React Fijación de filas de cuadrícula jerárquica

    La función de fijación de filas Ignite UI for React de React cuadrícula jerárquica le permite anclar una o varias filas a la parte superior o inferior de la cuadrícula. El anclaje de filas permite a los usuarios finales anclar filas en un orden determinado, duplicándolas en un área especial que siempre está visible incluso cuando se desplazan HierarchicalGrid verticalmente. La cuadrícula jerárquica de React tiene una interfaz de usuario de fijación de filas integrada, que se habilita mediante la inicialización de un IgrActionStrip componente en el contexto de la cuadrícula jerárquica. Además, puede definir una interfaz de usuario personalizada y cambiar el estado de anclaje de las filas a través de la API de fijación de filas.

    React Hierarchical Grid Row Pinning Example

    Row Pinning UI

    La interfaz de usuario integrada para fijar filas se habilita agregando un componente IgrActionStrip con el componente IgrGridPinningActions. La franja de acción se muestra automáticamente al pasar el cursor sobre una fila y mostrará un ícono de botón para fijar o quitar 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 a la vista para cada fila fijada.

    <IgrHierarchicalGrid>
        <IgrColumn field="Country" header="Country"> </IgrColumn>
        <IgrActionStrip key="actionStrip">
            <IgrGridPinningActions key="pinningActions"></IgrGridPinningActions>
            <IgrGridEditingActions key="editingActions"></IgrGridEditingActions>
        </IgrActionStrip>
    </IgrHierarchicalGrid>
    

    Row Pinning API

    El anclaje de filas se controla a través de la pinned entrada de the Row. Las filas ancladas se representan en la parte superior de la HierarchicalGrid de forma predeterminada y permanecen fijas a través del desplazamiento vertical de las filas no ancladas en el HierarchicalGrid cuerpo.

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

    También puede usar los HierarchicalGrid​ ​PinRow métodos o UnpinRow métodos para anclar o desanclar registros por su ID:

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

    Tenga en cuenta que el identificador de fila es el valor de clave principal, definido por el PrimaryKey de la cuadrícula o la propia instancia de registro. Ambos métodos devuelven un valor booleano que indica si su respectiva operación se realiza correctamente o no. Normalmente, la razón por la que fallan es que la fila ya está en el estado deseado.

    Se fija una fila debajo de la última fila fijada. Se puede cambiar el orden de las filas fijadas suscribiéndose al evento RowPinning y cambiando la propiedad InsertAtIndex de los argumentos del evento al índice de posición deseado.

    function rowPinning(grid: IgrGridBaseDirective, event: IgrPinRowEventArgs ) {
        event.detail.insertAtIndex = 0;
    }
    
    <IgrHierarchicalGrid autoGenerate="true" rowPinning={rowPinning}>
    </IgrHierarchicalGrid>
    

    Pinning Position

    Puede cambiar la posición de fijación de filas a través de la opción de Pinning configuración. Le permite establecer la posición del área del pin en Superior o Inferior. Cuando se establece en Inferior, las filas ancladas se representan en la parte inferior de la cuadrícula, después de las filas no ancladas. Las filas no ancladas se pueden desplazar verticalmente, mientras que las filas ancladas permanecen fijas en la parte inferior.

    <IgrHierarchicalGrid id="dataGrid" autoGenerate="true">
    </IgrHierarchicalGrid>
    
    var grid = document.getElementById("dataGrid") as IgrHierarchicalGrid;
    grid.pinning = { rows: RowPinningPosition.Bottom };
    

    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.

    function cellPinCellTemplate(ctx: IgrCellTemplateContext) {
        const row = ctx.dataContext.cell.row;
        return (
            <>
                <span onPointerDown={(e: any) => toggleRowPin(row)}>📌</span>
            </>
        );
    }
    
    <IgrHierarchicalGrid primaryKey="ID" autoGenerate="false">
        <IgrColumn width="70px" bodyTemplate={cellPinCellTemplate}>
        </IgrColumn>
        <IgrRowIsland childDataKey="Orders" autoGenerate="true"></IgrRowIsland>
    </IgrHierarchicalGrid>
    

    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.

    function toggleRowPin(row: IgrRowType) {
      row.pinned = !row.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 ID de fila, al seleccionar filas fijadas también se seleccionan sus copias (y viceversa). Además, la selección de rango (por ejemplo, usando Shift + clic) dentro del área fijada 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 fijadas 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:

    <IgrHierarchicalGrid className="grid"></IgrHierarchicalGrid>
    

    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.