--- title: Hooks metaTitle: Hooks - API Reference - Handsontable Documentation permalink: /9.0/api/hooks canonicalUrl: /api/hooks editLink: false --- # Hooks [[toc]] ## Members ### afterAddChild ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1907 ::: _afterAddChild(parent, element, index)_ Fired by [NestedRows](@/api/nestedRows.md) plugin after adding a children to the NestedRows structure. This hook is fired when [Options#nestedRows](@/api/metaSchema.md#nestedrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | parent | `object` | The parent object. | | element | `object`
`undefined` | The element added as a child. If `undefined`, a blank child was added. | | index | `number`
`undefined` | The index within the parent where the new child was added. If `undefined`, the element was added as the last child. | ### afterAutofill ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L655 ::: _afterAutofill(fillData, sourceRange, targetRange, direction)_ Fired by [Autofill](@/api/autofill.md) plugin after populating the data in the autofill feature. This hook is fired when [Options#fillHandle](@/api/metaSchema.md#fillhandle) option is enabled. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | fillData | `Array` | The data that was used to fill the `targetRange`. If `beforeAutofill` was used and returned `[[]]`, this will be the same object that was returned from `beforeAutofill`. | | sourceRange | `CellRange` | The range values will be filled from. | | targetRange | `CellRange` | The range new values will be filled into. | | direction | `string` | Declares the direction of the autofill. Possible values: `up`, `down`, `left`, `right`. | ### afterBeginEditing ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1938 ::: _afterBeginEditing(row, column)_ Fired after the editor is opened and rendered. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index of the edited cell. | | column | `number` | Visual column index of the edited cell. | ### afterCellMetaReset ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L56 ::: _afterCellMetaReset_ Fired after resetting a cell's meta. This happens when the [Core#updateSettings](@/api/core.md#updatesettings) method is called. ### afterChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L63 ::: _afterChange(changes, [source])_ Fired after one or more cells has been changed. The changes are triggered in any situation when the value is entered using an editor or changed using API (e.q setDataAtCell). __Note:__ For performance reasons, the `changes` array is null for `"loadData"` source. **Example** ```js new Handsontable(element, { afterChange: (changes) => { changes.forEach(([row, prop, oldValue, newValue]) => { // Some logic... }); } }) ``` | Param | Type | Description | | --- | --- | --- | | changes | `Array` | 2D array containing information about each of the edited cells `[[row, prop, oldVal, newVal], ...]`. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterColumnCollapse ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2037 ::: _afterColumnCollapse(currentCollapsedColumns, destinationCollapsedColumns, collapsePossible, successfullyCollapsed)_ Fired by [CollapsibleColumns](@/api/collapsibleColumns.md) plugin before columns collapse. This hook is fired when [Options#collapsibleColumns](@/api/metaSchema.md#collapsiblecolumns) option is enabled. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | currentCollapsedColumns | `Array` | Current collapsible configuration - a list of collapsible physical column indexes. | | destinationCollapsedColumns | `Array` | Destination collapsible configuration - a list of collapsible physical column indexes. | | collapsePossible | `boolean` | `true`, if all of the column indexes are withing the bounds of the collapsed sections, `false` otherwise. | | successfullyCollapsed | `boolean` | `true`, if the action affected any non-collapsible column, `false` otherwise. | ### afterColumnExpand ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2061 ::: _afterColumnExpand(currentCollapsedColumns, destinationCollapsedColumns, expandPossible, successfullyExpanded)_ Fired by [CollapsibleColumns](@/api/collapsibleColumns.md) plugin before columns expand. This hook is fired when [Options#collapsibleColumns](@/api/metaSchema.md#collapsiblecolumns) option is enabled. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | currentCollapsedColumns | `Array` | Current collapsible configuration - a list of collapsible physical column indexes. | | destinationCollapsedColumns | `Array` | Destination collapsible configuration - a list of collapsible physical column indexes. | | expandPossible | `boolean` | `true`, if all of the column indexes are withing the bounds of the collapsed sections, `false` otherwise. | | successfullyExpanded | `boolean` | `true`, if the action affected any non-collapsible column, `false` otherwise. | ### afterColumnMove ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1304 ::: _afterColumnMove(movedColumns, finalIndex, dropIndex, movePossible, orderChanged)_ Fired by [ManualColumnMove](@/api/manualColumnMove.md) plugin after changing order of the visual indexes. This hook is fired when [Options#manualColumnMove](@/api/metaSchema.md#manualcolumnmove) option is enabled. | 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 visualization of final index please take a look at [documentation](@/guides/columns/column-moving.md). | | dropIndex | `number`
`undefined` | 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](@/guides/columns/column-moving.md). It's `undefined` when `dragColumns` function wasn't called. | | movePossible | `boolean` | Indicates if it was possible to move columns to the desired position. | | orderChanged | `boolean` | Indicates if order of columns was changed by move. | ### afterColumnResize ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1376 ::: _afterColumnResize(newSize, column, isDoubleClick)_ Fired by [ManualColumnResize](@/api/manualColumnResize.md) plugin after rendering the table with modified column sizes. This hook is fired when [Options#manualColumnResize](@/api/metaSchema.md#manualcolumnresize) option is enabled. | Param | Type | Description | | --- | --- | --- | | newSize | `number` | Calculated new column width. | | column | `number` | Visual index of the resized column. | | isDoubleClick | `boolean` | Flag that determines whether there was a double-click. | ### afterColumnSort ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1128 ::: _afterColumnSort(currentSortConfig, destinationSortConfigs)_ Fired by [ColumnSorting](@/api/columnSorting.md) and [MultiColumnSorting](@/api/multiColumnSorting.md) plugins after sorting the column. This hook is fired when [Options#columnSorting](@/api/metaSchema.md#columnsorting) or [Options#multiColumnSorting](@/api/metaSchema.md#multicolumnsorting) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentSortConfig | `Array` | Current sort configuration (for all sorted columns). | | destinationSortConfigs | `Array` | Destination sort configuration (for all sorted columns). | ### afterContextMenuDefaultOptions ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L85 ::: _afterContextMenuDefaultOptions(predefinedItems)_ Fired each time user opens [ContextMenu](@/api/contextMenu.md) and after setting up the Context Menu's default options. These options are a collection which user can select by setting an array of keys or an array of objects in [Options#contextMenu](@/api/metaSchema.md#contextmenu) option. | Param | Type | Description | | --- | --- | --- | | predefinedItems | `Array` | An array of objects containing information about the pre-defined Context Menu items. | ### afterContextMenuHide ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L124 ::: _afterContextMenuHide(context)_ Fired by [ContextMenu](@/api/contextMenu.md) plugin after hiding the Context Menu. This hook is fired when [Options#contextMenu](@/api/metaSchema.md#contextmenu) option is enabled. | Param | Type | Description | | --- | --- | --- | | context | `object` | The Context Menu plugin instance. | ### afterContextMenuShow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L142 ::: _afterContextMenuShow(context)_ Fired by [ContextMenu](@/api/contextMenu.md) plugin after opening the Context Menu. This hook is fired when [Options#contextMenu](@/api/metaSchema.md#contextmenu) option is enabled. | Param | Type | Description | | --- | --- | --- | | context | `object` | The Context Menu plugin instance. | ### afterCopy ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1232 ::: _afterCopy(data, coords)_ Fired by [CopyPaste](@/api/copyPaste.md) plugin after data are pasted into table. This hook is fired when [Options#copyPaste](@/api/metaSchema.md#copypaste) option is enabled. | Param | Type | Description | | --- | --- | --- | | data | `Array` | An array of arrays which contains the copied data. | | coords | `Array` | An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`) which was copied. | ### afterCopyLimit ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L151 ::: _afterCopyLimit(selectedRows, selectedColumns, copyRowsLimit, copyColumnsLimit)_ Fired by [CopyPaste](@/api/copyPaste.md) plugin after reaching the copy limit while copying data. This hook is fired when [Options#copyPaste](@/api/metaSchema.md#copypaste) option is enabled. | Param | Type | Description | | --- | --- | --- | | selectedRows | `number` | Count of selected copyable rows. | | selectedColumns | `number` | Count of selected copyable columns. | | copyRowsLimit | `number` | Current copy rows limit. | | copyColumnsLimit | `number` | Current copy columns limit. | ### afterCreateCol ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L184 ::: _afterCreateCol(index, amount, [source])_ Fired after created a new column. | Param | Type | Description | | --- | --- | --- | | index | `number` | Represents the visual index of first newly created column in the data source. | | amount | `number` | Number of newly created columns in the data source. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterCreateRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L207 ::: _afterCreateRow(index, amount, [source])_ Fired after created a new row. | Param | Type | Description | | --- | --- | --- | | index | `number` | Represents the visual index of first newly created row in the data source array. | | amount | `number` | Number of newly created rows in the data source array. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterCut ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1186 ::: _afterCut(data, coords)_ Fired by [CopyPaste](@/api/copyPaste.md) plugin after data was cut out from the table. This hook is fired when [Options#copyPaste](@/api/metaSchema.md#copypaste) option is enabled. | Param | Type | Description | | --- | --- | --- | | data | `Array` | An array of arrays which contains the cutted out data. | | coords | `Array` | An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`) which was cut out. | ### afterDeselect ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L218 ::: _afterDeselect_ Fired after the current cell is deselected. ### afterDestroy ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L225 ::: _afterDestroy_ Fired after destroying the Handsontable instance. ### afterDetachChild ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1928 ::: _afterDetachChild(parent, element)_ Fired by [NestedRows](@/api/nestedRows.md) plugin after detaching a child from its parent. This hook is fired when [Options#nestedRows](@/api/metaSchema.md#nestedrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | parent | `object` | An object representing the parent from which the element was detached. | | element | `object` | The detached element. | ### afterDocumentKeyDown ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L232 ::: _afterDocumentKeyDown(event)_ General hook which captures `keydown` events attached to the document body. These events are delegated to the hooks system and consumed by Core and internal modules (e.g plugins, editors). | Param | Type | Description | | --- | --- | --- | | event | `Event` | A native `keydown` event object. | ### afterDrawSelection ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L241 ::: _afterDrawSelection(currentRow, currentColumn, cornersOfSelection, layerLevel) ⇒ string | undefined_ Fired inside the Walkontable's selection `draw` method. Can be used to add additional class names to cells, depending on the current selection. **Since**: 0.38.1 | Param | Type | Description | | --- | --- | --- | | currentRow | `number` | Row index of the currently processed cell. | | currentColumn | `number` | Column index of the currently cell. | | cornersOfSelection | `Array` | Array of the current selection in a form of `[startRow, startColumn, endRow, endColumn]`. | | layerLevel | `number`
`undefined` | Number indicating which layer of selection is currently processed. | **Returns**: `string` | `undefined` - Can return a `String`, which will act as an additional `className` to be added to the currently processed cell. ### afterDropdownMenuDefaultOptions ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L104 ::: _afterDropdownMenuDefaultOptions(predefinedItems)_ Fired by [DropdownMenu](@/api/dropdownMenu.md) plugin after setting up the Dropdown Menu's default options. These options are a collection which user can select by setting an array of keys or an array of objects in [Options#dropdownMenu](@/api/metaSchema.md#dropdownmenu) option. | Param | Type | Description | | --- | --- | --- | | predefinedItems | `Array` | An array of objects containing information about the pre-defined Context Menu items. | ### afterDropdownMenuHide ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1887 ::: _afterDropdownMenuHide(instance)_ Fired by [DropdownMenu](@/api/dropdownMenu.md) plugin after hiding the Dropdown Menu. This hook is fired when [Options#dropdownMenu](@/api/metaSchema.md#dropdownmenu) option is enabled. | Param | Type | Description | | --- | --- | --- | | instance | `DropdownMenu` | The DropdownMenu instance. | ### afterDropdownMenuShow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1878 ::: _afterDropdownMenuShow(dropdownMenu)_ Fired by [DropdownMenu](@/api/dropdownMenu.md) plugin after opening the Dropdown Menu. This hook is fired when [Options#dropdownMenu](@/api/metaSchema.md#dropdownmenu) option is enabled. | Param | Type | Description | | --- | --- | --- | | dropdownMenu | `DropdownMenu` | The DropdownMenu instance. | ### afterFilter ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1469 ::: _afterFilter(conditionsStack)_ Fired by [Filters](@/api/filters.md) plugin after applying [filtering](@/guides/columns/column-filter.md). This hook is fired when [Options#filters](@/api/metaSchema.md#filters) option is enabled. | Param | Type | Description | | --- | --- | --- | | conditionsStack | `Array` | An array of objects with added conditions. ```js // Example format of the conditionsStack argument: [ { column: 2, conditions: [ {name: 'begins_with', args: [['S']]} ], operation: 'conjunction' }, { column: 4, conditions: [ {name: 'not_empty', args: []} ], operation: 'conjunction' }, ] ``` | ### afterFormulasValuesUpdate ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1498 ::: _afterFormulasValuesUpdate(changes)_ Called when a value is updated in the engine. **Since**: 9.0.0 | Param | Type | Description | | --- | --- | --- | | changes | `Array` | The values and location of applied changes. | ### afterGetCellMeta ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L263 ::: _afterGetCellMeta(row, column, cellProperties)_ Fired after getting the cell settings. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | cellProperties | `object` | Object containing the cell properties. | ### afterGetColHeader ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L273 ::: _afterGetColHeader(column, TH)_ Fired after retrieving information about a column header and appending it to the table header. | Param | Type | Description | | --- | --- | --- | | column | `number` | Visual column index. | | TH | `HTMLTableCellElement` | Header's TH element. | ### afterGetColumnHeaderRenderers ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1410 ::: _afterGetColumnHeaderRenderers(renderers)_ Fired after getting the column header renderers. | Param | Type | Description | | --- | --- | --- | | renderers | `Array` | An array of the column header renderers. | ### afterGetRowHeader ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L282 ::: _afterGetRowHeader(row, TH)_ Fired after retrieving information about a row header and appending it to the table header. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | TH | `HTMLTableCellElement` | Header's TH element. | ### afterGetRowHeaderRenderers ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1418 ::: _afterGetRowHeaderRenderers(renderers)_ Fired after getting the row header renderers. | Param | Type | Description | | --- | --- | --- | | renderers | `Array` | An array of the row header renderers. | ### afterHideColumns ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1789 ::: _afterHideColumns(currentHideConfig, destinationHideConfig, actionPossible, stateChanged)_ Fired by [HiddenColumns](@/api/hiddenColumns.md) plugin after marking the columns as hidden. Fired only if the [Options#hiddenColumns](@/api/metaSchema.md#hiddencolumns) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical column indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical column indexes. | | actionPossible | `boolean` | `true`, if the provided column indexes are valid, `false` otherwise. | | stateChanged | `boolean` | `true`, if the action affected any non-hidden columns, `false` otherwise. | ### afterHideRows ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1743 ::: _afterHideRows(currentHideConfig, destinationHideConfig, actionPossible, stateChanged)_ Fired by [HiddenRows](@/api/hiddenRows.md) plugin after marking the rows as hidden. Fired only if the [Options#hiddenRows](@/api/metaSchema.md#hiddenrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical row indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical row indexes. | | actionPossible | `boolean` | `true`, if provided row indexes are valid, `false` otherwise. | | stateChanged | `boolean` | `true`, if the action affected any non-hidden rows, `false` otherwise. | ### afterInit ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L291 ::: _afterInit_ Fired after the Handsontable instance is initiated. ### afterLanguageChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L630 ::: _afterLanguageChange(languageCode)_ Fired after successful change of language (when proper language code was set). **Since**: 0.35.0 | Param | Type | Description | | --- | --- | --- | | languageCode | `string` | New language code. | ### afterListen ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1988 ::: _afterListen_ Fired after the table was switched into listening mode. This allows Handsontable to capture keyboard events and respond in the right way. ### afterLoadData ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L298 ::: _afterLoadData(sourceData, initialLoad, source)_ Fired after new data is loaded (by `loadData` or `updateSettings` method) into the data source array. | Param | Type | Description | | --- | --- | --- | | sourceData | `Array` | Array of arrays or array of objects containing data. | | initialLoad | `boolean` | Flag that determines whether the data has been loaded during the initialization. | | source | `string` | Source of the call. | ### afterMergeCells ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1957 ::: _afterMergeCells(cellRange, mergeParent, [auto])_ Fired by [MergeCells](@/api/mergeCells.md) plugin after cell merging. This hook is fired when [Options#mergeCells](@/api/metaSchema.md#mergecells) option is enabled. | Param | Type | Default | Description | | --- | --- | --- | --- | | cellRange | `CellRange` | | Selection cell range. | | mergeParent | `object` | | The parent collection of the provided cell range. | | [auto] | `boolean` | false | `optional` `true` if called automatically by the plugin. | ### afterModifyTransformEnd ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1692 ::: _afterModifyTransformEnd(coords, rowTransformDir, colTransformDir)_ Fired after the end of the selection is being modified (e.g. Moving the selection with the arrow keys). | Param | Type | Description | | --- | --- | --- | | coords | `CellCoords` | Visual coords of the freshly selected cell. | | rowTransformDir | `number` | `-1` if trying to select a cell with a negative row index. `0` otherwise. | | colTransformDir | `number` | `-1` if trying to select a cell with a negative column index. `0` otherwise. | ### afterModifyTransformStart ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1682 ::: _afterModifyTransformStart(coords, rowTransformDir, colTransformDir)_ Fired after the start of the selection is being modified (e.g. Moving the selection with the arrow keys). | Param | Type | Description | | --- | --- | --- | | coords | `CellCoords` | Coords of the freshly selected cell. | | rowTransformDir | `number` | `-1` if trying to select a cell with a negative row index. `0` otherwise. | | colTransformDir | `number` | `-1` if trying to select a cell with a negative column index. `0` otherwise. | ### afterMomentumScroll ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L308 ::: _afterMomentumScroll_ Fired after a scroll event, which is identified as a momentum scroll (e.g. On an iPad). ### afterNamedExpressionAdded ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1507 ::: _afterNamedExpressionAdded(namedExpressionName, changes)_ Called when a named expression is added to the Formulas' engine instance. **Since**: 9.0.0 | Param | Type | Description | | --- | --- | --- | | namedExpressionName | `string` | The name of the added expression. | | changes | `Array` | The values and location of applied changes. | ### afterNamedExpressionRemoved ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1517 ::: _afterNamedExpressionRemoved(namedExpressionName, changes)_ Called when a named expression is removed from the Formulas' engine instance. **Since**: 9.0.0 | Param | Type | Description | | --- | --- | --- | | namedExpressionName | `string` | The name of the removed expression. | | changes | `Array` | The values and location of applied changes. | ### afterOnCellContextMenu ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L359 ::: _afterOnCellContextMenu(event, coords, TD)_ Fired after clicking right mouse button on a cell or row/column header. For example clicking on the row header of cell (0, 0) results with `afterOnCellContextMenu` called with coordinates `{row: 0, col: -1}`. **Since**: 4.1.0 | Param | Type | Description | | --- | --- | --- | | event | `Event` | `contextmenu` event object. | | coords | `CellCoords` | Coordinates object containing the visual row and visual column indexes of the clicked cell. | | TD | `HTMLTableCellElement` | Cell's TD (or TH) element. | ### afterOnCellCornerDblClick ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L323 ::: _afterOnCellCornerDblClick(event)_ Fired after a `dblclick` event is triggered on the cell corner (the drag handle). | Param | Type | Description | | --- | --- | --- | | event | `Event` | `dblclick` event object. | ### afterOnCellCornerMouseDown ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L315 ::: _afterOnCellCornerMouseDown(event)_ Fired after a `mousedown` event is triggered on the cell corner (the drag handle). | Param | Type | Description | | --- | --- | --- | | event | `Event` | `mousedown` event object. | ### afterOnCellMouseDown ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L331 ::: _afterOnCellMouseDown(event, coords, TD)_ Fired after clicking on a cell or row/column header. In case the row/column header was clicked, the coordinate indexes are negative. For example clicking on the row header of cell (0, 0) results with `afterOnCellMouseDown` called with coordinates `{row: 0, col: -1}`. | Param | Type | Description | | --- | --- | --- | | event | `Event` | `mousedown` event object. | | coords | `CellCoords` | Coordinates object containing the visual row and visual column indexes of the clicked cell. | | TD | `HTMLTableCellElement` | Cell's TD (or TH) element. | ### afterOnCellMouseOut ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L387 ::: _afterOnCellMouseOut(event, coords, TD)_ Fired after leaving a cell or row/column header with the mouse cursor. | Param | Type | Description | | --- | --- | --- | | event | `Event` | `mouseout` event object. | | coords | `CellCoords` | Leaved cell's visual coordinate object. | | TD | `HTMLTableCellElement` | Cell's TD (or TH) element. | ### afterOnCellMouseOver ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L373 ::: _afterOnCellMouseOver(event, coords, TD)_ Fired after hovering a cell or row/column header with the mouse cursor. In case the row/column header was hovered, the index is negative. For example, hovering over the row header of cell (0, 0) results with `afterOnCellMouseOver` called with coords `{row: 0, col: -1}`. | Param | Type | Description | | --- | --- | --- | | event | `Event` | `mouseover` event object. | | coords | `CellCoords` | Hovered cell's visual coordinate object. | | TD | `HTMLTableCellElement` | Cell's TD (or TH) element. | ### afterOnCellMouseUp ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L345 ::: _afterOnCellMouseUp(event, coords, TD)_ Fired after clicking on a cell or row/column header. In case the row/column header was clicked, the coordinate indexes are negative. For example clicking on the row header of cell (0, 0) results with `afterOnCellMouseUp` called with coordinates `{row: 0, col: -1}`. | Param | Type | Description | | --- | --- | --- | | event | `Event` | `mouseup` event object. | | coords | `CellCoords` | Coordinates object containing the visual row and visual column indexes of the clicked cell. | | TD | `HTMLTableCellElement` | Cell's TD (or TH) element. | ### afterPaste ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1273 ::: _afterPaste(data, coords)_ Fired by [CopyPaste](@/api/copyPaste.md) plugin after values are pasted into table. This hook is fired when [Options#copyPaste](@/api/metaSchema.md#copypaste) option is enabled. | Param | Type | Description | | --- | --- | --- | | data | `Array` | An array of arrays which contains the pasted data. | | coords | `Array` | An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`) that correspond to the previously selected area. | ### afterPluginsInitialized ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1718 ::: _afterPluginsInitialized_ Fired after initializing all the plugins. This hook should be added before Handsontable is initialized. **Example** ```js Handsontable.hooks.add('afterPluginsInitialized', myCallback); ``` ### afterRedo ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1626 ::: _afterRedo(action)_ Fired by [UndoRedo](@/api/undoRedo.md) plugin after the redo action. Contains information about the action that is being redone. This hook is fired when [Options#undo](@/api/metaSchema.md#undo) option is enabled. | Param | Type | Description | | --- | --- | --- | | action | `object` | The action object. Contains information about the action being redone. The `actionType` property of the object specifies the type of the action in a String format (e.g. `'remove_row'`). | ### afterRedoStackChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1636 ::: _afterRedoStackChange(undoneActionsBefore, undoneActionsAfter)_ Fired by [UndoRedo](@/api/undoRedo.md) plugin after changing redo stack. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | undoneActionsBefore | `Array` | Stack of actions which could be redone before performing new action. | | undoneActionsAfter | `Array` | Stack of actions which can be redone after performing new action. | ### afterRefreshDimensions ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2004 ::: _afterRefreshDimensions(previousDimensions, currentDimensions, stateChanged)_ Fired after the window was resized. | Param | Type | Description | | --- | --- | --- | | previousDimensions | `object` | Previous dimensions of the container. | | currentDimensions | `object` | Current dimensions of the container. | | stateChanged | `boolean` | `true`, if the container was re-render, `false` otherwise. | ### afterRemoveCellMeta ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L553 ::: _afterRemoveCellMeta(row, column, key, value)_ Fired after cell meta is removed. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | key | `string` | The removed meta key. | | value | `*` | Value which was under removed key of cell meta. | ### afterRemoveCol ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L397 ::: _afterRemoveCol(index, amount, physicalColumns, [source])_ Fired after one or more columns are removed. | Param | Type | Description | | --- | --- | --- | | index | `number` | Visual index of starter column. | | amount | `number` | An amount of removed columns. | | physicalColumns | `Array` | An array of physical columns removed from the data source. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterRemoveRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L409 ::: _afterRemoveRow(index, amount, physicalRows, [source])_ Fired after one or more rows are removed. | Param | Type | Description | | --- | --- | --- | | index | `number` | Visual index of starter row. | | amount | `number` | An amount of removed rows. | | physicalRows | `Array` | An array of physical rows removed from the data source. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterRender ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L421 ::: _afterRender(isForced)_ Fired after the Handsontable table is rendered. | Param | Type | Description | | --- | --- | --- | | isForced | `boolean` | Is `true` if rendering was triggered by a change of settings or data; or `false` if rendering was triggered by scrolling or moving selection. | ### afterRenderer ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L443 ::: _afterRenderer(TD, row, column, prop, value, cellProperties)_ Fired after finishing rendering the cell (after the renderer finishes). | Param | Type | Description | | --- | --- | --- | | TD | `HTMLTableCellElement` | Currently rendered cell's TD element. | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | prop | `string`
`number` | Column property name or a column index, if datasource is an array of arrays. | | value | `*` | Value of the rendered cell. | | cellProperties | `object` | Object containing the cell's properties. | ### afterRowMove ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1344 ::: _afterRowMove(movedRows, finalIndex, dropIndex, movePossible, orderChanged)_ Fired by [ManualRowMove](@/api/manualRowMove.md) plugin after changing the order of the visual indexes. This hook is fired when [Options#manualRowMove](@/api/metaSchema.md#manualrowmove) option is enabled. | 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 visualization of final index please take a look at [documentation](@/guides/rows/row-moving.md). | | dropIndex | `number`
`undefined` | 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](@/guides/rows/row-moving.md). It's `undefined` when `dragRows` function wasn't called. | | movePossible | `boolean` | Indicates if it was possible to move rows to the desired position. | | orderChanged | `boolean` | Indicates if order of rows was changed by move. | ### afterRowResize ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1399 ::: _afterRowResize(newSize, row, isDoubleClick)_ Fired by [ManualRowResize](@/api/manualRowResize.md) plugin after rendering the table with modified row sizes. This hook is fired when [Options#manualRowResize](@/api/metaSchema.md#manualrowresize) option is enabled. | Param | Type | Description | | --- | --- | --- | | newSize | `number` | Calculated new row height. | | row | `number` | Visual index of the resized row. | | isDoubleClick | `boolean` | Flag that determines whether there was a double-click. | ### afterScrollHorizontally ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L456 ::: _afterScrollHorizontally_ Fired after the horizontal scroll event. ### afterScrollVertically ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L463 ::: _afterScrollVertically_ Fired after the vertical scroll event. ### afterSelection ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L470 ::: _afterSelection(row, column, row2, column2, preventScrolling, selectionLayerLevel)_ Fired after one or more cells are selected (e.g. During mouse move). **Example** ```js new Handsontable(element, { afterSelection: (row, column, row2, column2, preventScrolling, selectionLayerLevel) => { // setting if prevent scrolling after selection preventScrolling.value = true; } }) ``` | Param | Type | Description | | --- | --- | --- | | row | `number` | Selection start visual row index. | | column | `number` | Selection start visual column index. | | row2 | `number` | Selection end visual row index. | | column2 | `number` | Selection end visual column index. | | preventScrolling | `object` | Object with `value` property where its value change will be observed. | | selectionLayerLevel | `number` | The number which indicates what selection layer is currently modified. | ### afterSelectionByProp ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L492 ::: _afterSelectionByProp(row, prop, row2, prop2, preventScrolling, selectionLayerLevel)_ Fired after one or more cells are selected. The `prop` and `prop2` arguments represent the source object property name instead of the column number. **Example** ```js new Handsontable(element, { afterSelectionByProp: (row, column, row2, column2, preventScrolling, selectionLayerLevel) => { // setting if prevent scrolling after selection preventScrolling.value = true; } }) ``` | Param | Type | Description | | --- | --- | --- | | row | `number` | Selection start visual row index. | | prop | `string` | Selection start data source object property name. | | row2 | `number` | Selection end visual row index. | | prop2 | `string` | Selection end data source object property name. | | preventScrolling | `object` | Object with `value` property where its value change will be observed. | | selectionLayerLevel | `number` | The number which indicates what selection layer is currently modified. | ### afterSelectionEnd ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L516 ::: _afterSelectionEnd(row, column, row2, column2, selectionLayerLevel)_ Fired after one or more cells are selected (e.g. On mouse up). | Param | Type | Description | | --- | --- | --- | | row | `number` | Selection start visual row index. | | column | `number` | Selection start visual column index. | | row2 | `number` | Selection end visual row index. | | column2 | `number` | Selection end visual column index. | | selectionLayerLevel | `number` | The number which indicates what selection layer is currently modified. | ### afterSelectionEndByProp ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L528 ::: _afterSelectionEndByProp(row, prop, row2, prop2, selectionLayerLevel)_ Fired after one or more cells are selected (e.g. On mouse up). The `prop` and `prop2` arguments represent the source object property name instead of the column number. | Param | Type | Description | | --- | --- | --- | | row | `number` | Selection start visual row index. | | prop | `string` | Selection start data source object property index. | | row2 | `number` | Selection end visual row index. | | prop2 | `string` | Selection end data source object property index. | | selectionLayerLevel | `number` | The number which indicates what selection layer is currently modified. | ### afterSetCellMeta ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L542 ::: _afterSetCellMeta(row, column, key, value)_ Fired after cell meta is changed. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | key | `string` | The updated meta key. | | value | `*` | The updated meta value. | ### afterSetDataAtCell ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L564 ::: _afterSetDataAtCell(changes, [source])_ Fired after cell data was changed. | Param | Type | Description | | --- | --- | --- | | changes | `Array` | An array of changes in format `[[row, column, oldValue, value], ...]`. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterSetDataAtRowProp ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L574 ::: _afterSetDataAtRowProp(changes, [source])_ Fired after cell data was changed. Called only when `setDataAtRowProp` was executed. | Param | Type | Description | | --- | --- | --- | | changes | `Array` | An array of changes in format `[[row, prop, oldValue, value], ...]`. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### afterSetSourceDataAtCell ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L585 ::: _afterSetSourceDataAtCell(changes, [source])_ Fired after cell source data was changed. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | changes | `Array` | An array of changes in format `[[row, column, oldValue, value], ...]`. | | [source] | `string` | `optional` String that identifies source of hook call. | ### afterSheetAdded ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1527 ::: _afterSheetAdded(addedSheetDisplayName)_ Called when a new sheet is added to the Formulas' engine instance. **Since**: 9.0.0 | Param | Type | Description | | --- | --- | --- | | addedSheetDisplayName | `string` | The name of the added sheet. | ### afterSheetRemoved ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1546 ::: _afterSheetRemoved(removedSheetDisplayName, changes)_ Called when a sheet is removed from the Formulas' engine instance. **Since**: 9.0.0 | Param | Type | Description | | --- | --- | --- | | removedSheetDisplayName | `string` | The removed sheet name. | | changes | `Array` | The values and location of applied changes. | ### afterSheetRenamed ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1536 ::: _afterSheetRenamed(oldDisplayName, newDisplayName)_ Called when a sheet in the Formulas' engine instance is renamed. **Since**: 9.0.0 | Param | Type | Description | | --- | --- | --- | | oldDisplayName | `string` | The old name of the sheet. | | newDisplayName | `string` | The new name of the sheet. | ### afterTrimRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1834 ::: _afterTrimRow(currentTrimConfig, destinationTrimConfig, actionPossible, stateChanged) ⇒ undefined | boolean_ Fired by [TrimRows](@/api/trimRows.md) plugin after trimming rows. This hook is fired when [Options#trimRows](@/api/metaSchema.md#trimrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentTrimConfig | `Array` | Current trim configuration - a list of trimmed physical row indexes. | | destinationTrimConfig | `Array` | Destination trim configuration - a list of trimmed physical row indexes. | | actionPossible | `boolean` | `true`, if all of the row indexes are withing the bounds of the table, `false` otherwise. | | stateChanged | `boolean` | `true`, if the action affected any non-trimmed rows, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the trimming action will not be completed. ### afterUndo ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1586 ::: _afterUndo(action)_ Fired by [UndoRedo](@/api/undoRedo.md) plugin after the undo action. Contains information about the action that is being undone. This hook is fired when [Options#undo](@/api/metaSchema.md#undo) option is enabled. | Param | Type | Description | | --- | --- | --- | | action | `object` | The action object. Contains information about the action being undone. The `actionType` property of the object specifies the type of the action in a String format. (e.g. `'remove_row'`). | ### afterUndoStackChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1596 ::: _afterUndoStackChange(doneActionsBefore, doneActionsAfter)_ Fired by [UndoRedo](@/api/undoRedo.md) plugin after changing undo stack. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | doneActionsBefore | `Array` | Stack of actions which could be undone before performing new action. | | doneActionsAfter | `Array` | Stack of actions which can be undone after performing new action. | ### afterUnhideColumns ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1812 ::: _afterUnhideColumns(currentHideConfig, destinationHideConfig, actionPossible, stateChanged)_ Fired by [HiddenColumns](@/api/hiddenColumns.md) plugin after marking the columns as not hidden. Fired only if the [Options#hiddenColumns](@/api/metaSchema.md#hiddencolumns) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical column indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical column indexes. | | actionPossible | `boolean` | `true`, if the provided column indexes are valid, `false` otherwise. | | stateChanged | `boolean` | `true`, if the action affected any hidden columns, `false` otherwise. | ### afterUnhideRows ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1766 ::: _afterUnhideRows(currentHideConfig, destinationHideConfig, actionPossible, stateChanged)_ Fired by [HiddenRows](@/api/hiddenRows.md) plugin after marking the rows as not hidden. Fired only if the [Options#hiddenRows](@/api/metaSchema.md#hiddenrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical row indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical row indexes. | | actionPossible | `boolean` | `true`, if provided row indexes are valid, `false` otherwise. | | stateChanged | `boolean` | `true`, if the action affected any hidden rows, `false` otherwise. | ### afterUnlisten ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1996 ::: _afterUnlisten_ Fired after the table was switched off from the listening mode. This makes the Handsontable inert for any keyboard events. ### afterUnmergeCells ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1978 ::: _afterUnmergeCells(cellRange, [auto])_ Fired by [MergeCells](@/api/mergeCells.md) plugin after unmerging the cells. This hook is fired when [Options#mergeCells](@/api/metaSchema.md#mergecells) option is enabled. | Param | Type | Default | Description | | --- | --- | --- | --- | | cellRange | `CellRange` | | Selection cell range. | | [auto] | `boolean` | false | `optional` `true` if called automatically by the plugin. | ### afterUntrimRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1857 ::: _afterUntrimRow(currentTrimConfig, destinationTrimConfig, actionPossible, stateChanged) ⇒ undefined | boolean_ Fired by [TrimRows](@/api/trimRows.md) plugin after untrimming rows. This hook is fired when [Options#trimRows](@/api/metaSchema.md#trimrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentTrimConfig | `Array` | Current trim configuration - a list of trimmed physical row indexes. | | destinationTrimConfig | `Array` | Destination trim configuration - a list of trimmed physical row indexes. | | actionPossible | `boolean` | `true`, if all of the row indexes are withing the bounds of the table, `false` otherwise. | | stateChanged | `boolean` | `true`, if the action affected any trimmed rows, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the untrimming action will not be completed. ### afterUpdateSettings ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L595 ::: _afterUpdateSettings(newSettings)_ Fired after calling the `updateSettings` method. | Param | Type | Description | | --- | --- | --- | | newSettings | `object` | New settings object. | ### afterValidate ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L603 ::: _afterValidate(isValid, value, row, prop, [source]) ⇒ void | boolean_ A plugin hook executed after validator function, only if validator function is defined. Validation result is the first parameter. This can be used to determinate if validation passed successfully or not. __Returning false from the callback will mark the cell as invalid__. | Param | Type | Description | | --- | --- | --- | | isValid | `boolean` | `true` if valid, `false` if not. | | value | `*` | The value in question. | | row | `number` | Visual row index. | | prop | `string`
`number` | Property name / visual column index. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `void` | `boolean` - If `false` the cell will be marked as invalid, `true` otherwise. ### afterViewportColumnCalculatorOverride ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1710 ::: _afterViewportColumnCalculatorOverride(calc)_ Fired inside the `viewportColumnCalculatorOverride` method. Allows modifying the row calculator parameters. | Param | Type | Description | | --- | --- | --- | | calc | `object` | The row calculator. | ### afterViewportRowCalculatorOverride ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1702 ::: _afterViewportRowCalculatorOverride(calc)_ Fired inside the `viewportRowCalculatorOverride` method. Allows modifying the row calculator parameters. | Param | Type | Description | | --- | --- | --- | | calc | `object` | The row calculator. | ### beforeAddChild ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1896 ::: _beforeAddChild(parent, element, index)_ Fired by [NestedRows](@/api/nestedRows.md) plugin before adding a children to the NestedRows structure. This hook is fired when [Options#nestedRows](@/api/metaSchema.md#nestedrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | parent | `object` | The parent object. | | element | `object`
`undefined` | The element added as a child. If `undefined`, a blank child was added. | | index | `number`
`undefined` | The index within the parent where the new child was added. If `undefined`, the element was added as the last child. | ### beforeAutofill ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L639 ::: _beforeAutofill(selectionData, sourceRange, targetRange, direction) ⇒ boolean | Array<Array>_ Fired by [Autofill](@/api/autofill.md) plugin before populating the data in the autofill feature. This hook is fired when [Options#fillHandle](@/api/metaSchema.md#fillhandle) option is enabled. | Param | Type | Description | | --- | --- | --- | | selectionData | `Array` | Data the autofill operation will start from. | | sourceRange | `CellRange` | The range values will be filled from. | | targetRange | `CellRange` | The range new values will be filled into. | | direction | `string` | Declares the direction of the autofill. Possible values: `up`, `down`, `left`, `right`. | **Returns**: `boolean` | `Array` - If false, the operation is cancelled. If array of arrays, the returned data will be passed into `populateFromArray` instead of the default autofill algorithm's result. ### beforeAutofillInsidePopulate ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1654 ::: _beforeAutofillInsidePopulate(index, direction, input, deltas)_ ***Deprecated*** Fired from the `populateFromArray` method during the `autofill` process. Fired for each "autofilled" cell individually. | Param | Type | Description | | --- | --- | --- | | index | `object` | Object containing `row` and `col` properties, defining the number of rows/columns from the initial cell of the autofill. | | direction | `string` | Declares the direction of the autofill. Possible values: `up`, `down`, `left`, `right`. | | input | `Array` | Contains an array of rows with data being used in the autofill. | | deltas | `Array` | The deltas array passed to the `populateFromArray` method. | ### beforeCellAlignment ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L669 ::: _beforeCellAlignment(stateBefore, range, type, alignmentClass)_ Fired before aligning the cell contents. | Param | Type | Description | | --- | --- | --- | | stateBefore | `object` | An object with class names defining the cell alignment. | | range | `Array` | An array of CellRange coordinates where the alignment will be applied. | | type | `string` | Type of the alignment - either `horizontal` or `vertical`. | | alignmentClass | `string` | String defining the alignment class added to the cell. Possible values: * `htLeft` * `htCenter` * `htRight` * `htJustify` * `htTop` * `htMiddle` * `htBottom`. | ### beforeChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L688 ::: _beforeChange(changes, [source]) ⇒ void | boolean_ Fired before one or more cells is changed. Its main purpose is to alter changes silently after input and before table rendering. **Example** ```js // To disregard a single change, set changes[i] to null or remove it from array using changes.splice(i, 1). new Handsontable(element, { beforeChange: (changes, source) => { // [[row, prop, oldVal, newVal], ...] changes[0] = null; } }); // To alter a single change, overwrite the desired value to changes[i][3]. new Handsontable(element, { beforeChange: (changes, source) => { // [[row, prop, oldVal, newVal], ...] changes[0][3] = 10; } }); // To cancel all edit, return false from the callback or set array length to 0 (changes.length = 0). new Handsontable(element, { beforeChange: (changes, source) => { // [[row, prop, oldVal, newVal], ...] return false; } }); ``` | Param | Type | Description | | --- | --- | --- | | changes | `Array` | 2D array containing information about each of the edited cells. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `void` | `boolean` - If `false` all changes were cancelled, `true` otherwise. ### beforeChangeRender ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L724 ::: _beforeChangeRender(changes, [source])_ Fired right before rendering the changes. | Param | Type | Description | | --- | --- | --- | | changes | `Array` | Array in form of `[row, prop, oldValue, newValue]`. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### beforeColumnCollapse ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2025 ::: _beforeColumnCollapse(currentCollapsedColumns, destinationCollapsedColumns, collapsePossible) ⇒ undefined | boolean_ Fired by [CollapsibleColumns](@/api/collapsibleColumns.md) plugin before columns collapse. This hook is fired when [Options#collapsibleColumns](@/api/metaSchema.md#collapsiblecolumns) option is enabled. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | currentCollapsedColumns | `Array` | Current collapsible configuration - a list of collapsible physical column indexes. | | destinationCollapsedColumns | `Array` | Destination collapsible configuration - a list of collapsible physical column indexes. | | collapsePossible | `boolean` | `true`, if all of the column indexes are withing the bounds of the collapsed sections, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the collapsing action will not be completed. ### beforeColumnExpand ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2049 ::: _beforeColumnExpand(currentCollapsedColumns, destinationCollapsedColumns, expandPossible) ⇒ undefined | boolean_ Fired by [CollapsibleColumns](@/api/collapsibleColumns.md) plugin before columns expand. This hook is fired when [Options#collapsibleColumns](@/api/metaSchema.md#collapsiblecolumns) option is enabled. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | currentCollapsedColumns | `Array` | Current collapsible configuration - a list of collapsible physical column indexes. | | destinationCollapsedColumns | `Array` | Destination collapsible configuration - a list of collapsible physical column indexes. | | expandPossible | `boolean` | `true`, if all of the column indexes are withing the bounds of the collapsed sections, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the expanding action will not be completed. ### beforeColumnMove ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1284 ::: _beforeColumnMove(movedColumns, finalIndex, dropIndex, movePossible) ⇒ void | boolean_ Fired by [ManualColumnMove](@/api/manualColumnMove.md) plugin before change order of the visual indexes. This hook is fired when [Options#manualColumnMove](@/api/metaSchema.md#manualcolumnmove) option is enabled. | 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 visualization of final index please take a look at [documentation](@/guides/columns/column-moving.md). | | dropIndex | `number`
`undefined` | 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](@/guides/columns/column-moving.md). It's `undefined` when `dragColumns` function wasn't called. | | movePossible | `boolean` | Indicates if it's possible to move rows to the desired position. | **Returns**: `void` | `boolean` - If `false` the column will not be moved, `true` otherwise. ### beforeColumnResize ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1364 ::: _beforeColumnResize(newSize, column, isDoubleClick) ⇒ number_ Fired by [ManualColumnResize](@/api/manualColumnResize.md) plugin before rendering the table with modified column sizes. This hook is fired when [Options#manualColumnResize](@/api/metaSchema.md#manualcolumnresize) option is enabled. | Param | Type | Description | | --- | --- | --- | | newSize | `number` | Calculated new column width. | | column | `number` | Visual index of the resized column. | | isDoubleClick | `boolean` | Flag that determines whether there was a double-click. | **Returns**: `number` - Returns a new column size or `undefined`, if column size should be calculated automatically. ### beforeColumnSort ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1115 ::: _beforeColumnSort(currentSortConfig, destinationSortConfigs) ⇒ boolean | void_ Fired by [ColumnSorting](@/api/columnSorting.md) and [MultiColumnSorting](@/api/multiColumnSorting.md) plugins before sorting the column. If you return `false` value inside callback for hook, then sorting will be not applied by the Handsontable (useful for server-side sorting). This hook is fired when [Options#columnSorting](@/api/metaSchema.md#columnsorting) or [Options#multiColumnSorting](@/api/metaSchema.md#multicolumnsorting) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentSortConfig | `Array` | Current sort configuration (for all sorted columns). | | destinationSortConfigs | `Array` | Destination sort configuration (for all sorted columns). | **Returns**: `boolean` | `void` - If `false` the column will not be sorted, `true` otherwise. ### beforeContextMenuSetItems ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L94 ::: _beforeContextMenuSetItems(menuItems)_ Fired each time user opens [ContextMenu](@/api/contextMenu.md) plugin before setting up the Context Menu's items but after filtering these options by user (`contextMenu` option). This hook can by helpful to determine if user use specified menu item or to set up one of the menu item to by always visible. | Param | Type | Description | | --- | --- | --- | | menuItems | `Array` | An array of objects containing information about to generated Context Menu items. | ### beforeContextMenuShow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L133 ::: _beforeContextMenuShow(context)_ Fired by [ContextMenu](@/api/contextMenu.md) plugin before opening the Context Menu. This hook is fired when [Options#contextMenu](@/api/metaSchema.md#context-menu) option is enabled. | Param | Type | Description | | --- | --- | --- | | context | `object` | The Context Menu instance. | ### beforeCopy ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1197 ::: _beforeCopy(data, coords) ⇒ \*_ Fired before values are copied into clipboard. **Example** ```js // To disregard a single row, remove it from array using data.splice(i, 1). ... new Handsontable(document.getElementById('example'), { beforeCopy: (data, coords) => { // data -> [[1, 2, 3], [4, 5, 6]] data.splice(0, 1); // data -> [[4, 5, 6]] // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}] } }); ... // To cancel copying, return false from the callback. ... new Handsontable(document.getElementById('example'), { beforeCopy: (data, coords) => { return false; } }); ... ``` | Param | Type | Description | | --- | --- | --- | | data | `Array` | An array of arrays which contains data to copied. | | coords | `Array` | An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`) which will copied. | **Returns**: `*` - If returns `false` then copying is canceled. ### beforeCreateCol ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L163 ::: _beforeCreateCol(index, amount, [source]) ⇒ \*_ Fired before created a new column. **Example** ```js // Return `false` to cancel column inserting. new Handsontable(element, { beforeCreateCol: function(data, coords) { return false; } }); ``` | Param | Type | Description | | --- | --- | --- | | index | `number` | Represents the visual index of first newly created column in the data source array. | | amount | `number` | Number of newly created columns in the data source array. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `*` - If `false` then creating columns is cancelled. ### beforeCreateRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L195 ::: _beforeCreateRow(index, amount, [source]) ⇒ \* | boolean_ Fired before created a new row. | Param | Type | Description | | --- | --- | --- | | index | `number` | Represents the visual index of first newly created row in the data source array. | | amount | `number` | Number of newly created rows in the data source array. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeCut ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1156 ::: _beforeCut(data, coords) ⇒ \*_ Fired by [CopyPaste](@/api/copyPaste.md) plugin before copying the values into clipboard and before clearing values of the selected cells. This hook is fired when [Options#copyPaste](@/api/metaSchema.md#copypaste) option is enabled. **Example** ```js // To disregard a single row, remove it from the array using data.splice(i, 1). new Handsontable(element, { beforeCut: function(data, coords) { // data -> [[1, 2, 3], [4, 5, 6]] data.splice(0, 1); // data -> [[4, 5, 6]] // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}] } }); // To cancel a cutting action, just return `false`. new Handsontable(element, { beforeCut: function(data, coords) { return false; } }); ``` | Param | Type | Description | | --- | --- | --- | | data | `Array` | An array of arrays which contains data to cut. | | coords | `Array` | An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`) which will be cut out. | **Returns**: `*` - If returns `false` then operation of the cutting out is canceled. ### beforeDetachChild ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1918 ::: _beforeDetachChild(parent, element)_ Fired by [NestedRows](@/api/nestedRows.md) plugin before detaching a child from its parent. This hook is fired when [Options#nestedRows](@/api/metaSchema.md#nestedrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | parent | `object` | An object representing the parent from which the element is to be detached. | | element | `object` | The detached element. | ### beforeDrawBorders ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L734 ::: _beforeDrawBorders(corners, borderClassName)_ Fired before drawing the borders. | Param | Type | Description | | --- | --- | --- | | corners | `Array` | Array specifying the current selection borders. | | borderClassName | `string` | Specifies the border class name. | ### beforeDropdownMenuSetItems ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L114 ::: _beforeDropdownMenuSetItems(menuItems)_ Fired by [DropdownMenu](@/api/dropdownMenu.md) plugin before setting up the Dropdown Menu's items but after filtering these options by user (`dropdownMenu` option). This hook can by helpful to determine if user use specified menu item or to set up one of the menu item to by always visible. | Param | Type | Description | | --- | --- | --- | | menuItems | `Array` | An array of objects containing information about to generated Dropdown Menu items. | ### beforeDropdownMenuShow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1869 ::: _beforeDropdownMenuShow(dropdownMenu)_ Fired by [DropdownMenu](@/api/dropdownMenu.md) plugin before opening the dropdown menu. This hook is fired when [Options#dropdownMenu](@/api/metaSchema.md#dropdownmenu) option is enabled. | Param | Type | Description | | --- | --- | --- | | dropdownMenu | `DropdownMenu` | The DropdownMenu instance. | ### beforeFilter ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1437 ::: _beforeFilter(conditionsStack) ⇒ boolean_ Fired by [Filters](@/api/filters.md) plugin before applying [filtering](@/guides/columns/column-filter.md). This hook is fired when [Options#filters](@/api/metaSchema.md#filters) option is enabled. | Param | Type | Description | | --- | --- | --- | | conditionsStack | `Array` | An array of objects with added formulas. ```js // Example format of the conditionsStack argument: [ { column: 2, conditions: [ {name: 'begins_with', args: [['S']]} ], operation: 'conjunction' }, { column: 4, conditions: [ {name: 'not_empty', args: []} ], operation: 'conjunction' }, ] ``` | **Returns**: `boolean` - If hook returns `false` value then filtering won't be applied on the UI side (server-side filtering). ### beforeGetCellMeta ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L743 ::: _beforeGetCellMeta(row, column, cellProperties)_ Fired before getting cell settings. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | cellProperties | `object` | Object containing the cell's properties. | ### beforeHideColumns ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1777 ::: _beforeHideColumns(currentHideConfig, destinationHideConfig, actionPossible) ⇒ undefined | boolean_ Fired by [HiddenColumns](@/api/hiddenColumns.md) plugin before marking the columns as hidden. Fired only if the [Options#hiddenColumns](@/api/metaSchema.md#hiddencolumns) option is enabled. Returning `false` in the callback will prevent the hiding action from completing. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical column indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical column indexes. | | actionPossible | `boolean` | `true`, if the provided column indexes are valid, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the hiding action will not be completed. ### beforeHideRows ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1731 ::: _beforeHideRows(currentHideConfig, destinationHideConfig, actionPossible) ⇒ undefined | boolean_ Fired by [HiddenRows](@/api/hiddenRows.md) plugin before marking the rows as hidden. Fired only if the [Options#hiddenRows](@/api/metaSchema.md#hiddenrows) option is enabled. Returning `false` in the callback will prevent the hiding action from completing. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical row indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical row indexes. | | actionPossible | `boolean` | `true`, if provided row indexes are valid, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the hiding action will not be completed. ### beforeHighlightingColumnHeader ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1071 ::: _beforeHighlightingColumnHeader(column, headerLevel, highlightMeta) ⇒ number | undefined_ Allows modify the visual column index that is used to retrieve the column header element (TH) before it's highlighted (proper CSS class names are added). Modifying the visual column index allows building a custom implementation of the nested headers feature or other features that require highlighting other DOM elements than that the rendering engine, by default, would have highlighted. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | column | `number` | Visual column index. | | headerLevel | `number` | Row header level (0 = most distant to the table). | | highlightMeta | `object` | An object that contains additional information about processed selection. | ### beforeHighlightingRowHeader ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1056 ::: _beforeHighlightingRowHeader(row, headerLevel, highlightMeta) ⇒ number | undefined_ Allows modify the visual row index that is used to retrieve the row header element (TH) before it's highlighted (proper CSS class names are added). Modifying the visual row index allows building a custom implementation of the nested headers feature or other features that require highlighting other DOM elements than that the rendering engine, by default, would have highlighted. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | headerLevel | `number` | Column header level (0 = most distant to the table). | | highlightMeta | `object` | An object that contains additional information about processed selection. | ### beforeInit ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L765 ::: _beforeInit_ Fired before the Handsontable instance is initiated. ### beforeInitWalkontable ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L772 ::: _beforeInitWalkontable(walkontableConfig)_ Fired before the Walkontable instance is initiated. | Param | Type | Description | | --- | --- | --- | | walkontableConfig | `object` | Walkontable configuration object. | ### beforeKeyDown ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L792 ::: _beforeKeyDown(event)_ Fired before keydown event is handled. It can be used to overwrite default key bindings. __Note__: To prevent default behavior you need to call `event.stopImmediatePropagation()` in your `beforeKeyDown` handler. | Param | Type | Description | | --- | --- | --- | | event | `Event` | Original DOM event. | ### beforeLanguageChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L621 ::: _beforeLanguageChange(languageCode)_ Fired before successful change of language (when proper language code was set). **Since**: 0.35.0 | Param | Type | Description | | --- | --- | --- | | languageCode | `string` | New language code. | ### beforeLoadData ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L780 ::: _beforeLoadData(sourceData, initialLoad, source) ⇒ Array_ Fired before new data is loaded (by `loadData` or `updateSettings` method) into the data source array. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | sourceData | `Array` | Array of arrays or array of objects containing data. | | initialLoad | `boolean` | Flag that determines whether the data has been loaded during the initialization. | | source | `string` | Source of the call. | **Returns**: `Array` - The returned array will be used as new dataset. ### beforeMergeCells ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1947 ::: _beforeMergeCells(cellRange, [auto])_ Fired by [MergeCells](@/api/mergeCells.md) plugin before cell merging. This hook is fired when [Options#mergeCells](@/api/metaSchema.md#mergecells) option is enabled. | Param | Type | Default | Description | | --- | --- | --- | --- | | cellRange | `CellRange` | | Selection cell range. | | [auto] | `boolean` | false | `optional` `true` if called automatically by the plugin. | ### beforeOnCellContextMenu ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L825 ::: _beforeOnCellContextMenu(event, coords, TD)_ Fired after the user clicked a cell, but before all the calculations related with it. **Since**: 4.1.0 | Param | Type | Description | | --- | --- | --- | | event | `Event` | The `contextmenu` event object. | | coords | `CellCoords` | Cell coords object containing the visual coordinates of the clicked cell. | | TD | `HTMLTableCellElement` | TD element. | ### beforeOnCellMouseDown ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L803 ::: _beforeOnCellMouseDown(event, coords, TD, controller)_ Fired after the user clicked a cell, but before all the calculations related with it. | Param | Type | Description | | --- | --- | --- | | event | `Event` | The `mousedown` event object. | | coords | `CellCoords` | Cell coords object containing the visual coordinates of the clicked cell. | | TD | `HTMLTableCellElement` | TD element. | | controller | `object` | An object with properties `row`, `column` and `cells`. Each property contains a boolean value that allows or disallows changing the selection for that particular area. | ### beforeOnCellMouseOut ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L848 ::: _beforeOnCellMouseOut(event, coords, TD)_ Fired after the user moved cursor out from a cell, but before all the calculations related with it. | Param | Type | Description | | --- | --- | --- | | event | `Event` | The `mouseout` event object. | | coords | `CellCoords` | CellCoords object containing the visual coordinates of the leaved cell. | | TD | `HTMLTableCellElement` | TD element. | ### beforeOnCellMouseOver ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L836 ::: _beforeOnCellMouseOver(event, coords, TD, controller)_ Fired after the user moved cursor over a cell, but before all the calculations related with it. | Param | Type | Description | | --- | --- | --- | | event | `Event` | The `mouseover` event object. | | coords | `CellCoords` | CellCoords object containing the visual coordinates of the clicked cell. | | TD | `HTMLTableCellElement` | TD element. | | controller | `object` | An object with properties `row`, `column` and `cell`. Each property contains a boolean value that allows or disallows changing the selection for that particular area. | ### beforeOnCellMouseUp ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L815 ::: _beforeOnCellMouseUp(event, coords, TD)_ Fired after the user clicked a cell. | Param | Type | Description | | --- | --- | --- | | event | `Event` | The `mouseup` event object. | | coords | `CellCoords` | Cell coords object containing the visual coordinates of the clicked cell. | | TD | `HTMLTableCellElement` | TD element. | ### beforePaste ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1243 ::: _beforePaste(data, coords) ⇒ \*_ Fired by [CopyPaste](@/api/copyPaste.md) plugin before values are pasted into table. This hook is fired when [Options#copyPaste](@/api/metaSchema.md#copypaste) option is enabled. **Example** ```js // To disregard a single row, remove it from array using data.splice(i, 1). new Handsontable(example, { beforePaste: (data, coords) => { // data -> [[1, 2, 3], [4, 5, 6]] data.splice(0, 1); // data -> [[4, 5, 6]] // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}] } }); // To cancel pasting, return false from the callback. new Handsontable(example, { beforePaste: (data, coords) => { return false; } }); ``` | Param | Type | Description | | --- | --- | --- | | data | `Array` | An array of arrays which contains data to paste. | | coords | `Array` | An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`) that correspond to the previously selected area. | **Returns**: `*` - If returns `false` then pasting is canceled. ### beforeRedo ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1606 ::: _beforeRedo(action) ⇒ \* | boolean_ Fired by [UndoRedo](@/api/undoRedo.md) plugin before the redo action. Contains information about the action that is being redone. This hook is fired when [Options#undo](@/api/metaSchema.md#undo) option is enabled. | Param | Type | Description | | --- | --- | --- | | action | `object` | The action object. Contains information about the action being redone. The `actionType` property of the object specifies the type of the action in a String format (e.g. `'remove_row'`). | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeRedoStackChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1617 ::: _beforeRedoStackChange(undoneActions)_ Fired by [UndoRedo](@/api/undoRedo.md) plugin before changing redo stack. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | undoneActions | `Array` | Stack of actions which may be redone. | ### beforeRefreshDimensions ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2014 ::: _beforeRefreshDimensions(previousDimensions, currentDimensions, actionPossible) ⇒ undefined | boolean_ Cancellable hook, called after resizing a window, but before redrawing a table. | Param | Type | Description | | --- | --- | --- | | previousDimensions | `object` | Previous dimensions of the container. | | currentDimensions | `object` | Current dimensions of the container. | | actionPossible | `boolean` | `true`, if current and previous dimensions are different, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the refresh action will not be completed. ### beforeRemoveCellClassNames ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L254 ::: _beforeRemoveCellClassNames ⇒ Array<string> | undefined_ Fired inside the Walkontable's `refreshSelections` method. Can be used to remove additional class names from all cells in the table. **Since**: 0.38.1 **Returns**: `Array` | `undefined` - Can return an `Array` of `String`s. Each of these strings will act like class names to be removed from all the cells in the table. ### beforeRemoveCellMeta ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L753 ::: _beforeRemoveCellMeta(row, column, key, value) ⇒ \* | boolean_ Fired before cell meta is removed. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | key | `string` | The removed meta key. | | value | `*` | Value which is under removed key of cell meta. | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeRemoveCol ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L858 ::: _beforeRemoveCol(index, amount, physicalColumns, [source]) ⇒ \* | boolean_ Fired before one or more columns are about to be removed. | Param | Type | Description | | --- | --- | --- | | index | `number` | Visual index of starter column. | | amount | `number` | Amount of columns to be removed. | | physicalColumns | `Array` | An array of physical columns removed from the data source. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeRemoveRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L871 ::: _beforeRemoveRow(index, amount, physicalRows, [source]) ⇒ \* | boolean_ Fired when one or more rows are about to be removed. | Param | Type | Description | | --- | --- | --- | | index | `number` | Visual index of starter row. | | amount | `number` | Amount of rows to be removed. | | physicalRows | `Array` | An array of physical rows removed from the data source. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeRender ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L884 ::: _beforeRender(isForced, skipRender)_ Fired before the Handsontable table is rendered. | Param | Type | Description | | --- | --- | --- | | isForced | `boolean` | If `true` rendering was triggered by a change of settings or data; or `false` if rendering was triggered by scrolling or moving selection. | | skipRender | `object` | Object with `skipRender` property, if it is set to `true ` the next rendering cycle will be skipped. | ### beforeRenderer ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L430 ::: _beforeRenderer(TD, row, column, prop, value, cellProperties)_ Fired before starting rendering the cell. | Param | Type | Description | | --- | --- | --- | | TD | `HTMLTableCellElement` | Currently rendered cell's TD element. | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | prop | `string`
`number` | Column property name or a column index, if datasource is an array of arrays. | | value | `*` | Value of the rendered cell. | | cellProperties | `object` | Object containing the cell's properties. | ### beforeRowMove ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1324 ::: _beforeRowMove(movedRows, finalIndex, dropIndex, movePossible) ⇒ \* | boolean_ Fired by [ManualRowMove](@/api/manualRowMove.md) plugin before changing the order of the visual indexes. This hook is fired when [Options#manualRowMove](@/api/metaSchema.md#manualrowmove) option is enabled. | 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 visualization of final index please take a look at [documentation](@/guides/rows/row-moving.md). | | dropIndex | `number`
`undefined` | 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](@/guides/rows/row-moving.md). It's `undefined` when `dragRows` function wasn't called. | | movePossible | `boolean` | Indicates if it's possible to move rows to the desired position. | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeRowResize ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1387 ::: _beforeRowResize(newSize, row, isDoubleClick) ⇒ number_ Fired by [ManualRowResize](@/api/manualRowResize.md) plugin before rendering the table with modified row sizes. This hook is fired when [Options#manualRowResize](@/api/metaSchema.md#manualrowresize) option is enabled. | Param | Type | Description | | --- | --- | --- | | newSize | `number` | Calculated new row height. | | row | `number` | Visual index of the resized row. | | isDoubleClick | `boolean` | Flag that determines whether there was a double-click. | **Returns**: `number` - Returns the new row size or `undefined` if row size should be calculated automatically. ### beforeSetCellMeta ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L894 ::: _beforeSetCellMeta(row, column, key, value) ⇒ \* | boolean_ Fired before cell meta is changed. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | key | `string` | The updated meta key. | | value | `*` | The updated meta value. | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeSetRangeEnd ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L923 ::: _beforeSetRangeEnd(coords)_ Fired before setting range is ended. | Param | Type | Description | | --- | --- | --- | | coords | `CellCoords` | CellCoords instance. | ### beforeSetRangeStart ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L915 ::: _beforeSetRangeStart(coords)_ Fired before setting range is started. | Param | Type | Description | | --- | --- | --- | | coords | `CellCoords` | CellCoords instance. | ### beforeSetRangeStartOnly ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L907 ::: _beforeSetRangeStartOnly(coords)_ Fired before setting range is started but not finished yet. | Param | Type | Description | | --- | --- | --- | | coords | `CellCoords` | CellCoords instance. | ### beforeStretchingColumnWidth ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1426 ::: _beforeStretchingColumnWidth(stretchedWidth, column) ⇒ number_ Fired before applying stretched column width to column. | Param | Type | Description | | --- | --- | --- | | stretchedWidth | `number` | Calculated width. | | column | `number` | Visual column index. | **Returns**: `number` - Returns new width which will be applied to the column element. ### beforeTouchScroll ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L931 ::: _beforeTouchScroll_ Fired before the logic of handling a touch scroll, when user started scrolling on a touch-enabled device. ### beforeTrimRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1823 ::: _beforeTrimRow(currentTrimConfig, destinationTrimConfig, actionPossible) ⇒ undefined | boolean_ Fired by [TrimRows](@/api/trimRows.md) plugin before trimming rows. This hook is fired when [Options#trimRows](@/api/metaSchema.md#trimrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentTrimConfig | `Array` | Current trim configuration - a list of trimmed physical row indexes. | | destinationTrimConfig | `Array` | Destination trim configuration - a list of trimmed physical row indexes. | | actionPossible | `boolean` | `true`, if all of the row indexes are withing the bounds of the table, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the trimming action will not be completed. ### beforeUndo ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1563 ::: _beforeUndo(action) ⇒ \* | boolean_ Fired by [UndoRedo](@/api/undoRedo.md) plugin before the undo action. Contains information about the action that is being undone. This hook is fired when [Options#undo](@/api/metaSchema.md#undo) option is enabled. | Param | Type | Description | | --- | --- | --- | | action | `object` | The action object. Contains information about the action being undone. The `actionType` property of the object specifies the type of the action in a String format. (e.g. `'remove_row'`). | **Returns**: `*` | `boolean` - If false is returned the action is canceled. ### beforeUndoStackChange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1574 ::: _beforeUndoStackChange(doneActions, [source]) ⇒ \* | boolean_ Fired by [UndoRedo](@/api/undoRedo.md) plugin before changing undo stack. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | doneActions | `Array` | Stack of actions which may be undone. | | [source] | `string` | `optional` String that identifies source of action ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | **Returns**: `*` | `boolean` - If false is returned the action of changing undo stack is canceled. ### beforeUnhideColumns ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1800 ::: _beforeUnhideColumns(currentHideConfig, destinationHideConfig, actionPossible) ⇒ undefined | boolean_ Fired by [HiddenColumns](@/api/hiddenColumns.md) plugin before marking the columns as not hidden. Fired only if the [Options#hiddenColumns](@/api/metaSchema.md#hiddencolumns) option is enabled. Returning `false` in the callback will prevent the column revealing action from completing. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical column indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical column indexes. | | actionPossible | `boolean` | `true`, if the provided column indexes are valid, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the hiding action will not be completed. ### beforeUnhideRows ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1754 ::: _beforeUnhideRows(currentHideConfig, destinationHideConfig, actionPossible) ⇒ undefined | boolean_ Fired by [HiddenRows](@/api/hiddenRows.md) plugin before marking the rows as not hidden. Fired only if the [Options#hiddenRows](@/api/metaSchema.md#hiddenrows) option is enabled. Returning `false` in the callback will prevent the row revealing action from completing. | Param | Type | Description | | --- | --- | --- | | currentHideConfig | `Array` | Current hide configuration - a list of hidden physical row indexes. | | destinationHideConfig | `Array` | Destination hide configuration - a list of hidden physical row indexes. | | actionPossible | `boolean` | `true`, if provided row indexes are valid, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the revealing action will not be completed. ### beforeUnmergeCells ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1968 ::: _beforeUnmergeCells(cellRange, [auto])_ Fired by [MergeCells](@/api/mergeCells.md) plugin before unmerging the cells. This hook is fired when [Options#mergeCells](@/api/metaSchema.md#mergecells) option is enabled. | Param | Type | Default | Description | | --- | --- | --- | --- | | cellRange | `CellRange` | | Selection cell range. | | [auto] | `boolean` | false | `optional` `true` if called automatically by the plugin. | ### beforeUntrimRow ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1846 ::: _beforeUntrimRow(currentTrimConfig, destinationTrimConfig, actionPossible) ⇒ undefined | boolean_ Fired by [TrimRows](@/api/trimRows.md) plugin before untrimming rows. This hook is fired when [Options#trimRows](@/api/metaSchema.md#trimrows) option is enabled. | Param | Type | Description | | --- | --- | --- | | currentTrimConfig | `Array` | Current trim configuration - a list of trimmed physical row indexes. | | destinationTrimConfig | `Array` | Destination trim configuration - a list of trimmed physical row indexes. | | actionPossible | `boolean` | `true`, if all of the row indexes are withing the bounds of the table, `false` otherwise. | **Returns**: `undefined` | `boolean` - If the callback returns `false`, the untrimming action will not be completed. ### beforeValidate ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L938 ::: _beforeValidate(value, row, prop, [source])_ Fired before cell validation, only if validator function is defined. This can be used to manipulate the value of changed cell before it is applied to the validator function. __Note:__ this will not affect values of changes. This will change value *ONLY* for validation. | Param | Type | Description | | --- | --- | --- | | value | `*` | Value of the cell. | | row | `number` | Visual row index. | | prop | `string`
`number` | Property name / column index. | | [source] | `string` | `optional` String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)). | ### beforeValueRender ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L953 ::: _beforeValueRender(value, cellProperties)_ Fired before cell value is rendered into the DOM (through renderer function). This can be used to manipulate the value which is passed to the renderer without modifying the renderer itself. | Param | Type | Description | | --- | --- | --- | | value | `*` | Cell value to render. | | cellProperties | `object` | An object containing the cell properties. | ### construct ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L963 ::: _construct_ Fired after Handsontable instance is constructed (using `new` operator). ### init ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L970 ::: _init_ Fired after Handsontable instance is initiated but before table is rendered. ### modifyAutoColumnSizeSeed ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2073 ::: _modifyAutoColumnSizeSeed(seed, cellProperties, cellValue)_ Fired by [AutoColumnSize](@/api/autoColumnSize.md) plugin within SampleGenerator utility. **Since**: 8.4.0 | Param | Type | Description | | --- | --- | --- | | seed | `string`
`undefined` | Seed ID, unique name to categorize samples. | | cellProperties | `object` | Object containing the cell properties. | | cellValue | `*` | Value of the cell. | ### modifyAutofillRange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1138 ::: _modifyAutofillRange(startArea, entireArea)_ Fired by [Autofill](@/api/autofill.md) plugin after setting range of autofill. This hook is fired when [Options#fillHandle](@/api/metaSchema.md#fillhandle) option is enabled. | Param | Type | Description | | --- | --- | --- | | startArea | `Array` | Array of visual coordinates of the starting point for the drag-down operation (`[startRow, startColumn, endRow, endColumn]`). | | entireArea | `Array` | Array of visual coordinates of the entire area of the drag-down operation (`[startRow, startColumn, endRow, endColumn]`). | ### modifyColHeader ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L977 ::: _modifyColHeader(column)_ Fired when a column header index is about to be modified by a callback function. | Param | Type | Description | | --- | --- | --- | | column | `number` | Visual column header index. | ### modifyColumnHeaderHeight ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1556 ::: _modifyColumnHeaderHeight_ Fired while retrieving the column header height. ### modifyColWidth ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L985 ::: _modifyColWidth(width, column)_ Fired when a column width is about to be modified by a callback function. | Param | Type | Description | | --- | --- | --- | | width | `number` | Current column width. | | column | `number` | Visual column index. | ### modifyCopyableRange ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1148 ::: _modifyCopyableRange(copyableRanges)_ Fired to allow modifying the copyable range with a callback function. | Param | Type | Description | | --- | --- | --- | | copyableRanges | `Array` | Array of objects defining copyable cells. | ### modifyData ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1011 ::: _modifyData(row, column, valueHolder, ioMode)_ Fired when a data was retrieved or modified. | Param | Type | Description | | --- | --- | --- | | row | `number` | Physical row height. | | column | `number` | Physical column index. | | valueHolder | `object` | Object which contains original value which can be modified by overwriting `.value` property. | | ioMode | `string` | String which indicates for what operation hook is fired (`get` or `set`). | ### modifyGetCellCoords ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1042 ::: _modifyGetCellCoords(row, column, topmost)_ Used to modify the cell coordinates when using the `getCell` method, opening editor, getting value from the editor and saving values from the closed editor. **Since**: 0.36.0 | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row index. | | column | `number` | Visual column index. | | topmost | `boolean` | If set to `true`, it returns the TD element from the topmost overlay. For example, if the wanted cell is in the range of fixed rows, it will return a TD element from the `top` overlay. | ### modifyRowData ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1034 ::: _modifyRowData(row)_ Fired when a data was retrieved or modified. | Param | Type | Description | | --- | --- | --- | | row | `number` | Physical row index. | ### modifyRowHeader ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L994 ::: _modifyRowHeader(row)_ Fired when a row header index is about to be modified by a callback function. | Param | Type | Description | | --- | --- | --- | | row | `number` | Visual row header index. | ### modifyRowHeaderWidth ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1646 ::: _modifyRowHeaderWidth(rowHeaderWidth)_ Fired while retrieving the row header width. | Param | Type | Description | | --- | --- | --- | | rowHeaderWidth | `number` | Row header width. | ### modifyRowHeight ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1002 ::: _modifyRowHeight(height, row)_ Fired when a row height is about to be modified by a callback function. | Param | Type | Description | | --- | --- | --- | | height | `number` | Row height. | | row | `number` | Visual row index. | ### modifySourceData ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1022 ::: _modifySourceData(row, column, valueHolder, ioMode)_ Fired when a data was retrieved or modified from the source data set. **Since**: 8.0.0 | Param | Type | Description | | --- | --- | --- | | row | `number` | Physical row index. | | column | `number` | Physical column index. | | valueHolder | `object` | Object which contains original value which can be modified by overwriting `.value` property. | | ioMode | `string` | String which indicates for what operation hook is fired (`get` or `set`). | ### modifyTransformEnd ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1674 ::: _modifyTransformEnd(delta)_ Fired when the end of the selection is being modified (e.g. Moving the selection with the arrow keys). | Param | Type | Description | | --- | --- | --- | | delta | `CellCoords` | Cell coords object declaring the delta of the new selection relative to the previous one. | ### modifyTransformStart ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1666 ::: _modifyTransformStart(delta)_ Fired when the start of the selection is being modified (e.g. Moving the selection with the arrow keys). | Param | Type | Description | | --- | --- | --- | | delta | `CellCoords` | Cell coords object declaring the delta of the new selection relative to the previous one. | ### persistentStateLoad ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1086 ::: _persistentStateLoad(key, valuePlaceholder)_ Fired by [PersistentState](@/api/persistentState.md) plugin, after loading value, saved under given key, from browser local storage. This hook is fired when [Options#persistentState](@/api/metaSchema.md#persistentstate) option is enabled. | Param | Type | Description | | --- | --- | --- | | key | `string` | Key. | | valuePlaceholder | `object` | Object containing the loaded value under `valuePlaceholder.value` (if no value have been saved, `value` key will be undefined). | ### persistentStateReset ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1096 ::: _persistentStateReset([key])_ Fired by [PersistentState](@/api/persistentState.md) plugin after resetting data from local storage. If no key is given, all values associated with table will be cleared. This hook is fired when [Options#persistentState](@/api/metaSchema.md#persistentstate) option is enabled. | Param | Type | Description | | --- | --- | --- | | [key] | `string` | `optional` Key. | ### persistentStateSave ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L1105 ::: _persistentStateSave(key, value)_ Fired by [PersistentState](@/api/persistentState.md) plugin, after saving value under given key in browser local storage. This hook is fired when [Options#persistentState](@/api/metaSchema.md#persistentstate) option is enabled. | Param | Type | Description | | --- | --- | --- | | key | `string` | Key. | | value | `Mixed` | Value to save. | ## Methods ### add ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2226 ::: _hooks.add(key, callback, [context]) ⇒ [Hooks](@/api/pluginHooks.md)_ Adds a listener (globally or locally) to a specified hook name. If the `context` parameter is provided, the hook will be added only to the instance it references. Otherwise, the callback will be used everytime the hook fires on any Handsontable instance. You can provide an array of callback functions as the `callback` argument, this way they will all be fired once the hook is triggered. **See**: [Core#addHook](@/api/core.md#addhook) **Example** ```js // single callback, added locally Handsontable.hooks.add('beforeInit', myCallback, hotInstance); // single callback, added globally Handsontable.hooks.add('beforeInit', myCallback); // multiple callbacks, added locally Handsontable.hooks.add('beforeInit', [myCallback, anotherCallback], hotInstance); // multiple callbacks, added globally Handsontable.hooks.add('beforeInit', [myCallback, anotherCallback]); ``` | Param | Type | Default | Description | | --- | --- | --- | --- | | key | `string` | | Hook name. | | callback | `function`
`Array` | | Callback function or an array of functions. | | [context] | `object` | null | `optional` The context for the hook callback to be added - a Handsontable instance or leave empty. | **Returns**: [`Hooks`](#hooks) - Instance of Hooks. ### createEmptyBucket ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2171 ::: _hooks.createEmptyBucket() ⇒ object_ Returns a new object with empty handlers related to every registered hook name. **Example** ```js Handsontable.hooks.createEmptyBucket(); // Results: { ... afterCreateCol: [], afterCreateRow: [], beforeInit: [], ... } ``` **Returns**: `object` - The empty bucket object. ### deregister ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2463 ::: _hooks.deregister(key)_ Deregisters a hook name (removes it from the list of known hook names). **Example** ```js Handsontable.hooks.deregister('myHook'); ``` | Param | Type | Description | | --- | --- | --- | | key | `string` | The hook name. | ### destroy ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2430 ::: _hooks.destroy([context])_ Destroy all listeners connected to the context. If no context is provided, the global listeners will be destroyed. **Example** ```js // destroy the global listeners Handsontable.hooks.destroy(); // destroy the local listeners Handsontable.hooks.destroy(hotInstance); ``` | Param | Type | Default | Description | | --- | --- | --- | --- | | [context] | `object` | null | `optional` A Handsontable instance. | ### getBucket ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2186 ::: _hooks.getBucket([context]) ⇒ object_ Get hook bucket based on the context of the object or if argument is `undefined`, get the global hook bucket. | Param | Type | Default | Description | | --- | --- | --- | --- | | [context] | `object` | null | `optional` A Handsontable instance. | **Returns**: `object` - Returns a global or Handsontable instance bucket. ### getRegistered ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2525 ::: _hooks.getRegistered() ⇒ Array_ Returns an array of registered hooks. **Example** ```js Handsontable.hooks.getRegistered(); // Results: [ ... 'beforeInit', 'beforeRender', 'beforeSetRangeEnd', 'beforeDrawBorders', 'beforeChange', ... ] ``` **Returns**: `Array` - An array of registered hooks. ### has ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2330 ::: _hooks.has(key, [context]) ⇒ boolean_ Checks whether there are any registered listeners for the provided hook name. If the `context` parameter is provided, it only checks for listeners assigned to the given Handsontable instance. | Param | Type | Default | Description | | --- | --- | --- | --- | | key | `string` | | Hook name. | | [context] | `object` | null | `optional` A Handsontable instance. | **Returns**: `boolean` - `true` for success, `false` otherwise. ### isDeprecated ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2483 ::: _hooks.isDeprecated(hookName) ⇒ boolean_ Returns a boolean value depending on if a hook by such name has been removed or deprecated. **Example** ```js Handsontable.hooks.isDeprecated('skipLengthCache'); // Results: true ``` | Param | Type | Description | | --- | --- | --- | | hookName | `string` | The hook name to check. | **Returns**: `boolean` - Returns `true` if the provided hook name was marked as deprecated or removed from API, `false` otherwise. ### isRegistered ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2500 ::: _hooks.isRegistered(hookName) ⇒ boolean_ Returns a boolean depending on if a hook by such name has been registered. **Example** ```js Handsontable.hooks.isRegistered('beforeInit'); // Results: true ``` | Param | Type | Description | | --- | --- | --- | | hookName | `string` | The hook name to check. | **Returns**: `boolean` - `true` for success, `false` otherwise. ### once ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2284 ::: _hooks.once(key, callback, [context])_ Adds a listener to a specified hook. After the hook runs this listener will be automatically removed from the bucket. **See**: [Core#addHookOnce](@/api/core.md#addhookonce) **Example** ```js Handsontable.hooks.once('beforeInit', myCallback, hotInstance); ``` | Param | Type | Default | Description | | --- | --- | --- | --- | | key | `string` | | Hook/Event name. | | callback | `function`
`Array` | | Callback function. | | [context] | `object` | null | `optional` A Handsontable instance. | ### register ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2447 ::: _hooks.register(key)_ Registers a hook name (adds it to the list of the known hook names). Used by plugins. It is not necessary to call register, but if you use it, your plugin hook will be used returned by the `getRegistered` method. (which itself is used in the [demo](@/guides/getting-started/events-and-hooks.md)). **Example** ```js Handsontable.hooks.register('myHook'); ``` | Param | Type | Description | | --- | --- | --- | | key | `string` | The hook name. | ### remove ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2308 ::: _hooks.remove(key, callback, [context]) ⇒ boolean_ Removes a listener from a hook with a given name. If the `context` argument is provided, it removes a listener from a local hook assigned to the given Handsontable instance. **See**: [Core#removeHook](@/api/core.md#removehook) **Example** ```js Handsontable.hooks.remove('beforeInit', myCallback); ``` | Param | Type | Default | Description | | --- | --- | --- | --- | | key | `string` | | Hook/Event name. | | callback | `function` | | Callback function (needs the be the function that was previously added to the hook). | | [context] | `object` | null | `optional` Handsontable instance. | **Returns**: `boolean` - Returns `true` if hook was removed, `false` otherwise. ### run ::: source-code-link https://github.com/handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/pluginHooks.js#L2356 ::: _hooks.run(context, key, [p1], [p2], [p3], [p4], [p5], [p6]) ⇒ \*_ Runs all local and global callbacks assigned to the hook identified by the `key` parameter. It returns either a return value from the last called callback or the first parameter (`p1`) passed to the `run` function. **See**: [Core#runHooks](@/api/core.md#runhooks) **Example** ```js Handsontable.hooks.run(hot, 'beforeInit'); ``` | Param | Type | Description | | --- | --- | --- | | context | `object` | Handsontable instance. | | key | `string` | Hook/Event name. | | [p1] | `*` | `optional` Parameter to be passed as an argument to the callback function. | | [p2] | `*` | `optional` Parameter to be passed as an argument to the callback function. | | [p3] | `*` | `optional` Parameter to be passed as an argument to the callback function. | | [p4] | `*` | `optional` Parameter to be passed as an argument to the callback function. | | [p5] | `*` | `optional` Parameter to be passed as an argument to the callback function. | | [p6] | `*` | `optional` Parameter to be passed as an argument to the callback function. | **Returns**: `*` - Either a return value from the last called callback or `p1`.