Skip to content

MultiSorterFixedCollection

This document describes the metadata properties available when mapping a fixed collection to MultiSorter control. Typically the controls that make use of this definition display some sort of list to the user.


When assigning a rule to a property of MultiSorterFixedCollection, the rule will be passed an instance of the following proxy class as an argument:



Items

  • type: array

All array items must be of type:

Any following options needs to be fulfilled.

Option 1

  • type: object with following properties.
Property Type Required Default
DisplayValue string No
ReturnValue string Yes
AscendingLabel string No
DescendingLabel string No

DisplayValue

The value to display to the user. If not specified, the ReturnValue will be used.

ReturnValue

The value to return on selection.

AscendingLabel

The value to display ascending label. If not specified, default value is Ascending.

DescendingLabel

The value to display descending label label. If not specified, default value is Descending.

Option 2

  • string

Examples

[{
  "ReturnValue": "NotificationNumber",
  "DisplayValue": "Notification ID",
  "AscendingLabel": "Lowest First",
  "DescendingLabel": "Highest First"
},
{
  "ReturnValue": "NotificationDescription",
  "DisplayValue": "Description",
  "AscendingLabel": "Ascending",
  "DescendingLabel": "Descending"
},
{
  "ReturnValue": "Priority",
  "DisplayValue": "Priority",
  "AscendingLabel": "Smallest First",
  "DescendingLabel": "Biggest First"
},
{
  "ReturnValue": "RequiredEndDate",
  "DisplayValue": "Due Date",
  "AscendingLabel": "Ascending",
  "DescendingLabel": "Descending"
}]

[ "OrderId", "BusinessArea", "OrderType" ]