HiddenRows

Options

hiddenRows

Ask AI

Source code

hiddenRows.hiddenRows : boolean | object

The hiddenRows option configures the HiddenRows plugin.

You can set the hiddenRows option to one of the following:

Setting	Description
false	Disable the HiddenRows plugin
true	Enable the HiddenRows plugin with the default plugin options
An object	- Enable the HiddenRows plugin - Modify the plugin options

If you set the hiddenRows to an object, you can set the following HiddenRows plugin options:

Property	Possible values	Description
rows	An array of indexes	An array of indexes of rows that are hidden at initialization
copyPasteEnabled	true | false	true: when copying or pasting data, take hidden rows into account false: when copying or pasting data, don’t take hidden rows into account
indicators	true | false	true: display UI markers to indicate the presence of hidden rows false: display UI markers

Read more:

• Row hiding

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: undefined
Example

// enable the `HiddenRows` plugin
hiddenRows: true,

// enable `HiddenRows` plugin, and modify the plugin options
hiddenRows: {
  // set rows that are hidden by default
  rows: [5, 10, 15],
  // when copying or pasting data, take hidden rows into account
  copyPasteEnabled: true,
  // show where hidden rows are
  indicators: true
}

Members

DEFAULT_SETTINGS

Ask AI

Source code

HiddenRows.DEFAULT_SETTINGS

Returns the default settings applied when the plugin is enabled without explicit configuration.

PLUGIN_KEY

Ask AI

Source code

HiddenRows.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Ask AI

Source code

HiddenRows.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

Methods

destroy

Ask AI

Source code

hiddenRows.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

hiddenRows.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

hiddenRows.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getHiddenRows

Ask AI

Source code

hiddenRows.getHiddenRows() ⇒ Array<number>

Returns an array of visual indexes of hidden rows.

hideRow

Ask AI

Source code

hiddenRows.hideRow(…row)

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

Param	Type	Description
…row	number	Visual row index.

hideRows

Ask AI

Source code

hiddenRows.hideRows(rows)

Hides the rows provided in the array.

Param	Type	Description
rows	Array<number>	Array of visual row indexes.

isEnabled

Ask AI

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

Ask AI

Source code

hiddenRows.isHidden(row) ⇒ boolean

Checks if the provided row is hidden.

Param	Type	Description
row	number	Visual row index.

isValidConfig

Ask AI

Source code

hiddenRows.isValidConfig(hiddenRows) ⇒ boolean

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

Param	Type	Description
hiddenRows	Array	List of hidden visual row indexes.

showRow

Ask AI

Source code

hiddenRows.showRow(…row)

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

Param	Type	Description
…row	number	Visual row index.

showRows

Ask AI

Source code

hiddenRows.showRows(rows)

Shows the rows provided in the array.

Param	Type	Description
rows	Array<number>	Array of visual row indexes.

updatePlugin

Ask AI

Source code

hiddenRows.updatePlugin()

Updates the plugin’s state.

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

• hiddenRows