Class History

The history API responsible for undo / redo.

Hierarchy

  • Events
    • History

Internal

constructor

Other

canRedo canUndo currentAction lastAction add addAndExecute clear redo undo

Internal

constructor

Other

canRedo

canUndo

currentAction

lastAction

add

  • add(action: HistoryAction): void

  • Adds history action

    Parameters

    Returns void

    Example

    const prevSelection = editor.selection.items;
    editor.history.add({
        name: 'clear selection',
        redo: () => { editor.selection.clear({ history: false }); },
        undo: () => { editor.selection.set(prevSelection, { history: false }); },
    });

addAndExecute

  • addAndExecute(action: HistoryAction): void

  • Adds history action and execute redo

    Parameters

    Returns void

    Example

    const prevSelection = editor.selection.items;
    editor.history.addAndExecute({
        name: 'clear selection',
        redo: () => { editor.selection.clear({ history: false }); },
        undo: () => { editor.selection.set(prevSelection, { history: false }); },
    });

clear

redo

undo

Settings

Member Visibility

On This Page

Internal
Other