Interface IDesignEditorDefinitionParams

Provides commands used in the design-editor widget.

Package: ui-framework

Properties

actionsErrorToast

Enables a toast to display errors.

Declaration

actionsErrorToast: ActionsErrorToastConfig

Property Value

Type	Description
ActionsErrorToastConfig	Enables a toast to display errors.

changeDesignVariant

A command that changes product design variants.

Declaration

changeDesignVariant?: IChangeDesignVariantCommandDefinition

Property Value

Type	Description
IChangeDesignVariantCommandDefinition	A command that changes product design variants.

changeLayout

Replaces design elements.

Declaration

changeLayout?: IDesignEditorDefinitionChangeLayout

Property Value

Type	Description
IDesignEditorDefinitionChangeLayout	Replaces design elements.

changeMockup

Changes mockup images in the editor. This command uses images from the Customer's Canvas back end.

Declaration

changeMockup?: IDesignEditorDefinitionChangeMockup

Property Value

Type	Description
IDesignEditorDefinitionChangeMockup	Changes mockup images in the editor. This command uses images from the Customer's Canvas back end.

initial

Initializes the editor.

Declaration

initial?: IDesignEditorDefinitionInitial

Property Value

Type	Description
IDesignEditorDefinitionInitial	Initializes the editor.

modifyItems

Changes properties of design elements in the editor.

Declaration

modifyItems?: IDesignEditorDefinitionModifyItems

Property Value

Type	Description
IDesignEditorDefinitionModifyItems	Changes properties of design elements in the editor.

preloader

preloader messages for initial loading and actions executing

Declaration

preloader?: IDesignEditorPreloaderConfig

Property Value

Type	Description
IDesignEditorPreloaderConfig	preloader messages for initial loading and actions executing

replaceInterpolationPlaceholders

If true, executes the replaceInterloationPlaceholders() method after initialization to convert interpolation placeholders to in-string placeholders.

Declaration

replaceInterpolationPlaceholders?: boolean

Property Value

Type	Description
boolean	If true, executes the replaceInterloationPlaceholders() method after initialization to convert interpolation placeholders to in-string placeholders.

setBackground

Sets a new background image.

Declaration

setBackground?: IDesignEditorDefinitionSetBackground

Property Value

Type	Description
IDesignEditorDefinitionSetBackground	Sets a new background image.

setPrintArea

Applies a new print area definition to the product.

Declaration

setPrintArea?: IDesignEditorDefinitionSetPrintArea

Property Value

Type	Description
IDesignEditorDefinitionSetPrintArea	Applies a new print area definition to the product.

setRemoteMockup

Changes mockup images in the editor. This command uses remote images through URLs.

Declaration

setRemoteMockup?: ISetRemoteMockupParams

Property Value

Type	Description
ISetRemoteMockupParams	Changes mockup images in the editor. This command uses remote images through URLs.

setSerializedProduct

Declaration

setSerializedProduct?: ISetSerializedProductConfig

Property Value

Type	Description
ISetSerializedProductConfig

setTheme

Applies a product theme.

Declaration

setTheme?: IDesignEditorDefinitionSetTheme

Property Value

Type	Description
IDesignEditorDefinitionSetTheme	Applies a product theme.

setViewerSettings

Changes product zoom properties in the editor.

Declaration

setViewerSettings?: IDesignEditorDefinitionSetViewerSettings

Property Value

Type	Description
IDesignEditorDefinitionSetViewerSettings	Changes product zoom properties in the editor.

updateItems

Updates design elements.

Declaration

updateItems?: IUpdateItemsCommandDefinition

Property Value

Type	Description
IUpdateItemsCommandDefinition	Updates design elements.