跳到主要內容

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>[]

選填

欄的彈性成長因子。必須為正數。

類型：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

選填

當儲存格的編輯屬性變更時觸發的回呼。
在儲存到狀態之前處理屬性。

類型：(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