- 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
- Configuration Module
- Ui Module
- ColorPickerSectionViewType Enumeration
- ColorPickerTarget Enumeration
- IActionModeParsed Interface
- IAssetManagerConfig Module
- IAssetSources Module
- IAutoZoomConfigParsed Interface
- IBarcodeDialogConfigParsed Interface
- IBottomToolbarConfigParsed Interface
- IColorPickerConfigParsed Interface
- IColorPickerConfigSection Interface
- ICommonConfigParsed Interface
- IFinishButtonConfigParsed Interface
- IFitTextRectangleSettings Interface
- IImageEditorDialogConfigParsed Interface
- IItemMenuConfigParsed Interface
- INoColorSection Interface
- IObjectInspectorConfigParsed Interface
- IPaletteSection Interface
- IPerSurfaceConfiguration Interface
- IRangeParamsParsed Interface
- IRecentSection Interface
- IRichComboValuesConfigParsed Interface
- IRichTextDialogConfigParsed Interface
- IShowHintSettingsParsed Interface
- IShowInputSettings Interface
- ISurfaceSwitchConfigParsed Interface
- ITextOutlineParsed Interface
- ITextShadowParamParsed Interface
- IThemeSection Interface
- IToolboxConfigParsed Module
- ITopToolbarConfigParsed Interface
- IWidgetConfigsForSurface Interface
- IWidgetsConfig Interface
- IZoomConfigParsed Interface
- IZOrderConfigParsed Interface
- SectionType Enumeration
- Ui Module
- Configuration Module
- IframeApi Module
- Web API
- Design Atoms Framework
- UI Framework
- Dynamic Image API
- IFrame API
- Add-ons
- System Requirements
- Troubleshooting
- Migrating Your Applications
- Licensing
- Copyright Notices
Ui Module
Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation
Widget configuration interfaces
Modules
| Name | Description |
|---|---|
| IAssetManagerConfig |
A structure defining tabs of the Asset Manager. For details, see The Asset Manager topic. |
| IAssetSources |
A structure defining sources for the Asset Manager. For details, see The Asset Manager topic. |
| IToolboxConfigParsed |
A structure defining the configuration of the Toolbox. For details, see the Customizing the Toolbox topic. |
Enumerations
| Name | Description |
|---|---|
| ColorPickerSectionViewType |
The appearance of the Color picker sections. |
| ColorPickerTarget |
Targets for color sections in the Color picker. |
| SectionType |
Sections of the predefined colors in the Color picker. |
Interfaces
| Name | Description |
|---|---|
| IActionModeParsed |
A structure defining how to import SVG, PDF, and PSD graphics. For details, see The Asset Manager topic. |
| IAutoZoomConfigParsed |
A structure containing auto-zoom configuration of the Rich text editor. |
| IBarcodeDialogConfigParsed |
A structure containing the configuration of the Barcode dialog. |
| IBottomToolbarConfigParsed |
A structure containing the configuration of the Bottom toolbar. |
| IColorPickerConfigParsed |
A structure defining the Color picker. For details, see the Color Picker topic. |
| IColorPickerConfigSection |
A structure defining basic properties of Color picker sections. For details, see the Color Picker topic. |
| ICommonConfigParsed |
A structure for common settings of widgets. |
| IFinishButtonConfigParsed |
The configuration of the Finish design button. |
| IFitTextRectangleSettings |
A structure defining when and how the editor fits bounding rectangles to rich formatted text. |
| IImageEditorDialogConfigParsed |
A structure defining settings of the Image editor dialog. |
| IItemMenuConfigParsed |
A structure defining commands of the Item menu. |
| INoColorSection |
A structure defining the No Color section in the Color picker. For details, see the Color Picker topic. |
| IObjectInspectorConfigParsed |
A structure containing the configuration of the Object inspector. |
| IPaletteSection |
A structure defining the section of swatches in the Color picker. For details, see the Color Picker topic. |
| 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. |
| IRangeParamsParsed |
A structure defining a range of values. |
| IRecentSection |
A structure defining the section of recently selected colors in the Color picker. For details, see the Color Picker topic. |
| IRichComboValuesConfigParsed |
An object defining the indent and padding values for the Rich Text editor. |
| IRichTextDialogConfigParsed |
The dialog providing text formatting options. For details, see the Rich Text Editor topic. |
| IShowHintSettingsParsed |
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. |
| ISurfaceSwitchConfigParsed |
A structure defining the configuration of the navigation area in the Bottom toolbar. |
| ITextOutlineParsed |
The text outline for low-contrast texts in the Rich Text editor. This feature is turned off by default. |
| ITextShadowParamParsed |
A structure defining a range of values. |
| IThemeSection |
A structure defining the section of theme colors in the Color picker. For details, see the Color Picker and Product Themes. |
| ITopToolbarConfigParsed |
A structure containing the configuration of the Top toolbar. |
| IWidgetConfigsForSurface |
A structure defining the configuration of widgets for a separate surface. |
| IWidgetsConfig |
The configuration of the editor widgets. For details, see the Customizing the User Interface topic. |
| IZOrderConfigParsed |
A structure containing the configuration of the z-order control. |
| IZoomConfigParsed |
A structure containing text zoom configuration of the Rich text editor. |