Blazor Tree Grid Summaries

The Ignite UI for Blazor Summaries feature in Blazor Tree Grid functions on a per-column level as group footer. Blazor TreeGrid summaries is powerful feature which enables the user to see column information in a separate container with a predefined set of default summary items, depending on the type of data within the column or by implementing a custom template in the IgbTreeGrid.

Blazor Tree Grid Summaries Overview Example

[!Note] 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

IgbTreeGridLos resúmenes también pueden activarse a nivel de columna en Ignite UI for Blazor, lo que significa que solo puedes activarlo para las columnas que necesites.IgbTreeGrid Resumen te ofrece un conjunto predefinido de resúmenes por defecto, dependiendo del tipo de datos en la columna, para que puedas ahorrar tiempo:

Parastring yboolean DataType está disponible la siguiente función:

Contar

Paranumber ycurrencypercent tipos de datos, están disponibles las siguientes funciones:

Contar
mín.
máx.
Promedio
Suma

Para eldate tipo de dato, 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.

IgbTreeGridLos resúmenes se activan por columna estableciendoHasSummary la propiedad en True. También es importante tener en cuenta que los resúmenes de cada columna se resuelven según el tipo de dato de columna. En laIgbTreeGrid columna predeterminada el tipo de dato esstring, así que si quieresnumber resúmenesdate específicos deberías especificar laDataType propiedad comonumber odate. Ten en cuenta que los valores resumen se mostrarán localizados, según la cuadrículaLocale y la columnaPipeArgs.

<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>

La otra forma de activar/desactivar resúmenes para una columna específica o una lista de columnas es usar el métodoEnableSummaries público/DisableSummaries of.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);
    }
}

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;
    }
}

Como se ve en los ejemplos, las clases base exponen elOperate método, así que puedes elegir obtener todos los resúmenes por defecto y modificar el resultado, o calcular resultados de resumen completamente nuevos.

El método devuelve una lista deIgbSummaryResult.

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.

[!Note] 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);

Custom summaries, which access all data

Now you can access all Tree Grid data inside the custom column summary. Two additional optional parameters are introduced in the SummaryOperand Operate method. As you can see in the code snippet below the operate method has the following three parameters:

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;
    }
}

Summary Template

SummaryTemplateApunta al resumen de columnas proporcionando como contexto los resultados del resumen de 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);

Cuando se define un resumen por defecto, la altura del área del resumen se calcula por diseño dependiendo de la columna con el mayor número de resúmenes y de la--ig-size cuadrícula. Usa laSummaryRowHeight propiedad de entrada para anular el valor por defecto. Como argumento, espera un valor numérico, y establecer un valor falso activará el comportamiento de dimensionamiento por defecto del pie de página de la cuadrícula.

Disabled Summaries

The DisabledSummaries property provides precise per-column control over the Blazor Tree Grid summary feature. This property enables users to customize the summaries displayed for each column in the TreeGrid, ensuring that only the most relevant and meaningful data is shown. For example, you can exclude specific summary types, such as ['count', 'min', 'max'] by specifying their summary keys in an array.

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.

The following examples illustrate how to use the DisabledSummaries property to manage summaries for different columns and exclude specific default and custom summary types in the Blazor Tree Grid:

<!-- 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']" />

PorqueUnitPrice, los resúmenes por defecto comocount,sum, yaverage están deshabilitados, dejando a otros comomin ymax activos.

ParaUnitsInStock esto, los resúmenes personalizados comodiscontinued ytotalDiscontinued se excluyen usando laDisabledSummaries propiedad.

En tiempo de ejecución, los resúmenes también pueden desactivarse dinámicamente usando estaDisabledSummaries propiedad. Por ejemplo, puedes establecer o actualizar la propiedad en columnas específicas de forma programática para adaptar los resúmenes mostrados según acciones del usuario o cambios en el estado de la aplicación.

Child Summaries

The IgbTreeGrid supports separate summaries for the root nodes and for each nested child node level. Which summaries are shown is configurable using the SummaryCalculationMode property. The child level summaries can be shown before or after the child nodes using the SummaryPosition property. Along with these two properties the IgbTreeGrid exposes and ShowSummaryOnCollapse property which allows you to determine whether the summary row stays visible when the parent node that refers to is collapsed.

Los valores disponibles de laSummaryCalculationMode propiedad son:

RootLevelOnly - Summaries are calculated only for the root level nodes.
ChildLevelsOnly- Los resúmenes se calculan solo para los niveles hijos.
RootAndChildLevels- Los resúmenes se calculan tanto para el nivel raíz como para el hijo de la empresa. Este es el valor por defecto.

Los valores disponibles de laSummaryPosition propiedad son:

Top - The summary row appears before the list of child rows.
Bottom - The summary row appears after the list of child rows. This is the default value.

The ShowSummaryOnCollapse property is boolean. Its default value is set to false, which means that the summary row would be hidden when the parent row is collapsed. If the property is set to true the summary row stays visible when parent row is collapsed.

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

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>

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;
}

Demo

API References

SummaryOperand
NumberSummaryOperand
DateSummaryOperand
IgbColumnGroup
IgbColumn

Additional Resources

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

Blazor Tree Grid Summaries