ISurfaceTemplate Interface

A structure used to create a surface from a PSD template.

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

Properties

Optional foldingLines

foldingLines: IFoldingLine []

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

Optional mockup

A mockup set in 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 specified for proof images.

Optional printAreas

printAreas: IPrintAreaTemplate []

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

Optional proofImage

proofImage: IProofImage

Optional spines

spines: ISpine []

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