@adaptabletools/adaptable 18.0.0-canary.2 → 18.0.0-canary.20

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -29,12 +29,12 @@ import { CalendarOptions } from './CalendarOptions';
 import { QuickSearchOptions } from './QuickSearchOptions';
 import { FormatColumnOptions } from './FormatColumnOptions';
 import { Fdc3Options } from './Fdc3Options';
-import { NotesOptions } from './NotesOptions';
+import { NoteOptions } from './NoteOptions';
 import { PredicateOptions } from './PredicateOptions';
 import { DataImportOptions } from './DataImportOptions';
 import { ColumnFilterOptions } from './ColumnFilterOptions';
 import { GridFilterOptions } from './GridFilterOptions';
-import { CommentsOptions } from './CommentsOptions';
+import { CommentOptions } from './CommentOptions';
 /**
  * Large group of options enabling developers to set up AdapTable at design time to fit precise requirements
  */
@@ -42,7 +42,7 @@ export interface AdaptableOptions<TData = any> {
     /**
      * Identifier for this instance of AdapTable
      *
-     * @defaultValue 'adaptable_id'
+     * @defaultValue 'adaptable_id_${random_number}'
      * @gridInfoItem
      * @noCodeItem
      */
@@ -65,6 +65,12 @@ export interface AdaptableOptions<TData = any> {
      * Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited.
      */
     licenseKey?: string;
+    /**
+     * Automatically migrate the state from the previous version of Adaptable to the current version.
+     *
+     * @defaultValue true
+     */
+    autoMigrateState?: boolean;
     /**
      * User State set at design-time and shipped with AdapTable for first use; can be `PredefinedConfig` object or url to file containing config
      *
@@ -128,13 +134,13 @@ export interface AdaptableOptions<TData = any> {
      */
     containerOptions?: ContainerOptions;
     /**
-     * Options for managing AdapTable Comments
+     * Options for managing personal Notes
      */
-    notesOptions?: NotesOptions;
+    noteOptions?: NoteOptions;
     /**
-     * Options for managing AdapTable Comments
+     * Options for managing collaborative Comments
      */
-    commentsOptions?: CommentsOptions<TData>;
+    commentOptions?: CommentOptions<TData>;
     /**
      * Options for using Custom Sort
      */

package/src/AdaptableOptions/ColumnFilterOptions.d.ts

@@ -102,6 +102,13 @@ export interface ColumnFilterOptions<TData = any> {
      * @noCodeItem
      */
     showSuspendFilterButton?: boolean;
+    /**
+     * Show Date Picker (or Date Input) in Filter controls
+     * @gridInfoItem
+     * @noCodeItem
+     * @defaultValue true
+     */
+    showDatePicker?: boolean;
 }
 /**
  * Options for managing the Filter Bar (aka Quick Filter)
@@ -177,17 +184,17 @@ export interface FilterFormOptions<TData = any> {
     defaultFilterFormTab?: 'Values' | 'Predicates';
 }
 /**
- * Options for managing the Values (IN) Column Filter
+ * Options for managing the Values (IN) Filter in Filter Bar and Filter Form
  */
 export interface ValuesFilterOptions<TData = any> {
     /**
-     * Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)
+     * Distinct column items to display in Values Filter; useful with large datasource (though AdapTable offers virtualisation)
      *
-     * @defaultValue 2,000
+     * @defaultValue undefined
      * @gridInfoItem
      * @noCodeItem
      */
-    maxFilterValuesToDisplay?: number;
+    maxFilterValuesToDisplay?: ((columFilterContext: ColumnFilterContext<TData>) => number) | number;
     /**
      * If Values filter should filter on datetime rather than date
      * @defaultValue  true

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -1,5 +1,5 @@
 import { Column } from '@ag-grid-community/core';
-import { AdaptableColumnGroup } from '../types';
+import { AdaptableColumnGroup, BaseContext } from '../types';
 /**
  * Options related to managing Columns in Adaptable.
  */
@@ -10,10 +10,10 @@ export interface ColumnOptions {
      */
     columnFriendlyName?: (columnFriendlyNameContext: ColumnFriendlyNameContext) => string | undefined;
     /**
-     * Optional list of Column Types - used primarily for Calculated and FreeText Columns
-     * @defaultValue undefined
+     * Optional list of Column Types - used for Scope and creating Special Columns
+     * @defaultValue Empty Array
      */
-    columnTypes?: string[];
+    columnTypes?: string[] | ((context: ColumnTypesContext) => string[]);
     /**
      * Log warning to console if AdapTable cannot find a column
      *
@@ -52,3 +52,8 @@ export interface ColumnFriendlyNameContext {
      */
     columnGroup: AdaptableColumnGroup;
 }
+/**
+ * Context used when retrieving Column Types
+ */
+export interface ColumnTypesContext extends BaseContext {
+}

package/src/AdaptableOptions/CommentOptions.d.ts

@@ -0,0 +1,33 @@
+import { CommentThread, BaseContext, GridCell } from '../types';
+/**
+ * Options for managing Comments and Comment Threads in AdapTable
+ */
+export interface CommentOptions<TData = any> {
+    /**
+     * Whether a cell can contain Comments
+     */
+    isCellCommentable?: (commentableCellContext: CommentableCellContext) => boolean;
+    /**
+     * Loads Comments
+     */
+    loadCommentThreads?(commentLoadContext: CommentLoadContext): Promise<CommentThread[]>;
+    /**
+     * Called when Comments change and need to be saved
+     * @param commentThreads
+     */
+    persistCommentThreads?(commentThreads: CommentThread[]): void;
+}
+/**
+ * Context used when determining if a cell can show Comments
+ */
+export interface CommentableCellContext extends BaseContext {
+    /**
+     * Grid Cell in AdapTable which has been clicked
+     */
+    gridCell: GridCell;
+}
+/**
+ * Context used when loading Comments
+ */
+export interface CommentLoadContext extends BaseContext {
+}

package/src/AdaptableOptions/GroupingOptions.d.ts

@@ -4,13 +4,6 @@ import { KeyCreatorParams } from '@ag-grid-community/core';
  * Options for managing Row and Column Groups in AdapTable
  */
 export interface GroupingOptions<TData = any> {
-    /**
-     * Show aggregated totals row at top of Grid when row grouping
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     */
-    showGroupingTotalsAsHeader?: boolean;
     /**
     * Value to use for 'Balanced Groups' (string columns only)
     */

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableMenuItem, ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem, ColumnMenuContext, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableColumn, AdaptableIcon, AdaptableModule, BaseContext } from '../types';
 /**
  * Options for managing menus in AdapTable – provided using 2 collections
@@ -12,58 +12,6 @@ export interface MenuOptions<TData = any> {
      * Customises 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
-     */
-    showAdaptableContextMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ContextMenuContext<TData>) => boolean);
-    /**
-     * Show AdapTable Column Menu (or specific items); can be boolean value or function invoked for each menu item
-     *
-     * @deprecated Use `customColumnMenu` instead
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showAdaptableColumnMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ColumnMenuContext<TData>) => boolean);
-    /**
-     * Adds 'Ungroup' Column Menu item to a row grouped column menu
-     *
-     * @deprecated Now provided by AG Grid and property is ignored
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showUngroupColumnMenuItem?: 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
-     */
-    columnMenuOrder?: ((context: MenuOrderContext) => ('aggrid' | 'adaptable' | 'user')[]) | ('aggrid' | 'adaptable' | 'user')[];
-    /**
-     * 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>[];
-    /**
-     * 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
@@ -229,6 +177,10 @@ type ModuleGroup = {
     icon?: AdaptableIcon;
     title: string;
 };
+export declare const DEFAULT_ADAPTABLE_COLUMN_MENU_STRUCTURE: (AdaptableModule | ModuleGroup)[];
+/**
+ * Defines the order of Menu Items in the CONTEXT Menu
+ * The items commented out do not have a Context Menu Option
+ */
 export declare const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE: (AdaptableModule | ModuleGroup)[];
-export declare const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER: (AdaptableModule | ModuleGroup)[];
 export {};

package/src/AdaptableOptions/MenuOptions.js

@@ -1,99 +1,96 @@
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
-export const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE = [
-    ModuleConstants.SettingsPanelModuleId,
+export const DEFAULT_ADAPTABLE_COLUMN_MENU_STRUCTURE = [
+    ModuleConstants.CalculatedColumnModuleId,
+    ModuleConstants.CellSummaryModuleId,
+    ModuleConstants.ColumnFilterModuleId,
+    ModuleConstants.ColumnInfoModuleId,
+    ModuleConstants.CustomSortModuleId,
     ModuleConstants.DashboardModuleId,
-    ModuleConstants.ToolPanelModuleId,
-    ModuleConstants.StatusBarModuleId,
-    ModuleConstants.LayoutModuleId,
-    ModuleConstants.FormatColumnModuleId,
-    ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.DataImportModuleId,
     ModuleConstants.FlashingCellModuleId,
-    ModuleConstants.CustomSortModuleId,
-    ModuleConstants.CellSummaryModuleId,
-    ModuleConstants.Fdc3ModuleId,
+    ModuleConstants.FormatColumnModuleId,
+    ModuleConstants.FreeTextColumnModuleId,
     ModuleConstants.GridInfoModuleId,
-    ModuleConstants.ColumnInfoModuleId,
+    ModuleConstants.LayoutModuleId,
+    ModuleConstants.PlusMinusModuleId,
+    ModuleConstants.SettingsPanelModuleId,
+    ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.SystemStatusModuleId, // Single Item - Always present
+    /*
+    // Modules that dont provide a Column Menu
     ModuleConstants.AlertModuleId,
-    ModuleConstants.CalculatedColumnModuleId,
-    ModuleConstants.ExportModuleId,
-    ModuleConstants.ColumnFilterModuleId,
-    {
-        title: 'Edit',
-        icon: {
-            name: 'edit',
-        },
-        modules: [ModuleConstants.SmartEditModuleId, ModuleConstants.BulkUpdateModuleId],
-    },
-    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.BulkUpdateModuleId,
+    ModuleConstants.ChartingModuleId,
+    ModuleConstants.CommentModuleId,
     ModuleConstants.DataChangeHistoryModuleId,
     ModuleConstants.DataSetModuleId,
-    ModuleConstants.FreeTextColumnModuleId,
+    ModuleConstants.ExportModuleId,
+    ModuleConstants.Fdc3ModuleId,
+    ModuleConstants.GridFilterModuleId,
     ModuleConstants.NamedQueryModuleId,
+    ModuleConstants.NoteModuleId,
     ModuleConstants.QuickSearchModuleId,
-    ModuleConstants.DataSetModuleId,
-    ModuleConstants.AlertModuleId,
-    ModuleConstants.SystemStatusModuleId,
-    ModuleConstants.CalculatedColumnModuleId,
-    ModuleConstants.FreeTextColumnModuleId,
-    ModuleConstants.ExportModuleId,
-    ModuleConstants.DataImportModuleId,
-    ModuleConstants.DataChangeHistoryModuleId,
-    ModuleConstants.SmartEditModuleId,
-    ModuleConstants.PlusMinusModuleId,
-    ModuleConstants.BulkUpdateModuleId,
-    ModuleConstants.ShortcutModuleId,
-    ModuleConstants.TeamSharingModuleId,
     ModuleConstants.ScheduleModuleId,
+    ModuleConstants.ShortcutModuleId,
+    ModuleConstants.SmartEditModuleId,
     ModuleConstants.StateManagementModuleId,
+    ModuleConstants.StatusBarModuleId,
+    ModuleConstants.TeamSharingModuleId,
     ModuleConstants.ThemeModuleId,
-    ModuleConstants.ChartingModuleId,
-    ModuleConstants.NotesModuleId,
-    ModuleConstants.CommentsModuleId,
-];
-export const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = [
-    ModuleConstants.SettingsPanelModuleId,
-    ModuleConstants.DashboardModuleId,
     ModuleConstants.ToolPanelModuleId,
-    ModuleConstants.StatusBarModuleId,
-    ModuleConstants.LayoutModuleId,
-    ModuleConstants.FormatColumnModuleId,
-    ModuleConstants.StyledColumnModuleId,
-    ModuleConstants.FlashingCellModuleId,
-    ModuleConstants.CustomSortModuleId,
-    ModuleConstants.CellSummaryModuleId,
-    ModuleConstants.Fdc3ModuleId,
-    ModuleConstants.GridInfoModuleId,
-    ModuleConstants.ColumnInfoModuleId,
+    */
+];
+/**
+ * Defines the order of Menu Items in the CONTEXT Menu
+ * The items commented out do not have a Context Menu Option
+ */
+export const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE = [
     ModuleConstants.AlertModuleId,
+    ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.CalculatedColumnModuleId,
-    ModuleConstants.ExportModuleId,
+    ModuleConstants.CellSummaryModuleId,
     ModuleConstants.ColumnFilterModuleId,
-    {
-        title: 'Edit',
-        modules: [ModuleConstants.SmartEditModuleId, ModuleConstants.BulkUpdateModuleId],
-    },
-    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.ColumnInfoModuleId,
+    ModuleConstants.CommentModuleId,
+    ModuleConstants.DashboardModuleId,
+    ModuleConstants.DataImportModuleId,
+    ModuleConstants.ExportModuleId,
+    ModuleConstants.Fdc3ModuleId,
+    ModuleConstants.FlashingCellModuleId,
+    ModuleConstants.GridInfoModuleId,
+    ModuleConstants.LayoutModuleId,
+    ModuleConstants.NoteModuleId,
+    ModuleConstants.SettingsPanelModuleId,
+    ModuleConstants.SmartEditModuleId,
+    ModuleConstants.SystemStatusModuleId, // Single Item - Always present
+    // this currently doesnt work
+    //  {
+    //    title: 'Edit',
+    //    icon: {
+    //      name: 'edit',
+    //    },
+    //    modules: [ModuleConstants.SmartEditModuleId, ModuleConstants.BulkUpdateModuleId],
+    //   },
+    /*
+    // Modules that dont provide a Context Menu
+    ModuleConstants.ChartingModuleId,
+    ModuleConstants.CustomSortModuleId,
     ModuleConstants.DataChangeHistoryModuleId,
     ModuleConstants.DataSetModuleId,
+    ModuleConstants.FormatColumnModuleId,
     ModuleConstants.FreeTextColumnModuleId,
+    ModuleConstants.GridFilterModuleId,
     ModuleConstants.NamedQueryModuleId,
-    ModuleConstants.QuickSearchModuleId,
-    ModuleConstants.DataSetModuleId,
-    ModuleConstants.AlertModuleId,
-    ModuleConstants.SystemStatusModuleId,
-    ModuleConstants.CalculatedColumnModuleId,
-    ModuleConstants.FreeTextColumnModuleId,
-    ModuleConstants.ExportModuleId,
-    ModuleConstants.DataImportModuleId,
-    ModuleConstants.DataChangeHistoryModuleId,
-    ModuleConstants.SmartEditModuleId,
     ModuleConstants.PlusMinusModuleId,
-    ModuleConstants.BulkUpdateModuleId,
-    ModuleConstants.ShortcutModuleId,
-    ModuleConstants.TeamSharingModuleId,
+    ModuleConstants.QuickSearchModuleId,
     ModuleConstants.ScheduleModuleId,
+    ModuleConstants.ShortcutModuleId,
     ModuleConstants.StateManagementModuleId,
+    ModuleConstants.StatusBarModuleId,
+    ModuleConstants.StyledColumnModuleId,
+    ModuleConstants.TeamSharingModuleId,
     ModuleConstants.ThemeModuleId,
-    ModuleConstants.ChartingModuleId,
-    ModuleConstants.NotesModuleId,
+    ModuleConstants.ToolPanelModuleId,
+  
+    */
 ];

package/src/AdaptableOptions/{NotesOptions.d.ts → NoteOptions.d.ts}

@@ -1,10 +1,10 @@
-import { BaseContext, CellAddress } from '../../types';
+import { BaseContext, GridCell } from '../../types';
 /**
  * Options for managing AdapTable Notes
  */
-export interface NotesOptions<TData = any> {
+export interface NoteOptions<TData = any> {
     /**
-     * Whether a cell can be noted on
+     * Whether a cell can contain Notes
      */
     isCellNotable?: (context: NotableCellContext) => boolean;
 }
@@ -12,5 +12,8 @@ export interface NotesOptions<TData = any> {
  * Context used when determining if a Note can be added to a Cell
  */
 export interface NotableCellContext extends BaseContext {
-    address: CellAddress;
+    /**
+      * Grid Cell in AdapTable which has been clicked
+      */
+    gridCell: GridCell;
 }

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -111,6 +111,23 @@ export interface UserInterfaceOptions<TData = any> {
      * @noCodeItem
      */
     showLoadingScreen?: boolean;
+    /**
+     * Delay in milliseconds before Loading Screen appears. `showLoadingScreen` must be true for this to take effect
+     *
+     * @defaultValue 200
+     */
+    loadingScreenDelay?: number;
+    /**
+     * Title to display in Loading Screen.
+     * @defaultValue 'Initialising Grid'
+     */
+    loadingScreenTitle?: string;
+    /**
+     * Text to display in Loading Screen.
+     *
+     * @defaultValue 'Retrieving your settings and setting up the grid...'
+     */
+    loadingScreenText?: string;
 }
 /**
  * Base class for all Permitted Values related objects

package/src/Api/AdaptableApi.d.ts

@@ -1,3 +1,4 @@
+import { GridApi as AgGridApi } from '@ag-grid-community/core';
 import { AlertApi } from './AlertApi';
 import { PluginsApi } from './PluginsApi';
 import { BulkUpdateApi } from './BulkUpdateApi';
@@ -39,7 +40,7 @@ import { StyledColumnApi } from './StyledColumnApi';
 import { OptionsApi } from './OptionsApi';
 import { ActionColumnApi } from './ActionColumnApi';
 import { ActionRowApi } from './ActionRowApi';
-import { NotesApi } from './NotesApi';
+import { NoteApi } from './NoteApi';
 import { Fdc3Api } from './Fdc3Api';
 import { DataImportApi } from './DataImportApi';
 import { GridFilterApi } from './GridFilterApi';
@@ -53,6 +54,10 @@ import { CommentApi } from './CommentApi';
  * Has a huge number of classes each dedicated to a specific AdapTable Module or functionality
  */
 export interface AdaptableApi {
+    /**
+     * AG Grid API; try to use the API methods provided by Adaptable instead of using this directly
+     */
+    agGridApi: AgGridApi;
     /**
      * Provides access to Action Columns
      */
@@ -226,11 +231,11 @@ export interface AdaptableApi {
      */
     userInterfaceApi: UserInterfaceApi;
     /**
-     * Provides access to the Notes Module
+     * Provides access to the Note Module
      */
-    notesApi: NotesApi;
+    noteApi: NoteApi;
     /**
-     * Provides access to the Comments Module
+     * Provides access to the Comment Module
      */
     commentApi: CommentApi;
     /**

package/src/Api/BulkUpdateApi.d.ts

@@ -16,9 +16,4 @@ export interface BulkUpdateApi {
      * @param cellUpdateRequests Cells to apply the Bulk Update
      */
     applyBulkUpdate(cellUpdateRequests: CellUpdateRequest[]): void;
-    /**
-     * Sets Bulk Update value
-     * @param bulkUpdateValue the value to use in Bulk Update Operation
-     */
-    setBulkUpdateValue(bulkUpdateValue: string): void;
 }

package/src/Api/ColumnApi.d.ts

@@ -262,4 +262,8 @@ export interface ColumnApi {
      * Opens Settings Panel with Column Info section selected and visible
      */
     openColumnInfoSettingsPanel(): void;
+    /**
+     * Returns available columns types defined under columnOptions.columnTypes
+     */
+    getColumnTypes(): string[];
 }

package/src/Api/CommentApi.d.ts

@@ -1,56 +1,55 @@
 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
      */
     addComment(commentText: string, address: 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
+     * Get Comments for a particular cell
      * @param CellAddress
      */
     getComments(cellAddress: CellAddress): AdaptableComment[];
     /**
-     *  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 all Comments for a particular cell
      * @param cellAddress
      */
     getCommentThread(cellAddress: CellAddress): CommentThread | undefined;
     /**
-     * Returns all comment threads
+     * Return all Comment Threads
      */
     getCommentThreads(): CommentThread[];
     /**
-     * Called to add a new comment thread
+     * Create a new Comment Thread
      *
      * @param commentThread
      */
     addCommentThread(commentThread: CommentThread): void;
     /**
-     * Called to set all cell comments
+     * Load all Comment Threads
      *
      * @param commentThreads new cell comments
      */

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