Eclipse BIRT Report Object Model (ROM)
SortElement Element
| Display Name: | Sort Element |
| Since: | 2.2 |
| XML Element: | sort-element |
| Extends: | None |
| Extendable: | No |
| Abstract: | No |
| Name Space: | None |
| Name Requirement: | Not Supported |
| Allows User Properties: | No |
| Has Style: | No |
Report sorting and group sorting is defined as a series of column, sort direction pairs. Each pair is a Sort Criteria structure.
The sort direction: Ascending (the default) or Descending.
| Type: | choice (sortDirection) |
| Since: | 2.2 |
| Required: | No |
| Display Name: | Direction |
| JavaScript Type: | |
| Default Value: | asc |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Name | Display Name | Value | Description |
| asc | Ascending | asc | Sort values from lowest to highest. |
| desc | Descending | desc | Sort values from highest to lowest. |
The sort direction: Ascending (the default) or Descending.
An expression that gives the sort key on which to sort.
| Type: | expression |
| Context: | |
| Expression Type: | None |
| Since: | 2.2 |
| Required: | Yes |
| Display Name: | Key |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | Yes |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
An expression that gives the sort key on which to sort. The simplest case is the name of a column. The expression can also be an expression that includes columns. When used for a group, the expression can contain an aggregate computed over the group.
Expressions that include only a column name are candidates for "pushing" into the data set. However, sort keys that are expressions must be evaluated within BIRT, and so the sorting itself must occur within BIRT.
The locale for this sort.
| Type: | locale |
| Since: | 2.5 |
| Required: | No |
| Display Name: | Sort locale |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
The locale for this sort.
| Type: | contentElement |
| Since: | 2.2 |
| Required: | No |
| Display Name: | Member |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | Yes |
| Property Sheet Visibility: | Hidden |
| Property Sheet Group: | Top |
The strength of this sort collation.
| Type: | integer |
| Since: | 2.5 |
| Required: | No |
| Display Name: | Sort strength |
| JavaScript Type: | |
| Default Value: | -1 |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
The strength of this sort collation. The default value is -1.