@adaptabletools/adaptable 10.0.4-canary.0 → 10.0.4-canary.4

package/src/Api/GridApi.d.ts

@@ -8,7 +8,7 @@ import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
 import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
 import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
 /**
  * Provides access to important properites of AdapTable e.g. sorting, selected cells etc.
@@ -20,7 +20,7 @@ export interface GridApi {
     getGridState(): GridState;
     /**
      * Repopulates grid with given data
-     * @param data any data from any datasource that is suitable for the underlying grid.
+     * @param data any data from any datasource that is suitable for AG Grid
      */
     setGridData(data: any): void;
     /**
@@ -33,23 +33,23 @@ export interface GridApi {
     getFilteredData(): any[];
     /**
      * Loads grid with given data
-     * @param data any data from any datasource that is suitable for the underlying grid.
+     * @param data any data from any datasource that is suitable for AG Grid
      */
     loadGridData(data: any): void;
     /**
-     * Updates Adaptable (and underlying grid) with rows that have changed
+     * Updates Adaptable (and AG Grid) with rows that have changed
      * @param dataRows rows which have been updated - send whole row and Adaptable will take care of the rest
      * @param config batch option and callback function to run post update
      */
     updateGridData(dataRows: any[], config?: DataUpdateConfig): void;
     /**
-     * Adds rows to Adaptable (and underlying grid)
+     * Adds rows to Adaptable (and AG Grid)
      * @param dataRows rows to add; ensure all 'mandatory' fields are included and Primary Key is unique
      * @param config batch option and callback function to run post addition
      */
     addGridData(dataRows: any[], config?: DataUpdateConfig): void;
     /**
-     * Deletes rows from Adaptable (and underlying grid)
+     * Deletes rows from Adaptable (and AG Grid)
      * @param dataRows rows which should be deleted
      * @param config batch option and callback function to run post deletion
      */
@@ -86,9 +86,9 @@ export interface GridApi {
      */
     getSelectedRowInfo(): SelectedRowInfo;
     /**
-     * Returns underlying Vendor Grid (object passed into Adaptable Options at start-up)
+     * Returns Ag Grid instance (passed into Adaptable Options at start-up)
      */
-    getVendorGrid(): any;
+    getAgGridInstance(): GridOptions;
     /**
      * Returns Column Sort information in Adaptable
      */
@@ -308,11 +308,11 @@ export interface GridApi {
      */
     fireSearchChangedEvent(searchChangedTrigger: 'DataSource' | 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort', searchAtDate?: Date): void;
     /**
-     * Fires Grid Data Changed Event - when any data in vendor grid data set has changed
+     * Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed
      */
     fireCellChangedEvent(cellChangedInfo: DataChangedInfo): void;
     /**
-     * Fires Grid Data Changed Event - when any data in vendor grid data set has changed
+     * Fires Grid Data Changed Event - when a row has changed in AG Grid
      */
     fireGridDataChangedEvent(dataRows: any[], rowTigger: 'Add' | 'Edit' | 'Delete'): void;
     /**

package/src/Api/Implementation/AlertApiImpl.js

@@ -159,6 +159,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     showFlashingAlert(alertToShow) {
         this.addUidToAdaptableObject(alertToShow);
         const flashingAlertFiredInfo = {
+            adaptableApi: this.adaptable.api,
             flashingAlert: alertToShow,
         };
         const results = this.adaptable.api.eventApi.emitSync('FlashingAlertFired', flashingAlertFiredInfo);
@@ -181,9 +182,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         this.addUidToAdaptableObject(alertToShow);
         this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getNotificationsOptions().maxAlertsInStore));
         // 2. Publish the Alert Fired Event
-        const alertFiredInfo = {
-            alert: alertToShow,
-        };
+        const alertFiredInfo = { adaptableApi: this.adaptable.api, alert: alertToShow };
         const results = await this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
         const showPopup = results.reduce((endResult, aResult) => {
             return endResult && aResult !== false;
@@ -233,9 +232,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         }
     }
     publishAlertFiredEvent(alertToFire) {
-        const alertFiredInfo = {
-            alert: alertToFire,
-        };
+        const alertFiredInfo = { adaptableApi: this.adaptable.api, alert: alertToFire };
         this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
     }
     displayMessageAlertPopup(alertToDisplayAsPopup) {
@@ -311,14 +308,17 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         return flashingAlertDefinitions === null || flashingAlertDefinitions === void 0 ? void 0 : flashingAlertDefinitions.map((alert) => this.getFlashingAlertDefinitionById(alert === null || alert === void 0 ? void 0 : alert.Uuid));
     }
     getAlertDescription(alertDefinition, dataChangedInfo) {
-        if (alertDefinition.MessageText != null) {
-            if (typeof alertDefinition.MessageText === 'function') {
-                return alertDefinition.MessageText(alertDefinition.Scope, alertDefinition.Rule, dataChangedInfo);
-            }
-            else {
-                return alertDefinition.MessageText;
+        var _a;
+        const alertMessageFunction = (_a = this.adaptable.adaptableOptions.notificationsOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
+        if (alertMessageFunction) {
+            const returnText = alertMessageFunction(alertDefinition, dataChangedInfo);
+            if (returnText) {
+                return returnText;
             }
         }
+        if (alertDefinition.MessageText != null) {
+            return alertDefinition.MessageText;
+        }
         let scopeDescription = this.adaptable.api.scopeApi.getScopeDescription(alertDefinition.Scope);
         let ruleDescription = this.getAlertRuleDescription(alertDefinition);
         return scopeDescription + ' - ' + ruleDescription;

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

@@ -3,7 +3,7 @@ import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../../PredefinedConfig/Common/Enums';
 import { ColumnApi } from '../ColumnApi';
 import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { Column, RowNode } from '@ag-grid-community/all-modules';
 export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getColumns(): AdaptableColumn[];
     getVisibleColumns(): AdaptableColumn[];
@@ -15,7 +15,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     selectColumns(columnIds: string[]): void;
     hideColumn(columnId: string): void;
     showColumn(columnId: string): void;
-    getVendorColumnType(columnId: string): string | string[];
+    getAgGridColumnType(columnId: string): string | string[];
     isRowGroupColumn(columnId: string): boolean;
     isCalculatedColumn(columnId: string): boolean;
     isFreeTextColumn(columnId: string): boolean;
@@ -35,7 +35,8 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     doesColumnExist(columnId: string): boolean;
     getColumnFromId(columnId: string, logWarning?: boolean): AdaptableColumn | undefined;
     getColumnIdsFromId(columnId: string, logWarning?: boolean): string[] | undefined;
-    getVendorGridColumnFieldForColumn(colId: string): string;
+    getAgGridColumnFieldForAdaptableColumn(colId: string): string;
+    getAgGridColumnForAdaptableColumn(columnId: string): Column;
     getColumnFromFriendlyName(columnName: string, logWarning?: boolean): AdaptableColumn;
     getColumnsOfType(dataType: DataType): AdaptableColumn[];
     getNumericColumns(): AdaptableColumn[];

package/src/Api/Implementation/ColumnApiImpl.js

@@ -44,8 +44,8 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     showColumn(columnId) {
         this.adaptable.showColumn(columnId);
     }
-    getVendorColumnType(columnId) {
-        return this.adaptable.getVendorColumnType(columnId);
+    getAgGridColumnType(columnId) {
+        return this.adaptable.getAgGridColumnType(columnId);
     }
     isRowGroupColumn(columnId) {
         // put this here as there might be other indicators we are not aware of
@@ -187,8 +187,12 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
         return undefined;
     }
-    getVendorGridColumnFieldForColumn(colId) {
-        return this.adaptable.getVendorGridColumnFieldForColumn(this.getColumnFromId(colId));
+    getAgGridColumnFieldForAdaptableColumn(colId) {
+        const agGridColumn = this.getAgGridColumnForAdaptableColumn(colId);
+        return agGridColumn.getColDef().field || '';
+    }
+    getAgGridColumnForAdaptableColumn(columnId) {
+        return this.adaptable.getAgGridColumnForAdaptableColumn(this.getColumnFromId(columnId));
     }
     getColumnFromFriendlyName(columnName, logWarning = true) {
         // just return null if no columns rather than logging a warning - otherwise get lots at startup
@@ -272,7 +276,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
         const returnValues = this.adaptable.getDistinctValuesForColumn(abColumn, false);
         return this.sortDistinctValues(returnValues, abColumn).map((cv) => {
-            return cv.displayValue;
+            return cv.normalisedValue;
         });
     }
     async getDistinctFilterDisplayValuesForColumn(columnId, filter) {
@@ -283,10 +287,10 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
                 suppressClientSideFilter: false,
             };
         }
-        const { gridCells, suppressClientSideFilter, } = await this.adaptable.getDistinctFilterValuesForColumn(abColumn, false, filter);
+        const { gridCells, suppressClientSideFilter } = await this.adaptable.getDistinctFilterValuesForColumn(abColumn, false, filter);
         return {
             values: this.sortDistinctValues(gridCells, abColumn).map((cv) => {
-                return cv.displayValue;
+                return cv.normalisedValue;
             }),
             suppressClientSideFilter,
         };
@@ -298,7 +302,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
         const gridCells = await this.adaptable.getDistinctCustomSortValuesForColumn(abColumn, false);
         return this.sortDistinctValues(gridCells, abColumn).map((cv) => {
-            return cv.displayValue;
+            return cv.normalisedValue;
         });
     }
     async getDistinctBulkUpdateDisplayValuesForColumn(columnId, selectedGridCells) {
@@ -308,7 +312,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
         const gridCells = await this.adaptable.getDistinctBulkUpdateValuesForColumn(abColumn, false, selectedGridCells);
         return this.sortDistinctValues(gridCells, abColumn).map((cv) => {
-            return cv.displayValue;
+            return cv.normalisedValue;
         });
     }
     getDistinctVisibleDisplayValuesForColumn(columnId) {
@@ -318,7 +322,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         }
         const returnValues = this.adaptable.getDistinctValuesForColumn(abColumn, true);
         return this.sortDistinctValues(returnValues, abColumn).map((cv) => {
-            return cv.displayValue;
+            return cv.normalisedValue;
         });
     }
     getDistinctRawValuesForColumn(columnId, skipRowNode) {
@@ -370,8 +374,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         });
     }
     usesAdaptableFilterForm(columnId) {
-        const useAdaptableFilterForm = this.getFilterOptions()
-            .useAdaptableFilterForm;
+        const useAdaptableFilterForm = this.getFilterOptions().useAdaptableFilterForm;
         if (useAdaptableFilterForm == null || useAdaptableFilterForm == false) {
             return false;
         }
@@ -381,8 +384,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return true;
     }
     usesAdaptableQuickFilter(columnId) {
-        const useAdaptableQuickFilter = this.getFilterOptions()
-            .useAdaptableQuickFilter;
+        const useAdaptableQuickFilter = this.getFilterOptions().useAdaptableQuickFilter;
         if (useAdaptableQuickFilter == null || useAdaptableQuickFilter == false) {
             return false;
         }

package/src/Api/Implementation/ConfigApiImpl.js

@@ -179,18 +179,10 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Application)
                     : this.getAdaptableState().Application;
-            case 'BulkUpdate':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().BulkUpdate)
-                    : this.getAdaptableState().BulkUpdate;
             case 'CalculatedColumn':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().CalculatedColumn)
                     : this.getAdaptableState().CalculatedColumn;
-            case 'CellSummary':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().SelectedCells)
-                    : this.getAdaptableState().CellSummary;
             case 'Chart':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Chart)
@@ -211,10 +203,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().DataSource)
                     : this.getAdaptableState().DataSource;
-            case 'Entitlement':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().Entitlements)
-                    : this.getAdaptableState().Entitlements;
             case 'Export':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Export)
@@ -255,18 +243,10 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Shortcut)
                     : this.getAdaptableState().Shortcut;
-            case 'SmartEdit':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().SmartEdit)
-                    : this.getAdaptableState().SmartEdit;
             case 'SparklineColumn':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().SparklineColumn)
                     : this.getAdaptableState().SparklineColumn;
-            case 'SystemStatus':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().SystemStatus)
-                    : this.getAdaptableState().SystemStatus;
             case 'Theme':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Theme)
@@ -275,10 +255,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().ToolPanel)
                     : this.getAdaptableState().ToolPanel;
-            case 'UserInterface':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().UserInterface)
-                    : this.getAdaptableState().UserInterface;
         }
     }
     incrementUerStateRevision(stateKey) {

package/src/Api/Implementation/DashboardApiImpl.js

@@ -18,6 +18,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
         // so we debounced to only get tha latest call
         this.fireDashboardChangedEvent = (trigger, oldDashboardState, newDashboardState) => {
             const dashboardChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 actionName: trigger,
                 oldDashboardState: oldDashboardState,
                 newDashboardState: newDashboardState,
@@ -39,7 +40,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
     getCustomDashboardButtonByLabel(buttonLabel) {
         const api = this.getAdaptableApi();
         const dashboardContext = {
-            api,
+            adaptableApi: api,
             dashboardState: api.dashboardApi.getDashboardState(),
         };
         return this.getDashboardOptions().customDashboardButtons.find((cb) => {

package/src/Api/Implementation/FilterApiImpl.js

@@ -174,7 +174,7 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         return this.adaptable.api.predicateApi.handlePredicate(columnFilter.Predicate, {
             value: gridCell.normalisedValue,
             oldValue: null,
-            displayValue: gridCell.displayValue,
+            displayValue: gridCell.normalisedValue,
             node,
             column,
         }, true);

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -256,6 +256,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     }
     fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
         let checkboxColumnClickedInfo = {
+            adaptableApi: this.adaptable.api,
             column: this.adaptable.api.columnApi.getColumnFromId(columnId),
             rowData: rowData,
             primaryKeyValue: primaryKeyValue,

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

@@ -8,7 +8,7 @@ import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { DataUpdateConfig } from '../../PredefinedConfig/Common/DataUpdateConfig';
 import { DataChangedInfo, AccessLevel, AdaptableModule } from '../../types';
 import { CellHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightInfo';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
 import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridState(): GridState;
@@ -34,7 +34,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     hideFilterForm(): void;
     applyGridFiltering(): void;
     clearGridFiltering(): void;
-    getVendorGrid(): any;
+    getAgGridInstance(): GridOptions;
     getColumnSorts(): ColumnSort[];
     getColumnSortForColumn(columnId: string): ColumnSort | undefined;
     setAdaptableSorting(columnSorts: ColumnSort[]): void;

package/src/Api/Implementation/GridApiImpl.js

@@ -87,7 +87,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         // slightly round the houses but we have to call FilterAPI as it does it properly
         this.adaptable.api.filterApi.clearAllColumnFilter();
     }
-    getVendorGrid() {
+    getAgGridInstance() {
         return this.adaptable.adaptableOptions.vendorGrid;
     }
     getColumnSorts() {
@@ -230,6 +230,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             const adaptableSearchState = this.adaptable.api.configApi.getAdaptableSearchState();
             const adaptableSortState = this.adaptable.api.configApi.getAdaptableSortState();
             const searchChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 searchChangedTrigger,
                 adaptableSearchState: adaptableSearchState,
                 adaptableSortState: adaptableSortState,
@@ -240,6 +241,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     fireCellChangedEvent(dataChangedInfo) {
         if (this.adaptable.isInitialised) {
             const cellChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 cellChange: dataChangedInfo,
             };
             this.adaptable.api.eventApi.emit('CellChanged', cellChangedInfo);
@@ -248,6 +250,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     fireGridDataChangedEvent(dataRows, rowTigger) {
         if (this.adaptable.isInitialised) {
             const gridDataChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 rowTigger: rowTigger,
                 dataRows: dataRows,
             };
@@ -296,8 +299,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
                 }
                 let cellEditableFn = this.adaptable.adaptableOptions.editOptions.isCellEditable;
                 if (cellEditableFn) {
-                    let rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(gridCell.primaryKeyValue);
-                    let functionReturnValue = cellEditableFn(gridCell, rowNode);
+                    let functionReturnValue = cellEditableFn(gridCell);
                     if (!functionReturnValue) {
                         returnValue = false;
                     }
@@ -331,7 +333,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this.adaptable.destroy();
     }
     getGridContainerElement() {
-        return this.adaptable.getGridContainerElement();
+        return this.adaptable.getAgGridContainerElement();
     }
 }
 exports.GridApiImpl = GridApiImpl;

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

@@ -80,7 +80,7 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     setDefaultDashboardTab(): void;
     getPrimaryKey(): any;
     getAdaptableInstance(): IAdaptable;
-    getVendorGridInstance(): any;
+    getAgGridInstance(): any;
     getPredefinedConfig(): any;
     getState(): AdaptableState;
     getAdaptableOptions(): AdaptableOptions;

package/src/Api/Implementation/InternalApiImpl.js

@@ -205,7 +205,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     getAdaptableInstance() {
         return this.adaptable;
     }
-    getVendorGridInstance() {
+    getAgGridInstance() {
         return this.adaptable.adaptableOptions.vendorGrid;
     }
     getPredefinedConfig() {
@@ -272,7 +272,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     }
     getCustomSortComparer(column) {
         var _a;
-        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => csc.columnId == column.columnId);
+        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => this.adaptable.api.scopeApi.isColumnInScope(column, csc.scope));
     }
     getLabelForButton(button, context) {
         if (!button.label) {

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

@@ -21,10 +21,12 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     createLayout(layoutToCreate: Layout): Layout | undefined;
     cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout;
     cloneLayout(layoutToClone: Layout, layoutName: string): Layout;
+    setColumnCaption(columnId: string, caption: string): void;
     saveLayout(layoutToSave: Layout): void;
     areLayoutsEqual(layout1: Layout, layout2: Layout): boolean;
     getLayoutDescription(layout: Layout): string;
     private getColumnSort;
     createDefaultLayoutIfNeeded(): Layout | null;
     showLayoutPopup(): void;
+    isCurrentLayoutReadOnly(): boolean;
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -50,6 +50,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     }
     fireLayoutChangedEvent(trigger, oldSate, newState) {
         const layoutChangedInfo = {
+            adaptableApi: this.adaptable.api,
             actionName: trigger,
             oldLayoutState: oldSate,
             newLayoutState: newState,
@@ -138,6 +139,14 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(LayoutRedux.LayoutAdd(newLayout));
         return this.getLayoutById(newLayout.Uuid);
     }
+    setColumnCaption(columnId, caption) {
+        if (StringExtensions_1.default.IsNotNullOrEmpty(columnId) && StringExtensions_1.default.IsNotNullOrEmpty(caption)) {
+            const currentLayoutName = this.getCurrentLayoutName();
+            if (StringExtensions_1.default.IsNotNullOrEmpty(currentLayoutName)) {
+                this.dispatchAction(LayoutRedux.LayoutSetColumnCaption(currentLayoutName, columnId, caption));
+            }
+        }
+    }
     saveLayout(layoutToSave) {
         if (!this.doesLayoutExist(layoutToSave)) {
             this.addUidToAdaptableObject(layoutToSave);
@@ -211,5 +220,12 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     showLayoutPopup() {
         this.showModulePopup(ModuleConstants.LayoutModuleId);
     }
+    isCurrentLayoutReadOnly() {
+        const currentLayout = this.getCurrentLayout();
+        if (currentLayout) {
+            return currentLayout.IsReadOnly;
+        }
+        return true;
+    }
 }
 exports.LayoutApiImpl = LayoutApiImpl;

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

@@ -11,8 +11,8 @@ export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
     getPluginState(pluginId: string): any;
     registerPlugin(pluginId: string, initialPluginState: any): void;
     setPluginState(pluginId: string, newPluginState: any): void;
-    getPluginApi(pluginId: string): any | IPushPullApi | Glue42Api | OpenFinApi | FinanceApi | ChartApi;
-    getIpushpullPluginApi(): IPushPullApi;
+    private getPluginApi;
+    getipushpullPluginApi(): IPushPullApi;
     getGlue42PluginApi(): Glue42Api;
     getOpenFinPluginApi(): OpenFinApi;
     getChartsPluginApi(): ChartApi;

package/src/Api/Implementation/PluginsApiImpl.js

@@ -41,7 +41,7 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
             return null;
         }
     }
-    getIpushpullPluginApi() {
+    getipushpullPluginApi() {
         return this.getPluginApi('ipushpull');
     }
     getGlue42PluginApi() {

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -76,7 +76,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllIPushPullSchedule() {
-        const ippApi = this.adaptable.api.pluginsApi.getPluginApi('ipushpull');
+        const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
         return ippApi ? ippApi.getIPushPullSchedules() : [];
     }
     getAllActiveIPushPullSchedule() {
@@ -105,7 +105,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllGlue42Schedule() {
-        const glue42Api = this.adaptable.api.pluginsApi.getPluginApi('glue42');
+        const glue42Api = this.adaptable.api.pluginsApi.getGlue42PluginApi();
         return glue42Api ? glue42Api.getGlue42Schedules() : [];
     }
     getAllActiveGlue42Schedule() {
@@ -134,7 +134,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllOpenFinSchedule() {
-        const openFinApi = this.adaptable.api.pluginsApi.getPluginApi('openfin');
+        const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
         return openFinApi ? openFinApi.getOpenFinSchedules() : [];
     }
     getAllActiveOpenFinSchedule() {
@@ -185,7 +185,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
             this.adaptable.api.exportApi.sendReport(reportSchedule.ReportName, reportSchedule.ExportDestination);
         }
         else if (scheduleType == 'ipushpull') {
-            const ippApi = this.adaptable.api.pluginsApi.getPluginApi('ipushpull');
+            const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
             const iPushPullSchedule = schedule;
             if (iPushPullSchedule.Transmission == 'Snapshot') {
                 ippApi.sendSnapshot(iPushPullSchedule.IPushPullReport);
@@ -195,12 +195,12 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
             }
         }
         else if (scheduleType == 'Glue42') {
-            const glue42Api = this.adaptable.api.pluginsApi.getPluginApi('glue42');
+            const glue42Api = this.adaptable.api.pluginsApi.getGlue42PluginApi();
             const glue42Schedule = schedule;
             glue42Api.sendSnapshotToDo(glue42Schedule.Glue42Report);
         }
         else if (scheduleType == 'OpenFin') {
-            const openFinApi = this.adaptable.api.pluginsApi.getPluginApi('openfin');
+            const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
             const openFinSchedule = schedule;
             openFinApi.startLiveData(openFinSchedule.OpenFinReport);
         }

package/src/Api/Implementation/SystemStatusApiImpl.js

@@ -80,6 +80,7 @@ class SystemStatusApiImpl extends ApiBase_1.ApiBase {
     }
     fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo) {
         const systemStatusMessageDisplayedInfo = {
+            adaptableApi: this.adaptable.api,
             systemStatusMessageInfo: systemStatusMessageInfo,
         };
         this.adaptable.api.eventApi.emit('SystemStatusMessageDisplayed', systemStatusMessageDisplayedInfo);

package/src/Api/Implementation/TeamSharingApiImpl.js

@@ -35,6 +35,7 @@ class TeamSharingApiImpl extends ApiBase_1.ApiBase {
     fireTeamSharingEntityChangedEvent(sharedEntity) {
         if (this.adaptable.isInitialised) {
             const teamSharingEntityChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 sharedEntity: sharedEntity,
             };
             this.adaptable.api.eventApi.emit('TeamSharingEntityChanged', teamSharingEntityChangedInfo);

package/src/Api/Implementation/ThemeApiImpl.js

@@ -48,6 +48,7 @@ class ThemeApiImpl extends ApiBase_1.ApiBase {
         }
         this.adaptable.applyAdaptableTheme(currentTheme);
         let themeChangedInfo = {
+            adaptableApi: this.adaptable.api,
             theme: currentTheme,
         };
         this.adaptable.api.eventApi.emit('ThemeChanged', themeChangedInfo);

package/src/Api/Implementation/ToolPanelApiImpl.js

@@ -15,7 +15,7 @@ class ToolPanelApiImpl extends ApiBase_1.ApiBase {
     openAdapTableToolPanel() {
         let gridOptions = this.getOptions().vendorGrid;
         if (gridOptions) {
-            gridOptions.api.openToolPanel('AdaptableToolPanel');
+            gridOptions.api.openToolPanel('adaptable');
         }
     }
     closeAdapTableToolPanel() {

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

@@ -2,7 +2,7 @@ import { ApiBase } from './ApiBase';
 import { UserInterfaceApi } from '../UserInterfaceApi';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
-import { UserMenuItem } from '../../PredefinedConfig/Common/Menu';
+import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../../PredefinedConfig/Common/Menu';
 import { ActionColumn, BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../../AdaptableOptions/UserInterfaceOptions';
 import { GridCell } from '../../types';
 export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfaceApi {
@@ -20,8 +20,8 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     getAllEditLookUpItems(): EditLookUpPermittedValues[];
     getEditLookUpItemForColumn(column: AdaptableColumn): EditLookUpPermittedValues | undefined;
     getEditLookUpValuesForEditLookUpItem(editLookUpItem: EditLookUpPermittedValues, gridCell: GridCell): any[] | undefined;
-    addColumnMenuItem(columnMenuItem: UserMenuItem): void;
-    addContextMenuItem(contextMenuItem: UserMenuItem): void;
+    addColumnMenuItem(userMenuItem: UserMenuItem<ColumnMenuContext>): void;
+    addContextMenuItem(userMenuItem: UserMenuItem<ContextMenuContext>): void;
     getEditableCellStyle(): AdaptableStyle | undefined;
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     getAllActionColumn(): ActionColumn[];