View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IBaseSurfacesDefinition Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

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

Properties

Optional bgFoldingMode

bgFoldingMode: IBgFoldingModeParams

Parameters of the background folding mode.

Optional foldingLines

foldingLines: IFoldingLine []

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

Optional name

name: string

A name of a surface (a page) in the product.

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