Interface GridGroupingColDefOverride<R>

interface GridGroupingColDefOverride<R> {
    align?: GridAlignment;
    cellClassName?: GridCellClassNamePropType<R, any>;
    colSpan?: number | GridColSpanFn<R, any, any>;
    description?: string;
    disableColumnMenu?: boolean;
    disableExport?: boolean;
    disableReorder?: boolean;
    display?: "flex" | "text";
    filterable?: boolean;
    filterOperators?: readonly GridFilterOperator<R, any, any>[];
    flex?: number;
    getApplyQuickFilterFn?: GetApplyQuickFilterFn<R, any>;
    getSortComparator?: ((sortDirection: GridSortDirection) => undefined | GridComparatorFn<any>) | ((sortDirection: GridSortDirection) => undefined | GridComparatorFn<any>) | ((sortDirection: GridSortDirection) => undefined | GridComparatorFn<any>);
    headerAlign?: GridAlignment;
    headerClassName?: GridColumnHeaderClassNamePropType;
    headerName?: string;
    hideable?: boolean;
    hideDescendantCount?: boolean;
    hideSortIcons?: boolean;
    leafField?: string;
    mainGroupingCriteria?: string;
    maxWidth?: number;
    minWidth?: number;
    pinnable?: boolean;
    renderCell?: ((params: GridRenderCellParams<R, any, any, GridTreeNodeWithRender>) => ReactNode) | ((params: GridRenderCellParams<R, any, any, GridTreeNodeWithRender>) => ReactNode) | ((params: GridRenderCellParams<R, any, any, GridTreeNodeWithRender>) => ReactNode);
    renderHeader?: ((params: GridColumnHeaderParams<R, any, any>) => ReactNode) | ((params: GridColumnHeaderParams<R, any, any>) => ReactNode) | ((params: GridColumnHeaderParams<R, any, any>) => ReactNode);
    renderHeaderFilter?: ((params: GridRenderHeaderFilterProps) => ReactNode);
    resizable?: boolean;
    rowSpanValueGetter?: GridValueGetter<R, any, any, never>;
    sortable?: boolean;
    sortComparator?: GridComparatorFn<any>;
    sortingOrder?: readonly GridSortDirection[];
    valueFormatter?: GridValueFormatter<R, any, any, never>;
    valueGetter?: GridValueGetter<R, any, any, never>;
    valueParser?: GridValueParser<R, any, any>;
    width?: number;
}

Type Parameters

Hierarchy

  • Omit<GridColDef<R>,
        | "editable"
        | "valueSetter"
        | "field"
        | "type"
        | "preProcessEditCellProps"
        | "renderEditCell"
        | "groupable">
    • GridGroupingColDefOverride

Properties

align? cellClassName? colSpan? description? disableColumnMenu? disableExport? disableReorder? display? filterable? filterOperators? flex? getApplyQuickFilterFn? getSortComparator? headerAlign? headerClassName? headerName? hideable? hideDescendantCount? hideSortIcons? leafField? mainGroupingCriteria? maxWidth? minWidth? pinnable? renderCell? renderHeader? renderHeaderFilter? resizable? rowSpanValueGetter? sortable? sortComparator? sortingOrder? valueFormatter? valueGetter? valueParser? width?

Properties

Optionalalign

align?: GridAlignment

Align cell content.

OptionalcellClassName

cellClassName?: GridCellClassNamePropType<R, any>

Class name added to cells in this column.

OptionalcolSpan

colSpan?: number | GridColSpanFn<R, any, any>

Number of columns a cell should span.

Default

1

Optionaldescription

description?: string

The tooltip text shown when the column header name is truncated.

OptionaldisableColumnMenu

disableColumnMenu?: boolean

If true, the column menu is disabled for this column.

Default

false

OptionaldisableExport

disableExport?: boolean

If true, this column will not be included in exports.

Default

false

OptionaldisableReorder

disableReorder?: boolean

If true, this column cannot be reordered.

Default

false

Optionaldisplay

display?: "flex" | "text"

Display mode for the cell:

  • 'text': For text-based cells (default)
  • 'flex': For cells with HTMLElement children

Optionalfilterable

filterable?: boolean

If true, the column is filterable.

Default

true

OptionalfilterOperators

filterOperators?: readonly GridFilterOperator<R, any, any>[]

Allows setting the filter operators for this column.

Optionalflex

flex?: number

The flex grow factor of the column. Must be a positive number.

OptionalgetApplyQuickFilterFn

getApplyQuickFilterFn?: GetApplyQuickFilterFn<R, any>

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.

Param: value

The value with which we want to filter the column.

Param: colDef

The column from which we want to filter the rows.

Param: apiRef

Deprecated: The API of the grid.

Returns

The function to call to check if a row pass this filter value or not.

OptionalgetSortComparator

getSortComparator?: ((sortDirection: GridSortDirection) => undefined | GridComparatorFn<any>) | ((sortDirection: GridSortDirection) => undefined | GridComparatorFn<any>) | ((sortDirection: GridSortDirection) => undefined | GridComparatorFn<any>)

Provide an alternative comparator function for sorting. Takes precedence over sortComparator.

Param: sortDirection

The direction of the sort.

Returns

The comparator function to use.

OptionalheaderAlign

headerAlign?: GridAlignment

Align column header content.

OptionalheaderClassName

headerClassName?: GridColumnHeaderClassNamePropType

Class name added to the column header cell.

OptionalheaderName

headerName?: string

The title displayed in the column header cell.

Optionalhideable

hideable?: boolean

If false, removes the option to hide this column.

Default

true

OptionalhideDescendantCount

hideDescendantCount?: boolean

If true, the grouping cells will not render the amount of descendants.

Default

false

OptionalhideSortIcons

hideSortIcons?: boolean

Toggle the visibility of the sort icons.

Default

false

OptionalleafField

leafField?: string

The field from which we want to render the leaves of the tree. Do not have any effect when building the tree with the props.treeData feature.

OptionalmainGroupingCriteria

mainGroupingCriteria?: string

The field from which we want to apply the sorting and the filtering for the grouping column. It is only useful when props.rowGroupingColumnMode === "multiple" to decide which grouping criteria should be used for sorting and filtering. Do not have any effect when building the tree with the props.treeData feature.

Default

The sorting and filtering is applied based on the leaf field in any, otherwise based on top level grouping criteria.

OptionalmaxWidth

maxWidth?: number

The maximum width of the column in pixels.

Default

Infinity

OptionalminWidth

minWidth?: number

The minimum width of the column in pixels.

Default

50

Optionalpinnable

pinnable?: boolean

If false, the menu items for column pinning menu will not be rendered. Only available in DataGridPro. TODO: Use module augmentation to move it to @mui/x-data-grid-pro (need to modify how we handle column types default values).

Default

true

OptionalrenderCell

renderCell?: ((params: GridRenderCellParams<R, any, any, GridTreeNodeWithRender>) => ReactNode) | ((params: GridRenderCellParams<R, any, any, GridTreeNodeWithRender>) => ReactNode) | ((params: GridRenderCellParams<R, any, any, GridTreeNodeWithRender>) => ReactNode)

Override the component rendered as cell for this column.

Template: R,

V, F

Param: params

Object containing parameters for the renderer.

Returns

The element to be rendered.

OptionalrenderHeader

renderHeader?: ((params: GridColumnHeaderParams<R, any, any>) => ReactNode) | ((params: GridColumnHeaderParams<R, any, any>) => ReactNode) | ((params: GridColumnHeaderParams<R, any, any>) => ReactNode)

Override the component rendered in the column header cell.

Template: R,

V, F

Param: params

Object containing parameters for the renderer.

Returns

The element to be rendered.

OptionalrenderHeaderFilter

renderHeaderFilter?: ((params: GridRenderHeaderFilterProps) => ReactNode)

Allows to render a component in the column header filter cell.

Type declaration

    • (params): ReactNode

    • Parameters

      Returns ReactNode

      The element to be rendered.

Optionalresizable

resizable?: boolean

If false, disables resizing for this column.

Default

true

OptionalrowSpanValueGetter

rowSpanValueGetter?: GridValueGetter<R, any, any, never>

Function that returns a specific value to be used in row spanning.

Optionalsortable

sortable?: boolean

If false, disables sorting for this column.

Default

true

OptionalsortComparator

sortComparator?: GridComparatorFn<any>

A comparator function used to sort rows.

OptionalsortingOrder

sortingOrder?: readonly GridSortDirection[]

The order of the sorting sequence.

OptionalvalueFormatter

valueFormatter?: GridValueFormatter<R, any, any, never>

Formats the cell value before rendering.

OptionalvalueGetter

valueGetter?: GridValueGetter<R, any, any, never>

Function that returns specific data to render in the cell instead of using the field value.

OptionalvalueParser

valueParser?: GridValueParser<R, any, any>

Function that takes the user-entered value and converts it to a value used internally.

Returns

The converted value to use internally.

Optionalwidth

width?: number

The width of the column in pixels.

Default

100

Settings

Member Visibility

On This Page

Properties