GridSingleSelectColDef API
Extended documentation for the GridSingleSelectColDef interface with detailed information on the module's properties and available APIs.
Demos
Import
import { GridSingleSelectColDef } from '@mui/x-data-grid-premium'
// or
import { GridSingleSelectColDef } from '@mui/x-data-grid-pro'
// or
import { GridSingleSelectColDef } from '@mui/x-data-grid'Column Definition interface used for columns with the
singleSelect type.Limit the aggregation function usable on this column.
By default, the column will have all the aggregation functions that are compatible with its type.
Type:string[]
Class name that will be added in cells for that column.
Type:GridCellClassNamePropType<R, V>
The description of the column rendered as tooltip if the column header name is not fully displayed.
Type:string
If true, the column menu is disabled for this column.
Type:boolean
Default:false
Display mode for the cell:
- 'text': For text-based cells (default)
- 'flex': For cells with HTMLElement children
Type:'text' | 'flex'
Allows setting the filter operators for this column.
Type:readonly GridFilterOperator<R, V, F>[]
The callback that generates a filtering function for a given quick filter value.
This function can return null to skip filtering for this value and column.
Type:GetApplyQuickFilterFn<R, V>
Used to determine the label displayed for a given value option.
Type:(value: ValueOptions) => string
Used to determine the value used for a value option.
Type:(value: ValueOptions) => any
Allows to use a different comparator function depending on the sort direction.
Takes precedence over sortComparator.
Type:(sortDirection: GridSortDirection) => GridComparatorFn<V> | undefined
If true, the rows can be grouped based on this column values (pro-plan only).
Only available in DataGridPremium.
Type:boolean
Default:true
Function that transforms a complex cell value into a key that be used for grouping the rows.
Type:GridGroupingValueGetter<R>
Class name that will be added in the column header cell.
Type:GridColumnHeaderClassNamePropType
Function that takes the clipboard-pasted value and converts it to a value used internally.
Type:GridPastedValueParser<R, V, F>
If false, the menu items for column pinning menu will not be rendered.
Only available in DataGridPro.
Type:boolean
Default:true
Callback fired when the edit props of the cell changes.
It allows to process the props that saved into the state.
Type:(params: GridPreProcessEditCellProps) => GridEditCellProps | Promise<GridEditCellProps>
Allows to override the component rendered as cell for this column.
Type:(params: GridRenderCellParams<R, V, F>) => React.ReactNode
Allows to override the component rendered in edit cell mode for this column.
Type:(params: GridRenderEditCellParams<R, V, F>) => React.ReactNode
Allows to render a component in the column header cell.
Type:(params: GridColumnHeaderParams<R, V, F>) => React.ReactNode
Allows to render a component in the column header filter cell.
Type:(params: GridRenderHeaderFilterProps) => React.ReactNode
Function that allows to provide a specific value to be used in row spanning.
Type:GridValueGetter<R, V, F>
Example values that can be used by the grid to get more context about the column.
Type:V[]
Function that allows to apply a formatter before rendering its value.
Type:GridValueFormatter<R, V, F>
Function that allows to get a specific data instead of field to render in the cell.
Type:GridValueGetter<R, V, F>
To be used in combination with type: 'singleSelect'. This is an array (or a function returning an array) of the possible cell values and labels.
Type:Array<ValueOptions> | ((params: GridValueOptionsParams<R>) => Array<ValueOptions>)
Function that takes the user-entered value and converts it to a value used internally.
Type:GridValueParser<R, V, F>
Function that allows to customize how the entered value is stored in the row.
It only works with cell/row editing.
Type:GridValueSetter<R, V, F>