ManualColumnMove
Methods
destroy
manualColumnMove.destroy()
Destroys the plugin instance.
disablePlugin
manualColumnMove.disablePlugin()
Disables the plugin functionality for this Handsontable instance.
dragColumn
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
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
manualColumnMove.enablePlugin()
Enables the plugin functionality for this Handsontable instance.
isEnabled
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
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
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
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
manualColumnMove.updatePlugin()
Updates the plugin’s state.
This method is executed when updateSettings() is invoked with any of the following configuration options: