Skip to main content

APIs de Fijación de Filas

Se puede fijar (Can-Pin)​

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

  • options.enableRowPinning se resuelve a true
  • options.enablePinning no está establecido en false

Estado​

El estado de fijación se almacena en la tabla usando la siguiente forma:

export type RowPinningPosition = false | "top" | "bottom";

export type RowPinningState = {
  top?: string[];
  bottom?: string[];
};

export type RowPinningRowState = {
  rowPinning: RowPinningState;
};

Opciones de la Tabla​

enableRowPinning​

enableRowPinning?: boolean | ((row: Row<TData>) => boolean)

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

keepPinnedRows​

keepPinnedRows?: boolean

Cuando false, las filas fijadas no serán visibles si se filtran o se paginan fuera de la tabla. Cuando true, las filas fijadas siempre serán visibles independientemente del filtrado o la paginación. Por defecto es true.

onRowPinningChange​

onRowPinningChange?: OnChangeFn<RowPinningState>

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

API de la Tabla​

setRowPinning​

setRowPinning: (updater: Updater<RowPinningState>) => void

Establece o actualiza el estado de state.rowPinning.

resetRowPinning​

resetRowPinning: (defaultState?: boolean) => void

Reinicia el estado de rowPinning a initialState.rowPinning, o se puede pasar true para forzar un reinicio a un estado en blanco por defecto {}.

getIsSomeRowsPinned​

getIsSomeRowsPinned: (position?: RowPinningPosition) => boolean;

Devuelve si hay alguna fila fijada o no. Opcionalmente, especifique si desea comprobar solo las filas fijadas en la posición top o bottom.

getTopRows​

getTopRows: () => Row < TData > [];

Devuelve todas las filas fijadas en la parte superior.

getBottomRows​

getBottomRows: () => Row < TData > [];

Devuelve todas las filas fijadas en la parte inferior.

getCenterRows​

getCenterRows: () => Row < TData > [];

Devuelve todas las filas que no están fijadas en la parte superior o inferior.

API de la Fila​

pin​

pin: (position: RowPinningPosition) => void

Fija una fila a la parte 'superior' o 'inferior', o la desfija al centro si se pasa false.

getCanPin​

getCanPin: () => boolean;

Devuelve si la fila puede ser fijada o no.

getIsPinned​

getIsPinned: () => RowPinningPosition;

Devuelve la posición fijada de la fila. ('superior', 'inferior' o false)

getPinnedIndex​

getPinnedIndex: () => number;

Devuelve el índice numérico fijado de la fila dentro de un grupo de filas fijadas.