@adaptabletools/adaptable 20.0.5-canary.0 → 20.0.6

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

@@ -62,17 +62,26 @@ export type ColumnAggregationModel = {
     aggFunc: string | true;
     weightedColumnId?: string;
 };
-export type AggregationColumnsModelItem = {
+export type AggregationColumnsModel = {
     ColumnId: string;
     AggFunc: ColumnAggregationModel;
-};
-export type AggregationColumnsModel = AggregationColumnsModelItem[];
-export type PivotAggregationColumnsModel = (AggregationColumnsModelItem & {
-    TotalColumn?: boolean | 'before' | 'after' | {
-        PivotColumnId: string;
-        ShowTotal?: boolean | 'before' | 'after';
-    }[];
-})[];
+}[];
+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 interface TableLayoutModel extends BaseLayoutModel {
     TableColumns: string[];
     /**
@@ -87,7 +96,6 @@ export interface TableLayoutModel extends BaseLayoutModel {
      * @defaultValue 'single'
      */
     RowGroupDisplayType?: 'single' | 'multi';
-    PivotAggregationColumns?: never;
     PivotColumns?: never;
     PivotGroupedColumns?: never;
     PivotExpandLevel?: never;
@@ -102,24 +110,13 @@ 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?: PivotAggregationColumnsModel;
+    PivotAggregationColumns?: AggregationColumnsModel;
     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 { ColDef, ColumnState, GridApi, GridOptions, GridState } from 'ag-grid-enterprise';
+import { ColumnState, GridApi, GridOptions, GridState } from 'ag-grid-enterprise';
 import { PivotLayoutModel, TableLayoutModel } from './LayoutManagerModel';
 import { LMEmitter } from './LMEmitter';
 export type LayoutManagerOptions = {
@@ -69,24 +69,7 @@ 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

@@ -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 { simplifyLayoutModel, simplifyPivotLayoutModel, simplifyTableLayoutModel, } from './simplifyLayoutModel';
+import { simplifyTableLayoutModel, simplifyPivotLayoutModel, simplifyLayoutModel, } from './simplifyLayoutModel';
 import { sortColumnIdsByOrder } from './sortColumnIdsByOrder';
 function flattenColDefs(colDefs) {
     const res = [];
@@ -117,12 +117,8 @@ 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() {
@@ -256,18 +252,6 @@ 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() {
@@ -288,7 +272,7 @@ export class LayoutManager extends LMEmitter {
         let ColumnPinning = {};
         const gridState = this.gridApi.getState();
         const prevLayout = this.currentLayout;
-        const prevAggColumns = prevLayout?.TableAggregationColumns ?? prevLayout?.PivotAggregationColumns;
+        const prevAggColumns = prevLayout?.TableAggregationColumns;
         const prevAggColumnsMap = prevAggColumns?.reduce((acc, agg) => {
             acc[agg.ColumnId] = agg;
             return acc;
@@ -999,7 +983,6 @@ 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
@@ -1027,50 +1010,6 @@ 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();
@@ -1106,229 +1045,4 @@ 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;
-            }
-            // 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 (!isPivotLayoutModel(this.currentLayout)) {
-                return;
-            }
-            this.patchPivotTotalColumn(colGroupDef);
-        });
-    }
-    isPivotRowTotalColDef(colDef) {
-        return colDef.colId?.startsWith('PivotRowTotal_');
-    }
-    patchGrandTotalColumn(resultColDef) {
-        if (!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 (!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 (!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',
-            };
-        }
-    }
 }

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

@@ -139,9 +139,6 @@ 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) {