@adaptabletools/adaptable 20.2.0-canary.0 → 20.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.2.0-canary.0",
+  "version": "20.2.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/AdaptableOptions/ExportOptions.d.ts

@@ -26,21 +26,21 @@ export interface ExportOptions<TData = any> {
      */
     customDestinations?: CustomDestination[];
     /**
-     * System Reports to use; leave blank for all, empty array for none
+     * System Reports to use; leave unset for all, empty array for none
      *
      * @defaultValue  'All Data', 'Current Layout', 'Selected Data',
      * @gridInfoItem
      */
     systemReportNames?: SystemReportName[] | ((context: SystemReportNamesContext) => SystemReportName[]);
     /**
-     * System Report Formats to use; leave blank for all, empty array for none
+     * System Report Formats to use; leave unset for all, empty array for none
      *
      * @defaultValue 'Excel', 'VisualExcel', 'CSV', 'JSON'
      * @gridInfoItem
      */
     systemReportFormats?: SystemReportFormat[] | ((context: SystemReportFormatsContext) => SystemReportFormat[]);
     /**
-     * Export destinations to use; leave blank for all, empty array for none
+     * Export destinations to use; leave unset for all, empty array for none
      *
      * @defaultValue 'Download', 'Clipboard'
      * @gridInfoItem

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -186,6 +186,10 @@ export interface InFilterValueInfo {
      * How many times the item appears in the column
      */
     count?: number;
+    /**
+     * How many times the item appears in the column in filtered rows
+     */
+    visibleCount?: number;
     /**
      * Whether the item is currently visible in the Grid (i.e. in filtered rows)
      */

package/src/AdaptableOptions/QuickSearchOptions.d.ts

@@ -9,6 +9,9 @@ export interface QuickSearchOptions<TData = any> {
      * @param quickSearchContext Contains quick search text and current Grid Cell
      */
     isCellSearchable?: (quickSearchContext: QuickSearchContext) => boolean;
+    /**
+     * Allows a different value to be used for a cell when searching (instead of its raw value)
+     */
     getCellSearchText?: (quickSearchContext: QuickSearchContext) => string | null;
     /**
      * Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)

package/src/AdaptableState/LayoutState.d.ts

@@ -46,6 +46,9 @@ export interface LayoutBase extends AdaptableObject {
      * Defines which Row Groups are expanded / collapsed
      */
     RowGroupValues?: RowGroupValues;
+    /**
+     * Defines which Column Groups are expanded / collapsed
+     */
     ColumnGroupValues?: ColumnGroupValues;
     /**
      * Set of custom header names for some (or all) Columns
@@ -172,25 +175,43 @@ export interface PivotLayout extends LayoutBase {
  */
 export type PivotTotalPosition = 'before' | 'after' | boolean;
 /**
- * Manages how (and which) Row Group values are stored
+ * Manages Row Group expand / collapse behaviour, including exceptions
  */
 export type RowGroupValues = {
     RowGroupDefaultBehavior: 'always-expanded' | 'always-collapsed';
 } | RowGroupValuesWithExceptionKeys;
+/**
+ * Defines which Row Groups are expanded or collapsed
+ */
+export type RowGroupValuesWithExceptionKeys = {
+    /**
+     * Default behaviour for Row Groups: 'expanded' or 'collapsed';
+     */
+    RowGroupDefaultBehavior: 'expanded' | 'collapsed';
+    /**
+     * Keys of Row Groups which are exceptions to default RowGroupDefaultBehavior - these are actual values in Row Grouped Column
+     */
+    ExceptionGroupKeys?: any[][];
+};
+/**
+ * Manages Column Group expand / collapse behaviour, including exceptions
+ */
 export type ColumnGroupValues = {
     ColumnGroupDefaultBehavior: 'always-expanded' | 'always-collapsed';
 } | ColumnGroupValuesWithExceptionKeys;
+/**
+ * Defines which Column Groups are expanded or collapsed
+ */
 export type ColumnGroupValuesWithExceptionKeys = {
+    /**
+     * Default behaviour for Column Groups: 'expanded' or 'collapsed';
+     */
     ColumnGroupDefaultBehavior: 'expanded' | 'collapsed';
+    /**
+     * Keys of Column Groups which are exceptions to default ColumnGroupDefaultBehavior; key maps to groupId property in ColGroupDef
+     */
     ExceptionGroupKeys?: any[];
 };
-/**
- * Defines which Row Group Values are expanded or collapsed
- */
-export type RowGroupValuesWithExceptionKeys = {
-    RowGroupDefaultBehavior: 'expanded' | 'collapsed';
-    ExceptionGroupKeys?: any[][];
-};
 /**
  * Defines a map of Columns with a String value
  */

package/src/AdaptableState/Selection/GridCell.d.ts

@@ -56,6 +56,7 @@ export interface GridCell<TData = any> {
 }
 export interface GridCellWithCount extends GridCell {
     count: number;
+    visibleCount: number;
 }
 /**
  * Lightweight object used for identifying a Cell to be updated

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

@@ -4,4 +4,5 @@ import { AdaptableModule } from '../../../types';
 export declare class SettingsPanelApiImpl extends ApiBase implements SettingsPanelApi {
     openSettingsPanel(moduleName?: AdaptableModule): void;
     openCustomSettingsPanel(name: string): void;
+    closeSettingsPanel(): void;
 }

package/src/Api/Implementation/SettingsPanelApiImpl.js

@@ -2,16 +2,21 @@ import { ApiBase } from './ApiBase';
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
 export class SettingsPanelApiImpl extends ApiBase {
     openSettingsPanel(moduleName) {
+        if (!moduleName) {
+            this.dispatchAction(PopupRedux.PopupShowScreen());
+        }
         const moduleInfo = this.getAdaptableInternalApi()
             .getModuleService()
             .getModuleInfoByModule(moduleName);
         if (!moduleInfo) {
-            this.logError(`${moduleName} module does not exist`);
-            return;
+            this.logWarn(`${moduleName} module does not exist`);
         }
-        this.dispatchAction(PopupRedux.PopupShowScreen(moduleName, moduleInfo.Popup));
+        this.dispatchAction(PopupRedux.PopupShowScreen(moduleName, moduleInfo?.Popup));
     }
     openCustomSettingsPanel(name) {
         this.dispatchAction(PopupRedux.PopupShowScreen(null, name));
     }
+    closeSettingsPanel() {
+        this.dispatchAction(PopupRedux.PopupHideScreen());
+    }
 }

package/src/Api/SettingsPanelApi.d.ts

@@ -13,4 +13,8 @@ export interface SettingsPanelApi {
      * @param name name of Custom Settings Panel to display
      */
     openCustomSettingsPanel(name: string): void;
+    /**
+     * Closes Settings Panel
+     */
+    closeSettingsPanel(): void;
 }

package/src/Utilities/Services/ChartingService.js

@@ -6,16 +6,16 @@ export class ChartingService {
     }
     onChartModelChange(models, eventType, params) {
         const allChartDefinitions = this.api.chartingApi.getChartDefinitions();
-        const currentChartModel = models.find((model) => model.chartId === params.chartId);
-        const currentChartDefinition = allChartDefinitions.find((chartDefinition) => chartDefinition.Model.chartId === params.chartId);
+        const currentChartModel = models.find((model) => model?.chartId === params.chartId);
+        const currentChartDefinition = allChartDefinitions.find((chartDefinition) => chartDefinition.Model?.chartId === params.chartId);
         switch (eventType) {
             case 'chartCreated':
                 const createParams = params;
-                if (allChartDefinitions.some((chartDefinition) => chartDefinition.Model.chartId === createParams.chartId)) {
+                if (allChartDefinitions.some((chartDefinition) => chartDefinition.Model?.chartId === createParams.chartId)) {
                     // chart already exists
                 }
                 else {
-                    const chartModel = models.find((model) => model.chartId === createParams.chartId);
+                    const chartModel = models.find((model) => model?.chartId === createParams.chartId);
                     this.saveNewChart(chartModel);
                 }
                 break;

package/src/View/Charting/useAgChartState.js

@@ -16,7 +16,7 @@ export const useAgChartState = (chartDefinition) => {
     }, [currentChartModels, chartDefinition]);
     const closeAlreadyOpenedChartsInContainer = (element) => {
         const chartModelAlreadyInChartContainer = currentChartModels.find((chartModel) => {
-            const chartRef = adaptable.api.chartingApi.getChartRef(chartModel.chartId);
+            const chartRef = adaptable.api.chartingApi.getChartRef(chartModel?.chartId);
             return chartRef && element.contains(chartRef.chartElement);
         });
         if (chartModelAlreadyInChartContainer) {

package/src/View/Components/NewScopeComponent.js

@@ -24,19 +24,19 @@ export const isScopeValid = ({ Scope }) => {
     return result.length ? result.join(', ') : true;
 };
 const DATA_TYPES_MAP = {
-    Date: {
+    date: {
         label: 'Date',
         value: 'date',
     },
-    Number: {
+    number: {
         label: 'Number',
         value: 'number',
     },
-    String: {
+    text: {
         label: 'Text',
         value: 'text',
     },
-    Boolean: {
+    boolean: {
         label: 'Boolean',
         value: 'boolean',
     },

package/src/View/Components/SharedProps/ModuleViewPopupProps.d.ts

@@ -18,7 +18,7 @@ export interface ModuleParams {
     value?: any;
     primaryKeyValues?: any[];
     maxWidth?: number;
-    source: 'Toolbar' | 'ModuleMenu' | 'ColumnMenu' | 'ContextMenu' | 'ModuleButton' | 'Other';
+    source: 'Toolbar' | 'ModuleMenu' | 'ColumnMenu' | 'ContextMenu' | 'ModuleButton' | 'Other' | 'Api';
     config?: {
         [key: string]: any;
     };

package/src/View/Layout/Wizard/sections/ColumnsSection.js

@@ -195,14 +195,16 @@ export const ColumnsSection = (props) => {
     const adaptable = useAdaptable();
     const { data: layout } = useOnePageAdaptableWizardContext();
     const [searchInputValue, setSearchInputValue] = React.useState('');
-    // we don't want to rely on all the columns from the Grid itself
-    // since the "Row Groups" section of the editor can determine a change
-    // which is not reflected into AG Grid until we hit finish
-    //
-    // so we only rely on non-generated columns, which are the same
-    const allColumns = adaptable.api.columnApi.getUIAvailableColumns().filter((col) => {
+    const allColumns = adaptable.api.columnApi
+        .getUIAvailableColumns()
+        .filter((col) => {
+        // since the "Row Groups" section of the editor can determine a change
+        // which is not reflected into AG Grid until we hit finish
+        // so we only rely on non-generated columns, which are the same
         return !col.isGeneratedRowGroupColumn;
-    });
+    })
+        // if the current Layout is a PivotLayout, then we also filter out current Pivot Result Columns
+        .filter((col) => !col.isGeneratedPivotResultColumn);
     // however, changes in RowGroupedColumns done in the previous step
     // are reflected into the layout, so we use the latest layout.RowGroupedColumns
     // to create new columns

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -101,6 +101,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private agGridListenerMouseEnter;
     private agGridListenerMouseLeave;
     private listenerGlobalSetRowSelection;
+    private listenerGlobalChartingChanges;
     private listenerCellEditingStarted;
     private listenerFirstDataRendered;
     private listenerPivotChanged;

package/src/agGrid/AdaptableAgGrid.js

@@ -1402,11 +1402,25 @@ You need to define at least one Layout!`);
         ];
         const chartingModule = this.ModuleService.getModuleById('Charting');
         if (chartingModule.isModuleAvailable()) {
-            this.agGridAdapter.getAgGridApi().addGlobalListener((type, params) => {
-                if (ArrayExtensions.ContainsItem(eventsThatTriggerChartingChanges, type)) {
+            // We need to break the loop of charting changes for 'chartOptionsChanged', which is triggered by the subsequent agGridApi.updateChart(...)
+            // see #ag_grid_update_chart_loop
+            let lastChartOptionsChangePayload = '';
+            this.listenerGlobalChartingChanges = (type, params) => {
+                if (eventsThatTriggerChartingChanges.includes(type)) {
+                    if (type === 'chartOptionsChanged') {
+                        // Exclude api and context
+                        const { api, context, ...sanitizedParams } = params || {};
+                        const eventPayload = JSON.stringify(sanitizedParams);
+                        if (eventPayload === lastChartOptionsChangePayload) {
+                            // this is a loop, so we ignore it
+                            return;
+                        }
+                        lastChartOptionsChangePayload = eventPayload;
+                    }
                     this.ChartingService.onChartModelChange(this.getChartModels(), type, params);
                 }
-            });
+            };
+            this.agGridAdapter.getAgGridApi().addGlobalListener(this.listenerGlobalChartingChanges);
         }
         /**
          * Row and Cell listeners created in 2020
@@ -2248,6 +2262,9 @@ You need to define at least one Layout!`);
                             get visible() {
                                 return gridCell.visible;
                             },
+                            get visibleCount() {
+                                return gridCell.visibleCount;
+                            },
                         };
                     });
                     return result;
@@ -2262,6 +2279,9 @@ You need to define at least one Layout!`);
                             get visible() {
                                 return gridCell.visible;
                             },
+                            get visibleCount() {
+                                return gridCell.visibleCount;
+                            },
                         };
                     });
                     return result;
@@ -2430,6 +2450,11 @@ You need to define at least one Layout!`);
                     return (rowNodesWithSameCellValue.findIndex((pk) => self.isRowNodeAvailableAfterFiltering(pk) === true) !== -1);
                 },
             });
+            Object.defineProperty(cellWithCount, 'visibleCount', {
+                get: () => {
+                    return rowNodesWithSameCellValue.filter((pk) => self.isRowNodeAvailableAfterFiltering(pk) === true).length;
+                },
+            });
             result.push(cellWithCount);
         });
         return result;
@@ -2694,6 +2719,10 @@ You need to define at least one Layout!`);
         return chartRef;
     }
     updateChart(chart) {
+        if (!chart.Model) {
+            this.logger.consoleError(`Chart definition must have a Model property to be updated: ${chart.Name}`);
+            return;
+        }
         const upgradableProperties = {
             // Only Range charts are supported to be created at run time
             // the other two are pivot & cross-filter
@@ -2703,6 +2732,7 @@ You need to define at least one Layout!`);
             suppressChartRanges: Boolean(chart.Model.suppressChartRanges),
             aggFunc: chart.Model.aggFunc,
         };
+        // see also #ag_grid_update_chart_loop
         this.agGridAdapter.getAgGridApi().updateChart(upgradableProperties);
     }
     getChartModels() {
@@ -2919,6 +2949,9 @@ You need to define at least one Layout!`);
             agGridApi.removeEventListener('columnGroupOpened', this.listenerColumnGroupOpened);
             agGridApi.removeEventListener('sortChanged', this.listenerSortChanged);
             agGridApi.removeGlobalListener(this.listenerGlobalSetRowSelection);
+            if (this.listenerGlobalChartingChanges) {
+                this.agGridAdapter.getAgGridApi().removeGlobalListener(this.listenerGlobalChartingChanges);
+            }
             this.listenerFirstDataRendered = null;
             this.listenerPivotChanged = null;
             this.listenerColumnGroupOpened = null;
@@ -2996,7 +3029,9 @@ You need to define at least one Layout!`);
         }
         this.DANGER_USE_GETTER_adaptableContainerElement = null;
         this.DANGER_USE_GETTER_agGridContainerElement = null;
+        this.debouncedSetSelectedCells?.cancel?.();
         this.debouncedSetSelectedCells = null;
+        this.debouncedSetSelectedRows?.cancel?.();
         this.debouncedSetSelectedRows = null;
         this.adaptableStore?.destroy();
         this.adaptableStore = null;

package/src/components/WindowModal/useStacking.js

@@ -2,7 +2,8 @@ import * as React from 'react';
 import { createUuid } from '../utils/uuid';
 const setZIndexMap = {};
 const zIndexMap = [];
-const BASE_Z_INDEX = 1000;
+// starts with 3000, to be above the default zIndex of the Modal component
+const BASE_Z_INDEX = 3000;
 /**
  * Used to facilitate the stacking between multiple opened windows.
  * When calling 'bringToFront' brings caller to top.

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: 1748873595292 || Date.now(),
-    VERSION: "20.2.0-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1749810312509 || Date.now(),
+    VERSION: "20.2.0" || '--current-version--',
 };