跳到主要內容

GridActionsColDefAPI

GridActionsColDef 介面的擴充文件，包含模組屬性和可用 API 的詳細資訊。

範例

匯入

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


用於 actions 類型的欄位定義介面。

屬性

欄位的唯一識別碼。用於與 GridRowModel 值對應。

類型：string

傳回要顯示的動作的函式。

類型：(params: GridRowParams<R>) => readonly React.ReactElement<GridActionsCellItemProps>[]

欄位的類型。

類型：'actions'

預設：'actions'

選用

如果為 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，則可以根據此欄位值對列進行分組（僅限專業版方案）。
僅適用於 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[]

選用

在呈現之前格式化儲存格值。

類型：GridValueFormatter<R, V, F>

選用

傳回要在儲存格中呈現的特定資料，而不是使用欄位值的函式。

類型：GridValueGetter<R, V, F>

選用

接收使用者輸入的值並將其轉換為內部使用的值的函式。

類型：GridValueParser<R, V, F>

選用

自訂輸入值在列中儲存方式的函式。
僅適用於儲存格/列編輯。

類型：GridValueSetter<R, V, F>

選用

欄位的寬度（像素）。

類型：number

預設：100