Similar to the global pui["gridSort"] function configuration option. The sort function can be used to customize the client side grid column sort. Unlike the pui["gridSort"] function, function is only defined for the screen level rather than global.
The following variables are passed to this function:
- value1 = first field value to compare.
- value2 = second field value to compare.
- fieldName = name of the field that the grid is sorted by.
- isDescending = true if sorting in descending sequence, false otherwise.
- fieldDateFormat = date format of the field that the grid is sorted by, if the field is not a date null will be passed instead.
- fieldInfo= formatting information of the field that the grid is sorted by; if the field does not contain any formatting information, a blank object will be passed instead.
- Some of the properties in the field info are:
- dataType - the field data type
- dataLength - data length (only present if the field is a character or a numeric field)
- formatting - field formatting
- Some of the properties in the field info are:
This function could be used to control the order numerals and characters are sorted.
Available in Version 6, Fix Pack 0.4 and later