---
title: "Surface Class"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surface.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# Surface Class

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
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](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surface.setmockup.htm.md) |  Sets a new surface mockup and returns a new product instance containing the changed surface. |
 |  [setPrintAreas](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surface.setprintareas.htm.md) |  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](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surfacemockup.htm.md)

A surface mockup.
 
### name
 
name: string

A surface name.
 
### previewMockups
 
previewMockups: [SurfaceMockup](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.surfacemockup.htm.md) []

An array of preview mockups.
 
### printAreas
 
printAreas: [PrintArea](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.printarea.htm.md) []

An array of print areas.
 
### width
 
width: number

A surface width.
