Eclipse BIRT Report Object Model (ROM)

Listing Element

# Element Overview

Abstract base element that captures the behavior common to lists and tables.

### Details

Display Name: | Listing
Since: | 1.0
XML Element: | `None`
Extends: | ReportItem
Extendable: | No
Abstract: | Yes
Name Space: | Report Items
Name Requirement: | Not Supported
Allows User Properties: | Yes
Has Style: | Yes
Default Style: | None

### Property Summary

filter
  Filter criteria to apply to each row in the List.
pageBreakInterval
repeatHeader
  Whether to repeat the headings at the top of each page.
sort
  The sort order for detail rows in the List.
sortByGroups

### Inherited Properties

ACLExpression, allowExport, bookmark, bookmarkDisplayName, boundDataColumns, cascadeACL, comments, cube, customXml, dataBindingRef, dataSet, displayName, displayNameID, eventHandlerClass, extends, height, multiViews, name, newHandlerOnEachEvent, paramBindings, propertyMasks, pushDown, refTemplateParameter, style, toc, userProperties, viewAction, visibility, width, x, y, zIndex

### Description

The listing element is an abstract base element that captures the commonality between the List and Table element. Both elements support a data set, filtering, sorting, methods, and so on.

See the List and Table items for the specific visual differences between the two items.

### See Also

Report Item for information on the data set, input parameter bindings, and so on.

# Property Detail

## filter Property

Filter criteria to apply to each row in the List.

### Details

Type: | List of FilterCondition Structures
Since: | 1.0
Required: | No
Display Name: | Filter
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | No
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

### Description

The filter property specifies filter criteria to apply to each row in the data set. The filter can contain BIRT expressions (in JavaScript.) If you want the database to do the filtering, put the filter criteria in the WHERE clause of your query.

## pageBreakInterval Property

### Details

Type: | integer
Since: | 2.0
Required: | No
Display Name: | Page break interval
JavaScript Type: |
Default Value: | 40
Inherited: | Yes
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

## repeatHeader Property

Whether to repeat the headings at the top of each page.

### Details

Type: | boolean
Since: | 2.1
Required: | No
Display Name: | Repeat header
JavaScript Type: |
Default Value: | true
Inherited: | Yes
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### Description

This property specifies whether to repeat the headings at the top of each page. If true (the default), the headings repeat. If false, the header appears only on the first page.

### See Also

`header` slot

## sort Property

The sort order for detail rows in the List.

### Details

Type: | List of SortKey Structures
Since: | 1.0
Required: | No
Display Name: | Sorting
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | No
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

### Description

Specifies the sorting of the rows within the detail band. This sorting is done within BIRT. If you want the database to do the sorting, specify the sort within the ORDER BY clause of your query.

## sortByGroups Property

### Details

Type: | boolean
Since: | 2.2
Required: | No
Display Name: | Sort by groups
JavaScript Type: |
Default Value: | true
Inherited: | Yes
Runtime Settable: | No
Property Sheet Visibility: | Visible
Property Sheet Group: | Top