Surface Class

A surface representing a product page.

example

surface = {
    width: 200,
    height: 150,
    printAreas: [{
        bounds: { x:0, y:0, width: 200, height: 150}
    }],
    mockup: {
        down: "envelope"
    },
    previewMockups: [{ down: "previewEnvelope" }] 
}

Methods

Name	Description
setMockup	Sets a new surface mockup and returns a new product instance containing the changed surface.
setPrintAreas	Sets a new print area for the surface and returns a new product instance containing the changed surface.

Properties

height

height: number

A surface height.

id

id: string

A unique surface identifier.

mockup

mockup: SurfaceMockup

A surface mockup.

name

name: string

A surface name.

previewMockups

previewMockups: SurfaceMockup []

An array of preview mockups.

printAreas

printAreas: PrintArea []

An array of print areas.

width

width: number

A surface width.