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
Column_Column
Defined in: core/columns/coreColumnsFeature.types.ts:45
Extends#
- Column_CoreProperties<TFeatures, TData, TValue>
Extended by#
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
TValue#
TValue extends CellData = CellData
Properties#
accessorFn?#
optional accessorFn?: AccessorFn<TData, TValue>;Defined in: core/columns/coreColumnsFeature.types.ts:15
The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined.
Inherited from#
Column_CoreProperties.accessorFn
columnDef#
columnDef: ColumnDef<TFeatures, TData, TValue>;Defined in: core/columns/coreColumnsFeature.types.ts:19
The original column def used to create the column.
Inherited from#
Column_CoreProperties.columnDef
columns#
columns: Column<TFeatures, TData, TValue>[];Defined in: core/columns/coreColumnsFeature.types.ts:23
The child column (if the column is a group column). Will be an empty array if the column is not a group column.
Inherited from#
depth#
depth: number;Defined in: core/columns/coreColumnsFeature.types.ts:27
The depth of the column (if grouped) relative to the root column def array.
Inherited from#
getFlatColumns#
getFlatColumns: () => Column<TFeatures, TData, TValue>[];Defined in: core/columns/coreColumnsFeature.types.ts:53
Flattens this column and every descendant column into a single array.
Returns#
Column<TFeatures, TData, TValue>[]
getLeafColumns#
getLeafColumns: () => Column<TFeatures, TData, TValue>[];Defined in: core/columns/coreColumnsFeature.types.ts:58
Collects the terminal leaf columns below this column, or the column itself when it has no children.
Returns#
Column<TFeatures, TData, TValue>[]
id#
id: string;Defined in: core/columns/coreColumnsFeature.types.ts:34
The resolved unique identifier for the column resolved in this priority:
- A manual id property from the column def
- The accessor key from the column def
- The header string from the column def
Inherited from#
parent?#
optional parent?: Column<TFeatures, TData, TValue>;Defined in: core/columns/coreColumnsFeature.types.ts:38
The parent column for this column. Will be undefined if this is a root column.
Inherited from#
table#
table: Table_Internal<TFeatures, TData>;Defined in: core/columns/coreColumnsFeature.types.ts:42
Reference to the parent table instance.