DataGridPremium API

Set of columns of type GridColDef[].

Set of rows of type GridRowsProp.

Aggregation functions available on the grid.

Set the aggregation model of the grid.

Rows used to generate the aggregated value. If filtered, the aggregated values are generated using only the rows currently passing the filtering process. If all, the aggregated values are generated using all the rows.

The ref object that allows grid manipulation. Can be instantiated with useGridApiRef().

The label of the grid.

The id of the element containing a label for the grid.

If true, the grid height is dynamic and follow the number of rows in the grid.

If true, the pageSize is calculated according to the container size and the max number of rows to avoid rendering a vertical scroll bar.

Controls the modes of the cells.

If true, the grid get a first column with a checkbox that allows to select rows.

If true, the "Select All" header checkbox selects only the rows on the current page. To be used in combination with checkboxSelection. It only works if the pagination is enabled.

Override or extend the styles applied to the component.

See CSS API below for more details.

The character used to separate cell values when copying to the clipboard.

Number of extra columns to be rendered before/after the visible slice.

Sets the height in pixel of the column headers in the grid.

Number of rows from the columnBuffer that can be visible before a new slice is rendered.

Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.

Overridable components.

Overridable components props dynamically passed to the component at rendering.

If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded.

Set the density of the grid.

The row ids to show the detail panel.

If true, aggregation is disabled.

If true, the filtering will only be applied to the top level rows when grouping rows with the treeData prop.

If true, the sorting will only be applied to the top level rows when grouping rows with the treeData prop.

If true, the clipboard paste is disabled.

If true, column filters are disabled.

If true, the column menu is disabled.

If true, the column pinning is disabled.

If true, reordering columns is disabled.

If true, resizing columns is disabled.

If true, hiding/showing columns is disabled.

If true, the density selector is disabled.

If true, filtering with multiple columns is disabled.

If true, sorting with multiple columns is disabled.

If true, multiple selection using the Ctrl or CMD key is disabled.

If true, the row grouping is disabled.

If true, the selection on click on a row or cell is disabled.

If true, the virtualization is disabled.

Controls whether to use the cell or row editing.

Unstable features, breaking changes might be introduced. For each feature, if the flag is not explicitly set to true, then the feature is fully disabled, and neither property nor method calls will have any effect.

Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.

Set the filter model of the grid.

Determines the position of an aggregated value.

Function that applies CSS classes dynamically on cells.

Function that returns the element to render in row detail.

Function that returns the height of the row detail panel.

Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.

Function that applies CSS classes dynamically on rows.

Function that sets the row height per row.

Return the id of a given GridRowModel.

Function that allows to specify the spacing between rows.

Determines the path of a row in the tree data. For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"]. Note that all paths must contain at least one element.

The grouping column used by the tree data.

If true, the footer component is hidden.

If true, the pagination component in the footer is hidden.

If true, the row count in the footer is hidden. It has no effect if the pagination is enabled.

If true, the selected row count in the footer is hidden.

The initial state of the DataGridPremium. The data in it is set in the state on initialization but isn't controlled. If one of the data in initialState is also being controlled, then the control state wins.

Callback fired when a cell is rendered, returns true if the cell is editable.

Determines if a group should be expanded after its creation. This prop takes priority over the defaultGroupingExpansionDepth prop.

Determines if a row can be selected.

If true, moving the mouse pointer outside the grid before releasing the mouse button in a column re-order action will not cause the column to jump back to its original position.

If true, the selection model will retain selected rows that do not exist. Useful when using server side pagination and row selections need to be retained when changing pages.

If true, a loading overlay is displayed.

Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.

Pass a custom logger in the components that implements the Logger interface.

Allows to pass the logging level or false to turn off logging.

Nonce of the inline styles for Content Security Policy.

Callback fired when the row grouping model changes.

Callback fired when any cell is clicked.

Callback fired when a double click event comes from a cell element.

Callback fired when the cell turns to edit mode.

Callback fired when the cell turns to view mode.

Callback fired when a keydown event comes from a cell element.

Callback fired when the cellModesModel prop changes.

Callback called when the data is copied to the clipboard.

Callback fired when the clipboard paste operation ends.

Callback fired when the clipboard paste operation starts.

Callback fired when a click event comes from a column header element.

Callback fired when a double click event comes from a column header element.

Callback fired when a mouse enter event comes from a column header element.

Callback fired when a mouse leave event comes from a column header element.

Callback fired when a mouseout event comes from a column header element.

Callback fired when a mouseover event comes from a column header element.

Callback fired when a column is reordered.

Callback fired while a column is being resized.

Callback fired when the column visibility model changes.

Callback fired when the width of a column is changed.

Callback fired when the detail panel of a row is opened or closed.

Callback fired when the state of the Excel export changes.

Callback fired when rowCount is set and the next batch of virtualized rows is rendered.

Callback fired when the Filter model changes before the filters are applied.

Callback fired when the menu is closed.

Callback fired when the menu is opened.

Callback fired when the pagination model has changed.

Callback fired when the pinned columns have changed.

Callback fired when the preferences panel is closed.

Callback fired when the preferences panel is opened.

Callback called when processRowUpdate throws an error or rejects.

Callback fired when the grid is resized.

Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

Callback fired when a double click event comes from a row container element.

Callback fired when the row changes are committed.

Callback fired when the row turns to edit mode.

Callback fired when the row turns to view mode.

Callback fired when the row grouping model changes.

Callback fired when the rowModesModel prop changes.

Callback fired when a row is being reordered.

Callback fired when the selection state of one or multiple rows changes.

Callback fired when scrolling to the bottom of the grid viewport.

Callback fired when the sort model changes before a column is sorted.

Select the pageSize dynamically using the component UI.

If true, pagination is enabled.

Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side.

The pagination model of type GridPaginationModel which refers to current page and pageSize.

The column fields to display pinned to left or right.

Rows data to pin on top or bottom.

Callback called before updating a row with new values in the row and cell editing.

Number of extra rows to be rendered before/after the visible slice.

Set the total number of rows, if it is different from the length of the value rows prop. If some rows have children (for instance in the tree data), this number represents the amount of top level rows.

If single, all the columns that are grouped are represented in the same grid column. If multiple, each column that is grouped is represented in its own grid column.

Set the row grouping model of the grid.

Sets the height in pixel of a row in the grid.

Controls the modes of the rows.

If true, the reordering of rows is enabled.

If false, the row selection mode is disabled.

Sets the row selection model of the grid.

Loading rows can be processed on the server or client-side. Set it to 'client' if you would like enable infnite loading. Set it to 'server' if you would like to enable lazy loading. * @default "client"

Sets the type of space between rows added by getRowSpacing.

Number of rows from the rowBuffer that can be visible before a new slice is rendered.

Override the height/width of the grid inner scrollbar.

Set the area in px at the bottom of the grid viewport where onRowsScrollEnd is called.

If true, the vertical borders of the cells are displayed.

If true, the right border of the column headers are displayed.

Overridable components props dynamically passed to the component at rendering.

Overridable components.

Sorting can be processed on the server or client-side. Set it to 'client' if you would like to handle sorting on the client-side. Set it to 'server' if you would like to handle sorting on the server-side.

The order of the sorting sequence.

Set the sort model of the grid.

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

If positive, the Grid will throttle updates coming from apiRef.current.updateRows and apiRef.current.setRows. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update.

If true, the rows will be gathered in a tree structure according to the getTreeDataPath prop.

If true, the cell selection mode is enabled.

Set the cell selection model of the grid.

If true, enables the data grid filtering on header feature.

If true, the grid will not use valueFormatter when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the valueFormatter for CSV export or clipboard export.

Callback fired when the selection state of one or multiple cells changes.

The function is used to split the pasted text into rows and cells.