ContextQMD
Back to Table

Table_RowModels_Faceted

docs/reference/interfaces/Table_RowModels_Faceted.md

8.21.32.5 KB
Original Source

Interface: Table_RowModels_Faceted<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getFacetedMinMaxValues()

ts
getFacetedMinMaxValues: () => [number, number] | undefined;

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

A function that computes and returns a min/max tuple derived from column.getFacetedRowModel. Useful for displaying faceted result values.

⚠️ Requires that you pass a valid getFacetedMinMaxValues function to options.getFacetedMinMaxValues. A default implementation is provided via the exported getFacetedMinMaxValues function.

Returns

[number, number] | undefined

getFacetedRowModel()

ts
getFacetedRowModel: () => RowModel<TFeatures, TData>;

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

Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.

⚠️ Requires that you pass a valid getFacetedRowModel function to options.facetedRowModel. A default implementation is provided via the exported getFacetedRowModel function.

Returns

RowModel<TFeatures, TData>

getFacetedUniqueValues()

ts
getFacetedUniqueValues: () => Map<any, number>;

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

A function that computes and returns a Map of unique values and their occurrences derived from column.getFacetedRowModel. Useful for displaying faceted result values.

⚠️ Requires that you pass a valid getFacetedUniqueValues function to options.getFacetedUniqueValues. A default implementation is provided via the exported getFacetedUniqueValues function.

Returns

Map<any, number>