1. Support
2. UI Framework Documentation
3. UI Framework Reference

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

Enables a toast to display errors.

---

Optional changeLayout

• changeLayout? : ICanvasDefinitionChangeLayout

Replaces design elements.

---

Optional changeMockup

• changeMockup? : ICanvasDefinitionChangeMockup

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

---

Optional initial

• initial? : ICanvasDefinitionInitial

Initializes the editor.

---

Optional modifyItems

• modifyItems? : ICanvasDefinitionModifyItems

Changes properties of design elements in the editor.

---

Optional onChange

• onChange? : Function

Runs a command when a value changes.

---

Optional replaceInterpolationPlaceholders

• replaceInterpolationPlaceholders? : boolean

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

---

Optional setBackground

• setBackground? : ICanvasDefinitionSetBackground

Sets a new background image.

---

Optional setPrintArea

• setPrintArea? : ICanvasDefinitionSetPrintArea

Applies a new print area definition to the product.

---

Optional setRemoteMockup

• setRemoteMockup? : ISetRemoteMockupParams

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

---

Optional setTheme

• setTheme? : ICanvasDefinitionSetTheme

Applies a product theme.

---

Optional setViewerSettings

• setViewerSettings? : ICanvasDefinitionSetViewerSettings

Changes product zoom properties in the editor.