@adaptabletools/adaptable 11.1.5 → 11.1.8

package/src/metamodel/adaptable.metamodel.js

@@ -283,6 +283,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Filter Api",
                 "reference": "FilterApi"
             },
+            {
+                "name": "flashingCellApi",
+                "kind": "REFERENCE",
+                "description": "Provides access to the Flashing Cell Module",
+                "uiLabel": "Flashing Cell Api",
+                "reference": "FlashingCellApi"
+            },
             {
                 "name": "formatColumnApi",
                 "kind": "REFERENCE",
@@ -3548,6 +3555,35 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ContactColumn": {
+        "name": "ContactColumn",
+        "kind": "Interface",
+        "description": "A (String) Column which will be defined as an FDC3 Contact columnId and at least one other property is required",
+        "properties": [
+            {
+                "name": "emailColumnId",
+                "kind": "string",
+                "description": "Column which holds the email address of a Contact",
+                "uiLabel": "Email Column Id",
+                "isOptional": true
+            },
+            {
+                "name": "fds_IdColumnId",
+                "kind": "string",
+                "description": "Column which holds an FDS_ID value a Contact",
+                "uiLabel": "Fds_Id Column Id",
+                "isOptional": true
+            },
+            {
+                "name": "intents",
+                "kind": "REFERENCE",
+                "description": "FDC3 Intents available to the Column",
+                "uiLabel": "Intents",
+                "isOptional": true,
+                "reference": "unknown"
+            }
+        ]
+    },
     "ContainerOptions": {
         "name": "ContainerOptions",
         "kind": "Interface",
@@ -3653,6 +3689,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether cell that was clicked is also currently selected",
                 "uiLabel": "Is Selected Cell"
             },
+            {
+                "name": "isSingleSelectedCell",
+                "kind": "boolean",
+                "description": "Whether the clicked cell is the only selected cell",
+                "uiLabel": "Is Single Selected Cell"
+            },
             {
                 "name": "isSingleSelectedColumn",
                 "kind": "boolean",
@@ -3688,6 +3730,35 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CountryColumn": {
+        "name": "CountryColumn",
+        "kind": "Interface",
+        "description": "A (String) Column which will be defined as an FDC3 Country",
+        "properties": [
+            {
+                "name": "intents",
+                "kind": "REFERENCE",
+                "description": "FDC3 Intents available to the Column",
+                "uiLabel": "Intents",
+                "isOptional": true,
+                "reference": "unknown"
+            },
+            {
+                "name": "isoAlpha2ColumnId",
+                "kind": "string",
+                "description": "Column which contains the ISOALPHA2 Standard",
+                "uiLabel": "Iso Alpha2Column Id",
+                "isOptional": true
+            },
+            {
+                "name": "isoAlpha3ColumnId",
+                "kind": "string",
+                "description": "Column which contains the ISOALPHA3 Standard",
+                "uiLabel": "Iso Alpha3Column Id",
+                "isOptional": true
+            }
+        ]
+    },
     "CustomDestination": {
         "name": "CustomDestination",
         "kind": "Interface",
@@ -5885,10 +5956,10 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Options required for when using the Finance plugin",
         "properties": [
             {
-                "name": "instrumentColumns",
+                "name": "fdc3Columns",
                 "kind": "unknown",
-                "description": "Columns to be defined as (FDC3) Instrument",
-                "uiLabel": "Instrument Columns",
+                "description": "Columns to be defined as FDC3",
+                "uiLabel": "Fdc3Columns",
                 "isOptional": true
             },
             {
@@ -7593,7 +7664,7 @@ exports.ADAPTABLE_METAMODEL = {
     "InstrumentColumn": {
         "name": "InstrumentColumn",
         "kind": "Interface",
-        "description": "Defines an Column which will be defind as an (FDC3) Instrument",
+        "description": "A Column which will be defined as an FDC3 Instrument",
         "properties": [
             {
                 "name": "bbgColumnId",
@@ -7602,12 +7673,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Bbg Column Id",
                 "isOptional": true
             },
-            {
-                "name": "columnId",
-                "kind": "string",
-                "description": "Column defined as an Instrument - its value provides the `name` property in the FDC3 message",
-                "uiLabel": "Column Id"
-            },
             {
                 "name": "cusipColumnId",
                 "kind": "string",
@@ -7622,6 +7687,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Figi Column Id",
                 "isOptional": true
             },
+            {
+                "name": "intents",
+                "kind": "REFERENCE",
+                "description": "FDC3 Intents available to the Column",
+                "uiLabel": "Intents",
+                "isOptional": true,
+                "reference": "unknown"
+            },
             {
                 "name": "isinColumnId",
                 "kind": "string",
@@ -7662,19 +7735,21 @@ exports.ADAPTABLE_METAMODEL = {
     "InstrumentContext": {
         "name": "InstrumentContext",
         "kind": "Interface",
-        "description": "Built-in context to define a financial instrument.",
+        "description": "Built-in context to define a financial Instrument",
         "properties": [
             {
                 "name": "id",
                 "kind": "unknown",
                 "description": "The instrument data",
-                "uiLabel": "Id"
+                "uiLabel": "Id",
+                "isOptional": true
             },
             {
                 "name": "name",
                 "kind": "string",
                 "description": "Free text name of instrument",
-                "uiLabel": "Name"
+                "uiLabel": "Name",
+                "isOptional": true
             },
             {
                 "name": "type",
@@ -8804,13 +8879,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Options required for when using the OpenFin plugin",
         "properties": [
-            {
-                "name": "broadcastFDC3Instrument",
-                "kind": "unknown",
-                "description": "Useful when you also use the finance plugin configured with instrumentColumns - values in cells in an instrument column can be broadcasted to fdc3, and this function will be called for broadcasting. It's your job to broadcast to the desired fdc3 channel",
-                "uiLabel": "Broadcast FDC3Instrument",
-                "isOptional": true
-            },
             {
                 "name": "notificationTimeout",
                 "kind": "unknown",
@@ -8819,6 +8887,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "defaultValue": "5000"
             },
+            {
+                "name": "onFDC3MessageSent",
+                "kind": "unknown",
+                "description": "Useful when you also use the finance plugin configured with fdc3 related columns - values in cells such columns can be broadcasted to fdc3, and this function will be called for broadcasting. It's your job to broadcast to the desired fdc3 channel",
+                "uiLabel": "On FDC3Message Sent",
+                "isOptional": true
+            },
             {
                 "name": "onNotificationAction",
                 "kind": "unknown",
@@ -8904,6 +8979,42 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Internal State used by AdapTable for managing the OpenFin plugin"
     },
+    "OrganizationColumn": {
+        "name": "OrganizationColumn",
+        "kind": "Interface",
+        "description": "A (String) Column which will be defined as an FDC3 Organization",
+        "properties": [
+            {
+                "name": "fds_IdColumnId",
+                "kind": "string",
+                "description": "Column which contains an FDS_ID",
+                "uiLabel": "Fds_Id Column Id",
+                "isOptional": true
+            },
+            {
+                "name": "intents",
+                "kind": "REFERENCE",
+                "description": "FDC3 Intents available to the Column",
+                "uiLabel": "Intents",
+                "isOptional": true,
+                "reference": "unknown"
+            },
+            {
+                "name": "leiColumnId",
+                "kind": "string",
+                "description": "Column which contains the LEI",
+                "uiLabel": "Lei Column Id",
+                "isOptional": true
+            },
+            {
+                "name": "permIdColumnId",
+                "kind": "string",
+                "description": "Column which contains a PermId",
+                "uiLabel": "Perm Id Column Id",
+                "isOptional": true
+            }
+        ]
+    },
     "PercentBarStyle": {
         "name": "PercentBarStyle",
         "kind": "Interface",
@@ -9140,6 +9251,60 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "PositionColumn": {
+        "name": "PositionColumn",
+        "kind": "Interface",
+        "description": "A (Numeric) Column which will be defined as an FDC3 Position",
+        "properties": [
+            {
+                "name": "instrumentColumnId",
+                "kind": "string",
+                "description": "Column which contains the Instrument information of the FDC3 Message",
+                "uiLabel": "Instrument Column Id"
+            },
+            {
+                "name": "intents",
+                "kind": "REFERENCE",
+                "description": "FDC3 Intents available to the Column",
+                "uiLabel": "Intents",
+                "isOptional": true,
+                "reference": "unknown"
+            }
+        ]
+    },
+    "PositionContext": {
+        "name": "PositionContext",
+        "kind": "Interface",
+        "description": "Built-in context to define a financial position",
+        "properties": [
+            {
+                "name": "holding",
+                "kind": "number",
+                "description": "Holding in the Position",
+                "uiLabel": "Holding"
+            },
+            {
+                "name": "id",
+                "kind": "unknown",
+                "description": "Optional Id",
+                "uiLabel": "Id",
+                "isOptional": true
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Free text name of Position",
+                "uiLabel": "Name",
+                "isOptional": true
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Context type is always 'position'",
+                "uiLabel": "Type"
+            }
+        ]
+    },
     "PredefinedConfig": {
         "name": "PredefinedConfig",
         "kind": "Interface",
@@ -10136,6 +10301,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Provides access to a suite of functions related to the `Scope` object",
         "properties": [
+            {
+                "name": "areAllBooleanColumnsInScope",
+                "kind": "function",
+                "description": "True if all selected columns are boolean",
+                "uiLabel": "Are All Boolean Columns In Scope"
+            },
             {
                 "name": "createCellColorRangesForScope",
                 "kind": "function",
@@ -10250,6 +10421,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "True if Scope contains DataTypes",
                 "uiLabel": "Scope Has Data Type"
             },
+            {
+                "name": "scopeHasOnlyBooleanDataType",
+                "kind": "function",
+                "description": "True if the Scope is DataTypes and contains only Boolean",
+                "uiLabel": "Scope Has Only Boolean Data Type"
+            },
             {
                 "name": "scopeIsAll",
                 "kind": "function",
@@ -10792,6 +10969,20 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Case",
                 "isOptional": true
             },
+            {
+                "name": "Prefix",
+                "kind": "string",
+                "description": "Prefix to use before the cell text",
+                "uiLabel": "Prefix",
+                "isOptional": true
+            },
+            {
+                "name": "Suffix",
+                "kind": "string",
+                "description": "Suffix to use after the cell text",
+                "uiLabel": "Suffix",
+                "isOptional": true
+            },
             {
                 "name": "Trim",
                 "kind": "boolean",
@@ -11683,7 +11874,7 @@ exports.ADAPTABLE_METAMODEL = {
     "WeightedAverageColumn": {
         "name": "WeightedAverageColumn",
         "kind": "Interface",
-        "description": "Defines an Column which have Weighted Average aggregation",
+        "description": "An Column which contains a Weighted Average aggregation",
         "properties": [
             {
                 "name": "columnId",

package/src/types.d.ts

@@ -19,7 +19,7 @@ export type { Glue42PluginOptions } from './AdaptableOptions/Glue42PluginOptions
 export type { IPushPullPluginOptions } from './AdaptableOptions/IPushPullPluginOptions';
 export type { LayoutOptions } from './AdaptableOptions/LayoutOptions';
 export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptions';
-export type { FinancePluginOptions, WeightedAverageColumn, InstrumentColumn, } from './AdaptableOptions/FinancePluginOptions';
+export type { FinancePluginOptions, WeightedAverageColumn, FDC3Column, InstrumentColumn, PositionColumn, CountryColumn, InstrumentIntent, InstrumentIntents, PositionIntent, PositionIntents, ContactIntent, ContactIntents, CountryIntent, CountryIntents, ContactColumn, OrganizationColumn, OrganizationIntent, OrganizationIntents, FDC3Intent, } from './AdaptableOptions/FinancePluginOptions';
 export type { DateInputOptions } from './AdaptableOptions/DateInputOptions';
 export type { FilterOptions } from './AdaptableOptions/FilterOptions';
 export type { SearchOptions } from './AdaptableOptions/SearchOptions';
@@ -111,7 +111,7 @@ export type { AdaptableObject } from './PredefinedConfig/Common/AdaptableObject'
 export type { SuspendableObject } from './PredefinedConfig/Common/SuspendableObject';
 export type { AdaptableQuery, AdaptableAggregatedBooleanQuery, AdaptableAggregatedScalarQuery, AdaptableBooleanQuery, AdaptableObservableQuery, AdaptableScalarQuery, } from './PredefinedConfig/Common/AdaptableQuery';
 export type { AdaptablePredicate, AdaptablePredicateDef, ModuleScope, PredicateDefHandlerParams, PredicateDefInput, PredicateDefToStringParams, } from './PredefinedConfig/Common/AdaptablePredicate';
-export type { FDC3Context, InstrumentContext } from './PredefinedConfig/Common/FDC3Context';
+export type { FDC3Context, InstrumentContext, InstrumentListContext, PositionContext, PortfolioContext, ContactContext, ContactListContext, CountryContext, OrganizationContext, AdaptableFDC3EventInfo, } from './PredefinedConfig/Common/FDC3Context';
 export type { AdaptableScope } from './PredefinedConfig/Common/AdaptableScope';
 export type { AdaptableStyle } from './PredefinedConfig/Common/AdaptableStyle';
 export type { AdaptableIcon } from './PredefinedConfig/Common/AdaptableIcon';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.1.5";
+declare const _default: "11.1.8";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.1.5'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.1.8'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version