sortFieldsList

sortFieldsList(compareFunction: Function)

[starting from version 2.9.17]

Sets custom sorting for Field List items.

sortFieldsList() can be defined in two ways:

As a regular API call: flexmonster.sortFieldsList(compareFunction).
As an initialization parameter: new Flexmonster({sortFieldsList: compareFunction, ...}).

Parameters

Parameter/Type Description

Parameter/Type	Description
compareFunction Function	Defines the sort order and works similarly to the `compareFunction` of the Array.sort() method. Data passed to the `compareFunction`: `firstItem` — FieldListItemObject. The first item for comparison. `secondItem` — FieldListItemObject. The second item for comparison. `viewType` — String. The current view type. Can be one of the following values: `"pivot"`, `"flat"`, and `"drillThrough"`. The `compareFunction` should return the positive, negative, or zero value.

compareFunction
Function

Defines the sort order and works similarly to the compareFunction of the Array.sort() method.
Data passed to the compareFunction:

firstItem — FieldListItemObject. The first item for comparison.
secondItem — FieldListItemObject. The second item for comparison.
viewType — String. The current view type. Can be one of the following values: "pivot", "flat", and "drillThrough".

The compareFunction should return the positive, negative, or zero value.

Sort Field List items in reverse alphabetical order:

flexmonster.sortFieldsList(function(firstItem, secondItem, viewType) {
  return secondItem.caption.localeCompare(firstItem.caption);
});

See the full code on JSFiddle.