This is an old documentation. Go to the latest Customer's Canvas docs

Editor Class

Represents the Design Editor.

The interfaces listed below define properties of the objects used as arguments in Customer's Canvas methods

Enumerations

Name	Description
BarcodeFormat	An enumeration of barcode formats.
BarcodeSubType	An enumeration of Qr code subtypes.
ViolationState	An enumeration of preflight check states.
ZoomMode	An enumeration of zoom modes to fit images on the canvas.

Interfaces

Name	Description
IBarcodeData	A structure containing data that can be encoded into barcodes.
IFinishDesignResult	A structure used by Editor.finishProductDesign to store a return value. For details, see the Introducing the IFrame API topic.
IProofResult	A structure used by Editor.getProofImages to store a return value. For details, see the Introducing the IFrame API topic.
IRectangleF	Width, height, left, and top coordinates of a rectangle.
ISaveProductResult	A structure used by Editor.saveProduct to store a return value. For details, see the Introducing the IFrame API topic.
ISurfaceUserInfo	A structure containing user data for a specific product page.
ISurfacesChanges	A structure containing changes the user made to the product on a per-surface basis.
IUnchangedItem	A structure containing a name and a corresponding surface of an unchanged design element.
IUnchangedItems	A structure used by Editor.getUnchangedItems to store a return value.
IUserChangeItem	A structure containing a name and a new value of text elements.
IUserChanges	A structure containing all changes the user made to the product when personalizing it. For details, see the Introducing the IFrame API topic.
IUserInfo	A structure containing user data for populating products. For details, see the Working with User Data topic.
IValidationResult	A structure used by Editor.validateUserInfo to store results of the UserInfo validation.
IViolationWarningData	A structure containing details about design elements that have preflight problems.

Methods

Name	Description
applyProductTheme	Applies a color theme to the product. For details, see the Product Themes topic.
clearSelection	Deselects design elements on the current surface.
dispose	Releases all resources used by the editor.
finishProductDesign	Saves the current product state and returns links to the hi-res output. For details, see the Introducing the IFrame API topic.
getProduct	Returns the product currently loaded in the editor.
getProofImages	Renders proof images (72 DPI). For details, see the Introducing the IFrame API topic.
getSelectedItems	Returns an array of selected design elements.
getUnchangedItems	Returns a list of layers that have not been personalized by the user. These are the items (texts and placeholders) that are not changed when the product editing is finished.
loadUserInfo	Populates a product with user data. For details, see the Working with User Data topic.
openGallery	Opens the Asset Manager with the listed asset tabs to add a new image to the design.
openGalleryForBackground	Opens the Asset Manager to select an image for the background layer.
openGalleryForItem	Opens the Asset Manager to select an image for the specified item.
redo	Recovers the last user action on the canvas, which was reverted by the undo command/button.
revertProduct	Cancels all changes made by a user.
saveProduct	Saves a product current state. For details, see the Introducing the IFrame API topic.
selectAllItems	Selects all design elements on the current surface.
selectItems	Selects the specified design elements on the current surface.
setThemeConfiguration	Changes a preloader image and the primary theme color.
subscribe	Links an event with a handler function. PostMessage.Events object contains the supported events.
undo	Reverts the last user action on the canvas.
validateUserInfo	Validates the UserInfo structure.

Properties

commandManager

commandManager: CommandManager

Performs operations on design elements, surfaces, print areas, and the entire product.