@adaptabletools/adaptable 11.0.0-canary.3 → 11.0.0-canary.7

package/src/metamodel/adaptable.metamodel.js

@@ -152,6 +152,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableAlertQuery": {
+        "name": "AdaptableAlertQuery",
+        "kind": "TypeAlias",
+        "description": "Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"
+    },
     "AdaptableApi": {
         "name": "AdaptableApi",
         "kind": "Interface",
@@ -296,13 +301,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Grid Api",
                 "reference": "GridApi"
             },
-            {
-                "name": "internalApi",
-                "kind": "REFERENCE",
-                "description": "Api methods used *internally* within AdapTable.",
-                "uiLabel": "Internal Api",
-                "reference": "unknown"
-            },
             {
                 "name": "layoutApi",
                 "kind": "REFERENCE",
@@ -366,6 +364,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Scope Api",
                 "reference": "ScopeApi"
             },
+            {
+                "name": "settingsPanelApi",
+                "kind": "REFERENCE",
+                "description": "Provides access to the Settings Panel",
+                "uiLabel": "Settings Panel Api",
+                "reference": "SettingsPanelApi"
+            },
             {
                 "name": "shortcutApi",
                 "kind": "REFERENCE",
@@ -474,6 +479,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableCalculatedColumnQuery": {
+        "name": "AdaptableCalculatedColumnQuery",
+        "kind": "TypeAlias",
+        "description": "Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"
+    },
     "AdaptableColumn": {
         "name": "AdaptableColumn",
         "kind": "Interface",
@@ -922,6 +932,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "'adaptable_id'"
             },
+            {
+                "name": "adaptableQLOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing AdapTableQL",
+                "uiLabel": "Adaptable QL Options",
+                "isOptional": true,
+                "reference": "unknown"
+            },
             {
                 "name": "adaptableStateKey",
                 "kind": "string",
@@ -931,6 +949,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "`adaptableId` value"
             },
+            {
+                "name": "alertOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing Alerts in AdapTable",
+                "uiLabel": "Alert Options",
+                "isOptional": true,
+                "gridInfo": "container",
+                "reference": "AlertOptions"
+            },
             {
                 "name": "autogeneratePrimaryKey",
                 "kind": "boolean",
@@ -1030,7 +1057,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "gridOptions",
                 "kind": "REFERENCE",
-                "description": "The AG Grid object which AdapTable interacts with. Note: if using React or Angular Wrapper, no need to populate this property as AdapTable wires it up differently",
+                "description": "The AG Grid object which AdapTable interacts with. Note: if using AdapTable React or AdapTable Angular, no need to populate this property as AdapTable wires it up differently",
                 "uiLabel": "Grid Options",
                 "isOptional": true,
                 "defaultValue": "n/a (Mandatory)",
@@ -1061,6 +1088,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "container",
                 "reference": "MenuOptions"
             },
+            {
+                "name": "modules",
+                "kind": "unknown",
+                "description": "AG Grid Modules that should be provided - needs to be provided separately",
+                "uiLabel": "Modules",
+                "isOptional": true
+            },
             {
                 "name": "notificationsOptions",
                 "kind": "REFERENCE",
@@ -1093,15 +1127,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "n/a (Mandatory)"
             },
-            {
-                "name": "queryLanguageOptions",
-                "kind": "REFERENCE",
-                "description": "Options for managing queries in AdapTableQL",
-                "uiLabel": "Query Language Options",
-                "isOptional": true,
-                "gridInfo": "container",
-                "reference": "QueryLanguageOptions"
-            },
             {
                 "name": "searchOptions",
                 "kind": "REFERENCE",
@@ -1782,7 +1807,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "When Alert should be triggered",
                 "uiLabel": "Rule",
-                "reference": "unknown"
+                "reference": "AlertRule"
             },
             {
                 "name": "Scope",
@@ -1812,6 +1837,61 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Form to show in an Alert"
     },
+    "AlertOptions": {
+        "name": "AlertOptions",
+        "kind": "Interface",
+        "description": "Options related to Alerts in Adaptable.",
+        "properties": [
+            {
+                "name": "actionHandlers",
+                "kind": "unknown",
+                "description": "onClick Handlers for Alert Buttons (defined in Alert State)",
+                "uiLabel": "Action Handlers",
+                "isOptional": true
+            },
+            {
+                "name": "alertForms",
+                "kind": "unknown",
+                "description": "Full definitions of Alert Forms - the names of which are provided in Alert State",
+                "uiLabel": "Alert Forms",
+                "isOptional": true
+            },
+            {
+                "name": "alertMessageText",
+                "kind": "unknown",
+                "description": "Function providing Message to display in Alert; if empty, AdapTable provides dynamically",
+                "uiLabel": "Alert Message Text",
+                "isOptional": true
+            },
+            {
+                "name": "cellHighlightDuration",
+                "kind": "number",
+                "description": "How long (in ms) a cell will be highlighted",
+                "uiLabel": "Cell Highlight Duration",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "3000"
+            },
+            {
+                "name": "dataChangeDetectionPolicy",
+                "kind": "unknown",
+                "description": "Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",
+                "uiLabel": "Data Change Detection Policy",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "'rawValue'"
+            },
+            {
+                "name": "maxAlertsInStore",
+                "kind": "number",
+                "description": "How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",
+                "uiLabel": "Max Alerts In Store",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "20"
+            }
+        ]
+    },
     "AlertProperties": {
         "name": "AlertProperties",
         "kind": "Interface",
@@ -1855,9 +1935,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "PreventEdit",
                 "kind": "boolean",
-                "description": "Automatically prevent any cell edit which triggered the Alert (i.e. validation)   false",
+                "description": "Automatically prevent any cell edit which triggered the Alert (i.e. validation)",
                 "uiLabel": "Prevent Edit",
-                "isOptional": true
+                "isOptional": true,
+                "defaultValue": "false"
             },
             {
                 "name": "ShowInDiv",
@@ -1868,6 +1949,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AlertRule": {
+        "name": "AlertRule",
+        "kind": "TypeAlias",
+        "description": "The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"
+    },
     "AlertState": {
         "name": "AlertState",
         "kind": "Interface",
@@ -1878,8 +1964,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Alert Definitions - will trigger Alerts when rule is met",
                 "uiLabel": "Alert Definitions",
-                "isOptional": true,
-                "defaultValue": "null"
+                "isOptional": true
             }
         ]
     },
@@ -2085,10 +2170,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Query",
                 "kind": "REFERENCE",
-                "description": "Scalar Expression used by AdapTableQL to evaluate Column's value",
+                "description": "Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",
                 "uiLabel": "Query",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "AdaptableCalculatedColumnQuery"
             }
         ]
     },
@@ -2115,12 +2200,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Edits given Calculated Column",
                 "uiLabel": "Edit Calculated Column"
             },
-            {
-                "name": "editCalculatedColumnExpression",
-                "kind": "function",
-                "description": "Replaces Expression in given Calculated Column with new value",
-                "uiLabel": "Edit Calculated Column Expression"
-            },
             {
                 "name": "editCalculatedColumns",
                 "kind": "function",
@@ -2136,7 +2215,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCalculatedColumnById",
                 "kind": "function",
-                "description": "Retrieves Calculated column by id",
+                "description": "Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState",
                 "uiLabel": "Get Calculated Column By Id"
             },
             {
@@ -2215,8 +2294,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Collection of Calculated Columns",
                 "uiLabel": "Calculated Columns",
-                "isOptional": true,
-                "defaultValue": "empty"
+                "isOptional": true
             }
         ]
     },
@@ -2245,6 +2323,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Id of Column containing Cell",
                 "uiLabel": "Column Id"
             },
+            {
+                "name": "highlightStyle",
+                "kind": "REFERENCE",
+                "description": "Adaptable Style to use in the Cell Highlight",
+                "uiLabel": "Highlight Style",
+                "reference": "AdaptableStyle"
+            },
             {
                 "name": "primaryKeyValue",
                 "kind": "unknown",
@@ -2586,12 +2671,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all Groupable Columns",
                 "uiLabel": "Get Groupable Columns"
             },
-            {
-                "name": "getNumericArrayColumns",
-                "kind": "function",
-                "description": "Returns all numeric array Columns",
-                "uiLabel": "Get Numeric Array Columns"
-            },
             {
                 "name": "getNumericColumns",
                 "kind": "function",
@@ -3240,7 +3319,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "agGridContainerWaitTimeout",
                 "kind": "number",
-                "description": "how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by React or Angular Wrappers)",
+                "description": "how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by AdapTable React or AdapTable Angular)",
                 "uiLabel": "Ag Grid Container Wait Timeout",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -3257,7 +3336,7 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "modalContainer",
-                "kind": "string",
+                "kind": "unknown",
                 "description": "Name of div where modals appear (if null, will be centre of page)",
                 "uiLabel": "Modal Container",
                 "isOptional": true,
@@ -3520,8 +3599,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Collection of Custom Sort objects.",
                 "uiLabel": "Custom Sorts",
-                "isOptional": true,
-                "defaultValue": "[]"
+                "isOptional": true
             }
         ]
     },
@@ -5043,17 +5121,104 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "The javascript function which is invoked by an AdapTableQL Function"
     },
+    "ExpressionOptions": {
+        "name": "ExpressionOptions",
+        "kind": "Interface",
+        "description": "Options for managing Expressions using AdapTableQL",
+        "properties": [
+            {
+                "name": "defaultAggregatedBooleanFunctions",
+                "kind": "REFERENCE",
+                "description": "Aggregated Boolean Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Aggregated Boolean Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultAggregatedScalarFunctions",
+                "kind": "REFERENCE",
+                "description": "Aggregated Scalar Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Aggregated Scalar Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultBooleanFunctions",
+                "kind": "REFERENCE",
+                "description": "Boolean Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Boolean Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultObservableFunctions",
+                "kind": "REFERENCE",
+                "description": "Observable Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Observable Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultScalarFunctions",
+                "kind": "REFERENCE",
+                "description": "Scalar Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Scalar Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "maxTimeframeSize",
+                "kind": "number",
+                "description": "Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",
+                "uiLabel": "Max Timeframe Size",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "28800000 (~8 hours)"
+            },
+            {
+                "name": "moduleExpressionFunctions",
+                "kind": "unknown",
+                "description": "Module specific ExpressionFunctions; if not defined, it falls back to the defined default values",
+                "uiLabel": "Module Expression Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined (defaults to default values)"
+            },
+            {
+                "name": "performExpressionValidation",
+                "kind": "boolean",
+                "description": "Validate Expressions before they can be run or saved",
+                "uiLabel": "Perform Expression Validation",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "true"
+            },
+            {
+                "name": "queryableColumns",
+                "kind": "unknown",
+                "description": "Columns that can be included in AdapTableQL Expressions; leave unset to include **ALL**, provide empty array to set **NONE**",
+                "uiLabel": "Queryable Columns",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined"
+            }
+        ]
+    },
     "FDC3Context": {
         "name": "FDC3Context",
         "kind": "Interface",
         "description": "General-purpose context type, as defined by [FDC3](https://fdc3.finos.org/docs/1.0/context-intro). A context object is a well-understood datum that is streamable between FDC3 participants. As a result it has a field describing what type it is, and data indicating its identity. Use this as a base to derive your own with any custom properties or metadata.",
         "properties": [
-            {
-                "name": "(indexer)",
-                "kind": "indexType",
-                "description": "Custom properties and metadata. This can be extended in specific context object.",
-                "uiLabel": "(indexer)"
-            },
             {
                 "name": "id",
                 "kind": "unknown",
@@ -5410,7 +5575,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "useAgGridFilterFormStyle",
                 "kind": "boolean",
-                "description": "Styles Adaptable Filter Form to match AG Grid's current styling",
+                "description": "Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)",
                 "uiLabel": "Use Ag Grid Filter Form Style",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5426,9 +5591,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "suppressFilterSearchBar",
                 "kind": "boolean",
-                "description": "Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed   false",
+                "description": "Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed",
                 "uiLabel": "Suppress Filter Search Bar",
-                "isOptional": true
+                "isOptional": true,
+                "defaultValue": "false"
             }
         ]
     },
@@ -5723,8 +5889,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Flashing Cell Definitions - will colour cells/rows when rule is met",
                 "uiLabel": "Flashing Cell Definitions",
-                "isOptional": true,
-                "defaultValue": "null"
+                "isOptional": true
             }
         ]
     },
@@ -6011,7 +6176,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "unknown",
                 "description": "Whether Column is String, Number, Boolean or Date",
                 "uiLabel": "Data Type",
-                "isOptional": true,
                 "defaultValue": "'String'"
             },
             {
@@ -6082,12 +6246,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Checks if a User Edit was in a Free Text Column",
                 "uiLabel": "Check Free Text Column For Data Change"
             },
-            {
-                "name": "createFreeTextColumn",
-                "kind": "function",
-                "description": "Creates new FreeTextColumn and adds it to Adaptable State",
-                "uiLabel": "Create Free Text Column"
-            },
             {
                 "name": "deleteFreeTextColumn",
                 "kind": "function",
@@ -6198,15 +6356,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "true"
             },
-            {
-                "name": "caseSensitiveTextComparisons",
-                "kind": "boolean",
-                "description": "Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",
-                "uiLabel": "Case Sensitive Text Comparisons",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "false"
-            },
             {
                 "name": "cellSummaryOperations",
                 "kind": "unknown",
@@ -6906,9 +7055,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "selectCellRange",
                 "kind": "function",
-                "description": "Selects a group of cells in a given range",
+                "description": "Selects a group of cells in a given range - provide either primary keys or row indexes",
                 "uiLabel": "Select Cell Range"
             },
+            {
+                "name": "selectColumn",
+                "kind": "function",
+                "description": "Selects a Column in AG Grid",
+                "uiLabel": "Select Column"
+            },
+            {
+                "name": "selectColumns",
+                "kind": "function",
+                "description": "Selects Columns in AG Grid",
+                "uiLabel": "Select Columns"
+            },
             {
                 "name": "selectNode",
                 "kind": "function",
@@ -7067,9 +7228,15 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "dataRows",
                 "kind": "unknown",
-                "description": "Rows that have been added, updated, or deleted",
+                "description": "Data rows that have been added, updated, or deleted",
                 "uiLabel": "Data Rows"
             },
+            {
+                "name": "rowNodes",
+                "kind": "unknown",
+                "description": "AG Grid Row Nodes that were affected by the Change",
+                "uiLabel": "Row Nodes"
+            },
             {
                 "name": "rowTrigger",
                 "kind": "unknown",
@@ -7196,19 +7363,19 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "id",
                 "kind": "unknown",
-                "description": "The instrument data. Can contain some or all of: * `ticker`: a ticker * `ISIN`: [ISIN](https://www.isin.org/isin/) * `CUSIP`: [CUSIP](https://www.cusip.com/cusip/index.htm) * `SEDOL`: [SEDOL](https://www.londonstockexchange.com/products-and-services/reference-data/sedol-master-file/sedol-master-file.htm) * `RIC`: [Reuters Instrument Code (RIC)](https://en.wikipedia.org/wiki/Reuters_Instrument_Code) * `BBG`: [Bloomberg Ticker](https://www.bloomberg.com/professional/product/market-data/) * `PERMID`: [PERMID](https://permid.org/) * `FIGI`: [FIGI](https://www.openfigi.com/about/figi)",
+                "description": "The instrument data",
                 "uiLabel": "Id"
             },
             {
                 "name": "name",
                 "kind": "string",
-                "description": "Free text name of the instrument.",
+                "description": "Free text name of instrument",
                 "uiLabel": "Name"
             },
             {
                 "name": "type",
                 "kind": "unknown",
-                "description": "The context type is always 'instrument'.",
+                "description": "Context type is always 'instrument'",
                 "uiLabel": "Type"
             }
         ]
@@ -7749,6 +7916,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether this Layout should be auto saved (based on Layout State and Layout Options)",
                 "uiLabel": "Should Auto Save Layout"
             },
+            {
+                "name": "showChangeColumnCaption",
+                "kind": "function",
+                "description": "Opens change column caption popup",
+                "uiLabel": "Show Change Column Caption"
+            },
             {
                 "name": "showLayoutPopup",
                 "kind": "function",
@@ -7846,16 +8019,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "string",
                 "description": "Layout which will be loaded when AdapTable starts - must match `Name` property in Layout",
                 "uiLabel": "Current Layout",
-                "isOptional": true,
-                "defaultValue": "''"
+                "isOptional": true
             },
             {
                 "name": "Layouts",
                 "kind": "unknown",
                 "description": "Collection of Layout objects - listed in Layout toolbar and Tool Panel",
                 "uiLabel": "Layouts",
-                "isOptional": true,
-                "defaultValue": "null"
+                "isOptional": true
             }
         ]
     },
@@ -7998,38 +8169,8 @@ exports.ADAPTABLE_METAMODEL = {
     "NotificationsOptions": {
         "name": "NotificationsOptions",
         "kind": "Interface",
-        "description": "Options related to Alerts, System Status Messages and Notifications in Adaptable.",
+        "description": "Options related to System Status Messages and Notifications in Adaptable.",
         "properties": [
-            {
-                "name": "actionHandlers",
-                "kind": "unknown",
-                "description": "onClick Handlers for Alert Buttons (defined in Alert State)",
-                "uiLabel": "Action Handlers",
-                "isOptional": true
-            },
-            {
-                "name": "alertForms",
-                "kind": "unknown",
-                "description": "Full definitions of Alert Forms - the names of which are provided in Alert State",
-                "uiLabel": "Alert Forms",
-                "isOptional": true
-            },
-            {
-                "name": "alertMessageText",
-                "kind": "unknown",
-                "description": "Function providing Message to display in Alert; if empty, AdapTable provides dynamically",
-                "uiLabel": "Alert Message Text",
-                "isOptional": true
-            },
-            {
-                "name": "cellHighlightDuration",
-                "kind": "number",
-                "description": "How long (in ms) a cell will be highlighted",
-                "uiLabel": "Cell Highlight Duration",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "3000"
-            },
             {
                 "name": "closeWhenClicked",
                 "kind": "boolean",
@@ -8039,15 +8180,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
-            {
-                "name": "dataChangeDetectionPolicy",
-                "kind": "unknown",
-                "description": "Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",
-                "uiLabel": "Data Change Detection Policy",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "'rawValue'"
-            },
             {
                 "name": "duration",
                 "kind": "unknown",
@@ -8066,15 +8198,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
-            {
-                "name": "maxAlertsInStore",
-                "kind": "number",
-                "description": "How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",
-                "uiLabel": "Max Alerts In Store",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "20"
-            },
             {
                 "name": "maxNotifications",
                 "kind": "number",
@@ -8230,6 +8353,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Clears any objects in internal OpenFin state created by AdapTable",
                 "uiLabel": "Clear Open Fin Internal State"
             },
+            {
+                "name": "getAlertOptions",
+                "kind": "function",
+                "description": "Gets the Alert section from Adaptable Options",
+                "uiLabel": "Get Alert Options"
+            },
             {
                 "name": "getCurrentLiveOpenFinReport",
                 "kind": "function",
@@ -8426,7 +8555,57 @@ exports.ADAPTABLE_METAMODEL = {
     "PluginsApi": {
         "name": "PluginsApi",
         "kind": "Interface",
-        "description": "API methods dealing with AdapTable plugins"
+        "description": "API methods dealing with AdapTable plugins",
+        "properties": [
+            {
+                "name": "getFinancePluginApi",
+                "kind": "function",
+                "description": "Returns Finance API class in Adaptable API",
+                "uiLabel": "Get Finance Plugin Api"
+            },
+            {
+                "name": "getGlue42PluginApi",
+                "kind": "function",
+                "description": "Returns Glue42 API class in Adaptable API",
+                "uiLabel": "Get Glue42Plugin Api"
+            },
+            {
+                "name": "getipushpullPluginApi",
+                "kind": "function",
+                "description": "Returns ipushpull API class in Adaptable API",
+                "uiLabel": "Getipushpull Plugin Api"
+            },
+            {
+                "name": "getOpenFinPluginApi",
+                "kind": "function",
+                "description": "Returns OpenFin API class in Adaptable API",
+                "uiLabel": "Get Open Fin Plugin Api"
+            },
+            {
+                "name": "getPluginsState",
+                "kind": "function",
+                "description": "Retrieves the Plugin State (internal only)",
+                "uiLabel": "Get Plugins State"
+            },
+            {
+                "name": "getPluginState",
+                "kind": "function",
+                "description": "Gets the State for a given Plugin",
+                "uiLabel": "Get Plugin State"
+            },
+            {
+                "name": "registerPlugin",
+                "kind": "function",
+                "description": "Registers a Plugin (internal method)",
+                "uiLabel": "Register Plugin"
+            },
+            {
+                "name": "setPluginState",
+                "kind": "function",
+                "description": "Sets the initial state for a given plugin (internal method)",
+                "uiLabel": "Set Plugin State"
+            }
+        ]
     },
     "PlusMinusApi": {
         "name": "PlusMinusApi",
@@ -8557,7 +8736,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Alert",
                 "kind": "REFERENCE",
-                "description": "Supplies a collection of *Alert Definition* objects which will fire when their definition is triggered, and where Alerts are displayed",
+                "description": "Collection of `AlertDefinitions` which will fire Alerts when the rule is met",
                 "uiLabel": "Alert",
                 "isOptional": true,
                 "reference": "AlertState"
@@ -8626,6 +8805,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "FilterState"
             },
+            {
+                "name": "FlashingCell",
+                "kind": "REFERENCE",
+                "description": "* Objects which define which cells flash in response to data changes",
+                "uiLabel": "Flashing Cell",
+                "isOptional": true,
+                "reference": "FlashingCellState"
+            },
             {
                 "name": "FormatColumn",
                 "kind": "REFERENCE",
@@ -8847,7 +9034,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCurrentQuery",
                 "kind": "function",
-                "description": "Retuns the Current Query",
+                "description": "Returns the Current Query",
                 "uiLabel": "Get Current Query"
             },
             {
@@ -8905,6 +9092,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Manages AdapTableQL (Query Language)",
         "properties": [
+            {
+                "name": "getAdaptableQueryExpression",
+                "kind": "function",
+                "description": "Returns the Expression string of the given AdaptableQuery, which may be either a Boolean, an AggregatedBoolean, a Scalar, an AggregatedScalar or an ObservableExpression expression",
+                "uiLabel": "Get Adaptable Query Expression"
+            },
             {
                 "name": "getASTForExpression",
                 "kind": "function",
@@ -8914,7 +9107,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getColumnsFromExpression",
                 "kind": "function",
-                "description": "Returns all Columns referenced in a Query",
+                "description": "Returns all Columns referenced in a QueryExpression",
                 "uiLabel": "Get Columns From Expression"
             },
             {
@@ -8930,10 +9123,16 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Get Queryable Column Ids"
             },
             {
-                "name": "isValidAggregationExpression",
+                "name": "isValidAggregatedBooleanExpression",
+                "kind": "function",
+                "description": "Whether the given AggregatedBooleanExpression is valid",
+                "uiLabel": "Is Valid Aggregated Boolean Expression"
+            },
+            {
+                "name": "isValidAggregatedScalarExpression",
                 "kind": "function",
-                "description": "Whether the given AggregationExpression is valid",
-                "uiLabel": "Is Valid Aggregation Expression"
+                "description": "Whether the given AggregatedScalarExpression is valid",
+                "uiLabel": "Is Valid Aggregated Scalar Expression"
             },
             {
                 "name": "isValidBooleanExpression",
@@ -8949,89 +9148,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "QueryLanguageOptions": {
-        "name": "QueryLanguageOptions",
-        "kind": "Interface",
-        "description": "Options for managing Expressions using AdapTableQL",
-        "properties": [
-            {
-                "name": "defaultAggregationFunctions",
-                "kind": "REFERENCE",
-                "description": "Aggregation Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Aggregation Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultBooleanFunctions",
-                "kind": "REFERENCE",
-                "description": "Boolean Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Boolean Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultObservableFunctions",
-                "kind": "REFERENCE",
-                "description": "Observable Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Observable Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultScalarFunctions",
-                "kind": "REFERENCE",
-                "description": "Scalar Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Scalar Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "maxTimeframeSize",
-                "kind": "number",
-                "description": "Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",
-                "uiLabel": "Max Timeframe Size",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "28800000 (~8 hours)"
-            },
-            {
-                "name": "moduleExpressionFunctions",
-                "kind": "unknown",
-                "description": "Module specific ExpressionFunctions; if not defined, it falls back to the defined default values",
-                "uiLabel": "Module Expression Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined (defaults to default values)"
-            },
-            {
-                "name": "performExpressionValidation",
-                "kind": "boolean",
-                "description": "Validate Expressions before they can be run or saved",
-                "uiLabel": "Perform Expression Validation",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "true"
-            },
-            {
-                "name": "queryableColumns",
-                "kind": "unknown",
-                "description": "Columns that can be included in AdapTableQL Expressions; leave unset to include **ALL**, provide empty array to set **NONE**",
-                "uiLabel": "Queryable Columns",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined"
-            }
-        ]
-    },
     "QueryState": {
         "name": "QueryState",
         "kind": "Interface",
@@ -9802,16 +9918,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "'Search'"
-            },
-            {
-                "name": "serverSearchOptions",
-                "kind": "REFERENCE",
-                "description": "Which searching and filtering options, if any, should take place on server",
-                "uiLabel": "Server Search Options",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined",
-                "reference": "unknown"
             }
         ]
     },
@@ -9868,6 +9974,25 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "SettingsPanelApi": {
+        "name": "SettingsPanelApi",
+        "kind": "Interface",
+        "description": "Provides run-time access to the Settings Panel",
+        "properties": [
+            {
+                "name": "showCustomSettingsPanel",
+                "kind": "function",
+                "description": "Opens Settings Panel with the Custom Settings Panel, provided by name, displayed",
+                "uiLabel": "Show Custom Settings Panel"
+            },
+            {
+                "name": "showSettingsPanel",
+                "kind": "function",
+                "description": "Opens Settings Panel and displays specified Module (if provided) or first available one",
+                "uiLabel": "Show Settings Panel"
+            }
+        ]
+    },
     "SharedEntity": {
         "name": "SharedEntity",
         "kind": "Interface",
@@ -10107,7 +10232,7 @@ exports.ADAPTABLE_METAMODEL = {
     "SpecialColumnSettings": {
         "name": "SpecialColumnSettings",
         "kind": "Interface",
-        "description": "Base Settings for SpecialColumns",
+        "description": "Base Settings for Calculated Columns and FreeText Columns",
         "properties": [
             {
                 "name": "Aggregatable",
@@ -10192,19 +10317,19 @@ exports.ADAPTABLE_METAMODEL = {
     "StateOptions": {
         "name": "StateOptions",
         "kind": "Interface",
-        "description": "Options related to state hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality.",
+        "description": "Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality",
         "properties": [
             {
                 "name": "applyState",
                 "kind": "unknown",
-                "description": "Allows hooking into AdaptableState hydration",
+                "description": "Allows hooking into Adaptable State hydration",
                 "uiLabel": "Apply State",
                 "isOptional": true
             },
             {
                 "name": "clearState",
                 "kind": "REFERENCE",
-                "description": "Allows clearing of remote state.",
+                "description": "Allows clearing of remote Adaptable State",
                 "uiLabel": "Clear State",
                 "isOptional": true,
                 "reference": "unknown"
@@ -10212,7 +10337,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "debounceStateDelay",
                 "kind": "number",
-                "description": "Delay (in ms) to debounce saveState/persistState calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",
+                "description": "Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",
                 "uiLabel": "Debounce State Delay",
                 "isOptional": true,
                 "defaultValue": "400"
@@ -10220,7 +10345,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "loadState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of state loading.",
+                "description": "Allows the customization of Adaptable State loading",
                 "uiLabel": "Load State",
                 "isOptional": true,
                 "reference": "AdaptableLoadStateFunction"
@@ -10228,7 +10353,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "persistState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of state persistence.",
+                "description": "Allows the customization of state persistence",
                 "uiLabel": "Persist State",
                 "isOptional": true,
                 "reference": "AdaptablePersistStateFunction"
@@ -10236,7 +10361,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "saveState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of the state that is going to be persisted",
+                "description": "Allows the customization of the Adaptable State that is going to be persisted",
                 "uiLabel": "Save State",
                 "isOptional": true,
                 "reference": "unknown"
@@ -10321,7 +10446,7 @@ exports.ADAPTABLE_METAMODEL = {
     "SystemStatusMessageDisplayedInfo": {
         "name": "SystemStatusMessageDisplayedInfo",
         "kind": "Interface",
-        "description": "Object returned by the SystemStatusMessageDisplayed' event",
+        "description": "Object returned by the `SystemStatusMessageDisplayed` event",
         "properties": [
             {
                 "name": "systemStatusMessageInfo",
@@ -10445,14 +10570,14 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getSharedEntities",
                 "kind": "unknown",
-                "description": "Function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State",
+                "description": "Async function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State",
                 "uiLabel": "Get Shared Entities",
                 "defaultValue": "null"
             },
             {
                 "name": "setSharedEntities",
                 "kind": "unknown",
-                "description": "Function which uploads Shared Entities so they can be downloaded by other members of the team",
+                "description": "Async function which uploads Shared Entities so they can be downloaded by other members of the team",
                 "uiLabel": "Set Shared Entities",
                 "defaultValue": "null"
             },
@@ -10844,6 +10969,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves `permittedValues` property from User Interface Options",
                 "uiLabel": "Get All Permitted Values Items"
             },
+            {
+                "name": "getBulkUpdatePermittedValuesForColumn",
+                "kind": "function",
+                "description": "Retrieves Permitted values for Bulk Update Module",
+                "uiLabel": "Get Bulk Update Permitted Values For Column"
+            },
             {
                 "name": "getColorPalette",
                 "kind": "function",
@@ -10853,7 +10984,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCustomSortPermittedValuesForColumn",
                 "kind": "function",
-                "description": "Retrieves Permitted values for Custom sort.",
+                "description": "Retrieves Permitted values for Custom Sort Module",
                 "uiLabel": "Get Custom Sort Permitted Values For Column"
             },
             {
@@ -10877,7 +11008,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getFilterPermittedValuesForColumn",
                 "kind": "function",
-                "description": "Retrieves Permitted values for filtering by column values in Floating Filter and dropdown Filter.",
+                "description": "Retrieves Permitted values for filtering by column values in Floating Filter and Quick Filter Bar",
                 "uiLabel": "Get Filter Permitted Values For Column"
             },
             {
@@ -10985,7 +11116,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Which sections to show in the Grid Info Screen",
                 "uiLabel": "Grid Info Sections",
                 "isOptional": true,
-                "defaultValue": "['GridSummary', 'AdaptableOptions','ColumnInfo']",
+                "defaultValue": "['GridSummary', 'AdaptableOptions', 'ColumnInfo']",
                 "reference": "unknown"
             },
             {