![]() ![]() |
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.
Does not extend any element
None
The following sections describe the properties of the ListingGroup element.
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.
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.
The interval upon which interval grouping occurs. The interval value can be any of those itemized in the following table.
The beginning value for the interval.
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
|
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.
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.
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
|
The table of contents (TOC) expression for the group. The value of the expression appears for the table of contents for the report.
![]() ![]() |