@adaptabletools/adaptable-cjs 18.0.0-canary.9 → 18.0.1

package/src/Api/ConfigApi.d.ts

@@ -15,18 +15,23 @@ import { AdaptablePersistentState, AdaptableState } from '../PredefinedConfig/Ad
 import { FreeTextColumnState } from '../PredefinedConfig/FreeTextColumnState';
 import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
 import { AdaptableStateKey, AdaptableModule } from '../PredefinedConfig/Common/Types';
-import { AdaptableSearchState, AdaptableSortState, NamedQueryState, PredefinedConfig, ScheduleState } from '../types';
-import { NotesState } from '../PredefinedConfig/NotesState';
+import { AdaptableSearchState, AdaptableSortState, NamedQueryState, PredefinedConfig, ScheduleState, NoteState } from '../types';
 /**
  * Range of functions to access Predefined Config and Adaptable State
  */
 export interface ConfigApi {
     /**
-     * Changes the key used for persisting the AdaptableState into localStorage
-     * @param adaptableStateKey key for persisting the AdaptableState into localStorage
+     * Changes the key used for persisting the AdaptableState into localStorage. Optionally provides a predefinedConfig to load.
+     * @param adaptableStateKey - key for persisting the AdaptableState into localStorage
+     * @param config.predefinedConfig - new predefinedConfig to load
+     * @param config.flushCurrentState - whether to flush(persist) the current state before loading the new predefinedConfig
+     * @param config.progressIndicatorLabel - label for the progress indicator
+     *
      */
     setAdaptableStateKey(adaptableStateKey: string, config?: {
-        predefinedConfig: PredefinedConfig;
+        predefinedConfig?: PredefinedConfig;
+        flushCurrentState?: boolean;
+        progressIndicatorLabel?: string;
     }): Promise<void>;
     /**
      * Returns current Predefined Config
@@ -105,10 +110,10 @@ export interface ConfigApi {
      */
     getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
     /**
-     * Returns Notes section of Adaptable State
+     * Returns Note section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getNotesState(returnJson?: boolean): NotesState;
+    getNoteState(returnJson?: boolean): NoteState;
     /**
      * Returns Custom Sort section of Adaptable State
      * @param returnJson return as JSON rather than object

package/src/Api/ContextMenuApi.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Provides run-time access to Context Menu
+ */
+export interface ContextMenuApi {
+    /**
+     * Hide the Context Menu
+     */
+    hideContextMenu(): void;
+}

package/src/Api/EventApi.d.ts

@@ -1,6 +1,4 @@
-import { ActionRowSubmittedInfo, AdaptableReadyInfo, AdaptableStateChangedInfo, AdaptableStateReloadedInfo, AlertFiredInfo, CellChangedInfo, CellSelectionChangedInfo, ChartChangedInfo, ColumnFilterAppliedInfo, CustomToolbarConfiguredInfo, DashboardChangedInfo, DataImportedInfo, DataSetSelectedInfo, Fdc3MessageInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, GridFilterAppliedInfo, GridSortedInfo, LayoutChangedInfo, LiveDataChangedInfo, RowSelectionChangedInfo, ScheduleTriggeredInfo, SystemStatusMessageDisplayedInfo, TeamSharingEntityChangedInfo, ThemeChangedInfo, ThemeEditedInfo } from '../types';
-import { CalculatedColumnChangedInfo } from './Events/CalculatedColumnChanged';
-import { CommentsChangedInfo } from './Events/CommentsChangedInfo';
+import { ActionRowSubmittedInfo, AdaptableReadyInfo, AdaptableStateChangedInfo, AdaptableStateReloadedInfo, AlertFiredInfo, CalculatedColumnChangedInfo, CellChangedInfo, CellSelectionChangedInfo, ChartChangedInfo, ColumnFilterAppliedInfo, CommentChangedInfo, CustomToolbarConfiguredInfo, DashboardChangedInfo, DataImportedInfo, DataSetSelectedInfo, Fdc3MessageInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, GridFilterAppliedInfo, GridSortedInfo, LayoutChangedInfo, LiveDataChangedInfo, RowSelectionChangedInfo, ScheduleTriggeredInfo, SystemStatusMessageDisplayedInfo, TeamSharingEntityChangedInfo, ThemeChangedInfo, ThemeEditedInfo } from '../types';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
@@ -297,17 +295,17 @@ export interface EventApi {
      */
     off(eventName: 'ChartChanged', callback: (chartChangedInfo: ChartChangedInfo) => void): void;
     /**
-     * Event fired when Comments are Changed
-     * @param eventName CommentsChanged
+     * Event fired when a Comment is Changed
+     * @param eventName CommentChanged
      * @param callback
      */
-    on(eventName: 'CommentsChanged', callback: (commentsChangedInfo: CommentsChangedInfo) => void): () => void;
+    on(eventName: 'CommentChanged', callback: (commentChangedInfo: CommentChangedInfo) => void): () => void;
     /**
-     * Unsubscribe from CommentsChanged
+     * Unsubscribe from CommentChanged
      * @param eventName
      * @param callback
      */
-    off(eventName: 'CommentsChanged', callback: (commentsChangedInfo: CommentsChangedInfo) => void): void;
+    off(eventName: 'CommentChanged', callback: (commentChangedInfo: CommentChangedInfo) => void): void;
     /**
      * Fired when Adaptable is up and running - has no arguments.
      * @param eventName - AdaptableReady
@@ -352,6 +350,6 @@ export interface EventApi {
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited' | 'GridFilterApplied' | 'CommentsChanged', data?: any): Promise<any>;
+    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited' | 'GridFilterApplied' | 'CommentChanged', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/Events/CommentChanged.d.ts

@@ -0,0 +1,11 @@
+import { CommentThread } from '../../types';
+import { BaseEventInfo } from './BaseEventInfo';
+/**
+ * Event fired when a Comment has changed
+ */
+export interface CommentChangedInfo extends BaseEventInfo {
+    /**
+     * All current Comment Threads
+     */
+    commentThreads: CommentThread[];
+}

package/src/Api/Events/CommentChanged.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/Events/GridDataChanged.d.ts

@@ -13,7 +13,7 @@ export type GridDataChangeTrigger = 'Add' | 'Edit' | 'Delete' | 'Load';
      */
     dataRows: TData[];
     /**
-     * Trigger for row change: 'Add', 'Edit', 'Delete', 'Load'
+     * Trigger for row change: Load, Add, Edit, or Delete
      */
     rowTrigger: GridDataChangeTrigger;
     /**

package/src/Api/FlashingCellApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlashingCell';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
-import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
+import { ColumnScope } from '../PredefinedConfig/Common/ColumnScope';
 import { FlashingCellDefinition, FlashingCellState } from '../PredefinedConfig/FlashingCellState';
 import { AdaptableObjectLookupCriteria } from '../PredefinedConfig/Common/AdaptableObject';
 /**
@@ -83,7 +83,7 @@ export interface FlashingCellApi {
      * Retrieves all Predicate Defs that match given Scope
      * @param scope the Scope to check
      */
-    getFlashingCellPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFlashingCellPredicateDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];
     /**
      * Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')
      */

package/src/Api/GridApi.d.ts

@@ -7,9 +7,10 @@ import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
 import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
 import { RowHighlightInfo } from '../PredefinedConfig/Common/RowHighlightInfo';
-import { IRowNode, RowModelType } from '@ag-grid-community/core';
+import { Column, IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
 import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo';
+import { TransposeConfig } from '../PredefinedConfig/Common/TransposeConfig';
 /**
  * Provides access to important properites of AdapTable e.g. sorting, selected cells etc.
  */
@@ -26,6 +27,10 @@ export interface GridApi {
      * Retrieves filtered data from the grid
      */
     getFilteredData(): any[];
+    /**
+     * Retrieves visible data from the grid (filtered and sorted)
+     */
+    getVisibleData(): any[];
     /**
      * @deprecated use `loadGridData()` instead
      */
@@ -354,18 +359,37 @@ export interface GridApi {
      */
     isGridGroupable(): boolean;
     /**
-     * Whether AdapTable instance offers cell selection
+     * Whether AdapTable instance offers row selection
+     *
+     * @deprecated use `isGridRowSelectable()` instead
      */
     isGridSelectable(): boolean;
+    /**
+     * Whether AdapTable instance offers row selection
+     */
+    isGridRowSelectable(): boolean;
+    /**
+     * Whether AdapTable instance offers cell range selection
+     */
+    isGridRangeSelectable(): boolean;
     /**
      * Whether Grid is currently showing Row Groups
      */
     isGridRowGrouped(): boolean;
+    /**
+     * Whether Grid is currently in Pivot Mode
+     */
+    isGridInPivotMode(): boolean;
     /**
      * Whether given Row Node is a Row Group
      * @param rowNode Node to check
      */
     isGroupRowNode(rowNode: IRowNode): boolean;
+    /**
+     * Whether given Row Node is in a Smmary Row
+     * @param rowNode Node to check
+     */
+    isSummaryNode(rowNode: IRowNode): boolean;
     /**
      * Whether Quick Filter is available in the Grid
      */
@@ -461,7 +485,7 @@ export interface GridApi {
      */
     refreshRowNodes(rowNodes: IRowNode[]): void;
     /**
-     * Forces a re-render of all Grouped rows (including aggregations)
+     * Forces a re-render of all Group Rows (including aggregations)
      */
     refreshGroupRowNodes(): void;
     /**
@@ -519,5 +543,9 @@ export interface GridApi {
     /**
      * Opens a window with a transposed view of Grid
      */
-    showTransposedView(transposedColumnId: string, hideTransposedColumn?: boolean): void;
+    showTransposedView(transposeConfig?: TransposeConfig): void;
+    /**
+     * Return all AG Grid columns
+     */
+    getAllAgGridColumns(): Column<any>[];
 }

package/src/Api/Implementation/ActionColumnApiImpl.js

@@ -13,11 +13,8 @@ class ActionColumnApiImpl extends ApiBase_1.ApiBase {
         return (_a = this.getActionColumnOptions().actionColumns) !== null && _a !== void 0 ? _a : [];
     }
     getColDefsForActionColumns() {
-        const defaultActionColumnSettings = {
-            resizable: true,
-            suppressMenu: false,
-            suppressMovable: false,
-        };
+        const defaultSpecialColumnSettings = this.getGridApi().internalApi.deriveSpecialColumnSettingsFromAgGridDefaultColDef();
+        const defaultActionColumnSettings = Object.assign(Object.assign({}, defaultSpecialColumnSettings), { resizable: true, suppressMenu: false, suppressMovable: false });
         return this.getActionColumnApi()
             .getActionColumns()
             .map((actionColumn) => {
@@ -29,7 +26,7 @@ class ActionColumnApiImpl extends ApiBase_1.ApiBase {
                 editable: false,
                 width: actionColumnSettings.width,
                 resizable: actionColumnSettings.resizable,
-                suppressMenu: actionColumnSettings.suppressMenu,
+                suppressHeaderMenuButton: actionColumnSettings.suppressMenu,
                 suppressMovable: actionColumnSettings.suppressMovable,
                 filter: false,
                 sortable: false,

package/src/Api/Implementation/ActionRowApiImpl.js

@@ -12,17 +12,13 @@ class ActionRowApiImpl extends ApiBase_1.ApiBase {
     getActionRowButtons() {
         var actionRowButtons = this.getActionRowOptions().actionRowButtons;
         if (typeof actionRowButtons === 'function') {
-            const context = {
-                adaptableApi: this.getAdaptableApi(),
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-            };
+            const context = this.getAdaptableApi().internalApi.buildBaseContext();
             actionRowButtons = actionRowButtons(context);
         }
         return actionRowButtons !== null && actionRowButtons !== void 0 ? actionRowButtons : [];
     }
     displayEditActionRow(primaryKey) {
-        const rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(primaryKey);
+        const rowNode = this.getAdaptableApi().gridApi.getRowNodeForPrimaryKey(primaryKey);
         if (!rowNode) {
             this.logWarn(`Can NOT edit row: rowNode not found for primaryKey ${primaryKey}`);
         }
@@ -44,7 +40,7 @@ class ActionRowApiImpl extends ApiBase_1.ApiBase {
         }));
     }
     displayCloneActionRow(primaryKey) {
-        const rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(primaryKey);
+        const rowNode = this.getAdaptableApi().gridApi.getRowNodeForPrimaryKey(primaryKey);
         if (!rowNode) {
             this.logWarn(`Can NOT clone row: rowNode not found for primaryKey ${primaryKey}`);
         }

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

@@ -1,6 +1,6 @@
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableInternalApi } from '../Internal/AdaptableInternalApi';
-import { AdaptableApi, DataImportApi, NamedQueryApi, OptionsApi, SettingsPanelApi } from '../../types';
+import { AdaptableApi, ColumnMenuApi, ContextMenuApi, DataImportApi, NamedQueryApi, OptionsApi, SettingsPanelApi } from '../../types';
 import { AlertApi } from '../AlertApi';
 import { BulkUpdateApi } from '../BulkUpdateApi';
 import { CalendarApi } from '../CalendarApi';
@@ -31,7 +31,7 @@ import { ExpressionApi } from '../ExpressionApi';
 import { TeamSharingApi } from '../TeamSharingApi';
 import { ColumnApi } from '../ColumnApi';
 import { ApplicationApi } from '../ApplicationApi';
-import { ScopeApi } from '../ScopeApi';
+import { ColumnScopeApi } from '../ColumnScopeApi';
 import { PredicateApi } from '../PredicateApi';
 import { DataChangeHistoryApi } from '../DataChangeHistoryApi';
 import { FlashingCellApi } from '../FlashingCellApi';
@@ -40,7 +40,7 @@ import { StatusBarApi } from '../StatusBarApi';
 import { StyledColumnApi } from '../StyledColumnApi';
 import { ActionColumnApi } from '../ActionColumnApi';
 import { ActionRowApi } from '../ActionRowApi';
-import { NotesApi } from '../NotesApi';
+import { NoteApi } from '../NoteApi';
 import { Fdc3Api } from '../Fdc3Api';
 import { GridFilterApi } from '../GridFilterApi';
 import { ColumnFilterApi } from '../ColumnFilterApi';
@@ -86,11 +86,13 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     styledColumnApi: StyledColumnApi;
     toolPanelApi: ToolPanelApi;
     teamSharingApi: TeamSharingApi;
-    scopeApi: ScopeApi;
+    columnScopeApi: ColumnScopeApi;
     dataChangeHistoryApi: DataChangeHistoryApi;
     chartingApi: ChartingApi;
     statusBarApi: StatusBarApi;
-    notesApi: NotesApi;
+    noteApi: NoteApi;
+    columnMenuApi: ColumnMenuApi;
+    contextMenuApi: ContextMenuApi;
     fdc3Api: Fdc3Api;
     dataImportApi: DataImportApi;
     gridFilterApi: GridFilterApi;

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -31,7 +31,7 @@ const ScheduleApiImpl_1 = require("./ScheduleApiImpl");
 const TeamSharingApiImpl_1 = require("./TeamSharingApiImpl");
 const ColumnApiImpl_1 = require("./ColumnApiImpl");
 const ApplicationApiImpl_1 = require("./ApplicationApiImpl");
-const ScopeApiImpl_1 = require("./ScopeApiImpl");
+const ColumnScopeApiImpl_1 = require("./ColumnScopeApiImpl");
 const DataChangeHistoryApiImpl_1 = require("./DataChangeHistoryApiImpl");
 const ExpressionApiImpl_1 = require("./ExpressionApiImpl");
 const FlashingCellApiImpl_1 = require("./FlashingCellApiImpl");
@@ -43,13 +43,15 @@ const StyledColumnApiImpl_1 = require("./StyledColumnApiImpl");
 const CalendarApiImpl_1 = require("./CalendarApiImpl");
 const EntitlementApiImpl_1 = require("./EntitlementApiImpl");
 const OptionsApiImpl_1 = require("./OptionsApiImpl");
-const NotesApiImpl_1 = require("./NotesApiImpl");
+const NoteApiImpl_1 = require("./NoteApiImpl");
 const Fdc3ApiImpl_1 = require("./Fdc3ApiImpl");
 const DataImportApiImpl_1 = require("./DataImportApiImpl");
 const GridFilterApiImpl_1 = require("./GridFilterApiImpl");
 const NamedQueryApiImpl_1 = require("./NamedQueryApiImpl");
 const ColumnFilterApiImpl_1 = require("./ColumnFilterApiImpl");
 const CommentsApiImpl_1 = require("./CommentsApiImpl");
+const ColumnMenuApiImpl_1 = require("./ColumnMenuApiImpl");
+const ContextMenuApiImpl_1 = require("./ContextMenuApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
@@ -68,6 +70,8 @@ class AdaptableApiImpl {
         this.calculatedColumnApi = new CalculatedColumnApiImpl_1.CalculatedColumnApiImpl(adaptable);
         this.cellSummaryApi = new CellSummaryApiImpl_1.CellSummaryApiImpl(adaptable);
         this.columnApi = new ColumnApiImpl_1.ColumnApiImpl(adaptable);
+        this.columnMenuApi = new ColumnMenuApiImpl_1.ColumnMenuApiImpl(adaptable);
+        this.contextMenuApi = new ContextMenuApiImpl_1.ContextMenuApiImpl(adaptable);
         this.configApi = new ConfigApiImpl_1.ConfigApiImpl(adaptable);
         this.customSortApi = new CustomSortApiImpl_1.CustomSortApiImpl(adaptable);
         this.dashboardApi = new DashboardApiImpl_1.DashboardApiImpl(adaptable);
@@ -93,11 +97,11 @@ class AdaptableApiImpl {
         this.styledColumnApi = new StyledColumnApiImpl_1.StyledColumnApiImpl(adaptable);
         this.toolPanelApi = new ToolPanelApiImpl_1.ToolPanelApiImpl(adaptable);
         this.teamSharingApi = new TeamSharingApiImpl_1.TeamSharingApiImpl(adaptable);
-        this.scopeApi = new ScopeApiImpl_1.ScopeApiImpl(adaptable);
+        this.columnScopeApi = new ColumnScopeApiImpl_1.ColumnScopeApiImpl(adaptable);
         this.dataChangeHistoryApi = new DataChangeHistoryApiImpl_1.DataChangeHistoryApiImpl(adaptable);
         this.chartingApi = new ChartingApiImpl_1.ChartingApiImpl(adaptable);
         this.statusBarApi = new StatusBarApiImpl_1.StatusBarApiImpl(adaptable);
-        this.notesApi = new NotesApiImpl_1.NotesApiImpl(adaptable);
+        this.noteApi = new NoteApiImpl_1.NoteApiImpl(adaptable);
         this.fdc3Api = new Fdc3ApiImpl_1.Fdc3ApiImpl(adaptable);
         this.dataImportApi = new DataImportApiImpl_1.DataImportApiImpl(adaptable);
         this.gridFilterApi = new GridFilterApiImpl_1.GridFilterApiImpl(adaptable);
@@ -147,7 +151,7 @@ class AdaptableApiImpl {
         this.expressionApi = null;
         this.quickSearchApi = null;
         this.scheduleApi = null;
-        this.scopeApi = null;
+        this.columnScopeApi = null;
         this.settingsPanelApi = null;
         this.shortcutApi = null;
         this.smartEditApi = null;

package/src/Api/Implementation/AlertApiImpl.js

@@ -47,13 +47,8 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         this.addUidToAdaptableObject(alertToShow);
         this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getAlertOptions().maxAlertsInStore));
         // 2. Publish the Alert Fired Event
-        const alertFiredInfo = {
-            adaptableApi: this.adaptable.api,
-            alert: alertToShow,
-            userName: this.adaptable.api.optionsApi.getUserName(),
-            adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
-        };
-        const results = await this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
+        const alertFiredInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { alert: alertToShow });
+        const results = await this.getAdaptableApi().eventApi.emit('AlertFired', alertFiredInfo);
         const showPopup = results.reduce((endResult, aResult) => {
             return endResult && aResult !== false;
         }, true);
@@ -110,13 +105,13 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                 }
                 if (alertNode) {
                     if (alertProperties.HighlightRow) {
-                        this.adaptable.api.gridApi.refreshRowNodes([alertNode]);
+                        this.getAdaptableApi().gridApi.refreshRowNodes([alertNode]);
                         setTimeout(() => {
                             this.dispatchAction(SystemRedux.SystemAlertRemoveRowHighlight(alertToShow));
                         }, this.adaptable.adaptableOptions.alertOptions.rowHighlightDuration);
                     }
                     if (alertProperties.HighlightCell) {
-                        this.adaptable.api.gridApi.refreshCells([alertNode], [alertToShow.cellDataChangedInfo.column.columnId]);
+                        this.getAdaptableApi().gridApi.refreshCells([alertNode], [alertToShow.cellDataChangedInfo.column.columnId]);
                         setTimeout(() => {
                             this.dispatchAction(SystemRedux.SystemAlertRemoveCellHighlight(alertToShow));
                         }, this.adaptable.adaptableOptions.alertOptions.cellHighlightDuration);
@@ -127,7 +122,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             else if (alertProperties.HighlightRow &&
                 (0, AdaptableAlert_1.isAdaptableRowChangedAlert)(alertToShow) &&
                 ((_b = alertToShow.gridDataChangedInfo) === null || _b === void 0 ? void 0 : _b.rowTrigger) === 'Add') {
-                this.adaptable.api.gridApi.refreshRowNodes(alertToShow.gridDataChangedInfo.rowNodes);
+                this.getAdaptableApi().gridApi.refreshRowNodes(alertToShow.gridDataChangedInfo.rowNodes);
                 setTimeout(() => {
                     this.dispatchAction(SystemRedux.SystemAlertRemoveRowHighlight(alertToShow));
                 }, this.adaptable.adaptableOptions.alertOptions.rowHighlightDuration);
@@ -171,7 +166,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     evaluateAlertDefinitions(alertDefinitions) {
         const filterScopeAllDefinitions = (alertDefinition) => {
-            if (this.getAdaptableApi().scopeApi.scopeIsAll(alertDefinition.Scope) &&
+            if (this.getAdaptableApi().columnScopeApi.scopeIsAll(alertDefinition.Scope) &&
                 !this.getAdaptableApi().expressionApi.getAdaptableQueryExpression(alertDefinition.Rule)) {
                 // we don't support scope ALL without an expression
                 // the predicates for scope ALL do NOT make any sense for a programmatic evaluation
@@ -206,7 +201,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         //  if there is an Expression defined, extract only the columns from there (in that case the Scope would be 'All' anyway)
         // columns referenced in rule expression
         const ruleExpression = this.getAdaptableApi().expressionApi.getAdaptableQueryExpression(alertDefinition.Rule);
-        if (this.getAdaptableApi().scopeApi.scopeIsAll(alertDefinition.Scope) &&
+        if (this.getAdaptableApi().columnScopeApi.scopeIsAll(alertDefinition.Scope) &&
             StringExtensions_1.default.IsNotNullOrEmpty(ruleExpression)) {
             // return only first referenced column (otherwise we would generate multiple alerts for the same row)
             const queryColumns = this.getAdaptableApi()
@@ -217,7 +212,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         else {
             // otherwise return all columns for given scope
             return this.getAdaptableApi()
-                .scopeApi.getColumnsForScope(alertDefinition.Scope)
+                .columnScopeApi.getColumnsForScope(alertDefinition.Scope)
                 .map((adaptableColumn) => adaptableColumn.columnId);
         }
     }

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

@@ -7,7 +7,7 @@ import { ModuleInfo } from '../../Strategy/Interface/IModule';
 import { AdaptableOptions } from '../../AdaptableOptions/AdaptableOptions';
 import { AdaptableApi } from '../AdaptableApi';
 import { ExportOptions } from '../../AdaptableOptions/ExportOptions';
-import { ActionColumnApi, ActionColumnOptions, ActionRowApi, ActionRowOptions, AlertApi, AlertOptions, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CalendarOptions, CellSummaryApi, CellSummaryOptions, ChartingApi, ChartingOptions, ColumnApi, ColumnFilterApi, ColumnFilterOptions, ColumnOptions, ConfigApi, ContainerOptions, CustomSortApi, CustomSortOptions, DashboardApi, DashboardOptions, DataChangeHistoryApi, DataChangeHistoryOptions, DataSetApi, DataSetOptions, EditOptions, EntitlementApi, EntitlementOptions, EventApi, ExportApi, ExpressionApi, ExpressionOptions, Fdc3Api, Fdc3Options, FlashingCellApi, FlashingCellOptions, FormatColumnApi, FormatColumnOptions, FreeTextColumnApi, GridApi, GridFilterApi, GroupingOptions, LayoutApi, LayoutAssociatedObject, LayoutOptions, MenuOptions, NamedQueryApi, NotesOptions, NotificationsOptions, PluginsApi, PlusMinusApi, PredicateApi, PredicateOptions, QuickSearchApi, QuickSearchOptions, ScheduleApi, ScopeApi, SettingsPanelApi, SettingsPanelOptions, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, ToolPanelOptions, UserInterfaceApi, UserInterfaceOptions } from '../../types';
+import { ActionColumnApi, ActionColumnOptions, ActionRowApi, ActionRowOptions, AlertApi, AlertOptions, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CalendarOptions, CellSummaryApi, CellSummaryOptions, ChartingApi, ChartingOptions, ColumnApi, ColumnFilterApi, ColumnFilterOptions, ColumnOptions, CommentOptions, ConfigApi, ContainerOptions, CustomSortApi, CustomSortOptions, DashboardApi, DashboardOptions, DataChangeHistoryApi, DataChangeHistoryOptions, DataSetApi, DataSetOptions, EditOptions, EntitlementApi, EntitlementOptions, EventApi, ExportApi, ExpressionApi, ExpressionOptions, Fdc3Api, Fdc3Options, FlashingCellApi, FlashingCellOptions, FormatColumnApi, FormatColumnOptions, FreeTextColumnApi, GridApi, GridFilterApi, GroupingOptions, LayoutApi, LayoutAssociatedObject, LayoutOptions, NamedQueryApi, NoteOptions, NotificationsOptions, PluginsApi, PlusMinusApi, PredicateApi, PredicateOptions, QuickSearchApi, QuickSearchOptions, ScheduleApi, ColumnScopeApi, SettingsPanelApi, SettingsPanelOptions, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, ToolPanelOptions, UserInterfaceApi, UserInterfaceOptions, ColumnMenuOptions, ContextMenuOptions } from '../../types';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
@@ -53,7 +53,8 @@ export declare abstract class ApiBase {
     protected getActionColumnOptions(): ActionColumnOptions;
     protected getActionRowOptions(): ActionRowOptions;
     protected getColumnOptions(): ColumnOptions;
-    protected getNotesOptions(): NotesOptions;
+    protected getCommentOptions(): CommentOptions;
+    protected getNoteOptions(): NoteOptions;
     protected getCustomSortOptions(): CustomSortOptions;
     protected getDataSetOptions(): DataSetOptions;
     protected getCalendarOptions(): CalendarOptions;
@@ -66,7 +67,8 @@ export declare abstract class ApiBase {
     protected getExportOptions(): ExportOptions;
     protected getGroupingOptions(): GroupingOptions;
     protected getLayoutOptions(): LayoutOptions;
-    protected getMenuOptions(): MenuOptions;
+    protected getColumnMenuOptions(): ColumnMenuOptions;
+    protected getContextMenuOptions(): ContextMenuOptions;
     protected getColumnFilterOptions(): ColumnFilterOptions;
     protected getExpressionOptions(): ExpressionOptions;
     protected getPredicateOptions(): PredicateOptions;
@@ -122,7 +124,7 @@ export declare abstract class ApiBase {
     protected getStyledColumnApi(): StyledColumnApi;
     protected getToolPanelApi(): ToolPanelApi;
     protected getTeamSharingApi(): TeamSharingApi;
-    protected getScopeApi(): ScopeApi;
+    protected getColumnScopeApi(): ColumnScopeApi;
     protected getDataChangeHistoryApi(): DataChangeHistoryApi;
     protected getChartingApi(): ChartingApi;
     protected getStatusBarApi(): StatusBarApi;

package/src/Api/Implementation/ApiBase.js

@@ -105,7 +105,10 @@ class ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
-    getNotesOptions() {
+    getCommentOptions() {
+        return this.getOptions().commentOptions;
+    }
+    getNoteOptions() {
         return this.getOptions().noteOptions;
     }
     getCustomSortOptions() {
@@ -144,8 +147,11 @@ class ApiBase {
     getLayoutOptions() {
         return this.getOptions().layoutOptions;
     }
-    getMenuOptions() {
-        return this.getOptions().menuOptions;
+    getColumnMenuOptions() {
+        return this.getOptions().columnMenuOptions;
+    }
+    getContextMenuOptions() {
+        return this.getOptions().contextMenuOptions;
     }
     getColumnFilterOptions() {
         return this.getOptions().columnFilterOptions;
@@ -312,8 +318,8 @@ class ApiBase {
     getTeamSharingApi() {
         return this.getAdaptableApi().teamSharingApi;
     }
-    getScopeApi() {
-        return this.getAdaptableApi().scopeApi;
+    getColumnScopeApi() {
+        return this.getAdaptableApi().columnScopeApi;
     }
     getDataChangeHistoryApi() {
         return this.getAdaptableApi().dataChangeHistoryApi;

package/src/Api/Implementation/CalendarApiImpl.js

@@ -45,12 +45,7 @@ class CalendarApiImpl extends ApiBase_1.ApiBase {
         const holidays = this.getCalendarOptions().holidays;
         if (holidays) {
             if (typeof holidays === 'function') {
-                const baseContext = {
-                    userName: this.getOptions().userName,
-                    adaptableId: this.getOptions().adaptableId,
-                    adaptableApi: this.getAdaptableApi(),
-                };
-                return holidays(baseContext);
+                return holidays(this.getAdaptableApi().internalApi.buildBaseContext());
             }
             else {
                 return holidays;

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

@@ -9,9 +9,4 @@ export declare class CellSummaryApiImpl extends ApiBase implements CellSummaryAp
     setCurrentCellSummaryOperation(operation: SummaryOperation | string): void;
     getCellSummaryOperationValue(operation: SummaryOperation | string): any;
     getCurrentCellSummaryOperationValue(): any;
-    /**
-     * Weighted average is availabe only if the current layout has at leat a Weighted Average aggregation defined.
-     */
-    private isWeightedAverageCellSummaryAvailable;
-    private getWeightedAverageCellSummaryOperation;
 }

package/src/Api/Implementation/CellSummaryApiImpl.js

@@ -6,7 +6,6 @@ const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
-const weightedAverage_1 = require("../../agGrid/weightedAverage");
 class CellSummaryApiImpl extends ApiBase_1.ApiBase {
     openCellSummaryPopupSettingsPanel() {
         this.showModulePopup(ModuleConstants.CellSummaryModuleId);
@@ -17,12 +16,6 @@ class CellSummaryApiImpl extends ApiBase_1.ApiBase {
     getCellSummaryOperationDefinitions() {
         var _a;
         let cellSummaryOperations = (_a = this.getCellSummaryOptions().cellSummaryOperations) !== null && _a !== void 0 ? _a : [];
-        if (this.isWeightedAverageCellSummaryAvailable()) {
-            cellSummaryOperations = [
-                ...cellSummaryOperations,
-                this.getWeightedAverageCellSummaryOperation(),
-            ];
-        }
         return cellSummaryOperations;
     }
     setCurrentCellSummaryOperation(operation) {
@@ -54,6 +47,8 @@ class CellSummaryApiImpl extends ApiBase_1.ApiBase {
                 return cellSummary.Std_Deviation;
             case Enums_1.SummaryOperation.Only:
                 return cellSummary.Only;
+            case Enums_1.SummaryOperation.Weighted_Average:
+                return cellSummary.Weighted_Average;
             default:
                 return cellSummary[operation];
         }
@@ -65,21 +60,5 @@ class CellSummaryApiImpl extends ApiBase_1.ApiBase {
             : cellSummaryOperation.operationName;
         return this.getCellSummaryOperationValue(summaryOperation);
     }
-    /**
-     * Weighted average is availabe only if the current layout has at leat a Weighted Average aggregation defined.
-     */
-    isWeightedAverageCellSummaryAvailable() {
-        const currentLayout = this.getAdaptableApi().layoutApi.getCurrentLayout();
-        if (currentLayout.AggregationColumns == undefined) {
-            return false;
-        }
-        return Object.values(currentLayout.AggregationColumns).some((aggCol) => typeof aggCol === 'object' && aggCol.type === 'weightedAverage');
-    }
-    getWeightedAverageCellSummaryOperation() {
-        return {
-            operationName: 'Weighted Avg',
-            operationFunction: weightedAverage_1.cellSummaryWeightedAverage,
-        };
-    }
 }
 exports.CellSummaryApiImpl = CellSummaryApiImpl;

package/src/Api/Implementation/ChartingApiImpl.js

@@ -60,7 +60,7 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
     }
     showChartDefinitionOnce(chartDefinition, container) {
         var _a;
-        const chartRef = this.adaptable.api.chartingApi.getChartRef((_a = chartDefinition === null || chartDefinition === void 0 ? void 0 : chartDefinition.Model) === null || _a === void 0 ? void 0 : _a.chartId);
+        const chartRef = this.getAdaptableApi().chartingApi.getChartRef((_a = chartDefinition === null || chartDefinition === void 0 ? void 0 : chartDefinition.Model) === null || _a === void 0 ? void 0 : _a.chartId);
         if (chartRef) {
             return;
         }
@@ -96,7 +96,7 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
     }
     getOpenChartContainer(chartDefinition) {
         var _a, _b, _c;
-        const containerOptions = (_b = (_a = this.adaptable.api.optionsApi.getAdaptableOptions()) === null || _a === void 0 ? void 0 : _a.chartingOptions) === null || _b === void 0 ? void 0 : _b.chartContainers;
+        const containerOptions = (_b = (_a = this.getAdaptableApi().optionsApi.getAdaptableOptions()) === null || _a === void 0 ? void 0 : _a.chartingOptions) === null || _b === void 0 ? void 0 : _b.chartContainers;
         if (!containerOptions || !containerOptions.length) {
             return null;
         }
@@ -159,7 +159,7 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
                         ],
                     } }),
             };
-            this.adaptable.api.alertApi.showAdaptableAlert(alert);
+            this.getAdaptableApi().alertApi.showAdaptableAlert(alert);
         }
     }
     editExternalChartDefinition(chartDefinition) {