@adaptabletools/adaptable-cjs 20.0.4 → 20.0.5-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-cjs",
-  "version": "20.0.4",
+  "version": "20.0.5-canary.0",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableState/Common/AggregationColumns.d.ts

@@ -12,7 +12,14 @@ export type TableAggregationColumns = {
 /**
  * Defines an Aggregated Column in a Pivot Layout
  */
-export type PivotAggregationColumns = TableAggregationColumns;
+export type PivotAggregationColumns = {
+    ColumnId: string;
+    AggFunc: AggregationColumnValue;
+    TotalColumn?: boolean | 'before' | 'after' | {
+        PivotColumnId: string;
+        ShowTotal?: boolean | 'before' | 'after';
+    }[];
+}[];
 export declare const WEIGHTED_AVERAGE_AGG_FN_NAME = "weightedAvg";
 /**
  * Defines a Weighted Average Agg

package/src/AdaptableState/LayoutState.d.ts

@@ -148,6 +148,18 @@ export interface PivotLayout extends LayoutBase {
      * Row Grouped Columns Columns - must NOT be provided
      */
     RowGroupedColumns?: never;
+    /**
+     * Display Grand Total Row at the top or bottom of the Pivot Table
+     */
+    GrandTotalRow?: 'top' | 'bottom' | boolean;
+    /**
+     * Display automatically calculated Totals of all Pivot Columns, in the position specified
+     */
+    GrandTotalColumn?: 'before' | 'after' | boolean;
+    /**
+     * Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
+     */
+    PivotGroupTotalColumn?: 'before' | 'after' | boolean;
 }
 /**
  * Manages how (and which) Row Group values are stored

package/src/Api/Implementation/ColumnApiImpl.d.ts

@@ -11,6 +11,7 @@ export declare function generateAutoTreeSingleColumn(): AdaptableColumn;
 export declare function generateAutoRowGroupColumnForColumn(column: AdaptableColumn): AdaptableColumn;
 export declare function getFriendlyNameForPivotResultColumn(columnId: string): string;
 export declare function isPivotResultColumn(columnId: string): boolean;
+export declare function isPivotGrandTotalColumn(columnId: string): boolean;
 export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     internalApi: ColumnInternalApi;
     constructor(_adaptable: IAdaptable);

package/src/Api/Implementation/ColumnApiImpl.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColumnApiImpl = exports.isPivotResultColumn = exports.getFriendlyNameForPivotResultColumn = exports.generateAutoRowGroupColumnForColumn = exports.generateAutoTreeSingleColumn = exports.generateAutoRowGroupSingleColumn = exports.isAutoRowGroupColumn = void 0;
+exports.ColumnApiImpl = exports.isPivotGrandTotalColumn = exports.isPivotResultColumn = exports.getFriendlyNameForPivotResultColumn = exports.generateAutoRowGroupColumnForColumn = exports.generateAutoTreeSingleColumn = exports.generateAutoRowGroupSingleColumn = exports.isAutoRowGroupColumn = void 0;
 const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const GeneralConstants = tslib_1.__importStar(require("../../Utilities/Constants/GeneralConstants"));
@@ -71,6 +71,13 @@ function generateAutoRowGroupColumnForColumn(column) {
 }
 exports.generateAutoRowGroupColumnForColumn = generateAutoRowGroupColumnForColumn;
 function getFriendlyNameForPivotResultColumn(columnId) {
+    if (isPivotGrandTotalColumn(columnId)) {
+        return `[Grand Total] ${columnId
+            .split('_')
+            .slice(2)
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+            .join(' ')}`;
+    }
     return `[Pivot] ${columnId
         .split('_')
         .slice(1)
@@ -83,6 +90,10 @@ function isPivotResultColumn(columnId) {
     return columnId?.startsWith(GeneralConstants.AG_GRID_PIVOT_COLUMN);
 }
 exports.isPivotResultColumn = isPivotResultColumn;
+function isPivotGrandTotalColumn(columnId) {
+    return columnId?.startsWith(GeneralConstants.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN);
+}
+exports.isPivotGrandTotalColumn = isPivotGrandTotalColumn;
 class ColumnApiImpl extends ApiBase_1.ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
@@ -146,7 +157,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return isAutoRowGroupColumn(columnId);
     }
     isPivotResultColumn(columnId) {
-        return isPivotResultColumn(columnId);
+        return isPivotResultColumn(columnId) || isPivotGrandTotalColumn(columnId);
     }
     isAutoRowGroupColumnForSingle(columnId) {
         return columnId === normalizeLayoutModel_1.GROUP_COLUMN_ID__SINGLE;

package/src/Api/Implementation/LayoutHelpers.js

@@ -209,12 +209,16 @@ const pivotLayoutToPivotLayoutModel = (pivotLayout) => {
         ColumnPinning: pivotLayout.ColumnPinning,
         PivotColumns: pivotLayout.PivotColumns,
         PivotExpandLevel: pivotLayout.PivotExpandLevel,
-        PivotAggregationColumns: (pivotLayout.PivotAggregationColumns || []).map(({ ColumnId, AggFunc }) => {
+        PivotAggregationColumns: (pivotLayout.PivotAggregationColumns || []).map(({ ColumnId, AggFunc, TotalColumn }) => {
             return {
                 ColumnId,
                 AggFunc: toAggFunc(AggFunc),
+                TotalColumn,
             };
         }),
+        GrandTotalRow: pivotLayout.GrandTotalRow,
+        GrandTotalColumn: pivotLayout.GrandTotalColumn,
+        PivotGroupTotalColumn: pivotLayout.PivotGroupTotalColumn,
         RowGroupValues: pivotLayout.RowGroupValues
             ? pivotLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-collapsed' ||
                 pivotLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-expanded'
@@ -340,10 +344,29 @@ const pivotLayoutModelToPivotLayout = (layoutModel, defaults) => {
     else {
         delete pivotLayout.RowGroupValues;
     }
+    if (layoutModel.GrandTotalRow) {
+        pivotLayout.GrandTotalRow = layoutModel.GrandTotalRow;
+    }
+    else {
+        delete pivotLayout.GrandTotalRow;
+    }
+    if (layoutModel.GrandTotalColumn) {
+        pivotLayout.GrandTotalColumn = layoutModel.GrandTotalColumn;
+    }
+    else {
+        delete pivotLayout.GrandTotalColumn;
+    }
+    if (layoutModel.PivotGroupTotalColumn) {
+        pivotLayout.PivotGroupTotalColumn = layoutModel.PivotGroupTotalColumn;
+    }
+    else {
+        delete pivotLayout.PivotGroupTotalColumn;
+    }
     if (layoutModel.PivotAggregationColumns) {
-        pivotLayout.PivotAggregationColumns = (layoutModel.PivotAggregationColumns || []).map(({ ColumnId, AggFunc }) => ({
+        pivotLayout.PivotAggregationColumns = (layoutModel.PivotAggregationColumns || []).map(({ ColumnId, AggFunc, TotalColumn }) => ({
             ColumnId,
             AggFunc: toAggregationColumnValue(AggFunc),
+            TotalColumn,
         }));
     }
     else {

package/src/Utilities/Constants/GeneralConstants.d.ts

@@ -24,6 +24,7 @@ export declare const GROUP_PATH_SEPARATOR: string;
 export declare const AG_GRID_GROUPED_COLUMN: string;
 export declare const AG_GRID_SELECTION_COLUMN: string;
 export declare const AG_GRID_PIVOT_COLUMN: string;
+export declare const AG_GRID_PIVOT_GRAND_TOTAL_COLUMN: string;
 export declare const AG_GRID_CHART_WINDOW = "AG Grid Window";
 export declare const ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = "(FDC3ActionColumn)";
 export declare const DEFAULT_DATE_FORMAT_PATTERN = "dd-MM-yyyy";

package/src/Utilities/Constants/GeneralConstants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LAYOUT_NEW_PIVOT_TOOLTIP = exports.LAYOUT_NEW_TABLE_TOOLTIP = exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_SELECTION_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
-exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = void 0;
+exports.LAYOUT_NEW_TABLE_TOOLTIP = exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_SELECTION_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
+exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = exports.LAYOUT_NEW_PIVOT_TOOLTIP = void 0;
 exports.AUTOGENERATED_PK_COLUMN = '__ADAPTABLE_PK__';
 exports.MISSING_COLUMN = ' [MISSING]';
 exports.LIGHT_THEME = 'light';
@@ -27,6 +27,7 @@ exports.GROUP_PATH_SEPARATOR = '/';
 exports.AG_GRID_GROUPED_COLUMN = 'ag-Grid-AutoColumn';
 exports.AG_GRID_SELECTION_COLUMN = 'ag-Grid-SelectionColumn';
 exports.AG_GRID_PIVOT_COLUMN = 'pivot_';
+exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = 'PivotRowTotal_pivot_';
 exports.AG_GRID_CHART_WINDOW = 'AG Grid Window';
 exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = '(FDC3ActionColumn)';
 // FIXME AFL - load this from DateInputOptions

package/src/env.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1744726373908 || Date.now(),
-    VERSION: "20.0.4" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1744819299231 || Date.now(),
+    VERSION: "20.0.5-canary.0" || '--current-version--',
 };

package/src/layout-manager/src/LayoutManagerModel.d.ts

@@ -62,26 +62,17 @@ export type ColumnAggregationModel = {
     aggFunc: string | true;
     weightedColumnId?: string;
 };
-export type AggregationColumnsModel = {
+export type AggregationColumnsModelItem = {
     ColumnId: string;
     AggFunc: ColumnAggregationModel;
-}[];
-type RowSummaryPosition = 'Top' | 'Bottom';
-export interface RowSummaryModel {
-    /**
-     * Where Row Summary appears - 'Top' or 'Bottom'
-     */
-    Position?: RowSummaryPosition;
-    /**
-     * Map of Columns with Summary Expressions
-     */
-    ColumnsMap: Record<string, string>;
-    /**
-     * Evaluates only currently filtered rows in the summary
-     * @defaultValue true
-     */
-    IncludeOnlyFilteredRows?: boolean;
-}
+};
+export type AggregationColumnsModel = AggregationColumnsModelItem[];
+export type PivotAggregationColumnsModel = (AggregationColumnsModelItem & {
+    TotalColumn?: boolean | 'before' | 'after' | {
+        PivotColumnId: string;
+        ShowTotal?: boolean | 'before' | 'after';
+    }[];
+})[];
 export interface TableLayoutModel extends BaseLayoutModel {
     TableColumns: string[];
     /**
@@ -96,6 +87,7 @@ export interface TableLayoutModel extends BaseLayoutModel {
      * @defaultValue 'single'
      */
     RowGroupDisplayType?: 'single' | 'multi';
+    PivotAggregationColumns?: never;
     PivotColumns?: never;
     PivotGroupedColumns?: never;
     PivotExpandLevel?: never;
@@ -110,13 +102,24 @@ export interface PivotLayoutModel extends BaseLayoutModel {
     /**
      * Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)
      */
-    PivotAggregationColumns?: AggregationColumnsModel;
+    PivotAggregationColumns?: PivotAggregationColumnsModel;
     TableAggregationColumns?: never;
     /**
      * Columns which are row-grouped when the Layout is applied
      */
     PivotGroupedColumns?: string[];
     RowGroupedColumns?: never;
+    /**
+     * Display Grand Total Row at the top or bottom of the Pivot Table
+     */
+    GrandTotalRow?: 'top' | 'bottom' | boolean;
+    /**
+     * Display Total of all Pivot Columns before or after the Pivot Columns
+     */
+    GrandTotalColumn?: 'before' | 'after' | boolean;
+    /**
+     * Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
+     */
+    PivotGroupTotalColumn?: 'before' | 'after' | boolean;
 }
 export type LayoutModel = TableLayoutModel | PivotLayoutModel;
-export {};

package/src/layout-manager/src/index.d.ts

@@ -1,4 +1,4 @@
-import { ColumnState, GridApi, GridOptions, GridState } from 'ag-grid-enterprise';
+import { ColDef, ColumnState, GridApi, GridOptions, GridState } from 'ag-grid-enterprise';
 import { PivotLayoutModel, TableLayoutModel } from './LayoutManagerModel';
 import { LMEmitter } from './LMEmitter';
 export type LayoutManagerOptions = {
@@ -69,7 +69,24 @@ export declare class LayoutManager<DATA_TYPE = any> extends LMEmitter {
     private computeColumnOrderAndVisibility;
     autoSizeColumns(columnIds?: string[]): false | string[];
     private applyPivotLayout;
+    applyPivotTotals(layout: PivotLayoutModel): void;
     applyPivotExpandLevel(layout: PivotLayoutModel): void;
     private withSuppressColumnAnimation;
+    private setupPivotTotals;
+    private isPivotRowTotalColDef;
+    private patchGrandTotalColumn;
+    private isPivotGroupTotalColumn;
+    private patchPivotGroupTotalColumn;
+    private patchPivotTotalColumn;
+    destructurePivotColumnId(colDef: ColDef, currentModel: {
+        pivotColIds: string[];
+        aggColIds: string[];
+    }): '!unknown!' | {
+        pivotColumnIds: string[];
+        pivotKeys: string[];
+        pivotColumnId: string;
+        aggregationColumnId?: string;
+    };
+    private getPivotTotalColumnConfig;
 }
 export {};

package/src/layout-manager/src/index.js

@@ -120,8 +120,12 @@ class LayoutManager extends LMEmitter_1.LMEmitter {
             }).bind(this);
         }
         this.setOptions(options);
+        // this ensures the grand total columns are positioned correctly (before/after) even when changed at runtime
+        // see https://www.ag-grid.com/react-data-grid/pivoting-column-groups/#changing-data-filters-and-configurations
+        this.gridApi.setGridOption('enableStrictPivotColumnOrder', true);
         this.setupEvents();
         this.indexColumns();
+        this.setupPivotTotals();
         globalThis.layoutManager = this;
     }
     destroy() {
@@ -255,6 +259,18 @@ class LayoutManager extends LMEmitter_1.LMEmitter {
             PivotAggregationColumns: layout.TableAggregationColumns,
             PivotExpandLevel: prevLayout?.PivotExpandLevel ?? -1,
         };
+        const grandTotalRow = this.gridApi.getGridOption('grandTotalRow');
+        if (grandTotalRow) {
+            pivotLayout.GrandTotalRow = grandTotalRow;
+        }
+        const grandTotalColumn = this.gridApi.getGridOption('pivotRowTotals');
+        if (grandTotalColumn) {
+            pivotLayout.GrandTotalColumn = grandTotalColumn;
+        }
+        const pivotGroupTotalColumn = this.gridApi.getGridOption('pivotColumnGroupTotals');
+        if (pivotGroupTotalColumn) {
+            pivotLayout.PivotGroupTotalColumn = pivotGroupTotalColumn;
+        }
         return (0, simplifyLayoutModel_1.simplifyPivotLayoutModel)(pivotLayout);
     }
     getTableLayoutModelFromGrid() {
@@ -275,7 +291,7 @@ class LayoutManager extends LMEmitter_1.LMEmitter {
         let ColumnPinning = {};
         const gridState = this.gridApi.getState();
         const prevLayout = this.currentLayout;
-        const prevAggColumns = prevLayout?.TableAggregationColumns;
+        const prevAggColumns = prevLayout?.TableAggregationColumns ?? prevLayout?.PivotAggregationColumns;
         const prevAggColumnsMap = prevAggColumns?.reduce((acc, agg) => {
             acc[agg.ColumnId] = agg;
             return acc;
@@ -986,6 +1002,7 @@ class LayoutManager extends LMEmitter_1.LMEmitter {
         return columnIds;
     }
     applyPivotLayout(layout, options) {
+        this.applyPivotTotals(layout);
         const columnState = this.computeColumnStateForPivotLayout(layout);
         // by simply calling this.gridApi.applyColumnState(columnState)
         // the order of aggregations is not preserved/guaranteed by ag-grid
@@ -1013,6 +1030,50 @@ class LayoutManager extends LMEmitter_1.LMEmitter {
             this.applyRowGroupValues(layout.RowGroupValues);
         }
     }
+    applyPivotTotals(layout) {
+        /**
+         * GrandTotalRow
+         */
+        if (layout.GrandTotalRow) {
+            const grandTotalRow = layout.GrandTotalRow === true || layout.GrandTotalRow === 'top'
+                ? 'top'
+                : layout.GrandTotalRow === 'bottom'
+                    ? 'bottom'
+                    : null;
+            this.gridApi.setGridOption('grandTotalRow', grandTotalRow);
+        }
+        else {
+            this.gridApi.setGridOption('grandTotalRow', null);
+        }
+        /**
+         * GrandTotalColumn
+         */
+        if (layout.GrandTotalColumn) {
+            const grandTotalColumn = layout.GrandTotalColumn === true || layout.GrandTotalColumn === 'before'
+                ? 'before'
+                : layout.GrandTotalColumn === 'after'
+                    ? 'after'
+                    : null;
+            this.gridApi.setGridOption('pivotRowTotals', grandTotalColumn);
+        }
+        else {
+            this.gridApi.setGridOption('pivotRowTotals', null);
+        }
+        /**
+         * PivotGroupTotalColumn
+         */
+        if (layout.PivotGroupTotalColumn) {
+            const pivotGroupTotalColumn = layout.PivotGroupTotalColumn === true || layout.PivotGroupTotalColumn === 'before'
+                ? 'before'
+                : layout.PivotGroupTotalColumn === 'after'
+                    ? 'after'
+                    : null;
+            this.gridApi.setGridOption('pivotColumnGroupTotals', pivotGroupTotalColumn);
+        }
+        else {
+            this.gridApi.setGridOption('pivotColumnGroupTotals', null);
+        }
+    }
     applyPivotExpandLevel(layout) {
         const PivotExpandLevel = layout.PivotExpandLevel ?? -1;
         const allDisplayedColumnGroups = this.gridApi.getAllDisplayedColumnGroups();
@@ -1048,5 +1109,230 @@ class LayoutManager extends LMEmitter_1.LMEmitter {
         }
         return res;
     }
+    setupPivotTotals() {
+        const _original_processPivotResultColDef = this.gridApi.getGridOption('processPivotResultColDef');
+        this.gridApi.setGridOption('processPivotResultColDef', (resulColDef) => {
+            _original_processPivotResultColDef?.(resulColDef);
+            if (!(0, isPivotLayoutModel_1.isPivotLayoutModel)(this.currentLayout)) {
+                return;
+            }
+            // column that contain the aggregated total for each value column per row
+            this.patchGrandTotalColumn(resulColDef);
+            this.patchPivotGroupTotalColumn(resulColDef);
+        });
+        const _original_processPivotResultColGroupDef = this.gridApi.getGridOption('processPivotResultColGroupDef');
+        this.gridApi.setGridOption('processPivotResultColGroupDef', (colGroupDef) => {
+            _original_processPivotResultColGroupDef?.(colGroupDef);
+            if (!(0, isPivotLayoutModel_1.isPivotLayoutModel)(this.currentLayout)) {
+                return;
+            }
+            this.patchPivotTotalColumn(colGroupDef);
+        });
+    }
+    isPivotRowTotalColDef(colDef) {
+        return colDef.colId?.startsWith('PivotRowTotal_');
+    }
+    patchGrandTotalColumn(resultColDef) {
+        if (!(0, isPivotLayoutModel_1.isPivotLayoutModel)(this.currentLayout) || !this.currentLayout.GrandTotalColumn) {
+            return;
+        }
+        if (this.isPivotRowTotalColDef(resultColDef)) {
+            resultColDef.headerName = `Grand Total ${resultColDef.headerName}`;
+        }
+    }
+    isPivotGroupTotalColumn(colDef) {
+        // pivot group total are spanning cross all aggregations
+        // therefore the last part of the colId is empty (hence the "dangling" underscore)
+        return colDef.colId?.startsWith('pivot_') && colDef.colId?.endsWith('_');
+    }
+    patchPivotGroupTotalColumn(resultColDef) {
+        if (!(0, isPivotLayoutModel_1.isPivotLayoutModel)(this.currentLayout) || !this.currentLayout.PivotGroupTotalColumn) {
+            return;
+        }
+        if (this.isPivotGroupTotalColumn(resultColDef)) {
+            // resultColDef
+            const colInfo = this.destructurePivotColumnId(resultColDef, {
+                pivotColIds: this.currentLayout.PivotColumns,
+                aggColIds: this.currentLayout.PivotAggregationColumns.map((col) => col.ColumnId),
+            });
+            if (colInfo !== '!unknown!') {
+                const currentPivotKey = colInfo.pivotKeys[colInfo.pivotKeys.length - 1];
+                resultColDef.headerName = `${currentPivotKey} Total`;
+            }
+        }
+    }
+    patchPivotTotalColumn(colGroupDef) {
+        const hasPivotTotalCols = (pivotLayout) => {
+            return pivotLayout.PivotAggregationColumns?.some((aggCol) => !!aggCol.TotalColumn);
+        };
+        const isPivotTotalColDef = (colDef) => {
+            return !!colDef.pivotTotalColumnIds?.length;
+        };
+        if (!(0, isPivotLayoutModel_1.isPivotLayoutModel)(this.currentLayout) || !hasPivotTotalCols(this.currentLayout)) {
+            return;
+        }
+        const pivotRowTotalColDefsBefore = [];
+        const pivotRowTotalColDefsAfter = [];
+        const pivotTotalColDefsBefore = [];
+        const pivotTotalColDefsAfter = [];
+        const normalColDefs = [];
+        colGroupDef.children.forEach((colDef) => {
+            if (this.isPivotRowTotalColDef(colDef)) {
+                if (this.gridApi.getGridOption('pivotRowTotals') === 'after') {
+                    pivotRowTotalColDefsAfter.push(colDef);
+                }
+                else {
+                    pivotRowTotalColDefsBefore.push(colDef);
+                }
+                return;
+            }
+            if (isPivotTotalColDef(colDef)) {
+                if (!colDef.colId.startsWith('pivot_')) {
+                    this.warn(`Pivot total column ${colDef.colId} is not prefixed with 'pivot_', skipping...`);
+                    return;
+                }
+                // we do this for all total cols, but we will hide the ones that are not visible
+                colDef.columnGroupShow = undefined;
+                colDef.headerName = `Total ${colDef.headerName}`;
+                const totalColConfig = this.getPivotTotalColumnConfig(colDef, this.currentLayout);
+                if (!totalColConfig.visible) {
+                    colDef.hide = true;
+                }
+                else {
+                    if (totalColConfig.position === 'after') {
+                        pivotTotalColDefsAfter.push(colDef);
+                    }
+                    else {
+                        pivotTotalColDefsBefore.push(colDef);
+                    }
+                }
+            }
+            else {
+                normalColDefs.push(colDef);
+            }
+        });
+        colGroupDef.children = [
+            ...pivotRowTotalColDefsBefore,
+            ...pivotTotalColDefsBefore,
+            ...normalColDefs,
+            ...pivotTotalColDefsAfter,
+            ...pivotRowTotalColDefsAfter,
+        ];
+    }
+    // supports only pivotTotalColumns (aggregation total) and pivotGroupTotal
+    // AG Grid builds the ID as: `pivot_${pivotCols.join('-')}_${pivotKeys.join('-')}_${measureColumnId}`
+    // see https://github.com/ag-grid/ag-grid/blob/e0cfe533b55b75cdc148cdfb1a4e977731dc0712/packages/ag-grid-enterprise/src/pivot/pivotColDefService.ts#L454C16-L454C88
+    destructurePivotColumnId(colDef, currentModel) {
+        const { colId } = colDef;
+        // Basic validation
+        if (!colId?.startsWith('pivot_')) {
+            this.warn(`Column id must start with 'pivot_': ${colId}`);
+            return '!unknown!';
+        }
+        const hasSpecialChars = (arr) => arr.some((str) => str.includes('-') || str.includes('_'));
+        // AG Grid uses _ and - as delimiters
+        // if we have these special characters in the column IDs, we need to parse them differently
+        const colIdsOrKeysContainSpecialChars = hasSpecialChars(currentModel.pivotColIds) ||
+            hasSpecialChars(currentModel.aggColIds) ||
+            hasSpecialChars(colDef.pivotKeys || []);
+        // Fast path - no special characters
+        if (!colIdsOrKeysContainSpecialChars) {
+            // Split by underscore to get 4 parts
+            const parts = colId.split('_');
+            if (parts.length !== 4) {
+                this.warn(`Unsupported format of pivot total column id: ${colId}`);
+                return '!unknown!';
+            }
+            const [_pivotPrefix, pivotColsTxt, pivotKeysTxt, aggregationColumnId] = parts;
+            const pivotColumnIds = pivotColsTxt.split('-');
+            const pivotKeys = pivotKeysTxt.split('-');
+            const pivotColumnId = pivotColumnIds[pivotKeys.length - 1];
+            return {
+                pivotColumnIds,
+                pivotKeys,
+                pivotColumnId,
+                aggregationColumnId: aggregationColumnId !== '' ? aggregationColumnId : undefined,
+            };
+        }
+        // the complex path, where we have to handle the special characters
+        // Remove 'pivot_' prefix
+        const withoutPrefix = colId.slice(6);
+        // Check if it's a pivot group total
+        const isPivotGroupTotal = withoutPrefix.endsWith('_');
+        // Get pivot keys from colDef (more reliable than string parsing)
+        const pivotKeys = colDef.pivotKeys || [];
+        if (isPivotGroupTotal) {
+            // Remove trailing underscore for pivot group totals
+            const content = withoutPrefix.slice(0, -1);
+            // The remaining content should be the pivot columns
+            const pivotColumnIds = currentModel.pivotColIds.filter((id) => content.includes(id));
+            if (!pivotColumnIds.length) {
+                this.warn(`Could not identify pivot columns in: ${content}`);
+                return '!unknown!';
+            }
+            return {
+                pivotColumnIds,
+                pivotKeys,
+                pivotColumnId: pivotColumnIds[pivotKeys.length],
+            };
+        }
+        // For regular pivot columns, work backwards to find aggregation column
+        const parts = withoutPrefix.split('_');
+        const lastPart = parts[parts.length - 1];
+        // Find the longest matching aggregation column id from the end
+        const aggregationColumnId = currentModel.aggColIds.find((aggId) => lastPart.endsWith(aggId));
+        if (!aggregationColumnId) {
+            this.warn(`Could not identify aggregation column in: ${lastPart}`);
+            return '!unknown!';
+        }
+        // Remove aggregation part and get pivot columns
+        const withoutAgg = withoutPrefix.slice(0, -(aggregationColumnId.length + 1));
+        const pivotColumnIds = currentModel.pivotColIds.filter((id) => withoutAgg.includes(id));
+        if (!pivotColumnIds.length) {
+            this.warn(`Could not identify pivot columns in: ${withoutAgg}`);
+            return '!unknown!';
+        }
+        return {
+            pivotColumnIds,
+            pivotKeys,
+            pivotColumnId: pivotColumnIds[pivotKeys.length - 1],
+            aggregationColumnId,
+        };
+    }
+    getPivotTotalColumnConfig(colDef, currentPivotLayout) {
+        const defaultHiddenConfig = {
+            visible: false,
+        };
+        const colIdInfo = this.destructurePivotColumnId(colDef, {
+            pivotColIds: this.currentLayout.PivotColumns,
+            aggColIds: this.currentLayout.PivotAggregationColumns.map((col) => col.ColumnId),
+        });
+        if (colIdInfo === '!unknown!') {
+            return defaultHiddenConfig;
+        }
+        const { pivotColumnId, aggregationColumnId } = colIdInfo;
+        const layoutAggCol = currentPivotLayout.PivotAggregationColumns?.find((col) => col.ColumnId === aggregationColumnId);
+        if (!layoutAggCol) {
+            this.warn(`Pivot Totals: could NOT find aggregation(value) column with id ${aggregationColumnId}`);
+            return defaultHiddenConfig;
+        }
+        const layoutPivotTotalColumn = layoutAggCol.TotalColumn;
+        if (!layoutPivotTotalColumn) {
+            return defaultHiddenConfig;
+        }
+        if (Array.isArray(layoutPivotTotalColumn)) {
+            const pivotSpecificConfig = layoutPivotTotalColumn.find((config) => config.PivotColumnId === pivotColumnId);
+            return {
+                visible: pivotSpecificConfig && pivotSpecificConfig.ShowTotal !== false,
+                position: pivotSpecificConfig?.ShowTotal === 'after' ? 'after' : 'before',
+            };
+        }
+        else {
+            return {
+                visible: !!layoutPivotTotalColumn,
+                position: layoutPivotTotalColumn === 'after' ? 'after' : 'before',
+            };
+        }
+    }
 }
 exports.LayoutManager = LayoutManager;

package/src/layout-manager/src/normalizeLayoutModel.js

@@ -144,6 +144,9 @@ function normalizePivotLayoutModel(layout) {
         // make it an own property
         layout.SuppressAggFuncInHeader = undefined;
     }
+    if (!layout.GrandTotalRow) {
+        layout.GrandTotalRow = false;
+    }
     return layout;
 }
 exports.normalizePivotLayoutModel = normalizePivotLayoutModel;