Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Table API Reference
Column API Reference
Row API Reference
Cell API Reference
Header API Reference
Features API Reference
Legacy API Reference
Enterprise
Row API Reference

Row_Row

Interface: Row_Row<TFeatures, TData>

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

Extends

Extended by

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

_uniqueValuesCache

ts
_uniqueValuesCache: Record<string, unknown>;

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

Inherited from

Row_CoreProperties._uniqueValuesCache


_valuesCache

ts
_valuesCache: Record<string, unknown>;

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

Inherited from

Row_CoreProperties._valuesCache


depth

ts
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_CoreProperties.depth


getAllCells()

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

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

Returns all of the cells for the row.

Returns

Cell<TFeatures, TData, unknown>[]


getAllCellsByColumnId()

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

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

Returns

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


getLeafRows()

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

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

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

Returns

Row<TFeatures, TData>[]


getParentRow()

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

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

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

Returns

Row<TFeatures, TData> | undefined


getParentRows()

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

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

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

Returns

Row<TFeatures, TData>[]


getUniqueValues()

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

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

Returns a unique array of values from the row for a given columnId.

Type Parameters

TValue

TValue

Parameters

columnId

string

Returns

TValue[]


getValue()

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

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

Returns the value from the row for a given columnId.

Type Parameters

TValue

TValue

Parameters

columnId

string

Returns

TValue


id

ts
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_CoreProperties.id


index

ts
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_CoreProperties.index


original

ts
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_CoreProperties.original


originalSubRows?

ts
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_CoreProperties.originalSubRows


parentId?

ts
optional parentId: string;

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

If nested, this row's parent row id.

Inherited from

Row_CoreProperties.parentId


renderValue()

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

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

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


subRows

ts
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_CoreProperties.subRows


table

ts
table: Table_Internal<TFeatures, TData>;

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

Reference to the parent table instance.

Inherited from

Row_CoreProperties.table