Configuration Module

The Customer's Canvas configuration. You can define these settings in the ~\Configuration\clientConfig.json file. You can find an example of this file in the corresponding topic. You can also pass these settings into the loadEditor method as follows:

example

configuration = {
    canvas: { /*...*/ },
    defaultItemsConfig: { /*...*/ },
    rendering: { /*...*/ },
    tokenId: /*...*/,
    widgets: {
        BottomToolbar: { /*...*/ },
        ColorPicker: { /*...*/ },
        ImageEditorDialog: { /*...*/ },
        Toolbox: { /*...*/ },
        ObjectInspector: { /*...*/ },
        RichTextDialog: { /*...*/ },
        TopToolbar: { /*...*/ }
    }
};
CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration);

Modules

Name	Description
ColorSpace	Available color spaces.
DefaultConfig	The configuration of design elements being added to the canvas.
FinishButtonMode	Modes of the Finish design button.
FontListMode	Modes of the font list.
GalleryDialogTab	Obsolete. Types of the Image Gallery's tabs.
GallerySource	Obsolete. Source types of gallery assets.
ImageSize	Sizes of images provided by Depositphotos.
InStringPlaceholderMode	Display modes of in-string placeholders in the Object Inspector.
ModelMode	Edit modes of Customer's Canvas.
ObjectInspectorPosition	The Object Inspector position.
PdfActionMode	PDF upload modes.
PsdActionMode	PSD upload modes.
RotationAlgorithm	Canvas rotation parameters.
RulersConfigUnit	Ruler units.
SvgActionMode	SVG upload modes.
TextAlignment	Text alignment types.

Enumerations

Name	Description
BarcodeType	Barcode 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.
IGridConfig	The grid configuration. For details, see the Markings topic.
IItemData	A structure defining text parameters that you can change through product themes.
IPdfMetadata	A structure containing PDF metadata to be saved in the hi-res output.
IProductThemeConfig	A configuration of product themes. For details, see the Product 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.
IRotationConfig	A structure containing parameters of the canvas rotation.
IRulersConfig	A structure containing the configuration of rulers. For details, see the Markings topic.
IShadowSettings	A structure defining parameters of text shadows.
ISnapElementConfiguration	A structure containing the advanced configuration of snap lines.
ISnapLinesConfig	A structure containing the configuration of snap lines.
IStrokeSettings	A structure defining parameters of text stroke.
IStubImagesBarcodeConfig	A configuration of messages in stub barcode placeholders.
IStubImagesConfig	A structure defining the appearance of stub barcode placeholders.
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.