- Introduction
- What's New?
- Features
- 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
- API
- Introduction to IFrame API
- IFrame API Reference
- BaseEditor Module
- IframeApi Module
- Configuration Module
- BarcodeType Enumeration
- ColorSpace Module
- DefaultConfig Module
- FinishButtonMode Module
- FontListMode Module
- GalleryDialogTab Module
- GallerySource Module
- ICanvasConfig Interface
- IConfiguration Interface
- IDefaultItemsConfig Interface
- IFontSettings Interface
- IGridConfig Interface
- IItemData Interface
- ImageSize Module
- InStringPlaceholderMode Module
- IPdfMetadata Interface
- IProductThemeConfig Interface
- IPublicApiConfig Interface
- IQualityLevelsConfig Interface
- IQualityMeterConfig Interface
- IRenderingProperty Interface
- IRulersConfig Interface
- IShadowSettings 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
- PsdActionMode Module
- RulersConfigUnit Module
- SvgActionMode Module
- TextAlignment Module
- Editor Class
- loadEditor Function
- loadEditorByQueryString Function
- ObjectModel Module
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Configuration Module
- Web API
- Old Query-string API
- Visual Proofing Tool
- Variable Data Printing
- System Requirements
- Troubleshooting
- Licensing
- Copyright Notices
ICanvasConfig Interface
Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation
A structure containing canvas settings in the editor.
Properties
Optional autoItemSelectionEnabled
Allows for auto selecting the first design element in the advanced editing mode. The default value is false.
Optional autoPlaceholderEditModeEnabled
Allows your users to work with the content of image placeholders by clicking a placeholder in either simple or advanced edit mode. If true, the Handle does not appear on image placeholders. The default value is false.
Optional canvasItemHoverEnabled
Enables text labels for design elements. The default value is false.
Optional color
The canvas color; this color is visible if a transparent object is placed on the canvas.
Optional containerColor
The color of the HTML element placed under the canvas.
Optional floatingItemToolbarEnabled
Enables the floating toolbar with the Select Image, Edit, and Delete buttons for a highlighted design element right on the canvas. Select Image appears for images and image placeholders. The Edit button allows for editing images and the content of text elements and image placeholders. You can configure this toolbar by using IItemToolbarPermissionsConfig. The default value is false.
Optional maskedPlaceholderUnderscoreEnabled
Enables displaying underscores in blank masked text layers. If it is false and the user has partially filled the text placeholder in, then the rest blank symbols are displayed as spaces. If true, the blank portion of the text layer displays underscores. The default value is true.
Optional multipleObjectsUpdateOptimizationEnabled
Optimizes the load time of templates consisting of a large number of layers. The default value is true.
Optional paddingPct
Padding between the canvas and the canvas viewer, in percent.
Optional pinchZoomEnabled
Allows users to zoom the canvas using the pinch gesture on mobile devices. The default value is true.
Optional qualityChangeContainersEnabled
Enables a bar displaying the DPI value of images on the canvas. If it is true, then the bar appears when your users resizing images or image placeholder. The default value is false.
Optional rulers
A structure containing the configuration of rulers. For details, see the Markings topic.
Optional shadowEnabled
Enables the product shadow.
Optional showGrid
Enables the grid when the canvas is created. The default value is false.
Optional showSafetyLines
Enables safety lines when the canvas is created. The default value is true.
Optional showSnapLines
Enables snap lines when the canvas is created. The default value is true.
Optional snapLines
A structure containing the configuration of snap lines.
Optional suppressOutOfRegionManipulation
Disallows working with elements outside of regions on the canvas. If it is true, then your users cannot manipulate items out of regions. The default value is true.
Optional violationWarningButtonsEnabled
Allows for displaying the image quality warnings on the canvas. If it is true, then notifying icons appear on such violation warnings as low image resolution, safety line violation, region violation, and clipping text. The default value is false.
Optional zoomStep
The step of increasing or decreasing the zoom level.