@adaptabletools/adaptable 16.0.9 → 16.1.0-canary.0

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -1,33 +1,44 @@
 import { AdaptableMenuItem, ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
-import { AdaptableColumn, BaseContext } from '../types';
+import { AdaptableColumn, AdaptableIcon, AdaptableModule, BaseContext } from '../types';
 /**
  * Options for managing menus in AdapTable
  */
 export interface MenuOptions<TData = any> {
     /**
-     * Show Adaptable Context Menu (or specific items); can be boolean value or function invoked for each menu item
+     * Adds 'Ungroup' Column Menu item to a row grouped column menu
      *
      * @defaultValue true
      * @gridInfoItem
      */
-    showAdaptableContextMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ContextMenuContext<TData>) => boolean);
+    showUngroupColumnMenuItem?: boolean;
     /**
-     * Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item
+     * Customised Context Menu. Default context menu items are available in the provided context.
+     */
+    customContextMenu?: (menuContext: CustomContextMenuContext<TData>) => CustomContextMenuItem[];
+    /**
+     * Customised Column Menu. Default column menu items are available in the provided context.
+     */
+    customColumnMenu?: (menuContext: CustomColumnMenuContext<TData>) => CustomColumnMenuItem[];
+    /**
+     * Show Adaptable Context Menu (or specific items); can be boolean value or function invoked for each menu item
      *
+     * @deprecated Use `customContextMenu` instead
      * @defaultValue true
      * @gridInfoItem
      */
-    showAdaptableColumnMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ColumnMenuContext<TData>) => boolean);
+    showAdaptableContextMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ContextMenuContext<TData>) => boolean);
     /**
-     * Adds 'Ungroup' Column Menu item to a row grouped column
+     * Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item
      *
+     * @deprecated Use `customContextMenu` instead
      * @defaultValue true
      * @gridInfoItem
      */
-    showUngroupColumnMenuItem?: boolean;
+    showAdaptableColumnMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ColumnMenuContext<TData>) => boolean);
     /**
      * Order in which AG Grid, AdapTable and User Menu sections will appear in Column Menu (list or function)
      *
+     * @deprecated Use `customColumnMenu` instead
      * @defaultValue 'aggrid', 'adaptable', 'user'
      * @gridInfoItem
      */
@@ -35,19 +46,143 @@ export interface MenuOptions<TData = any> {
     /**
      * Order in which AG Grid, AdapTable and User Menu sections will appear in Context Menu (list or function)
      *
+     * @deprecated Use `customContextMenu` instead
      * @defaultValue 'aggrid', 'adaptable', 'user'
      * @gridInfoItem
      */
     contextMenuOrder?: ((context: MenuOrderContext) => ('aggrid' | 'adaptable' | 'user')[]) | ('aggrid' | 'adaptable' | 'user')[];
     /**
      * User-defined Menu Items to add to the Column Menu
+     *
+     * @deprecated Use `customColumnMenu` instead
      */
     columnMenuItems?: UserMenuItem<ColumnMenuContext>[];
     /**
-     * User-defined Menu Items to add to the Context Menu
+     * Customised Context Menu. Default context menu items are available in the provided context.
+     *
+     * @deprecated Use `customContextMenu` instead
      */
     contextMenuItems?: UserMenuItem<ContextMenuContext>[];
 }
+/**
+ * Context info provided when building Custom Context Menus
+ */
+export interface CustomContextMenuContext<TData = any> extends ContextMenuContext<TData> {
+    /**
+     * Default AG Grid Menu Items
+     */
+    defaultAgGridMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
+    /**
+     * Default Adaptable Menu Items
+     */
+    defaultAdaptableMenuItems: AdaptableSystemMenuItem[];
+}
+/**
+ * Context info provided when building Custom Context Menus
+ */
+export interface CustomColumnMenuContext<TData = any> extends ColumnMenuContext<TData> {
+    /**
+     * Default AG Grid Menu Items
+     */
+    defaultAgGridMenuItems: AgGridMenuItem<AgGridColumnMenuItemType>[];
+    /**
+     * Default Adaptable Menu Items
+     */
+    defaultAdaptableMenuItems: AdaptableSystemMenuItem[];
+}
+/**
+ * Custom Context Menu Item
+ */
+export declare type CustomContextMenuItem = AgGridMenuItem<AgGridContextMenuItemType> | AdaptableSystemMenuItem | UserContextMenuItem | '-' | {
+    menuType: 'Group';
+    label: string;
+    subMenuItems: CustomContextMenuItem[];
+    disabled?: boolean;
+    icon?: AdaptableIcon;
+};
+/**
+ * Custom Column Menu Item
+ */
+export declare type CustomColumnMenuItem = AgGridMenuItem<AgGridColumnMenuItemType> | AdaptableSystemMenuItem | UserColumnMenuItem | '-' | {
+    menuType: 'Group';
+    label: string;
+    subMenuItems: CustomColumnMenuItem[];
+    disabled?: boolean;
+    icon?: AdaptableIcon;
+};
+/**
+ * Menu Item that is provided by AG Grid
+ */
+export interface AgGridMenuItem<MENU_TYPE> {
+    menuType: 'AgGrid';
+    name: MENU_TYPE;
+}
+/**
+ * Context Menu Item that is provided by AdapTable
+ */
+export interface AdaptableSystemMenuItem extends AdaptableMenuItem {
+    menuType: 'Adaptable';
+}
+/**
+ * Context Menu Item that is provided by User
+ */
+export interface UserContextMenuItem {
+    menuType: 'User';
+    /**
+     * Text to appear in the Menu Item
+     */
+    label: string;
+    /**
+     * Function invoked when the Menu Item is clicked
+     */
+    onClick?: (menuContext: ContextMenuContext) => void;
+    /**
+     * Whether menu item is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Whether menu item is hidden
+     */
+    hidden?: boolean;
+    /**
+     * Optional icon to display
+     */
+    icon?: AdaptableIcon;
+    /**
+     * Array of Menu Items, enabling limitless levels of menus
+     */
+    subMenuItems?: CustomContextMenuItem[];
+}
+/**
+ * Context Menu Item that is provided by User
+ */
+export interface UserColumnMenuItem {
+    menuType: 'User';
+    /**
+     * Text to appear in the Menu Item
+     */
+    label: string;
+    /**
+     * Function invoked when the Menu Item is clicked
+     */
+    onClick?: (menuContext: ColumnMenuContext) => void;
+    /**
+     * Whether menu item is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Whether menu item is hidden
+     */
+    hidden?: boolean;
+    /**
+     * Optional icon to display
+     */
+    icon?: AdaptableIcon;
+    /**
+     * Array of Menu Items, enabling limitless levels of menus
+     */
+    subMenuItems?: CustomColumnMenuItem[];
+}
 /**
  * Context used when ordering Menu Sections
  */
@@ -57,3 +192,7 @@ export interface MenuOrderContext extends BaseContext {
      */
     column: AdaptableColumn;
 }
+export declare type AgGridContextMenuItemType = 'autoSizeAll' | 'expandAll' | 'contractAll' | 'copy' | 'copyWithHeaders' | 'cut' | 'paste' | 'resetColumns' | 'export' | 'csvExport' | 'excelExport' | 'chartRange' | 'pivotChart';
+export declare type AgGridColumnMenuItemType = 'pinSubMenu' | 'valueAggSubMenu' | 'autoSizeThis' | 'autoSizeAll' | 'rowGroup' | 'rowUnGroup' | 'resetColumns' | 'expandAll' | 'contractAll';
+export declare const DEFAULT_ADAPTABLE_CONTEXT_MENU_ORDER: AdaptableModule[];
+export declare const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER: AdaptableModule[];

package/src/AdaptableOptions/MenuOptions.js

@@ -1,2 +1,77 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = exports.DEFAULT_ADAPTABLE_CONTEXT_MENU_ORDER = void 0;
+const tslib_1 = require("tslib");
+const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
+exports.DEFAULT_ADAPTABLE_CONTEXT_MENU_ORDER = [
+    ModuleConstants.SettingsPanelModuleId,
+    ModuleConstants.LayoutModuleId,
+    ModuleConstants.FlashingCellModuleId,
+    ModuleConstants.FormatColumnModuleId,
+    ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.CustomSortModuleId,
+    ModuleConstants.CellSummaryModuleId,
+    ModuleConstants.Fdc3ModuleId,
+    ModuleConstants.PlusMinusModuleId,
+    ModuleConstants.DashboardModuleId,
+    ModuleConstants.SystemStatusModuleId,
+    ModuleConstants.GridInfoModuleId,
+    ModuleConstants.ColumnInfoModuleId,
+    ModuleConstants.DataImportModuleId,
+    ModuleConstants.AlertModuleId,
+    ModuleConstants.CalculatedColumnModuleId,
+    ModuleConstants.ExportModuleId,
+    ModuleConstants.FilterModuleId,
+    ModuleConstants.SmartEditModuleId,
+    ModuleConstants.BulkUpdateModuleId,
+    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.DataChangeHistoryModuleId,
+    ModuleConstants.DataSetModuleId,
+    ModuleConstants.FreeTextColumnModuleId,
+    ModuleConstants.QueryModuleId,
+    ModuleConstants.QuickSearchModuleId,
+    ModuleConstants.ScheduleModuleId,
+    ModuleConstants.ShortcutModuleId,
+    ModuleConstants.StateManagementModuleId,
+    ModuleConstants.ToolPanelModuleId,
+    ModuleConstants.ThemeModuleId,
+    ModuleConstants.StatusBarModuleId,
+    ModuleConstants.ChartingModuleId,
+    ModuleConstants.NotesModuleId,
+];
+exports.DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = [
+    ModuleConstants.SettingsPanelModuleId,
+    ModuleConstants.LayoutModuleId,
+    ModuleConstants.FlashingCellModuleId,
+    ModuleConstants.FormatColumnModuleId,
+    ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.CustomSortModuleId,
+    ModuleConstants.CellSummaryModuleId,
+    ModuleConstants.Fdc3ModuleId,
+    ModuleConstants.PlusMinusModuleId,
+    ModuleConstants.DashboardModuleId,
+    ModuleConstants.SystemStatusModuleId,
+    ModuleConstants.GridInfoModuleId,
+    ModuleConstants.ColumnInfoModuleId,
+    ModuleConstants.DataImportModuleId,
+    ModuleConstants.AlertModuleId,
+    ModuleConstants.CalculatedColumnModuleId,
+    ModuleConstants.ExportModuleId,
+    ModuleConstants.FilterModuleId,
+    ModuleConstants.SmartEditModuleId,
+    ModuleConstants.BulkUpdateModuleId,
+    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.DataChangeHistoryModuleId,
+    ModuleConstants.DataSetModuleId,
+    ModuleConstants.FreeTextColumnModuleId,
+    ModuleConstants.QueryModuleId,
+    ModuleConstants.QuickSearchModuleId,
+    ModuleConstants.ScheduleModuleId,
+    ModuleConstants.ShortcutModuleId,
+    ModuleConstants.StateManagementModuleId,
+    ModuleConstants.ToolPanelModuleId,
+    ModuleConstants.ThemeModuleId,
+    ModuleConstants.StatusBarModuleId,
+    ModuleConstants.ChartingModuleId,
+    ModuleConstants.NotesModuleId,
+];

package/src/AdaptableOptions/NotesOptions.d.ts

@@ -0,0 +1,23 @@
+import { BaseContext } from '../../types';
+/**
+ * Options for managing AdapTable Notes
+ */
+export interface NotesOptions<TData = any> {
+    /**
+     * Whether a cell can be noted on
+     */
+    isCellNotable?: (context: NotableCellContext) => boolean;
+}
+/**
+ * Context used when determining if a Note can be added to a Cell
+ */
+export interface NotableCellContext extends BaseContext {
+    /**
+     * Value in Primary Key Column
+     */
+    primaryKeyValue: string;
+    /**
+     * Column where Note will be displayed
+     */
+    columnId: string;
+}

package/src/AdaptableOptions/QuickSearchOptions.d.ts

@@ -39,6 +39,14 @@ export interface QuickSearchOptions<TData = any> {
      * @noCodeItem
      */
     runQuickSearchOnRowGroups?: boolean;
+    /**
+     * Include Pivot columns when Quick Searching (highlight only)
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    runQuickSearchOnPivotColumns?: boolean;
     /**
      * Run Quick Search using Case Sensitivity
      *

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -82,6 +82,7 @@ export interface UserInterfaceOptions<TData = any> {
     /**
      * Which sections to show in the Grid Info Screen
      * @defaultValue ['GridSummary', 'AdaptableOptions', 'ColumnInfo', 'AdaptableObjects']
+     * @deprecated
      */
     gridInfoSections?: GridInfoSections;
     /**
@@ -218,6 +219,7 @@ export interface BulkUpdatePermittedValuesContext<TData = any> extends Permitted
 export declare type GridInfoSections = GridInfoSection[];
 /**
  * Tabs available in the Grid Info Settings Panel
+ * @deprecated
  */
 export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjects';
 /**

package/src/Api/AdaptableApi.d.ts

@@ -41,8 +41,9 @@ import { StyledColumnApi } from './StyledColumnApi';
 import { OptionsApi } from './OptionsApi';
 import { ActionColumnApi } from './ActionColumnApi';
 import { ActionRowApi } from './ActionRowApi';
-import { CommentsApi } from './CommentsApi';
+import { NotesApi } from './NotesAPi';
 import { Fdc3Api } from './Fdc3Api';
+import { DataImportApi } from './DataImportApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -223,9 +224,13 @@ export interface AdaptableApi {
      */
     userInterfaceApi: UserInterfaceApi;
     /**
-     * Provides access to the Comments Module
+     * Provides access to the Notes Module
      */
-    commentsApi: CommentsApi;
+    notesApi: NotesApi;
+    /**
+     * Provides access to the Data Import Module
+     */
+    dataImportApi: DataImportApi;
     /**
      * Manages the FDC3 capabilities of AdapTable
      */

package/src/Api/ChartingApi.d.ts

@@ -1,4 +1,5 @@
 import { ChartModel, ChartRef } from '@ag-grid-community/core';
+import { ExternalChartDefinition } from '../PredefinedConfig/ChartingState';
 import { ChartContainer, ChartDefinition } from '../types';
 import { ChartingOpenState } from './Events/ChartChanged';
 /**
@@ -21,6 +22,10 @@ export interface ChartingApi {
      * Retrieves all adaptable Chart definitions
      */
     getChartDefinitions(): ChartDefinition[];
+    /**
+     * Retrieves all adaptable external Chart definitions
+     */
+    getExternalChartDefinitions(): ExternalChartDefinition[];
     /**
      * Retrieves Chart definition by uuid
      * @param uuid Chart uuid
@@ -90,4 +95,29 @@ export interface ChartingApi {
      * @param chartDefinition Chart to add
      */
     getOpenChartContainer(chartDefinition: ChartDefinition): ChartContainer | null;
+    /**
+     * Add new external chart definition
+     *
+     * @param chartDef external chart definition
+     * @param options
+     * @param options.saveStrategy whether to ask the user to provide a name for the chart
+     */
+    addExternalChartDefinition(chartDef: ExternalChartDefinition, options?: {
+        saveStrategy: 'auto' | 'manual';
+    }): void;
+    /**
+     * Edit existing external chart definition
+     * @param chartDef external chart definition
+     */
+    editExternalChartDefinition(chartDef: ExternalChartDefinition): void;
+    /**
+     * Delete external chart definition
+     * @param chartDefinition chart definition
+     */
+    deleteExternalChartDefinition(chartDefinition: ExternalChartDefinition): void;
+    /**
+     * Retrieves Chart definition by name
+     * @param name Chart name
+     */
+    getExternalChartDefinitionByName(name: string): ExternalChartDefinition | undefined;
 }

package/src/Api/ColumnApi.d.ts

@@ -202,6 +202,11 @@ export interface ColumnApi {
      * @param columnId ColumnId to lookup
      */
     getFriendlyNameForColumnId(columnId: string): string;
+    /**
+     * Checks if Column has already been created
+     * @param columnId ColumnId to check
+     */
+    doesColumnExist(columnId: string): boolean;
     /**
      * Retrieves Friendly Names for given ColumnIds
      * @param columnIds ColumnIds to lookup

package/src/Api/ConfigApi.d.ts

@@ -15,8 +15,9 @@ 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, CommentsState, PredefinedConfig, ScheduleState } from '../types';
+import { AdaptableSearchState, AdaptableSortState, PredefinedConfig, ScheduleState } from '../types';
 import { QueryState } from '../PredefinedConfig/QueryState';
+import { NotesState } from '../PredefinedConfig/NotesState';
 /**
  * Range of functions to access Predefined Config and Adaptable State
  */
@@ -105,10 +106,10 @@ export interface ConfigApi {
      */
     getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
     /**
-     * Returns Comment section of Adaptable State
+     * Returns Notes section of Adaptable State
      * @param returnJson return as JSON rather than object
      */
-    getCommentsState(returnJson?: boolean): CommentsState;
+    getNotesState(returnJson?: boolean): NotesState;
     /**
      * Returns Custom Sort section of Adaptable State
      * @param returnJson return as JSON rather than object

package/src/Api/DataImportApi.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Provides run-time access to the Settings Panel
+ **/
+export interface DataImportApi {
+    /**
+     * Opens the Data Import Wizard
+     */
+    openImportWizard(): void;
+}

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

@@ -42,8 +42,9 @@ import { StatusBarApi } from '../StatusBarApi';
 import { StyledColumnApi } from '../StyledColumnApi';
 import { ActionColumnApi } from '../ActionColumnApi';
 import { ActionRowApi } from '../ActionRowApi';
-import { CommentsApi } from '../CommentsApi';
+import { NotesApi } from '../NotesAPi';
 import { Fdc3Api } from '../Fdc3Api';
+import { DataImportApiImpl } from './DataImportApiImpl';
 export declare class AdaptableApiImpl implements AdaptableApi {
     protected adaptable: IAdaptable;
     internalApi: AdaptableInternalApi;
@@ -90,8 +91,9 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     dataChangeHistoryApi: DataChangeHistoryApi;
     chartingApi: ChartingApi;
     statusBarApi: StatusBarApi;
-    commentsApi: CommentsApi;
+    notesApi: NotesApi;
     fdc3Api: Fdc3Api;
+    dataImportApi: DataImportApiImpl;
     private destroyed;
     constructor(adaptable: IAdaptable);
     /**

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -45,8 +45,9 @@ const StyledColumnApiImpl_1 = require("./StyledColumnApiImpl");
 const CalendarApiImpl_1 = require("./CalendarApiImpl");
 const EntitlementApiImpl_1 = require("./EntitlementApiImpl");
 const OptionsApiImpl_1 = require("./OptionsApiImpl");
-const CommentsApiImpl_1 = require("./CommentsApiImpl");
+const NotesApiImpl_1 = require("./NotesApiImpl");
 const Fdc3ApiImpl_1 = require("./Fdc3ApiImpl");
+const DataImportApiImpl_1 = require("./DataImportApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
@@ -95,8 +96,9 @@ class AdaptableApiImpl {
         this.dataChangeHistoryApi = new DataChangeHistoryApiImpl_1.DataChangeHistoryApiImpl(adaptable);
         this.chartingApi = new ChartingApiImpl_1.ChartingApiImpl(adaptable);
         this.statusBarApi = new StatusBarApiImpl_1.StatusBarApiImpl(adaptable);
-        this.commentsApi = new CommentsApiImpl_1.CommentsApiImpl(adaptable);
+        this.notesApi = new NotesApiImpl_1.NotesApiImpl(adaptable);
         this.fdc3Api = new Fdc3ApiImpl_1.Fdc3ApiImpl(adaptable);
+        this.dataImportApi = new DataImportApiImpl_1.DataImportApiImpl(adaptable);
         // adaptable internal api
         this.internalApi = new AdaptableInternalApi_1.AdaptableInternalApi(adaptable);
     }

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

@@ -20,7 +20,7 @@ import { ExpressionApi } from '../ExpressionApi';
 import { CalendarOptions } from '../../AdaptableOptions/CalendarOptions';
 import { Fdc3Api } from '../Fdc3Api';
 import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
-import { CommentOptions } from '../../AdaptableOptions/CommentsOptions';
+import { NotesOptions } from '../../AdaptableOptions/NotesOptions';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
     /**
@@ -64,7 +64,7 @@ export declare abstract class ApiBase {
     protected getActionColumnOptions(): ActionColumnOptions;
     protected getActionRowOptions(): ActionRowOptions;
     protected getColumnOptions(): ColumnOptions;
-    protected getCommentOptions(): CommentOptions;
+    protected getNotesOptions(): NotesOptions;
     protected getCustomSortOptions(): CustomSortOptions;
     protected getDataSetOptions(): DataSetOptions;
     protected getCalendarOptions(): CalendarOptions;

package/src/Api/Implementation/ApiBase.js

@@ -102,8 +102,8 @@ class ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
-    getCommentOptions() {
-        return this.getOptions().commentOptions;
+    getNotesOptions() {
+        return this.getOptions().notesOptions;
     }
     getCustomSortOptions() {
         return this.getOptions().customSortOptions;

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

@@ -2,10 +2,9 @@ import { ChartModel, ChartRef } from '@ag-grid-community/core';
 import { ChartingApi } from '../ChartingApi';
 import { ApiBase } from './ApiBase';
 import { ChartContainer, ChartDefinition } from '../../types';
-import { ChartingInternalApi } from '../Internal/ChartingInternalApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { ExternalChartDefinition } from '../../PredefinedConfig/ChartingState';
 export declare class ChartingApiImpl extends ApiBase implements ChartingApi {
-    internalApi: ChartingInternalApi;
     constructor(adaptable: IAdaptable);
     isChartingEnabled(): boolean;
     getCurrentChartModels(): ChartModel[];
@@ -32,4 +31,11 @@ export declare class ChartingApiImpl extends ApiBase implements ChartingApi {
     getOpenChartContainer(chartDefinition: ChartDefinition): ChartContainer | null;
     setChartReadOnly(chartDefinition: ChartDefinition): void;
     setChartEditable(chartDefinition: ChartDefinition): void;
+    addExternalChartDefinition(chartDefinition: ExternalChartDefinition, options: {
+        saveStrategy: 'auto' | 'manual';
+    }): void;
+    editExternalChartDefinition(chartDefinition: ExternalChartDefinition): void;
+    deleteExternalChartDefinition(chartDefinition: ExternalChartDefinition): void;
+    getExternalChartDefinitions(): ExternalChartDefinition<unknown>[];
+    getExternalChartDefinitionByName(name: string): ExternalChartDefinition | undefined;
 }

package/src/Api/Implementation/ChartingApiImpl.js

@@ -115,5 +115,69 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
     setChartEditable(chartDefinition) {
         this.dispatchAction(ChartingRedux.ChartingEditChart(Object.assign(Object.assign({}, chartDefinition), { IsReadOnly: false })));
     }
+    addExternalChartDefinition(chartDefinition, options) {
+        var _a, _b, _c;
+        const saveStrategy = (_a = options === null || options === void 0 ? void 0 : options.saveStrategy) !== null && _a !== void 0 ? _a : 'manual';
+        if (saveStrategy === 'auto') {
+            this.dispatchAction(ChartingRedux.ChartingAddExternalChart(Object.assign(Object.assign({}, chartDefinition), { Name: (_b = chartDefinition.Name) !== null && _b !== void 0 ? _b : this.internalApi.getUniqueChartName() })));
+        }
+        else {
+            const alert = {
+                alertType: 'generic',
+                header: 'Save chart',
+                message: 'Do you want to save this Chart?',
+                alertDefinition: Object.assign(Object.assign({}, ObjectFactory_1.default.CreateEmptyAlertDefinition()), { MessageType: 'Info', AlertProperties: {
+                        DisplayNotification: true,
+                        NotificationDuration: 'always',
+                    }, AlertForm: {
+                        Buttons: [
+                            {
+                                Label: 'Save',
+                                Action: (context) => {
+                                    this.dispatchAction(ChartingRedux.ChartingAddExternalChart(Object.assign(Object.assign({}, chartDefinition), { Name: context.formData.name || this.internalApi.getUniqueChartName() })));
+                                },
+                                ButtonStyle: {
+                                    tone: 'info',
+                                    variant: 'raised',
+                                },
+                            },
+                            {
+                                Label: 'Dismiss',
+                                ButtonStyle: {
+                                    tone: 'neutral',
+                                    variant: 'raised',
+                                },
+                            },
+                        ],
+                        fields: [
+                            {
+                                name: 'name',
+                                label: 'Name',
+                                fieldType: 'text',
+                                defaultValue: (_c = chartDefinition.Name) !== null && _c !== void 0 ? _c : '',
+                            },
+                        ],
+                    } }),
+            };
+            this.adaptable.api.alertApi.showAdaptableAlert(alert);
+        }
+    }
+    editExternalChartDefinition(chartDefinition) {
+        this.dispatchAction(ChartingRedux.ChartingEditExternalChart(chartDefinition));
+    }
+    deleteExternalChartDefinition(chartDefinition) {
+        this.dispatchAction(ChartingRedux.ChartingDeleteExternalChart(chartDefinition));
+    }
+    getExternalChartDefinitions() {
+        return this.getAdaptableState().Charting.ExternalChartDefinitions;
+    }
+    getExternalChartDefinitionByName(name) {
+        if (StringExtensions_1.default.IsNotNullOrEmpty(name)) {
+            let chartDefinition = this.getExternalChartDefinitions().find((c) => c.Name == name);
+            if (this.checkItemExists(chartDefinition, name, 'Chart')) {
+                return chartDefinition;
+            }
+        }
+    }
 }
 exports.ChartingApiImpl = ChartingApiImpl;

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

@@ -32,6 +32,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     hasDateDataType(columnId: string): boolean;
     getColumnDataTypeForColumnId(columnId: string): AdaptableColumnDataType | undefined;
     getFriendlyNameForColumnId(columnId: string): string;
+    doesColumnExist(columnId: string): boolean;
     getFriendlyNamesForColumnIds(columnIds: string[]): string[];
     getColumnIdForFriendlyName(friendlyName: string): string;
     getColumnIdsForFriendlyNames(friendlyNames: string[]): string[];

package/src/Api/Implementation/ColumnApiImpl.js

@@ -164,6 +164,10 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         this.logMissingColumnWarning(columnId);
         return result;
     }
+    doesColumnExist(columnId) {
+        const foundColumn = this.getColumns().find((c) => c.columnId == columnId);
+        return foundColumn ? true : false;
+    }
     getFriendlyNamesForColumnIds(columnIds) {
         const friendlyNames = [];
         if (ArrayExtensions_1.default.IsNullOrEmpty(columnIds)) {