Class: HiddenColumns

HiddenColumns

Plugin allowing to hide certain columns.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 16

Members

hiddenColumnsBoolean Object

List of currently hidden columns

lastSelectedColumnNumber

Last selected column index.

Default Value:
  • -1

settingsnull Object

Cached plugin settings.

Methods

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 515

destroy()

Destroy the plugin.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 94

disablePlugin()

Disable the plugin.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 52

enablePlugin()

Enable the plugin.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 193

getLogicalColumnIndex(column){Number}

Get the logical index of the provided column.

Parameters:
Name Type Description
column Number
Returns: {Number}
handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 150

hideColumn(column)

Hide a single column.

Parameters:
Name Type Description
column Number

Column index.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 134

hideColumns(columns)

Hide the columns provided in the array.

Parameters:
Name Type Description
columns Array

Array of column indexes.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 45

isEnabled(){Boolean}

Check if plugin is enabled.

Returns: {Boolean}
handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 161

isHidden(column, isLogicIndex){Boolean}

Check if the provided column is hidden.

Parameters:
Name Type Description
column Number

Column index.

isLogicIndex Boolean

flag which determines type of index.

Returns: {Boolean}
handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 204

onBeforeStretchingColumnWidth(width, column){Number}

Set width hidden columns on 0

Parameters:
Name Type Description
width Number

Column width.

column Number

Column index.

Returns: {Number}
handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 125

showColumn(column)

Show a single column.

Parameters:
Name Type Description
column Number

Column index.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 109

showColumns(columns)

Show the provided columns.

Parameters:
Name Type Description
columns Array

Array of column indexes.

handsontable-pro/src/plugins/hiddenColumns/hiddenColumns.js, line 84

updatePlugin()

Updates the plugin to use the latest options you have specified.