Lzh on GitHub

以下是所有标题的核心选项和 API 属性。其他 表格功能 可能提供更多选项和 API 属性。

标题 API (Header API)

所有标题对象都具有以下属性:

id

id: string

标题的唯一标识符。

index

index: number

标题在标题组中的索引。

depth

depth: number

标题的深度,从零开始索引。

column

column: Column<TData>

标题关联的 Column 对象。

headerGroup

headerGroup: HeaderGroup<TData>

标题关联的 HeaderGroup 对象。

subHeaders

type subHeaders = Header<TData>[]

标题的层次化子/下级标题。如果标题关联的列是叶子列,则为空数组。

colSpan

colSpan: number

标题的列跨度。

rowSpan

rowSpan: number

标题的行跨度。

getLeafHeaders

type getLeafHeaders = () => Header<TData>[]

返回此标题下层级嵌套的叶子标题。

isPlaceholder

isPlaceholder: boolean

一个布尔值,表示标题是否为占位符标题。

placeholderId

placeholderId?: string

如果标题是占位符标题,这将是一个唯一的标题 ID,与表格中任何其他标题都不冲突。

getContext

getContext: () => {
  table: Table<TData>
  header: Header<TData, TValue>
  column: Column<TData, TValue>
}

返回基于列的组件(如标题、页脚和过滤器)的渲染上下文(或 props)。将这些 props 与你框架的 flexRender 工具一起使用,以你选择的模板进行渲染:

flexRender(header.column.columnDef.header, header.getContext())

表格 API (Table API)

getHeaderGroups

type getHeaderGroups = () => HeaderGroup<TData>[]

返回表格的所有标题组。

getLeftHeaderGroups

type getRightHeaderGroups = () => HeaderGroup<TData>[]

如果启用固定(pinning),返回左侧固定列的标题组。

getCenterHeaderGroups

type getCenterHeaderGroups = () => HeaderGroup<TData>[]

如果启用固定,返回未固定列的标题组。

getRightHeaderGroups

type getRightHeaderGroups = () => HeaderGroup<TData>[]

如果启用固定,返回右侧固定列的标题组。

getFooterGroups

type getFooterGroups = () => HeaderGroup<TData>[]

返回表格的所有页脚组。

getLeftFooterGroups

type getLeftFooterGroups = () => HeaderGroup<TData>[]

如果启用固定,返回左侧固定列的页脚组。

getCenterFooterGroups

type getCenterFooterGroups = () => HeaderGroup<TData>[]

如果启用固定,返回未固定列的页脚组。

getRightFooterGroups

type getRightFooterGroups = () => HeaderGroup<TData>[]

如果启用固定,返回右侧固定列的页脚组。

getFlatHeaders

type getFlatHeaders = () => Header<TData, unknown>[]

返回表格中所有列的标题,包括父标题。

getLeftFlatHeaders

type getLeftFlatHeaders = () => Header<TData, unknown>[]

如果启用固定,返回表格中所有左侧固定列的标题,包括父标题。

getCenterFlatHeaders

type getCenterFlatHeaders = () => Header<TData, unknown>[]

如果启用固定,返回表格中所有未固定列的标题,包括父标题。

getRightFlatHeaders

type getRightFlatHeaders = () => Header<TData, unknown>[]

如果启用固定,返回表格中所有右侧固定列的标题,包括父标题。

getLeafHeaders

type getLeafHeaders = () => Header<TData, unknown>[]

返回表格中所有叶子列的标题(不包括父标题)。

getLeftLeafHeaders

type getLeftLeafHeaders = () => Header<TData, unknown>[]

如果启用固定,返回表格中所有左侧固定叶子列的标题(不包括父标题)。

getCenterLeafHeaders

type getCenterLeafHeaders = () => Header<TData, unknown>[]

如果启用固定,返回表格中所有未固定列的标题(不包括父标题)。

getRightLeafHeaders

type getRightLeafHeaders = () => Header<TData, unknown>[]

如果启用固定,返回表格中所有右侧固定叶子列的标题(不包括父标题)。