Angular Tree Grid Row Pinning

    Se pueden fijar una o varias filas en la parte superior o inferior de la cuadrícula de interfaz de usuario Angular. Fijar filas en Ignite UI for Angular permite a los usuarios finales fijar filas en un orden particular, duplicándolas en un área especial que siempre está visible incluso cuando se desplazan verticalmente por la cuadrícula de árbol. Material UI Grid tiene una interfaz de usuario de fijación de filas incorporada, que se habilita inicializando un componente igxActionStrip en el contexto de Tree Grid. Además, puede definir una interfaz de usuario personalizada y cambiar el estado de fijación de las filas a través de la API de fijación de filas.

    Angular Tree Grid Row Pinning Example

    Row Pinning UI

    La interfaz de usuario integrada para fijar filas se habilita agregando un componente igxActionStrip con el componente GridPinningActions. 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.

    <igx-tree-grid [data]="data" [autoGenerate]="false">
    <igx-column *ngFor="let c of columns" [field]="c.field" [header]="c.field">
    </igx-column>

    <igx-action-strip #actionStrip>
        <igx-grid-pinning-actions></igx-grid-pinning-actions>
        <igx-grid-editing-actions></igx-grid-editing-actions>
    </igx-action-strip>
</igx-tree-grid>

    Row Pinning API

    La fijación de filas se controla mediante la entrada pinned de la row. Las filas fijadas se representan en la parte superior de la Cuadrícula de árbol de forma predeterminada y permanecen fijas mediante el desplazamiento vertical de las filas no fijadas en el cuerpo de la Cuadrícula de árbol.

    this.treeGrid.getRowByIndex(0).pinned = true;

    También puede utilizar los métodos pinRow o unpinRow de Tree Grid del IgxTreeGridComponent para anclar o desanclar registros por su ID:

    this.treeGrid.pinRow('ALFKI');
this.treeGrid.unpinRow('ALFKI');

    Tenga en cuenta que el ID de fila es el valor de la clave principal, definido por la primaryKey de la cuadrícula o la instancia de registro misma. Ambos métodos devuelven un valor booleano que indica si su operación respectiva fue exitosa o no. Generalmente la razón por la que fallan es que la fila ya se encuentra 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.

    <igx-tree-grid #treeGrid [data]="data" primaryKey="ID" foreignKey="ParentID" [autoGenerate]="true" (rowPinning)="rowPinning($event)">
</igx-tree-grid>

    public rowPinning(event) {
    event.insertAtIndex = 0;
}

    Pinning Position

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

    <igx-tree-grid [data]="data" [autoGenerate]="true" [pinning]="pinningConfig"></igx-tree-grid>

    public pinningConfig: IPinningConfig = { 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.

    <igx-tree-grid [data]="data" primaryKey="ID" foreignKey="ParentID" [autoGenerate]="false">
    <igx-column width="70px">
        <ng-template igxCell let-cell="cell" let-val>
            <igx-icon class="pin-icon" (mousedown)="togglePinning(cell.row, $event)">
                {{cell.row.pinned ? 'lock' : 'lock_open'}}
            </igx-icon>
        </ng-template>
    </igx-column>
    <igx-column *ngFor="let c of columns" [field]="c.field" [header]="c.field">
    </igx-column>
</igx-tree-grid>

    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.

    public togglePinning(row: IgxGridRow, event) {
    event.preventDefault();
    if (row.pinned) {
        row.unpin();
    } else {
        row.pin();
    }
}

    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.
    • Debido a cómo se almacenan internamente las filas fijadas para que puedan aparecer tanto en las áreas fijadas como en las áreas no fijadas de la cuadrícula, la fijación de filas no se admite cuando los registros de la cuadrícula se obtienen desde un punto final remoto a pedido (virtualización remota).
    • 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.
    • Cuando la cuadrícula no tiene un conjunto primaryKey y los escenarios de datos remotos están habilitados (al paginar, ordenar, filtrar y desplazar solicitudes de activación a un servidor remoto para recuperar los datos que se mostrarán en la cuadrícula), una fila perderá el siguiente estado después de un dato. solicitud completa:
      • Selección de fila
      • Fila Expandir/contraer
      • Edición de filas
      • Fijación de filas

    Estilismo

    IgxTreeGrid permite diseñar a través de la Ignite UI for Angular. El tema de Tree Grid expone una amplia variedad de propiedades, que permiten la personalización de todas las características de Tree Grid.

    A continuación, repasamos los pasos para personalizar el estilo de fijación de filas de Tree Grid.

    Importing the Styling Library

    Para comenzar a personalizar la función de fijación de filas, debe importar el archivo index, donde se encuentran todas las funciones de estilo y mixins.

    @use "igniteui-angular/theming" as *;

// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';

    Defining a Theme

    A continuación, cree un nuevo tema, que extienda el grid-theme y acepte los parámetros necesarios para personalizar la función de fijación de filas como desee.

    $custom-grid-theme: grid-theme(
    /* Pinning properties that affect styling */
    $pinned-border-width: 5px,
    $pinned-border-style: double,
    $pinned-border-color: #FFCD0F,
    $cell-active-border-color: #FFCD0F
    /* add other features properties here... */
);

    Using CSS variables

    El último paso es pasar el tema de cuadrícula personalizado:

    @include css-vars($custom-grid-theme);

    Using mixins

    Para diseñar componentes para Internet Explorer 11, debe utilizar un enfoque diferente, ya que no admite variables CSS.

    Si el componente utiliza una ViewEncapsulation Emulated, es necesario penetrate esta encapsulación usando::ng-deep. Sin embargo, para evitar que el tema personalizado se filtre a otros componentes, asegúrese de incluir el selector:host antes de::ng-deep:

    :host {
    ::ng-deep {
        // Pass the custom grid theme to the `igx-grid` mixin
        @include grid($custom-grid-theme);
    }
}

    Manifestación

    Note

    La muestra no se verá afectada por el tema global seleccionado en Change Theme.

    API References

    Additional Resources

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