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

package/src/Api/Implementation/SystemStatusApiImpl.js

@@ -18,7 +18,7 @@ class SystemStatusApiImpl extends ApiBase_1.ApiBase {
         this.adaptable.api.internalApi.addSystemStatusMessageInfo(systemStatusMessageInfo);
         // publish the event
         this.fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo);
-        if (this.getNotificationsOptions().showSystemStatusMessageAsAlert) {
+        if (this.getNotificationsOptions().showSystemStatusMessageNotifications) {
             let fullMessage = statusMessage;
             if (StringExtensions_1.default.IsNotNullOrEmpty(statusFurtherInformation)) {
                 fullMessage += '\n' + statusFurtherInformation;

package/src/Api/Implementation/ToolPanelApiImpl.js

@@ -13,13 +13,13 @@ class ToolPanelApiImpl extends ApiBase_1.ApiBase {
         this.showModulePopup(ModuleConstants.ToolPanelModuleId, popupParams);
     }
     openAdapTableToolPanel() {
-        let gridOptions = this.getOptions().vendorGrid;
+        let gridOptions = this.getOptions().agGridOptions;
         if (gridOptions) {
             gridOptions.api.openToolPanel('adaptable');
         }
     }
     closeAdapTableToolPanel() {
-        let gridOptions = this.getOptions().vendorGrid;
+        let gridOptions = this.getOptions().agGridOptions;
         if (gridOptions) {
             gridOptions.api.closeToolPanel();
         }

package/src/Api/InternalApi.d.ts

@@ -22,7 +22,7 @@ import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { IDataService } from '../Utilities/Services/Interface/IDataService';
 import { AdaptableMessageType, DataChangedInfo, SystemStatusMessageInfo } from '../types';
 import { IEntitlementService } from '../Utilities/Services/Interface/IEntitlementService';
-import { AdaptableFlashingAlert } from '../PredefinedConfig/Common/AdaptableFlashingAlert';
+import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlashingCell';
 import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
 import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
 import { AdaptableState } from '../PredefinedConfig/AdaptableState';
@@ -50,7 +50,7 @@ export interface InternalApi {
     setChartVisibility(chartVisbility: ChartVisibility): void;
     getAdaptableAlerts(): AdaptableAlert[];
     showPopupConfirmation(confirmation: UIConfirmation): void;
-    getAdaptableFlashingAlertFor(primaryKey: string, columnId?: string): AdaptableFlashingAlert | null;
+    getAdaptableFlashingCellFor(primaryKey: string, columnId?: string): AdaptableFlashingCell | null;
     addSystemStatusMessageInfo(systemStatusMessageInfo: SystemStatusMessageInfo): void;
     getSystemStatusMessageInfos(): SystemStatusMessageInfo[];
     showLoadingScreen(): void;
@@ -112,8 +112,8 @@ export interface InternalApi {
     dispatchReduxAction(action: Action): void;
     waitForTeamSharingImportEnd(): Promise<boolean>;
     getUserDefinedHeaderName(columnId: string): string;
-    createFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
-    destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
+    createFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar' | string): void;
+    destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar' | string): void;
     initializeDataChangeHistory(): void;
     isTextComparisonCaseSensitive(): boolean;
     executeWithProgressIndicator(label: string, executeFn: () => unknown): void;

package/src/Api/SmartEditApi.d.ts

@@ -4,16 +4,16 @@ import { GridCell } from '../PredefinedConfig/Selection/GridCell';
  **/
 export interface SmartEditApi {
     /**
-     * Sets operation to use in Smart Edit
+     * Sets Smart Edit operation: ('Add','Subtract','Multiply','Divide'
      * @param operation operation to run
      */
-    setSmartEditOperation(operation: 'Add' | 'Subtract' | 'Multiply' | 'Divide' | 'Replace'): void;
+    setSmartEditOperation(operation: 'Add' | 'Subtract' | 'Multiply' | 'Divide'): void;
     /**
-     * Gets current Smart Edit Operation ('Add','Subtract','Multiply','Divide' or 'Replace')
+     * Gets current Smart Edit Operation
      */
     getSmartEditOperation(): string;
     /**
-     * Sets Smart Edit Value (e.g. to multiply by 10 then smartEditValue is 10)
+     * Sets Smart Edit Value
      * @param smartEditValue the value to use in Smart Edit Operation
      */
     setSmartEditValue(smartEditValue: number): void;

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -24,6 +24,7 @@ import { SparklineColumnState } from './SparklineColumnState';
 import { ApplicationState } from './ApplicationState';
 import { ToolPanelState } from './ToolPanelState';
 import { QueryState } from './QueryState';
+import { FlashingCellState } from './FlashingCellState';
 /**
  * The main state object that Adaptable persists
  */
@@ -38,6 +39,7 @@ export interface AdaptableState {
     Application: ApplicationState;
     SparklineColumn: SparklineColumnState;
     Alert: AlertState;
+    FlashingCell: FlashingCellState;
     CalculatedColumn: CalculatedColumnState;
     Chart: ChartState;
     ConditionalStyle: ConditionalStyleState;

package/src/PredefinedConfig/AlertState.d.ts

@@ -20,16 +20,12 @@ export interface AlertState extends ConfigState {
      * @defaultValue  null
      */
     AlertDefinitions?: AlertDefinition[];
-    /**
-     * Flashing Alert Definitions - will colour cells/rows when rule is met
-     * @defaultValue  null
-     */
-    FlashingAlertDefinitions?: FlashingAlertDefinition[];
+    FlashingAlertDefinitions?: any[];
 }
 /**
- * Base object used in all Alert Definitions - contains `Scope` and a `Rule`
+ * The Alert Definition object used in the Alert function
  */
-export interface BaseAlertDefinition extends SuspendableObject {
+export interface AlertDefinition extends SuspendableObject {
     /**
      * Where Alert can be triggered: one, some or all columns or DataTypes
      */
@@ -38,46 +34,6 @@ export interface BaseAlertDefinition extends SuspendableObject {
      * When Alert should be triggered
      */
     Rule: AlertRule;
-}
-/**
- * Properties to use in Flashing Alerts
- */
-export interface FlashingAlertProperties {
-    /**
-     * Should a cell or whole row flash
-     * @defaultValue  'cell'
-     */
-    FlashTarget?: 'row' | 'cell';
-    /**
-     * Style for 'Down' value changes
-     *  @defaultValue  Red BackColour
-     */
-    DownChangeStyle?: AdaptableStyle;
-    /**
-     * Style for 'Up' value changes
-     * @defaultValue  Green BackColour
-     */
-    UpChangeStyle?: AdaptableStyle;
-    /**
-     * Style for 'Neutral' value changes
-     * @defaultValue  Gray BackColour
-     */
-    NeutralChangeStyle?: AdaptableStyle;
-    /**
-     * Duration of Flash - can be number (in ms) or 'always'
-     * @defaultValue 500ms
-     */
-    FlashDuration?: number | 'always';
-}
-/**
- * The Flashing Alert Definition object used in the Alert function
- */
-export interface FlashingAlertDefinition extends BaseAlertDefinition, FlashingAlertProperties {
-}
-/**
- * The Alert Definition object used in the Alert function
- */
-export interface AlertDefinition extends BaseAlertDefinition {
     /**
      * Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging
      */
@@ -98,6 +54,9 @@ export interface AlertDefinition extends BaseAlertDefinition {
 export declare type AlertButtonForm = Omit<AdaptableForm<AlertButtonContext>, 'title' | 'buttons' | 'fields' | 'description'> & {
     Buttons?: AlertButton<AlertButtonContext>[];
 };
+export interface AlertDefinitionPredicate extends AdaptablePredicate {
+    PredicateId: TypeHint<string, SystemAlertPredicateId>;
+}
 /**
  * The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery
  */
@@ -126,9 +85,6 @@ export interface AlertButton<AlertButtonContext> extends Omit<AdaptableButton<Bu
      */
     Tooltip?: string;
 }
-export interface AlertDefinitionPredicate extends AdaptablePredicate {
-    PredicateId: TypeHint<string, SystemAlertPredicateId>;
-}
 /**
  *
  * Additional properties that specify how a particular Alert will ALWAYS behave
@@ -141,13 +97,17 @@ export interface AlertProperties {
     /**
      * Colours updated cell using `MessageType` property of triggering Alert Definition
      */
-    HighlightCell?: boolean;
+    HighlightCell?: boolean | AdaptableStyle;
+    /**
+     * Colours updated cell using `MessageType` property of triggering Alert Definition
+     */
+    HighlightRow?: boolean | AdaptableStyle;
     /**
      * Grid will 'jump' to the cell which triggered the Alert
      */
     JumpToCell?: boolean;
     /**
-     * Shows Alert text in the div specificed in `AlertDisplayDiv` property of Alert State.
+     * Shows Alert text in the div specificed in `alertContainer` property of Container Options
      */
     ShowInDiv?: boolean;
     /**
@@ -160,5 +120,4 @@ export interface AlertProperties {
      */
     PreventEdit?: boolean;
 }
-declare type SystemAlertPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'PercentChange' | 'PrimaryKeyDuplicate' | 'ExistingValuesOnly' | 'NoDuplicateValues' | 'IsNumeric' | 'Any';
-export {};
+export declare type SystemAlertPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'PercentChange' | 'PrimaryKeyDuplicate' | 'ExistingValuesOnly' | 'NoDuplicateValues' | 'IsNumeric' | 'Any';

package/src/PredefinedConfig/Common/AdaptableColumn.d.ts

@@ -101,6 +101,10 @@ export interface AdaptableColumn extends AdaptableColumnBase {
      * Is Column pinned or locked into position
      */
     isFixed: boolean;
+    /**
+     * The pinned position of the column
+     */
+    pinned: 'left' | 'right' | false;
     /**
      * Is it a Sparkline Column
      */

package/src/PredefinedConfig/Common/AdaptableComparerFunction.d.ts

@@ -14,9 +14,9 @@ valueB: any,
 /**
  * First Row Node to compare
  */
-nodeA: RowNode, 
+nodeA?: RowNode, 
 /**
  * Second Row Node to compare
  */
-nodeB: RowNode) => number;
+nodeB?: RowNode) => number;
 export declare type AdaptableNodeComparerFunction = (nodeA: RowNode, nodeB: RowNode) => number;

package/src/PredefinedConfig/Common/{AdaptableFlashingAlert.d.ts → AdaptableFlashingCell.d.ts}

@@ -1,16 +1,16 @@
 import { AdaptableObject } from './AdaptableObject';
 import { DataChangedInfo } from '../../types';
-import { FlashingAlertDefinition } from '../AlertState';
+import { FlashingCellDefinition } from '../../../types';
 /**
  * Defines an Alert fired by AdapTable
  */
-export interface AdaptableFlashingAlert extends AdaptableObject {
+export interface AdaptableFlashingCell extends AdaptableObject {
     /**
-     * Rule that caused the FlashingAlert to fire
+     * Rule that caused the FlashingCell to fire
      */
-    flashingAlertDefinition: FlashingAlertDefinition;
+    flashingCellDefinition: FlashingCellDefinition;
     /**
-     *  Data change which triggered the FlashingAlert
+     *  Data change which triggered the FlashingCell
      */
     dataChangedInfo?: DataChangedInfo;
     /**
@@ -20,7 +20,7 @@ export interface AdaptableFlashingAlert extends AdaptableObject {
     /**
      * What will flash (e.g. Cell, Row)
      */
-    flashTarget: FlashingAlertDefinition['FlashTarget'];
+    flashTarget: FlashingCellDefinition['FlashTarget'];
     /**
      * Column Ids that are flashing
      */

package/src/PredefinedConfig/Common/AdaptableFlashingCell.js

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

package/src/PredefinedConfig/Common/CellHighlightInfo.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableMessageType } from './AdaptableMessageType';
+import { AdaptableStyle } from '../../../types';
 /**
  * Defines how a given Cell in AdapTable should be highlighted
  */
@@ -15,8 +15,19 @@ export interface CellHighlightInfo {
      * Time after which Cell should be unhilighted
      */
     timeout?: number;
+    highlightStyle: AdaptableStyle;
+}
+export interface RowHighlightInfo {
+    /**
+     * Primary key value for the row to be highlighted
+     */
+    primaryKeyValue: any;
+    /**
+     * Timeout after which the highlight is removed
+     */
+    timeout?: number;
     /**
-     * Whether cell should show 'Info' (default), 'Success', 'Warning' or'Error' colour
+     * Highlight style
      */
-    highlightType?: AdaptableMessageType;
+    highlightStyle: AdaptableStyle;
 }

package/src/PredefinedConfig/Common/CellSummary.d.ts

@@ -16,11 +16,11 @@ export interface CellSummmary {
 }
 export interface CellSummaryOperation {
     /**
-     * Name of the Operation - will be displayed in the Cell Summary dropdowns.
+     * Name of the Operation - will be displayed in the Cell Summary components
      */
     operationName: string;
     /**
-     * Function to run when summary result is required
+     * Function to run when a summary result is required
      */
     operationFunction: (operationParam: CellSummaryOperationParams) => any;
 }

package/src/PredefinedConfig/Common/Menu.d.ts

@@ -13,7 +13,7 @@ export interface MenuContext {
     adaptableApi: AdaptableApi;
 }
 /**
- * Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu
+ * Menu item used by Adaptable in both Column and Context Menus
  */
 export interface AdaptableMenuItem {
     /**
@@ -75,7 +75,7 @@ export interface UserMenuItem<CONTEXT_TYPE extends MenuContext> {
     subMenuItems?: UserMenuItem<CONTEXT_TYPE>[];
 }
 /**
- * Provides full details about current Column where Column Header Menu will appear
+ * Provides full details about the Column where Column Menu will appear
  */
 export interface ColumnMenuContext extends MenuContext {
     /**

package/src/PredefinedConfig/Common/Schedule.d.ts

@@ -17,9 +17,9 @@ export interface Schedule extends AdaptableObject {
      */
     OneOffDate?: string;
     /**
-     * Days on which Shedule will run
+     * Days on which Schedule will run
      */
-    DaysOfWeek?: DayOfWeek[];
+    DaysOfWeek?: Weekdays;
 }
 /**
  * Base Schedule object - typically overriden by Functions
@@ -34,15 +34,5 @@ export interface BaseSchedule extends SuspendableObject {
      */
     ScheduleType: 'Report' | 'ipushpull' | 'Glue42' | 'Reminder' | 'OpenFin';
 }
-/**
- * Enum listing Days of the Week by 0-based index
- */
-export declare enum DayOfWeek {
-    Sunday = 0,
-    Monday = 1,
-    Tuesday = 2,
-    Wednesday = 3,
-    Thursday = 4,
-    Friday = 5,
-    Saturday = 6
-}
+export declare type Weekdays = Weekday[];
+export declare type Weekday = 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';

package/src/PredefinedConfig/Common/Schedule.js

@@ -1,16 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DayOfWeek = void 0;
-/**
- * Enum listing Days of the Week by 0-based index
- */
-var DayOfWeek;
-(function (DayOfWeek) {
-    DayOfWeek[DayOfWeek["Sunday"] = 0] = "Sunday";
-    DayOfWeek[DayOfWeek["Monday"] = 1] = "Monday";
-    DayOfWeek[DayOfWeek["Tuesday"] = 2] = "Tuesday";
-    DayOfWeek[DayOfWeek["Wednesday"] = 3] = "Wednesday";
-    DayOfWeek[DayOfWeek["Thursday"] = 4] = "Thursday";
-    DayOfWeek[DayOfWeek["Friday"] = 5] = "Friday";
-    DayOfWeek[DayOfWeek["Saturday"] = 6] = "Saturday";
-})(DayOfWeek = exports.DayOfWeek || (exports.DayOfWeek = {}));

package/src/PredefinedConfig/Common/Types.d.ts

@@ -19,10 +19,11 @@ export declare type AdaptableModuleButtons = AdaptableModuleButton[];
 /**
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
-export declare type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+export declare type AdaptableModuleButton = 'Alert' | 'FlashingCell' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme';
 export declare type AdaptableStateKeys = AdaptableStateKey[];
-export declare type AdaptableStateKey = 'Alert' | 'Application' | 'CalculatedColumn' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SparklineColumn' | 'Theme' | 'ToolPanel';
-export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableStateKey = 'Alert' | 'FlashingCell' | 'Application' | 'CalculatedColumn' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SparklineColumn' | 'Theme' | 'ToolPanel';
+export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/CustomSortState.d.ts

@@ -19,7 +19,7 @@ export interface CustomSort extends SuspendableObject {
      */
     ColumnId: string;
     /**
-     * Order of values by which Column will be sorted; any Column values NOT in this list will be sorted alphabetically AFTER all list values have been sorted
+     * Order of values by which Column will be sorted
      *
      */
     SortedValues?: string[];

package/src/PredefinedConfig/DashboardState.d.ts

@@ -6,7 +6,8 @@ import { AdaptableObject } from './Common/AdaptableObject';
  */
 export interface DashboardState extends ConfigState {
     /**
-     * Named group of Toolbars - each Toolbar should only be in one Tab; if no Tabs are provided, AdapTable creates one named 'Toolbars'
+     * Named group of Toolbars
+     * @defaultValue Empty Array
      */
     Tabs?: DashboardTab[];
     /**
@@ -39,7 +40,7 @@ export interface DashboardState extends ConfigState {
     FloatingPosition?: AdaptableCoordinate;
     /**
      * Module Buttons visible in Dasbhoard Header when application loads - open popup screen for associated AdapTable Module
-     * @defaultValue ['SystemStatus', 'GridInfo', 'Layout' 'ConditionalStyle']
+     * @defaultValue Empty Array
      */
     ModuleButtons?: AdaptableModuleButtons;
     /**

package/src/PredefinedConfig/FlashingCellState.d.ts

@@ -0,0 +1,70 @@
+import { ConfigState } from './ConfigState';
+import { AdaptableStyle } from './Common/AdaptableStyle';
+import { AdaptablePredicate, AdaptableScope } from '../types';
+import { XOR } from '../Utilities/Extensions/TypeExtensions';
+import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
+import { SystemAlertPredicateId } from './AlertState';
+import { TypeHint } from './Common/Types';
+import { SuspendableObject } from '../../types';
+export interface FlashingCellDefinitionPredicate extends AdaptablePredicate {
+    PredicateId: TypeHint<string, SystemAlertPredicateId>;
+}
+/**
+ * The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery
+ */
+export declare type FlashingCellRule = XOR<{
+    Predicate: FlashingCellDefinitionPredicate;
+}, AdaptableBooleanQuery>;
+/**
+ * Predefined Configuration for Flashing Cell module
+ */
+export interface FlashingCellState extends ConfigState {
+    /**
+     * Flashing Alert Definitions - will colour cells/rows when rule is met
+     * @defaultValue  null
+     */
+    FlashingCellDefinitions?: FlashingCellDefinition[];
+}
+/**
+ * Properties to use in Flashing Alerts
+ */
+export interface FlashingCellProperties {
+    /**
+     * Should a cell or whole row flash
+     * @defaultValue  'cell'
+     */
+    FlashTarget?: 'row' | 'cell';
+    /**
+     * Style for 'Down' value changes
+     *  @defaultValue  Red BackColour
+     */
+    DownChangeStyle?: AdaptableStyle;
+    /**
+     * Style for 'Up' value changes
+     * @defaultValue  Green BackColour
+     */
+    UpChangeStyle?: AdaptableStyle;
+    /**
+     * Style for 'Neutral' value changes
+     * @defaultValue  Gray BackColour
+     */
+    NeutralChangeStyle?: AdaptableStyle;
+    /**
+     * Duration of Flash - can be number (in ms) or 'always'
+     * @defaultValue 500ms
+     */
+    FlashDuration?: number | 'always';
+}
+/**
+ * The Flashing Cell Definition
+ */
+export interface FlashingCellDefinition extends FlashingCellProperties, SuspendableObject {
+    /**
+     * Where Alert can be triggered: one, some or all columns or DataTypes
+     */
+    Scope: AdaptableScope;
+    /**
+     * When Alert should be triggered
+     */
+    Rule: FlashingCellRule;
+}

package/src/PredefinedConfig/FlashingCellState.js

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

package/src/PredefinedConfig/FreeTextColumnState.d.ts

@@ -31,12 +31,12 @@ export interface FreeTextColumn extends AdaptableObject {
      */
     FreeTextStoredValues?: FreeTextStoredValue[];
     /**
-     * Cell editor to use when editing a Free Text Column with DataType of 'String'
+     * Cell editor to use when editing a string Free Text Column
      * * @defaultValue 'Inline'
      */
     TextEditor?: 'Inline' | 'Large';
     /**
-     * Whether Column is String, Number, Boolean or Date; the appropriate Cell Editor will be used
+     * Whether Column is String, Number, Boolean or Date
      * @defaultValue 'String'
      */
     DataType?: 'String' | 'Number' | 'Boolean' | 'Date';

package/src/PredefinedConfig/LayoutState.d.ts

@@ -43,7 +43,7 @@ export interface Layout extends AdaptableObject {
      */
     RowGroupedColumns?: string[];
     /**
-     * Values of opened row groups - only used if `includeExpandedRowGroups` in LayoutOptions is true
+     * Values of opened row groups
      */
     ExpandedRowGroupValues?: any[];
     /**

package/src/PredefinedConfig/PredefinedConfig.d.ts

@@ -7,6 +7,7 @@ import { CustomSortState } from './CustomSortState';
 import { DashboardState } from './DashboardState';
 import { DataSourceState } from './DataSourceState';
 import { ExportState } from './ExportState';
+import { FlashingCellState } from './FlashingCellState';
 import { FormatColumnState } from './FormatColumnState';
 import { FreeTextColumnState } from './FreeTextColumnState';
 import { LayoutState } from './LayoutState';
@@ -107,4 +108,5 @@ export interface PredefinedConfig {
      * Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
      */
     ToolPanel?: ToolPanelState;
+    FlashingCell?: FlashingCellState;
 }

package/src/PredefinedConfig/ScheduleState.d.ts

@@ -4,7 +4,6 @@ import { IPushPullSchedule } from './IPushPullState';
 import { OpenFinSchedule } from './OpenFinState';
 import { AdaptableMessageType, ReportSchedule } from '../types';
 import { BaseSchedule } from './Common/Schedule';
-import { AdaptableObject } from './Common/AdaptableObject';
 /**
  * Predefined Configuration for the Schedule Module
  *
@@ -32,12 +31,9 @@ export interface ScheduleState extends ConfigState {
     OpenFinSchedules?: OpenFinSchedule[];
 }
 /**
- * Schedules a Reminder (a.k.a. an Alert)
+ * Schedules a Reminder to appear at a given point in time
  */
 export interface ReminderSchedule extends BaseSchedule {
-    Reminder: Reminder;
-}
-export interface Reminder extends AdaptableObject {
     /**
      * Reminder header text
      */

package/src/PredefinedConfig/ShortcutState.d.ts

@@ -19,7 +19,7 @@ export declare type ShortcutScopeDataType = 'Number';
  */
 export interface Shortcut extends SuspendableObject {
     /**
-     * On which numeric Columns the Rule is applied
+     * Numeric Columns where Shortcut is applied
      */
     Scope: AdaptableScope<ShortcutScopeDataType>;
     /**

package/src/PredefinedConfig/SystemState.d.ts

@@ -8,10 +8,10 @@ import type { IPushPullState, IPushPullReport, IPushPullDomain } from './IPushPu
 import { Glue42State, Glue42Report } from './Glue42State';
 import { OpenFinState, OpenFinReport } from './OpenFinState';
 import { AdaptableAlert } from './Common/AdaptableAlert';
-import { CellHighlightInfo } from './Common/CellHighlightInfo';
+import { CellHighlightInfo, RowHighlightInfo } from './Common/CellHighlightInfo';
 import { SystemStatusMessageInfo } from './Common/SystemStatusMessageInfo';
 import { CachedQuery } from './QueryState';
-import { AdaptableFlashingAlert } from './Common/AdaptableFlashingAlert';
+import { AdaptableFlashingCell } from './Common/AdaptableFlashingCell';
 import { TypeUuid } from './Uuid';
 import { SummaryOperation } from './Common/Enums';
 import { ExportCustomDestinationPopup } from './ExportState';
@@ -29,10 +29,11 @@ export interface SystemState extends InternalState, IPushPullState, Glue42State,
     Export: {
         CustomDestinationPopups: ExportCustomDestinationPopup[];
     };
-    AdaptableFlashingAlerts: Record<ROW_PRIMARY_KEY, Record<COLUMN_ID_OR_WHOLE_ROW_LABEL, TypeUuid>>;
-    AdaptableFlashingAlertsMap: Record<TypeUuid, AdaptableFlashingAlert>;
+    AdaptableFlashingCells: Record<ROW_PRIMARY_KEY, Record<COLUMN_ID_OR_WHOLE_ROW_LABEL, TypeUuid>>;
+    AdaptableFlashingCellsMap: Record<TypeUuid, AdaptableFlashingCell>;
     SystemStatusMessages: SystemStatusMessageInfo[];
     HighlightedCells: CellHighlightInfo[];
+    HighlightedRows: RowHighlightInfo[];
     IsValidSmartEditSelection: boolean;
     SmartEditPreviewInfo: PreviewInfo;
     BulkUpdateValidationResult: BulkUpdateValidationResult;
@@ -61,6 +62,18 @@ export interface SystemState extends InternalState, IPushPullState, Glue42State,
         enableTime: Date;
         suspendTime: Date;
     };
+    SettingsPanel: {
+        [key: string]: {
+            position: {
+                x: number;
+                y: number;
+            };
+            size: {
+                width: number;
+                height: number;
+            };
+        };
+    };
 }
 export interface ProgressIndicator {
     active: boolean;