Table Docs
API Reference
Table API Reference
Column API Reference
Row API Reference
Cell API Reference
Header API Reference
Features API Reference
- stockFeatures
- coreFeatures
- coreCellsFeature
- coreColumnsFeature
- coreHeadersFeature
- coreRowModelsFeature
- coreRowsFeature
- coreTablesFeature
- cellSpanningFeature
- columnFilteringFeature
- columnFacetingFeature
- rowAggregationFeature
- columnGroupingFeature
- columnOrderingFeature
- columnPinningFeature
- columnResizingFeature
- columnSizingFeature
- columnVisibilityFeature
- globalFilteringFeature
- rowExpandingFeature
- rowPaginationFeature
- rowPinningFeature
- rowSelectionFeature
- rowSortingFeature
- filterFns
- sortFns
- aggregationFns
- ColumnFilter
- ColumnPinningState
- ColumnSort
- PaginationState
- RowPinningState
- columnResizingState
- FilterFn
- FilterFns
- FilterMeta
- SortFn
- SortFns
- AggregationFns
- AggregationContext
- AggregationMergeContext
- AggregationFnDef
- AggregationFnDescriptor
- AggregationValueContext
- AggregationValueResult
- constructAggregationFn
- ColumnFiltersState
- ColumnOrderState
- ColumnPinningPosition
- ColumnResizeDirection
- ColumnResizeMode
- ColumnSizingState
- ColumnVisibilityState
- ExpandedState
- GroupingState
- RowPinningPosition
- RowSelectionState
- SortDirection
- SortingState
- AggregationFnOption
- AggregationResult
- FilterFnOption
- SortFnOption
- BuiltInAggregationFn
- BuiltInFilterFn
- BuiltInSortFn
Static Functions API Reference
Legacy API Reference
- Legacy API Overview
- useLegacyTable
- legacyCreateColumnHelper
- getCoreRowModel
- getFilteredRowModel
- getSortedRowModel
- getGroupedRowModel
- getExpandedRowModel
- getPaginationRowModel
- getFacetedRowModel
- getFacetedMinMaxValues
- getFacetedUniqueValues
- LegacyRowModelOptions
- LegacyTable
- LegacyTableOptions
- LegacyReactTable
- LegacyColumnDef
AI/LLM: This documentation page is available in plain markdown format at/table/latest/docs/reference/index/interfaces/FilterFnDef.md
FilterFnDef
Defined in: features/column-filtering/columnFilteringFeature.types.ts:102
The definition object accepted by constructFilterFn.
filter is a value-level comparator: it receives the row's (resolved) data value and the (resolved) filter value instead of the whole row, so normalization concerns stay in resolveDataValue/resolveFilterValue.
Extended by#
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
Properties#
autoRemove?#
ts
optional autoRemove?: (filterValue) => boolean;Defined in: features/column-filtering/columnFilteringFeature.types.ts:113
Parameters#
filterValue#
any
Returns#
boolean
filter#
ts
filter: (dataValue, filterValue, row, columnId, addMeta?) => boolean;Defined in: features/column-filtering/columnFilteringFeature.types.ts:106
Parameters#
dataValue#
any
filterValue#
any
row#
Row<TFeatures, TData>
columnId#
string
addMeta?#
(meta) => void
Returns#
boolean
resolveDataValue?#
ts
optional resolveDataValue?: TransformDataValueFn;Defined in: features/column-filtering/columnFilteringFeature.types.ts:115
resolveFilterValue?#
ts
optional resolveFilterValue?: (filterValue) => any;Defined in: features/column-filtering/columnFilteringFeature.types.ts:114
Parameters#
filterValue#
any
Returns#
any