TanStack

column_getCanSpan

Function: column_getCanSpan()

ts
function column_getCanSpan<TFeatures, TData, TValue>(column): boolean;

Defined in: features/cell-spanning/cellSpanningFeature.utils.ts:124

Checks whether this column takes part in cell spanning.

A column def opting out with enableCellSpanning: false wins over the table option, matching how the other per-column enable flags resolve.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

column

Column<TFeatures, TData, TValue>

Returns

boolean

Example

ts
const canSpan = column_getCanSpan(column)