Libraries
Framework
Start
Router
Data & State
Query
DB
Store
AI
UI & UX
Table
Charts
Form
Hotkeys
Markdown
Highlight
Performance
Virtual
Pacer
Tooling
Devtools
Config
CLI
Intent
Browse all libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Contributors
Core, library, and community contributors.
Showcase
Teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Search
AI
Ask AI
Log In
Log In
Libraries
Blog
Blog & Release Notes
About
YouTube
The official TanStack channel.
Workshops
Live sessions from the maintainers.
Release Notes
The latest releases and changelog.
Community
Channels
Discord
Real-time community support.
GitHub
Source, issues, discussions, and releases.
People & Work
Maintainers
Meet the people maintaining the stack.
Contributors
Core, library, and community contributors.
Showcase
Teams building with TanStack.
Tools
Tools
Builder
Alpha
Generate TanStack app starters.
Stats
NPM and ecosystem usage data.
Merch
View all
Support
Support
Support Overview
Find the right support path.
Partners
Companies supporting TanStack.
OSS Sponsors
Sponsors keeping TanStack open source.
Enterprise Support
Private consulting and expert support.
Contact
Get in touch with the TanStack team.
About
Ethos
How we approach open source.
Tenets
The values that shape TanStack libraries.
Design System
Logos, tokens, and UI components.
Partnership Inquiry
Docs
React
beta
Search...
K
API Reference
Core API Reference
React API Reference
Table API Reference
Table
TableOptions
TableState
TableMeta
TableFeature
TableFeatures
StockFeatures
CoreFeatures
BaseAtoms
Atoms
ExternalAtoms
constructTable
tableOptions
tableFeatures
getInitialTableState
OnChangeFn
Updater
DebugOptions
useTable
createTableHook
ReactTable
AppReactTable
CreateTableHookOptions
Subscribe
FlexRender
flexRender
Column API Reference
Column
ColumnDef
ColumnDefBase
AccessorColumnDef
DisplayColumnDef
GroupColumnDef
ColumnDefTemplate
ColumnHelper
ColumnMeta
createColumnHelper
constructColumn
AccessorFn
DeepKeys
DeepValue
AppColumnHelper
Row API Reference
Row
RowData
RowModel
constructRow
createCoreRowModel
createFilteredRowModel
createSortedRowModel
createGroupedRowModel
createExpandedRowModel
createPaginatedRowModel
createFacetedRowModel
createFacetedMinMaxValues
createFacetedUniqueValues
expandRows
RowModelFns
CreateRowModels
CachedRowModels
Cell API Reference
Cell
CellContext
CellData
constructCell
AppCellContext
Header API Reference
Header
HeaderGroup
HeaderContext
constructHeader
buildHeaderGroups
AppHeaderContext
Features API Reference
stockFeatures
coreFeatures
coreCellsFeature
coreColumnsFeature
coreHeadersFeature
coreRowModelsFeature
coreRowsFeature
coreTablesFeature
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
Static Functions Overview
Legacy API Reference
Legacy API Overview
useLegacyTable
legacyCreateColumnHelper
getCoreRowModel
getFilteredRowModel
getSortedRowModel
getGroupedRowModel
getExpandedRowModel
getPaginationRowModel
getFacetedRowModel
getFacetedMinMaxValues
getFacetedUniqueValues
LegacyRowModelOptions
LegacyTable
LegacyTableOptions
LegacyReactTable
LegacyColumnDef
Menu
Menu
Home
Get Started
Guides
API
Examples
React
beta
API Reference
Core API Reference
React API Reference
Table API Reference
Table
TableOptions
TableState
TableMeta
TableFeature
TableFeatures
StockFeatures
CoreFeatures
BaseAtoms
Atoms
ExternalAtoms
constructTable
tableOptions
tableFeatures
getInitialTableState
OnChangeFn
Updater
DebugOptions
useTable
createTableHook
ReactTable
AppReactTable
CreateTableHookOptions
Subscribe
FlexRender
flexRender
Column API Reference
Column
ColumnDef
ColumnDefBase
AccessorColumnDef
DisplayColumnDef
GroupColumnDef
ColumnDefTemplate
ColumnHelper
ColumnMeta
createColumnHelper
constructColumn
AccessorFn
DeepKeys
DeepValue
AppColumnHelper
Row API Reference
Row
RowData
RowModel
constructRow
createCoreRowModel
createFilteredRowModel
createSortedRowModel
createGroupedRowModel
createExpandedRowModel
createPaginatedRowModel
createFacetedRowModel
createFacetedMinMaxValues
createFacetedUniqueValues
expandRows
RowModelFns
CreateRowModels
CachedRowModels
Cell API Reference
Cell
CellContext
CellData
constructCell
AppCellContext
Header API Reference
Header
HeaderGroup
HeaderContext
constructHeader
buildHeaderGroups
AppHeaderContext
Features API Reference
stockFeatures
coreFeatures
coreCellsFeature
coreColumnsFeature
coreHeadersFeature
coreRowModelsFeature
coreRowsFeature
coreTablesFeature
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
Static Functions Overview
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/beta/docs/reference/static-functions/index.md
Static Functions API Reference
On this page
static-functions
Copy page
static-functions
#
Functions
#
aggregateColumnValue
cell_getCanSelect
cell_getContext
cell_getIsAggregated
cell_getIsFocused
cell_getIsGrouped
cell_getIsPlaceholder
cell_getIsSelected
cell_getSelectionEdges
cell_getSelectionExtendHandler
cell_getSelectionStartHandler
cell_getTabIndex
cell_getValue
cell_renderValue
column_clearSorting
column_getAfter
column_getAggregationFns
column_getAggregationValue
column_getAutoAggregationFn
column_getAutoFilterFn
column_getAutoSortDir
column_getAutoSortFn
column_getCanFilter
column_getCanGlobalFilter
column_getCanGroup
column_getCanHide
column_getCanMultiSort
column_getCanPin
column_getCanResize
column_getCanSort
column_getFacetedMinMaxValues
column_getFacetedRowModel
column_getFacetedUniqueValues
column_getFilterFn
column_getFilterIndex
column_getFilterValue
column_getFirstSortDir
column_getFlatColumns
column_getGroupedIndex
column_getIndex
column_getIsFiltered
column_getIsFirstColumn
column_getIsGrouped
column_getIsLastColumn
column_getIsPinned
column_getIsResizing
column_getIsSorted
column_getIsVisible
column_getLeafColumns
column_getNextSortingOrder
column_getPinnedIndex
column_getSize
column_getSortFn
column_getSortIndex
column_getStart
column_getToggleGroupingHandler
column_getToggleSortingHandler
column_getToggleVisibilityHandler
column_pin
column_resetSize
column_setFilterValue
column_toggleGrouping
column_toggleSorting
column_toggleVisibility
formatAggregatedCellValue
getDefaultCellSelectionState
getDefaultColumnFiltersState
getDefaultColumnOrderState
getDefaultColumnPinningState
getDefaultColumnResizingState
getDefaultColumnSizingColumnDef
getDefaultColumnSizingState
getDefaultColumnVisibilityState
getDefaultExpandedState
getDefaultGroupingState
getDefaultPaginationState
getDefaultRowPinningState
getDefaultRowSelectionState
getDefaultSortingState
header_getContext
header_getLeafHeaders
header_getResizeHandler
header_getSize
header_getStart
isRowSelected
isSubRowSelected
isTouchStartEvent
normalizeAggregationRows
normalizeUniqueAggregationRows
orderColumns
passiveEventSupported
row_getAllCells
row_getAllCellsByColumnId
row_getCanExpand
row_getCanMultiSelect
row_getCanPin
row_getCanSelect
row_getCanSelectSubRows
row_getCenterVisibleCells
row_getDisplayIndex
row_getEndVisibleCells
row_getGroupingValue
row_getIsAllParentsExpanded
row_getIsAllSubRowsSelected
row_getIsExpanded
row_getIsGrouped
row_getIsPinned
row_getIsSelected
row_getIsSomeSelected
row_getLeafRows
row_getParentRow
row_getParentRows
row_getPinnedIndex
row_getStartVisibleCells
row_getToggleExpandedHandler
row_getToggleSelectedHandler
row_getUniqueValues
row_getValue
row_getVisibleCells
row_getVisibleCellsByColumnId
row_pin
row_renderValue
row_toggleExpanded
row_toggleSelected
selectRowsFn
shouldAutoRemoveFilter
table_autoResetCellSelection
table_autoResetExpanded
table_autoResetPageIndex
table_extendCellSelection
table_firstPage
table_getAllColumns
table_getAllFlatColumns
table_getAllFlatColumnsById
table_getAllLeafColumns
table_getAllLeafColumnsById
table_getBottomRows
table_getCanNextPage
table_getCanPreviousPage
table_getCanSomeRowsExpand
table_getCellSelectionBounds
table_getCellSelectionColumnIds
table_getCellSelectionColumnIndexes
table_getCellSelectionRowIds
table_getCenterFlatHeaders
table_getCenterFooterGroups
table_getCenterHeaderGroups
table_getCenterLeafColumns
table_getCenterLeafHeaders
table_getCenterRows
table_getCenterTotalSize
table_getCenterVisibleLeafColumns
table_getColumn
table_getColumnIndexes
table_getColumnOffsets
table_getCoreRowModel
table_getDefaultColumnDef
table_getEndFlatHeaders
table_getEndFooterGroups
table_getEndHeaderGroups
table_getEndLeafColumns
table_getEndLeafHeaders
table_getEndTotalSize
table_getEndVisibleLeafColumns
table_getExpandedDepth
table_getExpandedRowModel
table_getFilteredRowModel
table_getFilteredSelectedRowModel
table_getFlatHeaders
table_getFocusedCell
table_getFooterGroups
table_getGlobalAutoFilterFn
table_getGlobalFacetedMinMaxValues
table_getGlobalFacetedRowModel
table_getGlobalFacetedUniqueValues
table_getGlobalFilterFn
table_getGroupedRowModel
table_getGroupedSelectedRowModel
table_getHeaderGroups
table_getIsAllColumnsVisible
table_getIsAllPageRowsSelected
table_getIsAllRowsExpanded
table_getIsAllRowsSelected
table_getIsSomeColumnsPinned
table_getIsSomeColumnsVisible
table_getIsSomePageRowsSelected
table_getIsSomeRowsExpanded
table_getIsSomeRowsPinned
table_getIsSomeRowsSelected
table_getLeafHeaders
table_getMaxSubRowDepth
table_getOrderColumnsFn
table_getPageCount
table_getPageOptions
table_getPaginatedRowModel
table_getPinnedLeafColumns
table_getPinnedVisibleLeafColumns
table_getPreExpandedRowModel
table_getPreFilteredRowModel
table_getPreGroupedRowModel
table_getPrePaginatedRowModel
table_getPreSelectedRowModel
table_getPreSortedRowModel
table_getRow
table_getRowCount
table_getRowId
table_getRowModel
table_getRowsInDisplayOrder
table_getSelectedCellCount
table_getSelectedCellIds
table_getSelectedCellRangesData
table_getSelectedRowIds
table_getSelectedRowModel
table_getSortedRowModel
table_getStartFlatHeaders
table_getStartFooterGroups
table_getStartHeaderGroups
table_getStartLeafColumns
table_getStartLeafHeaders
table_getStartTotalSize
table_getStartVisibleLeafColumns
table_getToggleAllColumnsVisibilityHandler
table_getToggleAllPageRowsSelectedHandler
table_getToggleAllRowsExpandedHandler
table_getToggleAllRowsSelectedHandler
table_getTopRows
table_getTotalSize
table_getVisibleFlatColumns
table_getVisibleLeafColumns
table_lastPage
table_mergeOptions
table_moveCellSelection
table_nextPage
table_previousPage
table_reset
table_resetCellSelection
table_resetColumnFilters
table_resetColumnOrder
table_resetColumnPinning
table_resetColumnSizing
table_resetColumnVisibility
table_resetExpanded
table_resetGlobalFilter
table_resetGrouping
table_resetHeaderSizeInfo
table_resetPageIndex
table_resetPageSize
table_resetPagination
table_resetRowPinning
table_resetRowSelection
table_resetSorting
table_selectAllCells
table_selectCellRange
table_setCellSelection
table_setColumnFilters
table_setColumnOrder
table_setColumnPinning
table_setColumnResizing
table_setColumnSizing
table_setColumnVisibility
table_setExpanded
table_setFocusedCell
table_setGlobalFilter
table_setGrouping
table_setOptions
table_setPageIndex
table_setPageSize
table_setPagination
table_setRowPinning
table_setRowSelection
table_setSorting
table_syncExternalStateToBaseAtoms
table_toggleAllColumnsVisible
table_toggleAllPageRowsSelected
table_toggleAllRowsExpanded
table_toggleAllRowsSelected
Edit on GitHub
Previous
BuiltInSortFn
Next
Legacy API Overview
On this page
static-functions
Functions
Blog
@Tan_Stack on X.com
@TannerLinsley on X.com
GitHub
YouTube
Ethos
Tenets
Privacy Policy
Terms of Service
© 2026 TanStack LLC
Partners
Become a Partner
Gold
Silver
Bronze
Latest Posts