@adaptabletools/adaptable 10.0.4-canary.0 → 10.0.4-canary.4

package/src/metamodel/adaptable.metamodel.js

@@ -69,7 +69,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "rowNode",
                 "kind": "REFERENCE",
-                "description": "Current Row Node",
+                "description": "Current AG Grid Row Node",
                 "uiLabel": "Row Node",
                 "reference": "unknown"
             }
@@ -107,7 +107,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "width",
                 "kind": "number",
-                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid",
+                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",
                 "uiLabel": "Width",
                 "isOptional": true
             }
@@ -477,7 +477,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AdaptableColumn": {
         "name": "AdaptableColumn",
         "kind": "Interface",
-        "description": "Defines an Adaptable Column - created at run-time based on vendor grid column definition",
+        "description": "Defines an Adaptable Column - created at run-time based on AG Grid column definition",
         "properties": [
             {
                 "name": "aggregatable",
@@ -615,7 +615,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "columnId",
                 "kind": "string",
-                "description": "Name of Column in underlying grid (e.g. field or colId)",
+                "description": "Name of Column in AG Grid (e.g. field or colId)",
                 "uiLabel": "Column Id"
             },
             {
@@ -627,7 +627,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "friendlyName",
                 "kind": "string",
-                "description": "How Column is referred to in Adaptable UI; 'Caption' or 'Header' property in underlying grid",
+                "description": "How Column is referred to in Adaptable UI; `Caption` property in AG Grid",
                 "uiLabel": "Friendly Name"
             }
         ]
@@ -841,21 +841,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "module",
                 "kind": "unknown",
-                "description": "Adaptable Module associated with (shipped) menu item.",
+                "description": "Adaptable Module associated with (Adaptable) menu item.",
                 "uiLabel": "Module",
                 "isOptional": true
             },
             {
                 "name": "onClick",
                 "kind": "unknown",
-                "description": "Function to invoice when (custom) menu item is clicked",
+                "description": "Function to invoke when (custom) menu item is clicked",
                 "uiLabel": "On Click",
                 "isOptional": true
             },
             {
                 "name": "reduxAction",
                 "kind": "unknown",
-                "description": "Adaptable Redux Action to invoke when (shipped) menu item is clicked",
+                "description": "Adaptable Redux Action to invoke when (Adaptable) menu item is clicked",
                 "uiLabel": "Redux Action",
                 "isOptional": true
             },
@@ -905,7 +905,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AdaptableOptions": {
         "name": "AdaptableOptions",
         "kind": "Interface",
-        "description": "Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides Vendor Grid, Predefined Config and other information required to ensure a full, rich user experience",
+        "description": "Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience",
         "properties": [
             {
                 "name": "adaptableId",
@@ -937,7 +937,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "containerOptions",
                 "kind": "REFERENCE",
-                "description": "Options for setting the 'Div' elements in which AdapTable, the underlying grid, popups and charts are placed",
+                "description": "Options for setting the 'Div' elements in which AdapTable, AG Grid, popups and charts are placed",
                 "uiLabel": "Container Options",
                 "isOptional": true,
                 "reference": "ContainerOptions"
@@ -1134,7 +1134,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "vendorGrid",
                 "kind": "unknown",
-                "description": "Underlying vendor grid or grid object which AdapTable interacts with. Note: if using React or Angular Wrapper, no need to populate this property (as `gridOptions` is a separate prop and AdapTable wires up everything)",
+                "description": "The AG Grid object which AdapTable interacts with. Note: if using React or Angular Wrapper, no need to populate this property (as `gridOptions` is a separate prop and AdapTable wires up everything)",
                 "uiLabel": "Vendor Grid",
                 "isOptional": true,
                 "defaultValue": "n/a (Mandatory)"
@@ -1154,14 +1154,14 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Inputs",
                 "kind": "unknown",
-                "description": "Optional inputs - needed to evaluate some Predicates (e.g. 'GreaterThan')",
+                "description": "Optional Inputs that might be needed for evaluation",
                 "uiLabel": "Inputs",
                 "isOptional": true
             },
             {
                 "name": "PredicateId",
                 "kind": "string",
-                "description": "Id of Predicate (e.g. 'Equals', 'GreaterThan')",
+                "description": "Id of Predicate (e.g. `Equals`, `GreaterThan`)",
                 "uiLabel": "Predicate Id"
             }
         ]
@@ -1213,13 +1213,13 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "moduleScope",
                 "kind": "unknown",
-                "description": "Adaptable Modules where Predicate can run",
+                "description": "Modules where Predicate can run: 'filter', 'alert', 'conditionalstyle'",
                 "uiLabel": "Module Scope"
             },
             {
                 "name": "onlyQuickFilter",
                 "kind": "boolean",
-                "description": "Wether to display this predicate only in QuickFilter (and NOT in Column Filter)",
+                "description": "Display this predicate only in Quick Filter Bar (and NOT in Filter Form)",
                 "uiLabel": "Only Quick Filter",
                 "isOptional": true
             },
@@ -1245,17 +1245,11 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Object returned by `AdaptableReady` event - fired when AdapTable has loaded",
         "properties": [
             {
-                "name": "adaptableApi",
+                "name": "gridOptions",
                 "kind": "REFERENCE",
-                "description": "Adaptable API object used for runtime programmatic access to AdapTable",
-                "uiLabel": "Adaptable Api",
-                "reference": "AdaptableApi"
-            },
-            {
-                "name": "vendorGrid",
-                "kind": "unknown",
-                "description": "Instance of the underlying vendor grid (e.g. for AG Grid its the GridOptions object)",
-                "uiLabel": "Vendor Grid"
+                "description": "Underlying AG Grid instance",
+                "uiLabel": "Grid Options",
+                "reference": "unknown"
             }
         ]
     },
@@ -1384,49 +1378,49 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "BackColor",
                 "kind": "string",
-                "description": "Colour background of cell - provide a hex value.",
+                "description": "Colour background of cell: provide hex value or name",
                 "uiLabel": "Back Color",
                 "isOptional": true
             },
             {
                 "name": "BorderColor",
                 "kind": "string",
-                "description": "Colour of cell border - provide a hex value.",
+                "description": "Colour of cell border: provide hex value or name",
                 "uiLabel": "Border Color",
                 "isOptional": true
             },
             {
                 "name": "ClassName",
                 "kind": "string",
-                "description": "Name of existing Css Class; use instead of setting other object properties",
+                "description": "Existing CSS Class; use instead of setting other object properties",
                 "uiLabel": "Class Name",
                 "isOptional": true
             },
             {
                 "name": "FontSize",
                 "kind": "unknown",
-                "description": "Size of font: 'XSmall', 'Small', 'Medium', 'Large' or 'XLarge'",
+                "description": "Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`",
                 "uiLabel": "Font Size",
                 "isOptional": true
             },
             {
                 "name": "FontStyle",
                 "kind": "unknown",
-                "description": "Style of the font: 'Normal' or 'Italic'",
+                "description": "Style of font: `Normal` or `Italic`",
                 "uiLabel": "Font Style",
                 "isOptional": true
             },
             {
                 "name": "FontWeight",
                 "kind": "unknown",
-                "description": "Whether font appears as 'Normal' or 'Bold'",
+                "description": "Weight of font: `Normal` or `Bold`",
                 "uiLabel": "Font Weight",
                 "isOptional": true
             },
             {
                 "name": "ForeColor",
                 "kind": "string",
-                "description": "Font colour in cell - provide a hex value.",
+                "description": "Font colour in cell: provide hex value or name",
                 "uiLabel": "Fore Color",
                 "isOptional": true
             }
@@ -1437,6 +1431,13 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Used for creating User (i.e. Custom) Themes",
         "properties": [
+            {
+                "name": "AgGridClassName",
+                "kind": "string",
+                "description": "Ag Grid theme to apply when loading theme",
+                "uiLabel": "Ag Grid Class Name",
+                "isOptional": true
+            },
             {
                 "name": "Description",
                 "kind": "string",
@@ -1452,7 +1453,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "VendorGridClassName",
                 "kind": "string",
-                "description": "Vendor Grid related css className to be applied",
+                "description": "deprecated use `AgGridClassName` property instead",
                 "uiLabel": "Vendor Grid Class Name",
                 "isOptional": true
             }
@@ -1823,7 +1824,7 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "MessageText",
-                "kind": "unknown",
+                "kind": "string",
                 "description": "Alert Message - can be string or function; if not provided AdapTable creates dynamically using Rule & Scope",
                 "uiLabel": "Message Text",
                 "isOptional": true
@@ -1908,7 +1909,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AlertState": {
         "name": "AlertState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Alert function",
+        "description": "Predefined Configuration for Alert Module",
         "properties": [
             {
                 "name": "AlertDefinitions",
@@ -2030,7 +2031,7 @@ exports.ADAPTABLE_METAMODEL = {
     "ApplicationState": {
         "name": "ApplicationState",
         "kind": "Interface",
-        "description": "Predefined Configuration for the Application function",
+        "description": "Predefined Configuration for the Application Module",
         "properties": [
             {
                 "name": "ApplicationDataEntries",
@@ -2274,7 +2275,7 @@ exports.ADAPTABLE_METAMODEL = {
     "CalculatedColumnState": {
         "name": "CalculatedColumnState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Calculated Column function",
+        "description": "Predefined Configuration for Calculated Column Module",
         "properties": [
             {
                 "name": "CalculatedColumns",
@@ -2547,6 +2548,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all Aggregatable Columns",
                 "uiLabel": "Get Aggregetable Columns"
             },
+            {
+                "name": "getAgGridColumnFieldForAdaptableColumn",
+                "kind": "function",
+                "description": "Retrieves AG Grid's field property for the column",
+                "uiLabel": "Get Ag Grid Column Field For Adaptable Column"
+            },
+            {
+                "name": "getAgGridColumnForAdaptableColumn",
+                "kind": "function",
+                "description": "Retrieves AG Grid's column for an Adaptable column",
+                "uiLabel": "Get Ag Grid Column For Adaptable Column"
+            },
+            {
+                "name": "getAgGridColumnType",
+                "kind": "function",
+                "description": "Retrieves 'ColumnType' property for a given Column",
+                "uiLabel": "Get Ag Grid Column Type"
+            },
             {
                 "name": "getAllColumnFriendlyNames",
                 "kind": "function",
@@ -2733,18 +2752,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all string Columns",
                 "uiLabel": "Get String Columns"
             },
-            {
-                "name": "getVendorColumnType",
-                "kind": "function",
-                "description": "Retrieves 'ColumnType' property for a given Column",
-                "uiLabel": "Get Vendor Column Type"
-            },
-            {
-                "name": "getVendorGridColumnFieldForColumn",
-                "kind": "function",
-                "description": "Retrieves the field property for the column",
-                "uiLabel": "Get Vendor Grid Column Field For Column"
-            },
             {
                 "name": "getVisibleColumns",
                 "kind": "function",
@@ -2863,12 +2870,39 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Predicate",
                 "kind": "REFERENCE",
-                "description": "Predicate function to evaluate when Filter is run",
+                "description": "`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run",
                 "uiLabel": "Predicate",
                 "reference": "unknown"
             }
         ]
     },
+    "ColumnMenuContext": {
+        "name": "ColumnMenuContext",
+        "kind": "Interface",
+        "description": "Provides full details about current Column where Column Header Menu will appear",
+        "properties": [
+            {
+                "name": "adaptableColumn",
+                "kind": "REFERENCE",
+                "description": "Current Adaptable Column",
+                "uiLabel": "Adaptable Column",
+                "reference": "AdaptableColumn"
+            },
+            {
+                "name": "agGridColumn",
+                "kind": "REFERENCE",
+                "description": "Current AG Grid Column",
+                "uiLabel": "Ag Grid Column",
+                "reference": "unknown"
+            },
+            {
+                "name": "isRowGroupColumn",
+                "kind": "boolean",
+                "description": "Whether current Column is Row Group",
+                "uiLabel": "Is Row Group Column"
+            }
+        ]
+    },
     "ColumnSort": {
         "name": "ColumnSort",
         "kind": "Interface",
@@ -2893,18 +2927,19 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Comparer object for Column Values - used for custom sorting",
         "properties": [
-            {
-                "name": "columnId",
-                "kind": "string",
-                "description": "Column for which to compare values",
-                "uiLabel": "Column Id"
-            },
             {
                 "name": "comparer",
                 "kind": "REFERENCE",
                 "description": "Comparer function to use",
                 "uiLabel": "Comparer",
                 "reference": "AdaptableComparerFunction"
+            },
+            {
+                "name": "scope",
+                "kind": "REFERENCE",
+                "description": "Column for which to compare values",
+                "uiLabel": "Scope",
+                "reference": "AdaptableScope"
             }
         ]
     },
@@ -3061,7 +3096,7 @@ exports.ADAPTABLE_METAMODEL = {
     "ConditionalStyleState": {
         "name": "ConditionalStyleState",
         "kind": "Interface",
-        "description": "Predefined Configuration for the Conditional Style function",
+        "description": "Predefined Configuration for the Conditional Style Module",
         "properties": [
             {
                 "name": "ConditionalStyles",
@@ -3329,6 +3364,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": ""adaptable""
             },
+            {
+                "name": "agGridContainer",
+                "kind": "unknown",
+                "description": "Div containing AG Grid instance - string Id or HTMLElement",
+                "uiLabel": "Ag Grid Container",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": ""grid""
+            },
+            {
+                "name": "agGridContainerWaitTimeout",
+                "kind": "number",
+                "description": "how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by React or Angular Wrappers)",
+                "uiLabel": "Ag Grid Container Wait Timeout",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "60s"
+            },
             {
                 "name": "alertContainer",
                 "kind": "unknown",
@@ -3364,24 +3417,92 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "undefined"
+            }
+        ]
+    },
+    "ContextMenuContext": {
+        "name": "ContextMenuContext",
+        "kind": "Interface",
+        "description": "Provides full details about current cell (and selected cells) where Context Menu will appear",
+        "properties": [
+            {
+                "name": "adaptableApi",
+                "kind": "REFERENCE",
+                "description": "The Adaptable Api - included as a convenience",
+                "uiLabel": "Adaptable Api",
+                "reference": "AdaptableApi"
+            },
+            {
+                "name": "adaptableColumn",
+                "kind": "REFERENCE",
+                "description": "Current Adaptable Column",
+                "uiLabel": "Adaptable Column",
+                "reference": "AdaptableColumn"
             },
             {
-                "name": "vendorContainer",
+                "name": "agGridColumn",
+                "kind": "REFERENCE",
+                "description": "Current AG Grid Column",
+                "uiLabel": "Ag Grid Column",
+                "reference": "unknown"
+            },
+            {
+                "name": "gridCell",
+                "kind": "REFERENCE",
+                "description": "Cell that has been clicked; contains cell value",
+                "uiLabel": "Grid Cell",
+                "reference": "GridCell"
+            },
+            {
+                "name": "isGroupedNode",
+                "kind": "boolean",
+                "description": "Whether current AG Grid row node is grouped",
+                "uiLabel": "Is Grouped Node"
+            },
+            {
+                "name": "isRowGroupColumn",
+                "kind": "boolean",
+                "description": "Whether current Column is Row Grouped",
+                "uiLabel": "Is Row Group Column"
+            },
+            {
+                "name": "isSelectedCell",
+                "kind": "boolean",
+                "description": "Whether cell that was clicked is also currently selected",
+                "uiLabel": "Is Selected Cell"
+            },
+            {
+                "name": "isSingleSelectedColumn",
+                "kind": "boolean",
+                "description": "Whether Column that was clicked is only column with selected cells",
+                "uiLabel": "Is Single Selected Column"
+            },
+            {
+                "name": "primaryKeyValue",
                 "kind": "unknown",
-                "description": "Div containing underlying vendor grid- string Id or HTMLElement",
-                "uiLabel": "Vendor Container",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": ""grid""
+                "description": "Value of Primary Key column in current row",
+                "uiLabel": "Primary Key Value"
             },
             {
-                "name": "vendorContainerWaitTimeout",
-                "kind": "number",
-                "description": "Useful when the vendor grid is instantiated separately (eg: by vendor wrappers like React and Angular flavors). This is how long AdapTable waits for the vendor grid before giving up connecting to it.",
-                "uiLabel": "Vendor Container Wait Timeout",
-                "isOptional": true,
-                "gridInfo": "item",
-                "defaultValue": "60s"
+                "name": "rowNode",
+                "kind": "REFERENCE",
+                "description": "Current AG Grid row node",
+                "uiLabel": "Row Node",
+                "reference": "unknown"
+            },
+            {
+                "name": "selectedCellInfo",
+                "kind": "REFERENCE",
+                "description": "Currently selected cells in the grid",
+                "uiLabel": "Selected Cell Info",
+                "reference": "SelectedCellInfo"
+            },
+            {
+                "name": "selectedRowInfo",
+                "kind": "REFERENCE",
+                "description": "Currently selected rows in the grid",
+                "uiLabel": "Selected Row Info",
+                "reference": "SelectedRowInfo"
             }
         ]
     },
@@ -3544,7 +3665,7 @@ exports.ADAPTABLE_METAMODEL = {
     "CustomSortState": {
         "name": "CustomSortState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Custom Sort function",
+        "description": "Predefined Configuration for Custom Sort Module",
         "properties": [
             {
                 "name": "CustomSorts",
@@ -4132,7 +4253,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "rowNode",
                 "kind": "REFERENCE",
-                "description": "RowNode that contains the cell (an AG Grid object)",
+                "description": "AG Grid RowNode that contains the cell",
                 "uiLabel": "Row Node",
                 "isOptional": true,
                 "reference": "unknown"
@@ -4204,10 +4325,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "false"
             },
             {
-                "name": "filterDataChange",
+                "name": "showDataChange",
                 "kind": "unknown",
                 "description": "Function enabling specific data changes to be included/excluded from the Data Change History",
-                "uiLabel": "Filter Data Change",
+                "uiLabel": "Show Data Change",
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "undefined (all data changes are logged)"
@@ -4310,7 +4431,7 @@ exports.ADAPTABLE_METAMODEL = {
     "DataSourceState": {
         "name": "DataSourceState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Data Source function",
+        "description": "Predefined Configuration for Data Source Module",
         "properties": [
             {
                 "name": "CurrentDataSource",
@@ -4447,7 +4568,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "isCellEditable",
                 "kind": "unknown",
-                "description": "Function which returns true if given cell is editable",
+                "description": "Function which checks if given Grid Cell is editable",
                 "uiLabel": "Is Cell Editable",
                 "isOptional": true
             },
@@ -4927,7 +5048,7 @@ exports.ADAPTABLE_METAMODEL = {
     "ExportState": {
         "name": "ExportState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Export function",
+        "description": "Predefined Configuration for Export Module",
         "properties": [
             {
                 "name": "CurrentDestination",
@@ -5268,7 +5389,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "autoApplyFilter",
                 "kind": "boolean",
-                "description": "Apply selected filters in Filter Form as soon as they are clicked; if false an Apply Filter button is displayed",
+                "description": "Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed",
                 "uiLabel": "Auto Apply Filter",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5349,7 +5470,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "hideQuickFilterDropdown",
                 "kind": "unknown",
-                "description": "Sets whether to display Dropdown in Quick Filter Bar for given Column",
+                "description": "Hides the Dropdown in Quick Filter Bar for a given Column",
                 "uiLabel": "Hide Quick Filter Dropdown",
                 "isOptional": true,
                 "defaultValue": "undefined"
@@ -5357,7 +5478,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "hideQuickFilterInput",
                 "kind": "unknown",
-                "description": "Sets whether to display the Input in Quick Filter Bar for given Column",
+                "description": "Hides the Input in Quick Filter Bar for a given Column",
                 "uiLabel": "Hide Quick Filter Input",
                 "isOptional": true,
                 "defaultValue": "undefined"
@@ -5410,7 +5531,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "systemFilters",
                 "kind": "REFERENCE",
-                "description": "Which Adaptable System Filter Predicates are available; provide empty array for none or leave unset for all",
+                "description": "Which Adaptable System Filter Predicates are available",
                 "uiLabel": "System Filters",
                 "isOptional": true,
                 "reference": "unknown"
@@ -5418,7 +5539,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "useAdaptableFilterForm",
                 "kind": "unknown",
-                "description": "Uses Adaptable's Filter Form in Column header menu for all columns if 'true' (the default) or those listed; otherwise vendor grid one will be used",
+                "description": "Uses Adaptable's Filter Form in Column header menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form",
                 "uiLabel": "Use Adaptable Filter Form",
                 "isOptional": true,
                 "defaultValue": "true"
@@ -5426,17 +5547,17 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "useAdaptableQuickFilter",
                 "kind": "unknown",
-                "description": "Use Adaptable's Quick Filter for all columns if 'true' (the default) or those listed; otherwise vendor grid one will be used",
+                "description": "Use Adaptable's Quick Filter for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",
                 "uiLabel": "Use Adaptable Quick Filter",
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "true"
             },
             {
-                "name": "useVendorFilterFormStyle",
+                "name": "useAgGridFilterFormStyle",
                 "kind": "boolean",
-                "description": "Styles Adaptable Filter Form to match styling of current vendor grid",
-                "uiLabel": "Use Vendor Filter Form Style",
+                "description": "Styles Adaptable Filter Form to match AG Grid's current styling",
+                "uiLabel": "Use Ag Grid Filter Form Style",
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "true"
@@ -5449,10 +5570,10 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Used to define values inside the floating filter and floating filter (quick filter)",
         "properties": [
             {
-                "name": "suppressClientSideFiltering",
+                "name": "suppressFilterSearchBar",
                 "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",
+                "uiLabel": "Suppress Filter Search Bar",
                 "isOptional": true
             }
         ]
@@ -5472,7 +5593,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "IsQuickFilterVisible",
                 "kind": "boolean",
-                "description": "Whether to display Quick Filter Bar - at least one column must have Quick Filter set to true",
+                "description": "Whether to display Quick Filter Bar between Column Header and the Grid",
                 "uiLabel": "Is Quick Filter Visible",
                 "isOptional": true,
                 "defaultValue": "true"
@@ -5838,7 +5959,7 @@ exports.ADAPTABLE_METAMODEL = {
     "FormatColumnState": {
         "name": "FormatColumnState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Format Column function",
+        "description": "Predefined Configuration for Format Column Module",
         "properties": [
             {
                 "name": "FormatColumns",
@@ -6000,7 +6121,7 @@ exports.ADAPTABLE_METAMODEL = {
     "FreeTextColumnState": {
         "name": "FreeTextColumnState",
         "kind": "Interface",
-        "description": "Predefined Configuration for the Free Text Column function",
+        "description": "Predefined Configuration for the Free Text Column Module",
         "properties": [
             {
                 "name": "FreeTextColumns",
@@ -6033,7 +6154,7 @@ exports.ADAPTABLE_METAMODEL = {
     "GeneralOptions": {
         "name": "GeneralOptions",
         "kind": "Interface",
-        "description": "General options for configuring AdapTable including managing Primary Keys.",
+        "description": "General options for configuring AdapTable including managing Primary Keys",
         "properties": [
             {
                 "name": "alternativeModuleNames",
@@ -6370,7 +6491,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "addGridData",
                 "kind": "function",
-                "description": "Adds rows to Adaptable (and underlying grid)",
+                "description": "Adds rows to Adaptable (and AG Grid)",
                 "uiLabel": "Add Grid Data"
             },
             {
@@ -6412,7 +6533,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "deleteGridData",
                 "kind": "function",
-                "description": "Deletes rows from Adaptable (and underlying grid)",
+                "description": "Deletes rows from Adaptable (and AG Grid)",
                 "uiLabel": "Delete Grid Data"
             },
             {
@@ -6466,13 +6587,13 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "fireCellChangedEvent",
                 "kind": "function",
-                "description": "Fires Grid Data Changed Event - when any data in vendor grid data set has changed",
+                "description": "Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed",
                 "uiLabel": "Fire Cell Changed Event"
             },
             {
                 "name": "fireGridDataChangedEvent",
                 "kind": "function",
-                "description": "Fires Grid Data Changed Event - when any data in vendor grid data set has changed",
+                "description": "Fires Grid Data Changed Event - when a row has changed in AG Grid",
                 "uiLabel": "Fire Grid Data Changed Event"
             },
             {
@@ -6481,6 +6602,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Fires Search Changed Event - typically used to enable server searching and filtering",
                 "uiLabel": "Fire Search Changed Event"
             },
+            {
+                "name": "getAgGridInstance",
+                "kind": "function",
+                "description": "Returns Ag Grid instance (passed into Adaptable Options at start-up)",
+                "uiLabel": "Get Ag Grid Instance"
+            },
             {
                 "name": "getCellDisplayValue",
                 "kind": "function",
@@ -6625,12 +6752,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all current Selected Rows in AdapTable",
                 "uiLabel": "Get Selected Row Info"
             },
-            {
-                "name": "getVendorGrid",
-                "kind": "function",
-                "description": "Returns underlying Vendor Grid (object passed into Adaptable Options at start-up)",
-                "uiLabel": "Get Vendor Grid"
-            },
             {
                 "name": "getVisibleColumnCount",
                 "kind": "function",
@@ -6832,7 +6953,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "updateGridData",
                 "kind": "function",
-                "description": "Updates Adaptable (and underlying grid) with rows that have changed",
+                "description": "Updates Adaptable (and AG Grid) with rows that have changed",
                 "uiLabel": "Update Grid Data"
             }
         ]
@@ -7555,6 +7676,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Saves given Layout into Adaptable State",
                 "uiLabel": "Save Layout"
             },
+            {
+                "name": "setColumnCaption",
+                "kind": "function",
+                "description": "Sets a new Caption / Header for a Column (this Layout only)",
+                "uiLabel": "Set Column Caption"
+            },
             {
                 "name": "setLayout",
                 "kind": "function",
@@ -7657,7 +7784,7 @@ exports.ADAPTABLE_METAMODEL = {
     "LayoutState": {
         "name": "LayoutState",
         "kind": "Interface",
-        "description": "Predefined Configuration for the Layout function",
+        "description": "Predefined Configuration for the Layout Module",
         "properties": [
             {
                 "name": "CurrentLayout",
@@ -7729,92 +7856,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "MenuContext": {
-        "name": "MenuContext",
-        "kind": "Interface",
-        "description": "Provides full details about current Menu; used for both Column and Context Menus",
-        "properties": [
-            {
-                "name": "adaptableApi",
-                "kind": "REFERENCE",
-                "description": "The Adaptable Api - included as a convenience",
-                "uiLabel": "Adaptable Api",
-                "reference": "AdaptableApi"
-            },
-            {
-                "name": "adaptableColumn",
-                "kind": "REFERENCE",
-                "description": "Current Adaptable Column",
-                "uiLabel": "Adaptable Column",
-                "reference": "AdaptableColumn"
-            },
-            {
-                "name": "gridCell",
-                "kind": "REFERENCE",
-                "description": "Cell that has been clicked; contains cell value",
-                "uiLabel": "Grid Cell",
-                "reference": "GridCell"
-            },
-            {
-                "name": "isGroupedNode",
-                "kind": "boolean",
-                "description": "Whether current row node is grouped",
-                "uiLabel": "Is Grouped Node"
-            },
-            {
-                "name": "isRowGroupColumn",
-                "kind": "boolean",
-                "description": "Whether current Column is Row Group",
-                "uiLabel": "Is Row Group Column"
-            },
-            {
-                "name": "isSelectedCell",
-                "kind": "boolean",
-                "description": "Whether cell that was clicked is also currently selected",
-                "uiLabel": "Is Selected Cell"
-            },
-            {
-                "name": "isSingleSelectedColumn",
-                "kind": "boolean",
-                "description": "Whether Column that was clicked is only column with selected cells",
-                "uiLabel": "Is Single Selected Column"
-            },
-            {
-                "name": "primaryKeyValue",
-                "kind": "unknown",
-                "description": "Value of Primary Key column in current row",
-                "uiLabel": "Primary Key Value"
-            },
-            {
-                "name": "rowNode",
-                "kind": "REFERENCE",
-                "description": "Current AG Grid row node",
-                "uiLabel": "Row Node",
-                "reference": "unknown"
-            },
-            {
-                "name": "selectedCellInfo",
-                "kind": "REFERENCE",
-                "description": "Currently selected cells in the grid",
-                "uiLabel": "Selected Cell Info",
-                "reference": "SelectedCellInfo"
-            },
-            {
-                "name": "selectedRowInfo",
-                "kind": "REFERENCE",
-                "description": "Currently selected rows in the grid",
-                "uiLabel": "Selected Row Info",
-                "reference": "SelectedRowInfo"
-            },
-            {
-                "name": "vendorColumn",
-                "kind": "REFERENCE",
-                "description": "Current Vendor Grid Column",
-                "uiLabel": "Vendor Column",
-                "reference": "unknown"
-            }
-        ]
-    },
     "MenuOptions": {
         "name": "MenuOptions",
         "kind": "Interface",
@@ -7830,11 +7871,11 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "columnMenuOrder",
                 "kind": "unknown",
-                "description": "Order in which Vendor, AdapTable and User Menu items will appear in Column Menu",
+                "description": "Order in which AG Grid, AdapTable and User Menu items will appear in Column Menu",
                 "uiLabel": "Column Menu Order",
                 "isOptional": true,
                 "gridInfo": "item",
-                "defaultValue": "'vendor', 'adaptable', 'user'"
+                "defaultValue": "'aggrid', 'adaptable', 'user'"
             },
             {
                 "name": "contextMenuItems",
@@ -7846,11 +7887,11 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "contextMenuOrder",
                 "kind": "unknown",
-                "description": "Order in which Vendor, AdapTable and User Menu items will appear in Context Menu",
+                "description": "Order in which AG grid, AdapTable and User Menu items will appear in Context Menu",
                 "uiLabel": "Context Menu Order",
                 "isOptional": true,
                 "gridInfo": "item",
-                "defaultValue": "'vendor', 'adaptable', 'user'"
+                "defaultValue": "'aggrid', 'adaptable', 'user'"
             },
             {
                 "name": "showAdaptableColumnMenu",
@@ -7918,6 +7959,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Alert Forms",
                 "isOptional": true
             },
+            {
+                "name": "alertMessageText",
+                "kind": "unknown",
+                "description": "Function providing Message to display in Alert; if empty, AdapTable provides dynamically",
+                "uiLabel": "Alert Message Text",
+                "isOptional": true
+            },
             {
                 "name": "cellHighlightDuration",
                 "kind": "number",
@@ -8018,6 +8066,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "'BottomRight'",
                 "reference": "unknown"
             },
+            {
+                "name": "showApplicationIcon",
+                "kind": "boolean",
+                "description": "Displays the application icon in Notifications (if provided in `UserInterfaceOptions`)",
+                "uiLabel": "Show Application Icon",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
             {
                 "name": "showProgressBar",
                 "kind": "boolean",
@@ -8452,13 +8508,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "This is the main Predefined Config interface which developers will populate at design-time",
         "properties": [
-            {
-                "name": "ActionColumn",
-                "kind": "unknown",
-                "description": "",
-                "uiLabel": "Action Column",
-                "isOptional": true
-            },
             {
                 "name": "Alert",
                 "kind": "REFERENCE",
@@ -8483,13 +8532,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "CalculatedColumnState"
             },
-            {
-                "name": "CellSummary",
-                "kind": "unknown",
-                "description": "",
-                "uiLabel": "Cell Summary",
-                "isOptional": true
-            },
             {
                 "name": "Chart",
                 "kind": "REFERENCE",
@@ -8530,13 +8572,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "DataSourceState"
             },
-            {
-                "name": "Entitlements",
-                "kind": "unknown",
-                "description": "",
-                "uiLabel": "Entitlements",
-                "isOptional": true
-            },
             {
                 "name": "Export",
                 "kind": "REFERENCE",
@@ -8553,14 +8588,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "FilterState"
             },
-            {
-                "name": "FlashingCell",
-                "kind": "REFERENCE",
-                "description": "",
-                "uiLabel": "Flashing Cell",
-                "isOptional": true,
-                "reference": "unknown"
-            },
             {
                 "name": "FormatColumn",
                 "kind": "REFERENCE",
@@ -8577,14 +8604,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "FreeTextColumnState"
             },
-            {
-                "name": "GradientColumn",
-                "kind": "REFERENCE",
-                "description": "",
-                "uiLabel": "Gradient Column",
-                "isOptional": true,
-                "reference": "unknown"
-            },
             {
                 "name": "Layout",
                 "kind": "REFERENCE",
@@ -8593,14 +8612,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "LayoutState"
             },
-            {
-                "name": "PercentBar",
-                "kind": "REFERENCE",
-                "description": "",
-                "uiLabel": "Percent Bar",
-                "isOptional": true,
-                "reference": "unknown"
-            },
             {
                 "name": "PlusMinus",
                 "kind": "REFERENCE",
@@ -8649,13 +8660,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "SparklineColumnState"
             },
-            {
-                "name": "SystemStatus",
-                "kind": "unknown",
-                "description": "",
-                "uiLabel": "System Status",
-                "isOptional": true
-            },
             {
                 "name": "Theme",
                 "kind": "REFERENCE",
@@ -8671,21 +8675,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Tool Panel",
                 "isOptional": true,
                 "reference": "ToolPanelState"
-            },
-            {
-                "name": "UpdatedRow",
-                "kind": "REFERENCE",
-                "description": "",
-                "uiLabel": "Updated Row",
-                "isOptional": true,
-                "reference": "unknown"
-            },
-            {
-                "name": "UserInterface",
-                "kind": "unknown",
-                "description": "Section (only populated at Design Time) that manages UI-related elements in AdapTable",
-                "uiLabel": "User Interface",
-                "isOptional": true
             }
         ]
     },
@@ -9086,19 +9075,19 @@ exports.ADAPTABLE_METAMODEL = {
     "QuickSearchState": {
         "name": "QuickSearchState",
         "kind": "Interface",
-        "description": "Predefined Configuration for Quick Search function",
+        "description": "Predefined Configuration for Quick Search Module",
         "properties": [
             {
                 "name": "QuickSearchText",
                 "kind": "string",
-                "description": "Quick Search to run at start up (rarely set at design time)",
+                "description": "Last Quick Search that was run (and will run again at start up)",
                 "uiLabel": "Quick Search Text",
                 "isOptional": true
             },
             {
                 "name": "Style",
                 "kind": "REFERENCE",
-                "description": "Style to use for Quick Search; uses standard `AdaptableStyle` Object",
+                "description": "Style to use to highlight matching cells - uses common `AdaptableStyle` object",
                 "uiLabel": "Style",
                 "isOptional": true,
                 "reference": "AdaptableStyle"
@@ -9517,7 +9506,7 @@ exports.ADAPTABLE_METAMODEL = {
     "ScheduleState": {
         "name": "ScheduleState",
         "kind": "Interface",
-        "description": "Predefined Configuration for the Schedule function",
+        "description": "Predefined Configuration for the Schedule Module",
         "properties": [
             {
                 "name": "Glue42Schedules",
@@ -9898,10 +9887,9 @@ exports.ADAPTABLE_METAMODEL = {
         "properties": [
             {
                 "name": "Scope",
-                "kind": "REFERENCE",
+                "kind": "unknown",
                 "description": "On which numeric Columns the Rule is applied",
-                "uiLabel": "Scope",
-                "reference": "AdaptableScope"
+                "uiLabel": "Scope"
             },
             {
                 "name": "ShortcutKey",
@@ -9996,6 +9984,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ShortcutScopeDataType": {
+        "name": "ShortcutScopeDataType",
+        "kind": "TypeAlias",
+        "description": "Shortcut scope data type."
+    },
     "ShortcutState": {
         "name": "ShortcutState",
         "kind": "Interface",
@@ -10218,7 +10211,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "Width",
                 "kind": "number",
-                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid",
+                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",
                 "uiLabel": "Width",
                 "isOptional": true
             }
@@ -10415,7 +10408,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "fireTeamSharingEntityChangedEvent",
                 "kind": "function",
-                "description": "Fires the Team S",
+                "description": "Fires the Team Sharing Entity Changed Event",
                 "uiLabel": "Fire Team Sharing Entity Changed Event"
             },
             {
@@ -10580,13 +10573,13 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "loadDarkTheme",
                 "kind": "function",
-                "description": "Sets AdapTable Dark Theme - updates underlying vendor grid theme to match",
+                "description": "Sets AdapTable Dark Theme - updates the AG Grid theme to match",
                 "uiLabel": "Load Dark Theme"
             },
             {
                 "name": "loadLightTheme",
                 "kind": "function",
-                "description": "Sets AdapTable Light Theme - updates underlying vendor grid theme to match",
+                "description": "Sets AdapTable Light Theme - updates the AG Grid theme to match",
                 "uiLabel": "Load Light Theme"
             },
             {
@@ -10826,7 +10819,7 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Order of displayed ToolPanels in Sidebar",
                 "uiLabel": "Tool Panel Order",
                 "isOptional": true,
-                "defaultValue": "['filters', 'columns', 'AdaptableToolPanel']"
+                "defaultValue": "['filters', 'columns', 'adaptable']"
             },
             {
                 "name": "width",
@@ -11071,7 +11064,7 @@ exports.ADAPTABLE_METAMODEL = {
     "UserMenuItem": {
         "name": "UserMenuItem",
         "kind": "Interface",
-        "description": "Defines a Menu Item created at design-time, can be added to Column Header or Context Menu, and can contain sub items.",
+        "description": "Menu Item created at design-time which is added to Column Header or Context Menu, and can contain sub items",
         "properties": [
             {
                 "name": "disabled",
@@ -11090,7 +11083,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "icon",
                 "kind": "string",
-                "description": "Optional icon to show in the Menu Item",
+                "description": "Optional icon to show in the Column Menu Item",
                 "uiLabel": "Icon",
                 "isOptional": true
             },