Column Visibility APIs

状态 (State)

列可见性状态以以下形式存储在表格中：

export type VisibilityState = Record<string, boolean>

export type VisibilityTableState = {
  columnVisibility: VisibilityState
}

enableHiding?: boolean

启用/禁用列的隐藏功能。

getCanHide: () => boolean

返回列是否可以被隐藏。

getIsVisible: () => boolean

返回列是否可见。

toggleVisibility: (value?: boolean) => void

切换列的可见性。

getToggleVisibilityHandler: () => (event: unknown) => void

返回一个函数，可用于切换列的可见性。此函数可用于绑定到复选框的事件处理程序。

onColumnVisibilityChange?: OnChangeFn<VisibilityState>

如果提供，当 state.columnVisibility 改变时，此函数将使用 updaterFn 调用。这会覆盖默认的内部状态管理，因此你需要完全或部分地在表格之外持久化状态更改。

enableHiding?: boolean

启用/禁用列的隐藏功能。

getVisibleFlatColumns: () => Column<TData>[]

返回可见列的扁平数组，包括父列。

getVisibleLeafColumns: () => Column<TData>[]

返回可见叶节点列的扁平数组。

getLeftVisibleLeafColumns: () => Column<TData>[]

如果启用列固定，返回表格左侧部分可见叶节点列的扁平数组。

getRightVisibleLeafColumns: () => Column<TData>[]

如果启用列固定，返回表格右侧部分可见叶节点列的扁平数组。

getCenterVisibleLeafColumns: () => Column<TData>[]

如果启用列固定，返回表格未固定/中心部分可见叶节点列的扁平数组。

setColumnVisibility: (updater: Updater<VisibilityState>) => void

通过更新函数或值更新列可见性状态。

resetColumnVisibility: (defaultState?: boolean) => void

将列可见性状态重置为初始状态。如果提供了 defaultState，状态将重置为 {}。

toggleAllColumnsVisible: (value?: boolean) => void

切换所有列的可见性。

getIsAllColumnsVisible: () => boolean

返回所有列是否都可见。

getIsSomeColumnsVisible: () => boolean

返回是否有部分列可见。

getToggleAllColumnsVisibilityHandler: () => ((event: unknown) => void)

返回一个用于切换所有列可见性的处理程序，旨在绑定到 input[type=checkbox] 元素。

getVisibleCells: () => Cell<TData>[]

返回考虑列可见性的行的单元格数组。

Column Sizing APIs

Global Faceting APIs