kotlin-tanstack-table-core/tanstack.table.core/Header

Header

external interface Header<TData : RowData, TValue> : CoreHeader<TData, TValue> , ColumnSizingHeader(source)

Properties

abstract val colSpan: Int

The col-span for the header. API Docs Guide

abstract val column: Column<TData, TValue>

The header's associated column object. API Docs Guide

abstract val depth: Int

The depth of the header, zero-indexed based. API Docs Guide

abstract val getContext: () -> HeaderContext<TData, TValue>

Returns the rendering context (or props) for column-based components like headers, footers and filters. API Docs Guide

abstract val getLeafHeaders: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Header<TData, *>>

Returns the leaf headers hierarchically nested under this header. API Docs Guide

getResizeHandler

abstract val getResizeHandler: (@R|kotlin/ParameterName|(name = String(context)) ERROR CLASS: Symbol not found for Document??) -> (event: Any) -> Unit

Returns an event handler function that can be used to resize the header. It can be used as an:

abstract val getSize: () -> Int

Returns the current size of the header. API Docs Guide

abstract val getStart: (position: ColumnPinningPosition?) -> Int

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. API Docs Guide

abstract val headerGroup: HeaderGroup<TData>

The header's associated header group object. API Docs Guide

abstract val id: String

The unique identifier for the header. API Docs Guide

abstract val index: Int

The index for the header within the header group. API Docs Guide

abstract val isPlaceholder: Boolean

A boolean denoting if the header is a placeholder header. API Docs Guide

abstract val placeholderId: String?

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. API Docs Guide

abstract val rowSpan: Int

The row-span for the header. API Docs Guide

abstract val subHeaders: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Header<TData, TValue>>

The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column. API Docs Guide