---
title: "IConfiguration Interface"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iconfiguration.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/).

# IConfiguration Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure containing the web-to-print editor configuration. Extends [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).
  
 - example
     - ```
<script>
    ...
    // Defining the editor configuration.
    configuration = {
        canvas: {
            color: "grey"
        },
        grid: {
            stepX: 0.5,
            stepY: 0.5
        },
        initialMode: "Advanced",
        customStyle: "mySiteStyles",
        rendering: {
            proofImageMockupEnabled: false
        },
        userInfo: {
            "FirstName": "John",
            "LastName": "Wood",
            "Phone": "1234567890"
        },
        widgets: {
            ObjectInspector: {
                dndEnabled: false
            }
        },
        tokenId: "95c16577-75fe-4145-87ff-c0ba49d1a554"
    };

    // Loading the editor with the given configuration.
    CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration).then(function(e) {editor = e});
    ...
</script>
```
 
## Properties
 
### Optional alignToSafetyLineName
 
alignToSafetyLineName: string

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[alignToSafetyLineName](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

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
 
assetSources: [IAssetSources](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.iassetsources.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[assetSources](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Asset sources defined for the [Asset Manager](https://customerscanvas.com/docs/cc6/asset-manager.htm.md).
 
### Optional autoLoadUserInfo
 
autoLoadUserInfo: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[autoLoadUserInfo](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

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](https://customerscanvas.com/docs/cc6/working-with-user-data.htm.md) topic.
 
### Optional canvas
 
canvas: [ICanvasConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.icanvasconfig.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[canvas](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

A structure containing canvas settings in the editor.
 
### Optional canvasOnlyMode
 
canvasOnlyMode: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[canvasOnlyMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

The edit mode allowing you to hide all interface elements but the canvas. The default value is `false`.
 
### Optional customStyle
 
customStyle: string

The name of a CSS file (without extension) that will be loaded into the Design Editor; the file should be located in the `~/Configuration/customCss/` folder. You should pass this property to [loadEditor](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.loadeditor.htm.md) but cannot specify it in `clientConfig.json`.
 
### Optional defaultItemsConfig
 
defaultItemsConfig: [IDefaultItemsConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.idefaultitemsconfig.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[defaultItemsConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

The configuration of design elements being added to a product. For details, see the [Default Parameters of Design Elements](https://customerscanvas.com/docs/cc6/default-parameters-of-design-elements.htm.md) topic.
 
### Optional defaultLanguage
 
defaultLanguage: string

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[defaultLanguage](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

A default interface language. The default value is `"en"`. For details, see the [Localization of Customer's Canvas](https://customerscanvas.com/docs/cc6/localization-of-cc.htm.md) topic.
 
### Optional defaultProductTheme
 
defaultProductTheme: string

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[defaultProductTheme](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Allows for specifying the default color theme. For details, see the [Product Themes](https://customerscanvas.com/docs/cc6/product-themes.htm.md) topic.
 
### Optional deleteItemConfirmationEnabled
 
deleteItemConfirmationEnabled: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[deleteItemConfirmationEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Enables the confirmation dialog when deleting an item from a product. The default value is `false`.
 
### Optional fontList
 
fontList: string []  |  object

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[fontList](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

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](https://customerscanvas.com/docs/cc6/custom-fonts.htm.md) topic.
 
### Optional fontListMode
 
fontListMode: [FontListModeType](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.fontlistmode.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[fontListMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

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
 
grid: [IGridConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.igridconfig.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[grid](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

The grid configuration. For details, see the [Markings](https://customerscanvas.com/docs/cc6/configuring-rulers-and-grids.htm.md) topic.
 
### Optional imageEditorEnabled
 
imageEditorEnabled: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[imageEditorEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Enables the **Image Editor**. The default value is `true`.
 
### Optional initialMode
 
initialMode: [ModelModeType](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.modelmode.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[initialMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

The initial mode of the editor, either `Simple` or `Advanced`. The default value is `Simple`.
 
### Optional inlineStyle
 
inlineStyle: string

An inline CSS style that will be loaded into the Design Editor.
 
### Optional loadConfigFromState
 
loadConfigFromState: boolean

Enables loading the config settings from state files.
 
### Optional loadUserInfoButtonEnabled
 
loadUserInfoButtonEnabled: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[loadUserInfoButtonEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Displays the **Load my info** button. The default value is `false`. For details, see the [Working with User Data](https://customerscanvas.com/docs/cc6/working-with-user-data.htm.md) topic.
 
### Optional perSurfaceConfiguration
 
perSurfaceConfiguration: [IPerSurfaceConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.ipersurfaceconfiguration.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[perSurfaceConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

A configuration of widgets, that is defined for separate surfaces.
 
### Optional preloader
 
preloader: object

An object that sets up the embedded preloader of Customer's Canvas. For an example, refer to [The Product Loading Screen](https://customerscanvas.com/docs/cc6/product-loading-screen.htm.md) topic.
  
#### preloader declaration
 
- #####  Optional enabled:  boolean 
  
    Enables the embedded preloader of Customer's Canvas. If it is `false`, then you can implement your own preloader. The default value is `true`.
- #####  Optional errorMessage:  string 
  
    This message shows when an error occurs. If it is not set, then **"Initialization error."** message shows by default.
- #####  Optional firstTimeMessage:  string 
  
    This message shows when a product is being loaded for the first time. If it is not set, then **"The product is being configured for the first time. It may take a while."** message is shown by default.
 
### Optional productThemes
 
productThemes: object

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[productThemes](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

A predefined set of color themes and text styles for the product. For details, see the [Product Themes](https://customerscanvas.com/docs/cc6/product-themes.htm.md) topic.
   
#### productThemes declaration
 
- #####  [name: string ]:  [IProductThemeConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iproductthemeconfig.htm.md)
 
### Optional rendering
 
rendering: [IRenderingProperty](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.irenderingproperty.htm.md)

Inherited from [IPublicApiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ipublicapiconfig.htm.md).[rendering](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ipublicapiconfig.htm.md)
 
### Optional restoreProductOnReloadEnabled
 
restoreProductOnReloadEnabled: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[restoreProductOnReloadEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

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

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[revertProductConfirmationEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Enables the confirmation dialog when reverting a product to its initial state. The default value is `true`.
 
### Optional spellCheckEnabled
 
spellCheckEnabled: boolean

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[spellCheckEnabled](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Enables spell checking for product text fields and for the **Rich text** dialog. The default value is `false`.
 
### Optional theme
 
theme: string

The name of a theme. Possible values are `"BootstrapDefault"`, `"BootstrapEmpty"`, or `"Md"`. The default value is `"Md"`. You should pass this property to [loadEditor](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.loadeditor.htm.md) but cannot specify it in `clientConfig.json`.
 
### Optional themeConfiguration
 
themeConfiguration: [IThemeConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ithemeconfiguration.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[themeConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Defines the primary theme color and a new image for the standard preloader.
 
### Optional tokenId
 
tokenId: string

The security token required when accessing the user's private data and the Web API endpoints in the [Secure Mode](https://customerscanvas.com/docs/cc6/appsettings-config.htm.md).
 
### Optional userId
 
userId: string

The identifier of the user who currently works with the editor.
 
### Optional userInfo
 
userInfo: object

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[userInfo](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

Data to populate the loaded product template with.
   
#### userInfo declaration
 
- #####  [key: string ]:  string  |  [IBarcodeData](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.editor.ibarcodedata.htm.md)
 
### Optional variableItemsMaskSymbol
 
variableItemsMaskSymbol: string

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[variableItemsMaskSymbol](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

A symbol marking design elements as variable items. By default, it is `"%"`.
 
### Optional watermark
 
watermark: [IWatermarkConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iwatermarkconfig.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[watermark](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

The watermark configuration. For details, see the [Watermarks](https://customerscanvas.com/docs/cc6/watermarks.htm.md) topic.
 
### Optional widgets
 
widgets: [IWidgetsConfig](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.configuration.ui.iwidgetsconfig.htm.md)

Inherited from [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md).[widgets](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md)

The configuration of the editor widgets. For details, see the [Customizing the User Interface](https://customerscanvas.com/docs/cc6/customizing-user-interface.htm.md) topic.