@adaptabletools/adaptable 11.0.0-canary.6 → 11.0.1

package/src/metamodel/adaptable.metamodel.js

@@ -152,6 +152,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableAlertQuery": {
+        "name": "AdaptableAlertQuery",
+        "kind": "TypeAlias",
+        "description": "Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"
+    },
     "AdaptableApi": {
         "name": "AdaptableApi",
         "kind": "Interface",
@@ -474,6 +479,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableCalculatedColumnQuery": {
+        "name": "AdaptableCalculatedColumnQuery",
+        "kind": "TypeAlias",
+        "description": "Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"
+    },
     "AdaptableColumn": {
         "name": "AdaptableColumn",
         "kind": "Interface",
@@ -589,7 +599,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "readOnly",
                 "kind": "boolean",
-                "description": "Is column editable",
+                "description": "Is the column editable; returns FALSE if the column has conditional/dynamic editability, assuming some rows are editable",
                 "uiLabel": "Read Only"
             },
             {
@@ -879,6 +889,11 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error'"
     },
+    "AdaptableModule": {
+        "name": "AdaptableModule",
+        "kind": "TypeAlias",
+        "description": "Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config"
+    },
     "AdaptableObject": {
         "name": "AdaptableObject",
         "kind": "Interface",
@@ -922,6 +937,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "'adaptable_id'"
             },
+            {
+                "name": "adaptableQLOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing AdapTableQL",
+                "uiLabel": "Adaptable QL Options",
+                "isOptional": true,
+                "reference": "AdaptableQLOptions"
+            },
             {
                 "name": "adaptableStateKey",
                 "kind": "string",
@@ -1109,15 +1132,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "n/a (Mandatory)"
             },
-            {
-                "name": "queryLanguageOptions",
-                "kind": "REFERENCE",
-                "description": "Options for managing queries in AdapTableQL",
-                "uiLabel": "Query Language Options",
-                "isOptional": true,
-                "gridInfo": "container",
-                "reference": "QueryLanguageOptions"
-            },
             {
                 "name": "searchOptions",
                 "kind": "REFERENCE",
@@ -1280,6 +1294,40 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableQLOptions": {
+        "name": "AdaptableQLOptions",
+        "kind": "Interface",
+        "description": "Options for managing AdaptableQL - the Adaptable Query Lanaguage which evaluates Predicates and Expressions",
+        "properties": [
+            {
+                "name": "caseSensitiveTextComparisons",
+                "kind": "boolean",
+                "description": "Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",
+                "uiLabel": "Case Sensitive Text Comparisons",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "false"
+            },
+            {
+                "name": "expressionOptions",
+                "kind": "REFERENCE",
+                "description": "Options for managing Expressions in AdapTableQL",
+                "uiLabel": "Expression Options",
+                "isOptional": true,
+                "reference": "ExpressionOptions"
+            },
+            {
+                "name": "externallyEvaluatedModules",
+                "kind": "REFERENCE",
+                "description": "Which searching and filtering options should take place on server",
+                "uiLabel": "Externally Evaluated Modules",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined",
+                "reference": "unknown"
+            }
+        ]
+    },
     "AdaptableReadyInfo": {
         "name": "AdaptableReadyInfo",
         "kind": "Interface",
@@ -1798,7 +1846,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "When Alert should be triggered",
                 "uiLabel": "Rule",
-                "reference": "unknown"
+                "reference": "AlertRule"
             },
             {
                 "name": "Scope",
@@ -1940,6 +1988,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AlertRule": {
+        "name": "AlertRule",
+        "kind": "TypeAlias",
+        "description": "The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"
+    },
     "AlertState": {
         "name": "AlertState",
         "kind": "Interface",
@@ -1964,7 +2017,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "Adaptable Module to rename",
                 "uiLabel": "Adaptable Module",
-                "reference": "unknown"
+                "reference": "AdaptableModule"
             },
             {
                 "name": "newName",
@@ -2156,10 +2209,10 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Query",
                 "kind": "REFERENCE",
-                "description": "Scalar Expression used by AdapTableQL to evaluate Column's value",
+                "description": "Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",
                 "uiLabel": "Query",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "AdaptableCalculatedColumnQuery"
             }
         ]
     },
@@ -2186,12 +2239,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Edits given Calculated Column",
                 "uiLabel": "Edit Calculated Column"
             },
-            {
-                "name": "editCalculatedColumnExpression",
-                "kind": "function",
-                "description": "Replaces Expression in given Calculated Column with new value",
-                "uiLabel": "Edit Calculated Column Expression"
-            },
             {
                 "name": "editCalculatedColumns",
                 "kind": "function",
@@ -2207,7 +2254,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCalculatedColumnById",
                 "kind": "function",
-                "description": "Retrieves Calculated column by id",
+                "description": "Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState",
                 "uiLabel": "Get Calculated Column By Id"
             },
             {
@@ -2304,6 +2351,38 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CellColorRange": {
+        "name": "CellColorRange",
+        "kind": "Interface",
+        "description": "Defines which Colours to show in Gradient and Percent Bar Styles",
+        "properties": [
+            {
+                "name": "Color",
+                "kind": "string",
+                "description": "Cell colour to use for values that fall inside Range",
+                "uiLabel": "Color"
+            },
+            {
+                "name": "Max",
+                "kind": "number",
+                "description": "End number of Range",
+                "uiLabel": "Max"
+            },
+            {
+                "name": "Min",
+                "kind": "number",
+                "description": "Start number of Range",
+                "uiLabel": "Min"
+            },
+            {
+                "name": "ReverseGradient",
+                "kind": "boolean",
+                "description": "Reverses the Gradient so the lower the cell value the darker the colour",
+                "uiLabel": "Reverse Gradient",
+                "isOptional": true
+            }
+        ]
+    },
     "CellHighlightInfo": {
         "name": "CellHighlightInfo",
         "kind": "Interface",
@@ -2803,6 +2882,31 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ColumnComparison": {
+        "name": "ColumnComparison",
+        "kind": "Interface",
+        "description": "Enables a Percent Bar or Gradient Style to use another column in its calculations",
+        "properties": [
+            {
+                "name": "Color",
+                "kind": "string",
+                "description": "Colour to use for the Percent bar",
+                "uiLabel": "Color"
+            },
+            {
+                "name": "MaxValue",
+                "kind": "unknown",
+                "description": "End value - either numeric or Column name",
+                "uiLabel": "Max Value"
+            },
+            {
+                "name": "MinValue",
+                "kind": "unknown",
+                "description": "Start value - either numeric or Column name",
+                "uiLabel": "Min Value"
+            }
+        ]
+    },
     "ColumnFilter": {
         "name": "ColumnFilter",
         "kind": "Interface",
@@ -2869,6 +2973,36 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ColumnStyle": {
+        "name": "ColumnStyle",
+        "kind": "Interface",
+        "description": "Special Style used when Formatting Columns: Gradient, PercentBar or CheckBox",
+        "properties": [
+            {
+                "name": "CheckBoxStyle",
+                "kind": "boolean",
+                "description": "Style a boolean column so each cell displays a checkbox",
+                "uiLabel": "Check Box Style",
+                "isOptional": true
+            },
+            {
+                "name": "GradientStyle",
+                "kind": "REFERENCE",
+                "description": "Style a numeric column so each cell value shows a gradient shade",
+                "uiLabel": "Gradient Style",
+                "isOptional": true,
+                "reference": "GradientStyle"
+            },
+            {
+                "name": "PercentBarStyle",
+                "kind": "REFERENCE",
+                "description": "Style a numeric column so each cell displays a 'bar'",
+                "uiLabel": "Percent Bar Style",
+                "isOptional": true,
+                "reference": "PercentBarStyle"
+            }
+        ]
+    },
     "ColumnValuesComparer": {
         "name": "ColumnValuesComparer",
         "kind": "Interface",
@@ -2898,7 +3032,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "IncludeGroupedRows",
                 "kind": "boolean",
-                "description": "Whether to apply Style in Grouped Rows",
+                "description": "Whether to apply Style in Grouped Rows and when Pivoting",
                 "uiLabel": "Include Grouped Rows",
                 "isOptional": true,
                 "defaultValue": "false"
@@ -3048,7 +3182,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "ConditionalStyles",
                 "kind": "unknown",
-                "description": "Array of Conditional Styles to ship with Adaptable",
+                "description": "Array of Conditional Styles to ship with AdapTable",
                 "uiLabel": "Conditional Styles",
                 "isOptional": true
             }
@@ -3471,6 +3605,42 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CustomSettingsPanel": {
+        "name": "CustomSettingsPanel",
+        "kind": "Interface",
+        "description": "Definition of a Custom Panel to add to the Adaptable Settings Panel",
+        "properties": [
+            {
+                "name": "frameworkComponent",
+                "kind": "REFERENCE",
+                "description": "Framework-specific (Angular or React) component to be rendered",
+                "uiLabel": "Framework Component",
+                "isOptional": true,
+                "reference": "unknown"
+            },
+            {
+                "name": "icon",
+                "kind": "REFERENCE",
+                "description": "Icon rendered inside settings-panel name, inside the navigation",
+                "uiLabel": "Icon",
+                "isOptional": true,
+                "reference": "AdaptableIcon"
+            },
+            {
+                "name": "name",
+                "kind": "string",
+                "description": "Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end)",
+                "uiLabel": "Name"
+            },
+            {
+                "name": "render",
+                "kind": "unknown",
+                "description": "Function to provide bespoke content when NOT using a Framework wrapper",
+                "uiLabel": "Render",
+                "isOptional": true
+            }
+        ]
+    },
     "CustomSort": {
         "name": "CustomSort",
         "kind": "Interface",
@@ -3691,6 +3861,13 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Defines a Custom ToolPanel - provided by Users and contains custom content",
         "properties": [
+            {
+                "name": "buttons",
+                "kind": "unknown",
+                "description": "Optional set of buttons to show in the ToolPanel",
+                "uiLabel": "Buttons",
+                "isOptional": true
+            },
             {
                 "name": "frameworkComponent",
                 "kind": "REFERENCE",
@@ -3718,13 +3895,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Title to display in Custom ToolPanel; if undefined, will default to `name` property",
                 "uiLabel": "Title",
                 "isOptional": true
-            },
-            {
-                "name": "toolPanelButtons",
-                "kind": "unknown",
-                "description": "Optional set of buttons to show in the ToolPanel",
-                "uiLabel": "Tool Panel Buttons",
-                "isOptional": true
             }
         ]
     },
@@ -5113,6 +5283,99 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "The javascript function which is invoked by an AdapTableQL Function"
     },
+    "ExpressionOptions": {
+        "name": "ExpressionOptions",
+        "kind": "Interface",
+        "description": "Options for managing Expressions using AdapTableQL",
+        "properties": [
+            {
+                "name": "defaultAggregatedBooleanFunctions",
+                "kind": "REFERENCE",
+                "description": "Aggregated Boolean Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Aggregated Boolean Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultAggregatedScalarFunctions",
+                "kind": "REFERENCE",
+                "description": "Aggregated Scalar Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Aggregated Scalar Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultBooleanFunctions",
+                "kind": "REFERENCE",
+                "description": "Boolean Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Boolean Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultObservableFunctions",
+                "kind": "REFERENCE",
+                "description": "Observable Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Observable Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "defaultScalarFunctions",
+                "kind": "REFERENCE",
+                "description": "Scalar Expression Functions available in AdapTableQL",
+                "uiLabel": "Default Scalar Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null (sets all)",
+                "reference": "unknown"
+            },
+            {
+                "name": "maxTimeframeSize",
+                "kind": "number",
+                "description": "Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",
+                "uiLabel": "Max Timeframe Size",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "28800000 (~8 hours)"
+            },
+            {
+                "name": "moduleExpressionFunctions",
+                "kind": "unknown",
+                "description": "Module specific ExpressionFunctions; if not defined, it falls back to the defined default values",
+                "uiLabel": "Module Expression Functions",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined (defaults to default values)"
+            },
+            {
+                "name": "performExpressionValidation",
+                "kind": "boolean",
+                "description": "Validate Expressions before they can be run or saved",
+                "uiLabel": "Perform Expression Validation",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "true"
+            },
+            {
+                "name": "queryableColumns",
+                "kind": "unknown",
+                "description": "Columns that can be included in AdapTableQL Expressions; leave unset to include **ALL**, provide empty array to set **NONE**",
+                "uiLabel": "Queryable Columns",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "undefined"
+            }
+        ]
+    },
     "FDC3Context": {
         "name": "FDC3Context",
         "kind": "Interface",
@@ -5419,6 +5682,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "2,000"
             },
+            {
+                "name": "quickFilterHeight",
+                "kind": "number",
+                "description": "TODO: add comment",
+                "uiLabel": "Quick Filter Height",
+                "isOptional": true
+            },
             {
                 "name": "quickFilterTrigger",
                 "kind": "unknown",
@@ -5810,7 +6080,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Applies Gradient, Percent Bar or CheckBox style to a Column",
                 "uiLabel": "Column Style",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "ColumnStyle"
             },
             {
                 "name": "DisplayFormat",
@@ -6255,15 +6525,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "true"
             },
-            {
-                "name": "caseSensitiveTextComparisons",
-                "kind": "boolean",
-                "description": "Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",
-                "uiLabel": "Case Sensitive Text Comparisons",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "false"
-            },
             {
                 "name": "cellSummaryOperations",
                 "kind": "unknown",
@@ -6565,6 +6826,28 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "GradientStyle": {
+        "name": "GradientStyle",
+        "kind": "Interface",
+        "description": "Used to display Gradient Styles in Format Column",
+        "properties": [
+            {
+                "name": "CellRanges",
+                "kind": "unknown",
+                "description": "Ranges (e.g. to allow a traffic light effect)",
+                "uiLabel": "Cell Ranges",
+                "isOptional": true
+            },
+            {
+                "name": "ColumnComparison",
+                "kind": "REFERENCE",
+                "description": "Compares cell values to another Column",
+                "uiLabel": "Column Comparison",
+                "isOptional": true,
+                "reference": "ColumnComparison"
+            }
+        ]
+    },
     "GridApi": {
         "name": "GridApi",
         "kind": "Interface",
@@ -6963,9 +7246,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "selectCellRange",
                 "kind": "function",
-                "description": "Selects a group of cells in a given range",
+                "description": "Selects a group of cells in a given range - provide either primary keys or row indexes",
                 "uiLabel": "Select Cell Range"
             },
+            {
+                "name": "selectColumn",
+                "kind": "function",
+                "description": "Selects a Column in AG Grid",
+                "uiLabel": "Select Column"
+            },
+            {
+                "name": "selectColumns",
+                "kind": "function",
+                "description": "Selects Columns in AG Grid",
+                "uiLabel": "Select Columns"
+            },
             {
                 "name": "selectNode",
                 "kind": "function",
@@ -8434,6 +8729,52 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Internal State used by AdapTable for managing the OpenFin plugin"
     },
+    "PercentBarStyle": {
+        "name": "PercentBarStyle",
+        "kind": "Interface",
+        "description": "Style used to display Percent Bars in Format Column",
+        "properties": [
+            {
+                "name": "BackColor",
+                "kind": "string",
+                "description": "Back colour - only used for 'Percent Bar' Numeric style; leave unset if none required",
+                "uiLabel": "Back Color",
+                "isOptional": true,
+                "defaultValue": "Gray"
+            },
+            {
+                "name": "CellRanges",
+                "kind": "unknown",
+                "description": "Ranges (e.g. to allow a traffic light effect)",
+                "uiLabel": "Cell Ranges",
+                "isOptional": true
+            },
+            {
+                "name": "CellText",
+                "kind": "REFERENCE",
+                "description": "Whether Cell shows Cell Value, Percent Value, both or none",
+                "uiLabel": "Cell Text",
+                "isOptional": true,
+                "reference": "unknown"
+            },
+            {
+                "name": "ColumnComparison",
+                "kind": "REFERENCE",
+                "description": "Compares cell values to another Column",
+                "uiLabel": "Column Comparison",
+                "isOptional": true,
+                "reference": "ColumnComparison"
+            },
+            {
+                "name": "ToolTipText",
+                "kind": "REFERENCE",
+                "description": "Whether Tooltip shows Cell Value, Percent Value, both or none",
+                "uiLabel": "Tool Tip Text",
+                "isOptional": true,
+                "reference": "unknown"
+            }
+        ]
+    },
     "PermittedValues": {
         "name": "PermittedValues",
         "kind": "Interface",
@@ -8596,7 +8937,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Rule",
                 "kind": "REFERENCE",
-                "description": "(Optional) Boolean Query to determine whether to apply the Nudge",
+                "description": "(Optional) Boolean Expression to determine whether to apply the Nudge",
                 "uiLabel": "Rule",
                 "isOptional": true,
                 "reference": "unknown"
@@ -8930,7 +9271,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "getCurrentQuery",
                 "kind": "function",
-                "description": "Retuns the Current Query",
+                "description": "Returns the Current Query",
                 "uiLabel": "Get Current Query"
             },
             {
@@ -8988,6 +9329,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Manages AdapTableQL (Query Language)",
         "properties": [
+            {
+                "name": "getAdaptableQueryExpression",
+                "kind": "function",
+                "description": "Returns the Expression string of the given AdaptableQuery, which may be either a Boolean, an AggregatedBoolean, a Scalar, an AggregatedScalar or an ObservableExpression expression",
+                "uiLabel": "Get Adaptable Query Expression"
+            },
             {
                 "name": "getASTForExpression",
                 "kind": "function",
@@ -9018,6 +9365,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Whether the given AggregatedBooleanExpression is valid",
                 "uiLabel": "Is Valid Aggregated Boolean Expression"
             },
+            {
+                "name": "isValidAggregatedScalarExpression",
+                "kind": "function",
+                "description": "Whether the given AggregatedScalarExpression is valid",
+                "uiLabel": "Is Valid Aggregated Scalar Expression"
+            },
             {
                 "name": "isValidBooleanExpression",
                 "kind": "function",
@@ -9032,89 +9385,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "QueryLanguageOptions": {
-        "name": "QueryLanguageOptions",
-        "kind": "Interface",
-        "description": "Options for managing Expressions using AdapTableQL",
-        "properties": [
-            {
-                "name": "defaultAggregatedBooleanFunctions",
-                "kind": "REFERENCE",
-                "description": "Aggregated Boolean Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Aggregated Boolean Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultBooleanFunctions",
-                "kind": "REFERENCE",
-                "description": "Boolean Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Boolean Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultObservableFunctions",
-                "kind": "REFERENCE",
-                "description": "Observable Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Observable Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "defaultScalarFunctions",
-                "kind": "REFERENCE",
-                "description": "Scalar Expression Functions available in AdapTableQL",
-                "uiLabel": "Default Scalar Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "null (sets all)",
-                "reference": "unknown"
-            },
-            {
-                "name": "maxTimeframeSize",
-                "kind": "number",
-                "description": "Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",
-                "uiLabel": "Max Timeframe Size",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "28800000 (~8 hours)"
-            },
-            {
-                "name": "moduleExpressionFunctions",
-                "kind": "unknown",
-                "description": "Module specific ExpressionFunctions; if not defined, it falls back to the defined default values",
-                "uiLabel": "Module Expression Functions",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined (defaults to default values)"
-            },
-            {
-                "name": "performExpressionValidation",
-                "kind": "boolean",
-                "description": "Validate Expressions before they can be run or saved",
-                "uiLabel": "Perform Expression Validation",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "true"
-            },
-            {
-                "name": "queryableColumns",
-                "kind": "unknown",
-                "description": "Columns that can be included in AdapTableQL Expressions; leave unset to include **ALL**, provide empty array to set **NONE**",
-                "uiLabel": "Queryable Columns",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined"
-            }
-        ]
-    },
     "QueryState": {
         "name": "QueryState",
         "kind": "Interface",
@@ -9885,16 +10155,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "'Search'"
-            },
-            {
-                "name": "serverSearchOptions",
-                "kind": "REFERENCE",
-                "description": "Which searching and filtering options, if any, should take place on server",
-                "uiLabel": "Server Search Options",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "undefined",
-                "reference": "unknown"
             }
         ]
     },
@@ -9959,13 +10219,13 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showCustomSettingsPanel",
                 "kind": "function",
-                "description": "Opens a the settings panel to the custom module",
+                "description": "Opens Settings Panel with the Custom Settings Panel, provided by name, displayed",
                 "uiLabel": "Show Custom Settings Panel"
             },
             {
                 "name": "showSettingsPanel",
                 "kind": "function",
-                "description": "Opens settings panel to specified module, when not specified it opens the first available module",
+                "description": "Opens Settings Panel and displays specified Module (if provided) or first available one",
                 "uiLabel": "Show Settings Panel"
             }
         ]
@@ -10011,7 +10271,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "Adaptable Module to which object belongs",
                 "uiLabel": "Module",
-                "reference": "unknown"
+                "reference": "AdaptableModule"
             },
             {
                 "name": "Revision",
@@ -10209,7 +10469,7 @@ exports.ADAPTABLE_METAMODEL = {
     "SpecialColumnSettings": {
         "name": "SpecialColumnSettings",
         "kind": "Interface",
-        "description": "Base Settings for SpecialColumns",
+        "description": "Base Settings for Calculated Columns and FreeText Columns",
         "properties": [
             {
                 "name": "Aggregatable",
@@ -10294,19 +10554,19 @@ exports.ADAPTABLE_METAMODEL = {
     "StateOptions": {
         "name": "StateOptions",
         "kind": "Interface",
-        "description": "Options related to state hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality.",
+        "description": "Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality",
         "properties": [
             {
                 "name": "applyState",
                 "kind": "unknown",
-                "description": "Allows hooking into AdaptableState hydration",
+                "description": "Allows hooking into Adaptable State hydration",
                 "uiLabel": "Apply State",
                 "isOptional": true
             },
             {
                 "name": "clearState",
                 "kind": "REFERENCE",
-                "description": "Allows clearing of remote state.",
+                "description": "Allows clearing of remote Adaptable State",
                 "uiLabel": "Clear State",
                 "isOptional": true,
                 "reference": "unknown"
@@ -10314,7 +10574,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "debounceStateDelay",
                 "kind": "number",
-                "description": "Delay (in ms) to debounce saveState/persistState calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",
+                "description": "Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",
                 "uiLabel": "Debounce State Delay",
                 "isOptional": true,
                 "defaultValue": "400"
@@ -10322,7 +10582,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "loadState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of state loading.",
+                "description": "Allows the customization of Adaptable State loading",
                 "uiLabel": "Load State",
                 "isOptional": true,
                 "reference": "AdaptableLoadStateFunction"
@@ -10330,7 +10590,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "persistState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of state persistence.",
+                "description": "Allows the customization of state persistence",
                 "uiLabel": "Persist State",
                 "isOptional": true,
                 "reference": "AdaptablePersistStateFunction"
@@ -10338,13 +10598,34 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "saveState",
                 "kind": "REFERENCE",
-                "description": "Allows the customization of the state that is going to be persisted",
+                "description": "Allows the customization of the Adaptable State that is going to be persisted",
                 "uiLabel": "Save State",
                 "isOptional": true,
                 "reference": "unknown"
             }
         ]
     },
+    "StringFormatterOptions": {
+        "name": "StringFormatterOptions",
+        "kind": "Interface",
+        "description": "Formatter Options for String Columns",
+        "properties": [
+            {
+                "name": "Case",
+                "kind": "unknown",
+                "description": "Sets text to Upper or Lower case",
+                "uiLabel": "Case",
+                "isOptional": true
+            },
+            {
+                "name": "Trim",
+                "kind": "boolean",
+                "description": "Trims text (both start and end)",
+                "uiLabel": "Trim",
+                "isOptional": true
+            }
+        ]
+    },
     "SuspendableObject": {
         "name": "SuspendableObject",
         "kind": "Interface",
@@ -10813,10 +11094,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "'AdapTable'"
             },
             {
-                "name": "customToolPanelButtons",
+                "name": "customButtons",
                 "kind": "unknown",
                 "description": "ToolPanel Buttons provided by Users which perform custom behaviour",
-                "uiLabel": "Custom Tool Panel Buttons",
+                "uiLabel": "Custom Buttons",
                 "isOptional": true
             },
             {
@@ -10911,6 +11192,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ToolPanelVisibilityMode": {
+        "name": "ToolPanelVisibilityMode",
+        "kind": "TypeAlias",
+        "description": "Whether a ToolPanel displays as expanded or collapsed"
+    },
     "UserInterfaceApi": {
         "name": "UserInterfaceApi",
         "kind": "Interface",