列可见性

列可见性

状态 (State)

列的可见性状态 (visibility state) 以如下形式存储在表格中：

tsx

export type VisibilityState = Record<string, boolean>

export type VisibilityTableState = {
  columnVisibility: VisibilityState
}

export type VisibilityState = Record<string, boolean>

export type VisibilityTableState = {
  columnVisibility: VisibilityState
}

列定义选项 (Column Def Options)

enableHiding

tsx

enableHiding?: boolean

enableHiding?: boolean

启用/禁用列的隐藏功能

列 API (Column API)

getCanHide

tsx

getCanHide: () => boolean

getCanHide: () => boolean

返回该列是否可被隐藏

getIsVisible

tsx

getIsVisible: () => boolean

getIsVisible: () => boolean

返回该列当前是否可见

toggleVisibility

tsx

toggleVisibility: (value?: boolean) => void

toggleVisibility: (value?: boolean) => void

切换列的可见性状态

getToggleVisibilityHandler

tsx

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

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

返回一个用于切换列可见性的函数。该函数可用于将事件处理器绑定到复选框上。

表格选项 (Table Options)

onColumnVisibilityChange

tsx

onColumnVisibilityChange?: OnChangeFn<VisibilityState>

onColumnVisibilityChange?: OnChangeFn<VisibilityState>

当 state.columnVisibility 发生变化时，此回调函数会接收一个 updaterFn。这会覆盖默认的内部状态管理，因此您需要在表格外部完全或部分持久化状态变更。

enableHiding

tsx

enableHiding?: boolean

enableHiding?: boolean

启用/禁用所有列的隐藏功能

表格 API (Table API)

getVisibleFlatColumns

tsx

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

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

返回包含父列在内的所有可见列的扁平数组

getVisibleLeafColumns

tsx

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

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

返回所有可见叶子节点列的扁平数组

getLeftVisibleLeafColumns

tsx

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

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

如果启用了列固定 (column pinning)，返回左侧可见叶子节点列的扁平数组

getRightVisibleLeafColumns

tsx

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

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

如果启用了列固定 (column pinning)，返回右侧可见叶子节点列的扁平数组

getCenterVisibleLeafColumns

tsx

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

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

如果启用了列固定 (column pinning)，返回未固定/中间区域可见叶子节点列的扁平数组

setColumnVisibility

tsx

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

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

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

resetColumnVisibility

tsx

resetColumnVisibility: (defaultState?: boolean) => void

resetColumnVisibility: (defaultState?: boolean) => void

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

toggleAllColumnsVisible

tsx

toggleAllColumnsVisible: (value?: boolean) => void

toggleAllColumnsVisible: (value?: boolean) => void

切换所有列的可见性状态

getIsAllColumnsVisible

tsx

getIsAllColumnsVisible: () => boolean

getIsAllColumnsVisible: () => boolean

返回是否所有列都可见

getIsSomeColumnsVisible

tsx

getIsSomeColumnsVisible: () => boolean

getIsSomeColumnsVisible: () => boolean

返回是否部分列可见

getToggleAllColumnsVisibilityHandler

tsx

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

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

返回用于切换所有列可见性的处理器函数，通常绑定到 input[type=checkbox] 元素上

行 API (Row API)

getVisibleCells

tsx

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

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

返回该行中考虑列可见性后的单元格数组

状态 (State)

列定义选项 (Column Def Options)

enableHiding

列 API (Column API)

getCanHide

getIsVisible

toggleVisibility

getToggleVisibilityHandler

表格选项 (Table Options)

onColumnVisibilityChange

enableHiding

表格 API (Table API)

getVisibleFlatColumns

getVisibleLeafColumns

getLeftVisibleLeafColumns

getRightVisibleLeafColumns

getCenterVisibleLeafColumns

setColumnVisibility

resetColumnVisibility

toggleAllColumnsVisible

getIsAllColumnsVisible

getIsSomeColumnsVisible

getToggleAllColumnsVisibilityHandler

行 API (Row API)

getVisibleCells

Subscribe to Bytes

Subscribe to Bytes