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: { /*...*/  },
        LeftToolbar: { /*...*/  },
        ObjectInspector: { /*...*/  },
        RichTextDialog: { /*...*/  },
        TopToolbar: { /*...*/  }
    }
}

Modules

Name Description
BarcodeType

Bar codes.

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

A default tab opened in the Gallery.

ILeftToolbarConfig

A structure containing the configuration of the Left toolbar.

ModelMode

Editor modes.

ObjectInspectorPosition

The Object Inspector position.

RulersConfigUnit

Ruler units.

TextAlignment

The text alignment type.

Classes

Name Description
IManipulationPermissions

A structure defining the manipulation permissions.

Interfaces

Name Description
IAutoZoomConfig

A structure containing auto-zoom configuration of the Rich text editor.

IBarcodeDialogConfig

A structure containing the configuration of the Barcode dialog.

IBottomToolbarConfig

A structure containing the configuration of the Bottom toolbar.

ICanvasConfig

A structure containing canvas settings in the editor.

IColorPickerConfig

The color picker providing color selection in the editor. For details, see the Colors topic.

ICommonConfig

A structure for common font settings.

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.

IFinishButtonConfig

The configuration of the Finish design button.

IFitTextRectangleSettings

A structure defining when and how the editor fits bounding rectangles to rich text.

IFontSettings

A configuration of font settings for watermark text.

IGalleryDialogConfig

A structure defining settings of the Gallery dialog. For more details, refer to the Using the Image Gallery topic.

IGridConfig

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

IImageEditorDialogConfig

A structure defining settings of the Image editor dialog.

IItemMenuConfig

A structure defining settings of the Item menu.

IObjectInspectorConfig

A structure containing the configuration of the Object inspector.

IPdfMetadata

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

IPerSurfaceConfiguration

A configuration of widgets, that is defined for separate surfaces. For an example, you can refer to the Customizing Widgets on a Per-page Basis topic.

IProductThemeConfig

A configuration of color themes for products.

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.

IRangeParams

A structure defining a range of values.

IRenderingProperty

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

IResizeGripsPermissions

A structure defining the grips that appear on bounding rectangles.

IRichComboValuesConfig

An object defining the indent and padding values for the Rich Text editor.

IRichTextDialogConfig

The dialog providing rich text formatting options. For details, see the Rich Text Editor topic.

IRulersConfig

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

IShowHintSettings

The settings enabling hints for drop-down lists in the toolbar of the Rich Text editor. These hints are turned on by default.

IShowInputSettings

The settings enabling the user input for drop-down lists in the toolbar of the Rich Text editor. The user input is turned on by default.

ISnapLinesConfig

A structure containing the configuration of snap lines.

ISocialNetworkAppIds

The Instagram and/or Facebook identifiers for your application. For details, see the Integration with Facebook and Instagram topic.

ISurfaceSwitchConfig

A structure defining the configuration of the navigation area in the Bottom toolbar.

ITabDescriptor

A structure defining tubs of the Image Gallery.

ITextOutline

The text outline for low-contrast texts in the Rich Text editor. This feature is turned off by default.

ITextShadowParam

A structure defining a range of values.

ITopToolbarConfig

A structure containing the configuration of the Top toolbar.

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.

IWidgetConfigsForSurface

A structure defining the configuration of widgets for a separate surface.

IWidgetsConfig

The configuration of the editor widgets. For details, see the Customizing User Interface topic.

IZOrderConfig

A structure containing the configuration of the z-order control.

IZoomConfig

A structure containing text zoom configuration of the Rich text editor.

Type aliases

TextRectangleFitMode

TextRectangleFitMode: "shrinkToContentWidth" | "stretchToContentWidth" | "shrinkOrStretchToContentWidth" | "shrinkToContentHeight" | "stretchToContentHeight" | "shrinkOrStretchToContentHeight" | "shrinkToContent" | "stretchToContent" | "shrinkOrStretchToContent"