---
title: "Interface: IFoldingLine | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/interfaces/ObjectModel.IFoldingLine/"
---

# Interface: IFoldingLine

> A structure holding settings for a folding line.

## Remarks

For details, see the [Folding lines](https://customerscanvas.com/dev/editors/iframe-api/product-definition/folding-lines-and-spines.html) topic.

## Example

``` js
const fold = {
   isVertical: false,
   bleed: 10,
   pen: { color: "green" }
};

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

## Extended by

- [`ISpine`](https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/interfaces/ObjectModel.ISpine.md)

## Properties

### isVertical?

> `optional` **isVertical?**: `boolean`

If `true`, then the folding line is vertical, otherwise it is horizontal. The default value is `true`.

***

### margin?

> `optional` **margin?**: `string`

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. The default value is `"50%"`.

***

### bleed?

> `optional` **bleed?**: `number`

Defines offset for the folding line, in points, depending on its orientation. It is a top/bottom offset for the vertical line and a left/right offset for the horizontal line. The default value is `0`.

***

### pen?

> `optional` **pen?**: `object`

Configures the outline of the folding line.

#### width?

> `optional` **width?**: `number`

Line width.

#### dashStep?

> `optional` **dashStep?**: `number`

A dash step, in pixels.

#### color?

> `optional` **color?**: `string`

The main color of the folding line.

#### altColor?

> `optional` **altColor?**: `string`

The alt color of the folding line.