@adaptabletools/adaptable 11.2.1 → 11.2.4-canary.0

package/src/metamodel/adaptable.metamodel.js

@@ -554,6 +554,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "unknown"
             },
+            {
+                "name": "field",
+                "kind": "string",
+                "description": "Is the field of the row to get the cell data from",
+                "uiLabel": "Field",
+                "isOptional": true
+            },
             {
                 "name": "filterable",
                 "kind": "boolean",
@@ -986,7 +993,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Tags",
                 "kind": "unknown",
-                "description": "List of tags associated with the object",
+                "description": "List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope",
                 "uiLabel": "Tags",
                 "isOptional": true
             },
@@ -1000,6 +1007,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableObjectTag": {
+        "name": "AdaptableObjectTag",
+        "kind": "TypeAlias",
+        "description": "Object Tag - defined as a label and a value"
+    },
     "AdaptableOptions": {
         "name": "AdaptableOptions",
         "kind": "Interface",
@@ -2245,6 +2257,25 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AutoGenerateTagsForLayoutsContext": {
+        "name": "AutoGenerateTagsForLayoutsContext",
+        "kind": "Interface",
+        "description": "Context for `LayoutOptions.autoGenerateTagsForLayouts` method",
+        "properties": [
+            {
+                "name": "layouts",
+                "kind": "unknown",
+                "description": "Layouts currently in Adaptable State",
+                "uiLabel": "Layouts"
+            },
+            {
+                "name": "objectTags",
+                "kind": "unknown",
+                "description": "Object Tags provided in User Interface Options",
+                "uiLabel": "Object Tags"
+            }
+        ]
+    },
     "BaseContext": {
         "name": "BaseContext",
         "kind": "Interface",
@@ -5554,7 +5585,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "Main Adaptable Api object",
                 "uiLabel": "Api",
-                "isOptional": true,
                 "reference": "AdaptableApi"
             },
             {
@@ -7523,6 +7553,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns Ag Grid instance (passed into Adaptable Options at start-up)",
                 "uiLabel": "Get Ag Grid Instance"
             },
+            {
+                "name": "getAllRowNodes",
+                "kind": "function",
+                "description": "Retrieves all Row Nodes currently in the Grid (by default excluding the group rows)",
+                "uiLabel": "Get All Row Nodes"
+            },
             {
                 "name": "getCellDisplayValue",
                 "kind": "function",
@@ -7694,7 +7730,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getVisibleRowNodes",
                 "kind": "function",
-                "description": "Retrieves all Row Nodes currently in the Grid (i.e. filtered)",
+                "description": "Retrieves all filtered Row Nodes currently in the Grid (i.e. after applying the current filter)",
                 "uiLabel": "Get Visible Row Nodes"
             },
             {
@@ -8508,11 +8544,6 @@ 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",
@@ -8764,6 +8795,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Checks if the given Layout is Default Layout",
                 "uiLabel": "Is Default Layout"
             },
+            {
+                "name": "isObjectAvailableInCurrentLayout",
+                "kind": "function",
+                "description": "Does an object's Tags include the Current Layout",
+                "uiLabel": "Is Object Available In Current Layout"
+            },
             {
                 "name": "saveCurrentLayout",
                 "kind": "function",
@@ -8817,7 +8854,35 @@ exports.ADAPTABLE_METAMODEL = {
     "LayoutAssociatedObject": {
         "name": "LayoutAssociatedObject",
         "kind": "TypeAlias",
-        "description": "Types of objects that can be associated with a Layout"
+        "description": "Types of Adaptable Objects that can be associated with a Layout"
+    },
+    "LayoutAvailableContext": {
+        "name": "LayoutAvailableContext",
+        "kind": "Interface",
+        "description": "Context for `LayoutOptions.isObjectAvailableInLayout` functions",
+        "properties": [
+            {
+                "name": "adaptableObject",
+                "kind": "REFERENCE",
+                "description": "Object being checked",
+                "uiLabel": "Adaptable Object",
+                "reference": "LayoutAssociatedObject"
+            },
+            {
+                "name": "layout",
+                "kind": "REFERENCE",
+                "description": "Current Layout",
+                "uiLabel": "Layout",
+                "reference": "Layout"
+            },
+            {
+                "name": "module",
+                "kind": "REFERENCE",
+                "description": "Current Adaptable Module",
+                "uiLabel": "Module",
+                "reference": "AdaptableModule"
+            }
+        ]
     },
     "LayoutChangedInfo": {
         "name": "LayoutChangedInfo",
@@ -8850,13 +8915,6 @@ 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",
@@ -8912,17 +8970,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "false"
             },
             {
-                "name": "isObjectAvailableInLayout",
-                "kind": "unknown",
-                "description": "Checks if the provided AdaptableObject is available in the given Layout",
-                "uiLabel": "Is Object Available In Layout",
-                "isOptional": true
+                "name": "layoutTagOptions",
+                "kind": "REFERENCE",
+                "description": "Options for leveraging Object Tags to extend Layouts",
+                "uiLabel": "Layout Tag Options",
+                "isOptional": true,
+                "reference": "unknown"
             },
             {
-                "name": "viewOptions",
+                "name": "layoutViewOptions",
                 "kind": "REFERENCE",
                 "description": "Customize how Layouts are displayed in Settings Panel",
-                "uiLabel": "View Options",
+                "uiLabel": "Layout View Options",
                 "isOptional": true,
                 "reference": "LayoutViewOptions"
             }
@@ -8957,7 +9016,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "maxColumnsToDisplay",
                 "kind": "number",
-                "description": "How many columns to display in inline Layout preview",
+                "description": "How many Column Names to display in inline Layout preview",
                 "uiLabel": "Max Columns To Display",
                 "isOptional": true,
                 "defaultValue": "10"
@@ -11773,6 +11832,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether Team Sharing is Activated",
                 "uiLabel": "Is Team Sharing Activated"
             },
+            {
+                "name": "shareEntity",
+                "kind": "function",
+                "description": "Puts an Adaptable Object into Team Share",
+                "uiLabel": "Share Entity"
+            },
             {
                 "name": "showTeamSharingPopup",
                 "kind": "function",
@@ -12208,10 +12273,16 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Adds menu item to Context Menu",
                 "uiLabel": "Add Context Menu Item"
             },
+            {
+                "name": "getAdaptableObjectTags",
+                "kind": "function",
+                "description": "Retrieves any Object Tags (provided in User Interface Options)",
+                "uiLabel": "Get Adaptable Object Tags"
+            },
             {
                 "name": "getAllActionColumn",
                 "kind": "function",
-                "description": "Retrieves any Action Columns in User Interface Options",
+                "description": "Retrieves any Action Columns (provided in User Interface Options)",
                 "uiLabel": "Get All Action Column"
             },
             {

package/src/parser/src/types.d.ts

@@ -22,7 +22,7 @@ export interface ExpressionContext {
     /**
      * Main Adaptable Api object
      */
-    api?: AdaptableApi;
+    api: AdaptableApi;
     /**
      * All Expression Functions available to AdapTableQL
      */

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, LayoutViewOptions, IsObjectAvailableInLayoutContext, LayoutAssociatedObject, } from './AdaptableOptions/LayoutOptions';
+export type { LayoutOptions, LayoutViewOptions, LayoutTagOptions, LayoutAvailableContext, AutoGenerateTagsForLayoutsContext, 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';
@@ -108,7 +108,7 @@ export type { SystemStatusMessageInfo } from './PredefinedConfig/Common/SystemSt
 export type { AlternativeModuleName } from './PredefinedConfig/Common/AlternativeModuleName';
 export type { AdaptableFormat, DateFormatterOptions, NumberFormatterOptions, StringFormatterOptions, } from './PredefinedConfig/Common/AdaptableFormat';
 export type { AdaptableMessageType } from './PredefinedConfig/Common/AdaptableMessageType';
-export type { AdaptableObject } from './PredefinedConfig/Common/AdaptableObject';
+export type { AdaptableObject, AdaptableObjectTag, } 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';
@@ -153,7 +153,7 @@ export type { SelectedCellInfo } from './PredefinedConfig/Selection/SelectedCell
 export type { SelectedRowInfo } from './PredefinedConfig/Selection/SelectedRowInfo';
 export type { GridCellRange } from './PredefinedConfig/Selection/GridCellRange';
 export type { Shortcut, ShortcutState, ShortcutScopeDataType, } from './PredefinedConfig/ShortcutState';
-export type { SharedEntity, TeamSharingImportInfo, TeamSharingState, SharedEntityType, } from './PredefinedConfig/TeamSharingState';
+export type { SharedEntity, TeamSharingImportInfo, TeamSharingState, SharedEntityType, SharedEntityConfig, } from './PredefinedConfig/TeamSharingState';
 export type { AdaptableTheme, ThemeState } from './PredefinedConfig/ThemeState';
 export type { ToolPanelState, AdaptableToolPanelDefinition, ToolPanelVisibilityMode, } from './PredefinedConfig/ToolPanelState';
 export type { AdaptableFrameworkComponent, AngularFrameworkComponent, ReactFrameworkComponent, } from './AdaptableOptions/AdaptableFrameworkComponent';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.2.1";
+declare const _default: "11.2.4-canary.0";
 export default _default;

package/version.js

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