column_getStart

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

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

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 'start', 'center', or 'end' region.

start and end are logical positions. In LTR languages/layouts, start usually corresponds to left and end to right. In RTL languages/layouts, start usually corresponds to right and end to left.

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#

const startOffset = column_getStart(column, 'start')