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
LegacyRowModelOptions
Defined in: src/useLegacyTable.ts:208
Legacy v8-style row model options
Type Parameters#
TData#
TData extends RowData
Properties#
aggregationFns?#
optional aggregationFns?: AggregationFns;Defined in: src/useLegacyTable.ts:268
Additional aggregation functions to apply to the table.
Deprecated#
Use rowAggregationFeature with the aggregationFns slot instead. Add columnGroupingFeature and groupedRowModel only when grouping rows.
filterFns?#
optional filterFns?: FilterFns;Defined in: src/useLegacyTable.ts:258
Additional filter functions to apply to the table.
Deprecated#
Use the filteredRowModel/filterFns slots on the features option with createFilteredRowModel() instead.
getCoreRowModel?#
optional getCoreRowModel?: RowModelFactory<TData>;Defined in: src/useLegacyTable.ts:213
Returns the core row model for the table.
Deprecated#
This option is no longer needed in v9. The core row model is always created automatically.
getExpandedRowModel?#
optional getExpandedRowModel?: RowModelFactory<TData>;Defined in: src/useLegacyTable.ts:233
Returns the expanded row model for the table.
Deprecated#
Use the expandedRowModel slot on the features option with createExpandedRowModel() instead.
getFacetedMinMaxValues?#
optional getFacetedMinMaxValues?: FacetedMinMaxValuesFactory<TData>;Defined in: src/useLegacyTable.ts:248
Returns the faceted min/max values for a column.
Deprecated#
Use the facetedMinMaxValues slot on the features option with createFacetedMinMaxValues() instead.
getFacetedRowModel?#
optional getFacetedRowModel?: FacetedRowModelFactory<TData>;Defined in: src/useLegacyTable.ts:243
Returns the faceted row model for a column.
Deprecated#
Use the facetedRowModel slot on the features option with createFacetedRowModel() instead.
getFacetedUniqueValues?#
optional getFacetedUniqueValues?: FacetedUniqueValuesFactory<TData>;Defined in: src/useLegacyTable.ts:253
Returns the faceted unique values for a column.
Deprecated#
Use the facetedUniqueValues slot on the features option with createFacetedUniqueValues() instead.
getFilteredRowModel?#
optional getFilteredRowModel?: RowModelFactory<TData>;Defined in: src/useLegacyTable.ts:218
Returns the filtered row model for the table.
Deprecated#
Use the filteredRowModel/filterFns slots on the features option with createFilteredRowModel() instead.
getGroupedRowModel?#
optional getGroupedRowModel?: RowModelFactory<TData>;Defined in: src/useLegacyTable.ts:238
Returns the grouped row model for the table.
Deprecated#
Use columnGroupingFeature with the groupedRowModel slot and createGroupedRowModel() instead. Add rowAggregationFeature separately when grouped rows aggregate values.
getPaginationRowModel?#
optional getPaginationRowModel?: RowModelFactory<TData>;Defined in: src/useLegacyTable.ts:228
Returns the paginated row model for the table.
Deprecated#
Use the paginatedRowModel slot on the features option with createPaginatedRowModel() instead.
getSortedRowModel?#
optional getSortedRowModel?: RowModelFactory<TData>;Defined in: src/useLegacyTable.ts:223
Returns the sorted row model for the table.
Deprecated#
Use the sortedRowModel/sortFns slots on the features option with createSortedRowModel() instead.
sortFns?#
optional sortFns?: SortFns;Defined in: src/useLegacyTable.ts:263
Additional sort functions to apply to the table.
Deprecated#
Use the sortedRowModel/sortFns slots on the features option with createSortedRowModel() instead.