Blazor Hierarchical Grid Summaries

    La función Ignite UI for Blazor Summaries en Blazor Hierarchical Grid funciona a nivel de columna como pie de grupo. Los resúmenes Blazor HierarchicalGrid son una característica poderosa que permite al usuario ver la información de la columna en un contenedor separado con un conjunto predefinido de elementos de resumen predeterminados, según el tipo de datos dentro de la columna o mediante la implementación de una plantilla personalizada en IgbHierarchicalGrid.

    Blazor Hierarchical Grid Summaries Overview Example

    EXAMPLE
    MODULES
    DATA
    RAZOR
    CSS

    Like this sample? Get access to our complete Ignite UI for Blazor toolkit and start building your own apps in minutes. Download it for free.

    The summary of the column is a function of all column values, unless filtering is applied, then the summary of the column will be function of the filtered result values

    Los resúmenes IgbHierarchicalGrid también se pueden habilitar a nivel de columna en Ignite UI for Blazor, lo que significa que puede activarlos solo para las columnas que necesite. Los resúmenes IgbHierarchicalGrid le brindan un conjunto predefinido de resúmenes predeterminados, según el tipo de datos en la columna, para que pueda ahorrar algo de tiempo:

    Para string y boolean DataType, está disponible la siguiente función:

    • Contar

    Para los tipos de datos number, currency y percent, están disponibles las siguientes funciones:

    • Contar
    • mín.
    • máx.
    • Promedio
    • Suma

    Para el tipo de datos date, están disponibles las siguientes funciones:

    • Contar
    • Más temprano
    • El último

    Todos los tipos de datos de columna disponibles se pueden encontrar en el tema oficial Tipos de columna.

    IgbHierarchicalGrid Los resúmenes se habilitan por columna estableciendo HasSummary property en true. También es importante tener en cuenta que los resúmenes de cada columna se resuelven según el tipo de datos de columna. En la columna predeterminada, el IgbHierarchicalGrid tipo de datos es string, por lo que si desea date​ ​number resúmenes específicos, debe especificar la DataType propiedad como number or date. Tenga en cuenta que los valores de resumen se mostrarán localizados, de acuerdo con la cuadrícula Locale y la columna PipeArgs.

    <IgbHierarchicalGrid AutoGenerate="false" Data="SingersData" Name="hierarchicalGrid" @ref="hierarchicalGrid" Id="hierarchicalGrid" PrimaryKey="ID">
            <IgbColumn Field="Artist" HasSummary="true"></IgbColumn>
            <IgbColumn Field="Photo" DataType="GridColumnDataType.Image"></IgbColumn>
            <IgbColumn Field="Debut" HasSummary="true"></IgbColumn>
            <IgbColumn Field="GrammyNominations" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
            <IgbColumn Field="GrammyAwards" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
            <IgbRowIsland ChildDataKey="Albums" AutoGenerate="false">
                <IgbColumn Field="Album" DataType="GridColumnDataType.String"></IgbColumn>
                <IgbColumn Field="LaunchDate" DataType="GridColumnDataType.Date"></IgbColumn>
                <IgbColumn Field="BillboardReview" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
                <IgbColumn Field="USBillboard200" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
            </IgbRowIsland>
    </IgbHierarchicalGrid>
    razor

    La otra forma de habilitar/deshabilitar resúmenes para una columna específica o una lista de columnas es usar el método EnableSummaries public/ DisableSummaries de la IgbHierarchicalGrid.

    <IgbHierarchicalGrid AutoGenerate="false" Data="SingersData" Name="hierarchicalGrid" @ref="hierarchicalGrid" Id="hierarchicalGrid" PrimaryKey="ID">
        <IgbColumn Field="Artist" HasSummary="true"></IgbColumn>
        <IgbColumn Field="Photo" DataType="GridColumnDataType.Image"></IgbColumn>
        <IgbColumn Field="Debut" HasSummary="true"></IgbColumn>
        <IgbColumn Field="GrammyNominations" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
        <IgbColumn Field="GrammyAwards" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
    </IgbHierarchicalGrid>
    
    @code {
        public async void DisableSummaries()
        {
            object[] disabledSummaries = { "GrammyNominations" };
            await this.hierarchicalGrid.DisableSummariesAsync(disabledSummaries);
        }
    }
    razor

    Custom Hierarchical Grid Summaries

    Si estas funciones no cumplen con sus requisitos, puede proporcionar un resumen personalizado para las columnas específicas.

    
    //In JavaScript
    class WebGridDiscontinuedSummary {
        operate(data, allData, fieldName) {
            const discontinuedData = allData.filter((rec) => rec['Discontinued']).map(r => r[fieldName]);
            const result = [];
            result.push({
                key: 'products',
                label: 'Products',
                summaryResult: data.length
            });
            result.push({
                key: 'total',
                label: 'Total Items',
                summaryResult: data.length ? data.reduce((a, b) => +a + +b) : 0
            });
            result.push({
                key: 'discontinued',
                label: 'Discontinued Products',
                summaryResult: allData.map(r => r['Discontinued']).filter((rec) => rec).length
            });
            result.push({
                key: 'totalDiscontinued',
                label: 'Total Discontinued Items',
                summaryResult: discontinuedData.length ? discontinuedData.reduce((a, b) => +a + +b) : 0
            });
            return result;
        }
    }
    razor

    Como se ve en los ejemplos, las clases base exponen el método Operate, por lo que puede elegir obtener todos los resúmenes predeterminados y modificar el resultado, o calcular resultados resumidos completamente nuevos.

    El método devuelve una lista de IgbSummaryResult.

    y tomar parámetros opcionales para calcular los resúmenes. Consulte Resúmenes personalizados, que acceden a toda la sección de datos a continuación.

    In order to calculate the summary row height properly, the Hierarchical Grid needs the Operate method to always return an array of IgbSummaryResult with the proper length even when the data is empty.

    <IgbHierarchicalGrid 
            AutoGenerate="true"
            Name="hierarchicalGrid"
            @ref="hierarchicalGrid"
            Data="SingersData"
            PrimaryKey="ID"
            ColumnInitScript="WebHierarchicalGridCustomSummary">
    </IgbHierarchicalGrid>
    
    // In Javascript
    igRegisterScript("WebHierarchicalGridCustomSummary", (event) => {
        if (event.detail.field === "GrammyAwards") {
            event.detail.summaries = WebHierarchicalGridSummary;
        }
    }, false);
    razor

    Custom summaries, which access all data

    Ahora puede acceder a todos los datos de la cuadrícula jerárquica dentro del resumen de columna personalizado. Se introducen dos parámetros opcionales adicionales en el método SummaryOperand Operate. Como puede ver en el fragmento de código a continuación, el método operate tiene los siguientes tres parámetros:

    • columnData: le proporciona una matriz que contiene los valores solo para la columna actual
    • allGridData: le brinda toda la fuente de datos de la cuadrícula
    • fieldName - campo de columna actual
    class WebGridDiscontinuedSummary {
        operate(data, allData, fieldName) {
            const discontinuedData = allData.filter((rec) => rec['Discontinued']).map(r => r[fieldName]);
            result.push({
                key: 'totalDiscontinued',
                label: 'Total Discontinued Items',
                summaryResult: discontinuedData.length ? discontinuedData.reduce((a, b) => +a + +b) : 0
            });
            return result;
        }
    }
    razor

    EXAMPLE
    MODULES
    DATA
    RAZOR
    CSS

    Summary Template

    Summary apunta al resumen de la columna proporcionando como contexto los resultados del resumen de la columna.

    <IgbColumn HasSummary="true" SummaryTemplateScript="SummaryTemplate">
    </IgbColumn>
    
    igRegisterScript("SummaryTemplate", (ctx) => {
        var html = window.igTemplating.html;
        return html`<div>
        <span> ${ctx.implicit[0].label} - ${ctx.implicit[0].summaryResult} </span>
    </div>`
    }, false);
    razor

    Cuando se define un resumen predeterminado, la altura del área de resumen se calcula por diseño en función de la columna con el mayor número de resúmenes y la--ig-size de la cuadrícula. Utilice la SummaryRowHeight propiedad input para invalidar el valor predeterminado. Como argumento, espera un valor numérico, y establecer un valor falso desencadenará el comportamiento de tamaño predeterminado del pie de página de la cuadrícula.

    EXAMPLE
    MODULES
    DATA
    RAZOR
    JS
    CSS

    Keyboard Navigation

    Se puede navegar por las filas de resumen con las siguientes interacciones de teclado:

    • ARRIBA: navega una celda hacia arriba.
    • ABAJO: navega una celda hacia abajo.
    • IZQUIERDA: navega una celda hacia la izquierda.
    • DERECHA: navega una celda hacia la derecha.
    • CTRL + IZQUIERDA o INICIO: navega a la celda más a la izquierda.
    • CTRL + DERECHA o FINAL: navega a la celda más a la derecha.

    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:

    <IgbHierarchicalGrid id="hierarchicalGrid"></IgbHierarchicalGrid>
    razor

    Luego configure las propiedades CSS relacionadas para esa clase:

    #hierarchicalGrid {
        --ig-grid-summary-background-color:#e0f3ff;
        --ig-grid-summary-focus-background-color: rgba( #94d1f7, .3 );
        --ig-grid-summary-label-color: rgb(228, 27, 117);
        --ig-grid-summary-result-color: black;
    }
    css

    Demo

    EXAMPLE
    MODULES
    DATA
    RAZOR
    CSS

    API References

    Additional Resources

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