MultiColumnSorting

Methods

clearSort

Source code

multiColumnSorting.clearSort()

Clear the sort performed on the table.

disablePlugin

Source code

multiColumnSorting.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

multiColumnSorting.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

getSortConfig

Source code

multiColumnSorting.getSortConfig([column]) ⇒ undefined | object | Array

Get sort configuration for particular column or for all sorted columns. Objects contain column and sortOrder properties.

Note: Please keep in mind that returned objects expose visual column index under the column key. They are handled by the sort function.

Param	Type	Description
[column]	`number`	`optional` Visual column index.

isEnabled

Source code

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

isSorted

Source code

multiColumnSorting.isSorted() ⇒ boolean

Checks if the table is sorted (any column have to be sorted).

setSortConfig

Source code

multiColumnSorting.setSortConfig(sortConfig)

Warn: Useful mainly for providing server side sort implementation (see in the example below). It doesn’t sort the data set. It just sets sort configuration for all sorted columns. Note: Please keep in mind that this method doesn’t re-render the table.

Example

1
beforeColumnSort: function(currentSortConfig, destinationSortConfigs) {
2
  const columnSortPlugin = this.getPlugin('multiColumnSorting');
3

4
  columnSortPlugin.setSortConfig(destinationSortConfigs);
5

6
  // const newData = ... // Calculated data set, ie. from an AJAX call.
7

8
  this.updateData(newData); // Update data set and re-render the table.
9

10
  return false; // The blockade for the default sort action.
11
}

Param	Type	Description
sortConfig	`undefined` `object` `Array`	Single column sort configuration or full sort configuration (for all sorted columns). The configuration object contains `column` and `sortOrder` properties. First of them contains visual column index, the second one contains sort order (`asc` for ascending, `desc` for descending).

sort

Source code

multiColumnSorting.sort(sortConfig)

Sorts the table by chosen columns and orders.

Emits: Hooks#event:beforeColumnSort, Hooks#event:afterColumnSort
Example

1
// sort ascending first visual column
2
hot.getPlugin('multiColumnSorting').sort({ column: 0, sortOrder: 'asc' });
3

4
// sort first two visual column in the defined sequence
5
hot.getPlugin('multiColumnSorting').sort([{
6
  column: 1, sortOrder: 'asc'
7
}, {
8
  column: 0, sortOrder: 'desc'
9
}]);

Param	Type	Description
sortConfig	`undefined` `object` `Array`	Single column sort configuration or full sort configuration (for all sorted columns). The configuration object contains `column` and `sortOrder` properties. First of them contains visual column index, the second one contains sort order (`asc` for ascending, `desc` for descending). Note: Please keep in mind that every call of `sort` function set an entirely new sort order. Previous sort configs aren’t preserved.