Previous TopicNext Topic


ListingGroup

The ListingGroup element is a list or table that most often divides into two or more groups. Groups provide a way of showing common headings for a group of related rows. Groups often have subtotals. For example, a sales report may show totals per sales representative and region.

A group is defined by a group key. The key is a column from the query. If the group key is a time field then user often want to group on an interval such as month or quarter.

Extends

Does not extend any element

Property summary

Style properties

None

Method summary

ListingGroup properties

The following sections describe the properties of the ListingGroup element.

filter

A filter to apply to the each group as a whole. The filter conditions apply to values that are constant for each group. The filter expressions is functionally dependent on the group key, or defined on aggregates computed over the group.

groupName

Optional name of the group. The group name must be unique within the list or table. The name is used to identify the group in aggregates as explained in the scripting specification.

interval

The interval upon which interval grouping occurs. The interval value can be any of those itemized in the following table.

Name
Display name
Value
Group on
none
None
none
Individual values
prefix
Prefix
prefix
A string prefix
year
Year
year
A range of years
quarter
Quarter
quarter
A range of quarters
month
Month
month
A range of months
week
Week
week
A range of weeks
day
Day
day
A range of days
hour
Hour
hour
A range of hours
minute
Minute
minute
A range of minutes
second
Second
second
A range of seconds
interval
Interval
interval
A numeric interval

intervalBase

The beginning value for the interval.

intervalRange

The range of time over which the grouping interval occurs. For example, to show data over the span of three hours, set the grouping interval to hours and the range to 3.

The following table shows the meaning of the range for each interval type.

Interval
Meaning of range
None
Ignored
Prefix
The number of characters in the prefix
Date and time
The number of units
Interval
The numeric interval

keyExpr

The group key as an expression. The group key indicates when to cause a group break listing. For example, if the group is by state, then the group key might be row.state. A level break occurs each time the key changes. At each level break, the current group is ended, and a new group started. The expression most often is just a column, but can be a computed value.

sort

Custom sort criteria for the listing group. This property is a list of SortKey structures. If this property is empty, the sort key is the group key. For more information about the SortKey structure, see SortKey structure.

sortDirection

The direction in which to sort this listing group, either ascending or descending. The sort direction property applies only if the sort property is empty.

The following table itemizes the choices for this property.

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

toc

The table of contents (TOC) expression for the group. The value of the expression appears for the table of contents for the report.


(c) Copyright Actuate Corporation 2006

Previous TopicNext Topic