TrimRows

Options

trimRows

Ask AI

Source code

trimRows.trimRows : boolean | Array<number>

The trimRows option configures the TrimRows plugin.

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

Setting	Description
false	Disable the TrimRows plugin
true	Enable the TrimRows plugin
An array of physical row indexes	- Enable the TrimRows plugin - Trim selected rows at initialization

Read more:

• Row trimming

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 `TrimRows` plugin
trimRows: true,

// enable the `TrimRows` plugin
// at Handsontable's initialization, trim rows 5, 10, and 15
trimRows: [5, 10, 15],

Members

PLUGIN_KEY

Ask AI

Source code

TrimRows.PLUGIN_KEY

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

PLUGIN_PRIORITY

Ask AI

Source code

TrimRows.PLUGIN_PRIORITY

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

SETTING_KEYS

Ask AI

Source code

TrimRows.SETTING_KEYS

Returns the list of settings keys observed by the plugin for configuration changes.

Methods

destroy

Ask AI

Source code

trimRows.destroy()

Destroys the plugin instance.

disablePlugin

Ask AI

Source code

trimRows.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

trimRows.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getTrimmedRows

Ask AI

Source code

trimRows.getTrimmedRows() ⇒ Array

Get list of trimmed rows.

Returns: Array - Physical rows.

isEnabled

Ask AI

Source code

trimRows.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 TrimRows#enablePlugin method is called. When [[Options#dataProvider]] is a complete server-backed configuration, the DataProvider plugin blocks this plugin from enabling.

isTrimmed

Ask AI

Source code

trimRows.isTrimmed(physicalRow) ⇒ boolean

Checks if given row is hidden.

Param	Type	Description
physicalRow	number	Physical row index.

isValidConfig

Ask AI

Source code

trimRows.isValidConfig(trimmedRows) ⇒ boolean

Get if trim config is valid. Check whether all of the provided physical row indexes are within source data.

Param	Type	Description
trimmedRows	Array	List of physical row indexes.

trimRow

Ask AI

Source code

trimRows.trimRow(…row)

Trims the row provided as a physical row index (counting from 0).

Param	Type	Description
…row	number	Physical row index.

trimRows

Ask AI

Source code

trimRows.trimRows(rows)

Trims the rows provided in the array.

Emits: Hooks#event:beforeTrimRow, Hooks#event:afterTrimRow

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

untrimAll

Ask AI

Source code

trimRows.untrimAll()

Untrims all trimmed rows.

untrimRow

Ask AI

Source code

trimRows.untrimRow(…row)

Untrims the row provided as a physical row index (counting from 0).

Param	Type	Description
…row	number	Physical row index.

untrimRows

Ask AI

Source code

trimRows.untrimRows(rows)

Untrims the rows provided in the array.

Emits: Hooks#event:beforeUntrimRow, Hooks#event:afterUntrimRow

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

updatePlugin

Ask AI

Source code

trimRows.updatePlugin()

Updates the plugin’s state.

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

• trimRows