feat(grid-summary): summary disabling with disabledSummaries property

Author: georgianastasov

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes for each version of this project will be documented in this file.
 
+## 19.0.0
+### New Features
+- `IgxColumn`
+    - Introduced the `disabledSummaries` property, allowing users to specify which summaries should be disabled for a given column. This property accepts an array of strings corresponding to the summary keys, enabling selective control over both default summaries (e.g., 'Count', 'Min') and any custom summaries created by the user.
+
 ## 18.2.0
 ### General
 - `IFilteringExpressionsTree`, `FilteringExpressionsTree`

projects/igniteui-angular/src/lib/grids/columns/column.component.ts

@@ -1077,6 +1077,33 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
             this.grid.summaryService.resetSummaryHeight();
         }
     }
+
+    /**
+     * Sets/gets the summary operands to exclude from display.
+     * Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.
+     * ```typescript
+     * let disabledSummaries = this.column.disabledSummaries;
+     * ```
+     * ```html
+     * <igx-column [disabledSummaries]="['min', 'max', 'average']"></igx-column>
+     * ```
+     *
+     * @memberof IgxColumnComponent
+     */
+    @Input()
+    public get disabledSummaries(): string[] {
+        return this._disabledSummaries;
+    }
+
+    public set disabledSummaries(value: string[]) {
+        this._disabledSummaries = value;
+        if (this.grid) {
+            this.grid.summaryService.removeSummariesCachePerColumn(this.field);
+            this.grid.summaryPipeTrigger++;
+            this.grid.summaryService.resetSummaryHeight();
+        }
+    }
+
     /**
      * Gets the column `filters`.
      * ```typescript
@@ -1743,6 +1770,10 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
      * @hidden
      */
     protected _summaries = null;
+    /**
+     * @hidden
+     */
+    private _disabledSummaries: string[] = [];
     /**
      * @hidden
      */

projects/igniteui-angular/src/lib/grids/common/grid.interface.ts

@@ -443,6 +443,7 @@ export interface ColumnType extends FieldType {
     filteringExpressionsTree: FilteringExpressionsTree;
     hasSummary: boolean;
     summaries: any;
+    disabledSummaries?: string[];
     /**
      * The template reference for a summary of the column
      * It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

projects/igniteui-angular/src/lib/grids/grid/grid-summary.spec.ts

@@ -134,6 +134,77 @@ describe('IgxGrid - Summaries #grid', () => {
                     fixture.detectChanges();
                 }).not.toThrow();
             });
+
+            it('should not display initially disabled summaries in the summary output', fakeAsync(() => {
+                grid.enableSummaries([{ fieldName: 'UnitsInStock' }]);
+                fixture.detectChanges();
+                tick();
+
+                const column = grid.getColumnByName('UnitsInStock');
+
+                column.disabledSummaries = ['count', 'min', 'max'];
+                fixture.detectChanges();
+                tick();
+
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Sum', 'Avg'],
+                    ['39,004', '3,900.4']
+                );
+            }));
+
+            it('should apply disabled summaries dynamically at runtime', fakeAsync(() => {
+                grid.enableSummaries([{ fieldName: 'UnitsInStock' }]);
+                fixture.detectChanges();
+                tick();
+
+                const column = grid.getColumnByName('UnitsInStock');
+
+                column.disabledSummaries = [];
+                fixture.detectChanges();
+                tick();
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Count', 'Min', 'Max', 'Sum', 'Avg'],
+                    ['10', '0', '20,000', '39,004', '3,900.4']
+                );
+
+                column.disabledSummaries = ['count'];
+                fixture.detectChanges();
+                tick();
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Min', 'Max', 'Sum', 'Avg'],
+                    ['0', '20,000', '39,004', '3,900.4']
+                );
+
+                column.disabledSummaries = ['count', 'sum'];
+                fixture.detectChanges();
+                tick();
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Min', 'Max', 'Avg'],
+                    ['0', '20,000', '3,900.4']
+                );
+
+                column.disabledSummaries = ['count', 'sum', 'average'];
+                fixture.detectChanges();
+                tick();
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Min', 'Max'],
+                    ['0', '20,000']
+                );
+
+                column.disabledSummaries = ['min', 'max'];
+                fixture.detectChanges();
+                tick();
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Count', 'Sum', 'Avg'],
+                    ['10', '39,004', '3,900.4']
+                );
+            }));
         });
 
         describe('custom summaries: ', () => {
@@ -238,6 +309,33 @@ describe('IgxGrid - Summaries #grid', () => {
                 expect(lastColumnSummaryCellRect.right).toBe(lastColumnNormalCellRect.right,
                     'summary cell and data cell are not right aligned');
             });
+
+            it('should apply disabledSummaries with custom summary', fakeAsync(() => {
+                grid.enableSummaries([{ fieldName: 'UnitsInStock' }]);
+                fixture.detectChanges();
+                tick();
+
+                const column = grid.getColumnByName('UnitsInStock');
+                column.summaries = fixture.componentInstance.inStockSummary;
+                fixture.detectChanges();
+                tick();
+
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Count', 'Min', 'Max', 'Sum', 'Avg', 'Items InStock'],
+                    ['10', '0', '20,000', '39,004', '3,900.4', '6']
+                );
+
+                column.disabledSummaries = ['test'];
+                fixture.detectChanges();
+                tick();
+
+                GridSummaryFunctions.verifyColumnSummaries(
+                    GridSummaryFunctions.getRootSummaryRow(fixture), 3,
+                    ['Count', 'Min', 'Max', 'Sum', 'Avg'],
+                    ['10', '0', '20,000', '39,004', '3,900.4']
+                );
+            }));
         });
 
         describe('specific data: ', () => {

projects/igniteui-angular/src/lib/grids/summaries/grid-summary.service.ts

@@ -116,16 +116,38 @@ export class IgxGridSummaryService {
             rowSummaries = new Map<string, IgxSummaryResult[]>();
             this.summaryCacheMap.set(rowID, rowSummaries);
         }
+
         if (!this.hasSummarizedColumns || !data) {
             return rowSummaries;
         }
+
         this.grid.columns.filter(col => col.hasSummary).forEach((column) => {
             if (!rowSummaries.get(column.field)) {
-                const summaryResult = column.summaries.operate(data.map(r => resolveNestedPath(r, column.field)),
-                    data, column.field, groupRecord, this.grid.locale, column.pipeArgs);
+                let summaryResult = column.disabledSummaries.length
+                    ? this.getCachedSummary(column.field, column.disabledSummaries) || null
+                    : null;
+
+                if (!summaryResult) {
+                    summaryResult = column.summaries.operate(
+                        data.map(r => resolveNestedPath(r, column.field)),
+                        data,
+                        column.field,
+                        groupRecord,
+                        this.grid.locale,
+                        column.pipeArgs
+                    );
+
+                    if (column.disabledSummaries.length) {
+                        summaryResult = summaryResult.filter(
+                            result => !column.disabledSummaries.includes(result.key)
+                        );
+                        this.cacheSummary(column.field, summaryResult, column.disabledSummaries);
+                    }
+                }
                 rowSummaries.set(column.field, summaryResult);
             }
         });
+
         return rowSummaries;
     }
 
@@ -244,4 +266,17 @@ export class IgxGridSummaryService {
             });
         }
     }
+
+    private cacheSummary(field: string, summaryResult: IgxSummaryResult[], disabledSummaries: string[] = []) {
+        if (!this.summaryCacheMap.has(field)) {
+            this.summaryCacheMap.set(field, new Map<string, IgxSummaryResult[]>());
+        }
+        const cacheKey = JSON.stringify(disabledSummaries);
+        this.summaryCacheMap.get(field).set(cacheKey, summaryResult);
+    }
+
+    private getCachedSummary(field: string, disabledSummaries: string[] = []): IgxSummaryResult[] | undefined {
+        const cacheKey = JSON.stringify(disabledSummaries);
+        return this.summaryCacheMap.get(field)?.get(cacheKey);
+    }
 }