Skip to content

GridExportStateParams API

Extended documentation for the GridExportStateParams interface with detailed information on the module's properties and available APIs.

Demos

Import

import { GridExportStateParams } from '@mui/x-data-grid-premium'
// or
import { GridExportStateParams } from '@mui/x-data-grid-pro'
// or
import { GridExportStateParams } from '@mui/x-data-grid'


Object passed as parameter in the exportState() grid API method.

Properties

Optional

By default, the grid exports all the models.
You can switch this property to true to only exports models that are either controlled, initialized or modified.
For instance, with this property, if you don't control or initialize the filterModel and you did not apply any filter, the model won't be exported.
Note that the column dimensions are not a model. The grid only exports the dimensions of the modified columns even when exportOnlyDirtyModels is false.

Type:boolean

Default:false