ManualRowMove

Members

PLUGIN_KEY

Ask AI

Source code

ManualRowMove.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

ManualRowMove.PLUGIN_PRIORITY

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

SETTING_KEYS

Ask AI

Source code

ManualRowMove.SETTING_KEYS

Returns the list of settings keys observed by the plugin for configuration changes.

Methods

destroy

Ask AI

Source code

manualRowMove.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

manualRowMove.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

dragRow

Ask AI

Source code

manualRowMove.dragRow(row, dropIndex) ⇒ boolean

Drag a single row to drop index position.

Emits: Hooks#event:beforeRowMove, Hooks#event:afterRowMove

Param	Type	Description
row	number	Visual row index to be dragged.
dropIndex	number	Visual row index, being a drop index for the moved rows. Points to where we are going to drop the moved elements. To check visualization of drop index please take a look at documentation.

dragRows

Ask AI

Source code

manualRowMove.dragRows(rows, dropIndex) ⇒ boolean

Drag multiple rows to drop index position.

Emits: Hooks#event:beforeRowMove, Hooks#event:afterRowMove

Param	Type	Description
rows	Array	Array of visual row indexes to be dragged.
dropIndex	number	Visual row index, being a drop index for the moved rows. Points to where we are going to drop the moved elements. To check visualization of drop index please take a look at documentation.

enablePlugin

Ask AI

Source code

manualRowMove.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Ask AI

Source code

manualRowMove.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 ManualRowMove#enablePlugin method is called. When [[Options#dataProvider]] is a complete server-backed configuration, the DataProvider plugin blocks this plugin from enabling.

isMovePossible

Ask AI

Source code

manualRowMove.isMovePossible(movedRows, finalIndex) ⇒ boolean

Indicates if it’s possible to move rows to the desired position. Some of the actions aren’t possible, i.e. You can’t move more than one element to the last position.

Param	Type	Description
movedRows	Array	Array of visual row indexes to be moved.
finalIndex	number	Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action. To check the visualization of the final index, please take a look at documentation.

moveRow

Ask AI

Source code

manualRowMove.moveRow(row, finalIndex) ⇒ boolean

Moves a single row.

To see the outcome, rerender your grid by calling render().

Emits: Hooks#event:beforeRowMove, Hooks#event:afterRowMove

Param	Type	Description
row	number	Visual row index to be moved.
finalIndex	number	Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action. To check the visualization of the final index, please take a look at documentation.

moveRows

Ask AI

Source code

manualRowMove.moveRows(rows, finalIndex) ⇒ boolean

Moves multiple rows.

To see the outcome, rerender your grid by calling render().

Emits: Hooks#event:beforeRowMove, Hooks#event:afterRowMove

Param	Type	Description
rows	Array	Array of visual row indexes to be moved.
finalIndex	number	Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action. To check the visualization of the final index, please take a look at documentation.

updatePlugin

Ask AI

Source code

manualRowMove.updatePlugin()

Updates the plugin’s state.

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

• manualRowMove