Interface: Column_ColumnGrouping<TFeatures, TData>

Defined in: features/column-grouping/columnGroupingFeature.types.ts:78

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getAggregationFn()

getAggregationFn: () => 
  | AggregationFn<TFeatures, TData>
  | undefined;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:85

Returns the aggregation function for the column.

Returns

| AggregationFn<TFeatures, TData> | undefined

getAutoAggregationFn()

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

Defined in: features/column-grouping/columnGroupingFeature.types.ts:89

Returns the automatically inferred aggregation function for the column.

Returns

| AggregationFn<TFeatures, TData> | undefined

getCanGroup()

getCanGroup: () => boolean;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:93

Returns whether or not the column can be grouped.

Returns

boolean

getGroupedIndex()

getGroupedIndex: () => number;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:97

Returns the index of the column in the grouping state.

Returns

number

getIsGrouped()

getIsGrouped: () => boolean;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:101

Returns whether or not the column is currently grouped.

Returns

boolean

getToggleGroupingHandler()

getToggleGroupingHandler: () => () => void;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:105

Returns a function that toggles the grouping state of the column. This is useful for passing to the onClick prop of a button.

Returns

(): void;

Returns

void

toggleGrouping()

toggleGrouping: () => void;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:109

Toggles the grouping state of the column.

Returns

void