Circle V2 API Docs
    Preparing search index...

    Interface Row<TData>

    interface Row<TData extends RowData> {
        _getAllCellsByColumnId: () => Record<string, Cell<TData, unknown>>;
        _getAllVisibleCells: () => Cell<TData, unknown>[];
        _groupingValuesCache: Record<string, any>;
        _uniqueValuesCache: Record<string, unknown>;
        _valuesCache: Record<string, unknown>;
        columnFilters: Record<string, boolean>;
        columnFiltersMeta: Record<string, FilterMeta>;
        depth: number;
        getAllCells: () => Cell<TData, unknown>[];
        getCanExpand: () => boolean;
        getCanMultiSelect: () => boolean;
        getCanPin: () => boolean;
        getCanSelect: () => boolean;
        getCanSelectSubRows: () => boolean;
        getCenterVisibleCells: () => Cell<TData, unknown>[];
        getGroupingValue: (columnId: string) => unknown;
        getIsAllParentsExpanded: () => boolean;
        getIsAllSubRowsSelected: () => boolean;
        getIsExpanded: () => boolean;
        getIsGrouped: () => boolean;
        getIsPinned: () => RowPinningPosition;
        getIsSelected: () => boolean;
        getIsSomeSelected: () => boolean;
        getLeafRows: () => Row<TData>[];
        getLeftVisibleCells: () => Cell<TData, unknown>[];
        getParentRow: () => Row<TData> | undefined;
        getParentRows: () => Row<TData>[];
        getPinnedIndex: () => number;
        getRightVisibleCells: () => Cell<TData, unknown>[];
        getToggleExpandedHandler: () => () => void;
        getToggleSelectedHandler: () => (event: unknown) => void;
        getUniqueValues: <TValue>(columnId: string) => TValue[];
        getValue: <TValue>(columnId: string) => TValue;
        getVisibleCells: () => Cell<TData, unknown>[];
        groupingColumnId?: string;
        groupingValue?: unknown;
        id: string;
        index: number;
        original: TData;
        originalSubRows?: TData[];
        parentId?: string;
        pin: (
            position: RowPinningPosition,
            includeLeafRows?: boolean,
            includeParentRows?: boolean,
        ) => void;
        renderValue: <TValue>(columnId: string) => TValue;
        subRows: Row<TData>[];
        toggleExpanded: (expanded?: boolean) => void;
        toggleSelected: (
            value?: boolean,
            opts?: { selectChildren?: boolean },
        ) => void;
    }

    Type Parameters

    • TData extends RowData

    Hierarchy

    • CoreRow<TData>
    • VisibilityRow<TData>
    • ColumnPinningRow<TData>
    • RowPinningRow
    • ColumnFiltersRow<TData>
    • GroupingRow
    • RowSelectionRow
    • ExpandedRow
      • Row
    Index

    Properties

    _getAllCellsByColumnId _getAllVisibleCells _groupingValuesCache _uniqueValuesCache _valuesCache columnFilters columnFiltersMeta depth getAllCells getCanExpand getCanMultiSelect getCanPin getCanSelect getCanSelectSubRows getCenterVisibleCells getGroupingValue getIsAllParentsExpanded getIsAllSubRowsSelected getIsExpanded getIsGrouped getIsPinned getIsSelected getIsSomeSelected getLeafRows getLeftVisibleCells getParentRow getParentRows getPinnedIndex getRightVisibleCells getToggleExpandedHandler getToggleSelectedHandler getUniqueValues getValue getVisibleCells groupingColumnId? groupingValue? id index original originalSubRows? parentId? pin renderValue subRows toggleExpanded toggleSelected

    Properties

    _getAllCellsByColumnId

    _getAllCellsByColumnId: () => Record<string, Cell<TData, unknown>>

    _getAllVisibleCells

    _getAllVisibleCells: () => Cell<TData, unknown>[]

    _groupingValuesCache

    _groupingValuesCache: Record<string, any>

    _uniqueValuesCache

    _uniqueValuesCache: Record<string, unknown>

    _valuesCache

    _valuesCache: Record<string, unknown>
    columnFilters: Record<string, boolean>

    The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID.

    API Docs

    Guide

    columnFiltersMeta: Record<string, FilterMeta>

    The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process.

    API Docs

    Guide

    depth: number

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

    API Docs

    Guide

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

    Returns all of the cells for the row.

    API Docs

    Guide

    getCanExpand: () => boolean

    Returns whether the row can be expanded.

    API Docs

    Guide

    getCanMultiSelect: () => boolean

    Returns whether or not the row can multi-select.

    API Docs

    Guide

    getCanPin: () => boolean

    Returns whether or not the row can be pinned.

    API Docs

    Guide

    getCanSelect: () => boolean

    Returns whether or not the row can be selected.

    API Docs

    Guide

    getCanSelectSubRows: () => boolean

    Returns whether or not the row can select sub rows automatically when the parent row is selected.

    API Docs

    Guide

    getCenterVisibleCells: () => Cell<TData, unknown>[]

    Returns all center pinned (unpinned) leaf cells in the row.

    API Docs

    Guide

    getGroupingValue: (columnId: string) => unknown

    Returns the grouping value for any row and column (including leaf rows).

    API Docs

    Guide

    getIsAllParentsExpanded: () => boolean

    Returns whether all parent rows of the row are expanded.

    API Docs

    Guide

    getIsAllSubRowsSelected: () => boolean

    Returns whether or not all of the row's sub rows are selected.

    API Docs

    Guide

    getIsExpanded: () => boolean

    Returns whether the row is expanded.

    API Docs

    Guide

    getIsGrouped: () => boolean

    Returns whether or not the row is currently grouped.

    API Docs

    Guide

    getIsPinned: () => RowPinningPosition

    Returns the pinned position of the row. ('top', 'bottom' or false)

    API Docs

    Guide

    getIsSelected: () => boolean

    Returns whether or not the row is selected.

    API Docs

    Guide

    getIsSomeSelected: () => boolean

    Returns whether or not some of the row's sub rows are selected.

    API Docs

    Guide

    getLeafRows: () => Row<TData>[]

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

    API Docs

    Guide

    getLeftVisibleCells: () => Cell<TData, unknown>[]

    Returns all left pinned leaf cells in the row.

    API Docs

    Guide

    getParentRow: () => Row<TData> | undefined

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

    API Docs

    Guide

    getParentRows: () => Row<TData>[]

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

    API Docs

    Guide

    getPinnedIndex: () => number

    Returns the numeric pinned index of the row within a pinned row group.

    API Docs

    Guide

    getRightVisibleCells: () => Cell<TData, unknown>[]

    Returns all right pinned leaf cells in the row.

    API Docs

    Guide

    getToggleExpandedHandler: () => () => void

    Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button.

    API Docs

    Guide

    getToggleSelectedHandler: () => (event: unknown) => void

    Returns a handler that can be used to toggle the row.

    API Docs

    Guide

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

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

    API Docs

    Guide

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

    Returns the value from the row for a given columnId.

    API Docs

    Guide

    getVisibleCells: () => Cell<TData, unknown>[]

    Returns an array of cells that account for column visibility for the row.

    API Docs

    Guide

    groupingColumnId?: string

    If this row is grouped, this is the id of the column that this row is grouped by.

    API Docs

    Guide

    groupingValue?: unknown

    If this row is grouped, this is the unique/shared value for the groupingColumnId for all of the rows in this group.

    API Docs

    Guide

    id: string

    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).

    API Docs

    Guide

    index: number

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

    API Docs

    Guide

    original: TData

    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.

    API Docs

    Guide

    originalSubRows?: TData[]

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

    API Docs

    Guide

    parentId?: string

    If nested, this row's parent row id.

    API Docs

    Guide

    pin: (
        position: RowPinningPosition,
        includeLeafRows?: boolean,
        includeParentRows?: boolean,
    ) => void

    Pins a row to the 'top' or 'bottom', or unpins the row to the center if false is passed.

    API Docs

    Guide

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

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

    API Docs

    Guide

    subRows: Row<TData>[]

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

    API Docs

    Guide

    toggleExpanded: (expanded?: boolean) => void

    Toggles the expanded state (or sets it if expanded is provided) for the row.

    API Docs

    Guide

    toggleSelected: (value?: boolean, opts?: { selectChildren?: boolean }) => void

    Selects/deselects the row.

    API Docs

    Guide

    Settings

    Member Visibility

    On This Page

    Properties