Skip to main content

APIs de fijación de columnas

Puede Fijarse​

La capacidad de una columna para ser fijada se determina por lo siguiente:

  • options.enablePinning no está establecido en false
  • options.enableColumnPinning no está establecido en false
  • columnDefinition.enablePinning no está establecido en false

Estado​

El estado de fijación se almacena en la tabla utilizando la siguiente estructura:

export type ColumnPinningPosition = false | "left" | "right";

export type ColumnPinningState = {
  left?: string[];
  right?: string[];
};

export type ColumnPinningTableState = {
  columnPinning: ColumnPinningState;
};

Opciones de la tabla​

enableColumnPinning​

enableColumnPinning?: boolean

Habilita/deshabilita la fijación de columnas para todas las columnas de la tabla.

onColumnPinningChange​

onColumnPinningChange?: OnChangeFn<ColumnPinningState>

Si se proporciona, esta función se llamará con un updaterFn cuando state.columnPinning cambie. Esto anula la gestión de estado interna predeterminada, por lo que también deberá proporcionar state.columnPinning desde su propio estado gestionado.

Opciones de definición de columna​

enablePinning​

enablePinning?: boolean

Habilita/deshabilita la fijación para la columna.

API de la tabla​

setColumnPinning​

setColumnPinning: (updater: Updater<ColumnPinningState>) => void

Establece o actualiza el estado state.columnPinning.

resetColumnPinning​

resetColumnPinning: (defaultState?: boolean) => void

Restablece el estado columnPinning a initialState.columnPinning, o se puede pasar true para forzar un restablecimiento a un estado vacío predeterminado de { left: [], right: [], }.

getIsSomeColumnsPinned​

getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean;

Devuelve si alguna columna está fijada o no. Opcionalmente, especifique si solo se deben buscar columnas fijadas en la posición left o right.

Nota: No tiene en cuenta la visibilidad de la columna

getLeftHeaderGroups​

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

Devuelve los grupos de encabezados fijados a la izquierda para la tabla.

getCenterHeaderGroups​

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

Devuelve los grupos de encabezados no fijados/centrales para la tabla.

getRightHeaderGroups​

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

Devuelve los grupos de encabezados fijados a la derecha para la tabla.

getLeftFooterGroups​

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

Devuelve los grupos de pie de página fijados a la izquierda para la tabla.

getCenterFooterGroups​

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

Devuelve los grupos de pie de página no fijados/centrales para la tabla.

getRightFooterGroups​

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

Devuelve los grupos de pie de página fijados a la derecha para la tabla.

getLeftFlatHeaders​

getLeftFlatHeaders: () => Header < TData > [];

Devuelve un array plano de encabezados fijados a la izquierda para la tabla, incluyendo los encabezados padre.

getCenterFlatHeaders​

getCenterFlatHeaders: () => Header < TData > [];

Devuelve un array plano de encabezados no fijados/centrales para la tabla, incluyendo los encabezados padre.

getRightFlatHeaders​

getRightFlatHeaders: () => Header < TData > [];

Devuelve un array plano de encabezados fijados a la derecha para la tabla, incluyendo los encabezados padre.

getLeftLeafHeaders​

getLeftLeafHeaders: () => Header < TData > [];

Devuelve un array plano de encabezados fijados a la izquierda de nodo hoja para la tabla.

getCenterLeafHeaders​

getCenterLeafHeaders: () => Header < TData > [];

Devuelve un array plano de encabezados no fijados/centrales de nodo hoja para la tabla.

getRightLeafHeaders​

getRightLeafHeaders: () => Header < TData > [];

Devuelve un array plano de encabezados fijados a la derecha de nodo hoja para la tabla.

getLeftLeafColumns​

getLeftLeafColumns: () => Column < TData > [];

Devuelve todas las columnas hoja fijadas a la izquierda.

getRightLeafColumns​

getRightLeafColumns: () => Column < TData > [];

Devuelve todas las columnas hoja fijadas a la derecha.

getCenterLeafColumns​

getCenterLeafColumns: () => Column < TData > [];

Devuelve todas las columnas hoja centrales fijadas (no fijadas).

API de columna​

getCanPin​

getCanPin: () => boolean;

Devuelve si la columna puede ser fijada o no.

getPinnedIndex​

getPinnedIndex: () => number;

Devuelve el índice numérico de fijación de la columna dentro de un grupo de columnas fijadas.

getIsPinned​

getIsPinned: () => ColumnPinningPosition;

Devuelve la posición fijada de la columna. ('left', 'right' o false)

pin​

pin: (position: ColumnPinningPosition) => void

Fija una columna a la left o a la right, o la desfija al centro si se pasa false.

API de fila​

getLeftVisibleCells​

getLeftVisibleCells: () => Cell < TData > [];

Devuelve todas las celdas hoja fijadas a la izquierda en la fila.

getRightVisibleCells​

getRightVisibleCells: () => Cell < TData > [];

Devuelve todas las celdas hoja fijadas a la derecha en la fila.

getCenterVisibleCells​

getCenterVisibleCells: () => Cell < TData > [];

Devuelve todas las celdas hoja centrales fijadas (no fijadas) en la fila.