Configuration Module

The Customer's Canvas configuration. These settings are defined in the ~\Configuration\clientConfig.json file. You can find an example of this file in the corresponding topic.

structure
{
    canvas: { /*...*/  },
    defaultItemsConfig: { /*...*/  },
    rendering: { /*...*/  },
    watermark: { /*...*/  },
    widgets: {
        BottomToolbar: { /*...*/  },
        ColorPicker: { /*...*/  },
        ImageEditorDialog: { /*...*/  },
        Toolbox: { /*...*/  },
        ObjectInspector: { /*...*/  },
        RichTextDialog: { /*...*/  },
        TopToolbar: { /*...*/  }
    }
}

Modules

Name Description
BarcodeType

Bar codes.

ColorSpace

Available color spaces.

DefaultConfig

The default configuration of design elements being added to the canvas.

FinishButtonMode

Modes of the Finish design button.

FontListMode

Modes of the font list.

GalleryDialogTab

Types of the Image Gallery's tabs.

GallerySource

Source types of gallery assets.

InStringPlaceholderMode

Display modes of in-string placeholders in the Object Inspector.

ModelMode

Edit modes of Customer's Canvas.

ObjectInspectorPosition

The Object Inspector position.

PsdActionMode

PSD upload modes.

RulersConfigUnit

Ruler units.

SvgActionMode

SVG upload modes.

TextAlignment

Text alignment types.

Interfaces

Name Description
ICanvasConfig

A structure containing canvas settings in the editor.

IConfiguration

A structure containing the web-to-print editor configuration. Extends IUiConfig.

IDefaultItemsConfig

The configuration of design elements being added to a product. For details, see the Default Parameters of Design Elements topic.

IFontSettings

A configuration of font settings for watermark text.

IGridConfig

The grid configuration. For details, see the Markings topic.

IPdfMetadata

A structure containing PDF metadata to be saved in the hi-res output.

IProductThemeConfig

A configuration of color themes for products. For details, see the Color Themes topic.

IPublicApiConfig

A structure containing the settings of the hi-res output and proof images.

IQualityLevelsConfig

A structure defining the image quality levels of the Quality meter.

IQualityMeterConfig

A structure containing the configuration of the image quality meter.

IRenderingProperty

A structure containing the hi-res output and proof images configuration. For details, see the Configuring High Resolution and Proof Images topic.

IRulersConfig

A structure containing the configuration of rulers. For details, see the Markings topic.

ISnapLinesConfig

A structure containing the configuration of snap lines.

IUiConfig

A basic structure for IConfiguration, contains editor settings.

IViolationWarningsSettingsConfig

A structure containing the configuration of preflight warnings.

IWatermarkConfig

A configuration of watermarks. For details, see the Watermarks topic.

IWatermarkImageConfig

A configuration of watermark image.

IWatermarkTextConfig

A configuration of watermark text.

IWatermarkVisibilityConfig

A configuration of watermark visibility.