View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IBgFoldingModeParams Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure holding parameters of the folding mode of backgrounds.

example
product = {
    surfaces: [{
        foldingLines: [{ pen: { color: "white" } }],
        bgFoldingMode: {
            enabled: true,
            flip: {
                enabled: true,
                order: "Odd"
            }
        },
        printAreas: [{ designFile: "leaflet" }]
    }]
};

Properties

Optional enabled

enabled: boolean

Enables the folding mode for backgrounds. If true, Customer's Canvas replicates a background image in design areas separated by folding lines. The default value is false.

Optional flip

flip: object

Settings of the background flip for products with folding lines.

flip declaration

  • Optional enabled: boolean

    Allows you to flip backgrounds in the folding mode. The default value is false.

  • Optional order: "Even" | "Odd"

    The flip order for backgrounds in the folding mode. The "Even" order adds the original image to the background first and then the flipped image. The "Odd" order places the flipped image first. The default value is "Even".