Sorting

Sorting allows you to sort data in ascending or descending order.

This function is available:

• for widgets: List, GroupingHierarchy.
• for fields: See more field types

Type sorting

Sorting can be enabled in two ways:

• On the field Sorting must be enabled explicitly at the field level
• Not recommended. At the application level Sorting is enabled by default for all fields in the application.

Info

Sorting won't function until the page is refreshed after adding or updating records.

Please pay attention to the sorting behavior:

• If the user has not set a sorting option, the default sorting is applied if it is defined.
• If the user has applied a sorting option, it will be preserved when navigating via drill-down or between screens.

How does it look?

On the field

Live Sample · GitHub

How to add?

Example

Step 1 Add sort-enabled-default = false in application.yml

If the parameter is not set to true, sorting must be enabled explicitly at the field level.

    cxbox:
       widget:
           fields: 
                sort-enabled-default: false

Step 2 Add fields.enableSort to corresponding FieldMetaBuilder.

    @Override
    public void buildIndependentMeta(FieldsMeta<InputSortDTO> fields, InnerBcDescription bcDescription, Long parentId) {
        if (configuration.getForceActiveEnabled()) {
            fields.setForceActive(InputSortDTO_.customField);
        }
        fields.enableSort(InputSortDTO_.customField);
    }

At the application level

Not recommended.

If the parameter is set to true, sorting is enabled by default for all fields in the application.

How to add?

Example

Add sort-enabled-default in application.yml

  cxbox:
     widget:
         fields: 
              sort-enabled-default: true

Default sorting

If the parameter is set to true, sorting is enabled by default for all fields in the application.

How to add?

Example

Add business component in BC_PROPERTIES TABLE

BC - name business component PAGE_LIMIT - limit page default SORT - default sorting

BC;PAGE_LIMIT;SORT;FILTER;ID
dateSorting;1000;_sort.0.desc=customField;'""';