Editor
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 return value. See the Handling Product Customization topic for details. |
| IProofResult |
A structure used by Editor.getProofImages to store return value. See the Handling Product Customization topic for details. |
| ISaveProductResult |
A structure used by Editor.saveProduct to store return value. See the Handling Product Customization topic for details. |
| 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. See the Handling Product Customization topic for details. |
Methods
| Name | Description |
|---|---|
| dispose |
Releases all resources used by this Editor. |
| finishProductDesign |
Saves the current product state and returns links to hi-res output. See the Handling Product Customization topic for details. |
| getProduct |
Returns the product currently loaded in the editor. |
| getProofImages |
Renders proof images with the optional maximum width and height. See the Handling Product Customization topic for details. |
| 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. See the Working with User Data topic for details. |
| revertProduct |
Cancels all changes made by a user. |
| saveProduct |
Saves a product current state. See the Handling Product Customization topic for details. |
| subscribe |
Links an event with a handler function. PostMessage.Events object contains the supported events. |