Column_RowAggregation

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:250

Column instance APIs installed by rowAggregationFeature.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

getAggregationFns#

getAggregationFns: () => readonly ResolvedAggregationFn<TFeatures, TData>[];

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:255

Resolves the configured scalar or multiple aggregation definitions.

Returns#

readonly ResolvedAggregationFn<TFeatures, TData>[]

getAggregationValue#

getAggregationValue: <TResult>(options?) => TResult;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:263

Aggregates this column over the default pre-grouped row model, or over a caller-provided array of rows. options.maxDepth overrides the column's maxAggregationDepth. Explicit-row calls are intentionally not cached.

Type Parameters#

TResult#

TResult = ColumnAggregationValue<TFeatures>

Parameters#

options?#

AggregationValueOptions<TFeatures, TData>

Returns#

TResult

getAutoAggregationFn#

getAutoAggregationFn: () =>
  | AggregationFnDef<TFeatures, TData, any, any>
  | undefined;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:267

Infers sum for a numeric first row and extent for a Date first row.

Returns#

| AggregationFnDef<TFeatures, TData, any, any> | undefined