@adaptabletools/adaptable 20.0.3 → 20.0.4-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.0.3",
+  "version": "20.0.4-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/Common/BaseContext.d.ts

@@ -16,7 +16,7 @@ export interface BaseContext {
      */
     adaptableId: string;
     /**
-     * Custom applicaton Context provided in Adaptable Options
+     * Custom application Context provided in `AdaptableOptions.adaptableContext`
      */
     adaptableContext: any;
     /**

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/LayoutHelpers.js

@@ -197,12 +197,16 @@ export 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'
@@ -326,10 +330,20 @@ export const pivotLayoutModelToPivotLayout = (layoutModel, defaults) => {
     else {
         delete pivotLayout.RowGroupValues;
     }
+    if (layoutModel.GrandTotalRow) {
+        pivotLayout.GrandTotalRow = layoutModel.GrandTotalRow;
+    }
+    if (layoutModel.GrandTotalColumn) {
+        pivotLayout.GrandTotalColumn = layoutModel.GrandTotalColumn;
+    }
+    if (layoutModel.PivotGroupTotalColumn) {
+        pivotLayout.PivotGroupTotalColumn = layoutModel.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/env.js

@@ -1,5 +1,5 @@
 export 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: 1743768026543 || Date.now(),
-    VERSION: "20.0.3" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1744377437477 || Date.now(),
+    VERSION: "20.0.4-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

@@ -69,7 +69,12 @@ 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 patchGrandTotalColumn;
+    private patchPivotTotalColumn;
+    private getPivotTotalColumnConfig;
 }
 export {};

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

@@ -3,7 +3,7 @@ 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';
 function flattenColDefs(colDefs) {
     const res = [];
@@ -117,8 +117,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() {
@@ -272,7 +276,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 +987,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 +1015,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 +1094,118 @@ export class LayoutManager extends LMEmitter {
         }
         return res;
     }
+    setupPivotTotals() {
+        const _original_processPivotResultColDef = this.gridApi.getGridOption('processPivotResultColDef');
+        this.gridApi.setGridOption('processPivotResultColDef', (resulColDef) => {
+            _original_processPivotResultColDef?.(resulColDef);
+            if (!isPivotLayoutModel(this.currentLayout)) {
+                return;
+            }
+            this.patchGrandTotalColumn(resulColDef);
+        });
+        const _original_processPivotResultColGroupDef = this.gridApi.getGridOption('processPivotResultColGroupDef');
+        this.gridApi.setGridOption('processPivotResultColGroupDef', (colGroupDef) => {
+            _original_processPivotResultColGroupDef?.(colGroupDef);
+            if (!isPivotLayoutModel(this.currentLayout)) {
+                return;
+            }
+            this.patchPivotTotalColumn(colGroupDef);
+        });
+    }
+    patchGrandTotalColumn(resultColDef) {
+        if (!isPivotLayoutModel(this.currentLayout) || !this.currentLayout.GrandTotalColumn) {
+            return;
+        }
+        if (resultColDef.colId?.startsWith('PivotRowTotal_')) {
+            resultColDef.headerName = `Grand Total ${resultColDef.headerName}`;
+        }
+    }
+    patchPivotTotalColumn(colGroupDef) {
+        const hasPivotTotalCols = (pivotLayout) => {
+            return pivotLayout.PivotAggregationColumns?.some((aggCol) => !!aggCol.TotalColumn);
+        };
+        const isPivotTotalColDef = (colDef) => {
+            return !!colDef.pivotTotalColumnIds?.length;
+        };
+        if (!isPivotLayoutModel(this.currentLayout) || !hasPivotTotalCols(this.currentLayout)) {
+            return;
+        }
+        const pivotTotalColDefsBefore = [];
+        const pivotTotalColDefsAfter = [];
+        const normalColDefs = [];
+        colGroupDef.children.forEach((colDef) => {
+            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 = [
+            ...pivotTotalColDefsBefore,
+            ...normalColDefs,
+            ...pivotTotalColDefsAfter,
+        ];
+    }
+    getPivotTotalColumnConfig(colDef, currentPivotLayout) {
+        const defaultHiddenConfig = {
+            visible: false,
+        };
+        const colId = colDef.colId;
+        // 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 defaultHiddenConfig;
+        }
+        // e.g.
+        // pivot_country-sport-year_United States-Basketball_gold
+        // pivotColumnIds: ['country', 'sport', 'year']
+        // pivotKeys: ['United States', 'Basketball']
+        // aggregationColumnId: 'gold'
+        const [_pivotPrefix, pivotColsTxt, pivotKeysTxt, aggregationColumnId] = parts;
+        const pivotColumnIds = pivotColsTxt.split('-');
+        const pivotKeys = pivotKeysTxt.split('-');
+        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;
+        }
+        const pivotColumnId = pivotColumnIds[pivotKeys.length - 1];
+        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/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) {