Skip to content

GridAggregationFunction API

Extended documentation for the GridAggregationFunction interface with detailed information on the module's properties and available APIs.

Demos

Import

import { GridAggregationFunction } from '@mui/x-data-grid-premium'


Grid aggregation function data source definition interface.

Properties

Type:(params: GridAggregationParams<V>) => AV | null | undefined

Optional

Column types supported by this aggregation function.
If not defined, all types are supported (in most cases this property should be defined).

Type:string[]

Optional

Type:(params: GridAggregationGetCellValueParams) => V

Optional

Indicates if the aggregated value has the same unit as the cells used to generate it.
It can be used to apply a custom cell renderer only if the aggregated value has the same unit.

Type:boolean

Default:true

Optional

Label of the aggregation function.
Used for adding a label to the footer of the grouping column when this aggregation function is the only one being used.

Type:string

Default:apiRef.current.getLocaleText('aggregationFunctionLabel{capitalize(name)})

Optional

Function for applying a formatter to the aggregated value.
If not defined, the grid uses the formatter of the column.

Type:GridValueFormatter