@adaptabletools/adaptable 10.0.3 → 10.0.4-canary.0

package/src/metamodel/adaptable.metamodel.d.ts

@@ -765,6 +765,11 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
         }[];
     };
+    BulkUpdatePermittedValues: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     ButtonStyle: {
         name: string;
         kind: string;
@@ -1189,6 +1194,11 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
         }[];
     };
+    CustomSortPermittedValues: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     CustomSortState: {
         name: string;
         kind: string;
@@ -1401,8 +1411,15 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             description: string;
             uiLabel: string;
-            isOptional?: undefined;
             reference?: undefined;
+            isOptional?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+            isOptional?: undefined;
         } | {
             name: string;
             kind: string;
@@ -1522,6 +1539,11 @@ export declare const ADAPTABLE_METAMODEL: {
             defaultValue: string;
         }[];
     };
+    EditLookUpPermittedValues: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     EditOptions: {
         name: string;
         kind: string;
@@ -1807,6 +1829,18 @@ export declare const ADAPTABLE_METAMODEL: {
             defaultValue?: undefined;
         })[];
     };
+    FilterPermittedValues: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+        }[];
+    };
     FilterState: {
         name: string;
         kind: string;
@@ -2149,22 +2183,22 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             description: string;
             uiLabel: string;
+            reference: string;
             isOptional?: undefined;
-            reference?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
-            isOptional: boolean;
             reference?: undefined;
+            isOptional?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
-            reference: string;
-            isOptional?: undefined;
+            isOptional: boolean;
+            reference?: undefined;
         })[];
     };
     GridDataChangedInfo: {
@@ -2581,6 +2615,18 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    PermittedValues: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+        }[];
+    };
     PluginsApi: {
         name: string;
         kind: string;

package/src/metamodel/adaptable.metamodel.js

@@ -480,27 +480,27 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Defines an Adaptable Column - created at run-time based on vendor grid column definition",
         "properties": [
             {
-                "name": "Aggregatable",
+                "name": "aggregatable",
                 "kind": "boolean",
                 "description": "Is Column able to display aggregations (e.g. 'sum') when grouped",
                 "uiLabel": "Aggregatable"
             },
             {
-                "name": "AggregationFunction",
+                "name": "aggregationFunction",
                 "kind": "string",
                 "description": "Custom aggregation function for the Column",
                 "uiLabel": "Aggregation Function",
                 "isOptional": true
             },
             {
-                "name": "AvailableAggregationFunctions",
+                "name": "availableAggregationFunctions",
                 "kind": "unknown",
                 "description": "Available aggregations for the Column",
                 "uiLabel": "Available Aggregation Functions",
                 "isOptional": true
             },
             {
-                "name": "ColumnGroup",
+                "name": "columnGroup",
                 "kind": "REFERENCE",
                 "description": "The parent column group, if the column belongs to one",
                 "uiLabel": "Column Group",
@@ -508,98 +508,98 @@ exports.ADAPTABLE_METAMODEL = {
                 "reference": "unknown"
             },
             {
-                "name": "Filterable",
+                "name": "filterable",
                 "kind": "boolean",
                 "description": "Is Column able to be filtered",
                 "uiLabel": "Filterable"
             },
             {
-                "name": "Flex",
+                "name": "flex",
                 "kind": "number",
                 "description": "Flex details of the column",
                 "uiLabel": "Flex",
                 "isOptional": true
             },
             {
-                "name": "Groupable",
+                "name": "groupable",
                 "kind": "boolean",
                 "description": "Can Column form a Row Group",
                 "uiLabel": "Groupable"
             },
             {
-                "name": "Hideable",
+                "name": "hideable",
                 "kind": "boolean",
                 "description": "Can Column be removed from the grid",
                 "uiLabel": "Hideable"
             },
             {
-                "name": "IsExcludedFromQuickSearch",
+                "name": "isExcludedFromQuickSearch",
                 "kind": "boolean",
                 "description": "Has colummn been excluded from Quick Search results",
                 "uiLabel": "Is Excluded From Quick Search"
             },
             {
-                "name": "IsFixed",
+                "name": "isFixed",
                 "kind": "boolean",
                 "description": "Is Column pinned or locked into position",
                 "uiLabel": "Is Fixed"
             },
             {
-                "name": "IsGrouped",
+                "name": "isGrouped",
                 "kind": "boolean",
                 "description": "Is Column currently grouped",
                 "uiLabel": "Is Grouped"
             },
             {
-                "name": "IsPrimaryKey",
+                "name": "isPrimaryKey",
                 "kind": "boolean",
                 "description": "Is this the Primary Key column",
                 "uiLabel": "Is Primary Key"
             },
             {
-                "name": "IsSparkline",
+                "name": "isSparkline",
                 "kind": "boolean",
                 "description": "Is it a Sparkline Column",
                 "uiLabel": "Is Sparkline"
             },
             {
-                "name": "Moveable",
+                "name": "moveable",
                 "kind": "boolean",
                 "description": "Can Column be moved at run-time to a new position",
                 "uiLabel": "Moveable"
             },
             {
-                "name": "Pivotable",
+                "name": "pivotable",
                 "kind": "boolean",
                 "description": "Can Column be used in a Pivot Grid",
                 "uiLabel": "Pivotable"
             },
             {
-                "name": "Queryable",
+                "name": "queryable",
                 "kind": "boolean",
                 "description": "Can the Column be in included in Queries / Expressions",
                 "uiLabel": "Queryable"
             },
             {
-                "name": "ReadOnly",
+                "name": "readOnly",
                 "kind": "boolean",
                 "description": "Is column editable",
                 "uiLabel": "Read Only"
             },
             {
-                "name": "Sortable",
+                "name": "sortable",
                 "kind": "boolean",
                 "description": "Is Column sortable",
                 "uiLabel": "Sortable"
             },
             {
-                "name": "Visible",
+                "name": "visible",
                 "kind": "boolean",
                 "description": "Is Column currently visible",
                 "uiLabel": "Visible"
             },
             {
-                "name": "Width",
+                "name": "width",
                 "kind": "number",
                 "description": "Column width",
                 "uiLabel": "Width",
@@ -613,19 +613,19 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Base class for Adaptable Column containing most important properties",
         "properties": [
             {
-                "name": "ColumnId",
+                "name": "columnId",
                 "kind": "string",
                 "description": "Name of Column in underlying grid (e.g. field or colId)",
                 "uiLabel": "Column Id"
             },
             {
-                "name": "DataType",
+                "name": "dataType",
                 "kind": "unknown",
                 "description": "DataType of the column",
                 "uiLabel": "Data Type"
             },
             {
-                "name": "FriendlyName",
+                "name": "friendlyName",
                 "kind": "string",
                 "description": "How Column is referred to in Adaptable UI; 'Caption' or 'Header' property in underlying grid",
                 "uiLabel": "Friendly Name"
@@ -2087,6 +2087,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "BulkUpdatePermittedValues": {
+        "name": "BulkUpdatePermittedValues",
+        "kind": "Interface",
+        "description": "User to define permitted values when updating cells via bulk update"
+    },
     "ButtonStyle": {
         "name": "ButtonStyle",
         "kind": "Interface",
@@ -2212,12 +2217,30 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all the references in the AdaptableState of the given CalculatedColumn",
                 "uiLabel": "Get Calculated Column Module References"
             },
+            {
+                "name": "getCalculatedColumnsReferencingColumnId",
+                "kind": "function",
+                "description": "Returns all Calculated Columns whose Expression contains the ColumnId",
+                "uiLabel": "Get Calculated Columns Referencing Column Id"
+            },
             {
                 "name": "getCalculatedColumnState",
                 "kind": "function",
                 "description": "Retrieves Calculated Column section from Adaptable State",
                 "uiLabel": "Get Calculated Column State"
             },
+            {
+                "name": "getReferencedColumnIdsForCalculatedColumn",
+                "kind": "function",
+                "description": "Gets any ColumnIds referenced in a Calculated Column",
+                "uiLabel": "Get Referenced Column Ids For Calculated Column"
+            },
+            {
+                "name": "getReferencedColumnIdsForCalculatedColumnId",
+                "kind": "function",
+                "description": "Gets any ColumnIds referenced in a Calculated Column",
+                "uiLabel": "Get Referenced Column Ids For Calculated Column Id"
+            },
             {
                 "name": "showCalculatedColumnPopup",
                 "kind": "function",
@@ -2752,6 +2775,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Is Column a Calculated Column",
                 "uiLabel": "Is Calculated Column"
             },
+            {
+                "name": "isColumnReferencedInExpression",
+                "kind": "function",
+                "description": "Checks if a column is referenced in a given Expression",
+                "uiLabel": "Is Column Referenced In Expression"
+            },
             {
                 "name": "isDateColumn",
                 "kind": "function",
@@ -3507,6 +3536,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CustomSortPermittedValues": {
+        "name": "CustomSortPermittedValues",
+        "kind": "Interface",
+        "description": "Custom column values for custom sort."
+    },
     "CustomSortState": {
         "name": "CustomSortState",
         "kind": "Interface",
@@ -4064,10 +4098,11 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Changed At"
             },
             {
-                "name": "columnId",
-                "kind": "string",
-                "description": "Id of the Column in which the cell is situated",
-                "uiLabel": "Column Id"
+                "name": "column",
+                "kind": "REFERENCE",
+                "description": "Column in which cell is situated",
+                "uiLabel": "Column",
+                "reference": "AdaptableColumn"
             },
             {
                 "name": "newValue",
@@ -4390,6 +4425,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "EditLookUpPermittedValues": {
+        "name": "EditLookUpPermittedValues",
+        "kind": "Interface",
+        "description": "Used to define permitted values for inline column editor"
+    },
     "EditOptions": {
         "name": "EditOptions",
         "kind": "Interface",
@@ -5403,6 +5443,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "FilterPermittedValues": {
+        "name": "FilterPermittedValues",
+        "kind": "Interface",
+        "description": "Used to define values inside the floating filter and floating filter (quick filter)",
+        "properties": [
+            {
+                "name": "suppressClientSideFiltering",
+                "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",
+                "uiLabel": "Suppress Client Side Filtering",
+                "isOptional": true
+            }
+        ]
+    },
     "FilterState": {
         "name": "FilterState",
         "kind": "Interface",
@@ -6789,10 +6843,11 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value",
         "properties": [
             {
-                "name": "columnId",
-                "kind": "string",
+                "name": "column",
+                "kind": "REFERENCE",
                 "description": "Column in which cell is situtated",
-                "uiLabel": "Column Id"
+                "uiLabel": "Column",
+                "reference": "AdaptableColumn"
             },
             {
                 "name": "displayValue",
@@ -8252,6 +8307,20 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Internal State used by AdapTable for managing the OpenFin plugin"
     },
+    "PermittedValues": {
+        "name": "PermittedValues",
+        "kind": "Interface",
+        "description": "Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)",
+        "properties": [
+            {
+                "name": "values",
+                "kind": "unknown",
+                "description": "Values to display: either hardcoded list or a function",
+                "uiLabel": "Values",
+                "isOptional": true
+            }
+        ]
+    },
     "PluginsApi": {
         "name": "PluginsApi",
         "kind": "Interface",

package/src/types.d.ts

@@ -23,7 +23,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, } from './AdaptableOptions/UserInterfaceOptions';
+export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, } from './AdaptableOptions/UserInterfaceOptions';
 export type { MenuOptions } from './AdaptableOptions/MenuOptions';
 export type { EntitlementOptions } from './AdaptableOptions/EntitlementOptions';
 export type { QueryLanguageOptions, ModuleExpressionFunctions, } from './AdaptableOptions/QueryLanguageOptions';

package/version.d.ts

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

package/version.js

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