Describes a grouping and aggregations for a roll-up table. Pass to the Table.rollup function to create a roll-up table.

Hierarchy

  • RollupConfig

Constructors

Properties

aggregations: {
    [key: string]: string[];
}

Mapping from each aggregation name to the ordered list of columns it should be applied to in the resulting roll-up table.

Type declaration

  • [key: string]: string[]
groupingColumns: String[]

Ordered list of columns to group by to form the hierarchy of the resulting roll-up table.

includeConstituents: boolean

Optional parameter indicating if an extra leaf node should be added at the bottom of the hierarchy, showing the rows in the underlying table which make up that grouping. Since these values might be a different type from the rest of the column, any client code must check if TreeRow.hasChildren = false, and if so, interpret those values as if they were Column.constituentType instead of Column.type. Defaults to false.

includeDescriptions: boolean

Optional parameter indicating if original column descriptions should be included. Defaults to true.

includeOriginalColumns?: boolean