UndoRedo

Description

Initializes the plugin and registers all built-in undo/redo action handlers for the given Handsontable instance.

Members

PLUGIN_KEY

Ask AI

Source code

UndoRedo.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Ask AI

Source code

UndoRedo.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

SETTING_KEYS

Ask AI

Source code

UndoRedo.SETTING_KEYS

Returns whether the plugin handles its own settings keys without a dedicated key list.

Methods

clear

Ask AI

Source code

undoRedo.clear()

Clears undo and redo history.

destroy

Ask AI

Source code

undoRedo.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

undoRedo.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

done

Ask AI

Source code

undoRedo.done(wrappedAction, [source])

Stash information about performed actions.

Emits: Hooks#event:beforeUndoStackChange, Hooks#event:afterUndoStackChange, Hooks#event:beforeRedoStackChange, Hooks#event:afterRedoStackChange

Param	Type	Description
wrappedAction	function	The action descriptor wrapped in a closure.
[source]	string	optional Source of the action. It is defined just for more general actions (not related to plugins).

enablePlugin

Ask AI

Source code

undoRedo.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Ask AI

Source code

undoRedo.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit hook and if it returns true then the UndoRedo#enablePlugin method is called.

isRedoAvailable

Ask AI

Source code

undoRedo.isRedoAvailable() ⇒ boolean

Checks if redo action is available.

Returns: boolean - Return true if redo can be performed, false otherwise.

isUndoAvailable

Ask AI

Source code

undoRedo.isUndoAvailable() ⇒ boolean

Checks if undo action is available.

Returns: boolean - Return true if undo can be performed, false otherwise.

redo

Ask AI

Source code

undoRedo.redo()

Redo the previous action performed to the table (used to reverse an undo).

Emits: Hooks#event:beforeUndoStackChange, Hooks#event:afterUndoStackChange, Hooks#event:beforeRedoStackChange, Hooks#event:afterRedoStackChange, Hooks#event:beforeRedo, Hooks#event:afterRedo

undo

Ask AI

Source code

undoRedo.undo()

Undo the last action performed to the table.

Emits: Hooks#event:beforeUndoStackChange, Hooks#event:afterUndoStackChange, Hooks#event:beforeRedoStackChange, Hooks#event:afterRedoStackChange, Hooks#event:beforeUndo, Hooks#event:afterUndo