column_getStart

Function: column_getStart()

ts
function column_getStart<TFeatures, TData, TValue>(column, position): number;

Defined in: features/column-sizing/columnSizingFeature.utils.ts:91

Computes the offset from the start edge of a pinning region to this column.

The value is the sum of all previous visible leaf column sizes in the requested 'left', 'center', or 'right' region.

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

number

Example

ts
const leftOffset = column_getStart(column, 'left')