header_getContext

function header_getContext<TFeatures, TData, TValue>(header): object;

Defined in: core/headers/coreHeadersFeature.utils.ts:57

Builds the render context passed to a column's header or footer template.

The context contains the header, its column, and the owning table instance.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue

Parameters#

header#

Header<TFeatures, TData, TValue>

Returns#

object

column#

column: Column<TFeatures, TData, TValue> = header.column;

header#

header: Header<TFeatures, TData, TValue>;

table#

table: Table_Internal<TFeatures, TData> = header.column.table;

Example#

const context = header_getContext(header)