BindRowsWithHeaders

Options

bindRowsWithHeaders

Ask AI

Source code

bindRowsWithHeaders.bindRowsWithHeaders : boolean | string

The bindRowsWithHeaders option configures the BindRowsWithHeaders plugin.

When enabled, each row stays permanently linked to its row header label, regardless of row sorting or row moving. Normally, row headers display the visual row index and update as rows are reordered; with this plugin enabled, the header travels with the data row it was originally assigned to.

You can set the bindRowsWithHeaders option to one of the following:

Setting	Description
false	Disable the the BindRowsWithHeaders plugin
true	Enable the the BindRowsWithHeaders plugin

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Read more:

Default: undefined
Example

// enable the `BindRowsWithHeaders` plugin
bindRowsWithHeaders: true

Members

PLUGIN_KEY

Ask AI

Source code

BindRowsWithHeaders.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

BindRowsWithHeaders.PLUGIN_PRIORITY

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

Methods

destroy

Ask AI

Source code

bindRowsWithHeaders.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

bindRowsWithHeaders.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

bindRowsWithHeaders.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Ask AI

Source code

bindRowsWithHeaders.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit hook and if it returns true then the BindRowsWithHeaders#enablePlugin method is called.