Framework
Version
Enterprise

Column Faceting APIs

Column API

getFacetedRowModel

tsx
type getFacetedRowModel = () => RowModel<TData>
type getFacetedRowModel = () => RowModel<TData>

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

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

getFacetedUniqueValues

tsx
getFacetedUniqueValues: () => Map<any, number>
getFacetedUniqueValues: () => Map<any, number>

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

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

getFacetedMinMaxValues

tsx
getFacetedMinMaxValues: () => Map<any, number>
getFacetedMinMaxValues: () => Map<any, number>

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

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

Table Options

getColumnFacetedRowModel

tsx
getColumnFacetedRowModel: (columnId: string) => RowModel<TData>
getColumnFacetedRowModel: (columnId: string) => RowModel<TData>

Returns the faceted row model for a given columnId.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.