Merge branch 'master' into ttonev-fix-10806

teodosiah · web-flow · commit 11c93bcef87b · 2022-01-20T08:55:23.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,9 @@ All notable changes for each version of this project will be documented in this
     ```
 - `IgxTabs` have full right-to-left (RTL) support.
 
+- `IgxExcelExporterService`
+    - Added support for exporting the grids' headers by default when the data is empty. This behavior can be controlled by the `alwaysExportHeaders` option of the IgxExcelExporterOptions object.
+
 ### General
 
 - `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`
diff --git a/projects/igniteui-angular/src/lib/services/excel/excel-exporter-grid.spec.ts b/projects/igniteui-angular/src/lib/services/excel/excel-exporter-grid.spec.ts
@@ -389,6 +389,8 @@ describe('Excel Exporter', () => {
 
         it('should not export columns when \'columnExporting\' is canceled.', async () => {
             const fix = TestBed.createComponent(GridIDNameJobTitleComponent);
+            options.alwaysExportHeaders = false;
+
             fix.detectChanges();
             await wait();
 
@@ -477,6 +479,8 @@ describe('Excel Exporter', () => {
 
         it('should not export rows when \'rowExporting\' is canceled.', async () => {
             const fix = TestBed.createComponent(GridIDNameJobTitleComponent);
+            options.alwaysExportHeaders = false;
+
             fix.detectChanges();
             await wait();
 
@@ -902,12 +906,13 @@ describe('Excel Exporter', () => {
             await exportAndVerify(hGrid, options, actualData.exportMultiColumnHeadersDataWithSkippedParentMCH);
         });
 
-        it('should export empty file when all parent multi column headers are skipped', async () => {
+        it('should export empty file when all parent multi column headers are skipped and alwaysExportHeaders is false', async () => {
             const fix = TestBed.createComponent(IgxHierarchicalGridMultiColumnHeadersExportComponent);
             fix.detectChanges();
 
             const hGrid = fix.componentInstance.hGrid;
             options = createExportOptions('HierarchicalGridMCHExcelExport');
+            options.alwaysExportHeaders = false;
 
             exporter.columnExporting.subscribe((args: IColumnExportingEventArgs) => {
                 if (args.header === 'General Information' || args.header === 'Address Information' || args.field === 'CustomerID') {
@@ -918,6 +923,19 @@ describe('Excel Exporter', () => {
 
             await exportAndVerify(hGrid, options, actualData.exportMultiColumnHeadersDataWithAllParentsSkipped);
         });
+
+        it('should export headers when exporting empty hierarchical grid with multi column headers', async () => {
+            const fix = TestBed.createComponent(IgxHierarchicalGridMultiColumnHeadersExportComponent);
+            fix.detectChanges();
+
+            const hGrid = fix.componentInstance.hGrid;
+            fix.componentInstance.data = [];
+            options = createExportOptions('HierarchicalGridMCHExcelExport');
+
+            fix.detectChanges();
+
+            await exportAndVerify(hGrid, options, actualData.exportEmptyMultiColumnHeadersDataWithExportedHeaders);
+        });
     });
 
     describe('', () => {
@@ -1094,6 +1112,13 @@ describe('Excel Exporter', () => {
 
             await exportAndVerify(treeGrid, options, actualData.treeGridWithAdvancedFilters);
         });
+
+        it('should export headers when exporting empty tree grid.', async () => {
+            fix.componentInstance.data = [];
+            fix.detectChanges();
+
+            await exportAndVerify(treeGrid, options, actualData.emptyTreeGridWithExportedHeaders);
+        });
     });
 
     describe('', () => {
@@ -1160,6 +1185,14 @@ describe('Excel Exporter', () => {
             fix.detectChanges();
             await exportAndVerify(grid, options, actualData.exportFrozenMultiColumnHeadersData, false);
         });
+
+        it('should export headers when exporting empty grid with multi column headers', async () => {
+            fix.componentInstance.data = [];
+
+            fix.detectChanges();
+
+            await exportAndVerify(grid, options, actualData.exportEmptyGridWithMultiColumnHeadersData, false);
+        });
     });
 
     const getExportedData = (grid, exportOptions: IgxExcelExporterOptions) => {
diff --git a/projects/igniteui-angular/src/lib/services/excel/excel-exporter.spec.ts b/projects/igniteui-angular/src/lib/services/excel/excel-exporter.spec.ts
@@ -25,13 +25,16 @@ describe('Excel Exporter', () => {
 
     /* ExportData() tests */
     it('should not fail when data is empty.', async () => {
+        options.alwaysExportHeaders = false;
+
         const wrapper = await getExportedData([], options);
 
         wrapper.verifyStructure();
         await wrapper.verifyTemplateFilesContent();
     });
 
     it('should export empty objects successfully.', async () => {
+        options.alwaysExportHeaders = false;
         const wrapper = await getExportedData(SampleTestData.emptyObjectData(), options);
 
         wrapper.verifyStructure();
diff --git a/projects/igniteui-angular/src/lib/services/excel/excel-exporter.ts b/projects/igniteui-angular/src/lib/services/excel/excel-exporter.ts
@@ -123,6 +123,12 @@ export class IgxExcelExporterService extends IgxBaseExporter {
                 columnCount = columns.length;
                 rootKeys = columns.map(c => c.field);
             }
+        } else {
+            const ownersKeys = Array.from(this._ownersMap.keys());
+
+            defaultOwner = this._ownersMap.get(ownersKeys[0]);
+            columnWidths = defaultOwner.columnWidths;
+            columnCount = defaultOwner.columns.filter(col => !col.skip && col.headerType === HeaderType.ColumnHeader).length;
         }
 
         const worksheetData =
diff --git a/projects/igniteui-angular/src/lib/services/excel/excel-files.ts b/projects/igniteui-angular/src/lib/services/excel/excel-files.ts
@@ -38,7 +38,7 @@ export class CoreFile implements IExcelFile {
  */
 export class WorkbookRelsFile implements IExcelFile {
     public writeElement(folder: JSZip, worksheetData: WorksheetData) {
-        const hasSharedStrings = worksheetData.isEmpty === false;
+        const hasSharedStrings = !worksheetData.isEmpty || worksheetData.options.alwaysExportHeaders;
         folder.file('workbook.xml.rels', ExcelStrings.getWorkbookRels(hasSharedStrings));
     }
 }
@@ -71,11 +71,11 @@ export class WorksheetFile implements IExcelFile {
     public async writeElementAsync(folder: JSZip, worksheetData: WorksheetData) {
         return new Promise<void>(resolve => {
             this.prepareDataAsync(worksheetData, (cols, rows) => {
-                const hasTable = !worksheetData.isEmpty && worksheetData.options.exportAsTable;
-                const isHierarchicalGrid = worksheetData.data[0]?.type === ExportRecordType.HierarchicalGridRecord;
+                const hasTable = (!worksheetData.isEmpty || worksheetData.options.alwaysExportHeaders)
+                    && worksheetData.options.exportAsTable;
 
                 folder.file('sheet1.xml', ExcelStrings.getSheetXML(
-                    this.dimension, this.freezePane, cols, rows, hasTable, this.maxOutlineLevel, isHierarchicalGrid));
+                    this.dimension, this.freezePane, cols, rows, hasTable, this.maxOutlineLevel, worksheetData.isHierarchical));
                 resolve();
             });
         });
@@ -87,14 +87,15 @@ export class WorksheetFile implements IExcelFile {
         const dictionary = worksheetData.dataDictionary;
         this.rowIndex = 0;
 
-        if (worksheetData.isEmpty) {
+        if (worksheetData.isEmpty && (!worksheetData.options.alwaysExportHeaders || worksheetData.owner.columns.length === 0)) {
             sheetData += '<sheetData/>';
             this.dimension = 'A1';
             done('', sheetData);
         } else {
             const owner = worksheetData.owner;
-            const isHierarchicalGrid = worksheetData.data[0].type === ExportRecordType.HierarchicalGridRecord;
+            const isHierarchicalGrid = worksheetData.isHierarchical;
             const hasMultiColumnHeader = worksheetData.hasMultiColumnHeader;
+
             const hasUserSetIndex = owner.columns.some(col => col.exportIndex !== undefined);
 
             const height =  worksheetData.options.rowHeight;
@@ -182,7 +183,7 @@ export class WorksheetFile implements IExcelFile {
                 const indexOfLastPinnedColumn = worksheetData.indexOfLastPinnedColumn;
                 const frozenColumnCount = indexOfLastPinnedColumn + 1;
                 let firstCell = ExcelStrings.getExcelColumn(frozenColumnCount) + freezeHeaders;
-                if (indexOfLastPinnedColumn !== -1 &&
+                if (indexOfLastPinnedColumn !== undefined && indexOfLastPinnedColumn !== -1 &&
                     !worksheetData.options.ignorePinning &&
                     !worksheetData.options.ignoreColumnsOrder) {
                     this.freezePane =
@@ -209,7 +210,7 @@ export class WorksheetFile implements IExcelFile {
                 sheetData += rows;
                 sheetData += '</sheetData>';
 
-                if (hasMultiColumnHeader) {
+                if (hasMultiColumnHeader && this.mergeCellsCounter > 0) {
                     sheetData += `<mergeCells count="${this.mergeCellsCounter}">${this.mergeCellStr}</mergeCells>`;
                 }
 
@@ -223,40 +224,41 @@ export class WorksheetFile implements IExcelFile {
         const height =  worksheetData.options.rowHeight;
         this.rowHeight = height ? ' ht="' + height + '" customHeight="1"' : '';
 
-        const isHierarchicalGrid =
-            worksheetData.data.some(r => r.type === ExportRecordType.HeaderRecord || r.type === ExportRecordType.HierarchicalGridRecord);
+        const isHierarchicalGrid = worksheetData.isHierarchical;
         const hasUserSetIndex = worksheetData.owner.columns.some(c => c.exportIndex !== undefined);
 
         let recordHeaders = [];
 
         yieldingLoop(worksheetData.rowCount - 1, 1000,
             (i) => {
-                if (!isHierarchicalGrid) {
-                    if (hasUserSetIndex) {
-                        recordHeaders = worksheetData.rootKeys;
+                if (!worksheetData.isEmpty){
+                    if (!isHierarchicalGrid) {
+                        if (hasUserSetIndex) {
+                            recordHeaders = worksheetData.rootKeys;
+                        } else {
+                            recordHeaders = worksheetData.owner.columns
+                                .filter(c => c.headerType !== HeaderType.MultiColumnHeader && !c.skip)
+                                .sort((a, b) => a.startIndex-b.startIndex)
+                                .sort((a, b) => a.pinnedIndex-b.pinnedIndex)
+                                .map(c => c.field);
+                        }
                     } else {
-                        recordHeaders = worksheetData.owner.columns
-                            .filter(c => c.headerType !== HeaderType.MultiColumnHeader && !c.skip)
-                            .sort((a, b) => a.startIndex-b.startIndex)
-                            .sort((a, b) => a.pinnedIndex-b.pinnedIndex)
-                            .map(c => c.field);
-                    }
-                } else {
-                    const record = worksheetData.data[i];
+                        const record = worksheetData.data[i];
 
-                    if (record.type === ExportRecordType.HeaderRecord) {
-                        const recordOwner = worksheetData.owners.get(record.owner);
-                        const hasMultiColumnHeaders = recordOwner.columns.some(c => !c.skip && c.headerType === HeaderType.MultiColumnHeader);
+                        if (record.type === ExportRecordType.HeaderRecord) {
+                            const recordOwner = worksheetData.owners.get(record.owner);
+                            const hasMultiColumnHeaders = recordOwner.columns.some(c => !c.skip && c.headerType === HeaderType.MultiColumnHeader);
 
-                        if (hasMultiColumnHeaders) {
-                            this.hGridPrintMultiColHeaders(worksheetData, rowDataArr, record, recordOwner);
+                            if (hasMultiColumnHeaders) {
+                                this.hGridPrintMultiColHeaders(worksheetData, rowDataArr, record, recordOwner);
+                            }
                         }
+
+                        recordHeaders = Object.keys(worksheetData.data[i].data);
                     }
 
-                    recordHeaders = Object.keys(worksheetData.data[i].data);
+                    rowDataArr.push(this.processRow(worksheetData, i, recordHeaders, isHierarchicalGrid));
                 }
-
-                rowDataArr.push(this.processRow(worksheetData, i, recordHeaders, isHierarchicalGrid));
             },
             () => {
                 done(rowDataArr.join(''));
@@ -404,7 +406,8 @@ export class WorkbookFile implements IExcelFile {
  */
 export class ContentTypesFile implements IExcelFile {
     public writeElement(folder: JSZip, worksheetData: WorksheetData) {
-        folder.file('[Content_Types].xml', ExcelStrings.getContentTypesXML(!worksheetData.isEmpty, worksheetData.options.exportAsTable));
+        const hasSharedStrings = !worksheetData.isEmpty || worksheetData.options.alwaysExportHeaders;
+        folder.file('[Content_Types].xml', ExcelStrings.getContentTypesXML(hasSharedStrings, worksheetData.options.exportAsTable));
     }
 }
 
@@ -436,7 +439,10 @@ export class TablesFile implements IExcelFile {
     public writeElement(folder: JSZip, worksheetData: WorksheetData) {
         const columnCount = worksheetData.columnCount;
         const lastColumn = ExcelStrings.getExcelColumn(columnCount - 1) + worksheetData.rowCount;
-        const dimension = 'A1:' + lastColumn;
+        const autoFilterDimension = 'A1:' + lastColumn;
+        const tableDimension = worksheetData.isEmpty
+            ? 'A1:' + ExcelStrings.getExcelColumn(columnCount - 1) + (worksheetData.rowCount + 1)
+            : autoFilterDimension;
         const hasUserSetIndex = worksheetData.owner.columns.some(c => c.exportIndex !== undefined);
         const values = hasUserSetIndex
             ? worksheetData.rootKeys
@@ -463,7 +469,7 @@ export class TablesFile implements IExcelFile {
             sortString = `<sortState ref="A2:${lastColumn}"><sortCondition descending="${dir}" ref="${sc}1:${sc}15"/></sortState>`;
         }
 
-        folder.file('table1.xml', ExcelStrings.getTablesXML(dimension, tableColumns, sortString));
+        folder.file('table1.xml', ExcelStrings.getTablesXML(autoFilterDimension, tableDimension, tableColumns, sortString));
     }
 }
 
diff --git a/projects/igniteui-angular/src/lib/services/excel/excel-folders.ts b/projects/igniteui-angular/src/lib/services/excel/excel-folders.ts
@@ -70,7 +70,7 @@ export class XLExcelFolder implements IExcelFolder {
             ExcelFileTypes.WorkbookFile
         ];
 
-        if (!data.isEmpty) {
+        if (!data.isEmpty || data.options.alwaysExportHeaders) {
             retVal.push(ExcelFileTypes.SharedStringsFile);
         }
 
@@ -84,7 +84,7 @@ export class XLExcelFolder implements IExcelFolder {
             ExcelFolderTypes.WorksheetsExcelFolder
         ];
 
-        if (!data.isEmpty && data.options.exportAsTable) {
+        if ((!data.isEmpty || data.options.alwaysExportHeaders) && data.options.exportAsTable) {
             retVal.push(ExcelFolderTypes.TablesExcelFolder);
         }
 
@@ -133,7 +133,7 @@ export class WorksheetsExcelFolder implements IExcelFolder {
     }
 
     public childFolders(data: WorksheetData) {
-        return data.isEmpty || !data.options.exportAsTable ? [] : [ExcelFolderTypes.WorksheetsRelsExcelFolder];
+        return (data.isEmpty && !data.options.alwaysExportHeaders) || !data.options.exportAsTable ? [] : [ExcelFolderTypes.WorksheetsRelsExcelFolder];
     }
 }
 
diff --git a/projects/igniteui-angular/src/lib/services/excel/excel-strings.ts b/projects/igniteui-angular/src/lib/services/excel/excel-strings.ts
@@ -45,12 +45,12 @@ export class ExcelStrings {
         return retVal;
     }
 
-    public static getSheetXML(dimension: string, freezePane: string, cols: string, sheetData: string, hasTable: boolean, outlineLevel = 0, isHierarchicalGrid: boolean): string {
+    public static getSheetXML(dimension: string, freezePane: string, cols: string, sheetData: string, hasTable: boolean, outlineLevel = 0, isHierarchical: boolean): string {
         const hasOutline = outlineLevel > 0;
         const tableParts = hasTable ? '<tableParts count="1"><tablePart r:id="rId1"/></tableParts>' : '';
         const sheetOutlineProp = hasOutline ? '<sheetPr><outlinePr summaryBelow="0"/></sheetPr>' : '';
         const sOutlineLevel =  hasOutline ? `outlineLevelRow="${outlineLevel}"` : '';
-        const dimensions = isHierarchicalGrid ? '' : `<dimension ref="${dimension}"/>`;
+        const dimensions = isHierarchical ? '' : `<dimension ref="${dimension}"/>`;
 
         // return ExcelStrings.XML_STRING +
         //     '<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="x14ac" xmlns:x14ac="http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac"><dimension ref="' + dimension + '"/><sheetViews><sheetView tabSelected="1" workbookViewId="0">' + freezePane + '</sheetView></sheetViews><sheetFormatPr defaultRowHeight="15" x14ac:dyDescent="0.25"/>' + cols + sheetData + '<pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3" footer="0.3"/>' + tableParts + '</worksheet>';
@@ -94,9 +94,9 @@ ${tableParts}</worksheet>`;
         return contentTypes;
     }
 
-    public static getTablesXML(dimension: string, tableColumns: string, sort: string): string {
-        return `${ExcelStrings.XML_STRING}<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" id="1" name="Table1" displayName="Table1" ref="${dimension}" totalsRowShown="0">
-    <autoFilter ref="${dimension}"/>${sort}${tableColumns}<tableStyleInfo name="TableStyleMedium2" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/>
+    public static getTablesXML(autoFilterDimension: string, tableDimension: string, tableColumns: string, sort: string): string {
+        return `${ExcelStrings.XML_STRING}<table xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" id="1" name="Table1" displayName="Table1" ref="${tableDimension}" totalsRowShown="0">
+    <autoFilter ref="${autoFilterDimension}"/>${sort}${tableColumns}<tableStyleInfo name="TableStyleMedium2" showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0"/>
 </table>`;
     }
     /* eslint-enable  max-len */
diff --git a/projects/igniteui-angular/src/lib/services/excel/test-data.service.spec.ts b/projects/igniteui-angular/src/lib/services/excel/test-data.service.spec.ts
diff --git a/projects/igniteui-angular/src/lib/services/excel/worksheet-data.ts b/projects/igniteui-angular/src/lib/services/excel/worksheet-data.ts
diff --git a/projects/igniteui-angular/src/lib/services/exporter-common/exporter-options-base.ts b/projects/igniteui-angular/src/lib/services/exporter-common/exporter-options-base.ts

Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,12 @@ export class IgxExcelExporterService extends IgxBaseExporter {`
`123`	`123`	`columnCount = columns.length;`
`124`	`124`	`rootKeys = columns.map(c => c.field);`
`125`	`125`	`}`
	`126`	`+ } else {`
	`127`	`+ const ownersKeys = Array.from(this._ownersMap.keys());`
	`128`	`+`
	`129`	`+ defaultOwner = this._ownersMap.get(ownersKeys[0]);`
	`130`	`+ columnWidths = defaultOwner.columnWidths;`
	`131`	`+ columnCount = defaultOwner.columns.filter(col => !col.skip && col.headerType === HeaderType.ColumnHeader).length;`
`126`	`132`	`}`
`127`	`133`
`128`	`134`	`const worksheetData =`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ export class XLExcelFolder implements IExcelFolder {`
`70`	`70`	`ExcelFileTypes.WorkbookFile`
`71`	`71`	`];`
`72`	`72`
`73`		`- if (!data.isEmpty) {`
	`73`	`+ if (!data.isEmpty \|\| data.options.alwaysExportHeaders) {`
`74`	`74`	`retVal.push(ExcelFileTypes.SharedStringsFile);`
`75`	`75`	`}`
`76`	`76`
`@@ -84,7 +84,7 @@ export class XLExcelFolder implements IExcelFolder {`
`84`	`84`	`ExcelFolderTypes.WorksheetsExcelFolder`
`85`	`85`	`];`
`86`	`86`
`87`		`- if (!data.isEmpty && data.options.exportAsTable) {`
	`87`	`+ if ((!data.isEmpty \|\| data.options.alwaysExportHeaders) && data.options.exportAsTable) {`
`88`	`88`	`retVal.push(ExcelFolderTypes.TablesExcelFolder);`
`89`	`89`	`}`
`90`	`90`
`@@ -133,7 +133,7 @@ export class WorksheetsExcelFolder implements IExcelFolder {`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`public childFolders(data: WorksheetData) {`
`136`		`- return data.isEmpty \|\| !data.options.exportAsTable ? [] : [ExcelFolderTypes.WorksheetsRelsExcelFolder];`
	`136`	`+ return (data.isEmpty && !data.options.alwaysExportHeaders) \|\| !data.options.exportAsTable ? [] : [ExcelFolderTypes.WorksheetsRelsExcelFolder];`
`137`	`137`	`}`
`138`	`138`	`}`
`139`	`139`