AggregateColumnProps

Defines the configuration properties for aggregate columns in grid component. Specifies how data calculations are performed and displayed in summary rows. Controls aggregation behavior including calculation types, display formatting, and custom functions.

Props

The following table outlines the props for the AggregateColumnProps:

NameTypeDefaultDescription
cellClass
string | ((props?: CellClassProps<T>) => string)
-

Applies a CSS class to individual aggregate cells either globally or conditionally. Accepts a static class name or a callback function that returns a class name based on cell context. The callback receives a CellClassProps object with the following properties:

  • cellType – Identifies the structural role of the cell: Header, Content, or Aggregate. Useful for styling header, data, or summary cells.
  • column – The column configuration object associated with the aggregate cell.
  • data – The full data object for the aggregate row, enabling conditional styling based on field values.
  • rowIndex – The zero-based index of the row.
columnName
string
-

Defines the column name where calculated aggregate results will be displayed. Specifies the target column for showing computed summary values in the grid. Uses the field name as default when this property is not explicitly defined.

customAggregate
string | ((data: CustomAggregateData<T>[] | CustomAggregateData<T>, column: AggregateColumnProps) => Object)
-

Defines the custom function for calculating aggregate values when using custom aggregation. Specifies the calculation logic to be executed when the type property is set to Custom. Enables implementation of specialized calculations beyond the standard built-in aggregate types.

field
string
-

Defines the field name from the data source for performing aggregate calculations. Specifies which column field contains the data to be processed for summary operations. Must correspond to an existing field in the grid's data source collection.

footerTemplate
ComponentType<AggregateData> | ReactElement | string
-

Defines the template for rendering aggregate values in grid footer cells. Specifies custom content and formatting for displaying calculated results. Accepts string templates, React elements, or functions for dynamic content generation.

format
string | NumberFormatOptions | DateFormatOptions
-

Defines the format string applied to calculated aggregate values before display. Specifies number or date formatting rules for presenting results in readable format. Supports standard format strings and detailed NumberFormatOptions or DateFormatOptions.

type
AggregateType | AggregateType[] | string | string[]
-

Defines the aggregate calculation type to be applied on the column data. Specifies one or multiple calculation methods for comprehensive data analysis. Supports built-in types including Sum, Average, Count, Min, Max, and Custom calculations.