Eclipse BIRT Report Object Model (ROM)
SortHint Structure
Display Name: | Sort Hint |
Since: | 2.5 |
Supports row ordering. Its properties can be mapped to ODA corresponding values.
Name of the result set column for which hints are defined.
Type: | string |
Since: | 2.5 |
Required: | No |
Display Name: | Column Name |
JavaScript Type: | |
Default Value: | None |
Runtime Settable: | Yes |
Name of the result set column for which hints are defined. If a column can only be identified by position, the name may be empty.
The sort direction of this result set column.
Type: | choice (sortDirection) |
Since: | 2.5 |
Required: | No |
Display Name: | Sort Direction |
JavaScript Type: | |
Default Value: | asc |
Runtime Settable: | Yes |
Name | Display Name | Value | Description |
asc | Ascending | asc | the direction of sort hint is ascending. |
desc | Descending | desc | the direction of sort hint is descending. |
The sort direction of this result set column.
Indicates whether this sort key can be excluded at runtime.
Type: | boolean |
Since: | 2.5 |
Required: | No |
Display Name: | Optional |
JavaScript Type: | |
Default Value: | false |
Runtime Settable: | Yes |
Indicates whether this sort key can be excluded at runtime.
The ordering of null vs. non-null values in the sort order.
Type: | choice (nullValueOrderingType) |
Since: | 2.5 |
Required: | No |
Display Name: | Null Value Ordering |
JavaScript Type: | |
Default Value: | unknown |
Runtime Settable: | Yes |
Name | Display Name | Value | Description |
unknown | Unknown | unknown | the ordering of null in the sort order is unknown. |
nullIsFirst | NullIsFirst | nullIsFirst | the ordering of null in the sort order is first. |
nullIsLast | NullIsLast | nullIsLast | the ordering of null in the sort order is last. |
The ordering of null vs. non-null values in the sort order.
The 1-based index position of a result set column.
Type: | integer |
Since: | 2.5 |
Required: | No |
Display Name: | Column Position |
JavaScript Type: | |
Default Value: | None |
Runtime Settable: | Yes |
The 1-based index position of a result set column.