CollapsibleColumns
Methods
collapseAll
collapsibleColumns.collapseAll()
Collapses all collapsible sections.
collapseSection
collapsibleColumns.collapseSection(coords)
Collapses section at the provided coords.
| Param | Type | Description |
|---|---|---|
| coords | object | Contains coordinates information. (coords.row, coords.col). |
destroy
collapsibleColumns.destroy()
Destroys the plugin instance.
disablePlugin
collapsibleColumns.disablePlugin()
Disables the plugin functionality for this Handsontable instance.
enablePlugin
collapsibleColumns.enablePlugin()
Enables the plugin functionality for this Handsontable instance.
expandAll
collapsibleColumns.expandAll()
Expands all collapsible sections.
expandSection
collapsibleColumns.expandSection(coords)
Expands section at the provided coords.
| Param | Type | Description |
|---|---|---|
| coords | object | Contains coordinates information. (coords.row, coords.col). |
isEnabled
collapsibleColumns.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 CollapsibleColumns#enablePlugin method is called.
toggleAllCollapsibleSections
collapsibleColumns.toggleAllCollapsibleSections(action)
Collapses or expand all collapsible sections, depending on the action parameter.
| Param | Type | Description |
|---|---|---|
| action | string | ’collapse’ or ‘expand’. |
toggleCollapsibleSection
collapsibleColumns.toggleCollapsibleSection(coords, [action])
Collapses/Expands a section.
Emits: Hooks#event:beforeColumnCollapse, Hooks#event:beforeColumnExpand, Hooks#event:afterColumnCollapse, Hooks#event:afterColumnExpand
| Param | Type | Description |
|---|---|---|
| coords | Array | Array of coords - section coordinates. |
| [action] | string | optional Action definition (‘collapse’ or ‘expand’). |
updatePlugin
collapsibleColumns.updatePlugin()
Updates the plugin’s state.
This method is executed when updateSettings() is invoked with any of the following configuration options: