IFoldingLine

A structure holding settings for a folding line. See the Folding Lines and Spines topic for details.

example
// Set up the properties.
fold = {
    isVertical: false,
    bleed: 10,
    pen: { color: "green" }
};

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

Properties

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.

isVertical

isVertical: boolean

defines whether the folding line is vertical. If true, then the line is vertical, otherwise it is horizontal.

margin

margin: string

margin defines 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 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