ContextMenu

Members

DEFAULT_ITEMS

Ask AI

Source code

ContextMenu.DEFAULT_ITEMS ⇒ Array<string>

Context menu default items order when contextMenu options is set as true.

PLUGIN_DEPS

Ask AI

Source code

ContextMenu.PLUGIN_DEPS

Returns the list of plugin dependencies required before this plugin can be initialized.

PLUGIN_KEY

Ask AI

Source code

ContextMenu.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

ContextMenu.PLUGIN_PRIORITY

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

Methods

close

Ask AI

Source code

contextMenu.close()

Closes the menu.

destroy

Ask AI

Source code

contextMenu.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

contextMenu.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

contextMenu.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

executeCommand

Ask AI

Source code

contextMenu.executeCommand(commandName, …params)

Execute context menu command.

The executeCommand() method works only for selected cells.

When no cells are selected, executeCommand() doesn’t do anything.

You can execute all predefined commands:

• 'row_above' - Insert row above
• 'row_below' - Insert row below
• 'col_left' - Insert column left
• 'col_right' - Insert column right
• 'clear_column' - Clear selected column
• 'remove_row' - Remove row
• 'remove_col' - Remove column
• 'undo' - Undo last action
• 'redo' - Redo last action
• 'make_read_only' - Make cell read only
• 'alignment:left' - Alignment to the left
• 'alignment:top' - Alignment to the top
• 'alignment:right' - Alignment to the right
• 'alignment:bottom' - Alignment to the bottom
• 'alignment:middle' - Alignment to the middle
• 'alignment:center' - Alignment to the center (justify).

Or you can execute command registered in settings where key is your command name.

Param	Type	Description
commandName	string	The command name to be executed.
…params	*	Additional parameters passed to command executor module.

isEnabled

Ask AI

Source code

contextMenu.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 ContextMenu#enablePlugin method is called.

open

Ask AI

Source code

contextMenu.open(position, offset)

Opens the menu and positions it based on the passed coordinates.

Emits: Hooks#event:beforeContextMenuShow, Hooks#event:afterContextMenuShow
Example

const menu = hot.getPlugin('contextMenu');

hot.selectCell(0, 0);
menu.open({ top: 50, left: 50 });

Param	Type	Description
position	Object Event	An object with top and left properties (coordinates relative to the browser viewport, without scroll offsets), or a native browser Event instance (e.g., a MouseEvent).
offset	Object	An object that applies an offset to the menu position.

updatePlugin

Ask AI

Source code

contextMenu.updatePlugin()

Updates the plugin’s state.

This method is executed when updateSettings() is invoked with any of the following configuration options:

• contextMenu