Web Components Tree Grid Summaries

La función Resúmenes de Ignite UI for Web Components en Web Components cuadrícula de árbol funciona a nivel de columna como pie de página de grupo. Web Components resúmenes de IgcTreeGrid es 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 el 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

IgcTreeGridComponent Los resúmenes también se pueden habilitar en un nivel por columna en Ignite UI for Web Components, lo que significa que puede activarlo solo para las columnas que necesite. IgcTreeGridComponent Resúmenes le proporciona un conjunto predefinido de resúmenes predeterminados, según el tipo de datos de 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.

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

<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 habilitar/deshabilitar resúmenes para una columna específica o una lista de columnas es usar el método enableSummaries public / disableSummaries de la 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, debe anular una de las clases base IgcSummaryOperand, IgcNumberSummaryOperand o IgcDateSummaryOperand según el tipo de datos de la columna y sus necesidades. De esta manera puede redefinir la función existente o puede agregar nuevas funciones. La clase IgcSummaryOperand proporciona la implementación predeterminada solo para el método count. IgcNumberSummaryOperand extiende IgcSummaryOperand y proporciona implementación para Min, Max, Sum y Average. IgcDateSummaryOperand amplía IgcSummaryOperand y, además, le ofrece las versiones Earliest 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 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 IgcSummaryResult.

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 agreguemos nuestro resumen personalizado a la columna title. Lo lograremos estableciendo la propiedad Summaries' en 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 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 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

Summary apunta al resumen de la columna proporcionando como contexto los resultados del resumen de la 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 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.

Formatting summaries

De forma predeterminada, los resultados de resumen, producidos por los operandos de resumen integrados, se localizan y formatean de acuerdo con la locale de la cuadrícula y la columna pipeArgs. Cuando se utilizan operandos personalizados, la locale y pipeArgs no se aplican. Si desea cambiar la apariencia predeterminada de los resultados del resumen, puede formatearlos usando la propiedad summaryFormatter.

    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

Admite IgcTreeGridComponent 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 IgcTreeGridComponent 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 propiedad showSummaryOnCollapse es booleana. Su valor predeterminado está establecido en false, lo que significa que la fila de resumen se ocultará cuando se contraiga la fila principal. Si la propiedad se establece en verdadero, la fila de resumen permanece visible cuando se contrae la fila principal.

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