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

# GridHandler

> [`GridHandler`](#gridhandler)

## Classes

### GridHandler

#### Constructors

##### Constructor

```ts
new GridHandler(colorParser): GridHandler;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `colorParser` | [`IColorParser`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IColorParser.md#icolorparser) |

###### Returns

#### Accessors

##### gridContainer

###### Get Signature

```ts
get gridContainer(): Container;
```

###### Returns

`Container`

##### gridContainers

###### Get Signature

```ts
get gridContainers(): Collection<Container>;
```

###### Returns

`Collection`\<`Container`\>

##### surface

###### Get Signature

```ts
get surface(): Surface;
```

###### Returns

`Surface`

###### Set Signature

```ts
set surface(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `Surface` |

###### Returns

`void`

##### visible

###### Get Signature

```ts
get visible(): boolean;
```

###### Returns

`boolean`

###### Set Signature

```ts
set visible(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `boolean` |

###### Returns

`void`

#### Methods

##### addChanged()

```ts
addChanged(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | () => `void` |

###### Returns

`void`

##### getGridParameters()

```ts
getGridParameters(): object;
```

###### Returns

`object`

###### cols

```ts
cols: number;
```

###### location

```ts
location: PointF;
```

###### rows

```ts
rows: number;
```

###### stepX

```ts
stepX: number;
```

###### stepY

```ts
stepY: number;
```

##### removeChanged()

```ts
removeChanged(listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `listener` | () => `void` |

###### Returns

`void`

##### setConfig()

```ts
setConfig(config, rulersConfig): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`GridConfig`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/GridConfig.md#gridconfig) |
| `rulersConfig` | [`IRulersConfig`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IRulersConfig.md#irulersconfig) |

###### Returns

`void`