ManualColumnResize
Plugin: ManualColumnResize
Description
This plugin allows to change columns width.
The plugin creates additional components to make resizing possibly using user interface:
- handle - the draggable element that sets the desired width of the column.
- guide - the helper guide that shows the desired width as a vertical guide.
Options
manualColumnResize
manualColumnResize.manualColumnResize : boolean | Array<number>
The manualColumnResize option configures the ManualColumnResize plugin.
You can set the manualColumnResize option to one of the following:
| Setting | Description |
|---|---|
true | Enable the ManualColumnResize plugin |
false | Disable the ManualColumnResize plugin |
| An array | - Enable the ManualColumnResize plugin- Set initial widths of individual columns |
Read more:
Default: undefined
Example
// enable the `manualColumnResize` pluginmanualColumnResize: true,
// enable the `manualColumnResize` plugin// set the initial width of column 0 to 40 pixels// set the initial width of column 1 to 50 pixels// set the initial width of column 2 to 60 pixelsmanualColumnResize: [40, 50, 60],Methods
clearManualSize
manualColumnResize.clearManualSize(column)
Clears the cache for the specified column index.
| Param | Type | Description |
|---|---|---|
| column | number | Visual column index. |
destroy
manualColumnResize.destroy()
Destroys the plugin instance.
disablePlugin
manualColumnResize.disablePlugin()
Disables the plugin functionality for this Handsontable instance.
enablePlugin
manualColumnResize.enablePlugin()
Enables the plugin functionality for this Handsontable instance.
isEnabled
manualColumnResize.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 ManualColumnResize#enablePlugin method is called.
setManualSize
manualColumnResize.setManualSize(column, width) ⇒ number
Sets the new width for specified column index.
| Param | Type | Description |
|---|---|---|
| column | number | Visual column index. |
| width | number | Column width (no less than 20px). |
Returns: number - Returns new width.
updatePlugin
manualColumnResize.updatePlugin()
Updates the plugin’s state.
This method is executed when updateSettings() is invoked with any of the following configuration options: