Skip to main content

APIs de Encabezado

Estas son opciones y propiedades de API esenciales para todos los encabezados. Más opciones y propiedades de API pueden estar disponibles para otras características de tabla.

API de Encabezado​

Todos los objetos de encabezado tienen las siguientes propiedades:

id​

id: string;

El identificador único para el encabezado.

index​

index: number;

El índice para el encabezado dentro del grupo de encabezados.

depth​

depth: number;

La profundidad del encabezado, basada en índice cero.

column​

column: Column<TData>;

El objeto Column asociado al encabezado

headerGroup​

headerGroup: HeaderGroup<TData>;

El objeto HeaderGroup asociado al encabezado

subHeaders​

type subHeaders = Header<TData>[];

Los subencabezados/encabezados hijos jerárquicos del encabezado. Estará vacío si la columna asociada al encabezado es una columna hoja.

colSpan​

colSpan: number;

El col-span para el encabezado.

rowSpan​

rowSpan: number;

El row-span para el encabezado.

getLeafHeaders​

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

Devuelve los encabezados hoja anidados jerárquicamente bajo este encabezado.

isPlaceholder​

isPlaceholder: boolean;

Un booleano que indica si el encabezado es un encabezado de marcador de posición.

placeholderId​

placeholderId?: string

Si el encabezado es un encabezado de marcador de posición, este será un ID de encabezado único que no entra en conflicto con ningún otro encabezado en toda la tabla.

getContext​

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

Devuelve el contexto de renderizado (o props) para componentes basados en columnas como encabezados, pies de página y filtros. Usa estas props con la utilidad flexRender de tu framework para renderizarlos usando la plantilla de tu elección:

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

API de Tabla​

getHeaderGroups​

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

Devuelve todos los grupos de encabezados para la tabla.

getLeftHeaderGroups​

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

Si se está fijando, devuelve los grupos de encabezados para las columnas fijadas a la izquierda.

getCenterHeaderGroups​

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

Si se está fijando, devuelve los grupos de encabezados para las columnas que no están fijadas.

getRightHeaderGroups​

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

Si se está fijando, devuelve los grupos de encabezados para las columnas fijadas a la derecha.

getFooterGroups​

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

Devuelve todos los grupos de pie de página para la tabla.

getLeftFooterGroups​

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

Si se está fijando, devuelve los grupos de pie de página para las columnas fijadas a la izquierda.

getCenterFooterGroups​

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

Si se está fijando, devuelve los grupos de pie de página para las columnas que no están fijadas.

getRightFooterGroups​

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

Si se está fijando, devuelve los grupos de pie de página para las columnas fijadas a la derecha.

getFlatHeaders​

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

Devuelve los encabezados para todas las columnas de la tabla, incluyendo los encabezados padre.

getLeftFlatHeaders​

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

Si se está fijando, devuelve los encabezados para todas las columnas fijadas a la izquierda en la tabla, incluyendo los encabezados padre.

getCenterFlatHeaders​

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

Si se está fijando, devuelve los encabezados para todas las columnas que no están fijadas, incluyendo los encabezados padre.

getRightFlatHeaders​

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

Si se está fijando, devuelve los encabezados para todas las columnas fijadas a la derecha en la tabla, incluyendo los encabezados padre.

getLeafHeaders​

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

Devuelve los encabezados para todas las columnas hoja de la tabla (sin incluir los encabezados padre).

getLeftLeafHeaders​

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

Si se está fijando, devuelve los encabezados para todas las columnas hoja fijadas a la izquierda en la tabla (sin incluir los encabezados padre).

getCenterLeafHeaders​

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

Si se está fijando, devuelve los encabezados para todas las columnas que no están fijadas (sin incluir los encabezados padre).

getRightLeafHeaders​

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

Si se está fijando, devuelve los encabezados para todas las columnas hoja fijadas a la derecha en la tabla (sin incluir los encabezados padre).