Interface GridDataSource

interface GridDataSource {
    getChildrenCount?: ((row: GridValidRowModel) => number);
    getGroupKey?: ((row: GridValidRowModel) => string);
    getRows(params: GridGetRowsParams): Promise<GridGetRowsResponse>;
    updateRow?(updatedRow: GridValidRowModel): Promise<any>;
}

Index

Properties

getChildrenCount? getGroupKey?

Methods

getRows updateRow?

Properties

`Optional`getChildrenCount

getChildrenCount?: ((row: GridValidRowModel) => number)

Used to determine the number of children a row has on server.

Type declaration

- (row): number
- Parameters
  - row: GridValidRowModel
    The row to check the number of children.
  Returns number
  The number of children the row has. If the children count is not available for some reason, but there are some children, getChildrenCount should return -1.

`Optional`getGroupKey

getGroupKey?: ((row: GridValidRowModel) => string)

Used to group rows by their parent group. Replaces getTreeDataPath used in client side tree-data.

Type declaration

- (row): string
- Parameters
  - row: GridValidRowModel
    The row to get the group key of.
  Returns string
  The group key for the row.

Methods

getRows

getRows(params): Promise<GridGetRowsResponse>
This method will be called when the grid needs to fetch some rows.
Parameters
- params: GridGetRowsParams
  The parameters required to fetch the rows.
Returns Promise<GridGetRowsResponse>
A promise that resolves to the data of type [GridGetRowsResponse].
- Defined in @mui/x-data-grid/models/gridDataSource.d.ts:50

`Optional`updateRow

updateRow(updatedRow): Promise<any>
This method will be called when the user updates a row [Not yet implemented].
Parameters
- updatedRow: GridValidRowModel
  The updated row.
Returns Promise<any>
If resolved (synced on the backend), the grid will update the row and mutate the cache.
- Defined in @mui/x-data-grid/models/gridDataSource.d.ts:56