ColumnStatesManager

Description

Initializes the column states manager with the Handsontable instance and registers the sorting states index map under the given map name.

Members

headerAction

Ask AI

Source code

columnStatesManager.headerAction : boolean

Determines whether click on the header perform sorting.

indicator

Ask AI

Source code

columnStatesManager.indicator : boolean

Determines whether indicator should be visible (for sorted columns).

sortEmptyCells

Ask AI

Source code

columnStatesManager.sortEmptyCells : boolean

Determines whether we should sort empty cells.

sortingStates

Ask AI

Source code

columnStatesManager.sortingStates : LinkedPhysicalIndexToValueMap

Index map storing sorting states for every column. ColumnStatesManager write and read to/from this element.

Methods

destroy

Ask AI

Source code

columnStatesManager.destroy()

Destroy the state manager.

getAllColumnsProperties

Ask AI

Source code

columnStatesManager.getAllColumnsProperties() ⇒ object

Get all column properties which affect the sorting result.

getColumnSortState

Ask AI

Source code

columnStatesManager.getColumnSortState(column) ⇒ object | undefined

Get sort state for particular column. Object contains column and sortOrder properties.

Note: Please keep in mind that returned objects expose visual column index under the column key.

Param	Type	Description
column	number	Visual column index.

getIndexOfColumnInSortQueue

Ask AI

Source code

columnStatesManager.getIndexOfColumnInSortQueue(column) ⇒ number

Get order of particular column in the states queue.

Param	Type	Description
column	number	Visual column index.

getNumberOfSortedColumns

Ask AI

Source code

columnStatesManager.getNumberOfSortedColumns() ⇒ number

Get number of sorted columns.

getSortOrderOfColumn

Ask AI

Source code

columnStatesManager.getSortOrderOfColumn(searchedColumn) ⇒ string | undefined

Get sort order of column.

Param	Type	Description
searchedColumn	number	Visual column index.

Returns: string | undefined - Sort order (asc for ascending, desc for descending and undefined for not sorted).

getSortStates

Ask AI

Source code

columnStatesManager.getSortStates() ⇒ Array<object>

Queue of sort states containing sorted columns and their orders (Array of objects containing column and sortOrder properties).

Note: Please keep in mind that returned objects expose visual column index under the column key.

isColumnSorted

Ask AI

Source code

columnStatesManager.isColumnSorted(column) ⇒ boolean

Get if particular column is sorted.

Param	Type	Description
column	number	Visual column index.

isListOfSortedColumnsEmpty

Ask AI

Source code

columnStatesManager.isListOfSortedColumnsEmpty() ⇒ boolean

Get if list of sorted columns is empty.

setSortStates

Ask AI

Source code

columnStatesManager.setSortStates(sortStates)

Set all column states.

Param	Type	Description
sortStates	Array	Sort states.

updateAllColumnsProperties

Ask AI

Source code

columnStatesManager.updateAllColumnsProperties(allSortSettings)

Update column properties which affect the sorting result.

Note: All column properties can be overwritten by Options#columns option.

Param	Type	Description
allSortSettings	object	Column sorting plugin’s configuration object.