IUiConfig Interface
A basic structure for IConfiguration, contains editor settings.
Properties
Optional alignToSafetyLineName
A name of a safety line to which an item will be aligned; if there is no safety line with the name, then the item will be aligned to the first safety line in the safety lines array. The default value is "bleed".
Optional arbitraryResizeForImageItemEnabled
If enabled, a user can resize an image item in an editor without keeping the original aspect ratio. Otherwise, images can be resized only proportionally. The default value is false.
Optional autoLoadUserInfo
If true, then a product is automatically populated with predefined data when it is loaded into the editor; the Load my info button is not displayed. The default value is false. For details, see the Working with User Data topic.
Optional backgroundUpdateParams
Background parameters.
backgroundUpdateParams declaration
-
Optional folded
Mode: object -
Optional enabled: boolean
Enables the folded mode for backgrounds. The default value is
false. -
Optional flip: boolean
Enables the background flip if the folded mode is enabled. The default value is
false.
-
Optional canvas
A structure containing canvas settings in the editor.
Optional defaultItemsConfig
The configuration of design elements being added to a product. For details, see the default-settings.htm topic.
Optional defaultLanguage
A default interface language. The default value is "en". For details, see the Localization of Customer's Canvas topic.
Optional deleteItemConfirmationEnabled
Enables the confirmation dialog when deleting an item from a product. The default value is false.
Optional fontList
A list of fonts available for a user in the editor; all these fonts should be uploaded to the font folder on server, by default it is ~/Fonts/. For details, see the Custom Fonts topic.
Optional fontListMode
Mode of the font list, "Simple" or "Advanced". The simple mode allows a user to select font and set font size; the advanced mode also provides an ability to change font style. The default value is "Advanced".
Optional galleryOnly
Displays only the image Gallery containing the private tab; the web-to-print editor is not displayed in this mode. The default value is false.
Optional grid
The grid configuration. For details, see the Markings topic.
Optional imageEditorEnabled
Enables Image editor. The default value is true.
Optional initialMode
Initial mode of the editor. The default value is Simple.
Optional loadUserInfoButtonEnabled
Displays the Load my info button. The default value is false. For details, see the Working with User Data topic.
Optional newImageName
A default name for a new image layer: the first layer is named newImageNameValue, the second one is newImageNameValue_1, the third layer is newImageNameValue_2, etc. By default the name of the image file is used.
Optional perSurfaceConfiguration
A configuration of widgets, that is defined for separate surfaces.
Optional restoreProductOnReloadEnabled
Enables restoring product state when the design page is reloaded; if false, then product is reverted on reloading. The default value is true.
Optional revertProductConfirmationEnabled
Enables the confirmation dialog when reverting a product to its initial state. The default value is true.
Optional spellCheckEnabled
Enables spell checking for product text fields and for the Rich text dialog. The default value is false.
Optional userInfo
Data to populate the loaded product template with.
userInfo declaration
-
[key: string ]: string
Optional variableItemsMaskSymbol
A symbol marking design elements as variable items. By default, it is "%".
Optional watermark
The watermark configuration. For details, see the Watermarks topic.
Optional widgets
The configuration of the editor widgets. For details, see the Customizing User Interface topic.