ISurfacesFromFolder Interface

A structure holding settings for a set of template-based surfaces. This interface uses templates that are grouped by folders. For details, see the Multipage Products topic.

example
productDefinition = {
    surfaces: {
        // Get surfaces from the folder.
        designFolder: "myphotoBook"
    }
};

Properties

Optional bgFoldingMode

bgFoldingMode: IBgFoldingModeParams

Parameters of the background folding mode.

Optional designFolder

designFolder: string

A name of the folder containing PSD page templates of the multipage product.

Optional foldingLines

foldingLines: IFoldingLine []

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

Optional mockupFolder

mockupFolder: string | IMockupFolders

A name of the folder containing mockup files.

Optional previewMockupFolder

previewMockupFolder: string | IMockupFolders

A name of the folder containing preview mockup files.

Optional proofImage

proofImage: IProofImage

Settings of proof images.

Optional spines

spines: ISpine []

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

Optional upMockup

upMockup: boolean

Defines whether the mockup is displayed above the design (true) or in the background (false). The default value is false.