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

ObjectModel Module

The object model of Customer's Canvas products.

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.

PdfBox

PDF crop options.

Classes

Name Description
Container

A container for design elements.

Item

A design element.

PrintArea

A print area.

Product

A Customer's Canvas product.

Surface

A surface representing a product page.

SurfaceMockup

A mockup set for a surface.

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 basic features of multipage templates.

IBgFoldingModeParams

A structure holding parameters of the folding mode of backgrounds.

IChannelContainerDefinition

A structure holding settings to create a channel container. For details, see the Spot Colors and Textures topic.

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.

IDataSet

A structure defining the personalization data and a new product configuration. For details, see the Personalized Rendering topic.

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.

IItemsData

A structure defining the personalization data. For details about customizable properties and design items to which they can be applied, you can refer to the Personalized Rendering topic.

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.

IMockupTemplate

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.

IPageTemplate

A structure holding settings to create mockups and preview mockups for multipage IDML templates.

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.

ISetPrintAreasOptions

A structure holding settings to migrate data when replacing print areas or surfaces in a product.

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.

ISurfaceBinding

A structure specifying which surfaces of the loaded product should be rendered.

ISurfaceData

A structure defining which product surfaces should be rendered and how to apply itemsData to them. For details, see the Personalized Rendering topic.

ISurfaceDefinition

A structure holding settings to create an empty surface.

ISurfaceFromState

A structure holding settings to create a surface from a state file.

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.

IUpdateSurfaceOptionsByDefinition

A structure holding settings to migrate data when replacing surfaces in a product.

IVariable

A structure representing a variable item in a product.

Type aliases

SurfaceTypes