ManualColumnMove

Members

PLUGIN_KEY

Ask AI

Source code

ManualColumnMove.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

ManualColumnMove.PLUGIN_PRIORITY

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

Methods

destroy

Ask AI

Source code

manualColumnMove.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

manualColumnMove.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

dragColumn

Ask AI

Source code

manualColumnMove.dragColumn(column, dropIndex) ⇒ boolean

Drag a single column to drop index position.

Emits: Hooks#event:beforeColumnMove, Hooks#event:afterColumnMove

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

dragColumns

Ask AI

Source code

manualColumnMove.dragColumns(columns, dropIndex) ⇒ boolean

Drag multiple columns to drop index position.

Emits: Hooks#event:beforeColumnMove, Hooks#event:afterColumnMove

Param	Type	Description
columns	Array	Array of visual column indexes to be dragged.
dropIndex	number	Visual column index, being a drop index for the moved columns. 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

manualColumnMove.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Ask AI

Source code

manualColumnMove.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 ManualColumnMove#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

manualColumnMove.isMovePossible(movedColumns, finalIndex) ⇒ boolean

Indicates if it’s possible to move columns 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
movedColumns	Array	Array of visual column indexes to be moved.
finalIndex	number	Visual column index, being a start index for the moved columns. 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.

moveColumn

Ask AI

Source code

manualColumnMove.moveColumn(column, finalIndex) ⇒ boolean

Moves a single column.

Emits: Hooks#event:beforeColumnMove, Hooks#event:afterColumnMove

Param	Type	Description
column	number	Visual column index to be moved.
finalIndex	number	Visual column index, being a start index for the moved columns. 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.

moveColumns

Ask AI

Source code

manualColumnMove.moveColumns(columns, finalIndex) ⇒ boolean

Moves a multiple columns.

Emits: Hooks#event:beforeColumnMove, Hooks#event:afterColumnMove

Param	Type	Description
columns	Array	Array of visual column indexes to be moved.
finalIndex	number	Visual column index, being a start index for the moved columns. 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

manualColumnMove.updatePlugin()

Updates the plugin’s state.

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

• manualColumnMove