Interface ISurfacesFromMultipageTemplate

A structure holding settings to create a set of template-based surfaces.

Inheritance

IModelComponent

IBaseSurfaceDefinition

IBaseSurfacesDefinition

ISurfacesFromMultipageTemplate

Package: @aurigma/design-editor-iframe

Remarks

This interface uses pages of an IDML template. For details, see the Loading Multipage Products topic.

Examples

const productDefinition = {
   surfaces: {
       // Get surfaces from the three-page template "BookCover.idml".
       file: "BookCover",
       // Name the surfaces.
       names: ["Front cover", "Endpapers", "Back cover"]
   }
};

Properties

file

The name of an IDML template.

Declaration

file?: string;

Property Value

Type	Description
string	The name of an IDML template.

hiResOutput

Settings of the hi-res output.

Declaration

hiResOutput?: IHiResOutput;

Property Value

Type	Description
IHiResOutput	Settings of the hi-res output.

pageTemplates

Product mockups.

Declaration

pageTemplates?: IPageTemplate[];

Property Value

Type	Description
IPageTemplate[]	Product mockups.