Skip to content

MoveCells

Members

PLUGIN_KEY

Source code

MoveCells.PLUGIN_KEY ⇒ string

The plugin’s registration key (the name of the setting that enables it).

PLUGIN_PRIORITY

Source code

MoveCells.PLUGIN_PRIORITY ⇒ number

The plugin’s initialization priority within the plugin registry.

SETTING_KEYS

Source code

MoveCells.SETTING_KEYS ⇒ Array<string>

The settings whose change through updateSettings triggers updatePlugin.

Methods

destroy

Source code

moveCells.destroy()

Destroys the plugin and removes any active drag preview.

disablePlugin

Source code

moveCells.disablePlugin()

Disables selection move interactions and cancels an active drag.

enablePlugin

Source code

moveCells.enablePlugin()

Enables selection move interactions.

isEnabled

Source code

moveCells.isEnabled() ⇒ boolean

Checks whether the plugin is enabled in the Handsontable settings.

moveCellRange

Source code

moveCells.moveCellRange(sourceRange, targetTopLeft, [isCopy]) ⇒ boolean

Moves or copies a visual cell range.

ParamTypeDefaultDescription
sourceRangeCellRangeThe source range.
targetTopLeftCellCoordsThe destination top-left cell.
[isCopy]booleanfalseoptional Whether to keep the source values.

Returns: boolean - Whether the operation completed. Returns false when the target equals the source top-left (a no-op — no hook fires and no undo entry is recorded), when the range spans more than CELLS_LIMIT cells, or when any other guard vetoes the operation.

updatePlugin

Source code

moveCells.updatePlugin()

Updates the plugin after its setting changes.