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

# IFoldingLine Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure holding settings for a folding line. For details, see the [Folding Lines and Spines](https://customerscanvas.com/docs/cc6/configuring-folding-lines-and-spines.htm.md) topic.
  
 - example
     - ```
// Set up the properties.
var fold = {
    isVertical: false,
    bleed: 10,
    pen: { color: "green" }
};

// Load the editor.
CustomersCanvas.IframeApi.loadEditor(
    iframe,
    {
        surfaces: [{
            height: 600, width: 800,
            foldingLines: [fold]
        }]
    }
);
```
 
## Properties
 
### Optional bleed
 
bleed: number

bleed sets offset in points for the folding line depending on its orientation. It is a top/bottom offset for the vertical line and a left/right offset for the horizontal line.
 
### Optional isVertical
 
isVertical: boolean

defines whether the folding line is vertical. If true, then the line is vertical, otherwise it is horizontal.
 
### Optional margin
 
margin: string

margin defines the absolute or relative location of the folding line on the product in points or percent. For vertical lines, it defines the x-axis offset from the left edge. For horizontal lines, it defines the y-axis offset from the top edge of the product. To set the relative offset in percent, add the percent sign to the number.
 
### Optional pen
 
pen: object

pen configures the outline of the folding line.
   
#### pen declaration
 
- #####  Optional altColor:  string 
   
    line alt color
- #####  Optional color:  string 
   
    line main color
- #####  Optional dashStep:  number 
   
    line dash step in pixels
- #####  Optional width:  number 
   
    line width