AggregateColumnModel

23 Sep 20251 minute to read

Interface for a class AggregateColumn

Properties

columnName string

Defines the column name to display the aggregate value. If columnName is not defined,
then field name value will be assigned to the columnName property.

customAggregate CustomSummaryType|string

Defines a function to calculate custom aggregate value. The type value should be set to custom.
To use custom aggregate value in the template, use the key as ${custom}.
Total aggregation: The custom function will be called with the whole data and the current AggregateColumn object.
Group aggregation: This will be called with the current group details and the AggregateColumn object.

field string

Defines the column name to perform aggregation.

footerTemplate string|Function

Defines the footer cell template as a string for the aggregate column.
The type name should be used to access aggregate values inside the template.

format string|NumberFormatOptions|DateFormatOptions

Format is applied to a calculated value before it is displayed.
Gets the format from the user, which can be standard or custom
number
and date formats.

groupCaptionTemplate string|Function

Defines the group caption cell template as a string for the aggregate column.
The type name should be used to access aggregate values inside the template.
Additionally, the following fields can be accessed in the template.

  • field: The current grouped field name.
  • key: The current grouped field value.

groupFooterTemplate string|Function

Defines the group footer cell template as a string for the aggregate column.
The type name should be used to access aggregate values inside the template.
Additionally, the following fields can be accessed in the template.

  • field: The current grouped field.
  • key: The current grouped value.

type AggregateType|AggregateType[]|string

Defines the aggregate type of a particular column.
To use multiple aggregates for single column, specify the type as array.
Types of aggregate are,

  • sum
  • average
  • max
  • min
  • count
  • truecount
  • falsecount
  • custom

    Specify the type value as custom to use custom aggregation.