IMockupTemplate

A structure holding settings for a mockup created from an image. The mockup is not associated with any surface (page) and can be used as an argument for Surface.setMockup to update mockups at runtime.

example
mockup = { 
    down: {
        mockupFile: "envelopeMockup", 
        previewMockupFiles: ["envelopePreviewMockup"]
    }
}

Properties

Optional down

down: string | object

Background mockup: mockup lays below the design template.

mockupfile

Name of the mockup file without extension.

previewmockupfiles

Optional. Preview mockup files for this mockup file. Array of file names without extension.

Optional name

name: string

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

Optional up

up: string | object

Foreground mockup: mockup lays above the design template.

mockupfile

Name of the mockup file without extension.

previewmockupfiles

Optional. Preview mockup files for this mockup file. Array of file names without extension.