Header
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/types.d.ts:115
Extends
Section titled “Extends”CoreHeader<TData,TValue>.ColumnSizingHeader
Type Parameters
Section titled “Type Parameters”TData extends RowData
TValue
Section titled “TValue”TValue
Properties
Section titled “Properties”colSpan
Section titled “colSpan”colSpan:
number
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:27
The col-span for the header.
Inherited from
Section titled “Inherited from”CoreHeader.colSpan
column
Section titled “column”column:
Column<TData,TValue>
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:33
The header’s associated column object.
Inherited from
Section titled “Inherited from”CoreHeader.column
depth:
number
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:39
The depth of the header, zero-indexed based.
Inherited from
Section titled “Inherited from”CoreHeader.depth
getContext()
Section titled “getContext()”getContext: () =>
HeaderContext<TData,TValue>
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:45
Returns the rendering context (or props) for column-based components like headers, footers and filters.
Returns
Section titled “Returns”HeaderContext<TData, TValue>
Inherited from
Section titled “Inherited from”CoreHeader.getContext
getLeafHeaders()
Section titled “getLeafHeaders()”getLeafHeaders: () =>
Header<TData,unknown>[]
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:51
Returns the leaf headers hierarchically nested under this header.
Returns
Section titled “Returns”Header<TData, unknown>[]
Inherited from
Section titled “Inherited from”CoreHeader.getLeafHeaders
getResizeHandler()
Section titled “getResizeHandler()”getResizeHandler: (
context?) => (event) =>void
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/features/ColumnSizing.d.ts:173
Returns an event handler function that can be used to resize the header. It can be used as an:
onMouseDownhandleronTouchStarthandler
The dragging and release events are automatically handled for you.
Parameters
Section titled “Parameters”context?
Section titled “context?”Document
Returns
Section titled “Returns”(
event):void
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”ColumnSizingHeader.getResizeHandler
getSize()
Section titled “getSize()”getSize: () =>
number
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/features/ColumnSizing.d.ts:179
Returns the current size of the header.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”ColumnSizingHeader.getSize
getStart()
Section titled “getStart()”getStart: (
position?) =>number
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/features/ColumnSizing.d.ts:185
Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.
Parameters
Section titled “Parameters”position?
Section titled “position?”ColumnPinningPosition
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”ColumnSizingHeader.getStart
headerGroup
Section titled “headerGroup”headerGroup:
HeaderGroup<TData>
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:57
The header’s associated header group object.
Inherited from
Section titled “Inherited from”CoreHeader.headerGroup
id:
string
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:63
The unique identifier for the header.
Inherited from
Section titled “Inherited from”CoreHeader.id
index:
number
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:69
The index for the header within the header group.
Inherited from
Section titled “Inherited from”CoreHeader.index
isPlaceholder
Section titled “isPlaceholder”isPlaceholder:
boolean
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:75
A boolean denoting if the header is a placeholder header.
Inherited from
Section titled “Inherited from”CoreHeader.isPlaceholder
placeholderId?
Section titled “placeholderId?”
optionalplaceholderId:string
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:81
If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table.
Inherited from
Section titled “Inherited from”CoreHeader.placeholderId
rowSpan
Section titled “rowSpan”rowSpan:
number
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:87
The row-span for the header.
Inherited from
Section titled “Inherited from”CoreHeader.rowSpan
subHeaders
Section titled “subHeaders”subHeaders:
Header<TData,TValue>[]
Defined in: node_modules/.pnpm/@tanstack+table-core@8.21.3/node_modules/@tanstack/table-core/build/lib/core/headers.d.ts:93
The header’s hierarchical sub/child headers. Will be empty if the header’s associated column is a leaf-column.
Inherited from
Section titled “Inherited from”CoreHeader.subHeaders