Web Components Tree Grid Summaries

The Ignite UI for Web Components Summaries feature in Web Components Tree Grid functions on a per-column level as group footer. Web Components IgcTreeGrid 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 IgcTreeGridComponent.

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

IgcTreeGridComponentLos resúmenes también pueden activarse a nivel de columna en Ignite UI for Web Components, lo que significa que solo puedes activarlo para las columnas que necesites.IgcTreeGridComponent 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.

IgcTreeGridComponentLos 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 laIgcTreeGridComponent 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.

<igc-tree-grid id="grid1" auto-generate="false" height="800px" width="800px">
    <igc-column field="ID" header="Order ID">
    </igc-column>
    <igc-column field="Name" header="Order Product" has-summary="true">
    </igc-column>
    <igc-column field="Units" header="Units" editable="true" data-type="number" has-summary="true">
    </igc-column>
</igc-tree-grid>

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

<igc-tree-grid auto-generate="false" name="treeGrid" id="treeGrid" primary-key="ID">
    <igx-column field="ID" header="Order ID" width="200px">
    </igx-column>
    <igx-column field="Name" header="Order Product" width="200px" [hasSummary]="true">
    </igx-column>
    <igx-column field="Units" width="200px" [editable]="true" [dataType]="'number'" [hasSummary]="true">
    </igx-column>
</igc-tree-grid>
<button id="enableBtn">Enable Summary</button>
<button id="disableBtn">Disable Summary </button>

constructor() {
    var treeGrid = this.treeGrid = document.getElementById('treeGrid') as IgcTreeGrid;
    var enableBtn = this.enableBtn = document.getElementById('enableBtn') as HTMLButtonElement;
    var disableBtn = this.disableBtn = document.getElementById('disableBtn') as HTMLButtonElement;
    treeGrid.data = this.data;
    enableBtn.addEventListener("click", this.enableSummary);
    disableBtn.addEventListener("click", this.disableSummary);
}

public enableSummary() {
    this.treeGrid.enableSummaries([
        {fieldName: 'Name'},
        {fieldName: 'Units'}
    ]);
}
public disableSummary() {
    this.treeGrid.disableSummaries(['Units']);
}

Custom Tree Grid Summaries

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

Para lograr esto tienes que sobrescribir una de las clasesIgcSummaryOperand base,IgcNumberSummaryOperand oIgcDateSummaryOperand según el tipo de dato de columna y tus necesidades. De esta manera puedes redefinir la función existente o añadir nuevas funciones.IgcSummaryOperand Class proporciona la implementación predeterminada solo para elcount método.IgcNumberSummaryOperand extiendeIgcSummaryOperand y proporciona implementación para elMin,Max,Sum yAverage.IgcDateSummaryOperand extiendeIgcSummaryOperand y además teEarliest da y.Latest

import { IgcSummaryResult, IgcSummaryOperand, IgcNumberSummaryOperand, IgcDateSummaryOperand } from 'igniteui-webcomponents-grids';

class MySummary extends IgcNumberSummaryOperand {
    constructor() {
        super();
    }

    operate(data?: any[]): IgcSummaryResult[] {
        const result = super.operate(data);
        result.push({
            key: 'test',
            label: 'Test',
            summaryResult: data.filter(rec => rec > 10 && rec < 30).length
        });
        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 deIgcSummaryResult.

interface IgcSummaryResult {
    key: string;
    label: string;
    summaryResult: any;
}

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 IgcSummaryResult with the proper length even when the data is empty.

And now let's add our custom summary to the column title. We will achieve that by setting the Summaries` property to the class we create below.

<igc-tree-grid auto-generate="false" name="treeGrid" id="treeGrid" primary-key="ID">
    <igc-column field="Name" data-type="string"></igc-column>
    <igc-column field="Age" data-type="number"></igc-column>
    <igc-column field="Title" data-type="string" has-summary="true" id="column1"></igc-column>
</igc-tree-grid>

constructor() {
    var treeGrid = this.treeGrid = document.getElementById('treeGrid') as IgcTreeGrid;
    var column1 = this.column1 = document.getElementById('column1') as IgcColumnComponent;
    treeGrid.data = this.data;
    column1.summaries = this.mySummary;
}

export class TreeGridComponent implements OnInit {
    mySummary = MySummary;
}

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 MySummary extends IgcNumberSummaryOperand {
    constructor() {
        super();
    }
    operate(columnData: any[], allGridData = [], fieldName?): IgcSummaryResult[] {
        const result = super.operate(allData.map(r => r[fieldName]));
        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.

<igc-column id="column" has-summary="true">
</igc-column>

constructor() {
    var column = this.column = document.getElementById('column') as IgcColumnComponent;
    column.summaryTemplate = this.summaryTemplate;
}

public summaryTemplate = (ctx: IgcSummaryTemplateContext) => {
    return html`
        <span> My custom summary template</span>
        <span>${ ctx.implicit[0].label } - ${ ctx.implicit[0].summaryResult }</span>
    `;
}

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 disabled-summaries property provides precise per-column control over the Web Components Tree Grid summary feature. This property enables users to customize the summaries displayed for each column in the IgcTreeGrid, 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 IgcTreeGrid a los cambios en los estados de la aplicación o a las acciones del usuario.

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

<!-- Disable default summaries -->
<igc-column
    field="UnitPrice"
    header="Unit Price"
    data-type="number"
    has-summary="true"
    disabled-summaries="['count', 'sum', 'average']"
>
</igc-column>

<!-- Disable custom summaries -->
<igc-column
    field="UnitsInStock"
    header="Units In Stock"
    data-type="number"
    has-summary="true"
    summaries="discontinuedSummary"
    disabled-summaries="['discontinued', 'totalDiscontinued']"
>
</igc-column>

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 ladisabled-summaries 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.

Formatting summaries

Por defecto, los resultados resumen, producidos por los operandos de resumen integrados, se localizan y formatean según la cuadrículalocale y la columnapipeArgs. Al usar operandos personalizados, loslocale ypipeArgs no se aplican. Si quieres cambiar la apariencia predeterminada de los resultados resumen, puedes formatearlos usando lasummaryFormatter propiedad.

    public dateSummaryFormat(summary: IgcSummaryResult, summaryOperand: IgcSummaryOperand): string {
        const result = summary.summaryResult;
        if (summaryOperand instanceof IgcDateSummaryOperand && summary.key !== "count" && result !== null && result !== undefined) {
            const format = new Intl.DateTimeFormat("en", { year: "numeric" });
            return format.format(new Date(result));
        }
        return result;
    }

<igc-column id="column"></igx-column>

constructor() {
    var column = this.column = document.getElementById('column') as IgcColumnComponent;
    column.summaryFormatter = this.dateSummaryFormat;
}

Child Summaries

The IgcTreeGridComponent 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 IgcTreeGridComponent 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 IgcTreeGridComponent.

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:

<igc-tree-grid class="grid"></igc-tree-grid>

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

Additional Resources

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

Web Components Tree Grid Summaries