@adaptabletools/adaptable 11.1.15 → 11.2.0

package/src/metamodel/adaptable.metamodel.js

@@ -259,7 +259,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "destroy",
                 "kind": "unknown",
-                "description": "Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted.",
+                "description": "Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted. This destroys the Adaptable instance.",
                 "uiLabel": "Destroy"
             },
             {
@@ -311,6 +311,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Grid Api",
                 "reference": "GridApi"
             },
+            {
+                "name": "internalDestroySelf",
+                "kind": "unknown",
+                "description": "Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.",
+                "uiLabel": "Internal Destroy Self"
+            },
             {
                 "name": "layoutApi",
                 "kind": "REFERENCE",
@@ -973,10 +979,17 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Source",
                 "kind": "unknown",
-                "description": "Source of state object: 'Config' if provided via , 'User' or undefined for runtime state.",
+                "description": "Source of state object: 'Config' if provided via `AdaptableOptions.predefinedConfig`, 'User' or undefined for runtime state.",
                 "uiLabel": "Source",
                 "isOptional": true
             },
+            {
+                "name": "Tags",
+                "kind": "unknown",
+                "description": "List of tags associated with the object",
+                "uiLabel": "Tags",
+                "isOptional": true
+            },
             {
                 "name": "Uuid",
                 "kind": "REFERENCE",
@@ -2025,6 +2038,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "4000"
+            },
+            {
+                "name": "statusbarHighlightDuration",
+                "kind": "number",
+                "description": "How long (in ms) the status-panel will be highlighted when an Alert Fires",
+                "uiLabel": "Statusbar Highlight Duration",
+                "isOptional": true,
+                "defaultValue": "2000"
             }
         ]
     },
@@ -2224,10 +2245,10 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "BaseMenuContext": {
-        "name": "BaseMenuContext",
+    "BaseContext": {
+        "name": "BaseContext",
         "kind": "Interface",
-        "description": "Base Context object used for both Column and Context Menu Context",
+        "description": "Base Context object used in many functions provided by AdapTable",
         "properties": [
             {
                 "name": "adaptableApi",
@@ -2643,10 +2664,10 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "CellSummaryOperationParams": {
-        "name": "CellSummaryOperationParams",
+    "CellSummaryOperationContext": {
+        "name": "CellSummaryOperationContext",
         "kind": "Interface",
-        "description": "Params provided to a custom Cell Summary Operation function",
+        "description": "Context provided to a custom Cell Summary Operation function",
         "properties": [
             {
                 "name": "allValues",
@@ -3536,7 +3557,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getPersistedState",
                 "kind": "function",
-                "description": "Retrieves the PERSISTED state in Adaptable",
+                "description": "Retrieves the persisted state in Adaptable. This is the state that was last stored with the `StatusOptions.persistState()` function.",
                 "uiLabel": "Get Persisted State"
             },
             {
@@ -3602,7 +3623,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "loadUserState",
                 "kind": "function",
-                "description": "Loads supplied user state, replacing (not merging) existing User State.",
+                "description": "Loads supplied user state, replacing (NOT merging) existing User(persisted) State.",
                 "uiLabel": "Load User State"
             },
             {
@@ -5174,6 +5195,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Fired when Adaptable is up and running - has no arguments.",
                 "uiLabel": "On"
             },
+            {
+                "name": "on",
+                "kind": "function",
+                "description": "Fired when Adaptable is destroyed",
+                "uiLabel": "On"
+            },
             {
                 "name": "on",
                 "kind": "function",
@@ -5283,6 +5310,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves System Reports section of Export State",
                 "uiLabel": "Get Available System Reports"
             },
+            {
+                "name": "getCurrentDestination",
+                "kind": "function",
+                "description": "Retrieves the current Export destination",
+                "uiLabel": "Get Current Destination"
+            },
             {
                 "name": "getCurrentReport",
                 "kind": "function",
@@ -5355,6 +5388,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Runs the report function of the CustomReport with the given reportName",
                 "uiLabel": "Run Custom Report"
             },
+            {
+                "name": "selectDestination",
+                "kind": "function",
+                "description": "Selects the report destination in the dashboard and statusbar UI",
+                "uiLabel": "Select Destination"
+            },
+            {
+                "name": "selectReport",
+                "kind": "function",
+                "description": "Selects the report in the dashboard and statusbar UI",
+                "uiLabel": "Select Report"
+            },
             {
                 "name": "sendReport",
                 "kind": "function",
@@ -6180,13 +6225,121 @@ exports.ADAPTABLE_METAMODEL = {
     "FinanceApi": {
         "name": "FinanceApi",
         "kind": "Interface",
-        "description": "Provides run-time access to the OpenFin Plugin",
+        "description": "Provides run-time access to the Finance Plugin",
         "properties": [
+            {
+                "name": "createFDC3ContactContext",
+                "kind": "function",
+                "description": "Creates Contact Context",
+                "uiLabel": "Create FDC3Contact Context"
+            },
+            {
+                "name": "createFDC3ContactListContext",
+                "kind": "function",
+                "description": "Creates Contact List Context",
+                "uiLabel": "Create FDC3Contact List Context"
+            },
+            {
+                "name": "createFDC3CountryContext",
+                "kind": "function",
+                "description": "Creates Country Context",
+                "uiLabel": "Create FDC3Country Context"
+            },
+            {
+                "name": "createFDC3InstrumentContext",
+                "kind": "function",
+                "description": "Creates Instrument Context",
+                "uiLabel": "Create FDC3Instrument Context"
+            },
+            {
+                "name": "createFDC3InstrumentListContext",
+                "kind": "function",
+                "description": "Creates Instrumentlist Context",
+                "uiLabel": "Create FDC3Instrument List Context"
+            },
+            {
+                "name": "createFDC3OrganizationContext",
+                "kind": "function",
+                "description": "Creates Organization Context",
+                "uiLabel": "Create FDC3Organization Context"
+            },
+            {
+                "name": "createFDC3PortfolioContext",
+                "kind": "function",
+                "description": "Creates Portfolio Context",
+                "uiLabel": "Create FDC3Portfolio Context"
+            },
+            {
+                "name": "createFDC3PositionContext",
+                "kind": "function",
+                "description": "Creates Position Context",
+                "uiLabel": "Create FDC3Position Context"
+            },
+            {
+                "name": "getContactColumnById",
+                "kind": "function",
+                "description": "Gets Contact Column with given Id",
+                "uiLabel": "Get Contact Column By Id"
+            },
+            {
+                "name": "getCountryColumnById",
+                "kind": "function",
+                "description": "Gets Country Column with given Id",
+                "uiLabel": "Get Country Column By Id"
+            },
+            {
+                "name": "getInstrumentColumnById",
+                "kind": "function",
+                "description": "Gets Instrument Column with given Id",
+                "uiLabel": "Get Instrument Column By Id"
+            },
+            {
+                "name": "getOrganizationColumnById",
+                "kind": "function",
+                "description": "Gets Organization Column with given Id",
+                "uiLabel": "Get Organization Column By Id"
+            },
             {
                 "name": "getPluginOptions",
                 "kind": "function",
-                "description": "Retrieves the OpenFinPlugOptions provided in OpenFin Plugin",
+                "description": "Retrieves the FinancePlugOptions provided in the Finance Plugin",
                 "uiLabel": "Get Plugin Options"
+            },
+            {
+                "name": "getPositionColumnById",
+                "kind": "function",
+                "description": "Gets Position Column with given Id",
+                "uiLabel": "Get Position Column By Id"
+            },
+            {
+                "name": "isValidContactlistIntent",
+                "kind": "function",
+                "description": "Checks whether the Contact Intent is valid for Contact Lists",
+                "uiLabel": "Is Valid Contactlist Intent"
+            },
+            {
+                "name": "isValidInstrumentlistIntent",
+                "kind": "function",
+                "description": "Checks whether the Instrument Intent is valid for Instrument Lists",
+                "uiLabel": "Is Valid Instrumentlist Intent"
+            },
+            {
+                "name": "isValidPositionIntent",
+                "kind": "function",
+                "description": "Checks whether the Position Intent is valid for single Positions (and not Portfolios)",
+                "uiLabel": "Is Valid Position Intent"
+            },
+            {
+                "name": "publishBroadcastFDC3MessageEvent",
+                "kind": "function",
+                "description": "Publishes an FDC3 Message Event of type `Broadcast`",
+                "uiLabel": "Publish Broadcast FDC3Message Event"
+            },
+            {
+                "name": "publishRaiseFDC3IntentEvent",
+                "kind": "function",
+                "description": "Publishes an FDC3 Message Event of type `Raise Event`",
+                "uiLabel": "Publish Raise FDC3Intent Event"
             }
         ]
     },
@@ -8355,6 +8508,11 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Internal State used by AdapTable for managing the ipushpull plugin"
     },
+    "IsObjectAvailableInLayoutContext": {
+        "name": "IsObjectAvailableInLayoutContext",
+        "kind": "Interface",
+        "description": "Context for `LayoutOptions.isObjectAvailableInLayout` method"
+    },
     "Layout": {
         "name": "Layout",
         "kind": "Interface",
@@ -8639,7 +8797,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showChangeColumnCaption",
                 "kind": "function",
-                "description": "Opens change column caption popup",
+                "description": "Opens Change Column Caption popup",
                 "uiLabel": "Show Change Column Caption"
             },
             {
@@ -8656,6 +8814,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "LayoutAssociatedObject": {
+        "name": "LayoutAssociatedObject",
+        "kind": "TypeAlias",
+        "description": "Types of objects that can be associated with a Layout"
+    },
     "LayoutChangedInfo": {
         "name": "LayoutChangedInfo",
         "kind": "Interface",
@@ -8676,10 +8839,9 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "oldLayoutState",
-                "kind": "REFERENCE",
+                "kind": "unknown",
                 "description": "Previous Layout State",
-                "uiLabel": "Old Layout State",
-                "reference": "LayoutState"
+                "uiLabel": "Old Layout State"
             }
         ]
     },
@@ -8688,6 +8850,13 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width",
         "properties": [
+            {
+                "name": "autoGenerateTagsForLayouts",
+                "kind": "unknown",
+                "description": "Automatically generate a tag for each existing layout",
+                "uiLabel": "Auto Generate Tags For Layouts",
+                "isOptional": true
+            },
             {
                 "name": "autoSaveLayouts",
                 "kind": "boolean",
@@ -8727,9 +8896,11 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "displayRowGroups",
                 "kind": "unknown",
-                "description": "Whether RowGroups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",
+                "description": "Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",
                 "uiLabel": "Display Row Groups",
-                "isOptional": true
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "'closed'"
             },
             {
                 "name": "includeExpandedRowGroups",
@@ -8741,11 +8912,19 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "false"
             },
             {
-                "name": "view",
+                "name": "isObjectAvailableInLayout",
                 "kind": "unknown",
-                "description": "Options to customize how layout items are shown in Settings Panel",
-                "uiLabel": "View",
+                "description": "Checks if the provided AdaptableObject is available in the given Layout",
+                "uiLabel": "Is Object Available In Layout",
                 "isOptional": true
+            },
+            {
+                "name": "viewOptions",
+                "kind": "REFERENCE",
+                "description": "Customize how Layouts are displayed in Settings Panel",
+                "uiLabel": "View Options",
+                "isOptional": true,
+                "reference": "LayoutViewOptions"
             }
         ]
     },
@@ -8770,6 +8949,21 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "LayoutViewOptions": {
+        "name": "LayoutViewOptions",
+        "kind": "Interface",
+        "description": "Customize how Layouts are displayed in Settings Panel",
+        "properties": [
+            {
+                "name": "maxColumnsToDisplay",
+                "kind": "number",
+                "description": "How many columns to display in inline Layout preview",
+                "uiLabel": "Max Columns To Display",
+                "isOptional": true,
+                "defaultValue": "10"
+            }
+        ]
+    },
     "LiveDataChangedInfo": {
         "name": "LiveDataChangedInfo",
         "kind": "Interface",
@@ -10596,6 +10790,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves Schedule by id",
                 "uiLabel": "Get Schedule By Id"
             },
+            {
+                "name": "getScheduleState",
+                "kind": "function",
+                "description": "Retrieves Schedule section from Adaptable State",
+                "uiLabel": "Get Schedule State"
+            },
             {
                 "name": "showSchedulePopup",
                 "kind": "function",
@@ -11264,6 +11464,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "defaultValue": "true"
             },
+            {
+                "name": "HeaderToolTip",
+                "kind": "string",
+                "description": "Tooltip to show in the Column Header (not cells)",
+                "uiLabel": "Header Tool Tip",
+                "isOptional": true
+            },
             {
                 "name": "Pivotable",
                 "kind": "boolean",
@@ -12169,6 +12376,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "['GridSummary', 'AdaptableOptions', 'ColumnInfo']",
                 "reference": "unknown"
             },
+            {
+                "name": "objectTags",
+                "kind": "unknown",
+                "description": "Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",
+                "uiLabel": "Object Tags",
+                "isOptional": true
+            },
             {
                 "name": "permittedValues",
                 "kind": "unknown",

package/src/types.d.ts

@@ -17,7 +17,7 @@ export type { ExportOptions, SystemExportDestination, SystemExportDestinations,
 export type { GeneralOptions, ColumnValuesComparer } from './AdaptableOptions/GeneralOptions';
 export type { Glue42PluginOptions } from './AdaptableOptions/Glue42PluginOptions';
 export type { IPushPullPluginOptions } from './AdaptableOptions/IPushPullPluginOptions';
-export type { LayoutOptions } from './AdaptableOptions/LayoutOptions';
+export type { LayoutOptions, LayoutViewOptions, IsObjectAvailableInLayoutContext, LayoutAssociatedObject, } from './AdaptableOptions/LayoutOptions';
 export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptions';
 export type { FinancePluginOptions, WeightedAverageColumn, FDC3Column, InstrumentColumn, PositionColumn, CountryColumn, InstrumentIntent, InstrumentIntents, PositionIntent, PositionIntents, ContactIntent, ContactIntents, CountryIntent, CountryIntents, ContactColumn, OrganizationColumn, OrganizationIntent, OrganizationIntents, FDC3Intent, RaiseFDC3IntentContext, } from './AdaptableOptions/FinancePluginOptions';
 export type { DateInputOptions } from './AdaptableOptions/DateInputOptions';
@@ -29,7 +29,7 @@ export type { FilterActionOnDataChange } from './PredefinedConfig/Common/FilterA
 export type { ConfigState } from './PredefinedConfig/ConfigState';
 export type { TeamSharingOptions } from './AdaptableOptions/TeamSharingOptions';
 export type { ToolPanelOptions, CustomToolPanel, ToolPanelButtonContext, CustomToolPanelButtonContext, } from './AdaptableOptions/ToolPanelOptions';
-export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, BaseParams, EditLookUpParams, PermittedValuesParams, FilterPermittedValuesParams, BulkUpdatePermittedValuesParams, GridInfoSections, GridInfoSection, } from './AdaptableOptions/UserInterfaceOptions';
+export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, EditLookUpContext, PermittedValuesContext, FilterPermittedValuesContext, BulkUpdatePermittedValuesContext, GridInfoSections, GridInfoSection, } from './AdaptableOptions/UserInterfaceOptions';
 export type { MenuOptions } from './AdaptableOptions/MenuOptions';
 export type { CustomSettingsPanel, SettingsPanelOptions, } from './AdaptableOptions/SettingsPanelOptions';
 export type { EntitlementOptions } from './AdaptableOptions/EntitlementOptions';
@@ -98,7 +98,7 @@ export type { AlertDefinition, AlertProperties, AlertState, AlertButtonForm, Ale
 export type { ApplicationDataEntry, ApplicationState } from './PredefinedConfig/ApplicationState';
 export type { SpecialColumnSettings } from './PredefinedConfig/Common/SpecialColumnSettings';
 export type { CalculatedColumn, CalculatedColumnSettings, CalculatedColumnState, AdaptableCalculatedColumnQuery, } from './PredefinedConfig/CalculatedColumnState';
-export type { CellSummmary, CellSummaryOperation, CellSummaryOperationParams, } from './PredefinedConfig/Common/CellSummary';
+export type { CellSummmary, CellSummaryOperation, CellSummaryOperationContext, } from './PredefinedConfig/Common/CellSummary';
 export type { FlashingCellDefinition, FlashingCellState, } from './PredefinedConfig/FlashingCellState';
 export type { AdaptableAlert, AdaptableAlertType, AdaptableGenericAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert, AdaptableAlertBase, } from './PredefinedConfig/Common/AdaptableAlert';
 export type { AdaptableFlashingCell } from './PredefinedConfig/Common/AdaptableFlashingCell';
@@ -124,8 +124,9 @@ export type { CellDataChangedInfo } from './PredefinedConfig/Common/CellDataChan
 export type { DataChangedScope } from './PredefinedConfig/Common/DataChangedScope';
 export type { DataUpdateConfig } from './PredefinedConfig/Common/DataUpdateConfig';
 export type { AdaptableFormData, AdaptableForm, AdaptableFormField, } from './PredefinedConfig/Common/AdaptableForm';
-export type { AdaptableButton, ButtonContext } from './PredefinedConfig/Common/AdaptableButton';
-export type { AdaptableMenuItem, UserMenuItem, BaseMenuContext, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
+export type { AdaptableButton } from './PredefinedConfig/Common/AdaptableButton';
+export type { AdaptableMenuItem, UserMenuItem, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
+export type { BaseContext } from './PredefinedConfig/Common/BaseContext';
 export type { Schedule } from './PredefinedConfig/Common/Schedule';
 export type { ButtonStyle } from './PredefinedConfig/Common/ButtonStyle';
 export type { AdaptableModule, AdaptableToolPanel, AdaptableQLModule, AdaptableSettingsPanel, AdaptableDashboardToolbar, AdaptableStatusBarPanel, } from './PredefinedConfig/Common/Types';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.1.15";
+declare const _default: "11.2.0";
 export default _default;

package/version.js

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