ManualColumnFreeze

Options

manualColumnFreeze

Ask AI

Source code

manualColumnFreeze.manualColumnFreeze : boolean

The manualColumnFreeze option configures the ManualColumnFreeze plugin.

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

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

Read more:

• Column freezing

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

Default: undefined
Example

// enable the `ManualColumnFreeze` plugin
manualColumnFreeze: true,

Members

PLUGIN_KEY

Ask AI

Source code

ManualColumnFreeze.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

ManualColumnFreeze.PLUGIN_PRIORITY

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

Methods

disablePlugin

Ask AI

Source code

manualColumnFreeze.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

manualColumnFreeze.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

freezeColumn

Ask AI

Source code

manualColumnFreeze.freezeColumn(column)

Freezes the specified column (adds it to fixed columns).

freezeColumn() doesn’t re-render the table, so you need to call the render() method afterward.

Param	Type	Description
column	number	Visual column index.

isEnabled

Ask AI

Source code

manualColumnFreeze.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 ManualColumnFreeze#enablePlugin method is called.

unfreezeColumn

Ask AI

Source code

manualColumnFreeze.unfreezeColumn(column)

Unfreezes the given column (remove it from fixed columns and bring to it’s previous position).

Param	Type	Description
column	number	Visual column index.

updatePlugin

Ask AI

Source code

manualColumnFreeze.updatePlugin()

Updates the plugin’s state.

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

• manualColumnFreeze