Interface ISafetyLine

A structure holding settings for a safety line.

Package: @aurigma/design-editor-iframe

Remarks

For details, see the Bleed and Safety Zones topic.

Examples

// Defining the product.
let w = 720, h = 504; // in points (1 point = 1/72 inch)
let emptyProduct = {
   surfaces: [{
       width: w, height: h,
       printAreas: [{
           bounds: {
               x: 0, y: 0, width: w, height: h
           },
           safetyLines: [{
               margin: 8.5,
               color: 'rgba(0,255,0,1)',
               borderRadius: "10",
               stepPx: 5,
               widthPx: 1,
               pdfBox: "Trim"
           }]
       }]
   }]
};

Properties

altColor

The alternate color; a CSS-style color value. The default value is "rgba(0,0,0,1)".

Declaration

altColor?: string;

Property Value

Type	Description
string	The alternate color; a CSS-style color value. The default value is "rgba(0,0,0,1)".

borderRadius

The definition of rounded corners in the CSS format. You can set up the radius in points, in percent, or through the width and height of ellipses. By default, the safety zone is not rounded.

Declaration

borderRadius?: string;

Property Value

Type	Description
string	The definition of rounded corners in the CSS format. You can set up the radius in points, in percent, or through the width and height of ellipses. By default, the safety zone is not rounded.

color

The main color; a CSS-style color value. The default value is "rgba(255,255,255,1)".

Declaration

color?: string;

Property Value

Type	Description
string	The main color; a CSS-style color value. The default value is "rgba(255,255,255,1)".

margin

The distance between the safety line and the print area bounds, in points. The default value is 10 pt.

Declaration

margin?: number | IMarginHV | IMarginLTRB;

Property Value

Type	Description
number | IMarginHV | IMarginLTRB	The distance between the safety line and the print area bounds, in points. The default value is 10 pt.

name

The name of the safety line.

Declaration

name?: string;

Property Value

Type	Description
string	The name of the safety line.

pdfBox

The rectangle to wich the hi-res outputs are cropped: to CropBox, TrimBox, or BleedBox. By default, resulting PDF images are not cropped. Design Editor applies margins of the safety line to the corresponding PDF page box.

Declaration

pdfBox?: PdfBox;

Property Value

Type	Description
PdfBox	The rectangle to wich the hi-res outputs are cropped: to CropBox, TrimBox, or BleedBox. By default, resulting PDF images are not cropped. Design Editor applies margins of the safety line to the corresponding PDF page box.

stepPx

The dash length in pixels; the safety line is always a dashed line. The default value is 10 px.

Declaration

stepPx?: number;

Property Value

Type	Description
number	The dash length in pixels; the safety line is always a dashed line. The default value is 10 px.

widthPx

The line width, in pixels. The default value is 1 px.

Declaration

widthPx?: number;

Property Value

Type	Description
number	The line width, in pixels. The default value is 1 px.