@adaptabletools/adaptable 20.0.5 → 20.0.7-canary.0

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

@@ -3,8 +3,10 @@ import { isPivotLayoutModel } from './isPivotLayoutModel';
 import { LMEmitter } from './LMEmitter';
 import { GROUP_COLUMN_ID__MULTI_PREFIX, GROUP_COLUMN_ID__SINGLE, normalizeLayoutModel, normalizePivotLayoutModel, normalizeTableLayoutModel, } from './normalizeLayoutModel';
 import { isLayoutEqual } from './isLayoutEqual';
-import { simplifyTableLayoutModel, simplifyPivotLayoutModel, simplifyLayoutModel, } from './simplifyLayoutModel';
+import { simplifyLayoutModel, simplifyPivotLayoutModel, simplifyTableLayoutModel, } from './simplifyLayoutModel';
 import { sortColumnIdsByOrder } from './sortColumnIdsByOrder';
+import { destructurePivotColumnId } from './destructurePivotColumnId';
+import { isPivotTotalColumn } from './isPivotTotalColumn';
 function flattenColDefs(colDefs) {
     const res = [];
     const iteration = (c) => {
@@ -117,8 +119,12 @@ export class LayoutManager extends 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() {
@@ -252,6 +258,18 @@ export class LayoutManager extends 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 simplifyPivotLayoutModel(pivotLayout);
     }
     getTableLayoutModelFromGrid() {
@@ -272,7 +290,7 @@ export class LayoutManager extends 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;
@@ -983,6 +1001,7 @@ export class LayoutManager extends 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
@@ -1010,6 +1029,50 @@ export class LayoutManager extends 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();
@@ -1045,4 +1108,107 @@ export class LayoutManager extends LMEmitter {
         }
         return res;
     }
+    setupPivotTotals() {
+        const _original_processPivotResultColDef = this.gridApi.getGridOption('processPivotResultColDef');
+        const _original_processPivotResultColGroupDef = this.gridApi.getGridOption('processPivotResultColGroupDef');
+        this.gridApi.setGridOption('processPivotResultColGroupDef', (colGroupDef) => {
+            _original_processPivotResultColGroupDef?.(colGroupDef);
+            if (!isPivotLayoutModel(this.currentLayout)) {
+                return;
+            }
+            this.patchPivotTotalColumn(colGroupDef);
+        });
+    }
+    isPivotRowTotalColDef(colDef) {
+        return colDef.colId?.startsWith('PivotRowTotal_');
+    }
+    patchPivotTotalColumn(colGroupDef) {
+        const hasPivotTotalCols = (pivotLayout) => {
+            return pivotLayout.PivotAggregationColumns?.some((aggCol) => !!aggCol.TotalColumn);
+        };
+        if (!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 (isPivotTotalColumn(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;
+                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,
+        ];
+    }
+    getPivotTotalColumnConfig(colDef, currentPivotLayout) {
+        const defaultHiddenConfig = {
+            visible: false,
+        };
+        const colIdInfo = destructurePivotColumnId(colDef, {
+            pivotColIds: this.currentLayout.PivotColumns,
+            aggColIds: this.currentLayout.PivotAggregationColumns.map((col) => col.ColumnId),
+        }, (message) => this.warn(message));
+        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',
+            };
+        }
+    }
 }

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

@@ -0,0 +1,2 @@
+import { ColDef } from 'ag-grid-enterprise';
+export declare function isPivotGroupTotalColumn(colDef: ColDef): boolean;

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

@@ -0,0 +1,5 @@
+export function 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('_');
+}

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

@@ -0,0 +1,2 @@
+import { ColDef } from 'ag-grid-enterprise';
+export declare function isPivotTotalColumn(colDef: ColDef): colDef is ColDef;

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

@@ -0,0 +1,3 @@
+export function isPivotTotalColumn(colDef) {
+    return !!colDef.pivotTotalColumnIds?.length;
+}

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

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

package/src/metamodel/adaptable.metamodel.d.ts

@@ -2011,6 +2011,14 @@ export declare const ADAPTABLE_METAMODEL: {
             defVal: string;
             gridInfo?: undefined;
             noCode?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo?: undefined;
+            noCode?: undefined;
+            defVal?: undefined;
         })[];
     };
     ColumnScope: {
@@ -4368,18 +4376,18 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             desc: string;
             isOpt: boolean;
-            ref: string;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
-            isOpt?: undefined;
-            ref?: undefined;
+            isOpt: boolean;
+            ref: string;
         } | {
             name: string;
             kind: string;
             desc: string;
-            isOpt: boolean;
+            isOpt?: undefined;
             ref?: undefined;
         })[];
     };