Interface IBgFoldingModeParams

A structure holding parameters of the folding mode of backgrounds.

Package: @aurigma/design-editor-iframe

Examples

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

Properties

enabled

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

Declaration

enabled?: boolean;

Property Value

Type	Description
boolean	Enables the folding mode for backgrounds. If true, Design Editor replicates a background image in design areas separated by folding lines. The default value is false.

flip

Settings of the background flip for products with folding lines.

Declaration

flip?: {
        enabled?: boolean;
        order?: "Even" | "Odd";
    };

Property Value

Type	Description
{ enabled?: boolean; order?: "Even" | "Odd"; }	Settings of the background flip for products with folding lines.