Class: ManualRowMove

ManualRowMove

plugins/manualRowMove/manualRowMove.js#L24

This plugin allows to change rows order. To make rows order persistent the Options#persistentState
plugin should be enabled.

API:

  • moveRow - move single row to the new position.
  • moveRows - move many rows (as an array of indexes) to the new position.

If you want apply visual changes, you have to call manually the render() method on the instance of handsontable.

The plugin creates additional components to make moving possibly using user interface:

  • backlight - highlight of selected rows.
  • guideline - line which shows where rows has been moved.

Methods

plugins/manualRowMove/manualRowMove.js#L751

destroy()

Destroys the plugin instance.

plugins/manualRowMove/manualRowMove.js#L152

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

plugins/manualRowMove/manualRowMove.js#L113

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

plugins/manualRowMove/manualRowMove.js#L106

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 than the ManualRowMove#enablePlugin method is called.

Returns: {Boolean}
plugins/manualRowMove/manualRowMove.js#L176

moveRow(row, target)

Moves a single row.

Parameters:
Name Type Description
row Number

Visual row index to be moved.
target Number

Visual row index being a target for the moved row.
Fires:
plugins/manualRowMove/manualRowMove.js#L188

moveRows(rows, target)

Moves a multiple rows.

Parameters:
Name Type Description
rows Array

Array of visual row indexes to be moved.
target Number

Visual row index being a target for the moved rows.
Fires:
plugins/manualRowMove/manualRowMove.js#L309

persistentStateLoad(){Array}

Loads the manual row positions from the persistent state (the Options#persistentState option has to be enabled).

Fires:
Returns: {Array} Stored state.
plugins/manualRowMove/manualRowMove.js#L297

persistentStateSave()

Saves the manual row positions to the persistent state (the Options#persistentState option has to be enabled).

Fires:
plugins/manualRowMove/manualRowMove.js#L140

updatePlugin()

Updates the plugin state. This method is executed when Core#updateSettings is invoked.