Subtotal

An aggregate formula

Examples: Count(), Sum([Sales Amount])

The mode to use when calculating the aggregate formula. Mode determines which dimension(s) to use when performing the calculation.

Mode options vary between element types:

General purpose modes

• "grand_total" — (default for visualizations and pivot tables)— calculates the subtotal for the aggregate formula.

Visualization modes

• "color" — calculates the aggregate formula using only the column specified for COLOR.

• "x_axis" — calculates the aggregate formula using only the column(s) placed on the X-AXIS.

• "trellis_column" / "trellis_row" — calculates the aggregate subtotal using only the dimension specified for the TRELLIS COLUMN or TRELLIS ROW.

Pivot table modes

• "column" / "row" — calculates aggregate subtotal for the column or row total.

• "column_parent" / "row_parent" — calculates the aggregate subtotal for the column or row total, relative to the subtotal calculation for the parent dimensions.

Table modes

• "parent_grouping" — calculates the aggregate formula using the grouping keys from a parent grouping. This is equivalent to creating the aggregate calculation in a parent grouping and referencing it from a column in a lower grouping.

parameters
(optional)

An additional parameter specific to the mode.

This is only applicable to the following modes: "column_parent", "row_parent" and "parent_grouping"

For these modes, this 3rd parameter specifies how many parent dimensions to ignore.