Function: row_getGroupingValue()#

function row_getGroupingValue<TFeatures, TData>(row, columnId): any;

function row_getGroupingValue<TFeatures, TData>(row, columnId): any;

Defined in: features/column-grouping/columnGroupingFeature.utils.ts:268

Reads and caches this row's grouping value for a column.

columnDef.getGroupingValue wins when provided; otherwise the normal row accessor value is used.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Parameters#

row#

Row_Core<TFeatures, TData> & UnionToIntersection< | "columnFilteringFeature" extends keyof TFeatures ? Row_ColumnFiltering<TFeatures, TData> : never | "columnGroupingFeature" extends keyof TFeatures ? Row_ColumnGrouping : never | "columnPinningFeature" extends keyof TFeatures ? Row_ColumnPinning<TFeatures, TData> : never | "columnVisibilityFeature" extends keyof TFeatures ? Row_ColumnVisibility<TFeatures, TData> : never | "rowExpandingFeature" extends keyof TFeatures ? Row_RowExpanding : never | "rowPinningFeature" extends keyof TFeatures ? Row_RowPinning : never | "rowSelectionFeature" extends keyof TFeatures ? Row_RowSelection : never> & UnionToIntersection<{ [K in string | number | symbol]: K extends "coreReativityFeature" ? never : TFeatures[K] extends TableFeature<FeatureConstructorOptions> ? "Row" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions[keyof FeatureConstructorOptions & "Row"] : never : any }[keyof TFeatures]> & Row_Plugins<TFeatures, TData> & Partial<Row_ColumnGrouping>

columnId#

string

Returns#

any

Example#

const groupValue = row_getGroupingValue(row, 'status')

const groupValue = row_getGroupingValue(row, 'status')