Export Grid with summaries (#12027)

* feat(excel-exporter): include summaries in export

* feat(excel-exporter): export summaries

* feat(excel-exporter): export tGrid with summaries

* feat(excel-exporter): export hGrid with summaries

* chore(*): minor base-export refactoring

* feat(excel-exporter): fix grouped grid summaries export

* feat(excel-exporter): push latest hGrid summary export changes

* feat(excel-exporter): fix summary coordinates calculation for  t/hGrid

* feat(excel-exporter): fix summary export functions

* fix(excel-exporter): dont include lvl col in col count for non hGrids

* feat(excel-export): fix min, max, earliest, latest

* feat(excel-exporter): hide level column, remove commented lines

* chore(*): fix property usage

* chore(*): push tests and some bug fixes

* chore(*): remove fit from test

* chore(*): update test data

* fix(excel-exporter): exclude summary records from formatting+set level correctly

* fix(excel-exporter): export custom sumaries

* feat(exporter): add grid export sample

* chore(*): fix grid export samples+exporter options

* feat(excel-exporte): format currency cols in styles xml

* chore(*): push latest changes

* chore(*): remove extra symbol

* chore(*): update changelog

* chore(*): export sample fix columns

* feat(exporter): display currencies in summaries+fix date format

* chore(*): fix failing test

* fix(exporter): unsupported locale currencies fallback to numbers

* chore(*): add currencyCol settings

* chore(*): add missing import

* chore(*): add currency tests configuration

* chore(*): remove problematic tests

Co-authored-by: Stamen Stoychev <[email protected]>
Co-authored-by: Konstantin Dinev <[email protected]>
Co-authored-by: igdmdimitrov <[email protected]>
Co-authored-by: igdmdimitrov <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -30,6 +30,10 @@ All notable changes for each version of this project will be documented in this
 - `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`
     - **Behavioral Change** - When editing a row, `rowChangesCount` and `hiddenColumnsCount`would be displayed.
 
+- `IgxExcelExporterService`
+    - Added support for exporting grid summaries.
+    - Columns of type `currency` will be formatted as currency in Excel based on grid's locale. Locale currency different than `USD`, `EUR`, `GBP`, `CNY` or `JPY` will result in exporting the column as number instead.
+
 - `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`, `IgxPivotGrid`
     - Adding `Image` column data type
 

projects/igniteui-angular/src/lib/services/excel/excel-exporter-grid.spec.ts

@@ -18,14 +18,16 @@ import {
     MultiColumnHeadersExportComponent,
     GridWithEmptyColumnsComponent,
     ColumnsAddedOnInitComponent,
-    GridWithThreeLevelsOfMultiColumnHeadersAndTwoRowsExportComponent
+    GridWithThreeLevelsOfMultiColumnHeadersAndTwoRowsExportComponent,
+    GroupedGridWithSummariesComponent,
+    GridCurrencySummariesComponent
 } from '../../test-utils/grid-samples.spec';
 import { SampleTestData } from '../../test-utils/sample-test-data.spec';
 import { first } from 'rxjs/operators';
 import { DefaultSortingStrategy, SortingDirection } from '../../data-operations/sorting-strategy';
 import { IgxStringFilteringOperand } from '../../data-operations/filtering-condition';
 import { configureTestSuite } from '../../test-utils/configure-suite';
-import { IgxTreeGridPrimaryForeignKeyComponent } from '../../test-utils/tree-grid-components.spec';
+import { IgxTreeGridPrimaryForeignKeyComponent, IgxTreeGridSummariesKeyComponent } from '../../test-utils/tree-grid-components.spec';
 import { IgxTreeGridModule, IgxTreeGridComponent } from '../../grids/tree-grid/public_api';
 import { IgxNumberFilteringOperand } from '../../data-operations/filtering-condition';
 import { UIInteractions, wait } from '../../test-utils/ui-interactions.spec';
@@ -34,7 +36,8 @@ import { FilteringExpressionsTree } from '../../data-operations/filtering-expres
 import { FilteringLogic } from '../../data-operations/filtering-expression.interface';
 import { IgxHierarchicalGridExportComponent,
          IgxHierarchicalGridMultiColumnHeaderIslandsExportComponent,
-         IgxHierarchicalGridMultiColumnHeadersExportComponent
+         IgxHierarchicalGridMultiColumnHeadersExportComponent,
+         IgxHierarchicalGridSummariesExportComponent
 } from '../../test-utils/hierarchical-grid-components.spec';
 import { IgxHierarchicalGridModule,
          IgxHierarchicalGridComponent,
@@ -68,7 +71,11 @@ describe('Excel Exporter', () => {
                 IgxHierarchicalGridMultiColumnHeaderIslandsExportComponent,
                 GridWithThreeLevelsOfMultiColumnHeadersAndTwoRowsExportComponent,
                 IgxPivotGridMultipleRowComponent,
-                IgxPivotGridTestComplexHierarchyComponent
+                IgxPivotGridTestComplexHierarchyComponent,
+                IgxTreeGridSummariesKeyComponent,
+                IgxHierarchicalGridSummariesExportComponent,
+                GroupedGridWithSummariesComponent,
+                GridCurrencySummariesComponent
             ],
             imports: [IgxGridModule, IgxTreeGridModule, IgxHierarchicalGridModule, IgxPivotGridModule, NoopAnimationsModule]
         }).compileComponents();
@@ -1211,6 +1218,97 @@ describe('Excel Exporter', () => {
         });
     });
 
+
+    describe('', () => {
+        let fix;
+        let grid: any;
+
+        beforeEach(waitForAsync(() => {
+            options = createExportOptions('GirdSummariesExcelExport', 50);
+        }));
+
+        it('should export grid with summaries based on summaryCalculationMode', async () => {
+            fix = TestBed.createComponent(GroupedGridWithSummariesComponent);
+            fix.detectChanges();
+            await wait(300);
+
+            grid = fix.componentInstance.grid;
+            grid.summaryCalculationMode = 'rootLevelOnly';
+
+            await exportAndVerify(grid, options, actualData.exportGridWithSummaries);
+
+            (grid as IgxGridComponent).groupBy({ fieldName: 'Shipped', dir: SortingDirection.Asc, ignoreCase: false });
+            (grid as IgxGridComponent).groupBy({ fieldName: 'City', dir: SortingDirection.Asc, ignoreCase: false });
+            (grid as IgxGridComponent).groupBy({ fieldName: 'ContactTitle', dir: SortingDirection.Asc, ignoreCase: false });
+
+            fix.detectChanges();
+
+            await exportAndVerify(grid, options, actualData.exportGroupedGridWithSummariesRootLevelOnly);
+
+            grid.summaryCalculationMode = 'childLevelsOnly';
+            fix.detectChanges();
+
+            await exportAndVerify(grid, options, actualData.exportGroupedGridWithSummariesChildLevelsOnly);
+
+            grid.summaryCalculationMode = 'rootAndChildLevels';
+            fix.detectChanges();
+
+            await exportAndVerify(grid, options, actualData.exportGroupedGridWithSummariesRootAndChildLevels);
+        });
+
+        it('should export tree grid with summaries', async () => {
+            fix = TestBed.createComponent(IgxTreeGridSummariesKeyComponent);
+            fix.detectChanges();
+            await wait(300);
+            grid = fix.componentInstance.treeGrid;
+
+            grid.toggleRow(grid.getRowByIndex(2).key);
+            grid.toggleRow(grid.getRowByIndex(0).key);
+            grid.toggleRow(grid.getRowByIndex(3).key);
+            fix.detectChanges();
+
+            await exportAndVerify(grid, options, actualData.exportTreeGridWithSummaries);
+        });
+
+        it('should export hierarchical grid with summaries', async () => {
+            fix = TestBed.createComponent(IgxHierarchicalGridSummariesExportComponent);
+            fix.detectChanges();
+            await wait(300);
+            grid = fix.componentInstance.hGrid;
+
+            const firstRow = grid.gridAPI.get_row_by_index(0) as IgxHierarchicalRowComponent;
+            const secondRow = grid.gridAPI.get_row_by_index(1) as IgxHierarchicalRowComponent;
+
+            UIInteractions.simulateClickAndSelectEvent(firstRow.expander);
+            fix.detectChanges();
+            expect(firstRow.expanded).toBe(true);
+
+            let childGrids = grid.gridAPI.getChildGrids(false);
+
+            const firstChildGrid = childGrids[0];
+            const firstChildRow = firstChildGrid.gridAPI.get_row_by_index(0) as IgxHierarchicalRowComponent;
+
+            UIInteractions.simulateClickAndSelectEvent(firstChildRow.expander);
+            fix.detectChanges();
+            expect(firstChildRow.expanded).toBe(true);
+
+            UIInteractions.simulateClickAndSelectEvent(secondRow.expander);
+            fix.detectChanges();
+            expect(secondRow.expanded).toBe(true);
+
+            childGrids = grid.gridAPI.getChildGrids(false);
+
+            const thirdChildGrid = childGrids[1];
+            const thirdChildRow = thirdChildGrid.gridAPI.get_row_by_index(0) as IgxHierarchicalRowComponent;
+
+            UIInteractions.simulateClickAndSelectEvent(thirdChildRow.expander);
+            fix.detectChanges();
+            expect(thirdChildRow.expanded).toBe(true);
+
+            await exportAndVerify(grid, options, actualData.exportHierarchicalGridWithSummaries);
+        });
+    });
+
     describe('', () => {
         let fix;
         let grid: IgxPivotGridComponent;

projects/igniteui-angular/src/lib/services/excel/excel-exporter.ts

@@ -5,7 +5,7 @@ import { ExcelElementsFactory } from './excel-elements-factory';
 import { ExcelFolderTypes } from './excel-enums';
 import { IgxExcelExporterOptions } from './excel-exporter-options';
 import { IExcelFolder } from './excel-interfaces';
-import { ExportRecordType, IExportRecord, IgxBaseExporter, DEFAULT_OWNER, HeaderType } from '../exporter-common/base-export-service';
+import { ExportRecordType, IExportRecord, IgxBaseExporter, DEFAULT_OWNER, HeaderType, GRID_LEVEL_COL } from '../exporter-common/base-export-service';
 import { ExportUtilities } from '../exporter-common/export-utilities';
 import { WorksheetData } from './worksheet-data';
 import { IBaseEventArgs } from '../../core/utils';
@@ -114,7 +114,7 @@ export class IgxExcelExporterService extends IgxBaseExporter {
                 defaultOwner = this._ownersMap.get(firstDataElement.owner);
             } else {
                 defaultOwner = this._ownersMap.get(DEFAULT_OWNER);
-                const columns = defaultOwner.columns.filter(col => !col.skip && col.headerType === HeaderType.ColumnHeader);
+                const columns = defaultOwner.columns.filter(col => col.field !== GRID_LEVEL_COL && !col.skip && col.headerType === HeaderType.ColumnHeader);
 
                 columnWidths = defaultOwner.columnWidths;
                 indexOfLastPinnedColumn = defaultOwner.indexOfLastPinnedColumn;
@@ -126,7 +126,7 @@ export class IgxExcelExporterService extends IgxBaseExporter {
 
             defaultOwner = this._ownersMap.get(ownersKeys[0]);
             columnWidths = defaultOwner.columnWidths;
-            columnCount = defaultOwner.columns.filter(col => !col.skip && col.headerType === HeaderType.ColumnHeader).length;
+            columnCount = defaultOwner.columns.filter(col => col.field !== GRID_LEVEL_COL && !col.skip && col.headerType === HeaderType.ColumnHeader).length;
         }
 
         const worksheetData =