跳到内容

GridColDefAPI

GridColDef 接口的扩展文档，其中包含有关模块属性和可用 API 的详细信息。

演示

导入

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


列定义接口。

属性

列的唯一标识符。用于映射 GridRowModel 值。

类型:string

可选

如果为 true，则可以基于此列聚合单元格。

类型:boolean

默认值:true

可选

对齐单元格内容。

类型:GridAlignment

可选

限制可在此列上使用的聚合函数。
默认情况下，该列将具有与其类型兼容的所有聚合函数。

类型:string[]

可选

添加到此列中单元格的类名。

类型:GridCellClassNamePropType<R, V>

可选

单元格应跨越的列数。

类型:number | GridColSpanFn<R, V, F>

默认值:1

可选

当列标题名称被截断时显示的工具提示文本。

类型:string

可选

如果为 true，则禁用此列的列菜单。

类型:boolean

默认值:false

可选

如果为 true，则此列将不包含在导出中。

类型:boolean

默认值:false

可选

如果为 true，则无法重新排序此列。

类型:boolean

默认值:false

可选

单元格的显示模式
- 'text'：用于基于文本的单元格（默认）
- 'flex'：用于带有 HTMLElement 子元素的单元格

类型:'text' | 'flex'

可选

如果为 true，则此列的单元格是可编辑的。

类型:boolean

默认值:false

可选

如果为 true，则该列是可筛选的。

类型:boolean

默认值:true

可选

允许为此列设置筛选运算符。

类型:readonly GridFilterOperator<R, V, F>[]

可选

列的 flex 增长因子。必须为正数。

类型:number

可选

为给定的快速筛选值生成筛选函数的回调。
此函数可以返回 null 以跳过对此值和列的筛选。

类型:GetApplyQuickFilterFn<R, V>

可选

为排序提供备用比较器函数。
优先于 sortComparator。

类型:(sortDirection: GridSortDirection) => GridComparatorFn<V> | undefined

可选

如果为 true，则可以基于此列值对行进行分组（仅限 pro 计划）。
仅在 DataGridPremium 中可用。

类型:boolean

默认值:true

可选

将复杂的单元格值转换为可用于对行进行分组的键的函数。

类型:GridGroupingValueGetter<R>

可选

对齐列标题内容。

类型:GridAlignment

可选

添加到列标题单元格的类名。

类型:GridColumnHeaderClassNamePropType

可选

在列标题单元格中显示的标题。

类型:string

可选

如果为 false，则删除隐藏此列的选项。

类型:boolean

默认值:true

可选

切换排序图标的可见性。

类型:boolean

默认值:false

可选

列的最大宽度（以像素为单位）。

类型:number

默认值:Infinity

可选

列的最小宽度（以像素为单位）。

类型:number

默认值:50

可选

接受从剪贴板粘贴的值并将其转换为内部使用的值的函数。

类型:GridPastedValueParser<R, V, F>

可选

如果为 false，则不会呈现列固定菜单的菜单项。
仅在 DataGridPro 中可用。

类型:boolean

默认值:true

可选

当单元格的编辑 props 更改时触发的回调。
在保存到状态之前处理 props。

类型:(params: GridPreProcessEditCellProps) => GridEditCellProps | Promise<GridEditCellProps>

可选

覆盖为此列呈现为单元格的组件。

类型:(params: GridRenderCellParams<R, V, F>) => React.ReactNode

可选

覆盖为此列在编辑单元格模式下呈现的组件。

类型:(params: GridRenderEditCellParams<R, V, F>) => React.ReactNode

可选

覆盖在列标题单元格中呈现的组件。

类型:(params: GridColumnHeaderParams<R, V, F>) => React.ReactNode

可选

允许在列标题筛选器单元格中呈现组件。

类型:(params: GridRenderHeaderFilterProps) => React.ReactNode

可选

如果为 false，则禁用此列的调整大小功能。

类型:boolean

默认值:true

可选

返回要在行跨越中使用的特定值的函数。

类型:GridValueGetter<R, V, F>

可选

如果为 false，则禁用此列的排序功能。

类型:boolean

默认值:true

可选

用于对行进行排序的比较器函数。

类型:GridComparatorFn<V>

可选

排序顺序。

类型:readonly GridSortDirection[]

可选

列的类型。

类型:GridColType

默认值:'singleSelect'

可选

在渲染之前格式化单元格值。

类型:GridValueFormatter<R, V, F>

可选

返回要在单元格中渲染的特定数据而不是使用字段值的函数。

类型:GridValueGetter<R, V, F>

可选

接受用户输入的值并将其转换为内部使用的值的函数。

类型:GridValueParser<R, V, F>

可选

自定义输入值如何存储在行中的函数。
仅适用于单元格/行编辑。

类型:GridValueSetter<R, V, F>

可选

列的宽度（以像素为单位）。

类型:number

默认值:100