列排序

列排序

状态 (State)

列的排序状态 (column ordering) 通过以下结构存储在表格中：

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 参数以检查列是否在表格子分区的末位。