ObjectModel Module

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
CropMarkTextAlignment

A structure holding settings for text alignment.

Classes

Name Description
Product

A Customer's Canvas product.

Surface

A surface, which is a product unit. Each page of a product is a surface.

SurfaceMockup

A mockup set for a surface.

Interfaces

Name Description
IBasePrintAreaDefinition

A structure representing basic print area features.

IBaseSurfaceDefinition

A structure representing basic surface features.

IBgFoldingModeParams

A structure holding parameters of the folding mode of backgrounds.

ICropMark

A structure holding settings for a crop mark. For details, see the Safety Lines and 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.

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.

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.

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 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 and Crop Marks 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.

ISurfaceDefinition

A structure holding settings to create an empty surface.

ISurfaceTemplate

A structure used to create a surface from a PSD template.

ISurfacesFromFolder

A structure holding settings for a set of template-based surfaces. This interface uses templates that are grouped by folders. For details, see the Multipage Products topic.

ITagsDictionary

A structure specifying the product tags.

Type aliases

SurfaceTypes