@adaptabletools/adaptable-cjs 18.0.0-canary.3 → 18.0.0-canary.31

package/src/Api/CommentApi.d.ts

@@ -1,58 +1,56 @@
 import { CommentThread } from '../PredefinedConfig/CommentState';
-import { CellAddress } from '../PredefinedConfig/CellAddress';
-import { AdaptableComment } from '../types';
+import { AdaptableComment, CellAddress } from '../types';
 /**
- * Provides run-time access to Notes Module and related State
+ * Provides run-time access to Comment Module and related State
  */
 export interface CommentApi {
     /**
-     * Add comment to comment thread
+     * Add a Comment to a Comment Thread
      *
      * @param comment comment
-     * @param address where the comment should be added
+     * @param cellAddress cell where comment is added
      */
-    addComment(commentText: string, address: CellAddress): void;
+    addComment(commentText: string, cellAddress: CellAddress): void;
     /**
-     * Edit comment
+     * Edit a Comment
      *
      * @param comment Comment to edit
      * @param cellAddress Location of the comment, if not provided all comments will be traversed to find the comment
      */
     editComment(comment: AdaptableComment, cellAddress?: CellAddress): void;
     /**
-     * Delete a comment
+     * Delete a Comment
      * @param address Location of the comment, if not provided all comments will be traversed to find the comment
      */
     deleteComment(comment: AdaptableComment, cellAddress: CellAddress): void;
     /**
-     * Gets comments on a particular cell
-     * @param CellAddress
+     * Create a new Comment Thread
+     *
+     * @param commentThread
      */
-    getComments(cellAddress: CellAddress): AdaptableComment[];
+    addCommentThread(commentThread: CommentThread): void;
     /**
-     *  Delete all comments on a particular cell
+     *  Delete all Comments for a particular cell
      * @param cellAddress
      */
     deleteCommentThread(cellAddress: CellAddress): void;
     /**
-     * Returns cell comments at the given address
+     * Return the Comment Thread for a particular cell
      * @param cellAddress
      */
     getCommentThread(cellAddress: CellAddress): CommentThread | undefined;
     /**
-     * Returns all comment threads
+     * Return all Comment Threads in the grid
      */
-    getCommentThreads(): CommentThread[];
+    getGridComments(): CommentThread[];
     /**
-     * Called to add a new comment thread
+     * Sets the Comment Threads in the grid
      *
-     * @param commentThread
+     * @param commentThreads new cell comments
      */
-    addCommentThread(commentThread: CommentThread): void;
+    setGridComments(commentThreads: CommentThread[]): void;
     /**
-     * Called to set all cell comments
-     *
-     * @param commentThreads new cell comments
+     * Clear all Comment Threads in the grid
      */
-    loadCommentThreads(commentThreads: CommentThread[]): void;
+    clearGridComments(): void;
 }

package/src/Api/ConfigApi.d.ts

@@ -15,8 +15,7 @@ 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
  */
@@ -27,7 +26,7 @@ export interface ConfigApi {
      */
     setAdaptableStateKey(adaptableStateKey: string, config?: {
         predefinedConfig: PredefinedConfig;
-    }): PromiseLike<void>;
+    }): Promise<void>;
     /**
      * Returns current Predefined Config
      */
@@ -105,10 +104,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/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/AdaptableReady.d.ts

@@ -1,11 +1,11 @@
-import { GridOptions } from '@ag-grid-community/core';
+import { GridApi } from '@ag-grid-community/core';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by `AdaptableReady` event - fired when AdapTable has loaded
  */
 export interface AdaptableReadyInfo<TData = any> extends BaseEventInfo {
     /**
-     * Underlying AG Grid GridOptions object
+     * Underlying AG Grid API
      */
-    gridOptions: GridOptions<TData>;
+    agGridApi: GridApi<TData>;
 }

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/GridDataChanged.d.ts

@@ -1,9 +1,9 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { BaseEventInfo } from './BaseEventInfo';
+export type GridDataChangeTrigger = 'Add' | 'Edit' | 'Delete' | 'Load';
 /**
  * EventInfo returned by GridDataChanged event
- */
-export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
+ */ export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
     /**
      * Timestamp of change occurrence (in milliseconds)
      */
@@ -13,9 +13,9 @@ export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
      */
     dataRows: TData[];
     /**
-     * Trigger for row change: 'Add', 'Edit' or 'Delete'
+     * Trigger for row change: Load, Add, Edit, or Delete
      */
-    rowTrigger: 'Add' | 'Edit' | 'Delete';
+    rowTrigger: GridDataChangeTrigger;
     /**
      * Row Nodes that were affected by this change
      */

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 { GridOptions, 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.
  */
@@ -27,15 +28,22 @@ export interface GridApi {
      */
     getFilteredData(): any[];
     /**
-     * Repopulates Grid with given data; fires `GridDataChanged` Event
-     * @param data any data suitable as AG Grid data source
+     * Retrieves visible data from the grid (filtered and sorted)
+     */
+    getVisibleData(): any[];
+    /**
+     * @deprecated use `loadGridData()` instead
      */
     resetGridData(data: any[]): void;
     /**
-     * Sets grid with given data for FIRST use; doesn't fire 'GridDataChanged' Event
-     * @param dataany data suitable as AG Grid data source
+     * @deprecated use `loadGridData()` instead
      */
     setInitialGridData(data: any): void;
+    /**
+     * Loads data into grid and fire a `GridDataChanged.trigger='Load'` event
+     * @param data data to load
+     */
+    loadGridData(data: any): void;
     /**
      * Updates AdapTable (and AG Grid) with rows that have changed
      * @param dataRows rows which have been updated - send whole row and AdapTable take cares of the rest
@@ -86,10 +94,6 @@ export interface GridApi {
      * Returns all current Selected Rows in AdapTable
      */
     getSelectedRowInfo(): SelectedRowInfo;
-    /**
-     * Returns Ag Grid instance (passed into Adaptable Options at start-up)
-     */
-    getAgGridInstance(): GridOptions;
     /**
      * Returns Column Sort information in AdapTable
      */
@@ -355,13 +359,27 @@ 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
@@ -469,10 +487,6 @@ export interface GridApi {
      * Returns number of rows in Data Source
      */
     getRowCount(): number;
-    /**
-     * Returns number of visible rows in Data Source
-     */
-    getVisibleRowCount(): number;
     /**
      * Returns number of columns in Data Source
      */
@@ -515,4 +529,18 @@ export interface GridApi {
      * Returns AG Grid Row Model Type
      */
     getAgGridRowModelType(): RowModelType;
+    /**
+     * Returns number of visible rows in Data Source
+     *
+     * @deprecated use `getRowCount()` instead
+     */
+    getVisibleRowCount(): number;
+    /**
+     * Opens a window with a transposed view of Grid
+     */
+    showTransposedView(transposeConfig?: TransposeConfig): void;
+    /**
+     * Return all AG Grid columns
+     */
+    getAllAgGridColumns(): Column<any>[];
 }

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

@@ -1,7 +1,9 @@
 import { ActionColumn, ActionColumnApi } from '../../../types';
 import { ApiBase } from './ApiBase';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { ColDef } from '@ag-grid-community/core';
 export declare class ActionColumnApiImpl extends ApiBase implements ActionColumnApi {
     constructor(adaptable: IAdaptable);
     getActionColumns(): ActionColumn[];
+    getColDefsForActionColumns(): ColDef[];
 }

package/src/Api/Implementation/ActionColumnApiImpl.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionColumnApiImpl = void 0;
 const ApiBase_1 = require("./ApiBase");
+const ActionColumnRenderer_1 = require("../../agGrid/ActionColumnRenderer");
+const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 class ActionColumnApiImpl extends ApiBase_1.ApiBase {
     constructor(adaptable) {
         super(adaptable);
@@ -10,5 +12,33 @@ class ActionColumnApiImpl extends ApiBase_1.ApiBase {
         var _a;
         return (_a = this.getActionColumnOptions().actionColumns) !== null && _a !== void 0 ? _a : [];
     }
+    getColDefsForActionColumns() {
+        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) => {
+            const actionColumnSettings = Object.assign(Object.assign({}, defaultActionColumnSettings), actionColumn.actionColumnSettings);
+            const newColDef = {
+                headerName: actionColumn.friendlyName ? actionColumn.friendlyName : actionColumn.columnId,
+                colId: actionColumn.columnId,
+                hide: false,
+                editable: false,
+                width: actionColumnSettings.width,
+                resizable: actionColumnSettings.resizable,
+                suppressHeaderMenuButton: actionColumnSettings.suppressMenu,
+                suppressMovable: actionColumnSettings.suppressMovable,
+                filter: false,
+                sortable: false,
+                enableRowGroup: false,
+                cellRenderer: this.getAdaptableApi().internalApi.getAdaptableInstance().variant === 'react'
+                    ? ActionColumnRenderer_1.ReactActionColumnRenderer
+                    : ActionColumnRenderer_1.ActionColumnRenderer,
+                type: [GeneralConstants_1.AB_SPECIAL_COLUMN, 'abColDefObject'],
+            };
+            this.getAdaptableApi().logInfo('Setting up Action Column: ' + actionColumn.columnId);
+            return newColDef;
+        });
+    }
 }
 exports.ActionColumnApiImpl = ActionColumnApiImpl;

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

@@ -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';
@@ -90,7 +90,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     dataChangeHistoryApi: DataChangeHistoryApi;
     chartingApi: ChartingApi;
     statusBarApi: StatusBarApi;
-    notesApi: NotesApi;
+    noteApi: NoteApi;
     fdc3Api: Fdc3Api;
     dataImportApi: DataImportApi;
     gridFilterApi: GridFilterApi;
@@ -98,6 +98,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     commentApi: CommentApi;
     private destroyed;
     constructor(adaptable: IAdaptable);
+    get agGridApi(): import("@ag-grid-community/core/dist/esm/es6/gridApi").GridApi<any>;
     /**
      * This is only meant to be called by the Adaptable instance.
      */

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -43,7 +43,7 @@ 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");
@@ -97,7 +97,7 @@ class AdaptableApiImpl {
         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);
@@ -106,6 +106,9 @@ class AdaptableApiImpl {
         // adaptable internal api
         this.internalApi = new AdaptableInternalApi_1.AdaptableInternalApi(adaptable);
     }
+    get agGridApi() {
+        return this.adaptable.agGridAdapter.getAgGridApi();
+    }
     /**
      * This is only meant to be called by the Adaptable instance.
      */

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);

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

@@ -1,5 +1,5 @@
 import { Action } from 'redux';
-import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { AdaptableVariant, IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableState } from '../../PredefinedConfig/AdaptableState';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 import { AdaptableObject } from '../../PredefinedConfig/Common/AdaptableObject';
@@ -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, MenuOptions, NamedQueryApi, NoteOptions, 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 { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
@@ -20,6 +20,7 @@ export declare abstract class ApiBase {
     protected logSuccess(message: string, ...optionalParams: any[]): void;
     protected logWarn(message: string, ...optionalParams: any[]): void;
     protected logError(message: string, ...optionalParams: any[]): void;
+    protected getAdaptableVariant(): AdaptableVariant;
     /**
      * Base api helper method which ensure that Adaptable Object being used in the function is not null or undefined
      *
@@ -52,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;

package/src/Api/Implementation/ApiBase.js

@@ -25,6 +25,9 @@ class ApiBase {
     logError(message, ...optionalParams) {
         this.adaptable.logger.error(message, ...optionalParams);
     }
+    getAdaptableVariant() {
+        return this.adaptable.variant;
+    }
     /**
      * Base api helper method which ensure that Adaptable Object being used in the function is not null or undefined
      *
@@ -102,8 +105,11 @@ class ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
-    getNotesOptions() {
-        return this.getOptions().notesOptions;
+    getCommentOptions() {
+        return this.getOptions().commentOptions;
+    }
+    getNoteOptions() {
+        return this.getOptions().noteOptions;
     }
     getCustomSortOptions() {
         return this.getOptions().customSortOptions;

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

@@ -6,5 +6,4 @@ export declare class BulkUpdateApiImpl extends ApiBase implements BulkUpdateApi
     openBulkUpdateSettingsPanel(): void;
     showBulkUpdatePopup(): void;
     applyBulkUpdate(cellUpdateRequests: CellUpdateRequest[]): void;
-    setBulkUpdateValue(bulkUpdateValue: string): void;
 }

package/src/Api/Implementation/BulkUpdateApiImpl.js

@@ -5,7 +5,6 @@ const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const BulkUpdateRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/BulkUpdateRedux"));
-const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 class BulkUpdateApiImpl extends ApiBase_1.ApiBase {
     getBulkUpdateValue() {
         return this.getAdaptableState().System.BulkUpdateValue;
@@ -19,8 +18,5 @@ class BulkUpdateApiImpl extends ApiBase_1.ApiBase {
     applyBulkUpdate(cellUpdateRequests) {
         this.dispatchAction(BulkUpdateRedux.BulkUpdateApply(cellUpdateRequests));
     }
-    setBulkUpdateValue(bulkUpdateValue) {
-        this.dispatchAction(SystemRedux.BulkUpdateChangeValue(bulkUpdateValue));
-    }
 }
 exports.BulkUpdateApiImpl = BulkUpdateApiImpl;

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;
 }