@adaptabletools/adaptable 11.1.8 → 11.1.9

package/src/metamodel/adaptable.metamodel.js

@@ -395,6 +395,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Smart Edit Api",
                 "reference": "SmartEditApi"
             },
+            {
+                "name": "statusBarApi",
+                "kind": "REFERENCE",
+                "description": "Provides run-time access to the AdapTable Status Bar",
+                "uiLabel": "Status Bar Api",
+                "reference": "unknown"
+            },
             {
                 "name": "systemStatusApi",
                 "kind": "REFERENCE",
@@ -696,6 +703,39 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableDashboardToolbar": {
+        "name": "AdaptableDashboardToolbar",
+        "kind": "TypeAlias",
+        "description": "List of all the Toolbars that Adaptable provides"
+    },
+    "AdaptableFDC3EventInfo": {
+        "name": "AdaptableFDC3EventInfo",
+        "kind": "Interface",
+        "description": "EventInfo returned by `FDC3MessageSent` event",
+        "properties": [
+            {
+                "name": "context",
+                "kind": "REFERENCE",
+                "description": "Full FDC3 Context for the object related to the event",
+                "uiLabel": "Context",
+                "reference": "FDC3Context"
+            },
+            {
+                "name": "eventType",
+                "kind": "unknown",
+                "description": "Type of Event: `RaiseIntent` or `BroadcastMessage`",
+                "uiLabel": "Event Type"
+            },
+            {
+                "name": "intent",
+                "kind": "REFERENCE",
+                "description": "The FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)",
+                "uiLabel": "Intent",
+                "isOptional": true,
+                "reference": "FDC3Intent"
+            }
+        ]
+    },
     "AdaptableFlashingCell": {
         "name": "AdaptableFlashingCell",
         "kind": "Interface",
@@ -1177,7 +1217,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "stateOptions",
                 "kind": "REFERENCE",
-                "description": "Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behavior of saving to local storage",
+                "description": "Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage",
                 "uiLabel": "State Options",
                 "isOptional": true,
                 "reference": "StateOptions"
@@ -1948,11 +1988,11 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "cellHighlightDuration",
                 "kind": "number",
-                "description": "How long (in ms) a cell will be highlighted",
+                "description": "How long (in ms) a Cell will be highlighted when an Alert fires",
                 "uiLabel": "Cell Highlight Duration",
                 "isOptional": true,
                 "gridInfo": "item",
-                "defaultValue": "3000"
+                "defaultValue": "2000"
             },
             {
                 "name": "dataChangeDetectionPolicy",
@@ -1971,6 +2011,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "20"
+            },
+            {
+                "name": "rowHighlightDuration",
+                "kind": "number",
+                "description": "How long (in ms) a Row will be highlighted when an Alert Fires",
+                "uiLabel": "Row Highlight Duration",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "4000"
             }
         ]
     },
@@ -2557,12 +2606,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves all Cell Summary Definitions from Cell Summary State",
                 "uiLabel": "Get Cell Summary Operation Definitions"
             },
+            {
+                "name": "getCellSummaryOperationValue",
+                "kind": "function",
+                "description": "Retrieves the value of the current selected operation",
+                "uiLabel": "Get Cell Summary Operation Value"
+            },
             {
                 "name": "getCurrentCellSummaryOperation",
                 "kind": "function",
                 "description": "Retrieves currently selected Cell Summary Operation",
                 "uiLabel": "Get Current Cell Summary Operation"
             },
+            {
+                "name": "getCurrentCellSummaryOperationValue",
+                "kind": "function",
+                "description": "Retrieves the value of the current selected operation",
+                "uiLabel": "Get Current Cell Summary Operation Value"
+            },
             {
                 "name": "setCurrentCellSummaryOperation",
                 "kind": "function",
@@ -3026,7 +3087,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Color",
                 "kind": "string",
-                "description": "Colour to use for the Percent bar",
+                "description": "Colour to use for the Comparison",
                 "uiLabel": "Color"
             },
             {
@@ -3568,19 +3629,90 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true
             },
             {
-                "name": "fds_IdColumnId",
+                "name": "fds_idColumnId",
                 "kind": "string",
                 "description": "Column which holds an FDS_ID value a Contact",
-                "uiLabel": "Fds_Id Column Id",
+                "uiLabel": "Fds_id Column Id",
                 "isOptional": true
             },
             {
                 "name": "intents",
                 "kind": "REFERENCE",
-                "description": "FDC3 Intents available to the Column",
+                "description": "FDC3 Intents invoked by Column; can be: `StartCall` `StartChat` `ViewContact`",
                 "uiLabel": "Intents",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "ContactIntents"
+            }
+        ]
+    },
+    "ContactContext": {
+        "name": "ContactContext",
+        "kind": "Interface",
+        "description": "FDC3 Context to define a Contact",
+        "properties": [
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "The Contact data: email, FDS_ID",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of Contact",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always `contact`",
+                "uiLabel": "Type"
+            }
+        ]
+    },
+    "ContactIntent": {
+        "name": "ContactIntent",
+        "kind": "TypeAlias",
+        "description": "FDC3 Intents available to a Contact Column"
+    },
+    "ContactIntents": {
+        "name": "ContactIntents",
+        "kind": "TypeAlias",
+        "description": "All available Contact Intents"
+    },
+    "ContactListContext": {
+        "name": "ContactListContext",
+        "kind": "Interface",
+        "description": "FDC3 Context to define a list of Contacts",
+        "properties": [
+            {
+                "name": "contacts",
+                "kind": "unknown",
+                "description": "The array of Contacts",
+                "uiLabel": "Contacts",
+                "isOptional": true
+            },
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "Optional Id",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of Contact list",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always `contactList`",
+                "uiLabel": "Type"
             }
         ]
     },
@@ -3738,27 +3870,64 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "intents",
                 "kind": "REFERENCE",
-                "description": "FDC3 Intents available to the Column",
+                "description": "FDC3 Intents invoked by Column; can be: `ViewChart`",
                 "uiLabel": "Intents",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "CountryIntents"
             },
             {
-                "name": "isoAlpha2ColumnId",
+                "name": "isoalpha2ColumnId",
                 "kind": "string",
                 "description": "Column which contains the ISOALPHA2 Standard",
-                "uiLabel": "Iso Alpha2Column Id",
+                "uiLabel": "Isoalpha2Column Id",
                 "isOptional": true
             },
             {
-                "name": "isoAlpha3ColumnId",
+                "name": "isoalpha3ColumnId",
                 "kind": "string",
                 "description": "Column which contains the ISOALPHA3 Standard",
-                "uiLabel": "Iso Alpha3Column Id",
+                "uiLabel": "Isoalpha3Column Id",
                 "isOptional": true
             }
         ]
     },
+    "CountryContext": {
+        "name": "CountryContext",
+        "kind": "Interface",
+        "description": "FDC3 Context to define a Country",
+        "properties": [
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "The Country data: ISOALPHA2, ISOALPHA3",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of Country",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always `country`",
+                "uiLabel": "Type"
+            }
+        ]
+    },
+    "CountryIntent": {
+        "name": "CountryIntent",
+        "kind": "TypeAlias",
+        "description": "FDC3 Intents available to a Country Column"
+    },
+    "CountryIntents": {
+        "name": "CountryIntents",
+        "kind": "TypeAlias",
+        "description": "All available Country Intents"
+    },
     "CustomDestination": {
         "name": "CustomDestination",
         "kind": "Interface",
@@ -5522,6 +5691,54 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "FDC3Column": {
+        "name": "FDC3Column",
+        "kind": "Interface",
+        "description": "An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages",
+        "properties": [
+            {
+                "name": "broadcastContextMenuLabel",
+                "kind": "unknown",
+                "description": "Label to display in Broadcast Context Menu Item",
+                "uiLabel": "Broadcast Context Menu Label",
+                "isOptional": true
+            },
+            {
+                "name": "columnId",
+                "kind": "string",
+                "description": "Id of Column defined as FDC3",
+                "uiLabel": "Column Id"
+            },
+            {
+                "name": "intentContextMenuLabel",
+                "kind": "unknown",
+                "description": "Label to display in Intent Context Menu Item",
+                "uiLabel": "Intent Context Menu Label",
+                "isOptional": true
+            },
+            {
+                "name": "intents",
+                "kind": "unknown",
+                "description": "FDC3 intents which the Column can raise",
+                "uiLabel": "Intents",
+                "isOptional": true
+            },
+            {
+                "name": "nameColumnId",
+                "kind": "string",
+                "description": "If provided, will supply `name` property in FDC3 message",
+                "uiLabel": "Name Column Id",
+                "isOptional": true
+            },
+            {
+                "name": "showBroadcastContextMenu",
+                "kind": "boolean",
+                "description": "Should Column display a 'Broadcast' context menu item",
+                "uiLabel": "Show Broadcast Context Menu",
+                "isOptional": true
+            }
+        ]
+    },
     "FDC3Context": {
         "name": "FDC3Context",
         "kind": "Interface",
@@ -5530,25 +5747,31 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "id",
                 "kind": "unknown",
-                "description": "An optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for an instrument.",
+                "description": "Optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for Instrument",
                 "uiLabel": "Id",
                 "isOptional": true
             },
             {
                 "name": "name",
                 "kind": "string",
-                "description": "The name of the context data (optional). This is a text string that describes the data being sent. Implementors of context may choose to make the name mandatory.",
+                "description": "Name of the context data (optional) - a text string that describes the data being sent",
                 "uiLabel": "Name",
                 "isOptional": true
             },
             {
                 "name": "type",
-                "kind": "string",
-                "description": "The type of the context that uniquely identifies it, e.g. "instrument". This is used to refer to the accepted context(s) when declaring intents. See [[AppDirIntent]].",
-                "uiLabel": "Type"
+                "kind": "REFERENCE",
+                "description": "Type of context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents",
+                "uiLabel": "Type",
+                "reference": "unknown"
             }
         ]
     },
+    "FDC3Intent": {
+        "name": "FDC3Intent",
+        "kind": "TypeAlias",
+        "description": "Full list of FDC3 Intents available - each FDC3 Column can use a subset"
+    },
     "FilterActionOnDataChange": {
         "name": "FilterActionOnDataChange",
         "kind": "Interface",
@@ -5958,7 +6181,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "fdc3Columns",
                 "kind": "unknown",
-                "description": "Columns to be defined as FDC3",
+                "description": "Columns to be defined as FDC3-related",
                 "uiLabel": "Fdc3Columns",
                 "isOptional": true
             },
@@ -6696,6 +6919,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Custom Sort Comparers",
                 "isOptional": true
             },
+            {
+                "name": "englishVariant",
+                "kind": "unknown",
+                "description": "English variant to use in UI labels",
+                "uiLabel": "English Variant",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "'GB'"
+            },
             {
                 "name": "hideColumnWhenGrouped",
                 "kind": "boolean",
@@ -7690,10 +7922,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "intents",
                 "kind": "REFERENCE",
-                "description": "FDC3 Intents available to the Column",
+                "description": "FDC3 Intents invoked by Column; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`",
                 "uiLabel": "Intents",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "InstrumentIntents"
             },
             {
                 "name": "isinColumnId",
@@ -7735,26 +7967,70 @@ exports.ADAPTABLE_METAMODEL = {
     "InstrumentContext": {
         "name": "InstrumentContext",
         "kind": "Interface",
-        "description": "Built-in context to define a financial Instrument",
+        "description": "FDC3 Context to define a financial Instrument",
         "properties": [
             {
                 "name": "id",
                 "kind": "unknown",
-                "description": "The instrument data",
+                "description": "Instrument data: ticker, ISIN, CUSIP, SEDOL, RIC, BBG, PERMID, FIGI",
                 "uiLabel": "Id",
                 "isOptional": true
             },
             {
                 "name": "name",
                 "kind": "string",
-                "description": "Free text name of instrument",
+                "description": "Free text name of the Instrument",
                 "uiLabel": "Name",
                 "isOptional": true
             },
             {
                 "name": "type",
                 "kind": "unknown",
-                "description": "Context type is always 'instrument'",
+                "description": "Context type is always `instrument`",
+                "uiLabel": "Type"
+            }
+        ]
+    },
+    "InstrumentIntent": {
+        "name": "InstrumentIntent",
+        "kind": "TypeAlias",
+        "description": "FDC3 Intents available to an Instrument Column"
+    },
+    "InstrumentIntents": {
+        "name": "InstrumentIntents",
+        "kind": "TypeAlias",
+        "description": "All available Instrument Intents"
+    },
+    "InstrumentListContext": {
+        "name": "InstrumentListContext",
+        "kind": "Interface",
+        "description": "FDC3 Context to define an array of financial Instruments",
+        "properties": [
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "Optional Id",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "instruments",
+                "kind": "unknown",
+                "description": "The instrument data",
+                "uiLabel": "Instruments",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of list of Instruments (not set by AdapTable)",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always `instrumentList`",
                 "uiLabel": "Type"
             }
         ]
@@ -8985,16 +9261,16 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "A (String) Column which will be defined as an FDC3 Organization",
         "properties": [
             {
-                "name": "fds_IdColumnId",
+                "name": "fds_idColumnId",
                 "kind": "string",
                 "description": "Column which contains an FDS_ID",
-                "uiLabel": "Fds_Id Column Id",
+                "uiLabel": "Fds_id Column Id",
                 "isOptional": true
             },
             {
                 "name": "intents",
                 "kind": "REFERENCE",
-                "description": "FDC3 Intents available to the Column",
+                "description": "FDC3 Intents invoked by Column; can be: `ViewNews` `ViewAnalysis`",
                 "uiLabel": "Intents",
                 "isOptional": true,
                 "reference": "unknown"
@@ -9007,14 +9283,46 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true
             },
             {
-                "name": "permIdColumnId",
+                "name": "permidColumnId",
                 "kind": "string",
                 "description": "Column which contains a PermId",
-                "uiLabel": "Perm Id Column Id",
+                "uiLabel": "Permid Column Id",
                 "isOptional": true
             }
         ]
     },
+    "OrganizationContext": {
+        "name": "OrganizationContext",
+        "kind": "Interface",
+        "description": "FDC3 Context to define an Organization",
+        "properties": [
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "The Organization data: LEI, PERMID, FDS_ID",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of Organization",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always `organization`",
+                "uiLabel": "Type"
+            }
+        ]
+    },
+    "OrganizationIntent": {
+        "name": "OrganizationIntent",
+        "kind": "TypeAlias",
+        "description": "FDC3 Intents available to an Organization Column"
+    },
     "PercentBarStyle": {
         "name": "PercentBarStyle",
         "kind": "Interface",
@@ -9251,6 +9559,40 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "PortfolioContext": {
+        "name": "PortfolioContext",
+        "kind": "Interface",
+        "description": "FDC3 Context to define a financial Portfolio (array of Positions)",
+        "properties": [
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "Optional Id",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of portfolio",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "positions",
+                "kind": "unknown",
+                "description": "The position data",
+                "uiLabel": "Positions",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always `portfolio`",
+                "uiLabel": "Type"
+            }
+        ]
+    },
     "PositionColumn": {
         "name": "PositionColumn",
         "kind": "Interface",
@@ -9265,22 +9607,22 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "intents",
                 "kind": "REFERENCE",
-                "description": "FDC3 Intents available to the Column",
+                "description": "FDC3 Intents invoked by Column; can be: `ViewChart` `ViewNews` `ViewAnalysis`",
                 "uiLabel": "Intents",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "PositionIntents"
             }
         ]
     },
     "PositionContext": {
         "name": "PositionContext",
         "kind": "Interface",
-        "description": "Built-in context to define a financial position",
+        "description": "FDC3 Context to define a financial Position (requires an Instrument)",
         "properties": [
             {
                 "name": "holding",
                 "kind": "number",
-                "description": "Holding in the Position",
+                "description": "Holding in the Position (mandatory)",
                 "uiLabel": "Holding"
             },
             {
@@ -9290,6 +9632,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Id",
                 "isOptional": true
             },
+            {
+                "name": "instrument",
+                "kind": "REFERENCE",
+                "description": "The `InstrumentContext` of the relevant Instrument",
+                "uiLabel": "Instrument",
+                "reference": "InstrumentContext"
+            },
             {
                 "name": "name",
                 "kind": "string",
@@ -9300,11 +9649,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "type",
                 "kind": "unknown",
-                "description": "Context type is always 'position'",
+                "description": "Context type is always `position`",
                 "uiLabel": "Type"
             }
         ]
     },
+    "PositionIntent": {
+        "name": "PositionIntent",
+        "kind": "TypeAlias",
+        "description": "FDC3 Intents available to a Position Column"
+    },
+    "PositionIntents": {
+        "name": "PositionIntents",
+        "kind": "TypeAlias",
+        "description": "All available Position Intents"
+    },
     "PredefinedConfig": {
         "name": "PredefinedConfig",
         "kind": "Interface",
@@ -9454,6 +9813,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "ShortcutState"
             },
+            {
+                "name": "StatusBar",
+                "kind": "REFERENCE",
+                "description": "Configures the Adaptable Status Bar",
+                "uiLabel": "Status Bar",
+                "isOptional": true,
+                "reference": "unknown"
+            },
             {
                 "name": "Theme",
                 "kind": "REFERENCE",
@@ -9602,6 +9969,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Clears the Current Query",
                 "uiLabel": "Clear Current Query"
             },
+            {
+                "name": "expandCurrentQuery",
+                "kind": "function",
+                "description": "Opens current query editor",
+                "uiLabel": "Expand Current Query"
+            },
             {
                 "name": "getAllNamedQuery",
                 "kind": "function",
@@ -9817,6 +10190,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "RaiseFDC3IntentContext": {
+        "name": "RaiseFDC3IntentContext",
+        "kind": "Interface",
+        "description": "Context passed into Raise FDC3 Intent functions (e.g. get label)",
+        "properties": [
+            {
+                "name": "intent",
+                "kind": "REFERENCE",
+                "description": "FDC3 Intent that was raised",
+                "uiLabel": "Intent",
+                "reference": "FDC3Intent"
+            }
+        ]
+    },
     "ReactFrameworkComponent": {
         "name": "ReactFrameworkComponent",
         "kind": "TypeAlias",
@@ -11562,7 +11949,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "ToolPanels",
                 "kind": "unknown",
-                "description": "ToolPanels visible",
+                "description": "Adaptable Tool Panels which are viaible",
                 "uiLabel": "Tool Panels",
                 "isOptional": true,
                 "defaultValue": "ToolPanels for all available Modules (subject to Entitlement rules)"
@@ -11774,6 +12161,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "AdaptableStyle"
             },
+            {
+                "name": "showAdapTableVersion",
+                "kind": "boolean",
+                "description": "Displays the AdapTable version in Grid Info section of Settings Panel",
+                "uiLabel": "Show Adap Table Version",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "true"
+            },
             {
                 "name": "showDocumentationLinks",
                 "kind": "boolean",