Interface ICanvasDefinitionParams

Provides commands used in the canvas 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.

changeLayout

Replaces design elements.

Declaration

changeLayout?: ICanvasDefinitionChangeLayout

Property Value

Type	Description
ICanvasDefinitionChangeLayout	Replaces design elements.

changeMockup

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

Declaration

changeMockup?: ICanvasDefinitionChangeMockup

Property Value

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

initial

Initializes the editor.

Declaration

initial?: ICanvasDefinitionInitial

Property Value

Type	Description
ICanvasDefinitionInitial	Initializes the editor.

modifyItems

Changes properties of design elements in the editor.

Declaration

modifyItems?: ICanvasDefinitionModifyItems

Property Value

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

onChange

Runs a command when a value changes.

Declaration

onChange?: Function

Property Value

Type	Description
Function	Runs a command when a value changes.

preloader

preloader messages for initial loading and actions executing

Declaration

preloader?: ICanvasPreloaderConfig

Property Value

Type	Description
ICanvasPreloaderConfig	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?: ICanvasDefinitionSetBackground

Property Value

Type	Description
ICanvasDefinitionSetBackground	Sets a new background image.

setPrintArea

Applies a new print area definition to the product.

Declaration

setPrintArea?: ICanvasDefinitionSetPrintArea

Property Value

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

setTheme

Applies a product theme.

Declaration

setTheme?: ICanvasDefinitionSetTheme

Property Value

Type	Description
ICanvasDefinitionSetTheme	Applies a product theme.

setViewerSettings

Changes product zoom properties in the editor.

Declaration

setViewerSettings?: ICanvasDefinitionSetViewerSettings

Property Value

Type	Description
ICanvasDefinitionSetViewerSettings	Changes product zoom properties in the editor.