Blazor Tree Grid Summaries

    La función Ignite UI for Blazor Summaries en Blazor Tree Grid funciona a nivel de columna como pie de grupo. Los resúmenes Blazor TreeGrid 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 IgbTreeGrid.

    Blazor Tree Grid Summaries Overview Example

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    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 IgbTreeGrid 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 IgbTreeGrid 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.

    IgbTreeGrid Los resúmenes se habilitan por columna configurando HasSummary propiedad a verdadero. 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 IgbTreeGrid El tipo de datos de columna predeterminado es string, así que si quieres number o date resúmenes específicos, debe especificar el DataType propiedad como number o date. Tenga en cuenta que los valores de resumen se mostrarán localizados, de acuerdo con la cuadrícula Locale y columna PipeArgs.

    <IgbTreeGrid>
            <IgbColumn Field="ID" Header="Order ID"></IgbColumn>
            <IgbColumn Field="Name" Header="Order Product" HasSummary="true"></IgbColumn>
            <IgbColumn Field="Units" Header="Units" HasSummary="true"></IgbColumn>
    </IgbTreeGrid>
    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 IgbTreeGrid.

    <IgbTreeGrid AutoGenerate="false" Data="OrdersTreeData" Name="treeGrid" @ref="treeGridRef" Id="treeGrid" PrimaryKey="ID">
        <IgbColumn Field="ID" Header="Order ID"></IgbColumn>
        <IgbColumn Field="Name" Header="Order Product" HasSummary="true"></IgbColumn>
        <IgbColumn Field="Units" Header="Units" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
    </IgbTreeGrid>
    
    @code {
        public async void DisableSummaries()
        {
            object[] disabledSummaries = { "Units" };
            await this.treeGrid.DisableSummariesAsync(disabledSummaries);
        }
    }
    razor

    Custom Tree Grid Summaries

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

    
    //In JavaScript
    class PtoSummary {
        operate(data, allData, fieldName) {
            const result = [];
            result.push({
                key: 'totalOnPTO',
                label: 'Employees On PTO',
                summaryResult: this.count(allData.filter((rec) => rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'devs',
                label: 'Developers',
                summaryResult: this.count(allData.filter((rec) => rec[fieldName].includes('Developer') && rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'tl',
                label: 'Team Leads',
                summaryResult: this.count(allData.filter((rec) => rec[fieldName].includes('Team Lead') && rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'managers',
                label: 'Managers/Directors',
                summaryResult: this.count(allData.filter((rec) => (rec[fieldName].includes('Manager') || rec[fieldName].includes('Director')) && rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'ceo',
                label: 'CEO/President',
                summaryResult: this.count(allData.filter((rec) => (rec[fieldName].includes('CEO') || rec[fieldName].includes('President')) && rec['OnPTO']).map(r => r[fieldName]))
            });
            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 Tree Grid needs the Operate method to always return an array of IgbSummaryResult with the proper length even when the data is empty.

    <IgbTreeGrid 
            AutoGenerate="true"
            Name="treeGrid"
            @ref="treeGrid"
            Data="EmployeesFlatData"
            PrimaryKey="ID"
            ColumnInitScript="WebTreeGridCustomSummary">
    </IgbTreeGrid>
    
    // In Javascript
    igRegisterScript("WebTreeGridCustomSummary", (event) => {
        if (event.detail.field === "Title") {
            event.detail.summaries = PtoSummary;
        }
    }, false);
    razor

    Custom summaries, which access all data

    Ahora puede acceder a todos los datos de la cuadrícula de árbol 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 PtoSummary {
        operate(data, allData, fieldName) {
            const result = [];
            result.push({
                key: 'totalOnPTO',
                label: 'Employees On PTO',
                summaryResult: this.count(allData.filter((rec) => rec['OnPTO']).map(r => r[fieldName]))
            });
            return result;
        }
    }
    razor

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    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
    DATA
    MODULES
    RAZOR
    JS
    CSS

    Disabled Summaries

    La DisabledSummaries propiedad proporciona un control preciso por columna sobre la característica de resumen de cuadrícula de árbol de Blazor. Esta propiedad permite a los usuarios personalizar los resúmenes que se muestran para cada columna de TreeGrid, lo que garantiza que solo se muestren los datos más relevantes y significativos. Por ejemplo, puede excluir tipos de resumen específicos, por ejemplo ['count', 'min', 'max'], especificando sus claves de resumen en una matriz.

    Esta propiedad también se puede modificar dinámicamente en tiempo de ejecución a través del código, lo que proporciona flexibilidad para adaptar los resúmenes de TreeGrid a los cambios en los estados de la aplicación o a las acciones del usuario.

    En los ejemplos siguientes se muestra cómo utilizar la DisabledSummaries propiedad para administrar resúmenes de diferentes columnas y excluir tipos de resumen predeterminados y personalizados específicos en la cuadrícula de árbol de Blazor:

    <!-- Disable default summaries -->
    <IgbColumn 
        Field="UnitPrice" 
        Header="Unit Price" 
        DataType="GridColumnDataType.Number"
        HasSummary="true" 
        DisabledSummaries="['count', 'sum', 'average']" />
    
    <!-- Disable custom summaries -->
    <IgbColumn 
        Field="UnitsInStock" 
        Header="Units In Stock" 
        DataType="GridColumnDataType.Number"
        HasSummary="true" 
        Summaries="discontinuedSummary" 
        DisabledSummaries="['discontinued', 'totalDiscontinued']" />
    razor

    Para UnitPrice, los resúmenes predeterminados como count, sum, y average están deshabilitados, dejando otros como y min​ ​max activos.

    En el caso UnitsInStock de los resúmenes personalizados, como discontinued y totalDiscontinued se excluyen mediante la DisabledSummaries propiedad.

    En tiempo de ejecución, los resúmenes también se pueden deshabilitar dinámicamente mediante la DisabledSummaries propiedad. Por ejemplo, puede establecer o actualizar la propiedad en columnas específicas mediante programación para adaptar los resúmenes mostrados en función de las acciones del usuario o los cambios de estado de la aplicación.

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    CSS

    Child Summaries

    Admite IgbTreeGrid resúmenes independientes para los nodos raíz y para cada nivel de nodo secundario anidado. Los resúmenes que se muestran se pueden configurar mediante la SummaryCalculationMode propiedad. Los resúmenes de nivel secundario se pueden mostrar antes o después de los nodos secundarios que utilizan la SummaryPosition propiedad. Junto con estas dos propiedades, la propiedad exposes y ShowSummaryOnCollapse que le permite determinar si la IgbTreeGrid fila de resumen permanece visible cuando se contrae el nodo primario al que se hace referencia.

    Los valores disponibles de la propiedad SummaryCalculationMode son:

    • RootLevelOnly- Los resúmenes se calculan solo para los nodos de nivel raíz.
    • ChildLevelsOnly: los resúmenes se calculan solo para los niveles secundarios.
    • RootAndChildLevels: los resúmenes se calculan tanto para el nivel raíz como para el nivel secundario. Este es el valor predeterminado.

    Los valores disponibles de la propiedad SummaryPosition son:

    • Top- La fila de resumen aparece antes de la lista de filas secundarias.
    • Bottom- La fila de resumen aparece después de la lista de filas secundarias. Este es el valor predeterminado.

    La ShowSummaryOnCollapse propiedad es booleana. Su valor predeterminado se establece en false, lo que significa que la fila de resumen se ocultará cuando se contraiga la fila principal. Si la propiedad se establece en true, la fila de resumen permanece visible cuando se contrae la fila principal.

    The SummaryPosition property applies only for the child level summaries. The root level summaries appear always fixed at the bottom of the IgbTreeGrid.

    EXAMPLE
    DATA
    MODULES
    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:

    <IgbTreeGrid class="grid"></IgbTreeGrid>
    razor

    Luego configure las propiedades CSS relacionadas para esa clase:

    .grid {
        --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
    DATA
    MODULES
    RAZOR
    JS
    CSS

    API References

    Additional Resources

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