Header API

这些是所有 header 的核心选项和 API 属性。其他 table features 可能提供更多选项和 API 属性。

表头 API

所有 header 对象都具有以下属性

id

tsx

id: string

id: string

header 的唯一标识符。

index

tsx

index: number

index: number

header 在 header group 中的索引。

depth

tsx

depth: number

depth: number

header 的深度，从零开始索引。

column

tsx

column: Column<TData>

column: Column<TData>

header 关联的 Column 对象

headerGroup

tsx

headerGroup: HeaderGroup<TData>

headerGroup: HeaderGroup<TData>

header 关联的 HeaderGroup 对象

subHeaders

tsx

type subHeaders = Header<TData>[]

type subHeaders = Header<TData>[]

header 的层级子/子 header。如果 header 关联的 column 是叶子 column，则为空。

colSpan

tsx

colSpan: number

colSpan: number

header 的列跨度 (col-span)。

rowSpan

tsx

rowSpan: number

rowSpan: number

header 的行跨度 (row-span)。

getLeafHeaders

tsx

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

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

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

isPlaceholder

tsx

isPlaceholder: boolean

isPlaceholder: boolean

一个布尔值，表示 header 是否为占位符 header。

placeholderId

tsx

placeholderId?: string

placeholderId?: string

如果 header 是占位符 header，则此值将是一个唯一的 header ID，该 ID 不会与其他 table 中的任何其他 header 冲突。

getContext

tsx

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

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

返回列相关组件（如 header、footer 和 filter）的渲染上下文 (或 props)。将这些 props 与你的框架的 flexRender 工具一起使用，以使用你选择的模板进行渲染。

tsx

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

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

Table API

getHeaderGroups

tsx

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

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

返回 table 的所有 header group。

getLeftHeaderGroups

tsx

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

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

如果进行了固定，则返回左侧固定列的 header group。

getCenterHeaderGroups

tsx

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

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

如果进行了固定，则返回未固定列的 header group。

getRightHeaderGroups

tsx

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

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

如果进行了固定，则返回右侧固定列的 header group。

getFooterGroups

tsx

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

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

返回 table 的所有 footer group。

getLeftFooterGroups

tsx

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

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

如果进行了固定，则返回左侧固定列的 footer group。

getCenterFooterGroups

tsx

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

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

如果进行了固定，则返回未固定列的 footer group。

getRightFooterGroups

tsx

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

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

如果进行了固定，则返回右侧固定列的 footer group。

getFlatHeaders

tsx

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

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

返回 table 中所有列的 header，包括父 header。

getLeftFlatHeaders

tsx

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

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

如果进行了固定，则返回 table 中所有左侧固定列的 header，包括父 header。

getCenterFlatHeaders

tsx

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

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

如果进行了固定，则返回 table 中所有未固定列的 header，包括父 header。

getRightFlatHeaders

tsx

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

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

如果进行了固定，则返回 table 中所有右侧固定列的 header，包括父 header。

getLeafHeaders

tsx

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

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

返回 table 中所有叶子列的 header（不包括父 header）。

getLeftLeafHeaders

tsx

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

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

如果进行了固定，则返回 table 中所有左侧固定叶子列的 header（不包括父 header）。

getCenterLeafHeaders

tsx

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

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

如果进行了固定，则返回 table 中所有未固定列的 header（不包括父 header）。

getRightLeafHeaders

tsx

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

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

如果进行了固定，则返回 table 中所有右侧固定叶子列的 header（不包括父 header）。

表头 API

id

index

depth

column

headerGroup

subHeaders

colSpan

rowSpan

getLeafHeaders

isPlaceholder

placeholderId

getContext

Table API

getHeaderGroups

getLeftHeaderGroups

getCenterHeaderGroups

getRightHeaderGroups

getFooterGroups

getLeftFooterGroups

getCenterFooterGroups

getRightFooterGroups

getFlatHeaders

getLeftFlatHeaders

getCenterFlatHeaders

getRightFlatHeaders

getLeafHeaders

getLeftLeafHeaders

getCenterLeafHeaders

getRightLeafHeaders

订阅 Bytes

订阅 Bytes