This page covers a non-latest version of Handsontable.
# ColumnSorting
# Description
This plugin sorts the view by columns (but does not sort the data source!). To enable the plugin, set the Options#columnSorting property to the correct value (see the examples below).
Example
// as boolean
columnSorting: true
// as an object with initial sort config (sort ascending for column at index 1)
columnSorting: {
initialConfig: {
column: 1,
sortOrder: 'asc'
}
}
// as an object which define specific sorting options for all columns
columnSorting: {
sortEmptyCells: true, // true = the table sorts empty cells, false = the table moves all empty cells to the end of the table (by default)
indicator: true, // true = shows indicator for all columns (by default), false = don't show indicator for columns
headerAction: true, // true = allow to click on the headers to sort (by default), false = turn off possibility to click on the headers to sort
compareFunctionFactory: function(sortOrder, columnMeta) {
return function(value, nextValue) {
// Some value comparisons which will return -1, 0 or 1...
}
}
}
// as an object passed to the `column` property, allows specifying a custom options for the desired column.
// please take a look at documentation of `column` property: https://handsontable.com/docs/api/options/#columns
columns: [{
columnSorting: {
indicator: false, // disable indicator for the first column,
sortEmptyCells: true,
headerAction: false, // clicks on the first column won't sort
compareFunctionFactory: function(sortOrder, columnMeta) {
return function(value, nextValue) {
return 0; // Custom compare function for the first column (don't sort)
}
}
}
}]
# Options
# columnSorting
Source code (opens new window)columnSorting.columnSorting : boolean | object
Turns on Column sorting. Can be either a boolean (true
/ false
) or an object with a declared sorting options:
initialConfig
- Object with predefined keys:column
- sorted columnsortOrder
- order in which column will be sorted'asc'
= ascending'desc'
= descending
indicator
- display status for sorting order indicator (an arrow icon in the column header, specifying the sorting order).true
= show sort indicator for sorted columnsfalse
= don't show sort indicator for sorted columns
headerAction
- allow to click on the headers to sorttrue
= turn on possibility to click on the headers to sortfalse
= turn off possibility to click on the headers to sort
sortEmptyCells
- how empty values (more information here) should be handledtrue
= the table sorts empty cellsfalse
= the table moves all empty cells to the end of the table
compareFunctionFactory
- curry function returning compare function; compare function should work in the same way as function which is handled by nativeArray.sort
method); please take a look at below examples for more information.
Default: undefined
Example
// as boolean
columnSorting: true
// as an object with initial sort config (sort ascending for column at index 1)
columnSorting: {
initialConfig: {
column: 1,
sortOrder: 'asc'
}
}
// as an object which define specific sorting options for all columns
columnSorting: {
sortEmptyCells: true, // true = the table sorts empty cells, false = the table moves all empty cells to the end of the table
indicator: true, // true = shows indicator for all columns, false = don't show indicator for columns
headerAction: false, // true = allow to click on the headers to sort, false = turn off possibility to click on the headers to sort
compareFunctionFactory: function(sortOrder, columnMeta) {
return function(value, nextValue) {
// Some value comparisons which will return -1, 0 or 1...
}
}
}
# Methods
# clearSort
Source code (opens new window)columnSorting.clearSort()
Clear the sort performed on the table.
# destroy
Source code (opens new window)columnSorting.destroy()
Destroys the plugin instance.
# disablePlugin
Source code (opens new window)columnSorting.disablePlugin()
Disables the plugin functionality for this Handsontable instance.
# enablePlugin
Source code (opens new window)columnSorting.enablePlugin()
Enables the plugin functionality for this Handsontable instance.
# getSortConfig
Source code (opens new window)columnSorting.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 (opens new window)columnSorting.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
than the ColumnSorting#enablePlugin method is called.
# isSorted
Source code (opens new window)columnSorting.isSorted() ⇒ boolean
Checks if the table is sorted (any column have to be sorted).
# setSortConfig
Source code (opens new window)columnSorting.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
beforeColumnSort: function(currentSortConfig, destinationSortConfigs) {
const columnSortPlugin = this.getPlugin('columnSorting');
columnSortPlugin.setSortConfig(destinationSortConfigs);
// const newData = ... // Calculated data set, ie. from an AJAX call.
this.loadData(newData); // Load new data set and re-render the table.
return false; // The blockade for the default sort action.
}
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 (opens new window)columnSorting.sort(sortConfig)
Sorts the table by chosen columns and orders.
Emits: Hooks#event:beforeColumnSort
, Hooks#event:afterColumnSort
Example
// sort ascending first visual column
hot.getPlugin('columnSorting').sort({ column: 0, sortOrder: 'asc' });
Param | Type | Description |
---|---|---|
sortConfig | undefined object | Single column sort configuration. 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. |