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

# Configuration Module

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
The Customer's Canvas configuration.
  
You can define these settings in the `~\Configuration\clientConfig.json` file. You can find an example of this file in [the corresponding topic](https://customerscanvas.com/docs/cc6/client-config.htm.md). You can also pass these settings into the [loadEditor](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.loadeditor.htm.md) method as follows:
 
 - example
     - ```
configuration = {
    canvas: { /*...*/ },
    defaultItemsConfig: { /*...*/ },
    rendering: { /*...*/ },
    tokenId: /*...*/,
    widgets: {
        BottomToolbar: { /*...*/ },
        ColorPicker: { /*...*/ },
        ImageEditorDialog: { /*...*/ },
        Toolbox: { /*...*/ },
        ObjectInspector: { /*...*/ },
        RichTextDialog: { /*...*/ },
        TopToolbar: { /*...*/ }
    }
};
CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration);
```
 
## Modules
  
|  Name |  Description |
| --- | --- |
 |  [ColorSpace](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.colorspace.htm.md) |  Available color spaces. |
 |  [DefaultConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.defaultconfig.htm.md) |  The configuration of design elements being added to the canvas. |
 |  [FinishButtonMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.finishbuttonmode.htm.md) |  Modes of the Finish design button. |
 |  [FontListMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.fontlistmode.htm.md) |  Modes of the font list. |
 |  [GallerySource](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.gallerysource.htm.md) |  *Obsolete.* Source types of gallery assets. |
 |  [ImageSize](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.imagesize.htm.md) |  Sizes of images provided by Depositphotos. |
 |  [InStringPlaceholderMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.instringplaceholdermode.htm.md) |  Display modes of linked in-string placeholders in the Object Inspector. |
 |  [ModelMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.modelmode.htm.md) |  Edit modes of Customer's Canvas. |
 |  [ObjectInspectorPosition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.objectinspectorposition.htm.md) |  The Object Inspector position. |
 |  [PdfActionMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.pdfactionmode.htm.md) |  PDF upload modes. |
 |  [PsdActionMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.psdactionmode.htm.md) |  PSD upload modes. |
 |  [RotationAlgorithm](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.rotationalgorithm.htm.md) |  Canvas rotation parameters. |
 |  [RulersConfigUnit](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.rulersconfigunit.htm.md) |  Ruler units. |
 |  [SvgActionMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.svgactionmode.htm.md) |  SVG upload modes. |
 |  [TextAlignment](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.textalignment.htm.md) |  Text alignment types. |
 
## Enumerations
  
|  Name |  Description |
| --- | --- |
 |  [BarcodeType](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.barcodetype.htm.md) |  Barcode types. |
 |  [PlaceholderEditingViewMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.placeholdereditingviewmode.htm.md) |  Placeholder editing modes. |
 |  [TextEditorMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.texteditormode.htm.md) |  The WYSIWYG text editor modes. |
 
## Interfaces
  
|  Name |  Description |
| --- | --- |
 |  [ICanvasConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.icanvasconfig.htm.md) |  A structure containing canvas settings in the editor. |
 |  [IConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iconfiguration.htm.md) |  A structure containing the web-to-print editor configuration. Extends [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md). |
 |  [IDefaultItemsConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.idefaultitemsconfig.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. |
 |  [IFontSettings](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ifontsettings.htm.md) |  A configuration of font settings. |
 |  [IGridConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.igridconfig.htm.md) |  The grid configuration. For details, see the [Markings](https://customerscanvas.com/docs/cc6/configuring-rulers-and-grids.htm.md) topic. |
 |  [IHandlersConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ihandlersconfiguration.htm.md) |  A structure defining the item processing rules on the canvas. |
 |  [IItemData](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iitemdata.htm.md) |  A structure defining text parameters that you can change through [product themes](https://customerscanvas.com/docs/cc6/product-themes.htm.md). |
 |  [IPdfMetadata](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ipdfmetadata.htm.md) |  A structure containing PDF metadata to be saved in the hi-res output. |
 |  [IPrintZoneConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iprintzoneconfig.htm.md) |  A structure defining the appearance of bleed and trim lines on the canvas. |
 |  [IPrintZoneConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iprintzoneconfiguration.htm.md) |  A structure defining the appearance of the bleed zone on the canvas. |
 |  [IProductThemeConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iproductthemeconfig.htm.md) |  A configuration of product themes. For details, see the [Product Themes](https://customerscanvas.com/docs/cc6/product-themes.htm.md) topic. |
 |  [IPublicApiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ipublicapiconfig.htm.md) |  A structure containing the settings of the hi-res output and proof images. |
 |  [IQualityLevelsConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iqualitylevelsconfig.htm.md) |  A structure defining the image quality levels of the Quality meter. |
 |  [IQualityMeterConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iqualitymeterconfig.htm.md) |  A structure containing the configuration of the image quality meter. |
 |  [IRenderingProperty](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.irenderingproperty.htm.md) |  A structure containing the hi-res output and proof images configuration. For details, see the [Configuring High Resolution and Proof Images](https://customerscanvas.com/docs/cc6/configuring-high-resolution-and-proof-images.htm.md) topic. |
 |  [IRotationConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.irotationconfig.htm.md) |  A structure containing parameters of the canvas rotation. |
 |  [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. |
 |  [IShadowSettings](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ishadowsettings.htm.md) |  A structure defining parameters of text shadows. |
 |  [ISnapElementConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.isnapelementconfiguration.htm.md) |  A structure containing the advanced configuration of [snap lines](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.isnaplinesconfig.htm.md). |
 |  [ISnapLinesConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.isnaplinesconfig.htm.md) |  A structure containing the configuration of snap lines. |
 |  [IStrokeSettings](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.istrokesettings.htm.md) |  A structure defining parameters of text stroke. |
 |  [IStubImagesBarcodeConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.istubimagesbarcodeconfig.htm.md) |  A configuration of messages in stub barcode placeholders. |
 |  [IStubImagesConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.istubimagesconfig.htm.md) |  A structure defining the appearance of stub barcode placeholders. |
 |  [IThemeConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.ithemeconfiguration.htm.md) |  A structure containing the properties that redefine the appearance of the UI theme. |
 |  [IUiConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iuiconfig.htm.md) |  A basic structure for [IConfiguration](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iconfiguration.htm.md), contains editor settings. |
 |  [IViolationWarningsSettingsConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iviolationwarningssettingsconfig.htm.md) |  A structure containing the configuration of preflight warnings. |
 |  [IWatermarkConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iwatermarkconfig.htm.md) |  A configuration of watermarks. For details, see the [Watermarks](https://customerscanvas.com/docs/cc6/watermarks.htm.md) topic. |
 |  [IWatermarkImageConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iwatermarkimageconfig.htm.md) |  A configuration of watermark image. |
 |  [IWatermarkTextConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iwatermarktextconfig.htm.md) |  A configuration of watermark text. |
 |  [IWatermarkVisibilityConfig](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.iwatermarkvisibilityconfig.htm.md) |  A configuration of watermark visibility. |