Function: cell_getContext()#

function cell_getContext<TFeatures, TData, TValue>(cell): object;

Defined in: core/cells/coreCellsFeature.utils.ts:54

Builds the render context passed to a column's cell template.

The returned object includes stable references to the table, row, column, and cell, plus bound getValue and renderValue helpers for render functions.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

cell#

Cell\<`TFeatures`, `TData`, `TValue`\>

Returns#

object

cell#

cell: Cell<TFeatures, TData, TValue>;

column#

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

getValue()#

getValue: () => NoInfer<TValue>;

Returns#

NoInfer\<`TValue`\>

renderValue()#

renderValue: () => NoInfer<TValue | null>;

Returns#

NoInfer\<`TValue` \| `null`\>

row#

row: Row<TFeatures, TData> = cell.row;

table#

table: Table_Internal<TFeatures, TData> = cell.table;

Example#

const context = cell_getContext(cell)