Web Components Tree Grid Summaries

La función Ignite UI for Web Components Resúmenes en Web Components Tree Grid funciona a nivel de columna como un pie de página de grupo. Web Components resúmenes de IgcTreeGrid es una función 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, dependiendo del tipo de datos dentro de la columna o mediante la implementación de una plantilla personalizada en laIgcTreeGridComponent.

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.

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

<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

Ahora puedes acceder a todos los datos de la Cuadrícula de Árbol dentro del resumen de columnas personalizadas. Se introducen dos parámetros opcionales adicionales en el método SummaryOperandoperate. Como puedes ver en el fragmento de código de abajo, el método de operación 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 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

Ladisabled-summaries propiedad proporciona un control preciso por columna sobre la función resumen de la cuadrícula de árbol Web Components. Esta propiedad permite a los usuarios personalizar los resúmenes mostrados para cada columna en el IgcTreeGrid, asegurando que solo se muestren los datos más relevantes y significativos. Por ejemplo, puedes excluir tipos específicos de resumen, como ['count', 'min', 'max'] especificando sus claves de resumen en un 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.

Los siguientes ejemplos ilustran cómo usar ladisabled-summaries propiedad para gestionar resúmenes de diferentes columnas y excluir tipos específicos de resúmenes predeterminados y personalizados en la cuadrícula de árbol Web Components:

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

SoportaIgcTreeGridComponent resúmenes separados para los nodos raíz y para cada nivel de nodo hijo anidado. Qué resúmenes se muestran es configurable usando lasummaryCalculationMode propiedad. Los resúmenes a nivel hijo pueden mostrarse antes o después de los nodos hijos usando lasummaryPosition propiedad. Junto con estas dos propiedades, losIgcTreeGridComponent exposes yshowSummaryOnCollapse la propiedad que permite determinar si la fila resumen permanece visible cuando el nodo padre al que se refiere está colapsado.

Los valores disponibles de lasummaryCalculationMode propiedad son:

RootLevelOnly- Los resúmenes se calculan solo para los nodos a nivel raíz.
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- La fila resumen aparece antes de la lista de filas hijas.
Bottom- La fila resumen aparece después de la lista de filas hijas. Este es el valor por defecto.

LashowSummaryOnCollapse propiedad es booleana. Su valor por defecto está configurado como falso, lo que significa que la fila resumen quedaría oculta cuando la fila padre se colapsa. Si la propiedad está configurada como verdadera, la fila resumen permanece visible cuando la fila madre se colapsa.

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