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

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

import type { GridRowId, GridRowModel } from "../gridRows.js";
import type { GridRowSelectionModel } from "../gridRowSelectionModel.js";
import { GridControlledStateReasonLookup } from "../events/index.js";
/**
 * The selection API interface that is available in the grid [[apiRef]].
 */
export interface GridRowSelectionApi {
  /**
   * Change the selection state of a row.
   * @param {GridRowId} id The id of the row.
   * @param {boolean} isSelected Pass `false` to unselect a row. Default is `true`.
   * @param {boolean} resetSelection Whether to reset the already selected rows or not. Default is `false`.
   */
  selectRow: (id: GridRowId, isSelected?: boolean, resetSelection?: boolean) => void;
  /**
   * Determines if a row is selected or not.
   * @param {GridRowId} id The id of the row.
   * @returns {boolean} A boolean indicating if the row is selected.
   */
  isRowSelected: (id: GridRowId) => boolean;
  /**
   * Determines if a row can be selected or not.
   * @param {GridRowId} id The id of the row.
   * @returns {boolean} A boolean indicating if the row can be selected.
   */
  isRowSelectable: (id: GridRowId) => boolean;
  /**
   * Returns an array of the selected rows.
   * @returns {Map<GridRowId, GridRowModel>} A `Map` with the selected rows.
   * @deprecated Use `gridRowSelectionIdsSelector`, `gridRowSelectionCountSelector`, or `gridRowSelectionManagerSelector` instead.
   */
  getSelectedRows: () => Map<GridRowId, GridRowModel>;
  /**
   * Sets the new row selection model.
   *
   * ⚠️ Caution: `setRowSelectionModel` doesn't apply the selection propagation automatically.
   * Pass model returned by API method `getPropagatedRowSelectionModel` instead to apply the selection propagation.
   * @param {gridRowSelectionModel} rowSelectionModel The new row selection model.
   * @param {string} reason The reason for the state change.
   */
  setRowSelectionModel: (rowSelectionModel: GridRowSelectionModel, reason?: GridControlledStateReasonLookup['rowSelection']) => void;
}
export interface GridRowMultiSelectionApi {
  /**
   * Change the selection state of multiple rows.
   * @param {GridRowId[]} ids The row ids.
   * @param {boolean} isSelected The new selection state. Default is `true`.
   * @param {boolean} resetSelection Whether to reset the already selected rows or not. Default is `false`.
   */
  selectRows: (ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void;
  /**
   * Change the selection state of all the selectable rows in a range.
   * @param {Object} range The range of rows to select.
   * @param {GridRowId} range.startId The first row id.
   * @param {GridRowId} range.endId The last row id.
   * @param {boolean} isSelected The new selection state. Default is `true`.
   * @param {boolean} resetSelection Whether to reset the selected rows outside of the range or not. Default is `false`.
   */
  selectRowRange: (range: {
    startId: GridRowId;
    endId: GridRowId;
  }, isSelected?: boolean, resetSelection?: boolean) => void;
  /**
   * Returns the modified selection model after applying row selection propagation.
   *
   * Use this to achieve proper `rowSelectionPropagation` behavior when setting the selection model using `setRowSelectionModel`.
   * @param {GridRowSelectionModel} inputSelectionModel The selection model to propagate.
   * @returns {GridRowSelectionModel} The modified selection model.
   */
  getPropagatedRowSelectionModel: (inputSelectionModel: GridRowSelectionModel) => GridRowSelectionModel;
}
export interface GridMultiSelectionApi {
  /**
   * Change the selection state of multiple rows.
   * @param {GridRowId[]} ids The row ids.
   * @param {boolean} isSelected The new selection state. Default is `true`.
   * @param {boolean} resetSelection Whether to reset the already selected rows or not. Default is `false`.
   */
  selectRows: (ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void;
  /**
   * Change the selection state of all the selectable rows in a range.
   * @param {Object} range The range of rows to select.
   * @param {GridRowId} range.startId The first row id.
   * @param {GridRowId} range.endId The last row id.
   * @param {boolean} isSelected The new selection state. Default is `true`.
   * @param {boolean} resetSelection Whether to reset the selected rows outside of the range or not. Default is `false`.
   */
  selectRowRange: (range: {
    startId: GridRowId;
    endId: GridRowId;
  }, isSelected?: boolean, resetSelection?: boolean) => void;
}