Skip to content

Methods

destroy

Source code

hiddenRows.destroy()

Destroys the plugin instance.

disablePlugin

Source code

hiddenRows.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

hiddenRows.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getHiddenRows

Source code

hiddenRows.getHiddenRows() ⇒ Array<number>

Returns an array of visual indexes of hidden rows.

hideRow

Source code

hiddenRows.hideRow(…row)

Hides the row provided as row index (counting from 0).

ParamTypeDescription
…rownumberVisual row index.

hideRows

Source code

hiddenRows.hideRows(rows)

Hides the rows provided in the array.

ParamTypeDescription
rowsArray<number>Array of visual row indexes.

isEnabled

Source code

hiddenRows.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 HiddenRows#enablePlugin method is called.

isHidden

Source code

hiddenRows.isHidden(row) ⇒ boolean

Checks if the provided row is hidden.

ParamTypeDescription
rownumberVisual row index.

isValidConfig

Source code

hiddenRows.isValidConfig(hiddenRows) ⇒ boolean

Checks whether all of the provided row indexes are within the bounds of the table.

ParamTypeDescription
hiddenRowsArrayList of hidden visual row indexes.

showRow

Source code

hiddenRows.showRow(…row)

Shows the row provided as row index (counting from 0).

ParamTypeDescription
…rownumberVisual row index.

showRows

Source code

hiddenRows.showRows(rows)

Shows the rows provided in the array.

ParamTypeDescription
rowsArray<number>Array of visual row indexes.

updatePlugin

Source code

hiddenRows.updatePlugin()

Updates the plugin’s state.

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