@mui/x-data-grid/models/api/gridRowApi.d.ts

The Community plan edition of the Data Grid components (MUI X).

import { GridRowModel, GridRowId, GridRowModelUpdate, GridValidRowModel, GridTreeNode } from '../gridRows';
export interface GridRowGroupChildrenGetterParams {
    /**
     * The row id of the group
     */
    groupId: GridRowId;
    /**
     * If `true`, the method will not return the generated rows generated by the grid (aggregation footers, groups, ...)
     * @default true
     */
    skipAutoGeneratedRows?: boolean;
    /**
     * If `true`, the method will only return the rows that are matching the current filters
     * @default false
     */
    applyFiltering?: boolean;
    /**
     * If `true`, the method will order the returned rows according to the current sorting rules
     * @default false
     */
    applySorting?: boolean;
}
/**
 * The Row API interface that is available in the grid `apiRef`.
 */
export interface GridRowApi {
    /**
     * Gets the full set of rows as [[Map<GridRowId, GridRowModel>]].
     * @returns {Map<GridRowId, GridRowModel>} The full set of rows.
     */
    getRowModels: () => Map<GridRowId, GridRowModel>;
    /**
     * Gets the total number of rows in the grid.
     * @returns {number} The number of rows.
     */
    getRowsCount: () => number;
    /**
     * Gets the list of row ids.
     * TODO rows v6: Rename or remove ?
     * @returns {GridRowId[]} A list of ids.
     */
    getAllRowIds: () => GridRowId[];
    /**
     * Sets a new set of rows.
     * @param {GridRowModel[]} rows The new rows.
     */
    setRows: (rows: GridRowModel[]) => void;
    /**
     * Allows to update, insert and delete rows.
     * @param {GridRowModelUpdate[]} updates An array of rows with an `action` specifying what to do.
     */
    updateRows: (updates: GridRowModelUpdate[]) => void;
    /**
     * Gets the row data with a given id.
     * @param {GridRowId} id The id of the row.
     * @returns {GridRowModel} The row data.
     */
    getRow: <R extends GridValidRowModel = any>(id: GridRowId) => R | null;
    /**
     * Gets the ID of a row given its data.
     * @param {GridRowModel} row The row data.
     * @returns {GridRowId} The id of the row.
     */
    getRowId: <R extends GridValidRowModel = any>(row: R) => GridRowId;
    /**
     * Gets the row node from the internal tree structure.
     * TODO rows v6: Rename `getTreeNode`
     * @param {GridRowId} id The id of the row.
     * @returns {GridTreeNode} The tree node.
     */
    getRowNode: <N extends GridTreeNode>(id: GridRowId) => N | null;
    /**
     * Gets the index of a row relative to the rows that are reachable by scroll.
     * @param {GridRowId} id The row id.
     * @returns {number} The index of the row.
     */
    getRowIndexRelativeToVisibleRows: (id: GridRowId) => number;
    /**
     * Replace a set of rows with new rows.
     * @param {number} firstRowToReplace The index of the first row to be replaced.
     * @param {GridRowModel[]} newRows The new rows.
     */
    unstable_replaceRows: (firstRowToReplace: number, newRows: GridRowModel[]) => void;
}
export interface GridRowProApi {
    /**
     * Moves a row from its original position to the position given by `targetIndex`.
     * @param {GridRowId} rowId The row id
     * @param {number} targetIndex The new position (0-based).
     */
    setRowIndex: (rowId: GridRowId, targetIndex: number) => void;
    /**
     * Gets the rows of a grouping criteria.
     * Only contains the rows provided to the grid, not the rows automatically generated by it.
     * @param {GridRowGroupChildrenGetterParams} params Object containing parameters for the getter.
     * @returns {GridRowId[]} The id of each row in the grouping criteria.
     */
    getRowGroupChildren: (params: GridRowGroupChildrenGetterParams) => GridRowId[];
    /**
     * Expand or collapse a row children.
     * @param {GridRowId} id the ID of the row to expand or collapse.
     * @param {boolean} isExpanded A boolean indicating if the row must be expanded or collapsed.
     */
    setRowChildrenExpansion: (id: GridRowId, isExpanded: boolean) => void;
}