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

# IPageTemplate 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 mockups and preview mockups for multipage IDML templates.
  
 - example
     - ```
const productDefinition = {
    surfaces: {
        // Get surfaces from the multipage template "Booklet.idml".
        file: "Booklet",
        name: "Page {0}",
        pageTemplates: [
        {
            // The default mockup for all pages.
            mockup: {
                down: "bookletPages"
            }
            // The default preview mockup.
            previewMockups: [{ down: "previewBookletPages" }]
        },
        {
            // A mockup and a preview mockup for the first page.
            name: "Page 1",
            mockup: {
                up: "cover"
            },
            location: { X: "30", Y: "83" },
            previewMockups: [{ up: "previewCover" }]
        }]
    }
};
```
 
## Properties
 
### Optional index
 
index: number

The index of a product page, starting from `0`.
 
### Optional location
 
location: [IPointF](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.ipointf.htm.md)

The template position relative to the mockup.
 
### Optional mockup
 
mockup: [IMockupTemplate](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.objectmodel.imockuptemplate.htm.md)

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

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

A collection of preview mockups for proof images.