HiddenColumns
Methods
destroy
hiddenColumns.destroy()
Destroys the plugin instance.
disablePlugin
hiddenColumns.disablePlugin()
Disables the plugin functionality for this Handsontable instance.
enablePlugin
hiddenColumns.enablePlugin()
Enables the plugin functionality for this Handsontable instance.
getHiddenColumns
hiddenColumns.getHiddenColumns() ⇒ Array<number>
Returns an array of visual indexes of hidden columns.
hideColumn
hiddenColumns.hideColumn(…column)
Hides a single column.
| Param | Type | Description |
|---|---|---|
| …column | number | Visual column index. |
hideColumns
hiddenColumns.hideColumns(columns)
Hides the columns provided in the array.
| Param | Type | Description |
|---|---|---|
| columns | Array<number> | Array of visual column indexes. |
isEnabled
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
hiddenColumns.isHidden(column) ⇒ boolean
Checks if the provided column is hidden.
| Param | Type | Description |
|---|---|---|
| column | number | Visual column index. |
isValidConfig
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
hiddenColumns.showColumn(…column)
Shows a single column.
| Param | Type | Description |
|---|---|---|
| …column | number | Visual column index. |
showColumns
hiddenColumns.showColumns(columns)
Shows the provided columns.
| Param | Type | Description |
|---|---|---|
| columns | Array<number> | Array of visual column indexes. |
updatePlugin
hiddenColumns.updatePlugin()
Updates the plugin’s state.
This method is executed when updateSettings() is invoked with any of the following configuration options: