Skip to main content

History

Classes​

History​

Constructors​

Constructor​
new History(handler, historySize?): History;
Parameters​
ParameterTypeDefault value
handlerISnapshotHandlerundefined
historySizenumber10
Returns​

History

Accessors​

canRedo​
Get Signature​
get canRedo(): boolean;
Returns​

boolean

canUndo​
Get Signature​
get canUndo(): boolean;
Returns​

boolean

historySize​
Set Signature​
set historySize(historySize): void;
Parameters​
ParameterType
historySizenumber
Returns​

void

overflowMaxUndoStepCount​
Get Signature​
get overflowMaxUndoStepCount(): boolean;
Returns​

boolean

Methods​

addChanged()​
addChanged(listener): void;
Parameters​
ParameterType
listener() => void
Returns​

void

addRedoPerformed()​
addRedoPerformed(listener): void;
Parameters​
ParameterType
listener() => void
Returns​

void

addSnapshot()​
addSnapshot(suppressOnChanged?, replaceLastSnapshot?): void;
Parameters​
ParameterTypeDefault value
suppressOnChangedbooleanfalse
replaceLastSnapshotbooleanfalse
Returns​

void

addUndoPerformed()​
addUndoPerformed(listener): void;
Parameters​
ParameterType
listener() => void
Returns​

void

clear()​
clear(suppressOnChanged?): void;
Parameters​
ParameterTypeDefault value
suppressOnChangedbooleanfalse
Returns​

void

disable()​
disable(): void;
Returns​

void

enable()​
enable(): void;
Returns​

void

isPaused()​
isPaused(): boolean;
Returns​

boolean

pause()​
pause(): void;
Returns​

void

raiseChanged()​
raiseChanged(): void;
Returns​

void

redo()​
redo(): void;
Returns​

void

removeChanged()​
removeChanged(listener): void;
Parameters​
ParameterType
listener() => void
Returns​

void

removeRedoPerformed()​
removeRedoPerformed(listener): void;
Parameters​
ParameterType
listener() => void
Returns​

void

removeUndoPerformed()​
removeUndoPerformed(listener): void;
Parameters​
ParameterType
listener() => void
Returns​

void

resume()​
resume(
addSnapshot?,
forceAddSnapshot?,
replaceLastSnapshot?): void;
Parameters​
ParameterTypeDefault value
addSnapshotbooleantrue
forceAddSnapshotbooleanfalse
replaceLastSnapshotbooleanfalse
Returns​

void

undo()​
undo(): void;
Returns​

void

Was this page helpful?