Resúmenes de cuadrícula Angular

La cuadrícula Angular UI en Ignite UI for Angular tiene una función de resúmenes que funciona a nivel de columna como pie de página de grupo. Los resúmenes de cuadrícula Angular son una característica poderosa que permite al usuario ver 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 implementando una plantilla angular personalizada en la cuadrícula.

Angular Grid Summaries Overview Example

Note

El resumen de la columna es una función de todos los valores de la columna; a menos que se aplique un filtrado, el resumen de la columna será función de los valores de los resultados filtrados.

Los resúmenes de cuadrícula también se pueden habilitar a nivel de columna en Ignite UI for Angular, lo que significa que puede activarlos solo para las columnas que necesite. Los resúmenes de cuadrícula le brindan 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 data types, 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áximo
• 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.

Los resúmenes de cuadrícula se habilitan por columna estableciendo la propiedad hasSummary en true. También es importante tener en cuenta que los resúmenes de cada columna se resuelven según el tipo de datos de la columna. En igx-grid el tipo de datos de columna predeterminado es string, por lo que si desea resúmenes específicos number o date, debe especificar la propiedad dataType como number o date. Tenga en cuenta que los valores de resumen se mostrarán localizados, según la locale de la cuadrícula y la columna pipeArgs.

<igx-grid #grid1 [data]="data" [autoGenerate]="false" height="800px" width="800px" (columnInit)="initColumn($event)">
    <igx-column field="ProductID" header="Product ID" width="200px" [sortable]="true"></igx-column>
    <igx-column field="ProductName" header="Product Name" width="200px" [sortable]="true" [hasSummary]="true"></igx-column>
    <igx-column field="ReorderLevel" width="200px" [editable]="true" [dataType]="'number'" [hasSummary]="true"></igx-column>
</igx-grid>

La otra forma de habilitar/deshabilitar resúmenes para una columna específica o una lista de columnas es usar el método público enableSummaries / disableSummaries del igx-grid.

<igx-grid #grid1 [data]="data" [autoGenerate]="false" height="800px" width="800px" (columnInit)="initColumn($event)" >
    <igx-column field="ProductID" header="Product ID" width="200px"  [sortable]="true"></igx-column>
    <igx-column field="ProductName" header="Product Name" width="200px" [sortable]="true" [hasSummary]="true"></igx-column>
    <igx-column field="ReorderLevel" width="200px" [editable]="true" [dataType]="'number'" [hasSummary]="false"></igx-column>
</igx-grid>
<button (click)="enableSummary()">Enable Summary</button>
<button (click)="disableSummary()">Disable Summary </button>

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

Custom 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 IgxSummaryOperand, IgxNumberSummaryOperand o IgxDateSummaryOperand 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 IgxSummaryOperand proporciona la implementación predeterminada solo para el método count. IgxNumberSummaryOperand extiende IgxSummaryOperand y proporciona implementación para min, max, sum y average. IgxDateSummaryOperand amplía IgxSummaryOperand y, además, le ofrece las versiones earliest y latest.

import { IgxSummaryResult, IgxSummaryOperand, IgxNumberSummaryOperand, IgxDateSummaryOperand } from 'igniteui-angular';
// import { IgxSummaryResult, IgxSummaryOperand, IgxNumberSummaryOperand, IgxDateSummaryOperand } from '@infragistics/igniteui-angular'; for licensed package

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

    operate(data?: any[]): IgxSummaryResult[] {
        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 IgxSummaryResult.

interface IgxSummaryResult {
    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

Para calcular correctamente la altura de la fila de resumen, Grid necesita que el método operate devuelva siempre una matriz de IgxSummaryResult con la longitud adecuada incluso cuando los datos están vacíos.

Y ahora agreguemos nuestro resumen personalizado a la columna UnitsInStock. Lo lograremos estableciendo la propiedad summaries en la clase que creamos a continuación.

<igx-grid #grid1 [data]="data" [autoGenerate]="false" height="800px" width="800px" (columnInit)="initColumn($event)" >
    <igx-column field="ProductID" width="200px"  [sortable]="true">
    </igx-column>
    <igx-column field="ProductName" width="200px" [sortable]="true" [hasSummary]="true">
    </igx-column>
    <igx-column field="UnitsInStock" width="200px" [dataType]="'number'" [hasSummary]="true" [summaries]="mySummary" [sortable]="true">
    </igx-column>
    <igx-column field="ReorderLevel" width="200px" [editable]="true" [dataType]="'number'" [hasSummary]="true">
    </igx-column>
</igx-grid>

...
export class GridComponent implements OnInit {
    mySummary = MySummary;
    ....
}

Custom summaries, which access all data

Ahora puede acceder a todos los datos de la cuadrícula dentro del resumen de la columna personalizada. Se introducen dos parámetros opcionales adicionales en el método operate IgxSummaryOperand. Como puede ver en el fragmento de código a continuación, 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 IgxNumberSummaryOperand {
    constructor() {
        super();
    }
    operate(columnData: any[], allGridData = [], fieldName?): IgxSummaryResult[] {
        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

igxSummary apunta al resumen de la columna proporcionando como contexto los resultados del resumen de la columna.

<igx-column ... [hasSummary]="true">
    <ng-template igxSummary let-summaryResults>
        <span> My custom summary template</span>
        <span>{{ summaryResults[0].label }} - {{ summaryResults[0].summaryResult }}</span>
    </ng-template>
</igx-column>

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 el tamaño de la cuadrícula. Use la propiedad de entrada summaryRowHeight para invalidar el valor predeterminado. Como argumento, espera un valor numérico, y establecer un valor falso activará el comportamiento de tamaño predeterminado del pie de página de la cuadrícula.

Note

La plantilla de resumen de columna se puede definir a través de API estableciendo la propiedad SummaryTemplate de la columna en el TemplateRef requerido.

Formatting summaries

De forma predeterminada, los resultados de resumen, producidos por los operandos de resumen integrados, se localizan y se formatean según 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: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string {
    const result = summary.summaryResult;
    if(summaryOperand instanceof IgxDateSummaryOperand && summary.key !== 'count'
        && result !== null && result !== undefined) {
        const pipe = new DatePipe('en-US');
        return pipe.transform(result,'MMM YYYY');
    }
    return result;
}

<igx-column ... [summaryFormatter]="dateSummaryFormat"></igx-column>

Summaries with Group By

Cuando haya agrupado por columnas, Grid le permite cambiar la posición del resumen y el modo de cálculo utilizando las propiedades summaryCalculationMode y summaryPosition. Junto con estas dos propiedades, IgxGrid expone la propiedad showSummaryOnCollapse que le permite determinar si la fila de resumen permanece visible cuando la fila del grupo al que hace referencia está colapsada.

Los valores disponibles de la propiedad summaryCalculationMode son:

• rootLevelOnly: los resúmenes se calculan solo para el 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:

• arriba: la fila de resumen aparece antes del grupo por fila secundaria.
• abajo: la fila de resumen aparece después del grupo por fila secundaria. 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 del grupo. Si la propiedad se establece en verdadero, la fila de resumen permanece visible cuando se contrae la fila del grupo.

Note

La propiedad summaryPosition se aplica solo a los resúmenes de nivel secundario. Los resúmenes de nivel raíz aparecen siempre fijos en la parte inferior del Grid.

Demo

Exporting Summaries

Existe una opción exportSummaries en IgxExcelExporterOptions que especifica si los datos exportados deben incluir los resúmenes del grid. El valor predeterminado exportSummaries es falso.

​IgxExcelExporterService exportará los resúmenes predeterminados para todos los tipos de columnas como sus funciones de Excel equivalentes para que sigan funcionando correctamente cuando se modifique la hoja. Pruébelo usted mismo en el siguiente ejemplo:

El archivo exportado incluye una columna oculta que contiene el nivel de cada DataRecord en la hoja. Este nivel se utiliza en los resúmenes para filtrar las celdas que deben incluirse en la función de resumen.

En la siguiente tabla, puede encontrar la fórmula de Excel correspondiente a cada uno de los resúmenes predeterminados.

Tipo de datos	Función	Función Excel
string, boolean	contar	="Contar: "&CONTAR.SI(inicio:fin, nivel de registro)
number, currency, percent	contar	="Contar: "&CONTAR.SI(inicio:fin, nivel de registro)
	mín.	="Min: "&MIN(IF(inicio:fin=nivel de registro, inicio de rango:fin de rango))
	máximo	="Máx: "&MAX(IF(inicio:fin=nivel de registro, inicio de rango:fin de rango))
	promedio	="Promedio: "&PROMEDIOIF(inicio:fin, nivel de registro, inicio de rango:fin de rango)
	suma	="Suma: "&SUMIF(inicio:fin, nivel de registro, inicio de rango:fin de rango)
date	contar	="Contar: "&CONTAR.SI(inicio:fin, nivel de registro)
	más temprano	="Más temprano: "& TEXT(MIN(IF(start:end=recordLevel, rangeStart:rangeEnd)), formato)
	el último	="Último: "&TEXT(MAX(IF(start:end=recordLevel, rangeStart:rangeEnd)), formato)

Known Limitations

Limitación	Descripción
Exportar resúmenes personalizados	Los resúmenes personalizados se exportarán como cadenas en lugar de funciones de Excel.
Exportar resúmenes con plantillas	Los resúmenes con plantilla no son compatibles y se exportarán como los predeterminados.

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

Estilismo

Para comenzar a diseñar el comportamiento de clasificación, necesitamos importar el archivo index, donde se encuentran todas las funciones del tema y los mixins de componentes:

@use "igniteui-angular/theming" as *;

// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';

Siguiendo el enfoque más simple, creamos un nuevo tema que extiende el grid-summary-theme y acepta $background-color, $focus-background-color, $label-color, $result-color, $pinned-border-width, Parámetros $pinned-border-style y $pinned-border-color.

$custom-theme: grid-summary-theme(
    $background-color: #e0f3ff,
    $focus-background-color: rgba( #94d1f7, .3 ),
    $label-color: #e41c77,
    $result-color: black,
    $pinned-border-width: 2px,
    $pinned-border-style: dotted,
    $pinned-border-color: #e41c77
);

El último paso es incluir los mixins de componentes:

@include grid-summary($custom-theme);

Note

Si el componente utiliza una ViewEncapsulation Emulated, es necesario penetrate esta encapsulación usando::ng-deep:

:host {
   ::ng-deep {
       @include grid-summary($custom-theme);
   }
}

Defining a color palette

En lugar de codificar los valores de color como acabamos de hacer, podemos lograr una mayor flexibilidad en términos de colores utilizando las funciones igx-palette e igx-color.

igx-palette genera una paleta de colores basada en los colores primarios y secundarios que se pasan:

$blue-color: #7793b1;
$green-color: #00ff2d;

$my-custom-palette: palette($primary: $blue-color, $secondary: $green-color);

Y luego con igx-color podemos recuperar fácilmente el color de la paleta.

$custom-theme: grid-summary-theme(
    $background-color: color($my-custom-palette, "primary", 700),
    $focus-background-color: color($my-custom-palette, "primary", 800),
    $label-color: color($my-custom-palette, "secondary", 500),
    $result-color: color($my-custom-palette, "grays", 900),
    $pinned-border-width: 2px,
    $pinned-border-style: dotted,
    $pinned-border-color: color($my-custom-palette, "secondary", 500)
);

Note

​igx-color e igx-palette son funciones potentes para generar y recuperar colores. Consulte el tema Palettes para obtener orientación detallada sobre cómo utilizarlas.

Using Schemas

Yendo más allá con el motor de temas, puede crear una estructura sólida y flexible que se beneficie de los esquemas. Un esquema es una receta de un tema.

Amplíe uno de los dos esquemas predefinidos, que se proporcionan para cada componente, en este caso:_light-grid-summary:

// Extending the light grid summary schema
$my-summary-schema: extend($_light-grid-summary,
    (
        background-color: (igx-color: ('primary', 700)),
        focus-background-color: (igx-color: ('primary', 800)),
        label-color: (igx-color: ('secondary', 500)),
        result-color: (igx-color: ('grays', 900)),
        pinned-border-width: 2px,
        pinned-border-style: dotted,
        pinned-border-color: (igx-color: ('secondary', 500))
    )
);

Para aplicar nuestro esquema personalizado, tenemos que extender uno de los globales (light u dark), que básicamente señala los componentes con un esquema personalizado, y luego agregarlo a los temas de componentes respectivos:

// Extending the global light-schema
$my-custom-schema: extend($light-schema,
    (
        igx-grid-summary: $my-summary-schema
    )
);

// Defining our custom theme with the custom schema
$custom-theme: grid-summary-theme(
    $palette: $my-custom-palette,
    $schema: $my-custom-schema
);

No olvide incluir los temas de la misma manera que se demostró anteriormente.

Demo

API References

• API de componentes IgxGrid
• Estilos de componentes IgxGrid
• Estilos de resúmenes de IgxGrid
• IgxSummaryOperando
• IgxNúmeroResumenOperando
• IgxFechaResumenOperando
• Componente de grupo de columnas Igx
• ComponenteColumnaIgx

Additional Resources

• Descripción general de la cuadrícula
• Tipos de datos de columna
• Virtualización y rendimiento
• Paginación
• Filtración
• Clasificación
• Columna en movimiento
• Fijación de columnas
• Cambio de tamaño de columna
• Selección
• Agregados basados en selección

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

• Ignite UI for Angular foros angulares
• Ignite UI for Angular GitHub