Skip to main content
⚠️ Archived Version

You are viewing documentation for Design Editor version 7.3, which is no longer actively maintained. For the latest features and updates, please refer to the current version (7.4).

Interface: ISurfaceTemplate

A structure holding settings to create a surface from a PSD template.

Example​

CustomersCanvas.IframeApi.loadEditor(
   iframe,
   {
       surfaces: `[{
           name: "Front Side",
           printAreas: [{
               designFile: "stamp"
           }]`,
           mockup: { down: "envelope" },
           previewMockups: `[{ down: "previewMockup" }]`
       }]
   }
);

Extends​

Extended by​

Properties​

name?​

optional name?: string

A name of a surface (a page) in the product.

Remarks​

In multipage products, it allows you to use a name mask for product surfaces. If this string contains the {0} placeholder, it will be replaced with a page number, starting from 1. For example, name: "Page {0}" specifies the following page captions in the Bottom toolbar: Page 1, Page 2, and so on.

Inherited from​

IBaseSurfaceDefinition.name

foldingLines?​

optional foldingLines?: IFoldingLine[]

A collection of folding lines defined in the surface (page).

Inherited from​

IBaseSurfaceDefinition.foldingLines

spines?​

optional spines?: ISpine[]

A collection of spines defined in the surface (page).

Inherited from​

IBaseSurfaceDefinition.spines

bgFoldingMode?​

optional bgFoldingMode?: IBgFoldingModeParams

Parameters of the background folding mode.

Inherited from​

IBaseSurfaceDefinition.bgFoldingMode

proofImage?​

optional proofImage?: IProofImage

Settings of proof images.

Inherited from​

IBaseSurfaceDefinition.proofImage

mockup?​

optional mockup?: IMockupTemplate

A mockup applied to the surface.

previewMockups?​

optional previewMockups?: IMockupTemplate[]

A collection of preview mockups for proof images.

printAreas?​

optional printAreas?: (IPrintAreaTemplate | IPrintAreaDefinition)[]

A collection of print areas defined in the surface (page).

containers?​

optional containers?: IChannelContainerDefinition[]

A collection of channel containers. For more details, refer to the Post Press Finishing topic.

useSpecifiedContainersOnly?​

optional useSpecifiedContainersOnly?: boolean

If true, only spot containers defined in IDML or PSD templates will be created in a product, without the default containers Main, Background, and Foreground. The default value is false.

Was this page helpful?