Interface IConfiguration

A structure containing the web-to-print editor configuration.

Inheritance

IUiConfig

IPublicApiConfig

IConfiguration

Package: @aurigma/design-editor-iframe

Remarks

Extends IUiConfig.

Examples

   // Defining the editor configuration.
   var 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.
   var editor = await CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration);

Properties

customStyle

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 but cannot specify it in clientConfig.json.

Declaration

customStyle?: string;

Property Value

Type	Description
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 but cannot specify it in clientConfig.json.

enableLargeProductLoadOptimization

Declaration

enableLargeProductLoadOptimization?: boolean;

Property Value

Type	Description
boolean

enableTrace

Declaration

enableTrace?: boolean;

Property Value

Type	Description
boolean

inlineStyle

An inline CSS style that will be loaded into the Design Editor.

Declaration

inlineStyle?: string;

Property Value

Type	Description
string	An inline CSS style that will be loaded into the Design Editor.

loadConfigFromState

Enables loading the config settings from state files.

Declaration

loadConfigFromState?: boolean;

Property Value

Type	Description
boolean	Enables loading the config settings from state files.

preloader

An object that sets up the embedded preloader of Customer's Canvas. For an example, refer to Preloader topic.

Declaration

preloader?: {
        enabled?: boolean;
        errorMessage?: string;
        firstTimeMessage?: string;
    };

Property Value

Type	Description
{ enabled?: boolean; errorMessage?: string; firstTimeMessage?: string; }	An object that sets up the embedded preloader of Customer's Canvas. For an example, refer to Preloader topic.

theme

The name of a theme. Possible values are "BootstrapDefault", "BootstrapEmpty", or "Md". The default value is "Md". You should pass this property to loadEditor but cannot specify it in clientConfig.json.

Declaration

theme?: string;

Property Value

Type	Description
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 but cannot specify it in clientConfig.json.

tokenId

The security token required when accessing the user's private data and the Web API endpoints in the secure mode.

Declaration

tokenId?: string;

Property Value

Type	Description
string	The security token required when accessing the user's private data and the Web API endpoints in the secure mode.

userId

The identifier of the user who currently works with the editor.

Declaration

userId?: string;

Property Value

Type	Description
string	The identifier of the user who currently works with the editor.