Header

Properties

Link copied to clipboard
abstract var colSpan: Int

The col-span for the header. API Docs Guide

Link copied to clipboard
abstract var column: Column<TData, TValue>

The header's associated column object. API Docs Guide

Link copied to clipboard
abstract var depth: Int

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

Link copied to clipboard
abstract var getContext: () -> HeaderContext<TData, TValue>

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

Link copied to clipboard
abstract var getLeafHeaders: () -> ReadonlyArray<Header<TData, *>>

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

Link copied to clipboard
abstract var getResizeHandler: (context: Document?) -> (event: Any) -> Unit

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

Link copied to clipboard
abstract var getSize: () -> Int

Returns the current size of the header. API Docs Guide

Link copied to clipboard
abstract var 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

Link copied to clipboard

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

Link copied to clipboard
abstract var id: String

The unique identifier for the header. API Docs Guide

Link copied to clipboard
abstract var index: Int

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

Link copied to clipboard
abstract var isPlaceholder: Boolean

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

Link copied to clipboard
abstract var 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

Link copied to clipboard
abstract var rowSpan: Int

The row-span for the header. API Docs Guide

Link copied to clipboard

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