@adaptabletools/adaptable 11.0.0-canary.7 → 11.0.2-canary.0

package/src/metamodel/adaptable.metamodel.js

@@ -599,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"
             },
             {
@@ -889,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",
@@ -938,7 +943,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Options for managing AdapTableQL",
                 "uiLabel": "Adaptable QL Options",
                 "isOptional": true,
-                "reference": "unknown"
+                "reference": "AdaptableQLOptions"
             },
             {
                 "name": "adaptableStateKey",
@@ -1289,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",
@@ -1978,7 +2017,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "Adaptable Module to rename",
                 "uiLabel": "Adaptable Module",
-                "reference": "unknown"
+                "reference": "AdaptableModule"
             },
             {
                 "name": "newName",
@@ -2312,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",
@@ -2811,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",
@@ -2877,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",
@@ -2906,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"
@@ -3056,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
             }
@@ -3479,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",
@@ -3699,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",
@@ -3726,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
             }
         ]
     },
@@ -5520,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",
@@ -5911,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",
@@ -6657,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",
@@ -8538,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",
@@ -8700,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"
@@ -10034,7 +10271,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "REFERENCE",
                 "description": "Adaptable Module to which object belongs",
                 "uiLabel": "Module",
-                "reference": "unknown"
+                "reference": "AdaptableModule"
             },
             {
                 "name": "Revision",
@@ -10368,6 +10605,27 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "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",
@@ -10836,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
             },
             {
@@ -10934,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",

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.0-canary.7";
+declare const _default: "11.0.2-canary.0";
 export default _default;

package/version.js

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