Interface ISurfaceTemplate

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

Inheritance

IModelComponent

IBaseSurfaceDefinition

ISurfaceTemplate

Package: @aurigma/design-editor-iframe

Examples

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

Properties

containers

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

Declaration

containers?: IChannelContainerDefinition[];

Property Value

Type	Description
IChannelContainerDefinition[]	A collection of channel containers. For more details, refer to the Post Press Finishing topic.

mockup

A mockup applied to the surface.

Declaration

mockup?: IMockupTemplate;

Property Value

Type	Description
IMockupTemplate	A mockup applied to the surface.

previewMockups

A collection of preview mockups for proof images.

Declaration

previewMockups?: IMockupTemplate[];

Property Value

Type	Description
IMockupTemplate[]	A collection of preview mockups for proof images.

printAreas

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

Declaration

printAreas?: (IPrintAreaTemplate | IPrintAreaDefinition)[];

Property Value

Type	Description
(IPrintAreaTemplate | IPrintAreaDefinition)[]	A collection of print areas defined in the surface (page).

useSpecifiedContainersOnly

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.

Declaration

useSpecifiedContainersOnly?: boolean;

Property Value

Type	Description
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.