Interface IUiConfig

The basic structure for IConfiguration, defines the editor settings.

Package: @aurigma/design-editor-iframe

Properties

alignToSafetyLineName

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".

Declaration

alignToSafetyLineName?: string;

Property Value

Type	Description
string	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".

assetSources

Asset sources defined for the Asset Manager.

Declaration

assetSources?: IAssetSources;

Property Value

Type	Description
IAssetSources	Asset sources defined for the Asset Manager.

autoLoadUserInfo

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 Populating designs with user info topic.

Declaration

autoLoadUserInfo?: boolean;

Property Value

Type	Description
boolean	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 Populating designs with user info topic.

canvas

A structure containing canvas settings.

Declaration

canvas?: ICanvasConfig;

Property Value

Type	Description
ICanvasConfig	A structure containing canvas settings.

canvasOnlyMode

The edit mode allowing you to hide all interface elements but the canvas. The default value is false.

Declaration

canvasOnlyMode?: boolean;

Property Value

Type	Description
boolean	The edit mode allowing you to hide all interface elements but the canvas. The default value is false.

defaultItemsConfig

The configuration of design elements being added to a product. For details, see the Toolbox topic.

Declaration

defaultItemsConfig?: IDefaultItemsConfig;

Property Value

Type	Description
IDefaultItemsConfig	The configuration of design elements being added to a product. For details, see the Toolbox topic.

defaultLanguage

A default interface language. The default value is "en". For details, see the Localization topic.

Declaration

defaultLanguage?: string;

Property Value

Type	Description
string	A default interface language. The default value is "en". For details, see the Localization topic.

defaultProductTheme

Allows for specifying the default color theme.

Declaration

defaultProductTheme?: string;

Property Value

Type	Description
string	Allows for specifying the default color theme.

deleteItemConfirmationEnabled

Enables the confirmation dialog when deleting an item from a product. The default value is false.

Declaration

deleteItemConfirmationEnabled?: boolean;

Property Value

Type	Description
boolean	Enables the confirmation dialog when deleting an item from a product. The default value is false.

enableTrace

Declaration

enableTrace?: boolean;

Property Value

Type	Description
boolean

fontList

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 Font list topic.

Declaration

fontList?: string[] | {
        appFonts?: string[];
    };

Property Value

Type	Description
string[] | { appFonts?: string[]; }	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 Font list topic.

fontListMode

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".

Declaration

fontListMode?: FontListMode.FontListModeType;

Property Value

Type	Description
FontListModeType	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".

grid

The grid configuration. For details, see the Grid topic.

Declaration

grid?: IGridConfig;

Property Value

Type	Description
IGridConfig	The grid configuration. For details, see the Grid topic.

imageEditorEnabled

Enables the Image Editor. The default value is true.

Declaration

imageEditorEnabled?: boolean;

Property Value

Type	Description
boolean	Enables the Image Editor. The default value is true.

initialMode

The initial mode of the editor, either "Simple" or "Advanced". The default value is "Simple".

Declaration

initialMode?: ModelMode.ModelModeType;

Property Value

Type	Description
ModelModeType	The initial mode of the editor, either "Simple" or "Advanced". The default value is "Simple".

loadUserInfoButtonEnabled

Displays the **Load my info** button. The default value is false. For details, see the Populating designs with user info topic.

Declaration

loadUserInfoButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Load my info** button. The default value is false. For details, see the Populating designs with user info topic.

perSurfaceConfiguration

A configuration of widgets, that is defined for separate surfaces.

Declaration

perSurfaceConfiguration?: IPerSurfaceConfiguration;

Property Value

Type	Description
IPerSurfaceConfiguration	A configuration of widgets, that is defined for separate surfaces.

productThemes

A predefined set of color themes and text styles for the product.

Declaration

productThemes?: {
        [name: string]: IProductThemeConfig;
    };

Property Value

Type	Description
{ [name: string]: IProductThemeConfig; }	A predefined set of color themes and text styles for the product.

restoreProductOnReloadEnabled

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.

Declaration

restoreProductOnReloadEnabled?: boolean;

Property Value

Type	Description
boolean	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.

revertProductConfirmationEnabled

Enables the confirmation dialog when reverting a product to its initial state. The default value is true.

Declaration

revertProductConfirmationEnabled?: boolean;

Property Value

Type	Description
boolean	Enables the confirmation dialog when reverting a product to its initial state. The default value is true.

spellCheckEnabled

Enables spell checking for product text fields and for the Rich text dialog. The default value is false.

Declaration

spellCheckEnabled?: boolean;

Property Value

Type	Description
boolean	Enables spell checking for product text fields and for the Rich text dialog. The default value is false.

themeConfiguration

Defines the primary theme color and a new image for the standard preloader.

Declaration

themeConfiguration?: IThemeConfiguration;

Property Value

Type	Description
IThemeConfiguration	Defines the primary theme color and a new image for the standard preloader.

userInfo

Data to populate the loaded product template with.

Declaration

userInfo?: {
        [key: string]: string | IBarcodeData;
    };

Property Value

Type	Description
{ [key: string]: string | IBarcodeData; }	Data to populate the loaded product template with.

variableItemsMaskSymbol

A symbol marking design elements as variable items. By default, it is "%".

Declaration

variableItemsMaskSymbol?: string;

Property Value

Type	Description
string	A symbol marking design elements as variable items. By default, it is "%".

watermark

The watermark configuration.

Declaration

watermark?: IWatermarkConfig;

Property Value

Type	Description
IWatermarkConfig	The watermark configuration.

widgets

The configuration of the editor widgets. For details, see the UI overview topic.

Declaration

widgets?: IWidgetsConfig;

Property Value

Type	Description
IWidgetsConfig	The configuration of the editor widgets. For details, see the UI overview topic.