@adaptabletools/adaptable 18.0.0-canary.0 → 18.0.0-canary.10

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -1,4 +1,4 @@
-import { ChartModel, ChartRef, Column, GridOptions, IRowNode, Module, ModuleNames, RowModelType, StatusPanelDef } from '@ag-grid-community/core';
+import { ChartModel, ChartRef, Column, GridApi, GridOptions, IRowNode, Module, RowModelType, StatusPanelDef } from '@ag-grid-community/core';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
@@ -10,8 +10,7 @@ import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo
 import { AdaptableTheme } from '../PredefinedConfig/ThemeState';
 import { IAdaptableStore } from '../Redux/Store/Interface/IAdaptableStore';
 import { IModuleCollection } from '../Strategy/Interface/IModule';
-import { ActionColumnContext, AdaptableButton, AdaptableMenuItem, AdaptableOptions, AdaptablePlugin, ChartDefinition, CustomSort, SelectedRowInfo } from '../types';
-import { IPPStyle } from '../Utilities/Interface/IPPStyle';
+import { AdaptableMenuItem, AdaptableOptions, AdaptablePlugin, ChartDefinition, SelectedRowInfo } from '../types';
 import { ICalculatedColumnExpressionService } from '../Utilities/Services/Interface/ICalculatedColumnExpressionService';
 import { IDataService } from '../Utilities/Services/Interface/IDataService';
 import { CellPopupService } from '../Utilities/Services/CellPopupService';
@@ -25,11 +24,14 @@ import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
 import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';
 import { AdaptableFrameworkComponent } from '../AdaptableOptions/AdaptableFrameworkComponent';
 import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
-import { ColumnValuesComparer } from '../AdaptableOptions/CustomSortOptions';
-import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService';
 import { RenderReactRootFn } from '../renderReactRoot';
 import { AdaptableLogger } from '../agGrid/AdaptableLogger';
 import { Fdc3Service } from '../Utilities/Services/Fdc3Service';
+import { SummaryService } from '../Utilities/Services/SummaryService';
+import { AgGridAdapter } from '../agGrid/AgGridAdapter';
+import { AgGridColumnAdapter } from '../agGrid/AgGridColumnAdapter';
+import { AgGridMenuAdapter } from '../agGrid/AgGridMenuAdapter';
+import { RowEditService } from '../Utilities/Services/RowEditService';
 /**
  * Contains AG Grid Options and Modules - used when instantiating AdapTable vanilla
  */
@@ -59,37 +61,18 @@ export type AdaptableVariant = 'vanilla' | 'react' | 'angular';
 export interface IAdaptable {
     logger: AdaptableLogger;
     variant: AdaptableVariant;
-    renderReactRoot: RenderReactRootFn;
+    isReady: boolean;
+    isDestroyed: boolean;
     api: AdaptableApi;
     adaptableOptions: AdaptableOptions;
-    _rawAdaptableOptions: AdaptableOptions;
     adaptableStore: IAdaptableStore;
     adaptableModules: IModuleCollection;
-    gridOptions: GridOptions;
-    /**
-     * If using AG Grid community (which has no menu)
-     */
+    agGridAdapter: AgGridAdapter;
+    agGridMenuAdapter: AgGridMenuAdapter;
+    agGridColumnAdapter: AgGridColumnAdapter;
     embedColumnMenu: boolean;
-    /**
-     * Set when Adaptable is fully initialised
-     *
-     * Avoid unnecessary store calls and rendering
-     */
-    isInitialised: boolean;
-    /**
-     * Set to true when adaptable is destroyed.
-     */
-    isDestroyed: boolean;
-    /**
-     * TRUE iff:
-     *  1. isInitialised = TRUE
-     *  2. isDestroyed = FALSE
-     */
-    isLive: boolean;
-    /**
-     * TRUE if the Adaptable custom tool panel (side-bar) is displayed
-     */
     hasAdaptableToolPanel: boolean;
+    renderReactRoot: RenderReactRootFn;
     /**
      * Adaptable contains a number of 'Services' which are created at Startup
      *
@@ -105,9 +88,10 @@ export interface IAdaptable {
     AlertService: IAlertService;
     TeamSharingService: ITeamSharingService;
     MetamodelService: IMetamodelService;
-    RowEditService: IRowEditService;
+    RowEditService: RowEditService;
     Fdc3Service: Fdc3Service;
     CellPopupService: CellPopupService;
+    SummaryService: SummaryService;
     /**
      * INTERNAL ADAPTABLE EVENTS
      * These are not called externally - for that we use eventapi
@@ -120,6 +104,7 @@ export interface IAdaptable {
     _on(eventName: 'ScrollChanged', callback: () => void): () => void;
     _on(eventName: 'MouseEnter', callback: (event: MouseEvent) => void): () => void;
     _on(eventName: 'MouseLeave', callback: (event: MouseEvent) => void): () => void;
+    _on(eventname: 'FirstDataRendered', callback: () => void): () => void;
     _on(eventName: 'CellEditorKeyDown', callback: (param: {
         keyDownEvent: KeyboardEvent;
         cellValue: any;
@@ -149,20 +134,34 @@ export interface IAdaptable {
         componentType: string;
     }): Promise<any>;
     _emitSync(eventName: 'CreateAdaptableContextMenuItems', data?: any): Promise<any>;
-    prepareGrid(): void;
+    /**
+     *
+     */
+    getAgGridContainerElement(): HTMLElement | null;
     redrawBody(): void;
-    redrawRenderedRows(): void;
-    redrawHeader(): void;
+    refreshHeader(): void;
     redrawRow(rowNode: IRowNode): void;
-    redrawRows(rowNodes: IRowNode[]): void;
+    redrawRows(rowNodes?: IRowNode[]): void;
     refreshCells(rowNodes: IRowNode[], columns: (string | any)[], forceUpdate: boolean, suppressFlash?: boolean): void;
     refreshColumns(columns: (string | Column)[], forceUpdate: boolean, suppressFlash?: boolean): void;
-    setSelectedCells(): SelectedCellInfo | undefined;
-    setSelectedRows(): SelectedRowInfo | undefined;
+    refreshSelectedCellsState(): SelectedCellInfo | undefined;
+    refreshSelectedRowsState(): SelectedRowInfo | undefined;
+    selectColumn(columnId: string, config?: {
+        keepExistingSelection?: boolean;
+    }): void;
+    selectColumns(columnIds: string[], config?: {
+        keepExistingSelection?: boolean;
+    }): void;
+    selectAll(): void;
+    deselectAll(): void;
+    selectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
+    deSelectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
+    selectNode(rowNode: IRowNode, clearSelection: boolean): void;
+    deSelectNode(rowNode: IRowNode, clearSelection: boolean): void;
+    selectCells(columnIds: string[], startNode: IRowNode, endNode: IRowNode, clearSelection?: boolean): void;
     jumpToRow(rowNode: IRowNode): void;
     jumpToColumn(columnId: string): void;
     jumpToCell(columnId: string, rowNode: IRowNode): void;
-    getAgGridContainerElement(): HTMLElement | null;
     setGridData(dataSource: any): void;
     getGridData(): any[];
     getFilteredData(): any[];
@@ -173,50 +172,22 @@ export interface IAdaptable {
         updated: IRowNode[];
     }>;
     deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
-    selectColumn(columnId: string, config?: {
-        keepExistingSelection?: boolean;
-    }): void;
-    selectColumns(columnIds: string[], config?: {
-        keepExistingSelection?: boolean;
-    }): void;
-    selectAll(): void;
-    deselectAll(): void;
-    hideColumn(columnId: string): void;
-    showColumn(columnId: string): void;
-    autoSizeColumn(columnId: string): void;
-    autoSizeColumns(columnIds: string[]): void;
-    autoSizeAllColumns(): void;
-    updateColumnsIntoStore(): void;
-    setColumnOrder(visibleColumnList: string[]): void;
-    getPrimaryKeyValueFromRowNode(rowNode: IRowNode): any;
-    getColumnValueDisplayValuePairList(columnId: string, visibleRowsOnly: boolean, onlyIncludeIds?: {
-        [key: string]: boolean;
-    }): any[];
+    getPrimaryKeyValueFromRowNode(rowNode: IRowNode, gridApi?: GridApi): any;
     getDistinctValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctValuesParams): GridCell[];
-    getDistinctFilterListValuesForColumn(column: AdaptableColumn, filter: string, distinctValuesParams: DistinctValuesParams): Promise<{
-        gridCells: GridCell[];
-        suppressClientSideFilter?: boolean;
-    }>;
-    getDistinctCustomSortValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctValuesParams): Promise<GridCell[]>;
-    getDistinctBulkUpdateValuesForColumn(column: AdaptableColumn, selectedGridCells: GridCell[], distinctValuesParams: DistinctValuesParams): Promise<GridCell[]>;
-    getDisplayValue(id: any, columnId: string): string | undefined;
     getGridCellFromRowNode(rowNode: IRowNode, columnId: string): GridCell | undefined;
     getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any;
     getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): string | undefined;
     getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
     getGridCellsForColumn(columnId: string): GridCell[] | undefined;
-    getDataRowFromRowNode(rowNode: IRowNode): any;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;
     getRowNodeByIndex(index: number): IRowNode;
     getAgGridStatusPanels(): StatusPanelDef[];
     forPlugins(callback: (plugin: AdaptablePlugin) => any): void;
-    lookupPlugins(propertyName: string, ...args: any): any;
     getPluginProperty(pluginId: string, propertyName: string, ...args: any): any;
     getPlugin(pluginId: string): AdaptablePlugin;
     setDataValue(value: any, column: AdaptableColumn, primaryKeyValue: any, rowNode?: IRowNode): void;
-    cancelEdit(): any;
     isCellEditable(rowNode: IRowNode, column: Column): boolean;
     getFirstRowNode(): IRowNode | undefined;
     getFirstDisplayedRowNode(): IRowNode | undefined;
@@ -228,10 +199,6 @@ export interface IAdaptable {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): void;
-    getVisibleRowNodes(config?: {
-        includeGroupRows?: boolean;
-        filterFn?: (rowNode: IRowNode) => boolean;
-    }): IRowNode[];
     getAllRowNodes(config?: {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
@@ -242,26 +209,26 @@ export interface IAdaptable {
     updateRowGroupsExpandedState(layout?: Layout): void;
     getRowsInViewport(): IRowNode[];
     isGroupRowNode(rowNode: IRowNode): boolean;
-    isVisibleNode(rowNode: IRowNode): boolean;
-    selectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
-    deSelectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
-    selectNode(rowNode: IRowNode, clearSelection: boolean): void;
-    deSelectNode(rowNode: IRowNode, clearSelection: boolean): void;
-    selectCells(columnIds: string[], startNode: IRowNode, endNode: IRowNode, clearSelection?: boolean): void;
-    getFirstGroupedColumn(): AdaptableColumn | undefined;
     isRowNodeVisible(rowNode: IRowNode): boolean;
     getAgGridColumnType(columnId: string): string | string[];
-    getActiveColumnComparator(columnId: string, customSort?: CustomSort, customSortComparer?: ColumnValuesComparer): (valueA: any, valueB: any, nodeA?: IRowNode, nodeB?: IRowNode, isInverted?: boolean) => number | undefined;
+    hideColumn(columnId: string): void;
+    showColumn(columnId: string): void;
+    autoSizeColumn(columnId: string): void;
+    autoSizeColumns(columnIds: string[]): void;
+    autoSizeAllColumns(): void;
+    setColumnOrder(visibleColumnList: string[]): void;
     setColumnSort(columnSorts: ColumnSort[]): void;
     clearColumnSort(): void;
     hideColumnFilterForm(): void;
-    applyColumnFiltering(): void;
     clearColumnFiltering(): void;
     clearColumnFilteringForColumns(columnIds: string[]): void;
+    applyColumnFiltering(): void;
     applyGridFiltering(): void;
-    canExportToExcel(): boolean;
-    exportToExcel(reportData: ReportData, fileName: string): void;
-    exportVisualDataToExcel(): void;
+    refreshQuickFilter(): void;
+    showQuickFilter(): void;
+    hideQuickFilter(): void;
+    isQuickFilterAvailable(): boolean;
+    setAgGridQuickSearch(query: string): void;
     canGenerateCharts(): boolean;
     canDisplaySparklines(): boolean;
     showCharts(charts: ChartDefinition[]): ChartRef[];
@@ -270,32 +237,13 @@ export interface IAdaptable {
     updateChart(chart: ChartDefinition): void;
     getChartModels(): ChartModel[];
     getAgGridRowModelType(): RowModelType;
-    getCurrentIPPStyle(): IPPStyle;
-    getDefaultIPPStyle(): IPPStyle;
     getRowCount(): number;
     getColumnCount(): number;
-    getVisibleRowCount(): number;
     getVisibleColumnCount(): number;
-    setLayout(layout: Layout): void;
     isGridSelectable(): boolean;
-    isGridRangeSelectable(): boolean;
-    isGridGroupable(): boolean;
-    isGridPivotable(): boolean;
     isGridGroupingActive(): boolean;
-    showQuickFilter(): void;
-    hideQuickFilter(): void;
-    isQuickFilterAvailable(): boolean;
-    setAgGridQuickSearch(query: string): void;
-    getAgGridLightThemeName(): string;
     getAgGridCurrentThemeName(): string;
     applyAdaptableTheme(theme: AdaptableTheme | string): void;
-    /**
-     * called when you want to destroy the instance & cleanup resources
-     */
-    destroy(config?: {
-        unmount: boolean;
-        destroyApi?: boolean;
-    }): void;
     setRowGroupColumns(columnIds: string[]): void;
     getAgGridAllGridColumns(): Column<any>[];
     clearRowGroupColumns(): void;
@@ -305,14 +253,19 @@ export interface IAdaptable {
     getExpandRowGroupsKeys(): any[];
     getAdaptableContainerElement(): HTMLElement | null;
     getAgGridContainerElement(): HTMLElement | null;
-    buildStandaloneColumnHeader(adaptableColumn: AdaptableColumn): AdaptableMenuItem[];
-    setupColumns(): void;
-    updateColDefsForSpecialColumns({ skipSetupColumns }?: {
-        skipSetupColumns?: boolean;
+    updateColumnModelAndRefreshGrid(config?: {
+        skipColDefsRefresh?: boolean;
     }): void;
     getAgGridColumnForColumnId(columnId: string): Column;
-    isAgGridModulePresent(moduleName: ModuleNames): boolean;
     getMinMaxCachedValueForColumn(column: AdaptableColumn, minMax: 'min' | 'max'): number | undefined;
     getAgGridRegisteredModules(): Module[];
-    getActionRowButtonDefs: () => AdaptableButton<ActionColumnContext<any>>[];
+    setupRowSummaries: () => void;
+    destroy(config?: {
+        unmount: boolean;
+        destroyApi?: boolean;
+    }): void;
+    setLayout(layout?: Layout): void;
+    canExportToExcel(): boolean;
+    exportToExcel(reportData: ReportData, fileName: string): void;
+    exportVisualDataToExcel(): void;
 }

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 { CommentsOptions } 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 Notes
      */
-    notesOptions?: NotesOptions;
+    noteOptions?: NoteOptions;
     /**
      * Options for managing AdapTable Comments
      */
-    commentsOptions?: CommentsOptions<TData>;
+    commentOptions?: CommentsOptions<TData>;
     /**
      * Options for using Custom Sort
      */

package/src/AdaptableOptions/ColumnFilterOptions.d.ts

@@ -177,17 +177,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,7 @@
 import { Column } from '@ag-grid-community/core';
-import { AdaptableColumnGroup } from '../types';
+import { AdaptableColumnGroup, BaseContext } from '../types';
+export interface ColumnTypesContext extends BaseContext {
+}
 /**
  * Options related to managing Columns in Adaptable.
  */
@@ -13,7 +15,7 @@ export interface ColumnOptions {
      * Optional list of Column Types - used primarily for Calculated and FreeText Columns
      * @defaultValue undefined
      */
-    columnTypes?: string[];
+    columnTypes?: string[] | ((context: ColumnTypesContext) => string[]);
     /**
      * Log warning to console if AdapTable cannot find a column
      *

package/src/AdaptableOptions/{CommentsOptions.d.ts → CommentOptions.d.ts}

@@ -1,17 +1,17 @@
 import { CommentThread, BaseContext, CellAddress } from '../../types';
 /**
- * Options for managing AdapTable Notes
+ * Options for managing Comments and Comment Threads in AdapTable
  */
 export interface CommentsOptions<TData = any> {
     /**
      * Whether a cell can be noted on
      * TODO: check if it works
      */
-    isCellCommentable?: (context: CommentableCellContext) => boolean;
+    isCellCommentable?: (commentableCellContext: CommentableCellContext) => boolean;
     /**
      * Called to load initial comments
      */
-    loadCommentThreads?(context: CommentsLoadContext): Promise<CommentThread[]>;
+    loadCommentThreads?(commentLoadContext: CommentLoadContext): Promise<CommentThread[]>;
     /**
      * Called when comments change
      * @param commentThreads
@@ -19,10 +19,10 @@ export interface CommentsOptions<TData = any> {
     persistCommentThreads?(commentThreads: CommentThread[]): void;
 }
 /**
- * Context used when determining if a Note can be added to a Cell
+ * Context used when determining if a Comment can be added to a Cell
  */
 export interface CommentableCellContext extends BaseContext {
     address: CellAddress;
 }
-export interface CommentsLoadContext extends BaseContext {
+export interface CommentLoadContext extends BaseContext {
 }

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -230,5 +230,5 @@ type ModuleGroup = {
     title: string;
 };
 export declare const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE: (AdaptableModule | ModuleGroup)[];
-export declare const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER: (AdaptableModule | ModuleGroup)[];
+export declare const DEFAULT_ADAPTABLE_COLUMN_MENU_STRUCTURE: (AdaptableModule | ModuleGroup)[];
 export {};

package/src/AdaptableOptions/MenuOptions.js

@@ -38,9 +38,7 @@ export const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE = [
     ModuleConstants.ExportModuleId,
     ModuleConstants.DataImportModuleId,
     ModuleConstants.DataChangeHistoryModuleId,
-    ModuleConstants.SmartEditModuleId,
     ModuleConstants.PlusMinusModuleId,
-    ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.ShortcutModuleId,
     ModuleConstants.TeamSharingModuleId,
     ModuleConstants.ScheduleModuleId,
@@ -50,7 +48,7 @@ export const DEFAULT_ADAPTABLE_CONTEXT_MENU_STRUCTURE = [
     ModuleConstants.NotesModuleId,
     ModuleConstants.CommentsModuleId,
 ];
-export const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = [
+export const DEFAULT_ADAPTABLE_COLUMN_MENU_STRUCTURE = [
     ModuleConstants.SettingsPanelModuleId,
     ModuleConstants.DashboardModuleId,
     ModuleConstants.ToolPanelModuleId,
@@ -86,9 +84,7 @@ export const DEFAULT_ADAPTABLE_COLUMN_MENU_ORDER = [
     ModuleConstants.ExportModuleId,
     ModuleConstants.DataImportModuleId,
     ModuleConstants.DataChangeHistoryModuleId,
-    ModuleConstants.SmartEditModuleId,
     ModuleConstants.PlusMinusModuleId,
-    ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.ShortcutModuleId,
     ModuleConstants.TeamSharingModuleId,
     ModuleConstants.ScheduleModuleId,

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

@@ -2,7 +2,7 @@ import { BaseContext, CellAddress } from '../../types';
 /**
  * Options for managing AdapTable Notes
  */
-export interface NotesOptions<TData = any> {
+export interface NoteOptions<TData = any> {
     /**
      * Whether a cell can be noted on
      */

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';
@@ -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
      */

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/ConfigApi.d.ts

@@ -27,7 +27,7 @@ export interface ConfigApi {
      */
     setAdaptableStateKey(adaptableStateKey: string, config?: {
         predefinedConfig: PredefinedConfig;
-    }): PromiseLike<void>;
+    }): Promise<void>;
     /**
      * Returns current Predefined Config
      */

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

@@ -1,11 +1,11 @@
-import { GridOptions } from '@ag-grid-community/core';
+import { GridApi } from '@ag-grid-community/core';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by `AdaptableReady` event - fired when AdapTable has loaded
  */
 export interface AdaptableReadyInfo<TData = any> extends BaseEventInfo {
     /**
-     * Underlying AG Grid GridOptions object
+     * Underlying AG Grid API
      */
-    gridOptions: GridOptions<TData>;
+    agGridApi: GridApi<TData>;
 }

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

@@ -1,9 +1,9 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { BaseEventInfo } from './BaseEventInfo';
+export type GridDataChangeTrigger = 'Add' | 'Edit' | 'Delete' | 'Load';
 /**
  * EventInfo returned by GridDataChanged event
- */
-export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
+ */ export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
     /**
      * Timestamp of change occurrence (in milliseconds)
      */
@@ -13,9 +13,9 @@ export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
      */
     dataRows: TData[];
     /**
-     * Trigger for row change: 'Add', 'Edit' or 'Delete'
+     * Trigger for row change: 'Add', 'Edit', 'Delete', 'Load'
      */
-    rowTrigger: 'Add' | 'Edit' | 'Delete';
+    rowTrigger: GridDataChangeTrigger;
     /**
      * Row Nodes that were affected by this change
      */

package/src/Api/GridApi.d.ts

@@ -7,7 +7,7 @@ import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
 import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
 import { RowHighlightInfo } from '../PredefinedConfig/Common/RowHighlightInfo';
-import { GridOptions, IRowNode, RowModelType } from '@ag-grid-community/core';
+import { IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
 import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo';
 /**
@@ -27,15 +27,18 @@ export interface GridApi {
      */
     getFilteredData(): any[];
     /**
-     * Repopulates Grid with given data; fires `GridDataChanged` Event
-     * @param data any data suitable as AG Grid data source
+     * @deprecated use `loadGridData()` instead
      */
     resetGridData(data: any[]): void;
     /**
-     * Sets grid with given data for FIRST use; doesn't fire 'GridDataChanged' Event
-     * @param dataany data suitable as AG Grid data source
+     * @deprecated use `loadGridData()` instead
      */
     setInitialGridData(data: any): void;
+    /**
+     * Loads data into grid and fire a `GridDataChanged.trigger='Load'` event
+     * @param data data to load
+     */
+    loadGridData(data: any): void;
     /**
      * Updates AdapTable (and AG Grid) with rows that have changed
      * @param dataRows rows which have been updated - send whole row and AdapTable take cares of the rest
@@ -86,10 +89,6 @@ export interface GridApi {
      * Returns all current Selected Rows in AdapTable
      */
     getSelectedRowInfo(): SelectedRowInfo;
-    /**
-     * Returns Ag Grid instance (passed into Adaptable Options at start-up)
-     */
-    getAgGridInstance(): GridOptions;
     /**
      * Returns Column Sort information in AdapTable
      */
@@ -469,10 +468,6 @@ export interface GridApi {
      * Returns number of rows in Data Source
      */
     getRowCount(): number;
-    /**
-     * Returns number of visible rows in Data Source
-     */
-    getVisibleRowCount(): number;
     /**
      * Returns number of columns in Data Source
      */
@@ -515,4 +510,14 @@ export interface GridApi {
      * Returns AG Grid Row Model Type
      */
     getAgGridRowModelType(): RowModelType;
+    /**
+     * Returns number of visible rows in Data Source
+     *
+     * @deprecated use `getRowCount()` instead
+     */
+    getVisibleRowCount(): number;
+    /**
+     * Opens a window with a transposed view of Grid
+     */
+    showTransposedView(transposedColumnId: string, hideTransposedColumn?: boolean): void;
 }

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

@@ -1,7 +1,9 @@
 import { ActionColumn, ActionColumnApi } from '../../../types';
 import { ApiBase } from './ApiBase';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { ColDef } from '@ag-grid-community/core';
 export declare class ActionColumnApiImpl extends ApiBase implements ActionColumnApi {
     constructor(adaptable: IAdaptable);
     getActionColumns(): ActionColumn[];
+    getColDefsForActionColumns(): ColDef[];
 }