UndoManager

Defined in: undo/UndoManager.ts:23

Manages undo/redo history for a diagram.

Constructors

Constructor

new UndoManager(maxHistorySize?): UndoManager

Defined in: undo/UndoManager.ts:32

Parameters

maxHistorySize?

number = 100

Returns

UndoManager

Accessors

clearsHistory

Get Signature

get clearsHistory(): boolean

Defined in: undo/UndoManager.ts:57

GoJS-compatible: Whether undo/redo history is cleared by non-undoable actions.

Returns

boolean

Set Signature

set clearsHistory(value): void

Defined in: undo/UndoManager.ts:61

Parameters

value

boolean

Returns

void

---

isEnabled

Get Signature

get isEnabled(): boolean

Defined in: undo/UndoManager.ts:37

GoJS-compatible: Whether undo/redo is enabled.

Returns

boolean

Set Signature

set isEnabled(value): void

Defined in: undo/UndoManager.ts:41

Parameters

value

boolean

Returns

void

---

isUndoingRedoing

Get Signature

get isUndoingRedoing(): boolean

Defined in: undo/UndoManager.ts:84

GoJS-compatible: Whether the UndoManager is currently undoing or redoing.

Returns

boolean

---

maxHistoryLength

Get Signature

get maxHistoryLength(): number

Defined in: undo/UndoManager.ts:46

GoJS-compatible: The maximum number of undo/redo steps kept in history.

Returns

number

Set Signature

set maxHistoryLength(value): void

Defined in: undo/UndoManager.ts:50

Parameters

value

number

Returns

void

---

skipUndoManager

Get Signature

get skipUndoManager(): boolean

Defined in: undo/UndoManager.ts:75

Returns

boolean

Set Signature

set skipUndoManager(value): void

Defined in: undo/UndoManager.ts:79

Parameters

value

boolean

Returns

void

Methods

addListener()

addListener(listener): void

Defined in: undo/UndoManager.ts:258

Add a change listener.

Parameters

listener

UndoManagerEventHandler

Returns

void

---

beginTransaction()

beginTransaction(name?): void

Defined in: undo/UndoManager.ts:120

Begin a transaction. Commands executed afterward are grouped into one undo unit.

Parameters

name?

string = 'Transaction'

Returns

void

---

canRedo()

canRedo(): boolean

Defined in: undo/UndoManager.ts:224

Check if redo is available.

Returns

boolean

---

canUndo()

canUndo(): boolean

Defined in: undo/UndoManager.ts:219

Check if undo is available.

Returns

boolean

---

clear()

clear(): void

Defined in: undo/UndoManager.ts:251

Clear all history.

Returns

void

---

commitTransaction()

commitTransaction(): Transaction | null

Defined in: undo/UndoManager.ts:128

Commit the current transaction as a single undoable command. Returns the committed transaction, or null if no transaction is open.

Returns

Transaction | null

---

execute()

execute(command): void

Defined in: undo/UndoManager.ts:89

Execute a command and add it to the undo stack.

Parameters

command

Command

Returns

void

---

getRedoDescription()

getRedoDescription(): string | null

Defined in: undo/UndoManager.ts:245

Get the description of the next redo command.

Returns

string | null

---

getRedoStack()

getRedoStack(): readonly Command[]

Defined in: undo/UndoManager.ts:234

Get the redo stack.

Returns

readonly Command[]

---

getTransactionDepth()

getTransactionDepth(): number

Defined in: undo/UndoManager.ts:178

Get the depth of open transactions.

Returns

number

---

getUndoDescription()

getUndoDescription(): string | null

Defined in: undo/UndoManager.ts:239

Get the description of the next undo command.

Returns

string | null

---

getUndoStack()

getUndoStack(): readonly Command[]

Defined in: undo/UndoManager.ts:229

Get the undo stack.

Returns

readonly Command[]

---

isTransactionOpen()

isTransactionOpen(): boolean

Defined in: undo/UndoManager.ts:173

Check whether a transaction is currently open.

Returns

boolean

---

redo()

redo(): boolean

Defined in: undo/UndoManager.ts:201

Redo the last undone command.

Returns

boolean

---

removeListener()

removeListener(listener): void

Defined in: undo/UndoManager.ts:263

Remove a change listener.

Parameters

listener

UndoManagerEventHandler

Returns

void

---

rollbackTransaction()

rollbackTransaction(): boolean

Defined in: undo/UndoManager.ts:161

Roll back (cancel) the current transaction, undoing its commands. Returns true if a transaction was rolled back.

Returns

boolean

---

setTransactionIsSeparateFromHistory()

setTransactionIsSeparateFromHistory(): void

Defined in: undo/UndoManager.ts:70

GoJS-compatible: Mark the current transaction as separate from history. No-op: GraphoJS doesn’t yet distinguish “separate from history” transactions from regular ones.

Returns

void

---

undo()

undo(): boolean

Defined in: undo/UndoManager.ts:183

Undo the last command.

Returns

boolean