Interface IHistoryManager

Provides methods for undo/redo functionality.

interface IHistoryManager {
    autoBatchEnabled: boolean;
    canRedo: boolean;
    canUndo: boolean;
    onRedo: EventHandler<HistoryCommandOptions[]>;
    onUndo: EventHandler<HistoryCommandOptions[]>;
    clear(): void;
    dispose(): void;
    push(
        undo: VoidFunction,
        redo: VoidFunction,
        settings?: HistoryCommandOptions,
    ): void;
    redo(): void;
    undo(): void;
}

Hierarchy (View Summary)

IDisposable
- IHistoryManager

Implemented by

HistoryManager

Index

Properties

autoBatchEnabled canRedo canUndo onRedo onUndo

Methods

clear dispose push redo undo

Properties

autoBatchEnabled

autoBatchEnabled: boolean

Whether synchronous updates should be batched automatically.

`Readonly`canRedo

canRedo: boolean

Indicates whether redo is available.

`Readonly`canUndo

canUndo: boolean

Indicates whether undo is available.

onRedo

onRedo: EventHandler<HistoryCommandOptions[]>

Event raised when redi is called.

onUndo

onUndo: EventHandler<HistoryCommandOptions[]>

event raised when undo is called.

Methods

clear

clear(): void
Clears the history.

Returns void
- Defined in @tessa/platform/src/history/historyTypes.ts:24

dispose

dispose(): void
Returns void
Inherited from IDisposable.dispose
- Defined in @tessa/core/src/common/disposable.ts:4

push

push(
    undo: VoidFunction,
    redo: VoidFunction,
    settings?: HistoryCommandOptions,
): void
Writes undo/redo commands to history.
Parameters
- undo: VoidFunction
- redo: VoidFunction
- Optionalsettings: HistoryCommandOptions
Returns void
- Defined in @tessa/platform/src/history/historyTypes.ts:15

redo

redo(): void
Repeats the last undone command.

Returns void
- Defined in @tessa/platform/src/history/historyTypes.ts:21

undo

undo(): void
Undoes the last command.

Returns void
- Defined in @tessa/platform/src/history/historyTypes.ts:18