Skip to main content

getSortingState()

returns the current state of sorting data in TreeGrid

getSortingState(): any;

Returns:

An object with the current state of sorting data in the treegrid.

Example

var state = treegrid.getSortingState(); // -> {dir: "desc", by: "country"}

Related sample: TreeGrid. Get sorting state

The return object includes the following attributes:

dir(string) the sorting direction (desc, asc)
by(string)the id of a column that the treegrid is sorted by

Change log:

added in v6.4