@adaptabletools/adaptable 15.3.0 → 15.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "15.3.0",
+  "version": "15.3.2",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",
@@ -56,6 +56,6 @@
     "uuid": "^3.3.2"
   },
   "peerDependencies": {
-    "@ag-grid-community/core": ">=29.3.4"
+    "@ag-grid-community/core": ">=29.3.0"
   }
 }

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1683812137774;
+declare const _default: 1684762477916;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1683812137774;
+exports.default = 1684762477916;

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -208,6 +208,10 @@ export interface IAdaptable {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): IRowNode[];
+    getGroupRowNodes(config?: {
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): IRowNode[];
+    updateRowGroupsExpandedState(layout?: Layout): void;
     getRowsInViewport(): IRowNode[];
     isGroupRowNode(rowNode: IRowNode): boolean;
     isVisibleNode(rowNode: IRowNode): boolean;

package/src/AdaptableOptions/ActionOptions.d.ts

@@ -150,7 +150,7 @@ export interface ActionRowFormOptions<TData = any> {
      */
     formButtons?: AdaptableButton<ActionRowFormContext<TData>>[];
     /**
-     * Function invoked when the form in an Action Row is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!
+     * Event published when the form in an Action Row is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!
      *
      * @param actionRowSubmittedInfo the form submitted info
      * @defaultValue undefined

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -6,7 +6,7 @@ import { ExpressionOptions } from './ExpressionOptions';
 import { PredicateOptions } from './PredicateOptions';
 import { AdaptableObject } from '../types';
 /**
- * Options for managing AdapTableQL - the Adaptable Query Language which evaluates Predicates and Expressions
+ * Options for managing AdapTableQL: AdapTable's Query Language which evaluates Predicates and Expressions
  */
 export interface AdaptableQLOptions<TData = any> {
     /**
@@ -18,7 +18,7 @@ export interface AdaptableQLOptions<TData = any> {
      */
     caseSensitiveTextComparisons?: boolean;
     /**
-     * Whether a Module (or a specific expression) should be evaluated by AdapTableQL
+     * Whether a Module (or specific expression) should be evaluated by AdapTableQL
      * @defaultValue All Modules are evaluated by AdapTable
      */
     evaluateAdaptableQLExternally?: (context: EvaluateExpressionExternallyContext<TData>) => boolean;
@@ -35,7 +35,7 @@ export interface AdaptableQLOptions<TData = any> {
      */
     customPredicateDefs?: AdaptablePredicateDef[];
     /**
-     * Reference a Column's Header (FriendlyName) in all Expression overviews (instead of ColumnId)
+     * Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)
      *
      * @defaultValue true
      * @noCodeItem
@@ -51,7 +51,7 @@ export interface EvaluateExpressionExternallyContext<TData = any> extends BaseCo
      */
     module: AdaptableQLModule;
     /**
-     * The AdapTable Object which contains the Expression or Predicates
+     * AdapTable Object which contains the Expression or Predicates
      */
     object?: AdaptableObject;
     /**

package/src/Api/GridApi.d.ts

@@ -225,6 +225,13 @@ export interface GridApi {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): IRowNode[];
+    /**
+     * Retrieves all Grouped Row Nodes currently in the Grid
+     * @param config - configuration
+     */
+    getGroupRowNodes(config?: {
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): IRowNode[];
     /**
      * Retrieves Row Nodes that contain given Primary Keys
      * @param primaryKeyValues Primary Kev Values to look up
@@ -434,6 +441,10 @@ export interface GridApi {
      * @param rowNodes AG Grid rows
      */
     refreshRowNodes(rowNodes: IRowNode[]): void;
+    /**
+     * Forces a re-render of all Grouped rows (including aggregations)
+     */
+    refreshGroupRowNodes(): void;
     /**
      * Returns number of rows in Data Source
      */

package/src/Api/Implementation/CalculatedColumnApiImpl.js

@@ -61,7 +61,12 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
         });
         // refresh calculated columns
         const aggCalculatedColumnIds = aggregatedCalculatedColumns.map((calculatedColumn) => calculatedColumn.ColumnId);
-        this.getGridApi().refreshCells(null, aggCalculatedColumnIds);
+        if (this.getLayoutApi().internalApi.isLayoutGrouped()) {
+            this.getGridApi().refreshGroupRowNodes();
+        }
+        else {
+            this.getGridApi().refreshCells(null, aggCalculatedColumnIds);
+        }
     }
     refreshAggregatedCalculatedColumn(columnId) {
         var _a;
@@ -74,6 +79,12 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
             .internalApi.getCalculatedColumnExpressionService()
             .createAggregatedScalarLiveValue(aggregatedCalculatedColumn);
         this.getGridApi().refreshCells(null, [columnId]);
+        if (this.getLayoutApi().internalApi.isLayoutGrouped()) {
+            this.getGridApi().refreshGroupRowNodes();
+        }
+        else {
+            this.getGridApi().refreshCells(null, [columnId]);
+        }
     }
     showCalculatedColumnPopup() {
         (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'CalculatedColumnApi', 'showCalculatedColumnPopup', 'openCalculatedColumnSettingsPanel');

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

@@ -78,6 +78,9 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): IRowNode[];
+    getGroupRowNodes(config?: {
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): IRowNode[];
     getGridCellFromRowNode(rowNode: IRowNode, columnId: string): GridCell | undefined;
     getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
     getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
@@ -124,6 +127,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     refreshRowByPrimaryKey(primaryKey: any): void;
     refreshRowNode(rowNode: IRowNode): void;
     refreshRowNodes(rowNodes: IRowNode[]): void;
+    refreshGroupRowNodes(): void;
     isCellEditable(gridCell: GridCell): boolean;
     areCellsEditable(gridCells: GridCell[]): boolean;
     isEveryCellEditable(gridCells: GridCell[]): boolean;

package/src/Api/Implementation/GridApiImpl.js

@@ -268,6 +268,9 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     getAllRowNodes(config) {
         return this.adaptable.getAllRowNodes(config);
     }
+    getGroupRowNodes(config) {
+        return this.adaptable.getGroupRowNodes(config);
+    }
     getGridCellFromRowNode(rowNode, columnId) {
         return this.adaptable.getGridCellFromRowNode(rowNode, columnId);
     }
@@ -453,6 +456,11 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     refreshRowNodes(rowNodes) {
         this.adaptable.redrawRows(rowNodes);
     }
+    refreshGroupRowNodes() {
+        // see https://www.ag-grid.com/javascript-data-grid/client-side-row-stages/#refreshing-the-client-side-model
+        this.adaptable.api.internalApi.getAgGridInstance().api.refreshClientSideRowModel('group');
+        this.adaptable.updateRowGroupsExpandedState();
+    }
     isCellEditable(gridCell) {
         if (!gridCell) {
             return false;

package/src/agGrid/Adaptable.d.ts

@@ -188,7 +188,7 @@ export declare class Adaptable implements IAdaptable {
     setColumnOrder(VisibleColumnList: string[]): void;
     private persistLayout;
     setLayout(layout?: Layout): void;
-    private updateRowGroupsExpandedState;
+    updateRowGroupsExpandedState(layout?: Layout): void;
     private updateLayoutFromGrid;
     setSelectedCells(): SelectedCellInfo | undefined;
     setSelectedRows(): SelectedRowInfo | undefined;
@@ -235,6 +235,9 @@ export declare class Adaptable implements IAdaptable {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): IRowNode[];
+    getGroupRowNodes(config?: {
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): IRowNode[];
     getRowsInViewport(): IRowNode[];
     selectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
     deSelectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;

package/src/agGrid/Adaptable.js

@@ -2131,6 +2131,12 @@ class Adaptable {
         this.forAllRowNodesDo((rowNode) => rowNodes.push(rowNode), config);
         return rowNodes;
     }
+    getGroupRowNodes(config) {
+        return this.getAllRowNodes({
+            includeGroupRows: true,
+            filterFn: (rowNode) => this.isGroupRowNode(rowNode),
+        });
+    }
     getRowsInViewport() {
         return this.gridOptions.api.getRenderedNodes();
     }