HiddenColumns

Members

DEFAULT_SETTINGS

Ask AI

Source code

HiddenColumns.DEFAULT_SETTINGS

Returns the default settings applied when the plugin is enabled without explicit configuration.

PLUGIN_KEY

Ask AI

Source code

HiddenColumns.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

HiddenColumns.PLUGIN_PRIORITY

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

Methods

destroy

Ask AI

Source code

hiddenColumns.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

hiddenColumns.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

hiddenColumns.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getHiddenColumns

Ask AI

Source code

hiddenColumns.getHiddenColumns() ⇒ Array<number>

Returns an array of visual indexes of hidden columns.

hideColumn

Ask AI

Source code

hiddenColumns.hideColumn(…column)

Hides a single column.

Param	Type	Description
…column	number	Visual column index.

hideColumns

Ask AI

Source code

hiddenColumns.hideColumns(columns)

Hides the columns provided in the array.

Param	Type	Description
columns	Array<number>	Array of visual column indexes.

isEnabled

Ask AI

Source code

hiddenColumns.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 HiddenColumns#enablePlugin method is called.

isHidden

Ask AI

Source code

hiddenColumns.isHidden(column) ⇒ boolean

Checks if the provided column is hidden.

Param	Type	Description
column	number	Visual column index.

isValidConfig

Ask AI

Source code

hiddenColumns.isValidConfig(hiddenColumns) ⇒ boolean

Get if trim config is valid. Check whether all of the provided column indexes are within the bounds of the table.

Param	Type	Description
hiddenColumns	Array	List of hidden column indexes.

showColumn

Ask AI

Source code

hiddenColumns.showColumn(…column)

Shows a single column.

Param	Type	Description
…column	number	Visual column index.

showColumns

Ask AI

Source code

hiddenColumns.showColumns(columns)

Shows the provided columns.

Param	Type	Description
columns	Array<number>	Array of visual column indexes.

updatePlugin

Ask AI

Source code

hiddenColumns.updatePlugin()

Updates the plugin’s state.

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

• hiddenColumns