Interface: Row_Core<TFeatures, TData>#

Defined in: types/Row.ts:12

Extends#

• Row_Row<TFeatures, TData>

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

_uniqueValuesCache#

_uniqueValuesCache: Record<string, unknown>;

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

Inherited from#

Row_Row._uniqueValuesCache

_valuesCache#

_valuesCache: Record<string, unknown>;

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

Inherited from#

Row_Row._valuesCache

depth#

depth: number;

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

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>[];

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

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>>;

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

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

getLeafRows()#

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

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

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;

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

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>[];

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

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[];

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

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;

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

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;

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

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;

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

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

Inherited from#

Row_Row.index

original#

original: TData;

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

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[];

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

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

Inherited from#

Row_Row.originalSubRows

parentId?#

optional parentId: string;

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

If nested, this row's parent row id.

Inherited from#

Row_Row.parentId

renderValue()#

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

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

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>[];

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

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>;

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

Reference to the parent table instance.

Inherited from#

Row_Row.table