`<break>`

<break> specifies the sort order of the grouping column in a tabulation.

Description

<break> specifies how a break column of a tabulation (i.e., a column in breaks or cbreaks) should be sorted. <break> tags are optional and may be specified for all, some, or none of the break columns. If not specified for a column, the column is not sorted.

Syntax

<tabu label="[TABULATION_TITLE]" breaks="[GROUPING_COLUMN]">
      <break col="[COLUMN_NAME]" sort="[SORT_DIRECTION]"></break>
      <tcol source="[AGGREGATION_COLUMN]" fun="[FUNCTION]"
            label="[COLUMN_HEADING]"/>
</tabu>

Attributes

col

The name of the column.

col is required.

sort

Specifies whether the tabulation results should be sorted or not.

up: Sort the tabulation results so that this column is in ascending order.
down: Sort the tabulation results so that this column is in descending order.
none: Do not sort using this column.

naorder

If a sort is specified, whether to place N/A values first or last in the collation order.

The default is first.

placeholder

If this tabulation includes a <rollup> element, the value to use in place of N/A for rolled-up breaks.

The value must be of the same type (text, integer, real number) as the break column. If the break is a text column, then this value should be enclosed in single quotes within double quotes (e.g., placeholder="'ALL'"). The default is no placeholder (i.e., N/A is used).

rename

The break column may optionally be renamed from its pre-tabulation name. If present, rename specifies the new column name.

The default is not to rename.

relabel

The break column may optionally be given a different header (label) than its pre-tabulation header. If present, relabel specifies the new column header.

The default is not to relabel.

Example

In this example, the base table is pub.demo.retail.item.

<base table="pub.demo.retail.item"/>
<tabu label="Tabulation on Sales Item Detail" breaks="store" cbreaks="transid">
    <break col="store" sort="down"/>
    <tcol source="sales" fun="sum" label="Sum of`Sales"/>
</tabu>