- Introduction
- What's New?
- Features
- Getting Started
- Integration with E-commerce
- Integration with Remote Asset Sources
- Printable Files and Proof Images
- Configuring Products
- Creating Product Templates
- User Interface
- Configuration Files
- API
- Introduction to IFrame API
- IFrame API Reference
- BaseEditor Module
- IframeApi Module
- Configuration Module
- Editor Class
- loadEditor Function
- loadEditorByQueryString Function
- ObjectModel Module
- ChannelContainerType Enumeration
- Container Class
- CropMarkTextAlignment Enumeration
- IBarcodeVariable Interface
- IBasePrintAreaDefinition Interface
- IBaseSurfaceDefinition Interface
- IBaseSurfacesDefinition Interface
- IBgFoldingModeParams Interface
- IChannelContainerDefinition Interface
- ICropMark Interface
- ICropMarkText Interface
- IFoldingLine Interface
- IHiResOutput Interface
- IMarginHV Interface
- IMarginLTRB Interface
- IMockupData Interface
- IMockupFolders Interface
- IMockupTemplateHandlerLegacy Interface
- IMockupTemplateObject Interface
- IModelComponent Interface
- IPointF Interface
- IPrintAreaDefinition Interface
- IPrintAreaTemplate Interface
- IProductDefinition Interface
- IProofImage Interface
- IRectangleF Interface
- ISafetyLine Interface
- ISize Interface
- ISpine Interface
- IStateSurface Interface
- IStateSurfaces Interface
- ISurfaceDefinition Interface
- ISurfacesFromFolder Interface
- ISurfacesFromMultipageTemplate Interface
- ISurfaceTemplate Interface
- ITagsDictionary Interface
- Item Class
- IVariable Interface
- PrintArea Class
- Product Class
- Surface Class
- SurfaceMockup Class
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Web API
- Old Query-string API
- Visual Proofing Tool
- Variable Data Printing
- System Requirements
- Troubleshooting
- Licensing
- Copyright Notices
ObjectModel Module
Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation
Object model of Customer's Canvas product.
The interfaces listed below define properties of the objects used as arguments in loadEditor method.
Enumerations
| Name | Description |
|---|---|
| ChannelContainerType |
Channel container types. |
| CropMarkTextAlignment |
Text alignment options. |
Classes
Interfaces
| Name | Description |
|---|---|
| IBarcodeVariable |
A structure representing a variable barcode item in a product. |
| IBasePrintAreaDefinition |
A structure representing basic print area features. |
| IBaseSurfaceDefinition |
A structure representing basic surface features. |
| IBaseSurfacesDefinition |
A structure holding an array of surface names. |
| IBgFoldingModeParams |
A structure holding parameters of the folding mode of backgrounds. |
| IChannelContainerDefinition |
A structure holding settings to create a channel container. |
| ICropMark |
A structure holding settings for a crop mark. For details, see the Crop Marks topic. |
| ICropMarkText |
A structure holding settings for page information on hi-res outputs. |
| IFoldingLine |
A structure holding settings for a folding line. For details, see the Folding Lines and Spines topic. |
| IHiResOutput |
A structure holding the hi-res output settings. |
| IMarginHV |
A structure representing horizontal and vertical margins. |
| IMarginLTRB |
A structure representing left, top, right, and bottom margins. |
| IMockupData |
A structure holding the mockup settings. |
| IMockupFolders |
A structure holding names of folders containing the overlaying and background mockups. This interface uses mockups that are grouped by folders. |
| IMockupTemplateHandlerLegacy |
A structure holding settings to create mockups from PSD templates or raster images. This interface is out of date and to be removed in the next major release. Use the IMockupTemplate interface instead. |
| IMockupTemplateObject |
A structure holding settings to create overlaying and background mockups from PSD templates or raster images. For details, see the Mockups topic. |
| IModelComponent |
A basic component containing a name of a surface. |
| IPointF |
A structure representing a point in a two-dimensional plane. |
| IPrintAreaDefinition |
A structure used for creating an empty print area. |
| IPrintAreaTemplate |
A structure creating a print area based on a PSD/IDML template. |
| IProductDefinition |
A structure holding settings to create a product. |
| IProofImage |
A structure holding settings for proof images. |
| IRectangleF |
A structure representing a rectangle in a two-dimensional plane. |
| ISafetyLine |
A structure holding settings for a safety line. For details, see the Safety Lines topic. |
| ISize |
A structure representing size of a two-dimensional object. |
| ISpine |
A structure holding spine settings. For details, see the Folding Lines and Spines topic. |
| IStateSurface |
A structure holding a state file name and a surface name or a surface index. |
| IStateSurfaces |
A structure holding a state file name and an array of surface names. |
| ISurfaceDefinition |
A structure holding settings to create an empty surface. |
| ISurfaceTemplate |
A structure holding settings to create a surface from a PSD template. |
| ISurfacesFromFolder |
A structure holding settings to create a set of template-based surfaces. This interface uses PSD templates that are grouped by folders. For details, see the Multipage Products topic. |
| ISurfacesFromMultipageTemplate |
A structure holding settings to create a set of template-based surfaces. This interface uses pages of an IDML template. For details, see the Multipage Products topic. |
| ITagsDictionary |
A structure specifying the product tags. |
| IVariable |
A structure representing a variable item in a product. |