---
title: "ISurfaceFromState Interface"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacefromstate.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/).

# ISurfaceFromState Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure holding settings to create a surface from a state file.
  
 - example
     - ```
const productDefinition = {
    surfaces: [{
        // Initialize a surface through a state file.
        stateId: "ed867273-5679-4927-b718-a53e92d6802c",
        // Select a surface index in the state file.
        surface: 2,
        // Apply a background mockup to the surface.
        mockup: {
            down: "tshirt"
        },
        // Specify the design location relative to the mockup.
        location: { x: 120, y: 0 }
    }]
};
```
 
## Properties
 
### Optional bgFoldingMode
 
bgFoldingMode: [IBgFoldingModeParams](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibgfoldingmodeparams.htm.md)

Inherited from [IBaseSurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md).[bgFoldingMode](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md)

Parameters of the background folding mode.
 
### Optional containers
 
containers: [IChannelContainerDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ichannelcontainerdefinition.htm.md) []

Inherited from [ISurfaceTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md).[containers](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md)

A collection of channel containers. For more details, refer to the [Spot Colors and Textures](https://customerscanvas.com/docs/cc6/spot-colors-and-textures.htm.md) topic.
 
### Optional foldingLines
 
foldingLines: [IFoldingLine](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ifoldingline.htm.md) []

Inherited from [IBaseSurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md).[foldingLines](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md)

A collection of folding lines defined in the surface (page).
 
### Optional location
 
location: [IPointF](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ipointf.htm.md)

Coordinates of the design relative to the upper-left corner of the mockup, in points.
 
### Optional mockup
 
mockup: [IMockupTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockuptemplate.htm.md)

Inherited from [ISurfaceTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md).[mockup](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md)

A mockup applied to the surface.
 
### Optional name
 
name: string

Inherited from [IModelComponent](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imodelcomponent.htm.md).[name](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imodelcomponent.htm.md)

A name of a surface (a page) in the product.
 
### Optional previewMockups
 
previewMockups: [IMockupTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockuptemplate.htm.md) []

Inherited from [ISurfaceTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md).[previewMockups](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md)

A collection of preview mockups for proof images.
 
### Optional printAreas
 
printAreas: ( [IPrintAreaTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iprintareatemplate.htm.md)  |  [IPrintAreaDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iprintareadefinition.htm.md) ) []

Inherited from [ISurfaceTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md).[printAreas](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.isurfacetemplate.htm.md)

A collection of print areas defined in the surface (page).
 
### Optional proofImage
 
proofImage: [IProofImage](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.iproofimage.htm.md)

Inherited from [IBaseSurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md).[proofImage](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md)

Settings of proof images.
 
### Optional spines
 
spines: [ISpine](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ispine.htm.md) []

Inherited from [IBaseSurfaceDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md).[spines](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacedefinition.htm.md)

A collection of spines defined in the surface (page).
 
### stateId
 
stateId: string

The name of a state file.
 
### Optional surface
 
surface: number

A surface index in the state file. The default value is `0` that stands for the first surface.