---
title: "ICanvasConfig Interface"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.icanvasconfig.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# ICanvasConfig Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure containing canvas settings in the editor.
  
 - example
     - ```
configuration = {
    canvas: {
        rulers: {
            origin: {
                X: -1.15,
                Y: -1.67
            }
        },
        shadowEnabled: false,
        floatingItemToolbarEnabled: true,
        autoItemSelectionEnabled: true
    }
};
```
 
## Properties
 
### Optional autoItemSelectionEnabled
 
autoItemSelectionEnabled: boolean

Allows for auto selecting the first design element in the simple and advanced editing modes. The default value is `false`.
 
### Optional autoPlaceholderEditModeEnabled
 
autoPlaceholderEditModeEnabled: boolean

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
 
canvasItemHoverEnabled: boolean

Enables text labels for editable design elements. The default value is `false`. For details, see the [Defining Names of Design Elements](https://customerscanvas.com/docs/cc6/defining-item-names.htm.md) topic.
 
### Optional color
 
color: string

The canvas color; this color is visible if a transparent object is placed on the canvas.
 
### Optional containerColor
 
containerColor: string

The color of the HTML element placed under the canvas.
 
### Optional floatingItemToolbarEnabled
 
floatingItemToolbarEnabled: boolean

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](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.iitemtoolbarpermissionsconfig.htm.md). The default value is `false`.
 
### Optional gridVisible
 
gridVisible: boolean

Enables the grid when the canvas opens. The default value is `false`.
 
### Optional handlers
 
handlers: [IHandlersConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ihandlersconfiguration.htm.md)

A structure defining the item processing rules.
 
### Optional historySize
 
historySize: number

The number of actions in the Design Editor that can be reverted by using the **Undo** button. The default value is `10`.
 
### Optional maskedPlaceholderUnderscoreEnabled
 
maskedPlaceholderUnderscoreEnabled: boolean

Enables displaying underscores in blank masked text layers. If `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
 
multipleObjectsUpdateOptimizationEnabled: boolean

Optimizes the load time of templates consisting of a large number of layers. The default value is `true`.
 
### Optional paddingPct
 
paddingPct: number

Padding between the canvas and the canvas viewer, in percent.
 
### Optional pinchZoomEnabled
 
pinchZoomEnabled: boolean

Allows users to zoom the canvas using the pinch gesture on mobile devices. The default value is `true`.
 
### Optional printZone
 
printZone: [IPrintZoneConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iprintzoneconfiguration.htm.md)

A structure defining the appearance of the bleed zone on the canvas.
 
### Optional qualityChangeContainersEnabled
 
qualityChangeContainersEnabled: boolean

Enables a bar displaying the DPI value of images on the canvas. If `true`, then the bar appears when your users resizing images or image placeholder. The default value is `false`.
 
### Optional rotation
 
rotation: [IRotationConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.irotationconfig.htm.md)

A structure containing the canvas rotation parameters. By default, the canvas rotates at 90 degrees when clicking the **Rotate** button in the **Bottom Toolbar**.
 
### Optional rulers
 
rulers: [IRulersConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.irulersconfig.htm.md)

A structure containing the configuration of rulers. For details, see the [Markings](https://customerscanvas.com/docs/cc6/configuring-rulers-and-grids.htm.md) topic.
 
### Optional safetyLinesVisible
 
safetyLinesVisible: boolean

Enables safety lines when the canvas opens. The default value is `true`.
 
### Optional shadowEnabled
 
shadowEnabled: boolean

Enables the canvas shadow. The default value is `false`.
 
### Optional snapLines
 
snapLines: [ISnapLinesConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.isnaplinesconfig.htm.md)

A structure containing the configuration of snap lines.
 
### Optional snapLinesVisible
 
snapLinesVisible: boolean

Enables snap lines when the canvas opens. The default value is `true`.
 
### Optional suppressOutOfRegionManipulation
 
suppressOutOfRegionManipulation: boolean

Disallows working with elements outside of regions on the canvas. If `true`, then your users cannot manipulate items out of regions. The default value is `true`.
 
### Optional textEditor
 
textEditor: [TextEditorMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.texteditormode.htm.md)

Specifies the text editor mode when the WYSIWYG editor is active. The default value is [TextEditorMode.Default](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.texteditormode.htm.md).
 
### Optional violationWarningButtonsEnabled
 
violationWarningButtonsEnabled: boolean

Allows for displaying the image quality warnings on the canvas. If `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 zoom
 
zoom: [IRangeParamsParsed](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.irangeparamsparsed.htm.md)

A structure containing zoom parameters of the canvas.