Web Components Selección de filas de cuadrícula

    La función de selección de filas Ignite UI for Web Components en Web Components cuadrícula permite a los usuarios seleccionar, resaltar o anular la selección interactiva de una o varias filas de datos. Hay varios modos de selección disponibles en: IgcGridComponent​

    • Ninguna selección
    • Selección múltiple
    • Selección única

    Ejemplo de selección de filas Web Components

    En el ejemplo siguiente se muestran los tres tipos de IgcGridComponent Es decir, que Selección de filas comportamiento. Utilice el menú desplegable a continuación para habilitar cada uno de los modos de selección disponibles. Utilice la casilla de verificación para esconder o mostrar las casillas de verificación del selector de filas.

    Configuración

    Para configurar la selección de filas en IgcGridComponent, solo necesita configurar la propiedad rowSelection. Esta propiedad acepta la enumeración GridSelectionMode.

    GridSelectionMode expone los siguientes modos:

    • Ninguno
    • Soltero
    • Múltiple

    A continuación veremos cada uno de ellos con más detalle.

    Ninguna selección

    En IgcGridComponent, la selección de filas predeterminada está deshabilitada (rowSelection es Ninguno). Por lo tanto, no puede seleccionar o anular la selección de una fila mediante la interacción con la interfaz de usuario IgcGridComponent; la única forma de completar estas acciones es utilizar los métodos API proporcionados.

    Selección única

    La selección de una sola fila ahora se puede configurar fácilmente, lo único que necesita hacer es establecer rowSelection la Single propiedad. Esto le da la oportunidad de seleccionar solo una fila dentro de una cuadrícula. Puede seleccionar una fila haciendo clic en una celda o presionando la SPACE tecla cuando se enfoca en una celda de la fila y, por supuesto, puede seleccionar una fila haciendo clic en el campo selector de filas. Cuando se selecciona o se anula la selección RowSelectionChanging, se emite un evento.

    <igc-grid id="grid" row-selection="Single" auto-generate="true" allow-filtering="true"> </igc-grid>
    constructor() { const grid = document.getElementById('grid') as IgcGridComponent; grid.data = this.data; grid.addEventListener("rowSelectionChanging", this.handleRowSelection); }
    public handleRowSelection(args: IgcRowSelectionEventArgs) { if (args.detail.added.length && args.detail.added[0] === 3) { args.detail.cancel = true; } }

    Selección múltiple

    Para habilitar la selección de varias filas en el IgcGridComponent simplemente establezca la rowSelection propiedad en Multiple. Esto habilitará un campo selector de filas en cada fila y en el IgcGridComponent encabezado. 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 ordenación y el filtrado. La fila también se puede seleccionar haciendo clic en una celda o presionando la SPACE tecla cuando una celda está enfocada. Si ha seleccionado una fila y hace clic en otra mientras mantiene presionada la SHIFT tecla, esto seleccionará todo el rango de filas. En este modo de selección, al hacer clic en una sola fila, se anulará la selección de las filas seleccionadas anteriormente. Si hace clic mientras mantiene presionada la CTRL tecla, la fila se alternará y se conservará la selección anterior.

    <igc-grid id="grid" primary-key="ProductID" row-selection="Multiple" allow-filtering="true" auto-generate="true"> </igc-grid>

    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 en verdadero.
    • Cuando cambia entre modos de selección de filas en tiempo de ejecución, esto borrará el estado de selección de filas anterior.

    Uso de API

    Seleccionar filas mediante programación

    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.

    <igc-grid id="grid" primary-key="ProductID" row-selection="Multiple" auto-generate="true"> </igc-grid> <button id='select'>Select 1,2 and 5</button>
    constructor() { document.getElementById("select").addEventListener("click", this.onClickSelect); } public onClickSelect() { const grid = document.getElementById("grid") as IgcGridComponent; grid.selectRows([1,2,5], true); }

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

    Anular la selección de filas

    Si necesita anular la selección de filas mediante programación, puede utilizar el método deselectRows.

    <igc-grid id="grid" primary-key="ProductID" row-selection="Multiple" auto-generate="true"> </igc-grid> <button id='deselect'>DeSelect</button>
    constructor() { document.getElementById("deselect").addEventListener("click", this.onClickDeselect); } public onClickDeselect() { const grid = document.getElementById("grid") as IgcGridComponent; grid.deselectRows([1,2,5]); }

    Evento de selección de fila

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

    • OldSelection: matriz de ID de fila que contiene el estado anterior de la selección de fila.
    • NewSelection: matriz de ID de fila que coinciden con el nuevo estado de la selección de fila.
    • Added: conjunto de ID de fila que se agregan actualmente a la selección.
    • Removed: conjunto de ID 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.
    <igc-grid id="grid"> </igc-grid>
    constructor() { const grid = document.getElementById('grid') as IgcGridComponent; grid.data = this.data; grid.addEventListener("rowSelectionChanging", this.handleRowSelectionChange); } public handleRowSelectionChange(args) { args.detail.cancel = true; // this will cancel the row selection }

    Seleccionar todas las filas

    Otro método API útil que proporciona IgcGridComponent es selectAllRows. 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. Si llama al método con un parámetro falso, SelectAllRows(false) siempre seleccionará todos los datos en la cuadrícula, incluso si se aplica el filtrado.

    Nota Tenga en cuenta que selectAllRows no seleccionará las filas que se eliminan.

    Anular la selección de todas las filas

    IgcGridComponent proporciona un método deselectAllRows, 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. Si llama al método con un parámetro falso, DeselectAllRows(false) siempre borrará todo el estado de selección de filas incluso si se aplica el filtrado.

    Cómo obtener filas seleccionadas

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

    public getSelectedRows() { const grid = document.getElementById('grid') as IgcGridComponent; const currentSelection = grid.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 = [1, 2, 3]; // an array of row IDs constructor() { const grid = document.getElementById('grid') as IgcGridComponent; grid.data = this.data; grid.selectedRows = this.mySelectedRows; }

    Plantillas de selector de filas

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

    De forma predeterminada, controla IgcGridComponent todas las interacciones de selección de filas en el contenedor principal del selector de filas o en la propia fila, dejando solo la visualización de estado de la plantilla. La invalidación de la funcionalidad base generalmente se debe realizar mediante el evento RowSelectionChanging. En caso de que implemente una plantilla personalizada con un click controlador que invalide la funcionalidad base, debe detener la propagación del evento para conservar el estado de fila correcto.

    Plantilla de fila

    Para crear una plantilla de selector de filas personalizada, dentro de igc-grid puede usar la propiedad rowSelectorTemplate. 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 selected propiedad muestra si la fila actual está seleccionada o no, mientras que la index propiedad se puede usar para acceder al índice de fila.

    public rowSelectorTemplate = (ctx: IgcRowSelectorTemplateContext) => { if (ctx.implicit.selected) { return html`<div style="justify-content: space-evenly;display: flex;width: 70px;"> <span> ${ctx.implicit.index}</span> <igc-checkbox checked></igc-checkbox> </div>`; } else { return html`<div style="justify-content: space-evenly;display: flex;width: 70px;"> <span> ${ctx.implicit.index}</span> <igc-checkbox></igc-checkbox> </div>`; } }

    La rowID propiedad se puede usar para obtener una referencia de una igc-grid fila. Esto es útil cuando se implementa un click controlador en el elemento selector de filas.

    public rowSelectorTemplate = (ctx: IgcRowSelectorTemplateContext) => { return html` <igc-checkbox @click="${(event: any) => { this.onSelectorClick(event, ctx.implicit.key); }}" ></igc-checkbox> `; }

    En el ejemplo anterior estamos usando un IgcCheckboxComponent y nos vinculamos rowContext.selected a su checked propiedad. Vea esto en acción en nuestra demostración de numeración de filas.

    Plantilla de encabezado

    Para crear una plantilla de selector de encabezado personalizada, dentro de IgcGridComponent, puede usar la propiedad headSelectorTemplate. 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 selectedCount propiedad muestra cuántas filas están seleccionadas actualmente, mientras que totalCount muestra cuántas filas hay en IgcGridComponent total.

    public headSelectorTemplate = (ctx: IgcHeadSelectorTemplateContext) => { return html` ${ctx.implicit.selectedCount} / ${ctx.implicit.totalCount} `; };

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

    <igc-grid id="grid" primary-key="ProductID" row-selection="Multiple" auto-generate="true"> </igc-grid>
    constructor() { const grid = document.getElementById('grid') as IgcGridComponent; grid.data = this.data; grid.headSelectorTemplate = this.headSelectorTemplate; } public headSelectorTemplate = (ctx: IgcHeadSelectorTemplateContext) => { const implicit: any = ctx.implicit; if (implicit.selectedCount > 0 && implicit.selectedCount === implicit.totalCount) { return html`<igc-checkbox checked></igc-checkbox>`; } else if (implicit.selectedCount > 0 && implicit.selectedCount !== implicit.totalCount) { return html`<igc-checkbox indeterminate></igc-checkbox>`; } return html`<igc-checkbox></igc-checkbox>`; }

    Demostración de numeración de filas

    Esta demostración muestra el uso de selectores de filas y encabezados personalizados. Este último usa index para mostrar los números de fila y un IgcCheckboxComponent vinculado al selected.

    Demostración de selectores de filas de estilo Excel

    Esta demostración utiliza plantillas personalizadas que se parecen a los selectores de filas y encabezados similares a los de Excel.

    Demostración de selección condicional

    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.

    Referencias de API

    Recursos adicionales

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