TrimRows

Methods

destroy

Source code

trimRows.destroy()

Destroys the plugin instance.

disablePlugin

Source code

trimRows.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

trimRows.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getTrimmedRows

Source code

trimRows.getTrimmedRows() ⇒ Array

Get list of trimmed rows.

Returns: Array - Physical rows.

isEnabled

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

Source code

trimRows.isTrimmed(physicalRow) ⇒ boolean

Checks if given row is hidden.

Param	Type	Description
physicalRow	`number`	Physical row index.

isValidConfig

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

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

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

Source code

trimRows.untrimAll()

Untrims all trimmed rows.

untrimRow

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

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

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