@adaptabletools/adaptable 11.0.0-canary.4 → 11.0.0-canary.5

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -29,7 +29,7 @@ export interface ContainerOptions {
      * @defaultValue undefined
      * @gridInfoItem
      */
-    modalContainer?: string;
+    modalContainer?: string | HTMLElement;
     /**
      * Div to show System Status messages - string Id or HTMLElement
      *

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -38,7 +38,7 @@ export interface FilterOptions {
      */
     useAdaptableFilterForm?: boolean | string[];
     /**
-     * Styles Adaptable Filter Form to match AG Grid's current styling
+     * Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)
      *
      * @defaultValue true
      * @gridInfoItem

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,19 +1,7 @@
-import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
-import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
-import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
-import { DataChangedInfo } from '../types';
 /**
- * Options related to Alerts, System Status Messages and Notifications in Adaptable.
+ * Options related to System Status Messages and Notifications in Adaptable.
  */
 export interface NotificationsOptions {
-    /**
-     * How many alerts held in State at any one time; when limit is breached, oldest alert will be removed
-     *
-     * @defaultValue  20
-     * @gridInfoItem
-     */
-    maxAlertsInStore?: number;
     /**
      * How many Notifications can be displayed at one time
      *
@@ -35,13 +23,6 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     duration?: number | 'always';
-    /**
-     * How long (in ms) a cell will be highlighted
-     *
-     * @defaultValue 3000
-     * @gridInfoItem
-     */
-    cellHighlightDuration?: number;
     /**
      * Shows a Progress Bar in the Notification
      *
@@ -77,21 +58,6 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     transition?: 'Bounce' | 'Slide' | 'Zoom' | 'Flip';
-    /**
-     * onClick Handlers for Alert Buttons (defined in Alert State)
-     */
-    actionHandlers?: ActionHandler[];
-    /**
-     * Full definitions of Alert Forms - the names of which are provided in Alert State
-     */
-    alertForms?: AlertForm[];
-    /**
-     * Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data
-     *
-     * @defaultValue 'rawValue'
-     * @gridInfoItem
-     */
-    dataChangeDetectionPolicy?: 'rawValue' | 'formattedValue';
     /**
      * Display an Alert when a System Status Message is set
      *
@@ -111,49 +77,6 @@ export interface NotificationsOptions {
      * @defaultValue false
      */
     showApplicationIcon?: boolean;
-    /**
-     * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
-     */
-    alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
-}
-/**
- * Handles a Form Button Action
- */
-export declare type ActionHandler = {
-    /**
-     * Name of the Handler
-     */
-    name: string;
-    /**
-     * Handler function to call when the Button is clicked
-     */
-    handler: (button: AlertButton<AlertButtonContext>, context: AlertButtonContext) => void;
-};
-/**
- * Form to show in an Alert
- */
-export declare type AlertForm = {
-    /**
-     * Name of the Form
-     */
-    name: string;
-    /**
-     * The Form to display in the Alert
-     */
-    form: AdaptableForm<AlertButtonContext>;
-};
-/**
- * Context required by functions when using an Alert Button
- */
-export interface AlertButtonContext extends ButtonContext {
-    /**
-     * Alert that has been triggered
-     */
-    alert: AdaptableAlert;
-    /**
-     * Data in the Alert Form
-     */
-    formData?: AdaptableFormData;
 }
 /**
  * Different positions offered by Notifications

package/src/AdaptableOptions/QueryLanguageOptions.d.ts

@@ -9,7 +9,6 @@ export interface QueryLanguageOptions {
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#boolean-functions
      */
     defaultBooleanFunctions?: ExpressionFunctionMap;
     /**
@@ -17,7 +16,6 @@ export interface QueryLanguageOptions {
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#scalar-functions
      */
     defaultScalarFunctions?: ExpressionFunctionMap;
     /**
@@ -25,7 +23,6 @@ export interface QueryLanguageOptions {
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#observable-functions
      */
     defaultObservableFunctions?: ExpressionFunctionMap;
     /**
@@ -33,7 +30,6 @@ export interface QueryLanguageOptions {
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#aggregation-functions
      */
     defaultAggregationFunctions?: ExpressionFunctionMap;
     /**

package/src/AdaptableOptions/StateOptions.d.ts

@@ -44,10 +44,11 @@ export declare type AdaptableStateFunctionConfig = {
  * Used by the `persistState` function property in StateOptions
  *
  * @example
- *
+ * ```
  * persistState = (state, {adaptableId, adaptableStateKey}) => {
  *  localStorage.setItem(adaptableStateKey, JSON.stringify(state))
  * }
+ * ```
  */
 export interface AdaptablePersistStateFunction {
     (state: any, { adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): Promise<any>;

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -11,13 +11,13 @@ export interface TeamSharingOptions {
      */
     enableTeamSharing: boolean;
     /**
-     * Function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State
+     * Async function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State
      *
      * @defaultValue null
      */
     getSharedEntities: (adaptableId: string) => Promise<SharedEntity[]>;
     /**
-     * Function which uploads Shared Entities so they can be downloaded by other members of the team
+     * Async function which uploads Shared Entities so they can be downloaded by other members of the team
      *
      * @defaultValue null
      */

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -31,13 +31,11 @@ export interface ToolPanelOptions {
     /**
      * The initial width of AdapTable ToolPanel
      * @defaultValue var(--ab-cmp-toolpanel__width)
-     * @see https://docs.adaptabletools.com/docs/theming/css-variables#toolpanel
      */
     width?: number;
     /**
      * The min width of AdapTable ToolPanel
      * @defaultValue var(--ab-cmp-toolpanel__width)
-     * @see https://docs.adaptabletools.com/docs/theming/css-variables#toolpanel
      */
     minWidth?: number;
     /**

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -120,7 +120,7 @@ export interface EditLookUpPermittedValues extends BasePermittedValues {
 export interface FilterPermittedValues extends BasePermittedValues {
     /**
      * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
-     * @default false
+     * @defaultValue false
      */
     suppressFilterSearchBar?: boolean;
     values: (params: FilterPermittedValuesParams) => any[] | Promise<any[]>;
@@ -139,7 +139,7 @@ export interface BulkUpdatePermittedValues extends BasePermittedValues {
 }
 /**
  * Use PermittedValues instead
- * @deprecated
+ * @deprecated use PermittedValues instead
  */
 export declare type CellValuesList = PermittedValues;
 /**

package/src/Api/AdaptableApi.d.ts

@@ -185,6 +185,7 @@ export interface AdaptableApi {
     chartingApi: ChartingApi;
     /**
      * Api methods used *internally* within AdapTable.
+     * @internal
      */
     internalApi: InternalApi;
     /**

package/src/Api/AlertApi.d.ts

@@ -4,8 +4,7 @@ import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
-import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
-import { AdaptableMessageType, AlertProperties } from '../types';
+import { AdaptableMessageType, AlertButtonContext, AlertProperties } from '../types';
 /**
  * Provides run-time access to Alert function and associated State
  */
@@ -158,7 +157,7 @@ export interface AlertApi {
     suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
      * Activates a suspended Alert Definition
-     * @param alertDefinition Alert to Un-suspend (activate)
+     * @param alertDefinition - Alert to Un-suspend (activate)
      * @returns alert definition
      */
     unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

package/src/Api/EventApi.d.ts

@@ -195,9 +195,14 @@ export interface EventApi {
     off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;
     /**
      * Fired when Adaptable is up and running - has no arguments.
-     * @param eventName AdaptableReady - use as: adaptableApi.eventApi.on('AdaptableReady', (adaptableReadyInfo: AdaptableReadyInfo) => { .....[do stuff]...})
-     * @param callback An `AdaptableReadyInfo` object which contains the adaptableApi and GridOptions
-     * @returns the unsubscribe function
+     * @param eventName - AdaptableReady
+     * @param callback - An `AdaptableReadyInfo` object which contains the adaptableApi and GridOptions
+     * @returns the unsubscribe function
+     *
+     * @example Use as
+     * ```
+     * adaptableApi.eventApi.on('AdaptableReady', (adaptableReadyInfo: AdaptableReadyInfo) => { .....[do stuff]...})
+     * ```
      */
     on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;
     /**

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

@@ -5,13 +5,15 @@ import { BaseEventInfo } from './BaseEventInfo';
  */
 export interface GridDataChangedInfo extends BaseEventInfo {
     /**
-     * Rows that have been added, updated, or deleted
+     * Data rows that have been added, updated, or deleted
      */
     dataRows: any[];
     /**
      * Trigger for row change: 'Add', 'Edit' or 'Delete'
-  }
      */
     rowTrigger: 'Add' | 'Edit' | 'Delete';
+    /**
+     * AG Grid Row Nodes that were affected by the Change
+     */
     rowNodes: RowNode[];
 }

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

@@ -1,7 +1,7 @@
 import { SystemStatusMessageInfo } from '../../PredefinedConfig/Common/SystemStatusMessageInfo';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
- * Object returned by the `SystemStatusMessageDisplayed' event
+ * Object returned by the `SystemStatusMessageDisplayed` event
  */
 export interface SystemStatusMessageDisplayedInfo extends BaseEventInfo {
     /**

package/src/Api/FreeTextColumnApi.d.ts

@@ -34,18 +34,6 @@ export interface FreeTextColumnApi {
     editFreeTextColumn(freeTextColumn: Partial<FreeTextColumn> & {
         ColumnId: string;
     }): FreeTextColumn;
-    /**
-     * Creates new FreeTextColumn and adds it to Adaptable State
-     * @param columnId the id for the column - try to keep this small and unique (and dont use spaces)
-     * @param param.columnName the name for the column - optional - if not provided, will default to the columnId
-     * @param param.defaultValue the default value that will appear in the Column unless overrident - leave blank if you dont require a default value
-     * @returns free text column
-     */
-    createFreeTextColumn(param: {
-        columnId: string;
-        columnName?: string;
-        defaultValue: string;
-    }): FreeTextColumn;
     /**
      * Deletes existing FreeTextColumn from Adaptable State
      * @param columnId name of FreeTextColumn to delete

package/src/Api/IPushPullApi.d.ts

@@ -59,7 +59,7 @@ export interface IPushPullApi {
     /**
      * Retrieves all the ipushpull domain to which the current user has access
      *
-     * An `IPushPullDomain' contains 3 properties:
+     * An `IPushPullDomain` contains 3 properties:
      *
      * - **Name**: the name of the Domain / Folder
      *

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

@@ -6,8 +6,7 @@ import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
 import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableAlert } from '../../PredefinedConfig/Common/AdaptableAlert';
 import { AdaptableForm, AdaptableFormData } from '../../PredefinedConfig/Common/AdaptableForm';
-import { AlertButtonContext } from '../../AdaptableOptions/NotificationsOptions';
-import { AdaptableMessageType } from '../../types';
+import { AdaptableMessageType, AlertButtonContext } from '../../types';
 export declare class AlertApiImpl extends ApiBase implements AlertApi {
     getAlertState(): AlertState;
     getAdaptableFormByName(name: string): AdaptableForm<AlertButtonContext> | undefined;

package/src/Api/Implementation/AlertApiImpl.js

@@ -16,7 +16,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     getAdaptableFormByName(name) {
         var _a;
-        const alertForms = this.getNotificationsOptions().alertForms || [];
+        const alertForms = this.getAlertOptions().alertForms || [];
         return (_a = alertForms.find((f) => f.name === name)) === null || _a === void 0 ? void 0 : _a.form;
     }
     getAlertDefinitions() {
@@ -57,7 +57,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             }
             actions.forEach((action) => {
                 var _a;
-                const buttonOnClick = (_a = this.getNotificationsOptions().actionHandlers) === null || _a === void 0 ? void 0 : _a.find((x) => x.name === action);
+                const buttonOnClick = (_a = this.getAlertOptions().actionHandlers) === null || _a === void 0 ? void 0 : _a.find((x) => x.name === action);
                 buttonOnClick === null || buttonOnClick === void 0 ? void 0 : buttonOnClick.handler(button, context);
                 this.adaptable.api.alertApi.executeAlertAction(action, {
                     alertDefinition: context.alert.alertDefinition,
@@ -92,7 +92,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                 highlightStyle: {
                     BackColor: backgroundColor,
                 },
-                timeout: this.getNotificationsOptions().cellHighlightDuration,
+                timeout: this.getAlertOptions().cellHighlightDuration,
             });
             return;
         }
@@ -132,9 +132,12 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         // 3 things we always do with an alert are:
         // 1. Dispatch the Alert (so it appears in the toolbar)
         this.addUidToAdaptableObject(alertToShow);
-        this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getNotificationsOptions().maxAlertsInStore));
+        this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getAlertOptions().maxAlertsInStore));
         // 2. Publish the Alert Fired Event
-        const alertFiredInfo = { adaptableApi: this.adaptable.api, 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;
@@ -175,7 +178,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     this.adaptable.api.gridApi.refreshCells([alertNode], [dataChangedInfo.column.columnId]);
                     setTimeout(() => {
                         this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
-                    }, this.adaptable.adaptableOptions.notificationsOptions.cellHighlightDuration);
+                    }, this.adaptable.adaptableOptions.alertOptions.cellHighlightDuration);
                 }
             }
             if (alertProperties.HighlightRow && dataChangedInfo) {
@@ -187,7 +190,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     this.adaptable.api.gridApi.refreshRowNode(alertNode);
                     setTimeout(() => {
                         this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
-                    }, this.adaptable.adaptableOptions.notificationsOptions.cellHighlightDuration);
+                    }, this.adaptable.adaptableOptions.alertOptions.cellHighlightDuration);
                 }
             }
             if (alertProperties.LogToConsole) {
@@ -196,7 +199,10 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         }
     }
     publishAlertFiredEvent(alertToFire) {
-        const alertFiredInfo = { adaptableApi: this.adaptable.api, alert: alertToFire };
+        const alertFiredInfo = {
+            adaptableApi: this.adaptable.api,
+            alert: alertToFire,
+        };
         this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
     }
     displayMessageAlertPopup(alertToDisplayAsPopup) {
@@ -242,7 +248,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     getAlertDescription(alertDefinition, dataChangedInfo) {
         var _a;
-        const alertMessageFunction = (_a = this.adaptable.adaptableOptions.notificationsOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
+        const alertMessageFunction = (_a = this.adaptable.adaptableOptions.alertOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
         if (alertMessageFunction) {
             const returnText = alertMessageFunction(alertDefinition, dataChangedInfo);
             if (returnText) {

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

@@ -12,6 +12,7 @@ import { NotificationsOptions } from '../../AdaptableOptions/NotificationsOption
 import { ToolPanelOptions } from '../../AdaptableOptions/ToolPanelOptions';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 import { QueryLanguageOptions } from '../../AdaptableOptions/QueryLanguageOptions';
+import { AlertOptions } from '../../AdaptableOptions/AlertOptions';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
     /**
@@ -46,6 +47,7 @@ export declare abstract class ApiBase {
     protected getOptions(): AdaptableOptions;
     protected getContainerOptions(): ContainerOptions;
     protected getNotificationsOptions(): NotificationsOptions;
+    protected getAlertOptions(): AlertOptions;
     protected getDashboardOptions(): DashboardOptions;
     protected getEditOptions(): EditOptions;
     protected getExportOptions(): ExportOptions;

package/src/Api/Implementation/ApiBase.js

@@ -77,6 +77,9 @@ class ApiBase {
     getNotificationsOptions() {
         return this.getOptions().notificationsOptions;
     }
+    getAlertOptions() {
+        return this.getOptions().alertOptions;
+    }
     getDashboardOptions() {
         return this.getOptions().dashboardOptions;
     }

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

@@ -13,11 +13,6 @@ export declare class FreeTextColumnApiImpl extends ApiBase implements FreeTextCo
     }): FreeTextColumn;
     addEditFreeTextColumnStoredValue(freeTextColumn: FreeTextColumn, storedValue: FreeTextStoredValue): FreeTextColumn;
     addStoredValuesToFreeTextColumn(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
-    createFreeTextColumn({ columnName, columnId, defaultValue, }: {
-        columnId: string;
-        columnName?: string;
-        defaultValue: string;
-    }): FreeTextColumn;
     deleteFreeTextColumn(columnId: string): void;
     showFreeTextColumnPopup(): void;
     getFreeTextColumnValueFromRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -4,7 +4,6 @@ exports.FreeTextColumnApiImpl = void 0;
 const tslib_1 = require("tslib");
 const FreeTextColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/FreeTextColumnRedux"));
 const ApiBase_1 = require("./ApiBase");
-const ObjectFactory_1 = require("../../Utilities/ObjectFactory");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
@@ -67,14 +66,6 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
             this.dispatchAction(FreeTextColumnRedux.FreeTextColumnEdit(freeTextColumn));
         }
     }
-    createFreeTextColumn({ columnName, columnId, defaultValue = null, }) {
-        let freeTextColumn = ObjectFactory_1.ObjectFactory.CreateEmptyFreeTextColumn(this.adaptable.api.internalApi.getAdaptableOptions().filterOptions
-            .enableFilterOnSpecialColumns);
-        freeTextColumn.ColumnId = columnId;
-        freeTextColumn.FriendlyName = columnName || columnId;
-        freeTextColumn.DefaultValue = defaultValue;
-        return this.addFreeTextColumn(freeTextColumn);
-    }
     deleteFreeTextColumn(columnId) {
         let freeTextColumn = this.getAllFreeTextColumn().find((ftc) => ftc.ColumnId == columnId);
         if (this.checkItemExists(freeTextColumn, columnId, ModuleConstants.FreeTextColumnModuleId)) {

package/src/Api/Implementation/InternalApiImpl.js

@@ -25,7 +25,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         let adaptableAlertForm;
         let isActionForm = false;
         if (typeof alertForm === 'string') {
-            const alertForms = this.getNotificationsOptions().alertForms || [];
+            const alertForms = this.getAlertOptions().alertForms || [];
             adaptableAlertForm = (_a = alertForms.find((f) => f.name === alertForm)) === null || _a === void 0 ? void 0 : _a.form;
         }
         else {

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

@@ -1,6 +1,7 @@
 import { ApiBase } from './ApiBase';
 import { LayoutApi } from '../LayoutApi';
 import { LayoutState, Layout } from '../../PredefinedConfig/LayoutState';
+import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getLayoutState(): LayoutState;
     shouldAutoSaveLayout: (layout?: Layout) => boolean;
@@ -27,6 +28,7 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getLayoutDescription(layout: Layout): string;
     private getColumnSort;
     createDefaultLayoutIfNeeded(): Layout | null;
+    showChangeColumnCaption(column: AdaptableColumn): void;
     showLayoutPopup(): void;
     isCurrentLayoutReadOnly(): boolean;
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -14,6 +14,8 @@ const isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
 const ArrayExtensions_1 = require("../../Utilities/Extensions/ArrayExtensions");
+const PopupRedux_1 = require("../../Redux/ActionsReducers/PopupRedux");
+const LayoutRedux_1 = require("../../Redux/ActionsReducers/LayoutRedux");
 class LayoutApiImpl extends ApiBase_1.ApiBase {
     constructor() {
         super(...arguments);
@@ -229,6 +231,15 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             }
         }
     }
+    showChangeColumnCaption(column) {
+        this.dispatchAction(PopupRedux_1.PopupShowPrompt({
+            Header: `Change caption for '${column.friendlyName}'`,
+            Msg: '',
+            DefaultValue: column.friendlyName,
+            ConfirmActionCreator: (inputText) => inputText !== column.friendlyName &&
+                LayoutRedux_1.LayoutSetColumnCaption(this.getCurrentLayoutName(), column.columnId, inputText),
+        }));
+    }
     showLayoutPopup() {
         this.showModulePopup(ModuleConstants.LayoutModuleId);
     }

package/src/Api/Implementation/QueryApiImpl.js

@@ -25,7 +25,10 @@ class QueryApiImpl extends ApiBase_1.ApiBase {
         // check that there is no other existing named query with the same name
         const duplicate = this.getAllNamedQuery().find((q) => q.Name === namedQuery.Name && q.Uuid !== namedQuery.Uuid);
         if (duplicate) {
-            return { valid: false, message: 'A Named Query already exists with that name' };
+            return {
+                valid: false,
+                message: 'A Named Query already exists with that name',
+            };
         }
         return { valid: true, message: '' };
     }

package/src/Api/Implementation/QueryLanguageApiImpl.js

@@ -8,7 +8,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
     isValidBooleanExpression(query, module, validationErrorMessage) {
-        const { isValid, errorMessage, } = this.adaptable.api.internalApi
+        const { isValid, errorMessage } = this.adaptable.api.internalApi
             .getQueryLanguageService()
             .validateBoolean(query, module, { force: true });
         if (!isValid && validationErrorMessage) {
@@ -17,7 +17,7 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
         return isValid;
     }
     isValidObservableExpression(expression, module, validationErrorMessage) {
-        const { isValid, errorMessage, } = this.adaptable.api.internalApi
+        const { isValid, errorMessage } = this.adaptable.api.internalApi
             .getQueryLanguageService()
             .validateObservable(expression, module);
         if (!isValid && validationErrorMessage) {
@@ -26,7 +26,7 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
         return isValid;
     }
     isValidAggregationExpression(expression, module, validationErrorMessage) {
-        const { isValid, errorMessage, } = this.adaptable.api.internalApi
+        const { isValid, errorMessage } = this.adaptable.api.internalApi
             .getQueryLanguageService()
             .validateAggregation(expression, module);
         if (!isValid && validationErrorMessage) {
@@ -51,8 +51,7 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
         }
     }
     getQueryableColumnIds() {
-        let queryableColumns = this.getQueryLanguageOptions()
-            .queryableColumns;
+        let queryableColumns = this.getQueryLanguageOptions().queryableColumns;
         if (!queryableColumns) {
             return undefined;
         }

package/src/Api/LayoutApi.d.ts

@@ -1,3 +1,4 @@
+import { AdaptableColumn } from '../../types';
 import { LayoutState, Layout } from '../PredefinedConfig/LayoutState';
 /**
  * Provides run-time access to the Layout Module and associated state
@@ -128,4 +129,10 @@ export interface LayoutApi {
      */
     setColumnCaption(columnId: string, caption: string): void;
     isCurrentLayoutReadOnly(): boolean;
+    /**
+     * Opens change column caption popup
+     *
+     * @param column AdaptableColumn
+     */
+    showChangeColumnCaption(column: AdaptableColumn): void;
 }

package/src/Api/OpenFinApi.d.ts

@@ -2,6 +2,7 @@ import { OpenFinState, OpenFinReport, OpenFinSchedule } from '../PredefinedConfi
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { OpenFinPluginOptions } from '../AdaptableOptions/OpenFinPluginOptions';
 import { NotificationsOptions } from '../AdaptableOptions/NotificationsOptions';
+import { AlertOptions } from '../AdaptableOptions/AlertOptions';
 /**
  * Provides run-time access to the OpenFin Plugin
  */
@@ -44,6 +45,10 @@ export interface OpenFinApi {
      * Gets the Notification section from Adaptable Options
      */
     getNotificationsOptions(): NotificationsOptions;
+    /**
+     * Gets the Alert section from Adaptable Options
+     */
+    getAlertOptions(): AlertOptions;
     /**
      * Retrieves all Schedules that send data to Excel via OpenFin
      */