Describes how a Totals Table will be generated from its parent table. Each table has a default (which may be null) indicating how that table was configured when it was declared, and each Totals Table has a similar property describing how it was created. Both the Table.getTotalsTable and Table.getGrandTotalsTable methods take this config as an optional parameter - without it, the table's default will be used, or if null, a default instance of TotalsTableConfig will be supplied.

This class has a no-arg constructor, allowing an instance to be made with the default values provided. However, any JS object can be passed in to the methods which accept instances of this type, provided their values adhere to the expected formats.

Hierarchy

  • TotalsTableConfig

Constructors

Properties

defaultOperation: string

Specifies the default operation for columns that do not have a specific operation applied; defaults to "Sum".

groupBy: string[]

Groupings to use when generating the Totals Table. One row will exist for each unique set of values observed in these columns. See also Table.selectDistinct.

operationMap: {
    [key: string]: AggregationOperationType[];
}

Mapping from each column name to the aggregation(s) that should be applied to that column in the resulting Totals Table. If a column is omitted, the defaultOperation is used.

Type declaration

showGrandTotalsByDefault: boolean

Specifies if a Grand Totals Table should be expanded by default in the UI. Defaults to false.

showTotalsByDefault: boolean

Specifies if a Totals Table should be expanded by default in the UI. Defaults to false.

ABS_SUM: string

Deprecated

AVG: string

Deprecated

COUNT: string

Deprecated

FIRST: string

Deprecated

LAST: string

Deprecated

MAX: string

Deprecated

MIN: string

Deprecated

SKIP: string

Deprecated

STD: string

Deprecated

SUM: string

Deprecated

VAR: string

Deprecated

Methods

  • Returns string