- Introduction
- What's New?
- Features
- Upgrading the Design Editor
- Breaking Changes in 6.0
- Getting Started
- Integration with E-commerce
- Integration with Remote Asset Sources
- Printable Files and Proof Images
- Configuring Products
- Creating Product Templates
- User Interface
- Configuration Files
- APIs
- IFrame API
- Getting Started with IFrame API
- Using the Design Atoms Framework in IFrame API
- Changing the Product Size
- BaseEditor Module
- IframeApi Module
- Commands Module
- Configuration Module
- BarcodeType Enumeration
- ColorSpace Module
- DefaultConfig Module
- FinishButtonMode Module
- FontListMode Module
- GallerySource Module
- ICanvasConfig Interface
- IConfiguration Interface
- IDefaultItemsConfig Interface
- IFontSettings Interface
- IGridConfig Interface
- IHandlersConfiguration Interface
- IItemData Interface
- ImageSize Module
- InStringPlaceholderMode Module
- IPdfMetadata Interface
- IPrintZoneConfig Interface
- IPrintZoneConfiguration Interface
- IProductThemeConfig Interface
- IPublicApiConfig Interface
- IQualityLevelsConfig Interface
- IQualityMeterConfig Interface
- IRenderingProperty Interface
- IRotationConfig Interface
- IRulersConfig Interface
- IShadowSettings Interface
- ISnapElementConfiguration Interface
- ISnapLinesConfig Interface
- IStrokeSettings Interface
- IStubImagesBarcodeConfig Interface
- IStubImagesConfig Interface
- IUiConfig Interface
- IViolationWarningsSettingsConfig Interface
- IWatermarkConfig Interface
- IWatermarkImageConfig Interface
- IWatermarkTextConfig Interface
- IWatermarkVisibilityConfig Interface
- ModelMode Module
- ObjectInspectorPosition Module
- PdfActionMode Module
- PlaceholderEditingViewMode Enumeration
- PsdActionMode Module
- RotationAlgorithm Module
- RulersConfigUnit Module
- SvgActionMode Module
- TextAlignment Module
- TextEditorMode Enumeration
- Editor Class
- loadEditor Function
- ObjectModel Module
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Web API
- Design Atoms Framework
- UI Framework
- Dynamic Image API
- IFrame API
- Add-ons
- System Requirements
- Troubleshooting
- Migrating Your Applications
- Licensing
- Copyright Notices
IUiConfig Interface
Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation
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 assetSources
Asset sources defined for the Asset Manager.
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 canvas
A structure containing canvas settings in the editor.
Optional canvasOnlyMode
The edit mode allowing you to hide all interface elements but the canvas. The default value is false.
Optional defaultItemsConfig
The configuration of design elements being added to a product. For details, see the Default Parameters of Design Elements topic.
Optional defaultLanguage
A default interface language. The default value is "en". For details, see the Localization of Customer's Canvas topic.
Optional defaultProductTheme
Allows for specifying the default color theme. For details, see the Product Themes 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
A mode of the font list, either "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 grid
The grid configuration. For details, see the Markings topic.
Optional imageEditorEnabled
Enables the Image Editor. The default value is true.
Optional initialMode
The initial mode of the editor, either Simple or Advanced. 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 perSurfaceConfiguration
A configuration of widgets, that is defined for separate surfaces.
Optional productThemes
A predefined set of color themes and text styles for the product. For details, see the Product Themes topic.
productThemes declaration
-
[name: string ]: IProductThemeConfig
Optional restoreProductOnReloadEnabled
Enables restoring a product state when the design page is reloaded in the browser; if false, the product is reverted on reloading. The default value is false.
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 themeConfiguration
Defines the primary theme color and a new image for the standard preloader.
Optional userInfo
Data to populate the loaded product template with.
userInfo declaration
-
[key: string ]: string | IBarcodeData
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 the User Interface topic.