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

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().gridOptions;
         if (gridOptions) {
             gridOptions.api.openToolPanel('adaptable');
         }
     }
     closeAdapTableToolPanel() {
-        let gridOptions = this.getOptions().vendorGrid;
+        let gridOptions = this.getOptions().gridOptions;
         if (gridOptions) {
             gridOptions.api.closeToolPanel();
         }

package/src/Api/InternalApi.d.ts

@@ -1,7 +1,5 @@
 import { UIConfirmation } from '../Utilities/Interface/MessagePopups';
 import { SystemState } from '../PredefinedConfig/SystemState';
-import { ChartData } from '../PredefinedConfig/ChartState';
-import { ChartVisibility } from '../PredefinedConfig/Common/ChartEnums';
 import { Action } from 'redux';
 import { ModuleParams } from '../View/Components/SharedProps/ModuleViewPopupProps';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
@@ -22,7 +20,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';
@@ -46,11 +44,9 @@ export interface InternalApi {
             buttonStyle?: ButtonStyle;
         })[];
     };
-    setChartData(chartData: ChartData): void;
-    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;
@@ -80,7 +76,6 @@ export interface InternalApi {
     getQueryPreviewData(): any;
     buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
     setLastAppliedShortCut(gridCell: GridCell | undefined): void;
-    setDefaultDashboardTab(): void;
     updateCurrentDraftLayout(layout: Layout): void;
     getPrimaryKey(): any;
     getAdaptableInstance(): IAdaptable;
@@ -112,8 +107,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/PluginsApi.d.ts

@@ -2,7 +2,6 @@ import { PluginsState } from '../Redux/ActionsReducers/PluginsRedux';
 import { IPushPullApi } from './IPushPullApi';
 import { Glue42Api } from './Glue42Api';
 import { OpenFinApi } from './OpenFinApi';
-import { ChartApi } from './ChartApi';
 import { FinanceApi } from './FinanceApi';
 /**
  * API methods dealing with AdapTable plugins
@@ -15,6 +14,5 @@ export interface PluginsApi {
     getipushpullPluginApi(): IPushPullApi;
     getGlue42PluginApi(): Glue42Api;
     getOpenFinPluginApi(): OpenFinApi;
-    getChartsPluginApi(): ChartApi;
     getFinancePluginApi(): FinanceApi;
 }

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

@@ -3,7 +3,6 @@ import { GridState } from './GridState';
 import { SystemState } from './SystemState';
 import { AlertState } from './AlertState';
 import { CalculatedColumnState } from './CalculatedColumnState';
-import { ChartState } from './ChartState';
 import { ConditionalStyleState } from './ConditionalStyleState';
 import { CustomSortState } from './CustomSortState';
 import { DashboardState } from './DashboardState';
@@ -20,10 +19,10 @@ import { TeamSharingState } from './TeamSharingState';
 import { ThemeState } from './ThemeState';
 import { ConfigState } from './ConfigState';
 import { FilterState } from './FilterState';
-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
  */
@@ -36,10 +35,9 @@ export interface AdaptableState {
         [key: string]: any;
     };
     Application: ApplicationState;
-    SparklineColumn: SparklineColumnState;
     Alert: AlertState;
+    FlashingCell: FlashingCellState;
     CalculatedColumn: CalculatedColumnState;
-    Chart: ChartState;
     ConditionalStyle: ConditionalStyleState;
     CustomSort: CustomSortState;
     Dashboard: DashboardState;

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

@@ -32,7 +32,7 @@ export interface AdaptablePredicateDef {
      */
     columnScope: AdaptableScope;
     /**
-     * Modules where Predicate can run: 'filter', 'alert', 'conditionalstyle'
+     * Modules where the Predicate can run
      */
     moduleScope: ModuleScope[];
     /**
@@ -86,7 +86,7 @@ export interface PredicateDefHandlerParams {
      */
     displayValue: any;
     /**
-     * Row node which contains the cell
+     * AG Grid Row node which contains the cell
      */
     node: RowNode;
     /**
@@ -94,7 +94,7 @@ export interface PredicateDefHandlerParams {
      */
     inputs: any[];
     /**
-     * Column which contains the cell
+     * Adaptable Column which contains the cell
      */
     column: AdaptableColumn;
     /**
@@ -105,7 +105,7 @@ export interface PredicateDefHandlerParams {
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
-export declare type ModuleScope = 'filter' | 'alert' | 'conditionalstyle';
+export declare type ModuleScope = 'filter' | 'alert' | 'conditionalstyle' | 'flashingcell';
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */