UI Framework Reference › ICanvasDefinitionParams
Interface: ICanvasDefinitionParams
Provides commands used in the canvas widget.
Hierarchy
- ICanvasDefinitionParams
Index
Properties
- actionsErrorToast
- changeLayout
- changeMockup
- initial
- modifyItems
- onChange
- replaceInterpolationPlaceholders
- setBackground
- setPrintArea
- setRemoteMockup
- setTheme
- setViewerSettings
Properties
actionsErrorToast
• actionsErrorToast: ActionsErrorToastConfig
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:65
Enables a toast to display errors.
Optional changeLayout
• changeLayout? : ICanvasDefinitionChangeLayout
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:42
Replaces design elements.
Optional changeMockup
• changeMockup? : ICanvasDefinitionChangeMockup
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:40
Changes mockup images in the editor. This command uses images from the Customer's Canvas back end.
Optional initial
• initial? : ICanvasDefinitionInitial
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:38
Initializes the editor.
Optional modifyItems
• modifyItems? : ICanvasDefinitionModifyItems
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:52
Changes properties of design elements in the editor.
Optional onChange
• onChange? : Function
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:56
Runs a command when a value changes.
Optional replaceInterpolationPlaceholders
• replaceInterpolationPlaceholders? : boolean
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:63
If true, executes the replaceInterloationPlaceholders() method after initialization to convert interpolation placeholders to in-string placeholders.
Optional setBackground
• setBackground? : ICanvasDefinitionSetBackground
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:44
Sets a new background image.
Optional setPrintArea
• setPrintArea? : ICanvasDefinitionSetPrintArea
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:46
Applies a new print area definition to the product.
Optional setRemoteMockup
• setRemoteMockup? : ISetRemoteMockupParams
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:50
Changes mockup images in the editor. This command uses remote images through URLs.
Optional setTheme
• setTheme? : ICanvasDefinitionSetTheme
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:48
Applies a product theme.
Optional setViewerSettings
• setViewerSettings? : ICanvasDefinitionSetViewerSettings
Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:54
Changes product zoom properties in the editor.