React Fijación de filas de cuadrícula

The Ignite UI for React Row Pinning feature in React Grid allows you to pin one or multiple rows to the top or bottom of grid. Row Pinning allows end-users to pin rows in a particular order, duplicating them in a special area that is always visible even when they scroll the IgrGrid vertically. The React Grid has a built-in row pinning UI, which is enabled by initializing an IgrActionStrip component in the context of Grid. In addition, you can define custom UI and change the pin state of the rows via the Row Pinning API.

React Grid Row Pinning Example

Row Pinning UI

La interfaz integrada de fijación de filas se activa añadiendo unIgrActionStrip componente con elIgrGridPinningActions componente. La tira de acción se muestra automáticamente al pasar el cursor por una fila y mostrará un icono de botón de fijar o desclavar según el estado de la fila para la que se muestra. También se muestra una acción adicional que permite desplazar la copia de la fila fijada para que se vea para cada fila.

<IgrGrid>
    <IgrColumn field="Country" header="Country"> </IgrColumn>
    <IgrActionStrip>
        <IgrGridPinningActions></IgrGridPinningActions>
        <IgrGridEditingActions></IgrGridEditingActions>
    </IgrActionStrip>
</IgrGrid>

Row Pinning API

El fijamiento de fila se controla mediante lapinned entrada de laRow. Las filas fijadas se renderizan por defecto en la parte superior delIgrGrid cuerpo y permanecen fijas mediante desplazamiento vertical de las filas sin fijar en elIgrGrid cuerpo.

gridRef.current.getRowByIndex(0).pinned = true;

También puedes usar losIgrGridpinRow métodosunpinRow para fijar o desfijar registros por su ID:

gridRef.current.pinRow('ALFKI');
gridRef.current.unpinRow('ALFKI');

Ten en cuenta que el ID de fila es el valor principal de la clave, definido por laprimaryKey de la cuadrícula o por la propia instancia del registro. Ambos métodos devolven un valor booleano que indica si su operación respectiva es exitosa o no. Normalmente, la razón por la que fallan es que la fila ya está en el estado deseado.

Una fila queda clavada debajo de la última fila clavada. Cambiar el orden de las filas fijadas puede hacerse suscribiéndose alRowPinning evento y cambiando laInsertAtIndex propiedad de los argumentos del evento al índice de posición deseado.

const rowPinning = (event: IgrPinRowEventArgs) => {
    event.detail.insertAtIndex = 0;
}

<IgrGrid autoGenerate={true} onRowPinning={rowPinning}>
</IgrGrid>

Pinning Position

Puedes cambiar la posición de fijación de fila mediante lapinning opción de configuración. Te permite ajustar la posición del área del pasador en Arriba o Abajo. Cuando se configura en Inferior, las filas fijadas se renderizan en la parte inferior de la cuadrija, después de las filas sin fijar. Las filas sin fijar pueden desplazarse verticalmente, mientras que las filas fijas permanecen fijas en la parte inferior.

const pinning: IgrPinningConfig = { rows : RowPinningPosition.Bottom };

<IgrGrid ref={gridRef} autoGenerate={true} pinning={pinning}>
</IgrGrid>

Custom Row Pinning UI

Puede definir su interfaz de usuario personalizada y cambiar el estado del pin de las filas a través de la API relacionada.

Via extra column with icon

Digamos que en lugar de una franja de acción le gustaría mostrar un ícono de pin en cada fila, permitiendo al usuario final hacer clic y cambiar el estado del pin de una fila en particular. Esto se puede hacer agregando una columna adicional con una plantilla de celda que contenga el ícono personalizado.

const cellPinCellTemplate = (ctx: IgrCellTemplateContext) => {
    const index = ctx.cell.row.index;
    return (
        <>
            <span onPointerDown={(e: any) => toggleRowPin(index)}>📌</span>
        </>
    );
}

<IgrGrid primaryKey="ID" autoGenerate={false}>
    <IgrColumn width="70px" bodyTemplate={cellPinCellTemplate}>
    </IgrColumn>
</IgrGrid>

Al hacer clic en el icono personalizado, el estado del pin de la fila relacionada se puede cambiar utilizando los métodos API de la fila.

const toggleRowPin = (index: number) => {
  const grid = grid1Ref.current;
  grid.getRowByIndex(index).pinned = !grid.getRowByIndex(index).pinned;
}

Manifestación

Row Pinning Limitations

Solo se pueden anclar registros que existen en la fuente de datos.
El estado de fijación de filas no se exporta a Excel. La cuadrícula se exporta como si no se hubiera aplicado ninguna fijación de filas.
Las copias de filas fijadas en el área desplazable de la cuadrícula son una parte integral de cómo otras características de la cuadrícula logran su funcionalidad en presencia de filas fijadas y, por lo tanto, su creación no se puede deshabilitar ni eliminar.
Como la selección de filas funciona completamente con identificadores de fila, al seleccionar filas ancladas también se seleccionan sus copias (y viceversa). Además, la selección de rango (por ejemplo, usar SHIFT + clic) dentro del área anclada funciona de la misma manera que seleccionar un rango de filas dentro del área desplazable. La selección resultante incluye todas las filas intermedias, incluso si no están ancladas actualmente. Obtener las filas seleccionadas a través de la API solo devuelve una única instancia de cada registro seleccionado.

Styling

Además de los temas predefinidos, la cuadrícula se puede personalizar aún más configurando algunas de las propiedades CSS disponibles. En caso de que desee cambiar algunos de los colores, primero debe establecer una clase para la cuadrícula:

<IgrGrid className="grid"></IgrGrid>

Luego configure las propiedades CSS relacionadas para esa clase:

.grid {
    --ig-grid-pinned-border-width: 5px;
    --ig-grid-pinned-border-style: double;
    --ig-grid-pinned-border-color: #FFCD0F;
    --ig-grid-cell-active-border-color: #FFCD0F;
}

Manifestación

API References

Additional Resources

Nuestra comunidad es activa y siempre da la bienvenida a nuevas ideas.