---
title: "IRulersConfig Interface"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.irulersconfig.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# IRulersConfig Interface

**Applies to:** Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · **Archived documentation**
 
A structure containing the configuration of rulers. For details, see the [Markings](https://customerscanvas.com/docs/cc6/configuring-rulers-and-grids.htm.md) 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
 
unit: [RulersConfigUnitType](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.configuration.rulersconfigunit.htm.md)

Rulers measurement unit.