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

# ISurfacesFromFolder 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 set of template-based surfaces. This interface uses PSD templates that are grouped by folders. For details, see the [Multipage Products](https://customerscanvas.com/docs/cc6/multipage-products.htm.md) topic.
  
 - example
     - ```
const productDefinition = {
    surfaces: {
        // Get surfaces from the folder.
        designFolder: "myphotoBook",
        // Name surfaces as "Page 1", "Page 2", and so on.
        name: "Page {0}",
        // Get mockups from the folder.
        mockupFolder: { up: "photoBookMockups" }
    },
    // Define safety lines for all surfaces (product pages).
    defaultSafetyLines: [{
        margin: 5,
        color: "rgba(0,0,0,1)"
    }]
};
```
 
## 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 designFolder
 
designFolder: string

A name of the folder containing PSD page templates of the multipage product.
 
### 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 mockupFolder
 
mockupFolder: [IMockupFolders](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockupfolders.htm.md)

A name of the folder containing mockup files.
 
### Optional name
 
name: string

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

Allows you to use a name mask for product surfaces. This string must contain the `{0}` placeholder, which will be replaced with a page number, starting from 1. For example, `name: "Page {0}"` specifies the following page captions in the Bottom toolbar: `Page 1`, `Page 2`, and so on.
 
### Optional names
 
names: string []

Inherited from [IBaseSurfacesDefinition](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacesdefinition.htm.md).[names](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ibasesurfacesdefinition.htm.md)

An array of surface names. The number of array elements must match the number of surfaces. Otherwise, the default page captions appear in the Bottom toolbar.
 
### Optional previewMockupFolder
 
previewMockupFolder: string  |  [IMockupFolders](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockupfolders.htm.md)

A name of the folder containing preview mockup files.
 
### 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).