@adaptabletools/adaptable 20.2.1 → 20.2.2

package/src/agGrid/AdaptableAgGrid.js

@@ -90,7 +90,7 @@ import { weightedAverage } from '../Utilities/weightedAverage';
 import { ROW_SUMMARY_ROW_ID } from '../AdaptableState/Common/RowSummary';
 import { FlashingCellService } from '../Utilities/Services/FlashingCellService';
 import { AgGridExportAdapter } from './AgGridExportAdapter';
-import { checkForDuplicateColumns, isPivotLayout, layoutModelToLayoutState, layoutStateToLayoutModel, normalizeLayout, } from '../Api/Implementation/LayoutHelpers';
+import { checkForDuplicateColumns, getLayoutRowGroupValuesExceptionGroupKeys, isPivotLayout, layoutModelToLayoutState, layoutStateToLayoutModel, normalizeLayout, } from '../Api/Implementation/LayoutHelpers';
 import { LayoutManager } from '../layout-manager/src';
 import { isPivotLayoutModel } from '../layout-manager/src/isPivotLayoutModel';
 import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE, PIVOT_ANY_TOTAL_COLUMN_TYPE, PIVOT_COLUMN_TOTAL_COLUMN_TYPE, PIVOT_GRAND_TOTAL_COLUMN_TYPE, } from '../AdaptableState/Common/AdaptableColumn';
@@ -449,7 +449,7 @@ export class AdaptableAgGrid {
             this.updateColumnModelAndRefreshGrid();
         }
         const layoutModelForApply = layoutStateToLayoutModel(currentLayout);
-        this.layoutManager.applyRowGroupValues(layoutModelForApply.RowGroupValues);
+        this.layoutManager.applyRowGroupValues(layoutModelForApply.RowGroupValues, layoutModelForApply.RowGroupedColumns);
         this.layoutManager.applyColumnGroupCollapseExpandState(layoutModelForApply);
         this.autoSizeLayoutIfNeeded();
         this.ModuleService.createModuleUIItems();
@@ -2014,7 +2014,7 @@ You need to define at least one Layout!`);
             layout = this.api.layoutApi.getCurrentLayout();
         }
         const layoutModel = layoutStateToLayoutModel(layout);
-        this.layoutManager.applyRowGroupValues(layoutModel.RowGroupValues);
+        this.layoutManager.applyRowGroupValues(layoutModel.RowGroupValues, layoutModel.RowGroupedColumns);
     }
     isGroupRowNode(rowNode) {
         if (!rowNode) {
@@ -3107,12 +3107,23 @@ You need to define at least one Layout!`);
         checkForDuplicateColumns(layout);
         const isLayoutSwitch = this._prevLayout && layout.Name != this._prevLayout.Name;
         let shouldUpdateExpandState = isLayoutSwitch;
-        if (!isLayoutSwitch &&
-            this._prevLayout &&
-            layout.RowGroupValues?.RowGroupDefaultBehavior &&
-            this._prevLayout?.RowGroupValues?.RowGroupDefaultBehavior !=
-                layout.RowGroupValues?.RowGroupDefaultBehavior) {
-            shouldUpdateExpandState = true;
+        if (!isLayoutSwitch && this._prevLayout) {
+            if (layout.RowGroupValues?.RowGroupDefaultBehavior &&
+                this._prevLayout?.RowGroupValues?.RowGroupDefaultBehavior !=
+                    layout.RowGroupValues?.RowGroupDefaultBehavior) {
+                shouldUpdateExpandState = true;
+            }
+            else {
+                const prevLayoutExceptionGroupKeys = getLayoutRowGroupValuesExceptionGroupKeys(this._prevLayout)
+                    .flat()
+                    .join(',');
+                const currentLayoutExceptionGroupKeys = getLayoutRowGroupValuesExceptionGroupKeys(layout)
+                    .flat()
+                    .join(',');
+                if (prevLayoutExceptionGroupKeys !== currentLayoutExceptionGroupKeys) {
+                    shouldUpdateExpandState = true;
+                }
+            }
         }
         this._prevLayout = layout;
         const perfSetLayout = this.logger.beginPerf(`setLayout(${layout.Name})`);

package/src/agGrid/AgGridAdapter.js

@@ -425,6 +425,7 @@ export class AgGridAdapter {
         const isFdc3MainActionColumn = this.adaptableApi.fdc3Api.internalApi.isFdc3MainActionColumn(colId);
         let friendlyName;
         const isGeneratedRowGroupColumn = columnApi.isAutoRowGroupColumn(ColumnId);
+        const isGeneratedSelectionColumn = columnApi.isSelectionColumn(ColumnId);
         const isGeneratedPivotResultColumn = columnApi.isPivotResultColumn(ColumnId) && !agGridColumn.isPrimary();
         const colExists = columnApi.doesColumnExist(ColumnId) ||
             isGeneratedRowGroupColumn ||
@@ -464,7 +465,7 @@ export class AgGridAdapter {
             colDef.lockVisible === true &&
             colDef.suppressColumnsToolPanel === true &&
             colDef.suppressFiltersToolPanel === true;
-        const isGenerated = isGeneratedRowGroupColumn || isGeneratedPivotResultColumn;
+        const isGenerated = isGeneratedRowGroupColumn || isGeneratedPivotResultColumn || isGeneratedSelectionColumn;
         const abColumn = {
             Uuid: createUuid(),
             isTreeColumn,
@@ -491,6 +492,7 @@ export class AgGridAdapter {
             hideable: this.isColumnHideable(colDef),
             isGrouped: isGenerated ? false : this.isColumnRowGrouped(colDef),
             isGeneratedRowGroupColumn,
+            isGeneratedSelectionColumn,
             isGeneratedPivotResultColumn,
             isFixed: this.isColumnFixed(colDef),
             pinned: this.getColumnPinnedPosition(colDef),
@@ -676,6 +678,9 @@ export class AgGridAdapter {
             this.adaptableApi.columnApi.isAutoRowGroupColumn(colDef.colId)) {
             return false;
         }
+        if (this.adaptableApi.columnApi.isSelectionColumn(colDef.colId)) {
+            return false;
+        }
         if (colDef.lockVisible != null && colDef.lockVisible == true) {
             return false;
         }

package/src/agGrid/AgGridColumnAdapter.js

@@ -88,12 +88,16 @@ export class AgGridColumnAdapter {
     }
     shouldSkipColumn(colId) {
         /**
-         * This skips columns like `ag-Grid-SelectionColumn` and possibly other columns
-         * that ag grid will implement in the future
+         * This skips special columns that ag grid will likely implement in the future
          *
-         * BUT DOES NOT SKIP GROUP COLUMNS!!!
+         * BUT DOES NOT SKIP GROUP COLUMNS or SELECTION COLUMNS!!!
+         *
+         * It's probably here for historical reasons - previously it used to skip the selection column
+         * but now it's not skipping it anymore
          */
-        return colId.startsWith('ag-Grid-') && !this.adaptableApi.columnApi.isAutoRowGroupColumn(colId);
+        return (colId.startsWith('ag-Grid-') &&
+            !this.adaptableApi.columnApi.isAutoRowGroupColumn(colId) &&
+            !this.adaptableApi.columnApi.isSelectionColumn(colId));
     }
     setupColumns() {
         const pivotMode = this.agGridApi.isPivotMode();
@@ -153,10 +157,8 @@ export class AgGridColumnAdapter {
     setupColumnCellClass({ col, colId, abColumn }) {
         this.setColDefProperty(col, 'cellClass', (userCellClass) => {
             const formatColumns = this.adaptableApi.formatColumnApi.internalApi.getFormatColumnWithStyleClassNameForColumn(abColumn);
-            const quickSearchStyleClassName = this.adaptableApi.quickSearchApi.getQuickSearchStyle().ClassName;
             const quickSearchTextMatchStyle = this.getQuickSearchTextMatchStyle();
             const quickSearchCurrentTextMatchStyle = this.getQuickSearchCurrentTextMatchStyle();
-            const hasQuickSearchStyleClassName = StringExtensions.IsNotNullOrEmpty(quickSearchStyleClassName);
             const cellClass = (params) => {
                 const gridCell = this.adaptableApi.gridApi.getGridCellFromRowNode(params.node, abColumn.columnId);
                 if (!gridCell.column) {
@@ -183,7 +185,7 @@ export class AgGridColumnAdapter {
                     !hasStyledColumn && formatColumns.length
                         ? this.getFormatColumnCellClass(formatColumns, abColumn, params)
                         : null,
-                    isQuickSearchActive && hasQuickSearchStyleClassName ? quickSearchStyleClassName : null,
+                    //  isQuickSearchActive && hasQuickSearchStyleClassName ? quickSearchStyleClassName : null,
                     isQuickSearchActive && (quickSearchTextMatchStyle || quickSearchCurrentTextMatchStyle)
                         ? 'ab-QuickSearchFind'
                         : null,
@@ -848,7 +850,7 @@ export class AgGridColumnAdapter {
         return classNames;
     }
     getQuickSearchCellStyle() {
-        const quickSearchStyle = this.adaptableApi.quickSearchApi.getQuickSearchStyle();
+        const quickSearchStyle = this.adaptableApi.quickSearchApi.getQuickSearchCellMatchStyle();
         if (!quickSearchStyle || StringExtensions.IsNotNullOrEmpty(quickSearchStyle.ClassName)) {
             return undefined;
         }

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: 1750416425464 || Date.now(),
-    VERSION: "20.2.1" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1750862989331 || Date.now(),
+    VERSION: "20.2.2" || '--current-version--',
 };

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

@@ -1,3 +1,4 @@
+import { XOR } from '../../Utilities/Extensions/TypeExtensions';
 /**
  * Defines how a Column is sorted
  */
@@ -64,15 +65,27 @@ export interface BaseLayoutModel {
      */
     RowGroupValues?: {
         RowGroupDisplay: 'always-expanded';
-    } | {
+    } | ({
         RowGroupDisplay: 'expanded';
+    } & XOR<{
         Values: any[][];
-    } | {
+    }, {
+        GroupKeys: {
+            RowGroupedColumns: string[];
+            Values?: any[][];
+        }[];
+    }>) | {
         RowGroupDisplay: 'always-collapsed';
-    } | {
+    } | ({
         RowGroupDisplay: 'collapsed';
+    } & XOR<{
         Values: any[][];
-    };
+    }, {
+        GroupKeys: {
+            RowGroupedColumns: string[];
+            Values?: any[][];
+        }[];
+    }>);
     /**
      * Behaviour for Expanding / Collapsing Column Groups
      */

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

@@ -62,7 +62,7 @@ export declare class LayoutManager<DATA_TYPE = any> extends LMEmitter {
     private applyLayout;
     private applyTableLayout;
     private getRowGroupNodePathsAs;
-    applyRowGroupValues(RowGroupValues: TableLayoutModel['RowGroupValues']): void;
+    applyRowGroupValues(RowGroupValues: TableLayoutModel['RowGroupValues'], rowGroupedColumns: string[]): void;
     private computeColumnStateForPivotLayout;
     private computePivotAggregations;
     private computeColumnStateForTableLayout;

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

@@ -232,7 +232,7 @@ export class LayoutManager extends LMEmitter {
             // but we want to suspend the listener
             // as it would re-trigger another change
             const unsupress = this.suspendAgGridListener();
-            this.applyRowGroupValues(layout.RowGroupValues);
+            this.applyRowGroupValues(layout.RowGroupValues, layout.RowGroupedColumns);
             unsupress();
         }
         if ((!prevLayout?.RowGroupedColumns || !prevLayout?.RowGroupedColumns.length) &&
@@ -244,7 +244,7 @@ export class LayoutManager extends LMEmitter {
             // but we want to suspend the listener
             // as it would re-trigger another change
             const unsupress = this.suspendAgGridListener();
-            this.applyRowGroupValues(layout.RowGroupValues);
+            this.applyRowGroupValues(layout.RowGroupValues, layout.RowGroupedColumns);
             unsupress();
         }
         if (!shouldSkipTriggerChange) {
@@ -331,9 +331,8 @@ export class LayoutManager extends LMEmitter {
         return this.gridApi.getGridOption('treeData');
     }
     getUndecidedLayoutModelFromGrid(columnState) {
-        let TableColumns = columnState
-            .map((c) => c.colId)
-            .filter((colId) => colId !== 'ag-Grid-SelectionColumn');
+        let TableColumns = columnState.map((c) => c.colId);
+        // .filter((colId) => colId !== 'ag-Grid-SelectionColumn');
         let ColumnWidths = {};
         let ColumnSorts = [];
         let RowGroupedColumns = [];
@@ -496,10 +495,26 @@ export class LayoutManager extends LMEmitter {
                         : this.getRowGroupNodePathsAs({
                             expanded: true,
                         });
-                    RowGroupValues = {
-                        RowGroupDisplay: 'collapsed',
-                        Values: ExpandedValues,
-                    };
+                    if (Array.isArray(currentRowGroupValues.GroupKeys)) {
+                        RowGroupValues = {
+                            RowGroupDisplay: 'collapsed',
+                            GroupKeys: currentRowGroupValues.GroupKeys.map((item) => {
+                                if ((item.RowGroupedColumns || []).join(',') === (RowGroupedColumns || []).join(',')) {
+                                    return {
+                                        RowGroupedColumns: item.RowGroupedColumns,
+                                        Values: ExpandedValues,
+                                    };
+                                }
+                                return item;
+                            }),
+                        };
+                    }
+                    else {
+                        RowGroupValues = {
+                            RowGroupDisplay: 'collapsed',
+                            Values: ExpandedValues,
+                        };
+                    }
                 }
                 else if (currentRowGroupValues.RowGroupDisplay === 'expanded') {
                     const CollapsedValues = isGroupingNew
@@ -507,10 +522,26 @@ export class LayoutManager extends LMEmitter {
                         : this.getRowGroupNodePathsAs({
                             expanded: false,
                         });
-                    RowGroupValues = {
-                        RowGroupDisplay: 'expanded',
-                        Values: CollapsedValues,
-                    };
+                    if (Array.isArray(currentRowGroupValues.GroupKeys)) {
+                        RowGroupValues = {
+                            RowGroupDisplay: 'expanded',
+                            GroupKeys: currentRowGroupValues.GroupKeys.map((item) => {
+                                if ((item.RowGroupedColumns || []).join(',') === (RowGroupedColumns || []).join(',')) {
+                                    return {
+                                        RowGroupedColumns: item.RowGroupedColumns,
+                                        Values: CollapsedValues,
+                                    };
+                                }
+                                return item;
+                            }),
+                        };
+                    }
+                    else {
+                        RowGroupValues = {
+                            RowGroupDisplay: 'expanded',
+                            Values: CollapsedValues,
+                        };
+                    }
                 }
             }
         }
@@ -897,7 +928,7 @@ export class LayoutManager extends LMEmitter {
             this.gridApi.applyColumnState(this.computeColumnStateForTableLayout(layout));
             // but also let's not forget to apply the row group values
             if (hasGroupedColumns && layout.RowGroupValues && !options?.skipApplyRowGroupsExpandedState) {
-                this.applyRowGroupValues(layout.RowGroupValues);
+                this.applyRowGroupValues(layout.RowGroupValues, layout.RowGroupedColumns);
             }
             this.applyColumnGroupCollapseExpandState(layout);
         });
@@ -921,7 +952,7 @@ export class LayoutManager extends LMEmitter {
         });
         return result;
     }
-    applyRowGroupValues(RowGroupValues) {
+    applyRowGroupValues(RowGroupValues, rowGroupedColumns) {
         if (!RowGroupValues) {
             return;
         }
@@ -934,9 +965,21 @@ export class LayoutManager extends LMEmitter {
             return;
         }
         const defaultExpanded = RowGroupValues.RowGroupDisplay === 'expanded';
-        if (RowGroupValues.Values) {
+        let currentRowGroupedValues = RowGroupValues.Values;
+        if (RowGroupValues.GroupKeys) {
+            const matchingRowGroupColumnValues = RowGroupValues.GroupKeys.find((item) => {
+                return (item.RowGroupedColumns || []).join(',') === (rowGroupedColumns || []).join(',');
+            });
+            if (matchingRowGroupColumnValues) {
+                currentRowGroupedValues = matchingRowGroupColumnValues.Values;
+            }
+            else {
+                currentRowGroupedValues = [];
+            }
+        }
+        if (currentRowGroupedValues) {
             const deepMap = new DeepMap();
-            RowGroupValues.Values.forEach((rowGroupValue) => {
+            currentRowGroupedValues.forEach((rowGroupValue) => {
                 deepMap.set(rowGroupValue, true);
             });
             this.gridApi.forEachNode((node) => {
@@ -1228,7 +1271,7 @@ export class LayoutManager extends LMEmitter {
         const hasGroupedColumns = layout.PivotGroupedColumns && layout.PivotGroupedColumns.length;
         // but also let's not forget to apply the row group values
         if (hasGroupedColumns && layout.RowGroupValues && !options?.skipApplyRowGroupsExpandedState) {
-            this.applyRowGroupValues(layout.RowGroupValues);
+            this.applyRowGroupValues(layout.RowGroupValues, layout.PivotGroupedColumns);
         }
     }
     applyPivotTotals(layout) {

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

@@ -2005,6 +2005,16 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    ColumnGroupValues: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
+    ColumnGroupValuesWithExceptionKeys: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     ColumnMenuContext: {
         name: string;
         kind: string;