Skip to content

Commit 65a7363

Browse files
committed
chore: split filtering api docs · 3b3b3b3b
1 parent 3952c34 commit 65a7363

18 files changed

+961
-691
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Column Faceting APIs
3+
id: column-faceting
4+
---
5+
6+
## Column API
7+
8+
### `getFacetedRowModel`
9+
10+
```tsx
11+
type getFacetedRowModel = () => RowModel<TData>
12+
```
13+
14+
> ⚠️ Requires that you pass a valid `getFacetedRowModel` function to `options.facetedRowModel`. A default implementation is provided via the exported `getFacetedRowModel` function.
15+
16+
Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.
17+
18+
### `getFacetedUniqueValues`
19+
20+
```tsx
21+
getFacetedUniqueValues: () => Map<any, number>
22+
```
23+
24+
> ⚠️ Requires that you pass a valid `getFacetedUniqueValues` function to `options.getFacetedUniqueValues`. A default implementation is provided via the exported `getFacetedUniqueValues` function.
25+
26+
A function that **computes and returns** a `Map` of unique values and their occurrences derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
27+
28+
### `getFacetedMinMaxValues`
29+
30+
```tsx
31+
getFacetedMinMaxValues: () => Map<any, number>
32+
```
33+
34+
> ⚠️ Requires that you pass a valid `getFacetedMinMaxValues` function to `options.getFacetedMinMaxValues`. A default implementation is provided via the exported `getFacetedMinMaxValues` function.
35+
36+
A function that **computes and returns** a min/max tuple derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
37+
38+
## Table Options
39+
40+
### `getColumnFacetedRowModel`
41+
42+
```tsx
43+
getColumnFacetedRowModel: (columnId: string) => RowModel<TData>
44+
```
45+
46+
Returns the faceted row model for a given columnId.

0 commit comments

Comments
 (0)