@tanstack/table-core/build/lib/core/row.d.ts

Headless UI for building powerful tables & datagrids for TS/JS.

import { RowData, Cell, Row, Table } from '../types';
export interface CoreRow<TData extends RowData> {
    _getAllCellsByColumnId: () => Record<string, Cell<TData, unknown>>;
    _uniqueValuesCache: Record<string, unknown>;
    _valuesCache: Record<string, unknown>;
    /**
     * The depth of the row (if nested or grouped) relative to the root row array.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#depth)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    depth: number;
    /**
     * Returns all of the cells for the row.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getallcells)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    getAllCells: () => Cell<TData, unknown>[];
    /**
     * Returns the leaf rows for the row, not including any parent rows.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getleafrows)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    getLeafRows: () => Row<TData>[];
    /**
     * Returns the parent row for the row, if it exists.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getparentrow)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    getParentRow: () => Row<TData> | undefined;
    /**
     * Returns the parent rows for the row, all the way up to a root row.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getparentrows)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    getParentRows: () => Row<TData>[];
    /**
     * Returns a unique array of values from the row for a given columnId.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getuniquevalues)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    getUniqueValues: <TValue>(columnId: string) => TValue[];
    /**
     * Returns the value from the row for a given columnId.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getvalue)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    getValue: <TValue>(columnId: string) => TValue;
    /**
     * 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).
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#id)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    id: string;
    /**
     * The index of the row within its parent array (or the root data array).
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#index)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    index: number;
    /**
     * 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.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#original)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    original: TData;
    /**
     * An array of the original subRows as returned by the `options.getSubRows` option.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#originalsubrows)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    originalSubRows?: TData[];
    /**
     * If nested, this row's parent row id.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#parentid)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    parentId?: string;
    /**
     * Renders the value for the row in a given columnId the same as `getValue`, but will return the `renderFallbackValue` if no value is found.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#rendervalue)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    renderValue: <TValue>(columnId: string) => TValue;
    /**
     * An array of subRows for the row as returned and created by the `options.getSubRows` option.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#subrows)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
     */
    subRows: Row<TData>[];
}
export declare const createRow: <TData extends unknown>(table: Table<TData>, id: string, original: TData, rowIndex: number, depth: number, subRows?: Row<TData>[], parentId?: string) => Row<TData>;