# ManualColumnFreeze

# Description

This plugin allows to manually "freeze" and "unfreeze" a column using an entry in the Context Menu or using API. You can turn it on by setting a Options#manualColumnFreeze property to true.

Example

// Enables the plugin
manualColumnFreeze: true,

# Options

# manualColumnFreeze

Source code (opens new window)

manualColumnFreeze.manualColumnFreeze : boolean

Disables or enables ManualColumnFreeze plugin.

Default: undefined
Example

// enable fixed columns
manualColumnFreeze: true,

# Methods

# disablePlugin

Source code (opens new window)

manualColumnFreeze.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

# enablePlugin

Source code (opens new window)

manualColumnFreeze.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

# freezeColumn

Source code (opens new window)

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

Source code (opens new window)

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

# unfreezeColumn

Source code (opens new window)

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

Source code (opens new window)

manualColumnFreeze.updatePlugin()

Updates the plugin state. This method is executed when Core#updateSettings is invoked.

Last Updated: Oct 14, 2021