@adaptabletools/adaptable 10.0.1 → 10.0.4-canary.1

package/src/metamodel/adaptable.metamodel.js

@@ -18,6 +18,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Button to display in the Column",
                 "uiLabel": "Action Column Button"
             },
+            {
+                "name": "actionColumnSettings",
+                "kind": "REFERENCE",
+                "description": "Additional optional properties for Column (e.g. filterable, resizable)",
+                "uiLabel": "Action Column Settings",
+                "isOptional": true,
+                "reference": "ActionColumnSettings"
+            },
             {
                 "name": "columnId",
                 "kind": "string",
@@ -67,6 +75,44 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "ActionColumnSettings": {
+        "name": "ActionColumnSettings",
+        "kind": "Interface",
+        "description": "Set of optional properties that define an Action Columns behaviour",
+        "properties": [
+            {
+                "name": "resizable",
+                "kind": "boolean",
+                "description": "Whether Column can be resized (by dragging column header edges)",
+                "uiLabel": "Resizable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "suppressMenu",
+                "kind": "boolean",
+                "description": "Whether no menu should be shown for this Column header.",
+                "uiLabel": "Suppress Menu",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
+            {
+                "name": "suppressMovable",
+                "kind": "boolean",
+                "description": "Whether if this Column should be movable via dragging",
+                "uiLabel": "Suppress Movable",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
+            {
+                "name": "width",
+                "kind": "number",
+                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid",
+                "uiLabel": "Width",
+                "isOptional": true
+            }
+        ]
+    },
     "ActionHandler": {
         "name": "ActionHandler",
         "kind": "TypeAlias",
@@ -434,27 +480,27 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Defines an Adaptable Column - created at run-time based on vendor grid column definition",
         "properties": [
             {
-                "name": "Aggregatable",
+                "name": "aggregatable",
                 "kind": "boolean",
                 "description": "Is Column able to display aggregations (e.g. 'sum') when grouped",
                 "uiLabel": "Aggregatable"
             },
             {
-                "name": "AggregationFunction",
+                "name": "aggregationFunction",
                 "kind": "string",
                 "description": "Custom aggregation function for the Column",
                 "uiLabel": "Aggregation Function",
                 "isOptional": true
             },
             {
-                "name": "AvailableAggregationFunctions",
+                "name": "availableAggregationFunctions",
                 "kind": "unknown",
                 "description": "Available aggregations for the Column",
                 "uiLabel": "Available Aggregation Functions",
                 "isOptional": true
             },
             {
-                "name": "ColumnGroup",
+                "name": "columnGroup",
                 "kind": "REFERENCE",
                 "description": "The parent column group, if the column belongs to one",
                 "uiLabel": "Column Group",
@@ -462,98 +508,98 @@ exports.ADAPTABLE_METAMODEL = {
                 "reference": "unknown"
             },
             {
-                "name": "Filterable",
+                "name": "filterable",
                 "kind": "boolean",
                 "description": "Is Column able to be filtered",
                 "uiLabel": "Filterable"
             },
             {
-                "name": "Flex",
+                "name": "flex",
                 "kind": "number",
                 "description": "Flex details of the column",
                 "uiLabel": "Flex",
                 "isOptional": true
             },
             {
-                "name": "Groupable",
+                "name": "groupable",
                 "kind": "boolean",
                 "description": "Can Column form a Row Group",
                 "uiLabel": "Groupable"
             },
             {
-                "name": "Hideable",
+                "name": "hideable",
                 "kind": "boolean",
                 "description": "Can Column be removed from the grid",
                 "uiLabel": "Hideable"
             },
             {
-                "name": "IsExcludedFromQuickSearch",
+                "name": "isExcludedFromQuickSearch",
                 "kind": "boolean",
                 "description": "Has colummn been excluded from Quick Search results",
                 "uiLabel": "Is Excluded From Quick Search"
             },
             {
-                "name": "IsFixed",
+                "name": "isFixed",
                 "kind": "boolean",
                 "description": "Is Column pinned or locked into position",
                 "uiLabel": "Is Fixed"
             },
             {
-                "name": "IsGrouped",
+                "name": "isGrouped",
                 "kind": "boolean",
                 "description": "Is Column currently grouped",
                 "uiLabel": "Is Grouped"
             },
             {
-                "name": "IsPrimaryKey",
+                "name": "isPrimaryKey",
                 "kind": "boolean",
                 "description": "Is this the Primary Key column",
                 "uiLabel": "Is Primary Key"
             },
             {
-                "name": "IsSparkline",
+                "name": "isSparkline",
                 "kind": "boolean",
                 "description": "Is it a Sparkline Column",
                 "uiLabel": "Is Sparkline"
             },
             {
-                "name": "Moveable",
+                "name": "moveable",
                 "kind": "boolean",
                 "description": "Can Column be moved at run-time to a new position",
                 "uiLabel": "Moveable"
             },
             {
-                "name": "Pivotable",
+                "name": "pivotable",
                 "kind": "boolean",
                 "description": "Can Column be used in a Pivot Grid",
                 "uiLabel": "Pivotable"
             },
             {
-                "name": "Queryable",
+                "name": "queryable",
                 "kind": "boolean",
                 "description": "Can the Column be in included in Queries / Expressions",
                 "uiLabel": "Queryable"
             },
             {
-                "name": "ReadOnly",
+                "name": "readOnly",
                 "kind": "boolean",
                 "description": "Is column editable",
                 "uiLabel": "Read Only"
             },
             {
-                "name": "Sortable",
+                "name": "sortable",
                 "kind": "boolean",
                 "description": "Is Column sortable",
                 "uiLabel": "Sortable"
             },
             {
-                "name": "Visible",
+                "name": "visible",
                 "kind": "boolean",
                 "description": "Is Column currently visible",
                 "uiLabel": "Visible"
             },
             {
-                "name": "Width",
+                "name": "width",
                 "kind": "number",
                 "description": "Column width",
                 "uiLabel": "Width",
@@ -567,19 +613,19 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Base class for Adaptable Column containing most important properties",
         "properties": [
             {
-                "name": "ColumnId",
+                "name": "columnId",
                 "kind": "string",
                 "description": "Name of Column in underlying grid (e.g. field or colId)",
                 "uiLabel": "Column Id"
             },
             {
-                "name": "DataType",
+                "name": "dataType",
                 "kind": "unknown",
                 "description": "DataType of the column",
                 "uiLabel": "Data Type"
             },
             {
-                "name": "FriendlyName",
+                "name": "friendlyName",
                 "kind": "string",
                 "description": "How Column is referred to in Adaptable UI; 'Caption' or 'Header' property in underlying grid",
                 "uiLabel": "Friendly Name"
@@ -1198,13 +1244,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Object returned by `AdaptableReady` event - fired when AdapTable has loaded",
         "properties": [
-            {
-                "name": "adaptableApi",
-                "kind": "REFERENCE",
-                "description": "Adaptable API object used for runtime programmatic access to AdapTable",
-                "uiLabel": "Adaptable Api",
-                "reference": "AdaptableApi"
-            },
             {
                 "name": "vendorGrid",
                 "kind": "unknown",
@@ -1775,6 +1814,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "AlertProperties"
             },
+            {
+                "name": "MessageText",
+                "kind": "string",
+                "description": "Alert Message - can be string or function; if not provided AdapTable creates dynamically using Rule & Scope",
+                "uiLabel": "Message Text",
+                "isOptional": true
+            },
             {
                 "name": "MessageType",
                 "kind": "REFERENCE",
@@ -2034,6 +2080,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "BulkUpdatePermittedValues": {
+        "name": "BulkUpdatePermittedValues",
+        "kind": "Interface",
+        "description": "User to define permitted values when updating cells via bulk update"
+    },
     "ButtonStyle": {
         "name": "ButtonStyle",
         "kind": "Interface",
@@ -2072,7 +2123,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "CalculatedColumnSettings",
                 "kind": "REFERENCE",
-                "description": "Addtional optional properties for Column (e.g. filterable, resizable)",
+                "description": "Additional optional properties for Column (e.g. filterable, resizable)",
                 "uiLabel": "Calculated Column Settings",
                 "isOptional": true,
                 "reference": "CalculatedColumnSettings"
@@ -2159,12 +2210,30 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all the references in the AdaptableState of the given CalculatedColumn",
                 "uiLabel": "Get Calculated Column Module References"
             },
+            {
+                "name": "getCalculatedColumnsReferencingColumnId",
+                "kind": "function",
+                "description": "Returns all Calculated Columns whose Expression contains the ColumnId",
+                "uiLabel": "Get Calculated Columns Referencing Column Id"
+            },
             {
                 "name": "getCalculatedColumnState",
                 "kind": "function",
                 "description": "Retrieves Calculated Column section from Adaptable State",
                 "uiLabel": "Get Calculated Column State"
             },
+            {
+                "name": "getReferencedColumnIdsForCalculatedColumn",
+                "kind": "function",
+                "description": "Gets any ColumnIds referenced in a Calculated Column",
+                "uiLabel": "Get Referenced Column Ids For Calculated Column"
+            },
+            {
+                "name": "getReferencedColumnIdsForCalculatedColumnId",
+                "kind": "function",
+                "description": "Gets any ColumnIds referenced in a Calculated Column",
+                "uiLabel": "Get Referenced Column Ids For Calculated Column Id"
+            },
             {
                 "name": "showCalculatedColumnPopup",
                 "kind": "function",
@@ -2178,53 +2247,13 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Set of optional properties that define a Calculated Column's behaviour",
         "properties": [
-            {
-                "name": "Aggregatable",
-                "kind": "boolean",
-                "description": "Whether Column can be used in an aggregation when grouping",
-                "uiLabel": "Aggregatable",
-                "isOptional": true,
-                "defaultValue": "true"
-            },
             {
                 "name": "DataType",
                 "kind": "unknown",
-                "description": "Expression's return value DataType; inferred by AdapTable but setable by User",
+                "description": "Expression's return value DataType; inferred by AdapTable but settable by User",
                 "uiLabel": "Data Type",
                 "isOptional": true
             },
-            {
-                "name": "Filterable",
-                "kind": "boolean",
-                "description": "Whether Column is filterable",
-                "uiLabel": "Filterable",
-                "isOptional": true,
-                "defaultValue": "true"
-            },
-            {
-                "name": "Groupable",
-                "kind": "boolean",
-                "description": "Whether Column can be grouped",
-                "uiLabel": "Groupable",
-                "isOptional": true,
-                "defaultValue": "true"
-            },
-            {
-                "name": "Pivotable",
-                "kind": "boolean",
-                "description": "Whether Column can be used when grid is in pivot mode",
-                "uiLabel": "Pivotable",
-                "isOptional": true,
-                "defaultValue": "true"
-            },
-            {
-                "name": "Resizable",
-                "kind": "boolean",
-                "description": "Whether Column can be resized (by dragging column header edges)",
-                "uiLabel": "Resizable",
-                "isOptional": true,
-                "defaultValue": "true"
-            },
             {
                 "name": "ShowToolTip",
                 "kind": "boolean",
@@ -2232,21 +2261,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Show Tool Tip",
                 "isOptional": true,
                 "defaultValue": "false"
-            },
-            {
-                "name": "Sortable",
-                "kind": "boolean",
-                "description": "Whether Column is sortable",
-                "uiLabel": "Sortable",
-                "isOptional": true,
-                "defaultValue": "true"
-            },
-            {
-                "name": "Width",
-                "kind": "number",
-                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid",
-                "uiLabel": "Width",
-                "isOptional": true
             }
         ]
     },
@@ -2393,6 +2407,11 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button"
     },
+    "CellValuesList": {
+        "name": "CellValuesList",
+        "kind": "TypeAlias",
+        "description": "Use PermittedValues instead"
+    },
     "ChartApi": {
         "name": "ChartApi",
         "kind": "Interface",
@@ -2599,12 +2618,30 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns all Date Columns",
                 "uiLabel": "Get Date Columns"
             },
+            {
+                "name": "getDistinctBulkUpdateDisplayValuesForColumn",
+                "kind": "function",
+                "description": "Gets all distinct column display values for bulk update.",
+                "uiLabel": "Get Distinct Bulk Update Display Values For Column"
+            },
+            {
+                "name": "getDistinctCustomSortDisplayValuesForColumn",
+                "kind": "function",
+                "description": "Gets all distinct column display values in for custom sort.",
+                "uiLabel": "Get Distinct Custom Sort Display Values For Column"
+            },
             {
                 "name": "getDistinctDisplayValuesForColumn",
                 "kind": "function",
                 "description": "Gets all distinct display values in the Column",
                 "uiLabel": "Get Distinct Display Values For Column"
             },
+            {
+                "name": "getDistinctFilterDisplayValuesForColumn",
+                "kind": "function",
+                "description": "Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter",
+                "uiLabel": "Get Distinct Filter Display Values For Column"
+            },
             {
                 "name": "getDistinctRawValuesForColumn",
                 "kind": "function",
@@ -2719,12 +2756,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Is Column an Action Column",
                 "uiLabel": "Is Action Column"
             },
+            {
+                "name": "isBooleanColumn",
+                "kind": "function",
+                "description": "Is Column Boolean",
+                "uiLabel": "Is Boolean Column"
+            },
             {
                 "name": "isCalculatedColumn",
                 "kind": "function",
                 "description": "Is Column a Calculated Column",
                 "uiLabel": "Is Calculated Column"
             },
+            {
+                "name": "isColumnReferencedInExpression",
+                "kind": "function",
+                "description": "Checks if a column is referenced in a given Expression",
+                "uiLabel": "Is Column Referenced In Expression"
+            },
             {
                 "name": "isDateColumn",
                 "kind": "function",
@@ -2778,6 +2827,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "kind": "function",
                 "description": "Makes a Column visible",
                 "uiLabel": "Show Column"
+            },
+            {
+                "name": "usesAdaptableFilterForm",
+                "kind": "function",
+                "description": "Does Column use AdapTable's Filter Form",
+                "uiLabel": "Uses Adaptable Filter Form"
+            },
+            {
+                "name": "usesAdaptableQuickFilter",
+                "kind": "function",
+                "description": "Does Column use AdapTable's Quick Filter",
+                "uiLabel": "Uses Adaptable Quick Filter"
             }
         ]
     },
@@ -3027,6 +3088,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Copies User State sections of Adaptable State to clipboard",
                 "uiLabel": "Copy User State To Clipboard"
             },
+            {
+                "name": "dispatchStateReadyAction",
+                "kind": "function",
+                "description": "Sent by each Module when it is Ready",
+                "uiLabel": "Dispatch State Ready Action"
+            },
             {
                 "name": "getAdaptableSearchState",
                 "kind": "function",
@@ -3201,6 +3268,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns given section of Adaptable State (as JSON or object)",
                 "uiLabel": "Get User State By State Key"
             },
+            {
+                "name": "incrementUerStateRevision",
+                "kind": "function",
+                "description": "Adds '1' to current revision number of State element",
+                "uiLabel": "Increment Uer State Revision"
+            },
             {
                 "name": "loadUserState",
                 "kind": "function",
@@ -3456,6 +3529,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CustomSortPermittedValues": {
+        "name": "CustomSortPermittedValues",
+        "kind": "Interface",
+        "description": "Custom column values for custom sort."
+    },
     "CustomSortState": {
         "name": "CustomSortState",
         "kind": "Interface",
@@ -4013,10 +4091,11 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Changed At"
             },
             {
-                "name": "columnId",
-                "kind": "string",
-                "description": "Id of the Column in which the cell is situated",
-                "uiLabel": "Column Id"
+                "name": "column",
+                "kind": "REFERENCE",
+                "description": "Column in which cell is situated",
+                "uiLabel": "Column",
+                "reference": "AdaptableColumn"
             },
             {
                 "name": "newValue",
@@ -4247,6 +4326,13 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Object passed into Adaptable Grid Api data management methods",
         "properties": [
+            {
+                "name": "addIndex",
+                "kind": "number",
+                "description": "Index where to add new rows",
+                "uiLabel": "Add Index",
+                "isOptional": true
+            },
             {
                 "name": "callback",
                 "kind": "unknown",
@@ -4257,7 +4343,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "runAsync",
                 "kind": "boolean",
-                "description": "Whether data should be updated aysnchoronously",
+                "description": "Whether data should be updated asynchronously",
                 "uiLabel": "Run Async",
                 "isOptional": true
             }
@@ -4332,6 +4418,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "EditLookUpPermittedValues": {
+        "name": "EditLookUpPermittedValues",
+        "kind": "Interface",
+        "description": "Used to define permitted values for inline column editor"
+    },
     "EditOptions": {
         "name": "EditOptions",
         "kind": "Interface",
@@ -5188,7 +5279,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "defaultDateColumnFilter",
                 "kind": "unknown",
-                "description": "Default filter type for date Columns in Quick Filter",
+                "description": "Default filter type for date Columns",
                 "uiLabel": "Default Date Column Filter",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5206,7 +5297,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "defaultNumericColumnFilter",
                 "kind": "unknown",
-                "description": "Default filter type for numeric Columns in Quick Filter",
+                "description": "Default filter type for numeric Columns",
                 "uiLabel": "Default Numeric Column Filter",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5215,7 +5306,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "defaultStringColumnFilter",
                 "kind": "unknown",
-                "description": "Default filter type for string Columns in Quick Filter",
+                "description": "Default filter type for string Columns",
                 "uiLabel": "Default String Column Filter",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5224,7 +5315,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "enableFilterOnSpecialColumns",
                 "kind": "boolean",
-                "description": "Allows filtering on Calculated, Action & FreeText columns",
+                "description": "Allows filtering on Calculated & FreeText columns",
                 "uiLabel": "Enable Filter On Special Columns",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -5291,6 +5382,15 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "'mouseenter'"
             },
+            {
+                "name": "quickFilterValuesTrigger",
+                "kind": "unknown",
+                "description": "Whether to open Quick Filter Values dropdown with mouse hover or click",
+                "uiLabel": "Quick Filter Values Trigger",
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "'mouseenter'"
+            },
             {
                 "name": "sortColumnValuesInFilter",
                 "kind": "boolean",
@@ -5336,6 +5436,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "FilterPermittedValues": {
+        "name": "FilterPermittedValues",
+        "kind": "Interface",
+        "description": "Used to define values inside the floating filter and floating filter (quick filter)",
+        "properties": [
+            {
+                "name": "suppressClientSideFiltering",
+                "kind": "boolean",
+                "description": "Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed   false",
+                "uiLabel": "Suppress Client Side Filtering",
+                "isOptional": true
+            }
+        ]
+    },
     "FilterState": {
         "name": "FilterState",
         "kind": "Interface",
@@ -5754,6 +5868,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Default Value",
                 "isOptional": true
             },
+            {
+                "name": "FreeTextColumnSettings",
+                "kind": "REFERENCE",
+                "description": "Additional optional properties for Column (e.g. filterable, resizable)",
+                "uiLabel": "Free Text Column Settings",
+                "isOptional": true,
+                "reference": "FreeTextColumnSettings"
+            },
             {
                 "name": "FreeTextStoredValues",
                 "kind": "unknown",
@@ -5863,6 +5985,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "FreeTextColumnSettings": {
+        "name": "FreeTextColumnSettings",
+        "kind": "Interface",
+        "description": "Set of optional properties that define a FreeText Columns behaviour"
+    },
     "FreeTextColumnState": {
         "name": "FreeTextColumnState",
         "kind": "Interface",
@@ -6401,6 +6528,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Get keys for any open rows in Row Grouping",
                 "uiLabel": "Get Expand Row Groups Keys"
             },
+            {
+                "name": "getFilteredData",
+                "kind": "function",
+                "description": "Retrieves filtered data from the grid",
+                "uiLabel": "Get Filtered Data"
+            },
             {
                 "name": "getFirstRowNode",
                 "kind": "function",
@@ -6419,6 +6552,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves Cell in given Row and Column",
                 "uiLabel": "Get Grid Cell From Row Node"
             },
+            {
+                "name": "getGridContainerElement",
+                "kind": "function",
+                "description": "Returns the Grid Container in which the Adaptable Instance is present",
+                "uiLabel": "Get Grid Container Element"
+            },
+            {
+                "name": "getGridData",
+                "kind": "function",
+                "description": "Retrieves all data from the grid",
+                "uiLabel": "Get Grid Data"
+            },
             {
                 "name": "getGridState",
                 "kind": "function",
@@ -6581,6 +6726,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Refresh Cells in AdapTable",
                 "uiLabel": "Refresh Cells"
             },
+            {
+                "name": "refreshRow",
+                "kind": "function",
+                "description": "Forces a render of a row",
+                "uiLabel": "Refresh Row"
+            },
             {
                 "name": "selectAll",
                 "kind": "function",
@@ -6623,6 +6774,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Sorts AdapTable using given Column Sorts",
                 "uiLabel": "Set Adaptable Sorting"
             },
+            {
+                "name": "setCellsValue",
+                "kind": "function",
+                "description": "Updates multiple cells",
+                "uiLabel": "Set Cells Value"
+            },
             {
                 "name": "setCellValue",
                 "kind": "function",
@@ -6679,10 +6836,11 @@ exports.ADAPTABLE_METAMODEL = {
         "description": "Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value",
         "properties": [
             {
-                "name": "columnId",
-                "kind": "string",
+                "name": "column",
+                "kind": "REFERENCE",
                 "description": "Column in which cell is situtated",
-                "uiLabel": "Column Id"
+                "uiLabel": "Column",
+                "reference": "AdaptableColumn"
             },
             {
                 "name": "displayValue",
@@ -7472,7 +7630,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "createDefaultLayout",
                 "kind": "boolean",
-                "description": "Whether a "Default Layout" will be created in addition to Layouts in Config (if none there, Default Layout is always created)",
+                "description": "Whether a "Default Layout" will be created in addition to Layouts provided in Config",
                 "uiLabel": "Create Default Layout",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -8142,6 +8300,20 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Internal State used by AdapTable for managing the OpenFin plugin"
     },
+    "PermittedValues": {
+        "name": "PermittedValues",
+        "kind": "Interface",
+        "description": "Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)",
+        "properties": [
+            {
+                "name": "values",
+                "kind": "unknown",
+                "description": "Values to display: either hardcoded list or a function",
+                "uiLabel": "Values",
+                "isOptional": true
+            }
+        ]
+    },
     "PluginsApi": {
         "name": "PluginsApi",
         "kind": "Interface",
@@ -8987,32 +9159,46 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Provides meta data about a Row in Adaptable",
         "properties": [
+            {
+                "name": "isDisplayed",
+                "kind": "boolean",
+                "description": "Is Row displayed (ie. filtered, not necessarily in viewport)",
+                "uiLabel": "Is Displayed",
+                "isOptional": true
+            },
             {
                 "name": "isExpanded",
                 "kind": "boolean",
-                "description": "Whether - if a Group Row - it is currently expanded",
+                "description": "Is Row expanded (if a group row)",
                 "uiLabel": "Is Expanded",
                 "isOptional": true
             },
             {
                 "name": "isGroup",
                 "kind": "boolean",
-                "description": "Whether Row is a Row Group",
+                "description": "Is Row grouped",
                 "uiLabel": "Is Group",
                 "isOptional": true
             },
             {
                 "name": "isMaster",
                 "kind": "boolean",
-                "description": "Whether Row is a Master Row (in a Master-Detail grid)",
+                "description": "Is Row a Master Row (in a Master-Detail grid)",
                 "uiLabel": "Is Master",
                 "isOptional": true
             },
             {
-                "name": "level",
+                "name": "isSelected",
+                "kind": "boolean",
+                "description": "Is Row selected",
+                "uiLabel": "Is Selected",
+                "isOptional": true
+            },
+            {
+                "name": "rowGroupLevel",
                 "kind": "number",
                 "description": "What level the Row is (if Row Grouping is active)",
-                "uiLabel": "Level",
+                "uiLabel": "Row Group Level",
                 "isOptional": true
             }
         ]
@@ -9953,6 +10139,84 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "SpecialColumnSettings": {
+        "name": "SpecialColumnSettings",
+        "kind": "Interface",
+        "description": "Base Settings for SpecialColumns",
+        "properties": [
+            {
+                "name": "Aggregatable",
+                "kind": "boolean",
+                "description": "Whether Column can be used in an aggregation when grouping",
+                "uiLabel": "Aggregatable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "Filterable",
+                "kind": "boolean",
+                "description": "Whether Column is filterable",
+                "uiLabel": "Filterable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "Groupable",
+                "kind": "boolean",
+                "description": "Whether Column can be grouped",
+                "uiLabel": "Groupable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "Pivotable",
+                "kind": "boolean",
+                "description": "Whether Column can be used when grid is in pivot mode",
+                "uiLabel": "Pivotable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "Resizable",
+                "kind": "boolean",
+                "description": "Whether Column can be resized (by dragging column header edges)",
+                "uiLabel": "Resizable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "Sortable",
+                "kind": "boolean",
+                "description": "Whether Column is sortable",
+                "uiLabel": "Sortable",
+                "isOptional": true,
+                "defaultValue": "true"
+            },
+            {
+                "name": "SuppressMenu",
+                "kind": "boolean",
+                "description": "Whether if no menu should be shown for this Column header.",
+                "uiLabel": "Suppress Menu",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
+            {
+                "name": "SuppressMovable",
+                "kind": "boolean",
+                "description": "Whether if this Column should be movable via dragging",
+                "uiLabel": "Suppress Movable",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
+            {
+                "name": "Width",
+                "kind": "number",
+                "description": "Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid",
+                "uiLabel": "Width",
+                "isOptional": true
+            }
+        ]
+    },
     "StateOptions": {
         "name": "StateOptions",
         "kind": "Interface",
@@ -10632,6 +10896,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves Color Palette currently being used",
                 "uiLabel": "Get Color Palette"
             },
+            {
+                "name": "getCustomSortPermittedValuesForColumn",
+                "kind": "function",
+                "description": "Retrieves Permitted values for Custom sort.",
+                "uiLabel": "Get Custom Sort Permitted Values For Column"
+            },
             {
                 "name": "getEditableCellStyle",
                 "kind": "function",
@@ -10650,6 +10920,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves actual Look Up Values from an EditLookUpItem",
                 "uiLabel": "Get Edit Look Up Values For Edit Look Up Item"
             },
+            {
+                "name": "getFilterPermittedValuesForColumn",
+                "kind": "function",
+                "description": "Retrieves Permitted values for filtering by column values in Floating Filter and dropdown Filter.",
+                "uiLabel": "Get Filter Permitted Values For Column"
+            },
             {
                 "name": "getPermittedValuesForColumn",
                 "kind": "function",
@@ -10691,6 +10967,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "defaultValue": "null",
                 "reference": "AdaptableIcon"
             },
+            {
+                "name": "bulkUpdatePermittedValues",
+                "kind": "unknown",
+                "description": "Custom column values for editing via bulk-update. When not defined it defaults to permittedValues.",
+                "uiLabel": "Bulk Update Permitted Values",
+                "isOptional": true
+            },
             {
                 "name": "colorPalette",
                 "kind": "unknown",
@@ -10698,6 +10981,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Color Palette",
                 "isOptional": true
             },
+            {
+                "name": "customSortPermittedValues",
+                "kind": "unknown",
+                "description": "Custom column values for defining custom sort. When not defined it defaults to permittedValues.",
+                "uiLabel": "Custom Sort Permitted Values",
+                "isOptional": true
+            },
             {
                 "name": "dateInputOptions",
                 "kind": "REFERENCE",
@@ -10717,10 +11007,17 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "editLookUpItems",
                 "kind": "unknown",
-                "description": "Dropdown values displayed when column is being edited",
+                "description": "Dropdown values displayed when column is being edited. When not defined it defaults to permittedValues.",
                 "uiLabel": "Edit Look Up Items",
                 "isOptional": true
             },
+            {
+                "name": "filterPermittedValues",
+                "kind": "unknown",
+                "description": "Dropdown values for filter options inside floating and header filter. When not defined it defaults to permittedValues.",
+                "uiLabel": "Filter Permitted Values",
+                "isOptional": true
+            },
             {
                 "name": "permittedValues",
                 "kind": "unknown",