@adaptabletools/adaptable 10.0.4-canary.4 → 11.0.0-canary.2

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -45,7 +45,7 @@ export interface ExportOptions {
      */
     systemExportDestinations?: SystemExportDestinations;
     /**
-     * Whether to add a timestamp ('yyyyMMdd_HHmmss') as a suffix to exported file name
+     * Whether to add a timestamp as a suffix to exported file name
      *
      * @defaultValue false
      * @gridInfoItem

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -32,7 +32,7 @@ export interface FilterOptions {
      */
     indicateFilteredColumns?: boolean;
     /**
-     * Uses Adaptable's Filter Form in Column header menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
+     * Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
      *
      * @defaultValue true
      */
@@ -45,7 +45,7 @@ export interface FilterOptions {
      */
     useAgGridFilterFormStyle?: boolean;
     /**
-     * Use Adaptable's Quick Filter for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
+     * Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
      *
      * @defaultValue true
      * @gridInfoItem

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -28,7 +28,7 @@ export interface FinancePluginOptions {
  */
 export interface InstrumentColumn {
     /**
-     * Column to be defined as an Instrument - its value will provide the `name` property in the FDC3 message
+     * Column defined as an Instrument - its value provides the `name` property in the FDC3 message
      */
     columnId: string;
     /**

package/src/AdaptableOptions/FlashingCellOptions.d.ts

@@ -0,0 +1,31 @@
+import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+/**
+ * Properties for Flashing Cell
+ */
+export interface FlashingCellOptions {
+    /**
+     * Should a cell or whole row flash
+     * @defaultValue  'cell'
+     */
+    defaultFlashTarget?: 'row' | 'cell';
+    /**
+     * Style for 'Down' value changes
+     *  @defaultValue  Red BackColour
+     */
+    defaultDownChangeStyle?: AdaptableStyle;
+    /**
+     * Style for 'Up' value changes
+     * @defaultValue  Green BackColour
+     */
+    defaultUpChangeStyle?: AdaptableStyle;
+    /**
+     * Style for 'Neutral' value changes
+     * @defaultValue  Gray BackColour
+     */
+    defaultNeutralChangeStyle?: AdaptableStyle;
+    /**
+     * Duration of Flash - can be number (in ms) or 'always'
+     * @defaultValue 500ms
+     */
+    defaultFlashDuration?: number | 'always';
+}

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -71,7 +71,7 @@ export interface GeneralOptions {
      */
     customSortComparers?: ColumnValuesComparer[];
     /**
-     * Maintain upper and lower case when performing text operations (applies to both Expressions and Predicates)
+     * Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates
      *
      * @defaultValue false
      * @gridInfoItem

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -39,11 +39,11 @@ export interface MenuOptions {
      */
     contextMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
     /**
-     * A collection of UserMenuItem objects to be added to the Column Header Menu (the one that appears as a dropdown in each Column Header).
+     * User-defined Menu Items to add to the Column Menu
      */
     columnMenuItems?: UserMenuItem<ColumnMenuContext>[];
     /**
-     * A collection of UserMenuItem objects to be added to the Context Menu (the one that appears when you right-click on a cell, or cells, in the Grid).
+     * User-defined Menu Items to add to the Context Menu
      */
     contextMenuItems?: UserMenuItem<ContextMenuContext>[];
 }

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,4 +1,4 @@
-import { AlertButton, AlertDefinition, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
+import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
@@ -21,12 +21,6 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     maxNotifications?: number;
-    /**
-     * Flashing Alert Defaults
-     *
-     * @defaultValue BackColors: Green (up), Red (down), Gray (neutral), Duration: 500ms
-     */
-    flashingAlertDefaultProperties?: FlashingAlertProperties;
     /**
      * Where Notification will appear (if anywhere)
      *
@@ -104,7 +98,7 @@ export interface NotificationsOptions {
      * @defaultValue false
      * @gridInfoItem
      */
-    showSystemStatusMessageAsAlert?: boolean;
+    showSystemStatusMessageNotifications?: boolean;
     /**
      * How many System Status Messages to hold in State; when limit is reached, oldest Message is removed
      *

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -0,0 +1,87 @@
+import { AdaptableApi, AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
+import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
+export interface SettingsPanelOptions {
+    /**
+     * Title for the Settings Panel
+     *
+     * @defaultValue 'Settings Panel'
+     * @gridInfoItem
+     */
+    title?: string;
+    /**
+     * Icon for Settings Panel  Can be `ConfigurationIcon`, `ApplicationIcon` or a custom Icon
+     *
+     * @defaultValue 'ConfigurationIcon'
+     */
+    icon?: 'ConfigurationIcon' | 'ApplicationIcon' | AdaptableIcon;
+    /**
+     * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    alwaysShowInDashboard?: boolean;
+    /**
+     * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    alwaysShowInToolPanel?: boolean;
+    /**
+     * Ordered items to display at side of Settings Panel
+     */
+    navigation?: {
+        items?: (AdaptableSettingsPanel | string | '-')[];
+    };
+    /**
+     * Initial position of Settings Panel window
+     *
+     * @defaultValue 'Middle of Screen'
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Initial size of Settings Panel
+     *
+     * @defaultValue 'Computed based on size of screen'
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * How Settings Panel behaves: can be 'window' (movable, resizable no backdrop) or 'modal' (centre of screen with backdrop)
+     *
+     * @defaultValue 'window'
+     */
+    popupType?: 'modal' | 'window';
+    /**
+     * Custom Settings Panels provided by developers at design-time
+     */
+    customSettingsPanels?: CustomSettingsPanel[];
+}
+export interface CustomSettingsPanel {
+    /**
+     * Name appears in Settings Panel Navigation
+     * To be shown you must include it in settingsPanelOptions.navigation.
+     * By default is added to the end.
+     */
+    name: string;
+    /**
+     * Icon rendered inside settings-panel name, inside the navigation
+     */
+    icon?: AdaptableIcon;
+    /**
+     * Function to provide bespoke content when NOT using a Framework wrapper
+     */
+    render?: ({ visible, node, adaptableApi, }: {
+        visible: boolean;
+        node: HTMLDivElement;
+        adaptableApi: AdaptableApi;
+    }) => string | null;
+    /**
+     * Framework-specific (Angular or React) component to be rendered
+     */
+    frameworkComponent?: AdaptableFrameworkComponent;
+}

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -30,7 +30,7 @@ export interface TeamSharingOptions {
      */
     updateInterval?: number;
     /**
-     * How user is informed when Active Shared Entities have newer revisions: can be 'Alert', 'AlertWithNotification' or 'SystemStatus'
+     * How user is informed when Active Shared Entities have newer revisions
      *
      * @defaultValue null (none)
      * @gridInfoItem

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -52,20 +52,6 @@ export interface ToolPanelOptions {
      * @defaultValue ['filters', 'columns', 'adaptable']
      */
     toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
-    /**
-     * Display the Modules dropdown
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showModulesDropdown?: boolean;
-    /**
-     * Display the Columns dropdown
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showColumnsDropdown?: boolean;
     /**
      * Display the Tool Panels dropdown
      *

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -74,6 +74,11 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     styleClassNames?: string[];
+    /**
+     * Optional list of Column Types - used primarily for special columns
+     *
+     */
+    columnTypes?: string[];
     /**
      * Provide links to AdapTable documentation (in Module popups and Expression Editor)
      *
@@ -81,6 +86,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 {
     /**
@@ -201,17 +212,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

@@ -1,4 +1,3 @@
-import { SparklineColumnApi } from './SparklineColumnApi';
 import { AlertApi } from './AlertApi';
 import { PluginsApi } from './PluginsApi';
 import { BulkUpdateApi } from './BulkUpdateApi';
@@ -34,6 +33,8 @@ import { ApplicationApi } from './ApplicationApi';
 import { ScopeApi } from './ScopeApi';
 import { PredicateApi } from './PredicateApi';
 import { DataChangeHistoryApi } from './DataChangeHistoryApi';
+import { FlashingCellApi } from './FlashingCellApi';
+import { ChartingApi } from './ChartingApi';
 /**
  *
  * 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
      */
@@ -82,7 +84,7 @@ export interface AdaptableApi {
      */
     dashboardApi: DashboardApi;
     /**
-     * Provides run-time access to the Data Change History Module
+     * Provides run-time access to the Data Changes Module
      **/
     dataChangeHistoryApi: DataChangeHistoryApi;
     /**
@@ -122,7 +124,7 @@ export interface AdaptableApi {
      */
     plusMinusApi: PlusMinusApi;
     /**
-     * Offers access to AdapTable Plugin (e.g. charts, ipushpull, OpenFin etc)
+     * Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)
      */
     pluginsApi: PluginsApi;
     /**
@@ -157,10 +159,6 @@ export interface AdaptableApi {
      * Provides access to the Smart Edit Module
      */
     smartEditApi: SmartEditApi;
-    /**
-     * Provides access to the Sparkline Column in the Charts Plugin
-     */
-    sparklineColumnApi: SparklineColumnApi;
     /**
      * Methods related to displaying System Status and application health messages
      */
@@ -181,6 +179,10 @@ export interface AdaptableApi {
      * Manages User Interface Options where colours, styles and permitted values are configured
      */
     userInterfaceApi: UserInterfaceApi;
+    /**
+     * Provides run-time access to Charting Module and state
+     */
+    chartingApi: ChartingApi;
     /**
      * 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/ChartingApi.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Provides run-time access to Charting Module and state
+ */
+export interface ChartingApi {
+    /**
+     * Whether this Adaptable instance has Charting functions available.
+     */
+    isChartingEnabled(): boolean;
+}

package/src/Api/ColumnApi.d.ts

@@ -12,7 +12,7 @@ export interface ColumnApi {
     getColumns(): AdaptableColumn[];
     /**
      * Retrieves 'ColumnType' property for a given Column
-     * @param columnId Colmun to use
+     * @param columnId Column to use
      */
     getAgGridColumnType(columnId: string): string | string[];
     /**
@@ -69,11 +69,21 @@ export interface ColumnApi {
      * @param columnId Column to select
      */
     selectColumn(columnId: string): void;
+    /**
+     * Adds (highlights) a Column to any existing selection
+     * @param columnId Column to select
+     */
+    addColumnToSelection(columnId: string): void;
     /**
      * Selects (highlights) group of Columns
      * @param columnIds columns to select
      */
     selectColumns(columnIds: string[]): void;
+    /**
+     * Adds (highlights) a group of Columns to any existing selection
+     * @param columnIds columns to select
+     */
+    addColumnsToSelection(columnIds: string[]): void;
     /**
      * Selects all Columns
      */

package/src/Api/ConfigApi.d.ts

@@ -1,4 +1,3 @@
-import { ChartState } from '../PredefinedConfig/ChartState';
 import { ThemeState } from '../PredefinedConfig/ThemeState';
 import { ShortcutState } from '../PredefinedConfig/ShortcutState';
 import { QuickSearchState } from '../PredefinedConfig/QuickSearchState';
@@ -14,7 +13,6 @@ import { AlertState } from '../PredefinedConfig/AlertState';
 import { ConfigState } from '../PredefinedConfig/ConfigState';
 import { PlusMinusState } from '../PredefinedConfig/PlusMinusState';
 import { ApplicationState } from '../PredefinedConfig/ApplicationState';
-import { SparklineColumnState } from '../PredefinedConfig/SparklineColumnState';
 import { AdaptableState } from '../PredefinedConfig/AdaptableState';
 import { FreeTextColumnState } from '../PredefinedConfig/FreeTextColumnState';
 import { FilterState } from '../PredefinedConfig/FilterState';
@@ -114,11 +112,6 @@ export interface ConfigApi {
      * @param returnJson return as JSON rather than object
      */
     getCalculatedColumnState(returnJson: boolean): CalculatedColumnState;
-    /**
-     * Returns Chart section of Adaptable State
-     * @param returnJson return as JSON rather than object
-     */
-    getChartState(returnJson: boolean): ChartState;
     /**
      * Returns Conditional Style section of Adaptable State
      * @param returnJson return as JSON rather than object
@@ -189,11 +182,6 @@ export interface ConfigApi {
      * @param returnJson return as JSON rather than object
      */
     getShortcutState(returnJson: boolean): ShortcutState;
-    /**
-     * Returns Sparkline Column section of Adaptable State
-     * @param returnJson return as JSON rather than object
-     */
-    getSparklineColumnState(returnJson: boolean): SparklineColumnState;
     /**
      * Returns Theme section of Adaptable State
      * @param returnJson return as JSON rather than object

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 **Cell Flashing** is triggered in AdapTable.
+     * @param eventName FlashingCellDisplayed
+     * @param callback FlashingCellDisplayedInfo which wrap the `AdaptableFlashingCell` that was displayed
      * @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
@@ -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

@@ -5,7 +5,7 @@ import { BaseEventInfo } from './BaseEventInfo';
  */
 export interface AdaptableReadyInfo extends BaseEventInfo {
     /**
-     * Underlying AG Grid instance
+     * Underlying AG Grid GridOptions object
      */
     gridOptions: 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 `FlashingCellDisplayed` event
+ */
+export interface FlashingCellDisplayedInfo extends BaseEventInfo {
+    /**
+     * Details of the Cell (or row) which has just flashed
+     */
+    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[];
 }