Angular Tree Grid Row Selection

Con la selección de filas en Ignite UI for Angular, hay una columna selectora de filas que precede a todas las demás columnas dentro de la fila. Cuando un usuario hace clic en el selector de filas, la fila quedará seleccionada o deseleccionada, lo que le permitirá seleccionar varias filas de datos.

Angular Row Selection Example

El siguiente ejemplo demuestra los cuatro tipos de comportamiento de selección de filas de Tree Grid. Utilice los botones a continuación para habilitar cada uno de los modos de selección disponibles. Se proporcionará una breve descripción de cada interacción de botón a través de un cuadro de mensaje de snackbar. Utilice el botón de cambio para ocultar o mostrar la casilla de verificación del selector de filas.

Setup

Para configurar la selección de filas en igx-tree-grid, solo necesita configurar la propiedad rowSelection. Esta propiedad acepta la enumeración GridSelectionMode. GridSelectionMode expone los siguientes cuatro modos: none, single, multiple y multipleCascade. A continuación veremos cada uno de ellos con más detalle.

None Selection

En igx-tree-grid la selección de filas predeterminada está deshabilitada; de lo contrario ([rowSelection]="'none'"). Por lo tanto, no puede seleccionar o anular la selección de una fila mediante la interacción con la interfaz de usuario de Tree Grid; la única forma de completar estas acciones es utilizar los métodos API proporcionados.

Single Selection

La selección de una sola fila ahora se puede configurar fácilmente; lo único que debe hacer es establecer la propiedad [rowSelection] = '"single"'. Esto le brinda la oportunidad de seleccionar sólo una fila dentro de una cuadrícula. Puede seleccionar una fila haciendo clic en una celda o presionando la tecla de espacio cuando se enfoca en una celda de la fila y, por supuesto, puede seleccionar una fila haciendo clic en el campo selector de fila. Cuando se selecciona o deselecciona una fila, se emite el evento rowSelectionChanging.

<!-- selectionExample.component.html -->

<igx-tree-grid [data]="data" primaryKey="ID" foreignKey="ParentID" [autoGenerate]="true"
            [rowSelection]="'single'" [allowFiltering]="true" (rowSelectionChanging)="handleRowSelection($event)">
</igx-tree-grid>

/* selectionExample.component.ts */

public handleRowSelection(event) {
    if (args.added.length && args.added[0] === 3) {
        args.cancel = true;
    }
}

Multiple Selection

Para habilitar la selección de varias filas en igx-tree-grid simplemente establezca la propiedad rowSelection en multiple. Esto habilitará un campo selector de filas en cada fila y en el encabezado de la cuadrícula de árbol. El selector de filas permite a los usuarios seleccionar varias filas, y la selección persiste a través del desplazamiento, la paginación y las operaciones de datos, como la clasificación y el filtrado. La fila también se puede seleccionar haciendo clic en una celda o presionando la tecla de espacio cuando una celda está enfocada. Si ha seleccionado una fila y hace clic en otra mientras mantiene presionada la tecla Mayús, esto seleccionará todo el rango de filas. En este modo de selección, cuando hace clic en una sola fila, las filas seleccionadas anteriormente se deseleccionarán. Si hace clic mientras mantiene presionada la tecla Ctrl, la fila se alternará y se conservará la selección anterior.

<!-- selectionExample.component.html -->

<igx-tree-grid [data]="data" primaryKey="ID" foreignKey="ParentID" [rowSelection]="'multiple'"
        [allowFiltering]="true" (rowSelectionChanging)="handleRowSelection($event)" >
</igx-tree-grid>

Cascade Selection

Para habilitar la selección de filas en cascada en igx-tree-grid simplemente establezca la propiedad rowSelection en multipleCascade. Esto habilitará un campo selector de filas en cada fila y en el encabezado de la cuadrícula de árbol. El selector de filas permite a los usuarios seleccionar varias filas que seleccionarían a todos los elementos secundarios en el árbol siguiente. La selección persiste a través del desplazamiento, la paginación y las operaciones de datos, como la clasificación y el filtrado. La fila también se puede seleccionar haciendo clic en una celda o presionando la tecla de espacio cuando una celda está enfocada. Si ha seleccionado una fila y hace clic en otra mientras mantiene presionada la tecla Mayús, la selección de un registro principal seleccionará todos sus hijos incluso si no están en el rango seleccionado. En este modo de selección, al hacer clic en una sola fila, las filas previamente seleccionadas quedarán deseleccionadas. Si hace clic mientras mantiene presionada la tecla Ctrl, la fila y sus hijos se alternarán y se conservará la selección anterior.

<!-- selectionExample.component.html -->

<igx-tree-grid [data]="data" primaryKey="ID" foreignKey="ParentID" [autoGenerate]="true"
        [rowSelection]="'multipleCascade'" [allowFiltering]="true" (rowSelectionChanging)="handleRowSelection($event)">
</igx-tree-grid>

En este modo, el estado de selección de un padre depende completamente del estado de selección de sus hijos. Cuando un padre tiene algunos hijos seleccionados y algunos no seleccionados, su casilla de verificación está en un estado indeterminado.

<!-- selectionExample.component.ts -->

 public handleRowSelection(event: IRowSelectionEventArgs) {
    // use event.newSelection to retrieve primary key/row data of latest selected row
    this.selectedRowsCount = event.newSelection.length;
    this.selectedRowIndex = event.newSelection[0];
 }

Notas

La selección de filas activará el evento rowSelectionChanging. Este evento le brinda información sobre la nueva selección, la selección anterior y las filas que se agregaron y eliminaron de la selección anterior. Además, el evento es cancelable, por lo que esto le permite evitar la selección.
Cuando la selección de filas está habilitada, se muestran los selectores de filas, pero si no desea mostrarlos, puede configurar [hideRowSelectors] = true.
Cuando cambia entre modos de selección de filas en tiempo de ejecución, esto borrará el estado de selección de filas anterior.

API usage

Select rows programmatically

El siguiente fragmento de código se puede utilizar para seleccionar una o varias filas simultáneamente (a través de primaryKey); Además, el segundo parámetro de este método es una propiedad booleana mediante la cual puede elegir si la selección de fila anterior se borrará o no. La selección anterior se conserva de forma predeterminada.

<!-- selectionExample.component.html -->

<igx-tree-grid ... [primaryKey]="'ID'">
...
</igx-tree-grid>
...
<button (click)="this.treeGrid.selectRows([1,2,5], true)">Select 1,2 and 5</button> // select rows and clear previous selection state

Esto agregará las filas que corresponden a las entradas de datos con los ID 1, 2 y 5 a la selección de la Cuadrícula de árbol.

Deselect rows

Si necesita anular la selección de filas mediante programación, puede utilizar el método deselectRows(rowIds: []).

<!-- selectionExample.component.html -->

<igx-tree-grid ... [primaryKey]="'ID'">
...
</igx-tree-grid>
...
<button (click)="this.treeGrid.deselectRows([1,2,5])">Deselect 1,2 and 5</button>

Row selection event

Cuando hay algún cambio en la selección de filas, se emite el evento rowSelectionChanging. rowSelectionChanging expone los siguientes argumentos:

oldSelection: matriz de datos de la fila que contiene el estado anterior de la selección de la fila.
newSelection: conjunto de datos de fila que coinciden con el nuevo estado de la selección de fila.
added: conjunto de datos de fila que se agregan actualmente a la selección.
removed: conjunto de datos de fila que se eliminan actualmente según el estado de selección anterior.
event: el evento original que desencadenó el cambio de selección de fila.
cancel: le permite evitar el cambio de selección de fila.

Evento de selección de fila en escenarios de datos remotos

En escenarios de datos remotos, cuando la cuadrícula tiene una primaryKey establecida, el argumento del evento rowSelectionChanging.oldSelection no contendrá el objeto de datos de fila completo para las filas que actualmente están fuera de la vista de datos. En este caso, el objeto rowSelectionChanging.oldSelection contendrá solo una propiedad, que es el campo primaryKey. Para el resto de las filas, actualmente en la vista de datos, rowSelectionChanging.oldSelection contendrá todos los datos de la fila.

<!-- selectionExample.component.html -->

<igx-tree-grid (rowSelectionChanging)="handleRowSelectionChange($event)">
...
</igx-tree-grid>

/* selectionExample.component.ts */

public handleRowSelectionChange(args) {
    args.cancel = true; // this will cancel the row selection
}

Select all rows

Otro método API útil que proporciona igx-tree-grid es selectAll(onlyFilteredData). De forma predeterminada, este método seleccionará todas las filas de datos, pero si se aplica el filtrado, seleccionará solo las filas que coincidan con los criterios del filtro. Pero si llama al método con un parámetro falso, selectAll(false) siempre seleccionará todos los datos en la cuadrícula, incluso si se aplica el filtrado.

Note

Tenga en cuenta que selectAll() no seleccionará las filas que se eliminan.

Deselect all rows

igx-tree-grid proporciona el método deselectAll(onlyFilteredData), que de forma predeterminada anulará la selección de todas las filas de datos, pero si se aplica el filtrado, anulará la selección solo de las filas que coincidan con los criterios del filtro. Pero si llama al método con el parámetro falso, deselectAll(false) siempre borrará todo el estado de selección de filas incluso si se aplica el filtrado.

How to get selected rows

Si necesita ver qué filas están seleccionadas actualmente, puede obtener sus ID de fila con el captador selectedRows.


public getSelectedRows() {
    const currentSelection = this.treeGrid.selectedRows; // return array of row IDs
}

Además, asignar ID de fila a selectedRows le permitirá cambiar el estado de selección de la cuadrícula.

public mySelectedRows = ['Johnathan Winchester', 'Ana Sanders']; // an array of row IDs

<igx-tree-grid primaryKey="ID" rowSelection="multiple" [autoGenerate]="false" [selectedRows]="mySelectedRows" [data]="data">
    <igx-column [field]="'Name'"></igx-column>
    <igx-column [field]="'Title'"></igx-column>
</igx-tree-grid>

Row selector templates

Puede crear plantillas de encabezados y selectores de filas en la cuadrícula de árbol y también acceder a sus contextos, lo que proporciona una funcionalidad útil para diferentes escenarios.

De forma predeterminada, Tree Grid maneja todas las interacciones de selección de filas en el contenedor principal del selector de filas o en la fila misma, dejando solo la visualización del estado para la plantilla. La anulación de la funcionalidad básica generalmente se debe realizar mediante el rowSelectionChangingevento . En caso de que implemente una plantilla personalizada con un controlador click que anule la funcionalidad básica, debe detener la propagación del evento para preservar el estado de fila correcto.

plantilla de fila

Para crear una plantilla de selector de filas personalizada, dentro de igx-tree-grid, declare una <ng-template> con la directiva igxRowSelector. Desde la plantilla puede acceder a la variable de contexto proporcionada implícitamente, con propiedades que le brindan información sobre el estado de la fila.

La propiedad selected muestra si la fila actual está seleccionada o no, mientras que la propiedad index se puede usar para acceder al índice de la fila.

<ng-template igxRowSelector let-rowContext>
    {{ rowContext.index }}
    <igx-checkbox
        [checked]="rowContext.selected"
        [readonly]="true"
    ></igx-checkbox>
</ng-template>

La propiedad rowID se puede utilizar para obtener una referencia de una fila de igx-tree-grid. Esto es útil cuando implementas un controlador click en el elemento selector de fila.

<ng-template igxRowSelector let-rowContext>
    <igx-checkbox (click)="onSelectorClick($event, rowContext.key)"></igx-checkbox>
</ng-template>

En el ejemplo anterior, utilizamos una igx-checkbox y vinculamos rowContext.selected a su propiedad checked. Vea esto en acción en nuestra Row Numbering Demo.

Header template

Para crear una plantilla de selector de encabezado personalizada, dentro de Tree Grid, declare una <ng-template> con la directiva igxHeadSelector. Desde la plantilla puede acceder a la variable de contexto proporcionada implícitamente, con propiedades que le brindan información sobre el estado del encabezado.

La propiedad selectedCount muestra cuántas filas están seleccionadas actualmente, mientras que totalCount muestra cuántas filas hay en total en la cuadrícula de árbol.

<ng-template igxHeadSelector let-headContext>
    {{ headContext.selectedCount }} / {{ headContext.totalCount  }}
</ng-template>

Las propiedades selectedCount y totalCount se pueden utilizar para determinar si el selector principal debe estar marcado o indeterminado (seleccionado parcialmente).

<igx-tree-grid [data]="tGridData" primaryKey="ProductID" childDataKey="Products">
    <!-- ... -->
    <ng-template igxHeadSelector let-headContext>
        <igx-checkbox
            [checked]="headContext.selectedCount > 0 && headContext.selectedCount === headContext.totalCount"
            [indeterminate]="headContext.selectedCount > 0 && headContext.selectedCount !== headContext.totalCount">
        </igx-checkbox>
    </ng-template>
</igx-tree-grid>

Row Numbering Demo

Esta demostración muestra el uso de selectores de filas y encabezados personalizados. Este último usa rowContext.index para mostrar los números de fila y una igx-checkbox vinculada a rowContext.selected.

Conditional Selection Demo

Esta demostración evita que se seleccionen algunas filas mediante el evento rowSelectionChanging y una plantilla personalizada con la casilla de verificación deshabilitada para filas no seleccionables.

API References

Additional Resources

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