Interface IRulersConfig

A structure containing the configuration of rulers.

Package: @aurigma/design-editor-iframe

Remarks

For details, see the Rulers topic.

Examples

configuration = {
   canvas: {
       rulers: {
           origin: { X: -1.15, Y: -1.67 }
       },
       shadowEnabled: false
   }
};

Properties

customUnitScale

The ratio of the custom unit to points; this parameter is applied only if the unit parameter described above is set to "custom".

Declaration

customUnitScale?: number;

Property Value

Type	Description
number	The ratio of the custom unit to points; this parameter is applied only if the unit parameter described above is set to "custom".

enabled

Displays rulers. The default value is true.

Declaration

enabled?: boolean;

Property Value

Type	Description
boolean	Displays rulers. The default value is true.

origin

The point of origin relatively to the upper-left corner of the design; the coordinates are measured in the units specified by the IRulersConfig.unit parameter.

Declaration

origin?: {
        X: number;
        Y: number;
    };

Property Value

Type	Description
{ X: number; Y: number; }	The point of origin relatively to the upper-left corner of the design; the coordinates are measured in the units specified by the IRulersConfig.unit parameter.

unit

Rulers measurement unit.

Declaration

unit?: RulersConfigUnit;

Property Value

Type	Description
RulersConfigUnit	Rulers measurement unit.