Interface GridRowMultiSelectionApi

interface GridRowMultiSelectionApi {
    getPropagatedRowSelectionModel: ((inputSelectionModel: GridRowSelectionModel) => GridRowSelectionModel);
    selectRowRange: ((range: {
        endId: GridRowId;
        startId: GridRowId;
    }, isSelected?: boolean, resetSelection?: boolean) => void);
    selectRows: ((ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void);
}

Hierarchy (view full)

GridRowMultiSelectionApi
- GridApiPro

Index

Properties

getPropagatedRowSelectionModel selectRowRange selectRows

Properties

getPropagatedRowSelectionModel

getPropagatedRowSelectionModel: ((inputSelectionModel: GridRowSelectionModel) => GridRowSelectionModel)

Returns the modified selection model after applying row selection propagation.

Use this to achieve proper rowSelectionPropagation behavior when setting the selection model using setRowSelectionModel.

Type declaration

- (inputSelectionModel): GridRowSelectionModel
- Parameters
  - inputSelectionModel: GridRowSelectionModel
    The selection model to propagate.
  Returns GridRowSelectionModel
  The modified selection model.

selectRowRange

selectRowRange: ((range: {
endId: GridRowId;
startId: GridRowId;
}, isSelected?: boolean, resetSelection?: boolean) => void)

Change the selection state of all the selectable rows in a range.

Type declaration

- (range, isSelected?, resetSelection?): void
- Parameters
  - range: {
    endId: GridRowId;
    startId: GridRowId;
    }
    The range of rows to select.
    - endId: GridRowId
      The last row id.
    - startId: GridRowId
      The first row id.
  - OptionalisSelected: boolean
    The new selection state. Default is true.
  - OptionalresetSelection: boolean
    Whether to reset the selected rows outside of the range or not. Default is false.
  Returns void

selectRows

selectRows: ((ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void)

Change the selection state of multiple rows.

Type declaration

- (ids, isSelected?, resetSelection?): void
- Parameters
  - ids: GridRowId[]
    The row ids.
  - OptionalisSelected: boolean
    The new selection state. Default is true.
  - OptionalresetSelection: boolean
    Whether to reset the already selected rows or not. Default is false.
  Returns void