Skip to main content

APIs de Visibilidad de Columnas

Estado​

El estado de visibilidad de las columnas se almacena en la tabla utilizando la siguiente forma:

export type VisibilityState = Record<string, boolean>;

export type VisibilityTableState = {
  columnVisibility: VisibilityState;
};

Opciones de Definición de Columna​

enableHiding​

enableHiding?: boolean

Habilita/deshabilita la ocultación de la columna

API de Columna​

getCanHide​

getCanHide: () => boolean;

Devuelve si la columna puede ser ocultada

getIsVisible​

getIsVisible: () => boolean;

Devuelve si la columna es visible

toggleVisibility​

toggleVisibility: (value?: boolean) => void

Alterna la visibilidad de la columna

getToggleVisibilityHandler​

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

Devuelve una función que puede ser utilizada para alternar la visibilidad de la columna. Esta función puede ser utilizada para vincular un controlador de eventos a una casilla de verificación.

Opciones de Tabla​

onColumnVisibilityChange​

onColumnVisibilityChange?: OnChangeFn<VisibilityState>

Si se proporciona, esta función será llamada con un updaterFn cuando state.columnVisibility cambie. Esto anula la gestión de estado interna predeterminada, por lo que deberá mantener el cambio de estado de forma total o parcial fuera de la tabla.

enableHiding​

enableHiding?: boolean

Habilita/deshabilita la ocultación de columnas.

API de Tabla​

getVisibleFlatColumns​

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

Devuelve un array plano de columnas que están visibles, incluyendo las columnas padre.

getVisibleLeafColumns​

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

Devuelve un array plano de columnas de nodo hoja que están visibles.

getLeftVisibleLeafColumns​

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

Si hay fijación de columnas (column pinning), devuelve un array plano de columnas de nodo hoja que están visibles en la porción izquierda de la tabla.

getRightVisibleLeafColumns​

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

Si hay fijación de columnas (column pinning), devuelve un array plano de columnas de nodo hoja que están visibles en la porción derecha de la tabla.

getCenterVisibleLeafColumns​

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

Si hay fijación de columnas (column pinning), devuelve un array plano de columnas de nodo hoja que están visibles en la porción central/no fijada de la tabla.

setColumnVisibility​

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

Actualiza el estado de visibilidad de la columna mediante una función actualizadora o un valor

resetColumnVisibility​

resetColumnVisibility: (defaultState?: boolean) => void

Restablece el estado de visibilidad de la columna al estado inicial. Si se proporciona defaultState, el estado se restablecerá a {}

toggleAllColumnsVisible​

toggleAllColumnsVisible: (value?: boolean) => void

Alterna la visibilidad de todas las columnas

getIsAllColumnsVisible​

getIsAllColumnsVisible: () => boolean;

Devuelve si todas las columnas están visibles

getIsSomeColumnsVisible​

getIsSomeColumnsVisible: () => boolean;

Devuelve si algunas columnas están visibles

getToggleAllColumnsVisibilityHandler​

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

Devuelve un controlador para alternar la visibilidad de todas las columnas, destinado a ser vinculado a un elemento input[type=checkbox].

API de Fila​

getVisibleCells​

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

Devuelve un array de celdas que tienen en cuenta la visibilidad de las columnas para la fila.