Interface IPageTemplate

A structure holding settings to create mockups and preview mockups for multipage IDML templates.

Inheritance

IModelComponent

IBaseSurfaceDefinition

ISurfaceTemplate

IPageTemplate

Package: @aurigma/design-editor-iframe

Examples

const productDefinition = {
   surfaces: {
       // Get surfaces from the multipage template "Booklet.idml".
       file: "Booklet",
       name: "Page {0}",
       pageTemplates: [
       {
           // The default mockup for all pages.
           mockup: {
               down: "bookletPages"
           }
           // The default preview mockup.
           previewMockups: [{ down: "previewBookletPages" }]
       },
       {
           // A mockup and a preview mockup for the first page.
           name: "Page 1",
           mockup: {
               up: "cover"
           },
           location: { X: "30", Y: "83" },
           previewMockups: [{ up: "previewCover" }]
       }]
   }
};

Properties

index

The index of a product page, starting from 0.

Declaration

index?: number;

Property Value

Type	Description
number	The index of a product page, starting from 0.

location

The template position relative to the mockup.

Declaration

location?: PointF;

Property Value

Type	Description
PointF	The template position relative to the mockup.