Function: column_getIsFirstColumn()#

function column_getIsFirstColumn<TFeatures, TData, TValue>(column, position?): boolean;

function column_getIsFirstColumn<TFeatures, TData, TValue>(column, position?): boolean;

Defined in: features/column-ordering/columnOrderingFeature.utils.ts:59

Checks whether this column is the first visible column in a pinning region.

The same position semantics as column_getIndex apply.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

column#

Column_Internal<TFeatures, TData, TValue>

position?#

ColumnPinningPosition | "center"

Returns#

boolean

Example#

const isFirst = column_getIsFirstColumn(column, 'left')

const isFirst = column_getIsFirstColumn(column, 'left')