@slickgrid-universal/excel-export 5.0.1 → 5.2.0

package/dist/types/excelExport.service.d.ts

@@ -19,14 +19,14 @@ export declare class ExcelExportService implements ExternalResource, BaseExcelEx
     protected _workbook: Workbook;
     protected _regularCellExcelFormats: {
         [fieldId: string]: {
-            stylesheetFormatterId?: number;
+            excelFormatId?: number;
             getDataValueParser: GetDataValueCallback;
         };
     };
     protected _groupTotalExcelFormats: {
         [fieldId: string]: {
             groupType: string;
-            stylesheetFormatter?: ExcelFormatter;
+            excelFormat?: ExcelFormatter;
             getGroupTotalParser?: GetGroupTotalValueCallback;
         };
     };
@@ -39,19 +39,8 @@ export declare class ExcelExportService implements ExternalResource, BaseExcelEx
     protected get _gridOptions(): GridOption;
     get stylesheet(): StyleSheet;
     get stylesheetFormats(): any;
-    get groupTotalExcelFormats(): {
-        [fieldId: string]: {
-            groupType: string;
-            stylesheetFormatter?: ExcelFormatter | undefined;
-            getGroupTotalParser?: GetGroupTotalValueCallback | undefined;
-        };
-    };
-    get regularCellExcelFormats(): {
-        [fieldId: string]: {
-            stylesheetFormatterId?: number | undefined;
-            getDataValueParser: GetDataValueCallback;
-        };
-    };
+    get groupTotalExcelFormats(): any;
+    get regularCellExcelFormats(): any;
     dispose(): void;
     /**
      * Initialize the Export Service
@@ -111,7 +100,7 @@ export declare class ExcelExportService implements ExternalResource, BaseExcelEx
      * @param {Number} row - row index
      * @param {Object} itemObj - item datacontext object
      */
-    protected readRegularRowData(columns: Column[], row: number, itemObj: any): string[];
+    protected readRegularRowData(columns: Column[], row: number, itemObj: any, dataRowIdx: number): string[];
     /**
      * Get the grouped title(s) and its group title formatter, for example if we grouped by salesRep, the returned result would be:: 'Sales Rep: John Dow (2 items)'
      * @param itemObj
@@ -122,6 +111,6 @@ export declare class ExcelExportService implements ExternalResource, BaseExcelEx
      * For example if we grouped by "salesRep" and we have a Sum Aggregator on "sales", then the returned output would be:: ["Sum 123$"]
      * @param itemObj
      */
-    protected readGroupedTotalRows(columns: Column[], itemObj: any): Array<ExcelColumnMetadata | string | number>;
+    protected readGroupedTotalRows(columns: Column[], itemObj: any, dataRowIdx: number): Array<ExcelColumnMetadata | string | number>;
 }
 //# sourceMappingURL=excelExport.service.d.ts.map

package/dist/types/excelExport.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"excelExport.service.d.ts","sourceRoot":"","sources":["../../src/excelExport.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,QAAQ,EACR,KAAK,SAAS,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EACV,MAAM,EACN,gBAAgB,EAChB,kBAAkB,IAAI,sBAAsB,EAC5C,iBAAiB,EACjB,gBAAgB,EAEhB,oBAAoB,EACpB,0BAA0B,EAC1B,UAAU,EACV,YAAY,EACZ,MAAM,EACN,aAAa,EACb,aAAa,EACb,SAAS,EACT,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAKL,QAAQ,EAIT,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,KAAK,cAAc,EAIpB,MAAM,cAAc,CAAC;AAOtB,qBAAa,kBAAmB,YAAW,gBAAgB,EAAE,sBAAsB;IACjF,SAAS,CAAC,WAAW,WAAiB;IACtC,SAAS,CAAC,KAAK,EAAG,SAAS,CAAC;IAC5B,SAAS,CAAC,QAAQ,EAAG,MAAM,CAAC;IAC5B,SAAS,CAAC,qBAAqB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACtD,SAAS,CAAC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAM;IACnD,SAAS,CAAC,wBAAwB,UAAS;IAC3C,SAAS,CAAC,gBAAgB,UAAS;IACnC,SAAS,CAAC,mBAAmB,EAAG,iBAAiB,CAAC;IAClD,SAAS,CAAC,MAAM,EAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,WAAW,EAAG,UAAU,CAAC;IACnC,SAAS,CAAC,kBAAkB,EAAE,GAAG,CAAC;IAClC,SAAS,CAAC,cAAc,EAAE,aAAa,GAAG,IAAI,CAAQ;IACtD,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC5D,SAAS,CAAC,SAAS,EAAG,QAAQ,CAAC;IAG/B,SAAS,CAAC,wBAAwB,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG;YAAE,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAAC,kBAAkB,EAAE,oBAAoB,CAAC;SAAE,CAAC;KAAE,CAAM;IAC/I,SAAS,CAAC,uBAAuB,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,mBAAmB,CAAC,EAAE,cAAc,CAAC;YAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;SAAE,CAAC;KAAE,CAAM;IAE/K,8GAA8G;IAC9G,QAAQ,CAAC,SAAS,wBAAwB;IAE1C,SAAS,KAAK,kBAAkB,IAAI,MAAM,CAEzC;IAED,0CAA0C;IAC1C,IAAI,SAAS,IAAI,aAAa,CAE7B;IAED,iEAAiE;IACjE,SAAS,KAAK,YAAY,IAAI,UAAU,CAEvC;IAED,IAAI,UAAU,eAEb;IAED,IAAI,iBAAiB,QAEpB;IAED,IAAI,sBAAsB;;;;;;MAEzB;IAED,IAAI,uBAAuB;;;;;MAE1B;IAED,OAAO;IAIP;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI;IAa/D;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAwE5D;;;;;;;OAOG;IACH,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAoBnD,SAAS,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,EAAE,GAAG,mBAAmB,EAAE,CAAC;IA8BlE,2EAA2E;IAC3E,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE;IAuBnD;;;;;OAKG;IACH,SAAS,CAAC,gCAAgC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,aAAa,GAAG,KAAK,CAAC,mBAAmB,CAAC;IA2BlH,qDAAqD;IACrD,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,aAAa,GAAG,KAAK,CAAC,mBAAmB,CAAC;IAmBrG,SAAS,CAAC,mBAAmB,IAAI,MAAM,GAAG,IAAI;IAqB9C;;;KAGC;IACD,SAAS,CAAC,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC;IA0B9E;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI;IA0BzE;;OAEG;IACH,SAAS,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAC,CAAC;IA0BnL;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,MAAM,EAAE;IA6GpF;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM;IAYnD;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,GAAG,KAAK,CAAC,mBAAmB,GAAG,MAAM,GAAG,MAAM,CAAC;CAqD9G"}
+{"version":3,"file":"excelExport.service.d.ts","sourceRoot":"","sources":["../../src/excelExport.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,QAAQ,EACR,KAAK,SAAS,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EACV,MAAM,EACN,gBAAgB,EAChB,kBAAkB,IAAI,sBAAsB,EAC5C,iBAAiB,EAEjB,gBAAgB,EAChB,oBAAoB,EACpB,0BAA0B,EAC1B,UAAU,EACV,YAAY,EACZ,MAAM,EACN,aAAa,EACb,aAAa,EACb,SAAS,EACT,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAKL,QAAQ,EAIT,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,KAAK,cAAc,EAIpB,MAAM,cAAc,CAAC;AAOtB,qBAAa,kBAAmB,YAAW,gBAAgB,EAAE,sBAAsB;IACjF,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAiB;IAChD,SAAS,CAAC,KAAK,EAAG,SAAS,CAAC;IAC5B,SAAS,CAAC,QAAQ,EAAG,MAAM,CAAC;IAC5B,SAAS,CAAC,qBAAqB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACtD,SAAS,CAAC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAM;IACnD,SAAS,CAAC,wBAAwB,UAAS;IAC3C,SAAS,CAAC,gBAAgB,UAAS;IACnC,SAAS,CAAC,mBAAmB,EAAG,iBAAiB,CAAC;IAClD,SAAS,CAAC,MAAM,EAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,WAAW,EAAG,UAAU,CAAC;IACnC,SAAS,CAAC,kBAAkB,EAAE,GAAG,CAAC;IAClC,SAAS,CAAC,cAAc,EAAE,aAAa,GAAG,IAAI,CAAQ;IACtD,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC5D,SAAS,CAAC,SAAS,EAAG,QAAQ,CAAC;IAG/B,SAAS,CAAC,wBAAwB,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG;YAAE,aAAa,CAAC,EAAE,MAAM,CAAC;YAAC,kBAAkB,EAAE,oBAAoB,CAAC;SAAE,CAAC;KAAE,CAAM;IACvI,SAAS,CAAC,uBAAuB,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,cAAc,CAAC;YAAC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;SAAE,CAAC;KAAE,CAAM;IAEvK,8GAA8G;IAC9G,QAAQ,CAAC,SAAS,wBAAwB;IAE1C,SAAS,KAAK,kBAAkB,IAAI,MAAM,CAEzC;IAED,0CAA0C;IAC1C,IAAI,SAAS,IAAI,aAAa,CAE7B;IAED,iEAAiE;IACjE,SAAS,KAAK,YAAY,IAAI,UAAU,CAEvC;IAED,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED,IAAI,iBAAiB,IAAI,GAAG,CAE3B;IAED,IAAI,sBAAsB,IAAI,GAAG,CAEhC;IAED,IAAI,uBAAuB,IAAI,GAAG,CAEjC;IAED,OAAO,IAAI,IAAI;IAIf;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI;IAa/D;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAwE5D;;;;;;;OAOG;IACH,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAoBnD,SAAS,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,EAAE,GAAG,mBAAmB,EAAE,CAAC;IA8BlE,2EAA2E;IAC3E,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE;IAuBnD;;;;;OAKG;IACH,SAAS,CAAC,gCAAgC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,aAAa,GAAG,KAAK,CAAC,mBAAmB,CAAC;IA2BlH,qDAAqD;IACrD,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,aAAa,GAAG,KAAK,CAAC,mBAAmB,CAAC;IAmBrG,SAAS,CAAC,mBAAmB,IAAI,MAAM,GAAG,IAAI;IAqB9C;;;KAGC;IACD,SAAS,CAAC,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC;IA0B9E;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI;IA0BzE;;OAEG;IACH,SAAS,CAAC,yBAAyB,CAAC,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,mBAAmB,GAAG,MAAM,CAAC,CAAC;IA0BnL;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE;IA6GxG;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM;IAYnD;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC,mBAAmB,GAAG,MAAM,GAAG,MAAM,CAAC;CAqDlI"}

package/dist/types/excelUtils.d.ts

@@ -8,26 +8,29 @@ export declare const getExcelNumberCallback: GetDataValueCallback;
 /** Parse a number which the user might have provided formatter options (for example a user might have provided { decimalSeparator: ',', thousandSeparator: ' '}) */
 export declare function parseNumberWithFormatterOptions(value: any, column: Column, gridOptions: GridOption): any;
 /** use different Excel Stylesheet Format as per the Field Type */
-export declare function useCellFormatByFieldType(stylesheet: StyleSheet, stylesheetFormatters: any, columnDef: Column, grid: SlickGrid, autoDetect?: boolean): {
-    stylesheetFormatterId: number | undefined;
+export declare function useCellFormatByFieldType(stylesheet: StyleSheet, excelFormats: any, columnDef: Column, grid: SlickGrid, autoDetect?: boolean): {
+    excelFormatId: number | undefined;
     getDataValueParser: GetDataValueCallback;
 };
-export declare function getGroupTotalValue(totals: any, columnDef: Column, groupType: string): any;
+export declare function getGroupTotalValue(totals: any, args: {
+    columnDef: Column;
+    groupType: string;
+}): any;
 /** Get numeric formatter options when defined or use default values (minDecimal, maxDecimal, thousandSeparator, decimalSeparator, wrapNegativeNumber) */
 export declare function getNumericFormatterOptions(columnDef: Column, grid: SlickGrid, formatterType: FormatterType): {
-    minDecimal: any;
-    maxDecimal: any;
-    decimalSeparator: any;
-    thousandSeparator: any;
-    wrapNegativeNumber: any;
-    currencyPrefix: any;
-    currencySuffix: any;
+    minDecimal: number;
+    maxDecimal: number;
+    decimalSeparator: '.' | ',';
+    thousandSeparator: '' | '.' | ',' | '_' | ' ';
+    wrapNegativeNumber: boolean;
+    currencyPrefix: string;
+    currencySuffix: string;
     numberPrefix: string;
     numberSuffix: string;
 };
-export declare function getFormatterNumericDataType(formatter?: Formatter): "currency" | "decimal" | "percent";
-export declare function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, stylesheetFormatters: any, columnDef: Column, grid: SlickGrid, formatterType: FormatterType): {
-    stylesheetFormatter: ExcelFormatter;
+export declare function getFormatterNumericDataType(formatter?: Formatter): 'currency' | 'decimal' | 'percent';
+export declare function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, excelFormats: any, columnDef: Column, grid: SlickGrid, formatterType: FormatterType): {
+    excelFormat: ExcelFormatter;
     groupType: string;
 };
 //# sourceMappingURL=excelUtils.d.ts.map

package/dist/types/excelUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"excelUtils.d.ts","sourceRoot":"","sources":["../../src/excelUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EACV,MAAM,EACN,SAAS,EACT,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,SAAS,EACV,MAAM,6BAA6B,CAAC;AAYrC,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;CAAE,CAAC;AAGtD,eAAO,MAAM,6BAA6B,EAAE,oBAAqC,CAAC;AAClF,eAAO,MAAM,sBAAsB,EAAE,oBAGnC,CAAC;AAEH,oKAAoK;AACpK,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,OAUlG;AAED,kEAAkE;AAClE,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,UAAO;;;EAUhJ;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,OAEnF;AAED,yJAAyJ;AACzJ,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa;;;;;;;;;;EA6C1G;AAED,wBAAgB,2BAA2B,CAAC,SAAS,CAAC,EAAE,SAAS,sCAwBhE;AAED,wBAAgB,+BAA+B,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa;;;EAkFlK"}
+{"version":3,"file":"excelUtils.d.ts","sourceRoot":"","sources":["../../src/excelUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EACV,MAAM,EACN,SAAS,EACT,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,SAAS,EACV,MAAM,6BAA6B,CAAC;AAYrC,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;CAAE,CAAC;AAGtD,eAAO,MAAM,6BAA6B,EAAE,oBAI3C,CAAC;AACF,eAAO,MAAM,sBAAsB,EAAE,oBAGnC,CAAC;AAEH,oKAAoK;AACpK,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,GAAG,GAAG,CAUxG;AAED,kEAAkE;AAClE,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,UAAO,GAAG;IAC1I,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,kBAAkB,EAAE,oBAAoB,CAAC;CAC1C,CAUA;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;CAAE,GAAG,GAAG,CAEpG;AAED,yJAAyJ;AACzJ,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,GAAG;IAC5G,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,GAAG,GAAG,GAAG,CAAC;IAC5B,iBAAiB,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC9C,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB,CA6CA;AAED,wBAAgB,2BAA2B,CAAC,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAwBrG;AAED,wBAAgB,+BAA+B,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,GAAG;IAC5J,WAAW,EAAE,cAAc,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB,CAkFA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slickgrid-universal/excel-export",
-  "version": "5.0.1",
+  "version": "5.2.0",
   "description": "Excel Export (xls/xlsx) Service.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -38,13 +38,13 @@
     "not dead"
   ],
   "dependencies": {
-    "@slickgrid-universal/common": "~5.0.1",
-    "@slickgrid-universal/utils": "~5.0.0",
+    "@slickgrid-universal/common": "~5.2.0",
+    "@slickgrid-universal/utils": "~5.2.0",
     "excel-builder-vanilla": "^3.0.1"
   },
   "funding": {
     "type": "ko_fi",
     "url": "https://ko-fi.com/ghiscoding"
   },
-  "gitHead": "4affd2ca9e921166883822938f0cfae05ab2b447"
+  "gitHead": "d7de27ab3ac3c7e2d48302603ac76aaf794e66a2"
 }

package/src/excelExport.service.ts

@@ -11,8 +11,8 @@ import type {
   ContainerService,
   ExcelExportService as BaseExcelExportService,
   ExcelExportOption,
+  ExcelGroupValueParserArgs,
   ExternalResource,
-
   GetDataValueCallback,
   GetGroupTotalValueCallback,
   GridOption,
@@ -48,7 +48,7 @@ const DEFAULT_EXPORT_OPTIONS: ExcelExportOption = {
 };
 
 export class ExcelExportService implements ExternalResource, BaseExcelExportService {
-  protected _fileFormat = FileType.xlsx;
+  protected _fileFormat: FileType = FileType.xlsx;
   protected _grid!: SlickGrid;
   protected _locales!: Locale;
   protected _groupedColumnHeaders?: Array<KeyTitlePair>;
@@ -64,8 +64,8 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
   protected _workbook!: Workbook;
 
   // references of each detected cell and/or group total formats
-  protected _regularCellExcelFormats: { [fieldId: string]: { stylesheetFormatterId?: number; getDataValueParser: GetDataValueCallback; }; } = {};
-  protected _groupTotalExcelFormats: { [fieldId: string]: { groupType: string; stylesheetFormatter?: ExcelFormatter; getGroupTotalParser?: GetGroupTotalValueCallback; }; } = {};
+  protected _regularCellExcelFormats: { [fieldId: string]: { excelFormatId?: number; getDataValueParser: GetDataValueCallback; }; } = {};
+  protected _groupTotalExcelFormats: { [fieldId: string]: { groupType: string; excelFormat?: ExcelFormatter; getGroupTotalParser?: GetGroupTotalValueCallback; }; } = {};
 
   /** ExcelExportService class name which is use to find service instance in the external registered services */
   readonly className = 'ExcelExportService';
@@ -84,23 +84,23 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
     return this._grid?.getOptions() || {} as GridOption;
   }
 
-  get stylesheet() {
+  get stylesheet(): StyleSheet {
     return this._stylesheet;
   }
 
-  get stylesheetFormats() {
+  get stylesheetFormats(): any {
     return this._stylesheetFormats;
   }
 
-  get groupTotalExcelFormats() {
+  get groupTotalExcelFormats(): any {
     return this._groupTotalExcelFormats;
   }
 
-  get regularCellExcelFormats() {
+  get regularCellExcelFormats(): any {
     return this._regularCellExcelFormats;
   }
 
-  dispose() {
+  dispose(): void {
     this._pubSubService?.unsubscribeAll();
   }
 
@@ -155,15 +155,15 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
       this._stylesheet = this._workbook.getStyleSheet();
 
       // create some common default Excel formatters that will be used
-      const boldFormatter = this._stylesheet.createFormat({ font: { bold: true } });
-      const stringFormatter = this._stylesheet.createFormat({ format: '@' });
-      const numberFormatter = this._stylesheet.createFormat({ format: '0' });
+      const boldFormat = this._stylesheet.createFormat({ font: { bold: true } });
+      const stringFormat = this._stylesheet.createFormat({ format: '@' });
+      const numberFormat = this._stylesheet.createFormat({ format: '0' });
       this._stylesheetFormats = {
-        boldFormatter,
-        numberFormatter,
-        stringFormatter,
+        boldFormat,
+        numberFormat,
+        stringFormat,
       };
-      this._sheet.setColumnFormats([boldFormatter]);
+      this._sheet.setColumnFormats([boldFormat]);
 
       // get the CSV output from the grid data
       const dataOutput = this.getDataOutput();
@@ -238,7 +238,7 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
     const outputData: Array<string[] | ExcelColumnMetadata[]> = [];
     const gridExportOptions = this._gridOptions?.excelExportOptions;
     const columnHeaderStyle = gridExportOptions?.columnHeaderStyle;
-    let columnHeaderStyleId = this._stylesheetFormats.boldFormatter.id;
+    let columnHeaderStyleId = this._stylesheetFormats.boldFormat.id;
     if (columnHeaderStyle) {
       columnHeaderStyleId = this._stylesheet.createFormat(columnHeaderStyle).id;
     }
@@ -435,13 +435,13 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
         // Normal row (not grouped by anything) would have an ID which was predefined in the Grid Columns definition
         if (itemObj[this._datasetIdPropName] !== null && itemObj[this._datasetIdPropName] !== undefined) {
           // get regular row item data
-          originalDaraArray.push(this.readRegularRowData(columns, rowNumber, itemObj));
+          originalDaraArray.push(this.readRegularRowData(columns, rowNumber, itemObj, rowNumber));
         } else if (this._hasGroupedItems && itemObj.__groupTotals === undefined) {
           // get the group row
           originalDaraArray.push([this.readGroupedRowTitle(itemObj)]);
         } else if (itemObj.__groupTotals) {
           // else if the row is a Group By and we have agreggators, then a property of '__groupTotals' would exist under that object
-          originalDaraArray.push(this.readGroupedTotalRows(columns, itemObj));
+          originalDaraArray.push(this.readGroupedTotalRows(columns, itemObj, rowNumber));
         }
       }
     }
@@ -454,7 +454,7 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
    * @param {Number} row - row index
    * @param {Object} itemObj - item datacontext object
    */
-  protected readRegularRowData(columns: Column[], row: number, itemObj: any): string[] {
+  protected readRegularRowData(columns: Column[], row: number, itemObj: any, dataRowIdx: number): string[] {
     let idx = 0;
     const rowOutputStrings = [];
     const columnsLn = columns.length;
@@ -539,7 +539,7 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
           const cellStyleFormat = useCellFormatByFieldType(this._stylesheet, this._stylesheetFormats, columnDef, this._grid, autoDetectCellFormat);
           // user could also override style and/or valueParserCallback
           if (columnDef.excelExportOptions?.style) {
-            cellStyleFormat.stylesheetFormatterId = this._stylesheet.createFormat(columnDef.excelExportOptions.style).id;
+            cellStyleFormat.excelFormatId = this._stylesheet.createFormat(columnDef.excelExportOptions.style).id;
           }
           if (columnDef.excelExportOptions?.valueParserCallback) {
             cellStyleFormat.getDataValueParser = columnDef.excelExportOptions.valueParserCallback;
@@ -552,8 +552,8 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
           itemData = stripTags(itemData as string);
         }
 
-        const { stylesheetFormatterId, getDataValueParser } = this._regularCellExcelFormats[columnDef.id];
-        itemData = getDataValueParser(itemData, columnDef, stylesheetFormatterId, this._stylesheet, this._gridOptions);
+        const { excelFormatId, getDataValueParser } = this._regularCellExcelFormats[columnDef.id];
+        itemData = getDataValueParser(itemData, { columnDef, excelFormatId, stylesheet: this._stylesheet, gridOptions: this._gridOptions, dataRowIdx, dataContext: itemObj });
 
         rowOutputStrings.push(itemData);
         idx++;
@@ -584,7 +584,7 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
    * For example if we grouped by "salesRep" and we have a Sum Aggregator on "sales", then the returned output would be:: ["Sum 123$"]
    * @param itemObj
    */
-  protected readGroupedTotalRows(columns: Column[], itemObj: any): Array<ExcelColumnMetadata | string | number> {
+  protected readGroupedTotalRows(columns: Column[], itemObj: any, dataRowIdx: number): Array<ExcelColumnMetadata | string | number> {
     const groupingAggregatorRowText = this._excelExportOptions.groupingAggregatorRowText || '';
     const outputStrings: Array<ExcelColumnMetadata | string | number> = [groupingAggregatorRowText];
 
@@ -607,17 +607,17 @@ export class ExcelExportService implements ExternalResource, BaseExcelExportServ
         if (!groupCellFormat?.groupType) {
           groupCellFormat = getExcelFormatFromGridFormatter(this._stylesheet, this._stylesheetFormats, columnDef, this._grid, 'group');
           if (columnDef.groupTotalsExcelExportOptions?.style) {
-            groupCellFormat.stylesheetFormatter = this._stylesheet.createFormat(columnDef.groupTotalsExcelExportOptions.style);
+            groupCellFormat.excelFormat = this._stylesheet.createFormat(columnDef.groupTotalsExcelExportOptions.style);
           }
           this._groupTotalExcelFormats[columnDef.id] = groupCellFormat;
         }
 
         const groupTotalParser = columnDef.groupTotalsExcelExportOptions?.valueParserCallback ?? getGroupTotalValue;
         if (itemObj[groupCellFormat.groupType]?.[columnDef.field] !== undefined) {
-          itemData = {
-            value: groupTotalParser(itemObj, columnDef, groupCellFormat.groupType, this._stylesheet),
-            metadata: { style: groupCellFormat.stylesheetFormatter?.id }
-          };
+          const groupData = groupTotalParser(itemObj, { columnDef, groupType: groupCellFormat.groupType, excelFormatId: groupCellFormat.excelFormat?.id, stylesheet: this._stylesheet, dataRowIdx } as ExcelGroupValueParserArgs);
+          itemData = (typeof groupData === 'object' && groupData.hasOwnProperty('metadata'))
+            ? groupData
+            : itemData = { value: groupData, metadata: { style: groupCellFormat.excelFormat?.id } };
         }
       } else if (columnDef.groupTotalsFormatter) {
         const totalResult = columnDef.groupTotalsFormatter(itemObj, columnDef, this._grid);

package/src/excelUtils.ts

@@ -21,14 +21,18 @@ import { stripTags } from '@slickgrid-universal/utils';
 export type ExcelFormatter = object & { id: number; };
 
 // define all type of potential excel data function callbacks
-export const getExcelSameInputDataCallback: GetDataValueCallback = (data) => data;
-export const getExcelNumberCallback: GetDataValueCallback = (data, column, excelFormatterId, _excelSheet, gridOptions) => ({
-  value: typeof data === 'string' && /\d/g.test(data) ? parseNumberWithFormatterOptions(data, column, gridOptions) : data,
-  metadata: { style: excelFormatterId }
+export const getExcelSameInputDataCallback: GetDataValueCallback = (data, { excelFormatId }) => {
+  return excelFormatId !== undefined
+    ? { value: data, metadata: { style: excelFormatId } }
+    : data;
+};
+export const getExcelNumberCallback: GetDataValueCallback = (data, { columnDef, excelFormatId, gridOptions }) => ({
+  value: typeof data === 'string' && /\d/g.test(data) ? parseNumberWithFormatterOptions(data, columnDef, gridOptions) : data,
+  metadata: { style: excelFormatId }
 });
 
 /** Parse a number which the user might have provided formatter options (for example a user might have provided { decimalSeparator: ',', thousandSeparator: ' '}) */
-export function parseNumberWithFormatterOptions(value: any, column: Column, gridOptions: GridOption) {
+export function parseNumberWithFormatterOptions(value: any, column: Column, gridOptions: GridOption): any {
   let outValue = value;
   if (typeof value === 'string' && value) {
     const decimalSeparator = getValueFromParamsOrFormatterOptions('decimalSeparator', column, gridOptions, Constants.DEFAULT_NUMBER_DECIMAL_SEPARATOR);
@@ -41,24 +45,37 @@ export function parseNumberWithFormatterOptions(value: any, column: Column, grid
 }
 
 /** use different Excel Stylesheet Format as per the Field Type */
-export function useCellFormatByFieldType(stylesheet: StyleSheet, stylesheetFormatters: any, columnDef: Column, grid: SlickGrid, autoDetect = true) {
+export function useCellFormatByFieldType(stylesheet: StyleSheet, excelFormats: any, columnDef: Column, grid: SlickGrid, autoDetect = true): {
+  excelFormatId: number | undefined;
+  getDataValueParser: GetDataValueCallback;
+} {
   const fieldType = getColumnFieldType(columnDef);
-  let stylesheetFormatterId: number | undefined;
+  let excelFormatId: number | undefined;
   let callback: GetDataValueCallback = getExcelSameInputDataCallback;
 
   if (fieldType === FieldType.number && autoDetect) {
-    stylesheetFormatterId = getExcelFormatFromGridFormatter(stylesheet, stylesheetFormatters, columnDef, grid, 'cell').stylesheetFormatter.id;
+    excelFormatId = getExcelFormatFromGridFormatter(stylesheet, excelFormats, columnDef, grid, 'cell').excelFormat.id;
     callback = getExcelNumberCallback;
   }
-  return { stylesheetFormatterId, getDataValueParser: callback };
+  return { excelFormatId, getDataValueParser: callback };
 }
 
-export function getGroupTotalValue(totals: any, columnDef: Column, groupType: string) {
-  return totals?.[groupType]?.[columnDef.field] ?? 0;
+export function getGroupTotalValue(totals: any, args: { columnDef: Column, groupType: string; }): any {
+  return totals?.[args.groupType]?.[args.columnDef.field] ?? 0;
 }
 
 /** Get numeric formatter options when defined or use default values (minDecimal, maxDecimal, thousandSeparator, decimalSeparator, wrapNegativeNumber) */
-export function getNumericFormatterOptions(columnDef: Column, grid: SlickGrid, formatterType: FormatterType) {
+export function getNumericFormatterOptions(columnDef: Column, grid: SlickGrid, formatterType: FormatterType): {
+  minDecimal: number;
+  maxDecimal: number;
+  decimalSeparator: '.' | ',';
+  thousandSeparator: '' | '.' | ',' | '_' | ' ';
+  wrapNegativeNumber: boolean;
+  currencyPrefix: string;
+  currencySuffix: string;
+  numberPrefix: string;
+  numberSuffix: string;
+} {
   let dataType: 'currency' | 'decimal' | 'percent' | 'regular';
 
   if (formatterType === 'group') {
@@ -105,7 +122,7 @@ export function getNumericFormatterOptions(columnDef: Column, grid: SlickGrid, f
   return retrieveFormatterOptions(columnDef, grid, dataType!, formatterType);
 }
 
-export function getFormatterNumericDataType(formatter?: Formatter) {
+export function getFormatterNumericDataType(formatter?: Formatter): 'currency' | 'decimal' | 'percent' {
   let dataType: 'currency' | 'decimal' | 'percent' | 'regular';
 
   switch (formatter) {
@@ -131,10 +148,13 @@ export function getFormatterNumericDataType(formatter?: Formatter) {
   return dataType;
 }
 
-export function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, stylesheetFormatters: any, columnDef: Column, grid: SlickGrid, formatterType: FormatterType) {
+export function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, excelFormats: any, columnDef: Column, grid: SlickGrid, formatterType: FormatterType): {
+  excelFormat: ExcelFormatter;
+  groupType: string;
+} {
   let format = '';
-  let groupType = '';
-  let stylesheetFormatter: undefined | ExcelFormatter;
+  let groupType = columnDef.groupTotalsExcelExportOptions?.groupType || '';
+  let excelFormat: undefined | ExcelFormatter;
   const fieldType = getColumnFieldType(columnDef);
 
   if (formatterType === 'group') {
@@ -163,7 +183,7 @@ export function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, styleshe
         groupType = 'sum';
         break;
       default:
-        stylesheetFormatter = stylesheetFormatters.numberFormatter;
+        excelFormat = excelFormats.numberFormat;
         break;
     }
   } else {
@@ -174,15 +194,15 @@ export function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, styleshe
             // when formatter is a Formatter.multiple, we need to loop through each of its formatter to find the best possible Excel format
             if (Array.isArray(columnDef.params?.formatters)) {
               for (const formatter of columnDef.params.formatters) {
-                const { stylesheetFormatter: stylesheetFormatterResult } = getExcelFormatFromGridFormatter(stylesheet, stylesheetFormatters, { ...columnDef, formatter } as Column, grid, formatterType);
-                if (stylesheetFormatterResult !== stylesheetFormatters.numberFormatter) {
-                  stylesheetFormatter = stylesheetFormatterResult;
+                const { excelFormat: excelFormatResult } = getExcelFormatFromGridFormatter(stylesheet, excelFormats, { ...columnDef, formatter } as Column, grid, formatterType);
+                if (excelFormatResult !== excelFormats.numberFormat) {
+                  excelFormat = excelFormatResult;
                   break;
                 }
               }
             }
-            if (!stylesheetFormatter) {
-              stylesheetFormatter = stylesheetFormatters.numberFormatter;
+            if (!excelFormat) {
+              excelFormat = excelFormats.numberFormat;
             }
             break;
           case Formatters.currency:
@@ -198,21 +218,21 @@ export function getExcelFormatFromGridFormatter(stylesheet: StyleSheet, styleshe
             format = createExcelFormatFromGridFormatter(columnDef, grid, 'cell');
             break;
           default:
-            stylesheetFormatter = stylesheetFormatters.numberFormatter;
+            excelFormat = excelFormats.numberFormat;
             break;
         }
         break;
     }
   }
 
-  if (!stylesheetFormatter && (columnDef.formatter || columnDef.groupTotalsFormatter)) {
+  if (!excelFormat && (columnDef.formatter || columnDef.groupTotalsFormatter)) {
     format = createExcelFormatFromGridFormatter(columnDef, grid, formatterType, groupType);
-    if (!stylesheetFormatters.hasOwnProperty(format)) {
-      stylesheetFormatters[format] = stylesheet.createFormat({ format }); // save new formatter with its format as a prop key
+    if (!excelFormats.hasOwnProperty(format)) {
+      excelFormats[format] = stylesheet.createFormat({ format }); // save new formatter with its format as a prop key
     }
-    stylesheetFormatter = stylesheetFormatters[format] as ExcelFormatter;
+    excelFormat = excelFormats[format] as ExcelFormatter;
   }
-  return { stylesheetFormatter: stylesheetFormatter as ExcelFormatter, groupType };
+  return { excelFormat: excelFormat as ExcelFormatter, groupType };
 }
 
 // --