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 definition interface.
Function that takes the current cell values and generates the aggregated value.
Type:(params: GridAggregationParams<V>) => AV | null | undefined
Column types supported by this aggregation function.
If not defined, all types are supported (in most cases this property should be defined).
Type:string[]
Function that allows to transform the value of the cell passed to the aggregation function applier.
Useful for aggregating data from multiple row fields.
Type:(params: GridAggregationGetCellValueParams) => V
Indicates if the aggregated value have 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
Label of the aggregation function.
Will be used to add a label on 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)})