---
title: "ObjectModel Module"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# ObjectModel Module

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
The object model of Customer's Canvas products.
  
The interfaces listed below define properties of the objects used as arguments in [loadEditor](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.loadeditor.htm.md) method.
 
## Enumerations
  
|  Name |  Description |
| --- | --- |
 |  [ChannelContainerType](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.channelcontainertype.htm.md) |  Channel container types. |
 |  [CropMarkTextAlignment](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.cropmarktextalignment.htm.md) |  Text alignment options. |
 |  [PdfBox](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.pdfbox.htm.md) |  PDF crop options. |
 
## Classes
  
|  Name |  Description |
| --- | --- |
 |  [Container](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.container.htm.md) |  A container for design elements. |
 |  [Item](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.item.htm.md) |  A design element. |
 |  [PrintArea](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.printarea.htm.md) |  A print area. |
 |  [Product](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.product.htm.md) |  A Customer's Canvas product. |
 |  [Surface](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surface.htm.md) |  A surface representing a product page. |
 |  [SurfaceMockup](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surfacemockup.htm.md) |  A mockup set for a surface. |
 
## Interfaces
  
|  Name |  Description |
| --- | --- |
 |  [IBarcodeVariable](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibarcodevariable.htm.md) |  A structure representing a variable barcode item in a product. |
 |  [IBasePrintAreaDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibaseprintareadefinition.htm.md) |  A structure representing basic print area features. |
 |  [IBaseSurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md) |  A structure representing basic surface features. |
 |  [IBaseSurfacesDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacesdefinition.htm.md) |  A structure holding basic features of multipage templates. |
 |  [IBgFoldingModeParams](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibgfoldingmodeparams.htm.md) |  A structure holding parameters of the folding mode of backgrounds. |
 |  [IChannelContainerDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ichannelcontainerdefinition.htm.md) |  A structure holding settings to create a channel container. For details, see the [Spot Colors and Textures](https://customerscanvas.com/docs/cc6/spot-colors-and-textures.htm.md) topic. |
 |  [ICropMark](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.icropmark.htm.md) |  A structure holding settings for a crop mark. For details, see the [Crop Marks](https://customerscanvas.com/docs/cc6/crop-marks.htm.md) topic. |
 |  [ICropMarkText](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.icropmarktext.htm.md) |  A structure holding settings for page information on hi-res outputs. |
 |  [IDataSet](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.idataset.htm.md) |  A structure defining the personalization data and a new product configuration. For details, see the [Personalized Rendering](https://customerscanvas.com/docs/cc6/web-api-for-rendering.htm.md) topic. |
 |  [IFoldingLine](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ifoldingline.htm.md) |  A structure holding settings for a folding line. For details, see the [Folding Lines and Spines](https://customerscanvas.com/docs/cc6/configuring-folding-lines-and-spines.htm.md) topic. |
 |  [IHiResOutput](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ihiresoutput.htm.md) |  A structure holding the hi-res output settings. |
 |  [IItemsData](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iitemsdata.htm.md) |  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](https://customerscanvas.com/docs/cc6/web-api-for-rendering.htm.md) topic. |
 |  [IMarginHV](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imarginhv.htm.md) |  A structure representing horizontal and vertical margins. |
 |  [IMarginLTRB](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imarginltrb.htm.md) |  A structure representing left, top, right, and bottom margins. |
 |  [IMockupData](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockupdata.htm.md) |  A structure holding the mockup settings. |
 |  [IMockupFolders](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockupfolders.htm.md) |  A structure holding names of folders containing the overlaying and background mockups. This interface uses mockups that are grouped by folders. |
 |  [IMockupTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockuptemplate.htm.md) |  A structure holding settings to create overlaying and background mockups from PSD templates or raster images. For details, see the [Mockups](https://customerscanvas.com/docs/cc6/mockups.htm.md) topic. |
 |  [IModelComponent](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imodelcomponent.htm.md) |  A basic component containing a name of a surface. |
 |  [IPageTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ipagetemplate.htm.md) |  A structure holding settings to create mockups and preview mockups for multipage IDML templates. |
 |  [IPointF](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ipointf.htm.md) |  A structure representing a point in a two-dimensional plane. |
 |  [IPrintAreaDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iprintareadefinition.htm.md) |  A structure used for creating an empty print area. |
 |  [IPrintAreaTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iprintareatemplate.htm.md) |  A structure creating a print area based on a PSD/IDML template. |
 |  [IProductDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iproductdefinition.htm.md) |  A structure holding settings to create a product. |
 |  [IProofImage](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iproofimage.htm.md) |  A structure holding settings for proof images. |
 |  [IRectangleF](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.irectanglef.htm.md) |  A structure representing a rectangle in a two-dimensional plane. |
 |  [ISafetyLine](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isafetyline.htm.md) |  A structure holding settings for a safety line. For details, see the [Safety Lines](https://customerscanvas.com/docs/cc6/safety-lines.htm.md) topic. |
 |  [ISetPrintAreasOptions](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isetprintareasoptions.htm.md) |  A structure holding settings to migrate data when replacing print areas or surfaces in a product. |
 |  [ISize](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isize.htm.md) |  A structure representing size of a two-dimensional object. |
 |  [ISpine](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ispine.htm.md) |  A structure holding spine settings. For details, see the [Folding Lines and Spines](https://customerscanvas.com/docs/cc6/configuring-folding-lines-and-spines.htm.md) topic. |
 |  [IStateSurface](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.istatesurface.htm.md) |  A structure holding a state file name and a surface name or a surface index. |
 |  [IStateSurfaces](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.istatesurfaces.htm.md) |  A structure holding a state file name and an array of surface names. |
 |  [ISurfaceBinding](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacebinding.htm.md) |  A structure specifying which surfaces of the loaded product should be rendered. |
 |  [ISurfaceData](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacedata.htm.md) |  A structure defining which product surfaces should be rendered and how to apply [itemsData](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iitemsdata.htm.md) to them. For details, see the [Personalized Rendering](https://customerscanvas.com/docs/cc6/web-api-for-rendering.htm.md) topic. |
 |  [ISurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacedefinition.htm.md) |  A structure holding settings to create an empty surface. |
 |  [ISurfaceFromState](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacefromstate.htm.md) |  A structure holding settings to create a surface from a state file. |
 |  [ISurfaceTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md) |  A structure holding settings to create a surface from a PSD template. |
 |  [ISurfacesFromFolder](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacesfromfolder.htm.md) |  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](https://customerscanvas.com/docs/cc6/multipage-products.htm.md) topic. |
 |  [ISurfacesFromMultipageTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacesfrommultipagetemplate.htm.md) |  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](https://customerscanvas.com/docs/cc6/multipage-products.htm.md) topic. |
 |  [ITagsDictionary](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.itagsdictionary.htm.md) |  A structure specifying the product tags. |
 |  [IUpdateSurfaceOptionsByDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iupdatesurfaceoptionsbydefinition.htm.md) |  A structure holding settings to migrate data when replacing surfaces in a product. |
 |  [IVariable](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ivariable.htm.md) |  A structure representing a variable item in a product. |
 
## Type aliases
 
### SurfaceTypes
 
SurfaceTypes: string  |  [IPrintAreaTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iprintareatemplate.htm.md)  |  [ISurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacedefinition.htm.md)  |  [ISurfaceTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md)  |  [ISurfaceFromState](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacefromstate.htm.md)