Web Components Resúmenes de cuadrícula

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

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

IgcGridComponentLos 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.IgcGridComponent 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 ycurrency​percent 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.

IgcGridComponentLos 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 laIgcGridComponent 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-grid id="grid1" auto-generate="false" height="800px" width="800px">
    <igc-column field="ProductID" header="Product ID" width="200px"  sortable="true">
    </igc-column>
    <igc-column field="ProductName" header="Product Name" width="200px" sortable="true" has-summary="true">
    </igc-column>
    <igc-column field="ReorderLevel" width="200px" editable="true" data-type="number" has-summary="true">
    </igc-column>
</igc-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.IgcGridComponent​

<igc-grid id="grid" auto-generate="false" height="800px" width="800px">
    <igc-column field="ProductID" header="Product ID" width="200px" sortable="true">
    </igc-column>
    <igc-column field="ProductName" header="Product Name" width="200px" sortable="true" has-summary="true">
    </igc-column>
    <igc-column field="ReorderLevel" width="200px" editable="true" data-type="number" has-summary="false">
    </igc-column>
</igc-grid>
<button id="enableBtn">Enable Summary</button>
<button id="disableBtn">Disable Summary </button>

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

public enableSummary() {
    this.grid.enableSummaries([
        {fieldName: 'ReorderLevel'},
        {fieldName: 'ProductID'}
    ]);
}
public disableSummary() {
    this.grid.disableSummaries(['ProductID']);
}

Custom 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 Grid needs the operate method to always return an array of IgcSummaryResult with the proper length even when the data is empty.

Y ahora vamos a añadir nuestro resumen personalizado a la columnaUnitsInStock. Lo lograremos estableciendo la propiedad de Summaries a la clase que creamos a continuación.

<igc-grid id="grid1" auto-generate="false" height="800px" width="800px">
    <igc-column field="ProductID" width="200px" sortable="true">
    </igc-column>
    <igc-column field="ProductName" width="200px" sortable="true" has-summary="true">
    </igc-column>
    <igc-column id="unitsInStock" field="UnitsInStock" width="200px" data-type="number" has-summary="true" sortable="true">
    </igc-column>
    <igc-column field="ReorderLevel" width="200px" editable="true" data-type="number" has-summary="true">
    </igc-column>
</igc-grid>

constructor() {
    var grid1 = this.grid1 = document.getElementById('grid1') as IgcGridComponent;
    var unitsInStock = this.unitsInStock = document.getElementById('unitsInStock') as IgcColumnComponent;
    grid1.data = this.data;
    unitsInStock.summaries = this.mySummary;
}

export class GridComponent implements OnInit {
    mySummary = MySummary;
}

Custom summaries, which access all data

Now you can access all 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: 'test', label: 'Total Discontinued', summaryResult: allData.filter((rec) => rec.Discontinued).length });
        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 Grid summary feature. This property enables users to customize the summaries displayed for each column in the IgcGrid, 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 IgcGrid 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 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;
}

Summaries with Group By

When you have grouped by columns, the IgcGridComponent allows you to change the summary position and calculation mode using the summaryCalculationMode and summaryPosition properties. Along with these two properties the IgcGridComponent exposes and showSummaryOnCollapse property which allows you to determine whether the summary row stays visible when the group row that refers to is collapsed.

The available values of the summaryCalculationMode property are:

• RootLevelOnly - Summaries are calculated only for the root level.
• ChildLevelsOnly - Summaries are calculated only for the child levels.
• RootAndChildLevels - Summaries are calculated for both root and child levels. This is the default value.

The available values of the summaryPosition property are:

• Top - The summary row appears before the group by row children.
• Bottom - The summary row appears after the group by row children. 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 group row is collapsed. If the property is set to true the summary row stays visible when group 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 IgcGridComponent.

Demo

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:

<igc-grid class="grid"></igc-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

• IgcSummaryOperand
• IgcNumberSummaryOperand
• IgcDateSummaryOperand
• columnGroup
• IgcColumnComponent

Additional Resources

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

• Ignite UI for Web Components Foros
• Ignite UI for Web Components GitHub