ISurfacesFromMultipageTemplate Interface

A structure holding settings to create a set of template-based surfaces. This interface uses pages of an IDML template. For details, see the Multipage Products topic.

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

Properties

Optional bgFoldingMode

bgFoldingMode: IBgFoldingModeParams

Parameters of the background folding mode.

Optional file

file: string

The name of an IDML template.

Optional foldingLines

foldingLines: IFoldingLine []

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

Optional hiResOutput

hiResOutput: IHiResOutput

Settings of the hi-res output.

Optional name

name: string

Allows you to use a name mask for product surfaces. This string must contain the {0} placeholder, which 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.

Optional names

names: string []

An array of surface names. The number of array elements must match the number of surfaces. Otherwise, the default page captions appear in the Bottom toolbar.

Optional proofImage

proofImage: IProofImage

Settings of proof images.

Optional spines

spines: ISpine []

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