# aggFunc

Built-in or registered custom aggregate function name for grouping and analysis.

Canonical: https://grid.syidax.com/docs/columns/aggFunc/

<a id="meaning"></a>

## What does this API do?

Built-in or registered custom aggregate function name for grouping and analysis.

API for Pro features: Row grouping, built-in aggregation and group totals

<a id="contract"></a>

## Exact input and result types

```typescript
aggFunc?: 'sum' | 'avg' | 'min' | 'max' | 'count' | string
```

| Item | Value |
| --- | --- |
| Required | Optional |
| Input type | 'sum' \| 'avg' \| 'min' \| 'max' \| 'count' \| string |

<a id="usage"></a>

## Usage flow

Set this on an individual column object in columnDefs. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

<a id="recipes"></a>

## Feature explanations and examples

- [Grouping and aggregation](https://grid.syidax.com/docs/features/row-grouping.md) — Row grouping collects source rows with the same region or team into expandable groups. Unlike column groups, which organize headers, row groups change displayed rows and aggregation results.