Back to Table

CreateRowModel_Faceted

docs/reference/interfaces/CreateRowModel_Faceted.md

8.21.32.8 KB
Original Source

Interface: CreateRowModel_Faceted<TFeatures, TData>

Defined in: features/column-faceting/columnFacetingFeature.types.ts:45

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

facetedMinMaxValues()?

ts
optional facetedMinMaxValues: (table, columnId) => () => [number, number] | undefined;

Defined in: features/column-faceting/columnFacetingFeature.types.ts:52

This function is used to retrieve the faceted min/max values. If using server-side faceting, this function is not required. To use client-side faceting, pass the exported getFacetedMinMaxValues() from your adapter to your table or implement your own.

Parameters

table

Table<TFeatures, TData>

columnId

string

Returns

ts
(): [number, number] | undefined;
Returns

[number, number] | undefined


facetedRowModel()?

ts
optional facetedRowModel: (table, columnId) => () => RowModel<TFeatures, TData>;

Defined in: features/column-faceting/columnFacetingFeature.types.ts:59

This function is used to retrieve the faceted row model. If using server-side faceting, this function is not required. To use client-side faceting, pass the exported getFacetedRowModel() from your adapter to your table or implement your own.

Parameters

table

Table<TFeatures, TData>

columnId

string

Returns

ts
(): RowModel<TFeatures, TData>;
Returns

RowModel<TFeatures, TData>


facetedUniqueValues()?

ts
optional facetedUniqueValues: (table, columnId) => () => Map<any, number>;

Defined in: features/column-faceting/columnFacetingFeature.types.ts:66

This function is used to retrieve the faceted unique values. If using server-side faceting, this function is not required. To use client-side faceting, pass the exported getFacetedUniqueValues() from your adapter to your table or implement your own.

Parameters

table

Table<TFeatures, TData>

columnId

string

Returns

ts
(): Map<any, number>;
Returns

Map<any, number>