Editor Class

Represents the web-to-print editor.

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

Interfaces

Name Description
IFinishDesignResult

A structure used by Editor.finishProductDesign to store a return value. For details, see the Handling Product Customization topic.

IOutOfRegionItemData

A structure containing details about objects that go out of the region.

IProofResult

A structure used by Editor.getProofImages to store a return value. For details, see the Handling Product Customization topic.

ISaveProductResult

A structure used by Editor.saveProduct to store return value. For details, see the Handling Product Customization topic.

IUnchangedItems

A structure used by Editor.getUnchangedItems to store return value.

IUserChanges

A structure containing all changes the user made to the product when personalizing it. For details, see the Handling Product Customization topic.

Methods

Name Description
applyProductTheme

Applies a color theme to the product.

dispose

Releases all resources used by this Editor.

finishProductDesign

Saves the current product state and returns links to the hi-res output. For details, see the Handling Product Customization topic.

getProduct

Returns the product currently loaded in the editor.

getProofImages

Renders proof images with the optional maximum width and height. For details, see the Handling Product Customization topic.

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.

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 Handling Product Customization topic.

subscribe

Links an event with a handler function. PostMessage.Events object contains the supported events.

undo

Reverts the last user action on the canvas.