sorting-d2ce3f5.md

Sorting

The OData V4 model supports server-side sorting on lists.

To use server-side sorting, set the operation mode to sap.ui.model.odata.OperationMode.Server, as described in Filtering.

ODataListBinding allows to set static and dynamic sorters:

• For setting a static sorter, the $orderby system query option in the binding parameters is used. The static sorter value is sent with every data service request for the binding. The static sorter cannot be overwritten for an existing binding.

• The dynamic sorter is an sap.ui.model.Sorter instance, or an array thereof, in which case the sorters are concatenated. You can set the initial value for the dynamic sorter in v4.ODataModel.bindList, or declaratively in an XML view with the sorter property in an aggregation's binding information. For setting the dynamic sorter, the v4.ODataListBinding.sort method is used. The sorter that is given here overwrites the initial value specified on binding construction.

Dynamic sorters are transformed to an OData $orderby system query option value, and the static sorters are always appended as secondary sort criterion. In the example below, the equipments are first ordered by Category (dynamic sorter that can be overwritten by calling sort on the list binding, Line 9) and then by Name (secondary sort criterion, static sorter, Line 6). For information on the optional group property (Line 11), see Sorting, Grouping, and Filtering for List Bindingand the vGroup parameter of sap.ui.model.Sorter.

Example: Dynamic and static sorters

1  <Table growing="true" growingThreshold="5" id="Equipments"
2      items="{
3              path: '/Equipments',
4              parameters: {
5                  $$operationMode: 'Server',
6                  $orderby: 'Name',
7                  $select: 'Category, EmployeeId, ID, Name'
8              },
9              sorter: {
10                 path: 'Category',
11                 group: true
12             }
13     }">

Related Information

API Reference: sap.ui.model.Sorter