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

IMockupTemplateObject Interface

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

A structure holding settings to create overlaying and background mockups from PSD templates or raster images. For details, see the Mockups topic.

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

Properties

Optional down

down: string | IMockupTemplateHandlerLegacy

A background mockup: the mockup lays below the design template. You can define it as either a file name or an object containing the mockup file name and an array of preview mockups. Defining the background mockup through the object is the outdated way.

Optional name

name: string

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

Optional up

up: string | IMockupTemplateHandlerLegacy

An overlaying mockup: the mockup lays above the design template. You can define it as either a file name or an object containing the mockup file name and an array of preview mockups. Defining the overlaying mockup through the object is the outdated way.