Skip to main content

Interface: ISurfacesFromFolder

A structure holding settings to create a set of template-based surfaces.

Remarks​

This interface uses PSD templates that are grouped by folders. For details, see the Loading Pages from a Folder topic.

Example​

const productDefinition = {
  surfaces: {
    // Get surfaces from the folder.
    designFolder: "myphotoBook",
    // Name surfaces as "Page 1", "Page 2", and so on.
    name: "Page {0}",
    // Get mockups from the folder.
    mockupFolder: { up: "photoBookMockups" },
  },
};

Extends​

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​

IBaseSurfacesDefinition.name

foldingLines?​

optional foldingLines?: IFoldingLine[]

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

Inherited from​

IBaseSurfacesDefinition.foldingLines

spines?​

optional spines?: ISpine[]

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

Inherited from​

IBaseSurfacesDefinition.spines

bgFoldingMode?​

optional bgFoldingMode?: IBgFoldingModeParams

Parameters of the background folding mode.

Inherited from​

IBaseSurfacesDefinition.bgFoldingMode

proofImage?​

optional proofImage?: IProofImage

Settings of proof images.

Inherited from​

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

Inherited from​

IBaseSurfacesDefinition.names

designFolder?​

optional designFolder?: string

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

mockupFolder?​

optional mockupFolder?: IMockupFolders

A name of the folder containing mockup files.

previewMockupFolder?​

optional previewMockupFolder?: string | IMockupFolders

A name of the folder containing preview mockup files.

Was this page helpful?