Interface: IPageTemplate

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

Example

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" }]`
       }]
   }
};

Extends

• ISurfaceTemplate

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

ISurfaceTemplate.name

---

foldingLines?

optional foldingLines?: IFoldingLine[]

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

Inherited from

ISurfaceTemplate.foldingLines

---

spines?

optional spines?: ISpine[]

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

Inherited from

ISurfaceTemplate.spines

---

bgFoldingMode?

optional bgFoldingMode?: IBgFoldingModeParams

Parameters of the background folding mode.

Inherited from

ISurfaceTemplate.bgFoldingMode

---

proofImage?

optional proofImage?: IProofImage

Settings of proof images.

Inherited from

ISurfaceTemplate.proofImage

---

mockup?

optional mockup?: IMockupTemplate

A mockup applied to the surface.

Inherited from

ISurfaceTemplate.mockup

---

previewMockups?

optional previewMockups?: IMockupTemplate[]

A collection of preview mockups for proof images.

Inherited from

ISurfaceTemplate.previewMockups

---

printAreas?

optional printAreas?: (IPrintAreaTemplate | IPrintAreaDefinition)[]

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

Inherited from

ISurfaceTemplate.printAreas

---

containers?

optional containers?: IChannelContainerDefinition[]

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

Inherited from

ISurfaceTemplate.containers

---

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.

Inherited from

ISurfaceTemplate.useSpecifiedContainersOnly

---

index?

optional index?: number

The index of a product page, starting from 0.

---

location?

optional location?: PointF

The template position relative to the mockup.