Row_Core

Defined in: types/Row.ts:13

Extends

• Row_Row<TFeatures, TData>

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

_cellsCache?

optional _cellsCache?: WeakMap<Column<TFeatures, TData, unknown>, Cell<TFeatures, TData, unknown>>;

optional _cellsCache?: WeakMap<Column<TFeatures, TData, unknown>, Cell<TFeatures, TData, unknown>>;

Defined in: core/rows/coreRowsFeature.types.ts:12

Inherited from

Row_Row._cellsCache

_displayIndexCache

_displayIndexCache: number;

_displayIndexCache: number;

Defined in: core/rows/coreRowsFeature.types.ts:25

Internal

Internal cache used while resolving the current display order.

This value may be stale until display order is recomputed. Use row.getDisplayIndex() instead; it refreshes and validates the cached position before returning it.

Inherited from

Row_Row._displayIndexCache

_uniqueValuesCache

_uniqueValuesCache: Record<string, unknown>;

_uniqueValuesCache: Record<string, unknown>;

Defined in: core/rows/coreRowsFeature.types.ts:26

Inherited from

Row_Row._uniqueValuesCache

_valuesCache

_valuesCache: Record<string, unknown>;

_valuesCache: Record<string, unknown>;

Defined in: core/rows/coreRowsFeature.types.ts:27

Inherited from

Row_Row._valuesCache

depth

depth: number;

depth: number;

Defined in: core/rows/coreRowsFeature.types.ts:31

The depth of the row (if nested or grouped) relative to the root row array.

Inherited from

Row_Row.depth

getAllCells

getAllCells: () => Cell<TFeatures, TData, unknown>[];

getAllCells: () => Cell<TFeatures, TData, unknown>[];

Defined in: core/rows/coreRowsFeature.types.ts:80

Builds one cell for each leaf column, including cells for hidden columns.

Returns

Cell<TFeatures, TData, unknown>[]

Inherited from

Row_Row.getAllCells

getAllCellsByColumnId

getAllCellsByColumnId: () => Record<string, Cell<TFeatures, TData, unknown>>;

getAllCellsByColumnId: () => Record<string, Cell<TFeatures, TData, unknown>>;

Defined in: core/rows/coreRowsFeature.types.ts:76

Builds a lookup of this row's cells keyed by leaf column id.

Returns

Record<string, Cell<TFeatures, TData, unknown>>

Inherited from

Row_Row.getAllCellsByColumnId

getDisplayIndex

getDisplayIndex: () => number;

getDisplayIndex: () => number;

Defined in: core/rows/coreRowsFeature.types.ts:72

Returns the zero-based index of the row in the current display order before pagination, or -1 if the row is not in that model. Use this for display row-number columns instead of row.index or the internal _displayIndexCache field.

Returns

number

Inherited from

Row_Row.getDisplayIndex

getLeafRows

getLeafRows: () => Row<TFeatures, TData>[];

getLeafRows: () => Row<TFeatures, TData>[];

Defined in: core/rows/coreRowsFeature.types.ts:84

Returns the leaf rows for the row, not including any parent rows.

Returns

Row<TFeatures, TData>[]

Inherited from

Row_Row.getLeafRows

getParentRow

getParentRow: () => Row<TFeatures, TData> | undefined;

getParentRow: () => Row<TFeatures, TData> | undefined;

Defined in: core/rows/coreRowsFeature.types.ts:88

Returns the parent row for the row, if it exists.

Returns

Row<TFeatures, TData> | undefined

Inherited from

Row_Row.getParentRow

getParentRows

getParentRows: () => Row<TFeatures, TData>[];

getParentRows: () => Row<TFeatures, TData>[];

Defined in: core/rows/coreRowsFeature.types.ts:92

Returns the parent rows for the row, all the way up to a root row.

Returns

Row<TFeatures, TData>[]

Inherited from

Row_Row.getParentRows

getUniqueValues

getUniqueValues: <TValue>(columnId) => TValue[];

getUniqueValues: <TValue>(columnId) => TValue[];

Defined in: core/rows/coreRowsFeature.types.ts:96

Reads the values this row contributes to faceting/grouping for a column.

Type Parameters

TValue

TValue

Parameters

columnId

string

Returns

TValue[]

Inherited from

Row_Row.getUniqueValues

getValue

getValue: <TValue>(columnId) => TValue;

getValue: <TValue>(columnId) => TValue;

Defined in: core/rows/coreRowsFeature.types.ts:100

Reads this row's accessor value for a column id and caches the result.

Type Parameters

TValue

TValue

Parameters

columnId

string

Returns

TValue

Inherited from

Row_Row.getValue

id

id: string;

id: string;

Defined in: core/rows/coreRowsFeature.types.ts:35

The resolved unique identifier for the row resolved via the options.getRowId option. Defaults to the row's index (or relative index if it is a subRow).

Inherited from

Row_Row.id

index

index: number;

index: number;

Defined in: core/rows/coreRowsFeature.types.ts:39

The index of the row within its parent array (or the root data array).

Inherited from

Row_Row.index

original

original: TData;

original: TData;

Defined in: core/rows/coreRowsFeature.types.ts:43

The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group.

Inherited from

Row_Row.original

originalSubRows?

optional originalSubRows?: readonly TData[];

optional originalSubRows?: readonly TData[];

Defined in: core/rows/coreRowsFeature.types.ts:47

An array of the original subRows as returned by the options.getSubRows option.

Inherited from

Row_Row.originalSubRows

parentId?

optional parentId?: string;

optional parentId?: string;

Defined in: core/rows/coreRowsFeature.types.ts:51

If nested, this row's parent row id.

Inherited from

Row_Row.parentId

renderValue

renderValue: <TValue>(columnId) => TValue;

renderValue: <TValue>(columnId) => TValue;

Defined in: core/rows/coreRowsFeature.types.ts:104

Renders the value for the row in a given columnId the same as getValue, but will return the renderFallbackValue if no value is found.

Type Parameters

TValue

TValue

Parameters

columnId

string

Returns

TValue

Inherited from

Row_Row.renderValue

subRows

subRows: Row<TFeatures, TData>[];

subRows: Row<TFeatures, TData>[];

Defined in: core/rows/coreRowsFeature.types.ts:55

An array of subRows for the row as returned and created by the options.getSubRows option.

Inherited from

Row_Row.subRows

table

table: Table_Internal<TFeatures, TData>;

table: Table_Internal<TFeatures, TData>;

Defined in: core/rows/coreRowsFeature.types.ts:59

Reference to the parent table instance.

Inherited from

Row_Row.table