ObjectModel

Object model of Customer's Canvas product.

The interfaces listed below define properties of the objects used as arguments in loadEditor method.

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.

IFoldingLine

A structure holding settings for a folding line. See the Folding Lines and Spines topic for details.

IHiResOutput

A structure holding hi-res output settings.

IMockupTemplate

A structure holding settings for a mockup created from an image. The mockup is not associated with any surface (page) and can be used as an argument for Surface.setMockup to update mockups at runtime.

IModelComponent

A component containing a name of a surface.

IPointF

A structure representing a point in a two-dimensional plane.

IPrintAreaDefinition

A structure used to creating a 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. See the Safety Lines topic for details.

ISize

A structure representing size of a two-dimensional object.

ISpine

A structure holding spine settings. See the Folding Lines and Spines topic for details.

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. See the Multipage Products topic for details.

Type aliases

SurfaceTypes