Editor API Reference - v1.1.4
    Preparing search index...

    Class History

    The history API responsible for undo / redo.

    Hierarchy

    • Events
      • History
    Index

    Internal

    constructor

    Other

    canRedo canUndo currentAction lastAction add addAndExecute clear redo undo

    Internal

    Other

    • get canRedo(): boolean

      Gets whether there are actions to redo.

      Returns boolean

    • set canRedo(value: boolean): void

      Sets whether there are actions to redo.

      Parameters

      • value: boolean

      Returns void

    • get canUndo(): boolean

      Gets whether there are actions to undo.

      Returns boolean

    • set canUndo(value: boolean): void

      Sets whether there are actions to undo.

      Parameters

      • value: boolean

      Returns void

    • get currentAction(): HistoryAction

      Gets the current action

      Returns HistoryAction

    • get lastAction(): HistoryAction

      Gets the last action

      Returns HistoryAction

    • Adds history action

      Parameters

      • action: HistoryAction

        The action

      Returns void

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

    • Adds history action and execute redo

      Parameters

      • action: HistoryAction

        The action

      Returns void

      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 history

      Returns void

      editor.history.clear();

    • Redo last action

      Returns void

      editor.history.redo();

    • Undo last action

      Returns void

      editor.history.undo();

    Settings

    Member Visibility

    On This Page

    Internal
    Other