ISurfaceTemplate Interface

A structure holding settings to create a surface from a PSD template.

example
CustomersCanvas.IframeApi.loadEditor(
    iframe,
    {
        surfaces: [{
            name: "Front Side",
            printAreas: [{
                designFile: "stamp"
            }],
            mockup: { down: "envelope" },
            previewMockups: [{ down: "previewMockup" }]
        }]
    }
);

Properties

Optional bgFoldingMode

bgFoldingMode: IBgFoldingModeParams

Parameters of the background folding mode.

Optional containers

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

Optional mockup

A mockup applied to the surface.

Optional name

name: string

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

Optional previewMockups

previewMockups: IMockupTemplate []

A collection of preview mockups for proof images.

Optional printAreas

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