TanStack

aggregateColumnValue

Function: aggregateColumnValue()

ts
function aggregateColumnValue<TFeatures, TData>(args): unknown;

Defined in: features/row-aggregation/rowAggregationFeature.utils.ts:307

Executes every configured aggregation over a depth-selected row frontier.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Parameters

args

column

Column<TFeatures, TData, unknown>

groupingRow?

Row<TFeatures, TData>

maxDepth?

number

rows

readonly Row<TFeatures, TData>[]

subRows?

readonly Row<TFeatures, TData>[]

uniqueRows?

boolean

Marks rows as distinct nodes of a single row tree (rows the table's own row models produced), enabling frontier selection without the duplicate-id guard. Caller-supplied row arrays must omit this.

Returns

unknown