@adaptabletools/adaptable 14.0.0 → 14.0.1-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "14.0.0",
+  "version": "14.0.1-canary.1",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1671833413485;
+declare const _default: 1672761030413;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1671833413485;
+exports.default = 1672761030413;

package/src/AdaptableOptions/ActionOptions.d.ts

@@ -1,7 +1,5 @@
 import { RowNode } from '@ag-grid-community/core';
 import { ActionRowSubmittedInfo, ActionRowType, AdaptableButton, AdaptableColumn, AdaptableObject, BaseContext, FormContext } from '../types';
-interface ActionRowButtonsContext extends BaseContext {
-}
 /**
  * Options related to Action Columns and Buttons in Adaptable.
  */
@@ -212,4 +210,8 @@ export interface ActionRowButtonConfigurationContext extends BaseContext {
      */
     actionRowButtonType: ActionRowButtonType;
 }
-export {};
+/**
+ * Context passed to Action Row Buttons
+ */
+export interface ActionRowButtonsContext extends BaseContext {
+}

package/src/AdaptableOptions/AdaptableFrameworkComponent.d.ts

@@ -1,18 +1,20 @@
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { ReactElement } from 'react';
+import { BaseContext } from '../types';
+/**
+ * Base Component for Bespoke Components - Can be Angular or React
+ */
 export declare type AdaptableFrameworkComponent = AngularFrameworkComponent | ReactFrameworkComponent;
 /**
- * An Angular component defined by its type and an optional initialisation callback.
+ * Angular component defined by its type and (optional) initialisation callback
  */
 export declare type AngularFrameworkComponent<T = unknown> = {
     /**
-     * The angular component class (instance of https://angular.io/api/core/Type).
-     * It will be automatically instantiated at runtime and the `adaptableApi` is provided through an Injection token
+     * Angular component class (instance of https://angular.io/api/core/Type); will be automatically instantiated at runtime - `adaptableApi` is provided via Injection token
      */
     type: T;
     /**
-     * Optional initialisation callback.
-     * If provided, it will be invoked after each component instantiation and the returned object properties will be assigned to the component instance
+     * Optional initialisation callback; will be invoked after each component instantiation and returned object properties assigned to component instance
      */
     onSetup?: ({ adaptableApi }: {
         adaptableApi: AdaptableApi;
@@ -32,8 +34,13 @@ export declare type ReactFrameworkComponent = ({ adaptableApi, }: {
 /**
  * Context provided for any custom rendering
  */
-export interface CustomRenderContext {
+export interface CustomRenderContext extends BaseContext {
+    /**
+     * Whether Tool Panel is currently visible
+     */
     visible: boolean;
+    /**
+     * Current Div Element
+     */
     element: HTMLDivElement;
-    adaptableApi: AdaptableApi;
 }

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -84,16 +84,19 @@ export interface AdaptableOptions {
     actionOptions?: ActionOptions;
     /**
      * Options for managing AdapTableQL
+     * @noCodeContainer
      */
     adaptableQLOptions?: AdaptableQLOptions;
     /**
      * Options for managing Alerts in AdapTable
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     alertOptions?: AlertOptions;
     /**
      * Options for managing AG Grid's Charting
+     * @noCodeContainer
      */
     chartingOptions?: ChartingOptions;
     /**
@@ -101,19 +104,22 @@ export interface AdaptableOptions {
      */
     containerOptions?: ContainerOptions;
     /**
-     * Options for managing Columns
+     * Options related to Columns
+     * @noCodeContainer
      */
     columnOptions?: ColumnOptions;
     /**
-     * Options related to managing the Dashboard in AdapTable
+     * Options for managing the Dashboard in AdapTable
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     dashboardOptions?: DashboardOptions;
     /**
      * Options to manage Data Change History Module which provides an overview of all data changes
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     dataChangeHistoryOptions?: DataChangeHistoryOptions;
     /**
@@ -138,6 +144,8 @@ export interface AdaptableOptions {
      * Options for managing Filtering in AdapTable
      *
      * @gridInfoContainer
+     * @noCodeContainer
+     *
      */
     filterOptions?: FilterOptions;
     /**
@@ -150,12 +158,14 @@ export interface AdaptableOptions {
      * General options to manage AdapTable e.g. grouping behaviour, Primary Keys
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     generalOptions?: GeneralOptions;
     /**
      * Options related to Layouts
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     layoutOptions?: LayoutOptions;
     /**
@@ -168,18 +178,21 @@ export interface AdaptableOptions {
      * Options for managing Notifications in AdapTable
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     notificationsOptions?: NotificationsOptions;
     /**
      * Options for managing Search related functions in AdapTable
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     searchOptions?: SearchOptions;
     /**
      * Setting panel options
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     settingsPanelOptions?: SettingsPanelOptions;
     /**
@@ -196,6 +209,7 @@ export interface AdaptableOptions {
      * Options related to managing the Tool Panel elements in AdapTable
      *
      * @gridInfoContainer
+     * @noCodeContainer
      */
     toolPanelOptions?: ToolPanelOptions;
     /**

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -5,7 +5,7 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ExpressionOptions } from './ExpressionOptions';
 import { PredicateOptions } from './PredicateOptions';
 /**
- * Options for managing AdaptableQL - the Adaptable Query Language which evaluates Predicates and Expressions
+ * Options for managing AdapTableQL - the Adaptable Query Language which evaluates Predicates and Expressions
  */
 export interface AdaptableQLOptions {
     /**
@@ -21,13 +21,11 @@ export interface AdaptableQLOptions {
      */
     evaluateAdaptableQLExternally?: (context: EvaluateExpressionExternallyContext) => boolean;
     /**
-     * Options for managing Expressions in AdaptableQL
-     *
+     * Options for managing Expressions in AdapTableQL
      */
     expressionOptions?: ExpressionOptions;
     /**
-     * Options for managing Predicates in AdaptableQL
-     *
+     * Options for managing Predicates in AdapTableQL
      */
     predicateOptions?: PredicateOptions;
     /**
@@ -38,6 +36,7 @@ export interface AdaptableQLOptions {
      * Reference a Column's Header (FriendlyName) in all Expression overviews (instead of ColumnId)
      *
      * @defaultValue true
+     * @noCodeItem
      */
     displayColumnFriendlyNamesForExpressions?: boolean;
 }

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -12,6 +12,7 @@ export interface AlertOptions {
      *
      * @defaultValue  20
      * @gridInfoItem
+     * @noCodeItem
      */
     maxAlertsInStore?: number;
     /**

package/src/AdaptableOptions/ChartingOptions.d.ts

@@ -5,6 +5,7 @@ export interface ChartingOptions {
     /**
      * Behaviour for saving Charts: automatic, manual (via popup) or none
      * @defaultValue 'none'
+     * @noCodeItem
      */
     saveStrategy?: 'auto' | 'manual' | 'none';
     /**

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -18,6 +18,7 @@ export interface ColumnOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     showMissingColumnsWarning?: boolean;
     /**
@@ -26,6 +27,7 @@ export interface ColumnOptions {
      * The default group order will be derived from (in the specified priority): 1. an active CustomSort,  2. the defined ColDef Comparator, 3. current Layout ColumnSort or 4. alphanumerically
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     autoOrderGroupedColumns?: boolean;
     /**
@@ -33,6 +35,7 @@ export interface ColumnOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
      */
     hideColumnWhenGrouped?: boolean;
 }

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -12,6 +12,7 @@ export interface DashboardOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     canFloat?: boolean;
     /**
@@ -19,6 +20,7 @@ export interface DashboardOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     showQuickSearchInHeader?: boolean;
     /**
@@ -32,6 +34,7 @@ export interface DashboardOptions {
     /**
      * Where in Dashboard to display Module and Custom Buttons
      * @defaultValue 'right'
+     * @noCodeItem
      */
     buttonsLocation?: 'left' | 'right';
 }

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -36,6 +36,7 @@ export interface DataChangeHistoryOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
      */
     activeByDefault?: boolean;
     /**

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -6,53 +6,53 @@ import { AggregatedBooleanFunctionName } from '../Utilities/ExpressionFunctions/
 import { AggregatedScalarFunctionName } from '../Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions';
 import { AdaptableModule, BaseContext, AdaptableColumnBase } from '../types';
 /**
- * Options for managing Expressions using AdaptableQL
+ * Options for managing Expressions using AdapTableQL
  */
 export interface ExpressionOptions {
     /**
-     * System (built-in) Boolean Expression Functions available in AdaptableQL
+     * System (built-in) Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
     /**
-     * Custom (user defined) Boolean Expression Functions available in AdaptableQL
+     * Custom (user defined) Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
      * @gridInfoItem
      */
     customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
     /**
-     * System (built-in) Scalar Expression Functions available in AdaptableQL
+     * System (built-in) Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
     /**
-     * Custom (user defined) Scalar Expression Functions available in AdaptableQL
+     * Custom (user defined) Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
      * @gridInfoItem
      */
     customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
     /**
-     * System (built-in) Observable Expression Functions available in AdaptableQL
+     * System (built-in) Observable Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
     /**
-     * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
+     * System (built-in) AggregatedBoolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
     /**
-     * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
+     * System (built-in) AggregatedScalar Expression Functions available in AdapTableQL
      *
      * @defaultValue undefined (sets all)
      * @gridInfoItem
@@ -97,49 +97,49 @@ export declare type ModuleExpressionFunctionsMap = Partial<Record<AdaptableModul
  */
 export interface ModuleExpressionFunctions {
     /**
-     * System (built-in) Boolean Expression Functions available in AdaptableQL
+     * System (built-in) Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
     /**
-     * Custom (user defined) Boolean Expression Functions available in AdaptableQL
+     * Custom (user defined) Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
      * @gridInfoItem
      */
     customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
     /**
-     * System (built-in) Scalar Expression Functions available in AdaptableQL
+     * System (built-in) Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
     /**
-     * Custom (user defined) Scalar Expression Functions available in AdaptableQL
+     * Custom (user defined) Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
      * @gridInfoItem
      */
     customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
     /**
-     * System (built-in) Observable Expression Functions available in AdaptableQL
+     * System (built-in) Observable Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
     /**
-     * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
+     * System (built-in) AggregatedBoolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
      */
     systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
     /**
-     * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
+     * System (built-in) AggregatedScalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
+import { SystemFilterPredicateId } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
 /**
  * Options for managing Filtering in AdapTable
@@ -62,6 +62,7 @@ export interface FilterOptions {
      *
      * @defaultValue 'mouseenter'
      * @gridInfoItem
+     * @noCodeItem
      */
     quickFilterTrigger?: 'mouseenter' | 'click';
     /**
@@ -69,6 +70,7 @@ export interface FilterOptions {
      *
      * @defaultValue 'mouseenter'
      * @gridInfoItem
+     * @noCodeItem
      */
     quickFilterValuesTrigger?: 'mouseenter' | 'click';
     /**
@@ -147,14 +149,10 @@ export interface FilterOptions {
      * @gridInfoItem
      */
     enableFilterOnSpecialColumns?: boolean;
-    /**
-     * Set which System Filter Predicates are available
-     * @deprecated use systemFilterPredicates in PredicateOptions
-     */
-    systemFilters?: SystemFilterPredicateIds;
     /**
      * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
      * @defaultValue  true
+     * @noCodeItem
      */
     showQuickFilter?: boolean;
     /**
@@ -162,18 +160,21 @@ export interface FilterOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
      */
     showDistinctFilteredValuesOnly?: boolean;
     /**
-     * Display Clear Filter button in Toolbar and Toolpanel
+     * Display Clear Filter button in Toolbar and Tool Panel
      * @defaultValue  false
      * @gridInfoItem
+     * @noCodeItem
      */
     showClearFilterButton?: boolean;
     /**
-     * Display Suspend / Unsuspend Button in Toolbar and Toolpanel
+     * Display Suspend / Unsuspend Button in Toolbar and Tool Panel
      * @defaultValue  false
      * @gridInfoItem
+     * @noCodeItem
      */
     showSuspendFilterButton?: boolean;
 }

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -41,10 +41,6 @@ export interface FinancePluginOptions {
      * Intents to which to subscribe.
      */
     availableFDC3Intents?: (FDC3Intent | CustomFDC3Intent)[];
-    /**
-     * @deprecated - use Weighted Average Layout Aggregation
-     */
-    weightedAverageColumns?: WeightedAverageColumn[];
     /**
      * Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )
      *
@@ -60,13 +56,6 @@ export interface FinancePluginOptions {
      */
     onFDC3Context?: (context: FDC3Context, adaptableApi: AdaptableApi) => void;
 }
-/**
- * @deprecated - use Weighted Average Layout Aggregation
- */
-export interface WeightedAverageColumn {
-    columnId: string;
-    weightedColumnId: string;
-}
 /**
  * An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
  */

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -17,13 +17,6 @@ export interface GeneralOptions {
      * @uiLabel Show Missing Primary Key Warning
      */
     showMissingPrimaryKeyAlert?: boolean;
-    /**
-     * Hides any grouped rows if there are no columns visible
-     *
-     * @defaultValue false
-     * @deprecated starting with Adaptable v10
-     */
-    hideEmptyGroupRows?: boolean;
     /**
      * Show aggregated totals row at top of Grid when row grouping
      *
@@ -68,12 +61,13 @@ export interface GeneralOptions {
     /**
      * Places ungrouped columns at pre-grouping indexed position
      * @defaultValue false
+     * @noCodeItem
      */
     restoreUngroupedColumns?: boolean;
     /**
-     * By default, a confirmation dialog is displayed whenever an AdaptableObject is deleted. This option allows to suppress the confirmation dialog.
-     *
+     * Hides confirmation dialog which displays whenever an AdaptableObject is deleted
      * @defaultValue false
+     * @noCodeItem
      */
     disableDeleteConfirmation?: boolean;
 }

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -15,13 +15,6 @@ import { BaseContext } from '../../types';
  *
  */
 export interface LayoutOptions {
-    /**
-     * Layouts will include details of expanded grouped rows; if true these will be re-applied at start-up
-     * @deprecated use displayRowGroups instead
-     * @defaultValue false
-     * @gridInfoItem
-     */
-    includeExpandedRowGroups?: boolean;
     /**
      * Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)
      * @defaultValue 'closed'
@@ -41,6 +34,7 @@ export interface LayoutOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
      */
     autoSizeColumnsInLayout?: boolean;
     /**
@@ -48,6 +42,7 @@ export interface LayoutOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
      */
     autoSizeColumnsInPivotLayout?: boolean;
     /**

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -32,7 +32,7 @@ export interface MenuOptions {
      */
     columnMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
     /**
-     * Order in which AG grid, AdapTable and User Menu items will appear in Context Menu
+     * Order in which AG Grid, AdapTable and User Menu items will appear in Context Menu
      *
      * @defaultValue 'aggrid', 'adaptable', 'user'
      * @gridInfoItem

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -7,6 +7,7 @@ export interface NotificationsOptions {
      *
      * @defaultValue  3
      * @gridInfoItem
+     * noCodeItem
      */
     maxNotifications?: number;
     /**

package/src/AdaptableOptions/SearchOptions.d.ts

@@ -28,6 +28,7 @@ export interface SearchOptions {
      *
      * @defaultValue false
      * @gridInfoItem
+     * @noCodeItem
      */
     filterResultsAfterQuickSearch?: boolean;
 }

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -18,12 +18,14 @@ export interface SettingsPanelOptions {
      * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard
      * @defaultValue false
      * @gridInfoItem
+     *  @noCodeItem
      */
     alwaysShowInDashboard?: boolean;
     /**
      * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
      * @defaultValue false
      * @gridInfoItem
+     *  @noCodeItem
      */
     alwaysShowInToolPanel?: boolean;
     /**

package/src/AdaptableOptions/StateOptions.d.ts

@@ -50,10 +50,6 @@ export interface AdaptableStateFunctionConfig {
      * current Adaptable user
      */
     userName: string;
-    /**
-     * @deprecated unused will be removed in v.13
-     */
-    url?: string;
 }
 /**
  * Allows customization of state persistence - used `persistState` function in StateOptions

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -12,6 +12,7 @@ export interface ToolPanelOptions {
      *
      * @defaultValue true
      * @gridInfoItem
+     * @noCodeItem
      */
     showToolPanelsDropdown?: boolean;
     /**
@@ -40,7 +41,7 @@ export interface CustomToolPanel extends AdaptableObject {
      */
     buttons?: AdaptableButton<CustomToolPanelButtonContext>[];
     /**
-     * Function to provide bespoke content when NOT using a Framework wrapper
+     * Function to provide bespoke content when using AdapTable Vanilla
      */
     render?: (customRenderContext: CustomRenderContext) => string | null;
     /**

package/src/Api/AlertApi.d.ts

@@ -74,10 +74,10 @@ export interface AlertApi {
      */
     unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
-     * Evaluate all existing alerts which match the given criteria
-     * @param alertLookupCriteria AdaptableObjectLookupCriteria
+     * Evaluates the given Alert Definitions - will fire Alert if rule is met
+     * @param alertDefinitions Alert Definitions to evaluate
      */
-    evaluateAlerts(alertDefinitions: AlertDefinition[]): void;
+    evaluateAlertDefinitions(alertDefinitions: AlertDefinition[]): void;
     /**
      * Find all Alert Definitions which match the given criteria
      * @param alertLookupCriteria lookup criteria