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

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
      */
@@ -128,13 +128,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/AdaptablePlugin.d.ts

@@ -29,7 +29,9 @@ export declare abstract class AdaptablePlugin {
     afterInitOptions(adaptable: IAdaptable, adaptableOptions: AdaptableOptions): void;
     afterInitApi(adaptable: IAdaptable, api: AdaptableApi): void;
     afterInitServices(adaptable: IAdaptable): void;
+    afterInitialStateLoaded(adaptable: IAdaptable): void;
     afterInitModules(adaptable: IAdaptable, strategies: Map<AdaptableModule, IModule>): void;
+    afterInitStore(adaptable: IAdaptable): void;
     afterInit(ab: IAdaptable): void;
     afterSetLayout(adaptable: IAdaptable, layout: Layout): void;
     onStoreEvent(eventName: string, data: {

package/src/AdaptableOptions/AdaptablePlugin.js

@@ -29,7 +29,9 @@ export class AdaptablePlugin {
     afterInitOptions(adaptable, adaptableOptions) { }
     afterInitApi(adaptable, api) { }
     afterInitServices(adaptable) { }
+    afterInitialStateLoaded(adaptable) { }
     afterInitModules(adaptable, strategies) { }
+    afterInitStore(adaptable) { }
     afterInit(ab) { }
     // hook executed after each layout update (Adaptable.setLayout())
     afterSetLayout(adaptable, layout) { }

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,39 @@
+import { CommentThread, BaseContext, GridCell } from '../types';
+/**
+ * Options for managing Comments and Comment Threads in AdapTable
+ */
+export interface CommentOptions<TData = any> {
+    /**
+     * Function to configure if a cell can contain Comments
+     */
+    isCellCommentable?: (commentableCellContext: CommentableCellContext) => boolean;
+    /**
+     * Loads the Comment Threads
+     */
+    loadCommentThreads?(commentLoadContext: CommentLoadContext): Promise<CommentThread[]>;
+    /**
+     * Persists the current Comment Threads
+     * @param commentThreads
+     */
+    persistCommentThreads?(commentThreads: CommentThread[]): Promise<void>;
+    /**
+     * Format string for dates in Comments Popup
+     *
+     * @defaultValue 'dd-MM-yyyy HH:mm:ss'
+     */
+    dateFormat?: string;
+}
+/**
+ * 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/CustomSortOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableScope } from '../../types';
+import { ColumnScope } from '../../types';
 import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
 /**
  * Options for providing Custom Sorts comparers
@@ -16,7 +16,7 @@ export interface ColumnValuesComparer<TData = any> {
     /**
      * Column for which to compare values
      */
-    scope: AdaptableScope;
+    scope: ColumnScope;
     /**
      * Comparer function to use
      */

package/src/AdaptableOptions/DataImportOptions.d.ts

@@ -5,7 +5,7 @@ import { IRowNode } from '@ag-grid-community/core';
  */
 export interface DataImportOptions<T = Record<string, any>> {
     /**
-     * File extensions that the Data Import function accepts
+     * Custom File Handlers to use for Data Import
      */
     fileHandlers?: DataImportFileHandler<T>[];
     /**
@@ -60,7 +60,7 @@ export interface DataImportFileHandler<T = Record<string, any>> {
      */
     fileExtension?: string;
     /**
-     * Function which handles the File
+     * Async function which handles the import returning a Data Record
      */
     handleFile: (file: File) => Promise<T[]>;
 }

package/src/AdaptableOptions/FormatColumnOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
+import { ColumnScope } from '../PredefinedConfig/Common/ColumnScope';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { BaseContext } from '../../types';
 import { IRowNode } from '@ag-grid-community/core';
@@ -30,7 +30,7 @@ export interface CustomDisplayFormatter {
     /**
      * Where Custom Display Format can be applied
      */
-    scope: AdaptableScope;
+    scope: ColumnScope;
 }
 /**
  * Context used in handler of CustomDisplayFormatter

package/src/AdaptableOptions/GroupingOptions.d.ts

@@ -1,20 +1,7 @@
-import { AdaptableColumn, BaseContext } from '../../types';
-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)
-    */
-    balancedGroupsKey?: string | ((context: BalancedGroupsKeyContext<TData>) => string);
     /**
      * Places ungrouped columns at pre-grouping indexed position
      * @defaultValue false
@@ -30,16 +17,3 @@ export interface GroupingOptions<TData = any> {
      */
     autoOrderGroupedColumns?: boolean;
 }
-/**
- * Context used when setting a value for Balanced Row Groups
- */
-export interface BalancedGroupsKeyContext<TData = any> extends BaseContext {
-    /**
-     * AdapTable Column being grouped
-     */
-    adaptableColumn: AdaptableColumn<TData>;
-    /**
-     * AG Grid's Key Creator Params
-     */
-    params: KeyCreatorParams<TData>;
-}

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -1,69 +1,17 @@
-import { AdaptableMenuItem, ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
-import { AdaptableColumn, AdaptableIcon, AdaptableModule, BaseContext } from '../types';
+import { AdaptableMenuItem, ColumnMenuContext, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableColumn, AdaptableIcon, BaseContext } from '../types';
 /**
  * Options for managing menus in AdapTable – provided using 2 collections
  */
 export interface MenuOptions<TData = any> {
-    /**
-     * Customises Context Menu (default context menu items are available in provided context)
-     */
-    customContextMenu?: (menuContext: CustomContextMenuContext<TData>) => CustomContextMenuItem[];
     /**
      * 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
+     * Customises Context Menu (default context menu items are available in provided context)
      */
-    contextMenuItems?: UserMenuItem<ContextMenuContext>[];
+    customContextMenu?: (menuContext: CustomContextMenuContext<TData>) => CustomContextMenuItem[];
 }
 /**
  * Context info provided when building Custom Context Menus
@@ -74,13 +22,13 @@ export interface CustomContextMenuContext<TData = any> extends ContextMenuContex
      */
     defaultAgGridMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
     /**
-     * Default AdapTable Menu Items
+     * Flat list of all available AdapTable Menu Items
      */
     defaultAdaptableMenuItems: AdaptableSystemMenuItem[];
     /**
-     * All Adaptable Menu Items sorted and grouped
+     * Default structure of Adaptable Menu Items
      */
-    structuredAdaptableMenuItems: AdaptableSystemMenuItem[];
+    defaultAdaptableMenuStructure: (AdaptableSystemMenuItem | '-')[];
 }
 /**
  * Context info provided when building Custom Column Menus
@@ -91,13 +39,13 @@ export interface CustomColumnMenuContext<TData = any> extends ColumnMenuContext<
      */
     defaultAgGridMenuItems: AgGridMenuItem<AgGridColumnMenuItemType>[];
     /**
-     * Default AdapTable Menu Items
+     * Flat list of all available AdapTable Menu Items
      */
     defaultAdaptableMenuItems: AdaptableSystemMenuItem[];
     /**
-     * All Adaptable Menu Items sorted and grouped
+     * Default structure of Adaptable Menu Items
      */
-    structuredAdaptableMenuItems: AdaptableSystemMenuItem[];
+    defaultAdaptableMenuStructure: (AdaptableSystemMenuItem | '-')[];
 }
 /**
  * Custom Context Menu Item
@@ -219,16 +167,8 @@ export interface MenuOrderContext extends BaseContext {
 /**
  * Defines AG Grid Context Menu Items
  */
-export type AgGridContextMenuItemType = 'autoSizeAll' | 'expandAll' | 'contractAll' | 'copy' | 'copyWithHeaders' | 'cut' | 'paste' | 'resetColumns' | 'export' | 'csvExport' | 'excelExport' | 'chartRange' | 'pivotChart';
+export type AgGridContextMenuItemType = 'autoSizeAll' | 'expandAll' | 'contractAll' | 'copy' | 'copyWithHeaders' | 'copyWithGroupHeaders' | 'cut' | 'paste' | 'resetColumns' | 'export' | 'csvExport' | 'excelExport' | 'chartRange' | 'pivotChart';
 /**
  * Defines AG Grid Column Menu Items
  */
 export type AgGridColumnMenuItemType = 'pinSubMenu' | 'valueAggSubMenu' | 'autoSizeThis' | 'autoSizeAll' | 'rowGroup' | 'rowUnGroup' | 'resetColumns' | 'expandAll' | 'contractAll';
-type ModuleGroup = {
-    modules: AdaptableModule[];
-    icon?: AdaptableIcon;
-    title: string;
-};
-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 @@
-import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
-export const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE = [
-    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,
-    ModuleConstants.AlertModuleId,
-    ModuleConstants.CalculatedColumnModuleId,
-    ModuleConstants.ExportModuleId,
-    ModuleConstants.ColumnFilterModuleId,
-    {
-        title: 'Edit',
-        icon: {
-            name: 'edit',
-        },
-        modules: [ModuleConstants.SmartEditModuleId, ModuleConstants.BulkUpdateModuleId],
-    },
-    ModuleConstants.TeamSharingModuleId,
-    ModuleConstants.DataChangeHistoryModuleId,
-    ModuleConstants.DataSetModuleId,
-    ModuleConstants.FreeTextColumnModuleId,
-    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.ScheduleModuleId,
-    ModuleConstants.StateManagementModuleId,
-    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,
-    ModuleConstants.AlertModuleId,
-    ModuleConstants.CalculatedColumnModuleId,
-    ModuleConstants.ExportModuleId,
-    ModuleConstants.ColumnFilterModuleId,
-    {
-        title: 'Edit',
-        modules: [ModuleConstants.SmartEditModuleId, ModuleConstants.BulkUpdateModuleId],
-    },
-    ModuleConstants.TeamSharingModuleId,
-    ModuleConstants.DataChangeHistoryModuleId,
-    ModuleConstants.DataSetModuleId,
-    ModuleConstants.FreeTextColumnModuleId,
-    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.ScheduleModuleId,
-    ModuleConstants.StateManagementModuleId,
-    ModuleConstants.ThemeModuleId,
-    ModuleConstants.ChartingModuleId,
-    ModuleConstants.NotesModuleId,
-];
+export {};

package/src/AdaptableOptions/NoteOptions.d.ts

@@ -0,0 +1,25 @@
+import { BaseContext, GridCell } from '../../types';
+/**
+ * Options for managing AdapTable Notes
+ */
+export interface NoteOptions<TData = any> {
+    /**
+     * Whether a cell can contain Notes
+     */
+    isCellNotable?: (context: NotableCellContext) => boolean;
+    /**
+     * Format string for formatting in the Notes Popup
+     *
+     * @defaultValue 'dd-MM-yyyy HH:mm:ss'
+     */
+    dateFormat?: string;
+}
+/**
+ * Context used when determining if a Note can be added to a Cell
+ */
+export interface NotableCellContext extends BaseContext {
+    /**
+     * Grid Cell in AdapTable which has been clicked
+     */
+    gridCell: GridCell;
+}

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScope, SystemAlertPredicateId, SystemAlertPredicateIds, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, SystemFilterPredicateId, SystemFilterPredicateIds, SystemFlashingCellPredicateId, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds } from '../types';
+import { AdaptablePredicateDef, ColumnScope, BaseContext, PredicateModuleScope, SystemAlertPredicateId, SystemAlertPredicateIds, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, SystemFilterPredicateId, SystemFilterPredicateIds, SystemFlashingCellPredicateId, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds } from '../types';
 /**
  * Options for managing Adaptable Predicates using AdaptableQL
  */
@@ -51,5 +51,5 @@ export interface SystemPredicatesContext<PREDICATE_TYPE = string> extends BaseCo
     /**
      * Current Scope where Predicates are being used
      */
-    columnScope: AdaptableScope;
+    columnScope: ColumnScope;
 }

package/src/AdaptableOptions/StateOptions.d.ts

@@ -33,6 +33,12 @@ export interface StateOptions {
      * @defaultValue 400
      */
     debounceStateDelay?: number;
+    /**
+     * Automatically migrate State from previous AdapTable version to current one
+     *
+     * @defaultValue true
+     */
+    autoMigrateState?: boolean;
 }
 /**
  * State Function Config object passed into all State Options functions (except 'applyState')

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
 import { DateInputOptions } from './DateInputOptions';
-import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
+import { ColumnScope } from '../PredefinedConfig/Common/ColumnScope';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
@@ -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
@@ -119,7 +136,7 @@ export interface BasePermittedValues {
     /**
      * Scope where Values will appear (Mandatory property)
      */
-    scope: AdaptableScope;
+    scope: ColumnScope;
 }
 /**
  * Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)

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,17 @@ 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[];
+    /**
+     * Returns all columns of a given columnType
+     * @param columnType the columnType to filter by
+     */
+    getColumnsByColumnType(columnType: string): AdaptableColumn[];
+    /**
+     * Returns all columns currently Row Grouped
+     */
+    getRowGroupedColumns(): AdaptableColumn[];
 }