UI Framework ReferenceIDesignEditorDefinitionParams

Interface: IDesignEditorDefinitionParams

Provides commands used in the design-editor widget.

Hierarchy

  • IDesignEditorDefinitionParams

Index

Properties

Properties

actionsErrorToast

actionsErrorToast: ActionsErrorToastConfig

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:68

Enables a toast to display errors.


Optional changeLayout

changeLayout? : IDesignEditorDefinitionChangeLayout

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:44

Replaces design elements.


Optional changeMockup

changeMockup? : IDesignEditorDefinitionChangeMockup

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:42

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


Optional initial

initial? : IDesignEditorDefinitionInitial

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:40

Initializes the editor.


Optional modifyItems

modifyItems? : IDesignEditorDefinitionModifyItems

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:54

Changes properties of design elements in the editor.


Optional replaceInterpolationPlaceholders

replaceInterpolationPlaceholders? : boolean

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:66

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


Optional setBackground

setBackground? : IDesignEditorDefinitionSetBackground

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:46

Sets a new background image.


Optional setPrintArea

setPrintArea? : IDesignEditorDefinitionSetPrintArea

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:48

Applies a new print area definition to the product.


Optional setRemoteMockup

setRemoteMockup? : ISetRemoteMockupParams

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:52

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


Optional setSerializedProduct

setSerializedProduct? : ISetSerializedProductConfig

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:59


Optional setTheme

setTheme? : IDesignEditorDefinitionSetTheme

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:50

Applies a product theme.


Optional setViewerSettings

setViewerSettings? : IDesignEditorDefinitionSetViewerSettings

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:56

Changes product zoom properties in the editor.


Optional updateItems

updateItems? : IUpdateItemsCommandDefinition

Defined in src/widgets/au-widget-design-editor/IAuWidgetDesignEditor.ts:58

Updates design elements.