Interface ISurfaceDefinition

A structure holding settings to create an empty surface.

Inheritance

IModelComponent

IBaseSurfaceDefinition

ISurfaceDefinition

Package: @aurigma/design-editor-iframe

Examples

const emptyProduct = {
   surfaces: [{
       width: 720,
       height: 504,
       proofImage: {
           fileFormat: "PNG",
           rgbColorProfileName: "Adobe RGB (1998)",
           mockupEnabled: false
       }
   }]
};

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.

height

A surface height, in points.

Declaration

height: number;

Property Value

Type	Description
number	A surface height, in points.

printAreas

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

Declaration

printAreas?: IPrintAreaDefinition[];

Property Value

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

width

A surface width, in points.

Declaration

width: number;

Property Value

Type	Description
number	A surface width, in points.