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/functions/buildHeaderGroups.md
Header API Reference
buildHeaderGroups
ts
function buildHeaderGroups<TFeatures, TData, TValue>(
allColumns,
columnsToGroup,
table,
headerFamily?): HeaderGroup<TFeatures, TData>[];Defined in: core/headers/buildHeaderGroups.ts:227
Builds the nested header group structure for a table.
The result accounts for visible leaf columns, pinned column groups, and placeholder headers needed to render multi-level headers.
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
TValue#
TValue extends unknown = unknown
Parameters#
allColumns#
Column<TFeatures, TData, TValue>[]
columnsToGroup#
Column<TFeatures, TData, TValue>[]
table#
Table_Internal<TFeatures, TData>
headerFamily?#
"start" | "end" | "center"
Returns#
HeaderGroup<TFeatures, TData>[]