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

ISurfaceDefinition Interface

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

A structure holding settings to create an empty surface.

example
var emptyProduct = {
    surfaces: [{
        width: 720,
        height: 504,
        proofImage: {
            fileFormat: "PNG",
            rgbColorProfileName: "Adobe RGB (1998)",
            mockupEnabled: false
        }
    }]
};

Properties

Optional bgFoldingMode

bgFoldingMode: IBgFoldingModeParams

Parameters of the background folding mode.

Optional containers

containers: IChannelContainerDefinition []

A collection of channel containers. For more details, refer to the Spot Colors and Textures topic.

Optional foldingLines

foldingLines: IFoldingLine []

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

height

height: number

A surface height in points.

Optional name

name: string

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

Optional printAreas

printAreas: IPrintAreaDefinition []

A collection of print areas defined in the surface (page).

Optional proofImage

proofImage: IProofImage

Settings of proof images.

Optional spines

spines: ISpine []

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

width

width: number

A surface width in points.