Interface: IRulersConfig

A structure containing the configuration of rulers.

Remarks

For details, see the Rulers https://customerscanvas.com/dev/editors/iframe-api/editor-configuration/rulers-grids-snaplines.html|Rulers topic.

Example

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

Properties

enabled?

optional enabled?: boolean

Displays rulers. The default value is true.

---

unit?

optional unit?: RulersConfigUnit

Rulers measurement unit.

---

customUnitScale?

optional 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".

---

origin?

optional 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 IRulersConfig.unit parameter.

X

X: number

Y

Y: number