列顺序 API

状态

列顺序状态存储在表格中，形状如下：

tsx

export type ColumnOrderTableState = {
  columnOrder: ColumnOrderState
}

export type ColumnOrderState = string[]

export type ColumnOrderTableState = {
  columnOrder: ColumnOrderState
}

export type ColumnOrderState = string[]

tsx

onColumnOrderChange?: OnChangeFn<ColumnOrderState>

onColumnOrderChange?: OnChangeFn<ColumnOrderState>

如果提供了此函数，则在 `state.columnOrder` 更改时，将使用 `updaterFn` 调用此函数。这将覆盖默认的内部状态管理，因此您需要将状态更改完全或部分保存在表格外部。

tsx

setColumnOrder: (updater: Updater<ColumnOrderState>) => void

setColumnOrder: (updater: Updater<ColumnOrderState>) => void

设置或更新 `state.columnOrder` 状态。

tsx

resetColumnOrder: (defaultState?: boolean) => void

resetColumnOrder: (defaultState?: boolean) => void

将 `columnOrder` 状态重置为 `initialState.columnOrder`，或者可以传入 `true` 来强制重置为空状态 `[]`。

tsx

getIndex: (position?: ColumnPinningPosition) => number

getIndex: (position?: ColumnPinningPosition) => number

返回列在可见列顺序中的索引。可选地传入 `position` 参数以获取表格子区域中列的索引。

tsx

getIsFirstColumn: (position?: ColumnPinningPosition) => boolean

getIsFirstColumn: (position?: ColumnPinningPosition) => boolean

如果该列在可见列顺序中是第一个，则返回 `true`。可选地传入 `position` 参数以检查该列是否是表格子区域中的第一个。

tsx

getIsLastColumn: (position?: ColumnPinningPosition) => boolean

getIsLastColumn: (position?: ColumnPinningPosition) => boolean

如果该列在可见列顺序中是最后一个，则返回 `true`。可选地传入 `position` 参数以检查该列是否是表格子区域中的最后一个。