Eclipse BIRT Report Object Model (ROM)

SortElement Element

# Element Overview

A sort definition consisting of an expression and sort direction.

### Details

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

### Property Summary

direction
  The sort direction: Ascending (the default) or Descending.
key
  An expression that gives the sort key on which to sort.
locale
  The locale for this sort.
member
strength
  The strength of this sort collation.

### Description

Report sorting and group sorting is defined as a series of column, sort direction pairs. Each pair is a Sort Criteria structure.

# Property Detail

## direction Property

The sort direction: Ascending (the default) or Descending.

### Details

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

### Choices

Name | Display Name | Value | Description
asc | Ascending | asc | Sort values from lowest to highest.
desc | Descending | desc | Sort values from highest to lowest.

### Description

The sort direction: Ascending (the default) or Descending.

### See Also

## key Property

An expression that gives the sort key on which to sort.

### Details

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

### Description

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.

## locale Property

The locale for this sort.

### Details

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

### Description

The locale for this sort.

## member Property

### Details

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

## strength Property

The strength of this sort collation.

### Details

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

### Description

The strength of this sort collation. The default value is -1.