Merge branch 'master' into simeonoff/fix-9997

Author: zdrawku

CHANGELOG.md

@@ -9,6 +9,9 @@ All notable changes for each version of this project will be documented in this
     The `rowData` argument may be `undefined` in remote scenarios/applying the callback on filtering labels
     so make sure to check its availability.
 
+- `IgxExcelExporterService`
+    - Added support for freezing column headers in **Excel**. By default, the column headers would not be frozen but this behavior can be controlled by the `freezeHeaders` option of the IgxExcelExporterOptions object.
+
 ## 12.1.0
 
 ### New Features

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

@@ -235,6 +235,33 @@ describe('Excel Exporter', () => {
             await wrapper.verifyDataFilesContent(actualData.gridJobTitleIdFrozen, 'Not all pinned columns are frozen in the export!');
         });
 
+        it('should honor \'freezeHeaders\' option.', async () => {
+            const result = await TestMethods.createGridAndPinColumn([1]);
+            const fix = result.fixture;
+            const grid = result.grid;
+
+            options.ignorePinning = false;
+            options.freezeHeaders = true;
+            fix.detectChanges();
+
+            let wrapper = await getExportedData(grid, options);
+            wrapper.verifyStructure();
+            await wrapper.verifyDataFilesContent(actualData.gridNameFrozenHeaders,
+                'One frozen column and frozen headers should have been exported!');
+
+            options.ignorePinning = true;
+            fix.detectChanges();
+            wrapper = await getExportedData(grid, options);
+            await wrapper.verifyDataFilesContent(actualData.gridFrozenHeaders,
+                'No frozen columns and frozen headers should have been exported!');
+
+            options.freezeHeaders = false;
+            fix.detectChanges();
+            wrapper = await getExportedData(grid, options);
+            await wrapper.verifyDataFilesContent(actualData.gridNameIDJobTitle,
+                'No frozen columns and no frozen headers should have been exported!');
+        });
+
         it('should honor applied sorting.', async () => {
             const fix = TestBed.createComponent(GridIDNameJobTitleComponent);
             fix.detectChanges();
@@ -796,6 +823,13 @@ describe('Excel Exporter', () => {
 
             await exportAndVerify(hGrid, options, actualData.exportHierarchicalDataWithExpandedRows);
         });
+
+        it('should export hierarchical grid data with frozen headers', async () => {
+            options.freezeHeaders = true;
+            fix.detectChanges();
+
+            await exportAndVerify(hGrid, options, actualData.exportHierarchicalDataWithFrozenHeaders);
+        });
     });
 
     describe('', () => {
@@ -1043,6 +1077,12 @@ describe('Excel Exporter', () => {
 
             await exportAndVerify(grid, options, actualData.exportMultiColumnHeadersDataWithoutMultiColumnHeaders);
         });
+
+        it('should export grid with frozen multi column headers', async () => {
+            options.freezeHeaders = true;
+            fix.detectChanges();
+            await exportAndVerify(grid, options, actualData.exportFrozenMultiColumnHeadersData, false);
+        });
     });
 
     const getExportedData = (grid, exportOptions: IgxExcelExporterOptions) => {

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

@@ -151,6 +151,9 @@ export class WorksheetFile implements IExcelFile {
                 sheetData += `</row>`;
             }
 
+            const multiColumnHeaderLevel = worksheetData.options.ignoreMultiColumnHeaders ? 0 : owner.maxLevel;
+            const freezeHeaders = worksheetData.options.freezeHeaders ? 2 + multiColumnHeaderLevel : 1;
+
             if (!isHierarchicalGrid) {
                 this.dimension =
                     'A1:' + ExcelStrings.getExcelColumn(worksheetData.columnCount - 1) + (worksheetData.rowCount + owner.maxLevel);
@@ -177,18 +180,29 @@ export class WorksheetFile implements IExcelFile {
                 cols += '</cols>';
 
                 const indexOfLastPinnedColumn = worksheetData.indexOfLastPinnedColumn;
-
+                const frozenColumnCount = indexOfLastPinnedColumn + 1;
+                let firstCell = ExcelStrings.getExcelColumn(frozenColumnCount) + freezeHeaders;
                 if (indexOfLastPinnedColumn !== -1 &&
                     !worksheetData.options.ignorePinning &&
                     !worksheetData.options.ignoreColumnsOrder) {
-                    const frozenColumnCount = indexOfLastPinnedColumn + 1;
-                    const firstCell = ExcelStrings.getExcelColumn(frozenColumnCount) + '1';
                     this.freezePane =
-                        `<pane xSplit="${frozenColumnCount}" topLeftCell="${firstCell}" activePane="topRight" state="frozen"/>`;
+                        `<pane xSplit="${frozenColumnCount}" ySplit="${freezeHeaders - 1}"
+                         topLeftCell="${firstCell}" activePane="topRight" state="frozen"/>`;
+                } else if (worksheetData.options.freezeHeaders) {
+                    firstCell = ExcelStrings.getExcelColumn(0) + freezeHeaders;
+                    this.freezePane =
+                        `<pane xSplit="0" ySplit="${freezeHeaders - 1}"
+                         topLeftCell="${firstCell}" activePane="topRight" state="frozen"/>`;
                 }
             } else {
                 const columnWidth = worksheetData.options.columnWidth ? worksheetData.options.columnWidth : 20;
                 cols += `<cols><col min="1" max="${worksheetData.columnCount}" width="${columnWidth}" customWidth="1"/></cols>`;
+                if (worksheetData.options.freezeHeaders) {
+                    const firstCell = ExcelStrings.getExcelColumn(0) + freezeHeaders;
+                    this.freezePane =
+                        `<pane xSplit="0" ySplit="${freezeHeaders - 1}"
+                         topLeftCell="${firstCell}" activePane="topRight" state="frozen"/>`;
+                }
             }
 
             this.processDataRecordsAsync(worksheetData, (rows) => {