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

# History

> [`History`](#history)

## Classes

### History

#### Constructors

##### Constructor

```ts
new History(handler, historySize?): History;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `handler` | [`ISnapshotHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ISnapshotHandler.md#isnapshothandler) | `undefined` |
| `historySize` | `number` | `10` |

###### Returns

#### Accessors

##### canRedo

###### Get Signature

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

###### Returns

`boolean`

##### canUndo

###### Get Signature

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

###### Returns

`boolean`

##### historySize

###### Set Signature

```ts
set historySize(historySize): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `historySize` | `number` |

###### Returns

`void`

##### overflowMaxUndoStepCount

###### Get Signature

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

###### Returns

`boolean`

#### Methods

##### addChanged()

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

###### Parameters

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

###### Returns

`void`

##### addRedoPerformed()

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

###### Parameters

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

###### Returns

`void`

##### addSnapshot()

```ts
addSnapshot(suppressOnChanged?, replaceLastSnapshot?): void;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `suppressOnChanged` | `boolean` | `false` |
| `replaceLastSnapshot` | `boolean` | `false` |

###### Returns

`void`

##### addUndoPerformed()

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

###### Parameters

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

###### Returns

`void`

##### clear()

```ts
clear(suppressOnChanged?): void;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `suppressOnChanged` | `boolean` | `false` |

###### Returns

`void`

##### disable()

```ts
disable(): void;
```

###### Returns

`void`

##### enable()

```ts
enable(): void;
```

###### Returns

`void`

##### isPaused()

```ts
isPaused(): boolean;
```

###### Returns

`boolean`

##### pause()

```ts
pause(): void;
```

###### Returns

`void`

##### raiseChanged()

```ts
raiseChanged(): void;
```

###### Returns

`void`

##### redo()

```ts
redo(): void;
```

###### Returns

`void`

##### removeChanged()

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

###### Parameters

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

###### Returns

`void`

##### removeRedoPerformed()

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

###### Parameters

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

###### Returns

`void`

##### removeUndoPerformed()

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

###### Parameters

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

###### Returns

`void`

##### resume()

```ts
resume(
   addSnapshot?, 
   forceAddSnapshot?, 
   replaceLastSnapshot?): void;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `addSnapshot` | `boolean` | `true` |
| `forceAddSnapshot` | `boolean` | `false` |
| `replaceLastSnapshot` | `boolean` | `false` |

###### Returns

`void`

##### undo()

```ts
undo(): void;
```

###### Returns

`void`