Elements

element <sortRule>
Namespace:
http://schema.caplin.com/CaplinTrader/gridDefinitions
XML Representation Summary
<sortRule
   
field
 = 
 xs:string
type
 = 
 ("text" | "number" | "tenor") : "number"
order
 = 
 ("ascending" | "descending") : "ascending"
/>
Parent elements (1):
Description
Sorts the grid in ascending or descending order when the grid is initially rendered.
Attribute Detail
field
Type:
xs:string, predefined
Use:
required
The name of the field that will be used to sort the grid. The field can be any field returned by the data provider of the grid row model (see <gridRowModel>), and does not need to be a field in a column (see the 'fields' attribute of the <column> tag).
order
Type:
anonymous simpleType (restriction of xs:token)
Use:
optional
Default:
"ascending"
The order in which the grid will be sorted. Valid values are "ascending" and "descending".
type
Type:
anonymous simpleType (restriction of xs:token)
Use:
optional
Default:
"number"
The type of field to be sorted. Valid values are "number", "text" and "tenor". Fields of type "number" are sorted numerically, and fields of type "text" are sorted alphabetically. Fields of type "tenor" are sorted as tenors (for example "1Y" has the same sort value as "12M") if the field value is a valid tenor. Fields of type"tenor" that are not valid tenors are sorted numerically if the field value starts with a number, otherwise they are sorted alphabetically. Fields containing prices or ISO formatted dates must be set to "number".