---
title: "IRulersConfig | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IRulersConfig/"
---

# IRulersConfig

> `number`

## Enumerations

### RulersConfigUnit

#### Enumeration Members

| Enumeration Member | Value |
| ------ | ------ |
|  `Cm` | `"Cm"` |
|  `Custom` | `"Custom"` |
|  `Inch` | `"Inch"` |
|  `Mm` | `"Mm"` |
|  `Point` | `"Point"` |

## Interfaces

### IRulersConfig

#### Properties

##### customUnitScale?

```ts
optional customUnitScale?: number;
```

##### enabled?

```ts
optional enabled?: boolean;
```

##### origin?

```ts
optional origin?: object;
```

###### X

```ts
X: number;
```

###### Y

```ts
Y: number;
```

##### unit

```ts
unit: RulersConfigUnit;
```

## Functions

### getUnitScale()

```ts
function getUnitScale(config): number;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`IRulersConfig`](#irulersconfig) |

#### Returns