@adaptabletools/adaptable 10.0.4-canary.1 → 10.0.4-canary.5

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -81,6 +81,12 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     showDocumentationLinks?: boolean;
+    /**
+     * Which sections to show in the Grid Info Screen
+     *
+     * @defaultValue ['GridSummary', 'AdaptableOptions','ColumnInfo']
+     */
+    gridInfoSections?: GridInfoSections;
 }
 export interface BasePermittedValues {
     /**
@@ -111,7 +117,7 @@ export interface FilterPermittedValues extends BasePermittedValues {
      * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
      * @default false
      */
-    suppressClientSideFiltering?: boolean;
+    suppressFilterSearchBar?: boolean;
     values: (params: FilterPermittedValuesParams) => any[] | Promise<any[]>;
 }
 /**
@@ -169,7 +175,7 @@ export interface ActionColumnButtonContext extends ButtonContext {
      */
     primaryKeyValue: any;
     /**
-     * Current Row Node
+     * Current AG Grid Row Node
      */
     rowNode: RowNode;
 }
@@ -178,7 +184,7 @@ export interface ActionColumnButtonContext extends ButtonContext {
  */
 export interface ActionColumnSettings {
     /**
-     * Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid
+     * Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid
      */
     width?: number;
     /**
@@ -201,17 +207,40 @@ export interface BaseParams {
     adaptableApi: AdaptableApi;
 }
 export interface EditLookUpParams extends BaseParams {
+    /**
+     * Column displaying the Edit LookUp
+     */
     column: AdaptableColumn;
+    /**
+     * Cell being edited
+     */
     gridCell: GridCell;
 }
 export interface PermittedValuesParams extends BaseParams {
+    /**
+     * Column whose values are being displayed
+     */
     column: AdaptableColumn;
 }
 export interface FilterPermittedValuesParams extends BaseParams {
+    /**
+     * Column hosting the filter form
+     */
     column: AdaptableColumn;
+    /**
+     * A search string
+     */
     filter: string;
 }
 export interface BulkUpdatePermittedValuesParams extends BaseParams {
+    /**
+     * Column being edited via Bulk Update
+     */
     column: AdaptableColumn;
+    /**
+     * Cells which will be modified in the Bulk Update
+     */
     gridCells: GridCell[];
 }
+export declare type GridInfoSections = GridInfoSection[];
+export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo';

package/src/Api/AdaptableApi.d.ts

@@ -34,6 +34,7 @@ import { ApplicationApi } from './ApplicationApi';
 import { ScopeApi } from './ScopeApi';
 import { PredicateApi } from './PredicateApi';
 import { DataChangeHistoryApi } from './DataChangeHistoryApi';
+import { FlashingCellApi } from './FlashingCellApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -45,6 +46,7 @@ export interface AdaptableApi {
      * Provides access to the Alert Module
      */
     alertApi: AlertApi;
+    flashingCellApi: FlashingCellApi;
     /**
      * Provides access to the Application Module
      */
@@ -65,14 +67,14 @@ export interface AdaptableApi {
      * Provides a number of column-related methods
      */
     columnApi: ColumnApi;
-    /**
-     * Methods giving access to Adaptable State
-     */
-    configApi: ConfigApi;
     /**
      * Provides access to the Conditional Style Module
      */
     conditionalStyleApi: ConditionalStyleApi;
+    /**
+     * Methods giving access to Adaptable State
+     */
+    configApi: ConfigApi;
     /**
      * Provides access to the Custom Sort Module
      */
@@ -81,6 +83,10 @@ export interface AdaptableApi {
      * Provides access to the Dashboard
      */
     dashboardApi: DashboardApi;
+    /**
+     * Provides run-time access to the Data Changes Module
+     **/
+    dataChangeHistoryApi: DataChangeHistoryApi;
     /**
      * Provides access to the Data Source Module
      */
@@ -161,6 +167,10 @@ export interface AdaptableApi {
      * Methods related to displaying System Status and application health messages
      */
     systemStatusApi: SystemStatusApi;
+    /**
+     * Functions related to run-time Team Sharing of AdapTable objects between colleagues
+     */
+    teamSharingApi: TeamSharingApi;
     /**
      * Api methods related to Theme management
      */
@@ -173,14 +183,6 @@ export interface AdaptableApi {
      * Manages User Interface Options where colours, styles and permitted values are configured
      */
     userInterfaceApi: UserInterfaceApi;
-    /**
-     * Functions related to run-time Team Sharing of AdapTable objects between colleagues
-     */
-    teamSharingApi: TeamSharingApi;
-    /**
-     * Provides run-time access to the Data Change History Module
-     **/
-    dataChangeHistoryApi: DataChangeHistoryApi;
     /**
      * Api methods used *internally* within AdapTable.
      */

package/src/Api/AlertApi.d.ts

@@ -1,11 +1,11 @@
-import { AlertState, AlertDefinition, AdaptableAlertAction, AlertButton, FlashingAlertDefinition, BaseAlertDefinition } from '../PredefinedConfig/AlertState';
+import { AlertState, AlertDefinition, AdaptableAlertAction, AlertButton } from '../PredefinedConfig/AlertState';
 import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
 import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
-import { AdaptableFlashingAlert } from '../PredefinedConfig/Common/AdaptableFlashingAlert';
 import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
+import { AdaptableMessageType, AlertProperties } from '../types';
 /**
  * Provides run-time access to Alert function and associated State
  */
@@ -54,41 +54,6 @@ export interface AlertApi {
      * @returns alert definitions
      */
     getActiveReactiveAlertDefinitions(): AlertDefinition[];
-    /**
-     * Retrieves all Flashing Alert Definitions in Alert State
-     */
-    getFlashingAlertDefinitions(): FlashingAlertDefinition[];
-    /**
-     * Retrieves Flashing Alert Definition By Id
-     * @param id Flashing Alert id
-     * @returns flashing alert definition
-     */
-    getFlashingAlertDefinitionById(id: FlashingAlertDefinition['Uuid']): FlashingAlertDefinition;
-    /**
-     * Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
-     * @returns flashing alert definitions
-     */
-    getNonReactiveFlashingAlertDefinitions(): FlashingAlertDefinition[];
-    /**
-     * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
-     * @returns flashing alert definitions
-     */
-    getActiveNonReactiveFlashingAlertDefinitions(): FlashingAlertDefinition[];
-    /**
-     * Retrieves all Flashing Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
-     * @returns flashing alert definitions
-     */
-    getReactiveFlashingAlertDefinitions(): FlashingAlertDefinition[];
-    /**
-     * Retrieves all active (non-suspended) Flashing Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
-     * @returns flashing alert definitions
-     */
-    getActiveReactiveFlashingAlertDefinitions(): FlashingAlertDefinition[];
-    /**
-     * Returns where a Flashing Alert Definition will flash a single cell or a whole row
-     * @param flashingAlertDefinition Flashing Alert Definition to check
-     */
-    getFlashingAlertFlashTarget(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition['FlashTarget'];
     /**
      * Retrieves all Alert Definitions which prevent a Cell Edit
      * @returns alert definitions
@@ -141,12 +106,7 @@ export interface AlertApi {
      * @param alertDefinition The Alert Definition which defines when the Alert is triggered
      * @param dataChangedInfo The (optional) DataChangedInfo object that might have triggered the Alert
      */
-    showAlert(alertHeader: string, alertMessage: string, alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): void;
-    /**
-     * Displays a Flashing Alert
-     * @param flashingAlertToShow Flashing Alert to show
-     */
-    showFlashingAlert(flashingAlertToShow: AdaptableFlashingAlert): void;
+    showAlert(alertHeader: string, alertMessage: string, messageType: AdaptableMessageType, alertProperties?: AlertProperties): void;
     /**
      * Creates Alert formed from inputted values and displays it as Info Alert.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
@@ -202,41 +162,6 @@ export interface AlertApi {
      * @returns alert definition
      */
     unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
-    /**
-     * Edits Flashing Alert in State with given one
-     * @param flashingAlertDefinition Flashing Alert to Edit
-     * @returns alert flashing definition
-     */
-    editFlashingAlertDefinition(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition;
-    /**
-     * Edits provided Flashing Alert Definitions
-     * @param flashingAlertDefinitions Flashing Alerts to Edit
-     * @returns flashing alerts definitions
-     */
-    editFlashingAlertDefinitions(flashingAlertDefinitions: FlashingAlertDefinition[]): FlashingAlertDefinition[];
-    /**
-     * Adds a Flashing Alert Definition to State
-     * @param flashingAlertDefinition Flashing Alert to Add
-     */
-    addFlashingAlertDefinition(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition;
-    /**
-     * Adds provided Flashing Alert Definitions
-     * @param flashingAlertDefinitions Flashing Alerts to Add
-     * @returns flashing alert definition
-     */
-    addFlashingAlertDefinitions(flashingAlertDefinitions: FlashingAlertDefinition[]): FlashingAlertDefinition[];
-    /**
-     * Suspends a Flashing Alert Definition
-     * @param flashingAlertDefinition Alert to Suspend
-     * @returns flashing alert definition
-     */
-    suspendFlashingAlertDefinition(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition;
-    /**
-     * Activates a suspended Flashing Alert Definition
-     * @param flashingAlertDefinition Flashing Alert to Un-Suspend (activate)
-     * @returns flashing alert definition
-     */
-    unSuspendFlashingAlertDefinition(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition;
     /**
      * Returns a description of an Alert Definition
      * @param alertDefinition Alert Definition to use
@@ -246,5 +171,5 @@ export interface AlertApi {
      * Returns a description of an Alert Definition's Rule
      * @param alertDefinition Alert Definition to use
      */
-    getAlertRuleDescription(alertDefinition: BaseAlertDefinition): string;
+    getAlertRuleDescription(alertDefinition: AlertDefinition): string;
 }

package/src/Api/ColumnApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../PredefinedConfig/Common/Enums';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { Column, RowNode } from '@ag-grid-community/all-modules';
 import { GridCell } from '../../types';
 /**
  * A large range of column-related functions in AdapTable
@@ -14,7 +14,7 @@ export interface ColumnApi {
      * Retrieves 'ColumnType' property for a given Column
      * @param columnId Colmun to use
      */
-    getVendorColumnType(columnId: string): string | string[];
+    getAgGridColumnType(columnId: string): string | string[];
     /**
      * Returns all visible Columns
      * */
@@ -255,10 +255,15 @@ export interface ColumnApi {
      */
     getAllColumnFriendlyNames(): string[];
     /**
-     * Retrieves the field property for the column
-     * @param columnId string
+     * Retrieves AG Grid's field property for the column
+     * @param columnId columnId to look up
      */
-    getVendorGridColumnFieldForColumn(columnId: string): string;
+    getAgGridColumnFieldForAdaptableColumn(columnId: string): string;
+    /**
+     * Retrieves AG Grid's column for an Adaptable column
+     * @param columnId columnId to look up
+     */
+    getAgGridColumnForAdaptableColumn(columnId: string): Column;
     /**
      * Does Column use AdapTable's Filter Form
      * @param columnId Column to Check

package/src/Api/DataChangeHistoryApi.d.ts

@@ -31,4 +31,8 @@ export interface DataChangeHistoryApi {
      * @param dataChangeInfo the change to be undone
      */
     undoDataChangeHistoryEntry(dataChangeInfo: DataChangedInfo): void;
+    /**
+     * Opens Data Change History screen
+     */
+    showDataChangeHistoryPopup(): void;
 }

package/src/Api/EventApi.d.ts

@@ -11,7 +11,7 @@ import { CellChangedInfo } from './Events/CellChanged';
 import { SystemStatusMessageDisplayedInfo } from './Events/SystemStatusMessageDisplayed';
 import { CheckboxColumnClickedInfo } from './Events/ChexboxColumnClicked';
 import { AdaptableStateChangedInfo } from './Events/AdaptableStateChanged';
-import { FlashingAlertFiredInfo } from './Events/FlashingAlertFired';
+import { FlashingCellDisplayedInfo } from './Events/FlashingCellDisplayed';
 import { GridDataChangedInfo } from './Events/GridDataChanged';
 import { TeamSharingEntityChangedInfo } from './Events/TeamSharingEntityChanged';
 /**
@@ -115,16 +115,16 @@ export interface EventApi {
      */
     off(eventName: 'AlertFired', callback: (alertFiredInfo: AlertFiredInfo) => void): void;
     /**
-     * Event fired whenever a **FlashingAlert is triggered** in AdapTable.
-     * @param eventName FlashingAlertFired
-     * @param callback FlashingAlertFiredInfo which wrap the FlashingAlert that was fired
+     * Event fired whenever a **FlashingCell is triggered** in AdapTable.
+     * @param eventName FlashingCellFired
+     * @param callback FlashingCellFiredInfo which wrap the FlashingCell that was fired
      * @returns the unsubscribe function
      */
-    on(eventName: 'FlashingAlertFired', callback: (flashingAlertFiredInfo: FlashingAlertFiredInfo) => void): VoidFunction;
+    on(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): VoidFunction;
     /**
-     * Unsubscribe from FlashingAlertFired
+     * Unsubscribe from FlashingCellDisplayed
      */
-    off(eventName: 'FlashingAlertFired', callback: (flashingAlertFiredInfo: FlashingAlertFiredInfo) => void): void;
+    off(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): void;
     /**
      * Event fired whenever the **Button in a Checkbox Column is clicked**.
      * @param eventName CheckboxColumnClicked
@@ -196,7 +196,7 @@ export interface EventApi {
     /**
      * Fired when Adaptable is up and running - has no arguments.
      * @param eventName AdaptableReady - use as: adaptableApi.eventApi.on('AdaptableReady', (adaptableReadyInfo: AdaptableReadyInfo) => { .....[do stuff]...})
-     * @param callback An `AdaptableReadyInfo` object which contains the adaptableApi and the vendorGrid
+     * @param callback An `AdaptableReadyInfo` object which contains the adaptableApi and GridOptions
      * @returns the unsubscribe function
      */
     on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;
@@ -205,6 +205,6 @@ export interface EventApi {
      */
     off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
-    emitSync(eventName: 'FlashingAlertFired', data?: any): any[];
+    emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'BroadcastInstrument', data?: any): Promise<any>;
 }

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

@@ -1,10 +1,11 @@
+import { GridOptions } from '@ag-grid-community/all-modules';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by `AdaptableReady` event - fired when AdapTable has loaded
  */
 export interface AdaptableReadyInfo extends BaseEventInfo {
     /**
-     * Instance of the underlying vendor grid (e.g. for AG Grid its the GridOptions object)
+     * Underlying AG Grid GridOptions object
      */
-    vendorGrid: any;
+    agGridOptions: GridOptions;
 }

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

@@ -0,0 +1,11 @@
+import { AdaptableFlashingCell } from '../../PredefinedConfig/Common/AdaptableFlashingCell';
+import { BaseEventInfo } from './BaseEventInfo';
+/**
+ * Object returned by the `FlashingAlertFired` event
+ */
+export interface FlashingCellDisplayedInfo extends BaseEventInfo {
+    /**
+     * FlashingAlert which has been fired
+     */
+    flashingCell: AdaptableFlashingCell;
+}

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

@@ -1,3 +1,4 @@
+import { RowNode } from '@ag-grid-community/all-modules';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by GridDataChanged event
@@ -11,5 +12,6 @@ export interface GridDataChangedInfo extends BaseEventInfo {
      * Trigger for row change: 'Add', 'Edit' or 'Delete'
   }
      */
-    rowTigger: 'Add' | 'Edit' | 'Delete';
+    rowTrigger: 'Add' | 'Edit' | 'Delete';
+    rowNodes: RowNode[];
 }

package/src/Api/FlashingCellApi.d.ts

@@ -0,0 +1,78 @@
+import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlashingCell';
+import { FlashingCellDefinition, FlashingCellState } from '../PredefinedConfig/FlashingCellState';
+/**
+ * Provides run-time access to Alert function and associated State
+ */
+export interface FlashingCellApi {
+    /**
+     * Retrieves Alert section from Adaptable State
+     * @returns alert state
+     */
+    getFlashingCellState(): FlashingCellState;
+    /**
+     * Retrieves all Flashing cell Definitions in Alert State
+     */
+    getFlashingCellDefinitions(): FlashingCellDefinition[];
+    /**
+     * Retrieves Flashing cell Definition By Id
+     * @param id Flashing Alert id
+     * @returns flashing cell definition
+     */
+    getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid']): FlashingCellDefinition;
+    /**
+     * Retrieves all cell Definitions in Alert State which are NOT Reactive (BooleanQuery)
+     * @returns flashing cell definitions
+     */
+    getNonReactiveFlashingCellDefinitions(): FlashingCellDefinition[];
+    /**
+     * Retrieves all active (non-suspended) cell Definitions in Alert State which are NOT Reactive (BooleanQuery)
+     * @returns flashing cell definitions
+     */
+    getActiveNonReactiveFlashingCellDefinitions(): FlashingCellDefinition[];
+    /**
+     * Returns where a Flashing cell Definition will flash a single cell or a whole row
+     * @param flashingCellDefinition Flashing cell Definition to check
+     */
+    getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];
+    /**
+     * Displays a Flashing Alert
+     * @param flashingCellToShow Flashing Alert to show
+     */
+    showFlashingCell(flashingCellToShow: AdaptableFlashingCell): void;
+    /**
+     * Edits Flashing Alert in State with given one
+     * @param flashingCellDefinition Flashing Alert to Edit
+     * @returns alert flashing definition
+     */
+    editFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
+    /**
+     * Edits provided Flashing cell Definitions
+     * @param flashingCellDefinitions Flashing Alerts to Edit
+     * @returns flashing alerts definitions
+     */
+    editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
+    /**
+     * Adds a Flashing cell Definition to State
+     * @param flashingCellDefinition Flashing Alert to Add
+     */
+    addFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
+    setFlashingCellDefinition(flashingCellDefinitions: FlashingCellDefinition[]): void;
+    /**
+     * Adds provided Flashing cell Definitions
+     * @param flashingCellDefinitions Flashing Alerts to Add
+     * @returns flashing cell definition
+     */
+    addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
+    /**
+     * Suspends a Flashing cell Definition
+     * @param flashingCellDefinition Alert to Suspend
+     * @returns flashing cell definition
+     */
+    suspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
+    /**
+     * Activates a suspended Flashing cell Definition
+     * @param flashingCellDefinition Flashing Alert to Un-Suspend (activate)
+     * @returns flashing cell definition
+     */
+    unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
+}

package/src/Api/FlashingCellApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/GridApi.d.ts

@@ -5,10 +5,10 @@ import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
 import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
-import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
+import { CellHighlightInfo, RowHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
 import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
 /**
  * Provides access to important properites of AdapTable e.g. sorting, selected cells etc.
@@ -20,7 +20,7 @@ export interface GridApi {
     getGridState(): GridState;
     /**
      * Repopulates grid with given data
-     * @param data any data from any datasource that is suitable for the underlying grid.
+     * @param data any data from any datasource that is suitable for AG Grid
      */
     setGridData(data: any): void;
     /**
@@ -33,23 +33,23 @@ export interface GridApi {
     getFilteredData(): any[];
     /**
      * Loads grid with given data
-     * @param data any data from any datasource that is suitable for the underlying grid.
+     * @param data any data from any datasource that is suitable for AG Grid
      */
     loadGridData(data: any): void;
     /**
-     * Updates Adaptable (and underlying grid) with rows that have changed
+     * Updates Adaptable (and AG Grid) with rows that have changed
      * @param dataRows rows which have been updated - send whole row and Adaptable will take care of the rest
      * @param config batch option and callback function to run post update
      */
     updateGridData(dataRows: any[], config?: DataUpdateConfig): void;
     /**
-     * Adds rows to Adaptable (and underlying grid)
+     * Adds rows to Adaptable (and AG Grid)
      * @param dataRows rows to add; ensure all 'mandatory' fields are included and Primary Key is unique
      * @param config batch option and callback function to run post addition
      */
     addGridData(dataRows: any[], config?: DataUpdateConfig): void;
     /**
-     * Deletes rows from Adaptable (and underlying grid)
+     * Deletes rows from Adaptable (and AG Grid)
      * @param dataRows rows which should be deleted
      * @param config batch option and callback function to run post deletion
      */
@@ -86,9 +86,9 @@ export interface GridApi {
      */
     getSelectedRowInfo(): SelectedRowInfo;
     /**
-     * Returns underlying Vendor Grid (object passed into Adaptable Options at start-up)
+     * Returns Ag Grid instance (passed into Adaptable Options at start-up)
      */
-    getVendorGrid(): any;
+    getAgGridInstance(): GridOptions;
     /**
      * Returns Column Sort information in Adaptable
      */
@@ -308,13 +308,13 @@ export interface GridApi {
      */
     fireSearchChangedEvent(searchChangedTrigger: 'DataSource' | 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort', searchAtDate?: Date): void;
     /**
-     * Fires Grid Data Changed Event - when any data in vendor grid data set has changed
+     * Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed
      */
     fireCellChangedEvent(cellChangedInfo: DataChangedInfo): void;
     /**
-     * Fires Grid Data Changed Event - when any data in vendor grid data set has changed
+     * Fires Grid Data Changed Event - when a row has changed in AG Grid
      */
-    fireGridDataChangedEvent(dataRows: any[], rowTigger: 'Add' | 'Edit' | 'Delete'): void;
+    fireGridDataChangedEvent(dataRows: any[], rowNodes: RowNode[], rowTrigger: 'Add' | 'Edit' | 'Delete'): void;
     /**
      * Grid will jump to Row containing given Primary Kev Value
      * @param primaryKeyValue value in Primary Key Column
@@ -340,12 +340,26 @@ export interface GridApi {
      * Unhighlights a Cell in AdapTable
      * @param cellHighlightInfo cell to unhighlight
      */
-    unhighlightCell(cellHighlightInfo: CellHighlightInfo): void;
+    unHighlightCell(primaryKeyValue: CellHighlightInfo['primaryKeyValue'], columnId: CellHighlightInfo['columnId']): void;
     /**
      * Unhighlights all highlighted Cells in AdapTable
      * @param cellHighlightInfo cell to highlight
      */
-    unhighlightAllCells(): void;
+    unHighlightAllCells(): void;
+    /**
+     * Highlight a row using an adaptable style
+     * @param rowHighlightInfo highlight instructions
+     */
+    highlightRow(rowHighlightInfo: RowHighlightInfo): void;
+    /**
+     * Remove highlight from row
+     * @param primaryKeyValue
+     */
+    unHighlightRow(primaryKeyValue: RowHighlightInfo['primaryKeyValue']): void;
+    /**
+     * Remove all highlighted rows
+     */
+    unHighlightAllRows(): void;
     /**
      * Refresh Cells in AdapTable
      * @param rowNodes agGrid RowNodes which contain cells to refresh
@@ -356,7 +370,12 @@ export interface GridApi {
      * Forces a render of a row
      * @param primaryKey row primary key
      */
-    refreshRow(primaryKey: any): void;
+    refreshRowByPrimaryKey(primaryKey: any): void;
+    /**
+     *
+     * @param rowNode ag-grid row
+     */
+    refreshRowNode(rowNode: RowNode): void;
     /**
      * Returns number of rows in Data Source
      */
@@ -399,4 +418,8 @@ export interface GridApi {
      * Returns the Grid Container in which the Adaptable Instance is present
      */
     getGridContainerElement(): HTMLElement | null;
+    /**
+     * Opens Grid Info popup screen
+     */
+    showGridInfoPopup(): void;
 }

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

@@ -36,10 +36,12 @@ import { ApplicationApi } from '../ApplicationApi';
 import { ScopeApi } from '../ScopeApi';
 import { PredicateApi } from '../PredicateApi';
 import { DataChangeHistoryApi } from '../DataChangeHistoryApi';
+import { FlashingCellApi } from '../FlashingCellApi';
 export declare class AdaptableApiImpl implements AdaptableApi {
     protected adaptable: IAdaptable;
     applicationApi: ApplicationApi;
     alertApi: AlertApi;
+    flashingCellApi: FlashingCellApi;
     predicateApi: PredicateApi;
     bulkUpdateApi: BulkUpdateApi;
     calculatedColumnApi: CalculatedColumnApi;

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -37,12 +37,14 @@ const ApplicationApiImpl_1 = require("./ApplicationApiImpl");
 const ScopeApiImpl_1 = require("./ScopeApiImpl");
 const DataChangeHistoryApiImpl_1 = require("./DataChangeHistoryApiImpl");
 const QueryLanguageApiImpl_1 = require("./QueryLanguageApiImpl");
+const FlashingCellApiImpl_1 = require("./FlashingCellApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
         this.adaptable = adaptable;
         this.applicationApi = new ApplicationApiImpl_1.ApplicationApiImpl(adaptable);
         this.alertApi = new AlertApiImpl_1.AlertApiImpl(adaptable);
+        this.flashingCellApi = new FlashingCellApiImpl_1.FlashingCellApiImpl(adaptable);
         this.predicateApi = new PredicateApiImpl_1.PredicateApiImpl(adaptable);
         this.pluginsApi = new PluginsApiImpl_1.PluginsApiImpl(adaptable);
         this.bulkUpdateApi = new BulkUpdateApiImpl_1.BulkUpdateApiImpl(adaptable);