Interface: IBaseSurfacesDefinition

A structure holding basic features of multipage templates.

Example

const productDefinition = {
  surfaces: {
    // Get surfaces from a folder containing three PSD templates.
    designFolder: "BookCover",
    // Name the surfaces.
    names: ["Front cover", "Endpapers", "Back cover"],
  },
};

Extends

• IBaseSurfaceDefinition

Extended by

• ISurfacesFromFolder
• ISurfacesFromMultipageTemplate

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

IBaseSurfaceDefinition.name

---

foldingLines?

optional foldingLines?: IFoldingLine[]

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

Inherited from

IBaseSurfaceDefinition.foldingLines

---

spines?

optional spines?: ISpine[]

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

Inherited from

IBaseSurfaceDefinition.spines

---

bgFoldingMode?

optional bgFoldingMode?: IBgFoldingModeParams

Parameters of the background folding mode.

Inherited from

IBaseSurfaceDefinition.bgFoldingMode

---

proofImage?

optional proofImage?: IProofImage

Settings of proof images.

Inherited from

IBaseSurfaceDefinition.proofImage

---

names?

optional 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.