---
title: "Aggregation - Configure Columns"
enterprise: true
framework: javascript
version: "36.1.0"
---

# Aggregation - Configure Columns

Columns can be configured to aggregate data for each level of row grouping or tree data.

#### Enabling Aggregation

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import {
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, hide: true },
    { field: "year", rowGroup: true, hide: true },
    { field: "total", aggFunc: "sum" },
    { field: "total", aggFunc: "avg" },
    { field: "total", aggFunc: "count" },
    { field: "total", aggFunc: "min" },
    { field: "total", aggFunc: "max" },
    { field: "total", aggFunc: "first" },
    { field: "total", aggFunc: "last" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 140,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Enabling Aggregation](https://www.ag-grid.com/examples/aggregation-columns/enable-aggregation/typescript)

## Enabling Aggregation

An aggregation function can be applied to a column by setting the `aggFunc` grid option to one of: `"sum"`, `"min"`, `"max"`, `"first"`, `"last"`, `"count"`, or `"avg"`.

The example above demonstrates the following configuration:

```js
const gridOptions = {
    columnDefs: [
        { field: 'total', aggFunc: 'sum' },
        { field: 'total', aggFunc: 'avg' },
        { field: 'total', aggFunc: 'count' },
        { field: 'total', aggFunc: 'min' },
        { field: 'total', aggFunc: 'max' },
        { field: 'total', aggFunc: 'first' },
        { field: 'total', aggFunc: 'last' },
        // ... other column definitions
    ],

    // other grid options ...
}
```

> **Note**
>
> The built-in functions will support `bigint` values if you have them in your data, but the `avg` function will lose precision as it can only use integer arithmetic if `bigint` is used.

## Configuring via the UI

Enable users to configure aggregation functions on a column using the [Columns Tool Panel](https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/) and [Column Menu](https://www.ag-grid.com/javascript-data-grid/column-menu/) by setting the `enableValue` column definition property to `true`.

#### Directly Supplied Aggregation Functions

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import {
  ColumnMenuModule,
  ColumnsToolPanelModule,
  ContextMenuModule,
  RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
  ColumnsToolPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, hide: true },
    { field: "bronze", enableValue: true },
    { field: "silver", enableValue: true },
    { field: "gold", enableValue: true },
    { field: "total", enableValue: true },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 140,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  sideBar: "columns",
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Directly Supplied Aggregation Functions](https://www.ag-grid.com/examples/aggregation-columns/user-configured/typescript)

The example above demonstrates the following configuration:

```js
const gridOptions = {
    columnDefs: [
        { field: 'bronze', enableValue: true },
        { field: 'silver', enableValue: true },
        { field: 'gold', enableValue: true },
        { field: 'total', enableValue: true },
        // ... other column definitions
    ],
    sideBar: 'columns',

    // other grid options ...
}
```

### Allowed Functions

To restrict the aggregation functions that can be applied to a column, set the `allowedAggFuncs` column definition property to an array of allowed aggregation function names. The functions appear in the order specified in the array.

#### Allowed Aggregations

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import {
  ColumnMenuModule,
  ColumnsToolPanelModule,
  ContextMenuModule,
  RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
  ColumnsToolPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, hide: true },
    {
      headerName: "First or Last",
      field: "total",
      aggFunc: "first",
      allowedAggFuncs: ["first", "last"],
      enableValue: true,
    },
    {
      headerName: "Min or Max",
      field: "total",
      aggFunc: "min",
      allowedAggFuncs: ["min", "max"],
      enableValue: true,
    },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 100,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  sideBar: "columns",
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Allowed Aggregations](https://www.ag-grid.com/examples/aggregation-columns/user-configured-allowed-aggregations/typescript)

The following configuration is an example demonstrating limiting a column to only allow the `"first"` and `"last"` aggregation functions:

```js
const gridOptions = {
    columnDefs: [
        { field: 'total', enableValue: true, allowedAggFuncs: ['first', 'last'] },
        // ... other column definitions
    ],

    // other grid options ...
}
```

### Default Function

When right clicked in the [Column Tool Panel](https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/) or dragged into the aggregation panel, the `"sum"` aggregation function is applied to the column. This default can be changed by setting the `defaultAggFunc` column definition property.

#### Default Aggregation

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import {
  ColumnMenuModule,
  ColumnsToolPanelModule,
  ContextMenuModule,
  RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
  ColumnsToolPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, hide: true },
    { field: "athlete", defaultAggFunc: "count", enableValue: true },
    { field: "year", defaultAggFunc: "count", enableValue: true },
    { field: "total", defaultAggFunc: "avg", enableValue: true },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 100,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  sideBar: "columns",
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Default Aggregation](https://www.ag-grid.com/examples/aggregation-columns/user-configured-default-aggregations/typescript)

The example above demonstrates the following configuration:

```js
const gridOptions = {
    columnDefs: [
        { field: 'total', enableValue: true, defaultAggFunc: 'avg' },
        // ... other column definitions
    ],

    // other grid options ...
}
```

## Editing Aggregated Columns

Aggregated columns can be made editable at the group row level, allowing users to edit a group total and distribute the change to descendant rows. Set `groupRowEditable` on the column and configure a `groupRowValueSetter` to control how the edited value is distributed. The built-in distribution automatically handles all standard aggregation functions.

See [Editing Group Rows](https://www.ag-grid.com/javascript-data-grid/grouping-edit/) for full details.

## Omit Function Name in Header

To omit the aggregation function name from the column header, set the `suppressAggFuncInHeader` grid option to `true`.

#### Suppress Aggregation Function in Header

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import {
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  ColumnMenuModule,
  ContextMenuModule,
  RowGroupingModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, hide: true },
    { field: "bronze", aggFunc: "max" },
    { field: "silver", aggFunc: "max" },
    { field: "gold", aggFunc: "max" },
    { field: "total", aggFunc: "avg" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 140,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
};

function toggleProperty() {
  const suppressAggFuncInHeader = document.querySelector<HTMLInputElement>(
    "#suppressAggFuncInHeader",
  )!.checked;
  gridApi.setGridOption("suppressAggFuncInHeader", suppressAggFuncInHeader);
}

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).toggleProperty = toggleProperty;
}
```

[Live example: Suppress Aggregation Function in Header](https://www.ag-grid.com/examples/aggregation-columns/suppress-func-name/typescript)

The example above demonstrates the following configuration:

```js
const gridOptions = {
    suppressAggFuncInHeader: true,

    // other grid options ...
}
```