Class History_2

Package: @aurigma/design-atoms

Constructors

(constructor)(handler, historySize)

Constructs a new instance of the History class

Declaration

constructor(handler: ISnapshotHandler, historySize?: number);

Parameters

Type	Name	Description
ISnapshotHandler	handler
number	historySize

Properties

canRedo

Declaration

get canRedo(): boolean;

Property Value

Type	Description
boolean

canUndo

Declaration

get canUndo(): boolean;

Property Value

Type	Description
boolean

historySize

Declaration

set historySize(historySize: number);

Property Value

Type	Description
number

overflowMaxUndoStepCount

Declaration

get overflowMaxUndoStepCount(): boolean;

Property Value

Type	Description
boolean

Methods

addChanged(listener)

Declaration

addChanged(listener: () => void): void;

Parameters

Type	Name	Description
() => void	listener

Returns

Type	Description
void

addRedoPerformed(listener)

Declaration

addRedoPerformed(listener: () => void): void;

Parameters

Type	Name	Description
() => void	listener

Returns

Type	Description
void

addSnapshot(suppressOnChanged, replaceLastSnapshot)

Declaration

addSnapshot(suppressOnChanged?: boolean, replaceLastSnapshot?: boolean): void;

Parameters

Type	Name	Description
boolean	suppressOnChanged
boolean	replaceLastSnapshot

Returns

Type	Description
void

addUndoPerformed(listener)

Declaration

addUndoPerformed(listener: () => void): void;

Parameters

Type	Name	Description
() => void	listener

Returns

Type	Description
void

clear(suppressOnChanged)

Declaration

clear(suppressOnChanged?: boolean): void;

Parameters

Type	Name	Description
boolean	suppressOnChanged

Returns

Type	Description
void

disable()

Declaration

disable(): void;

Returns

Type	Description
void

enable()

Declaration

enable(): void;

Returns

Type	Description
void

isPaused()

Declaration

isPaused(): boolean;

Returns

Type	Description
boolean

pause()

Declaration

pause(): void;

Returns

Type	Description
void

raiseChanged()

Declaration

raiseChanged(): void;

Returns

Type	Description
void

redo()

Declaration

redo(): void;

Returns

Type	Description
void

removeChanged(listener)

Declaration

removeChanged(listener: () => void): void;

Parameters

Type	Name	Description
() => void	listener

Returns

Type	Description
void

removeRedoPerformed(listener)

Declaration

removeRedoPerformed(listener: () => void): void;

Parameters

Type	Name	Description
() => void	listener

Returns

Type	Description
void

removeUndoPerformed(listener)

Declaration

removeUndoPerformed(listener: () => void): void;

Parameters

Type	Name	Description
() => void	listener

Returns

Type	Description
void

resume(addSnapshot, forceAddSnapshot, replaceLastSnapshot)

Declaration

resume(addSnapshot?: boolean, forceAddSnapshot?: boolean, replaceLastSnapshot?: boolean): void;

Parameters

Type	Name	Description
boolean	addSnapshot
boolean	forceAddSnapshot
boolean	replaceLastSnapshot

Returns

Type	Description
void

undo()

Declaration

undo(): void;

Returns

Type	Description
void