gridx.modules.SingleSort
Object » _Module » gridx.modules.SingleSort
dojo.require("gridx.modules.SingleSort");
Defined in gridx/modules/SingleSort.js
This module provides the single column sorting functionality for grid.
Property Summary
Method Summary
- _initHeader(colId)
- _onClick(e)
- _onKeyDown(e)
- _updateHeader(colId, isDescending)
- clear(skipUpdateBody) Clear sort.
- getAPIPath()
- getSortData() returns Object[]|null Get an array of objects that can be accepted by the store's "sort" argument.
- isSorted(colId) returns Number Check wheter (and how) the grid is sorted on the given column.
- load()
- preload()
- sort(colId, isDescending, skipUpdateBody) Sort the grid on given column.
Attached Objects
Properties
Methods
Overrides _Module
Clear sort.
| Parameter | Type | Description |
|---|---|---|
| skipUpdateBody | If | set to true, the grid body will not automatically be refreshed after this call, so that several grid operations could be done altogether without refreshing the grid over and over. |
Overrides _Module
Returns Object[]|null: An array containing the sort info
Get an array of objects that can be accepted by the store's "sort" argument.
Overrides _Module
Returns Number: Positive number if the column is sorted ascendingly;
Negative number if the column is sorted descendingly;
Zero if the column is not sorted.
Check wheter (and how) the grid is sorted on the given column.
| Parameter | Type | Description |
|---|---|---|
| colId | String | The columnn ID |
Overrides _Module
Sort the grid on given column.
| Parameter | Type | Description |
|---|---|---|
| colId | String | The column ID |
| isDescending | Boolean | Optional. Whether to sort the column descendingly |
| skipUpdateBody | Boolean | Optional. If set to true, the grid body will not automatically be refreshed after this call,
so that several grid operations could be done altogether
without refreshing the grid over and over. |