IRulersConfig Interface

A structure containing the configuration of rulers. For details, see the Markings topic.

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

Properties

Optional customUnitScale

customUnitScale: number

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

Optional enabled

enabled: boolean

Displays rulers.

Optional origin

origin: object

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

origin declaration

  • X: number
  • Y: number

Optional unit

Rulers measurement unit.