@adaptabletools/adaptable 11.0.7 → 11.1.0

package/src/metamodel/adaptable.metamodel.js

@@ -5,7 +5,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AccessLevel": {
         "name": "AccessLevel",
         "kind": "TypeAlias",
-        "description": "Defines Access Level for an Entitlement - can be 'ReadOnly', 'Hidden' or 'Full'"
+        "description": "Defines Access Level for an Entitlement - can be `ReadOnly`, `Hidden` or `Full`"
     },
     "ActionColumn": {
         "name": "ActionColumn",
@@ -120,8 +120,13 @@ exports.ADAPTABLE_METAMODEL = {
     },
     "AdaptableAlert": {
         "name": "AdaptableAlert",
+        "kind": "TypeAlias",
+        "description": "Defines an Alert fired by AdapTable"
+    },
+    "AdaptableAlertBase": {
+        "name": "AdaptableAlertBase",
         "kind": "Interface",
-        "description": "Defines an Alert fired by AdapTable",
+        "description": "Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",
         "properties": [
             {
                 "name": "alertDefinition",
@@ -131,12 +136,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "reference": "AlertDefinition"
             },
             {
-                "name": "dataChangedInfo",
-                "kind": "REFERENCE",
-                "description": "DataChange which triggered Alert",
-                "uiLabel": "Data Changed Info",
-                "isOptional": true,
-                "reference": "DataChangedInfo"
+                "name": "alertType",
+                "kind": "unknown",
+                "description": "The type of Alert",
+                "uiLabel": "Alert Type"
             },
             {
                 "name": "header",
@@ -484,6 +487,20 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"
     },
+    "AdaptableCellChangedAlert": {
+        "name": "AdaptableCellChangedAlert",
+        "kind": "Interface",
+        "description": "Defines an Alert fired by AdapTable when a cell is changed",
+        "properties": [
+            {
+                "name": "dataChangedInfo",
+                "kind": "REFERENCE",
+                "description": "Cell DataChange which triggered Alert",
+                "uiLabel": "Data Changed Info",
+                "reference": "DataChangedInfo"
+            }
+        ]
+    },
     "AdaptableColumn": {
         "name": "AdaptableColumn",
         "kind": "Interface",
@@ -1347,6 +1364,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableRowChangedAlert": {
+        "name": "AdaptableRowChangedAlert",
+        "kind": "Interface",
+        "description": "Defines an Alert fired by AdapTable when a row is changed",
+        "properties": [
+            {
+                "name": "gridDataChangedInfo",
+                "kind": "REFERENCE",
+                "description": "Row DataChange which triggered Alert",
+                "uiLabel": "Grid Data Changed Info",
+                "reference": "GridDataChangedInfo"
+            }
+        ]
+    },
     "AdaptableScope": {
         "name": "AdaptableScope",
         "kind": "TypeAlias",
@@ -1726,7 +1757,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showAlertPopup",
                 "kind": "function",
-                "description": "Opens the Alert popup screen",
+                "description": "Opens Settings Panel with Alert section selected and visible",
                 "uiLabel": "Show Alert Popup"
             },
             {
@@ -1965,10 +1996,17 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "JumpToCell",
                 "kind": "boolean",
-                "description": "Grid will 'jump' to the cell which triggered the Alert",
+                "description": "Grid will 'jump' to the changed cell which triggered the Alert",
                 "uiLabel": "Jump To Cell",
                 "isOptional": true
             },
+            {
+                "name": "JumpToRow",
+                "kind": "boolean",
+                "description": "Grid will 'jump' to the newly added row which triggered the Alert",
+                "uiLabel": "Jump To Row",
+                "isOptional": true
+            },
             {
                 "name": "LogToConsole",
                 "kind": "boolean",
@@ -2125,6 +2163,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "BaseMenuContext": {
+        "name": "BaseMenuContext",
+        "kind": "Interface",
+        "description": "Base Context object used for both Column and Context Menu Context",
+        "properties": [
+            {
+                "name": "adaptableApi",
+                "kind": "REFERENCE",
+                "description": "The Adaptable Api - included as a convenience",
+                "uiLabel": "Adaptable Api",
+                "reference": "AdaptableApi"
+            }
+        ]
+    },
     "BulkUpdateApi": {
         "name": "BulkUpdateApi",
         "kind": "Interface",
@@ -2142,10 +2194,16 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns current Bulk Update value",
                 "uiLabel": "Get Bulk Update Value"
             },
+            {
+                "name": "setBulkUpdateValue",
+                "kind": "function",
+                "description": "Sets Bulk Update value",
+                "uiLabel": "Set Bulk Update Value"
+            },
             {
                 "name": "showBulkUpdatePopup",
                 "kind": "function",
-                "description": "Opens Bulk Update popup screen",
+                "description": "Opens Settings Panel with Bulk Update section selected and visible",
                 "uiLabel": "Show Bulk Update Popup"
             }
         ]
@@ -2301,7 +2359,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showCalculatedColumnPopup",
                 "kind": "function",
-                "description": "Opens Calculated Column popup screen",
+                "description": "Opens Settings Panel with Calculated Column section selected and visible",
                 "uiLabel": "Show Calculated Column Popup"
             }
         ]
@@ -2415,7 +2473,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "timeout",
                 "kind": "number",
-                "description": "Time after which Cell should be unhilighted",
+                "description": "Time after which Cell should be unhighlighted",
                 "uiLabel": "Timeout",
                 "isOptional": true
             }
@@ -2447,7 +2505,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showCellSummaryPopup",
                 "kind": "function",
-                "description": "Opens Cell Summary popup screen",
+                "description": "Opens Settings Panel with Cell Summary section selected and visible",
                 "uiLabel": "Show Cell Summary Popup"
             }
         ]
@@ -3163,7 +3221,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showConditionalStylePopup",
                 "kind": "function",
-                "description": "Opens Conditional Style popup screen",
+                "description": "Opens Settings Panel with Conditional Style section selected and visible",
                 "uiLabel": "Show Conditional Style Popup"
             },
             {
@@ -3391,10 +3449,10 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Get User State By State Key"
             },
             {
-                "name": "incrementUerStateRevision",
+                "name": "incrementUserStateRevision",
                 "kind": "function",
                 "description": "Adds '1' to current revision number of State element",
-                "uiLabel": "Increment Uer State Revision"
+                "uiLabel": "Increment User State Revision"
             },
             {
                 "name": "loadUserState",
@@ -3423,7 +3481,7 @@ exports.ADAPTABLE_METAMODEL = {
         "properties": [
             {
                 "name": "Revision",
-                "kind": "number",
+                "kind": "unknown",
                 "description": "Version number of the Item - allows developers to update one section in Predefined Config while keeping others unchanged",
                 "uiLabel": "Revision",
                 "isOptional": true
@@ -3740,7 +3798,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showCustomSortPopup",
                 "kind": "function",
-                "description": "Opens Custom Sort popup screen",
+                "description": "Opens Settings Panel with Custom Sort section selected and visible",
                 "uiLabel": "Show Custom Sort Popup"
             },
             {
@@ -4115,7 +4173,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showDashboardPopup",
                 "kind": "function",
-                "description": "Opens the Dashboard popup screen",
+                "description": "Opens Settings Panel with Dashboard section selected and visible",
                 "uiLabel": "Show Dashboard Popup"
             }
         ]
@@ -4314,7 +4372,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "changedAt",
                 "kind": "number",
-                "description": "Timestamp of change occurence (in milliseconds)",
+                "description": "Timestamp of change occurrence (in milliseconds)",
                 "uiLabel": "Changed At"
             },
             {
@@ -4528,7 +4586,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showDataSourcePopup",
                 "kind": "function",
-                "description": "Opens Data Source popup screen",
+                "description": "Opens Settings Panel with Data Source section selected and visible",
                 "uiLabel": "Show Data Source Popup"
             }
         ]
@@ -4874,7 +4932,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "on",
                 "kind": "function",
-                "description": "Event fired when data changes in the Grid",
+                "description": "Event fired when a row is added, deleted or updated in the Grid",
                 "uiLabel": "On"
             },
             {
@@ -5010,6 +5068,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves Report with the given name",
                 "uiLabel": "Get Report By Name"
             },
+            {
+                "name": "getReportDataForReport",
+                "kind": "function",
+                "description": "Returns the ReportData for the Report with the given name",
+                "uiLabel": "Get Report Data For Report"
+            },
             {
                 "name": "getReportSchedules",
                 "kind": "function",
@@ -5043,7 +5107,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showExportPopup",
                 "kind": "function",
-                "description": "Opens Export popup screen",
+                "description": "Opens Settings Panel with Export section selected and visible",
                 "uiLabel": "Show Export Popup"
             }
         ]
@@ -6311,7 +6375,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showFormatColumnPopup",
                 "kind": "function",
-                "description": "Opens the Format Column popup screen",
+                "description": "Opens Settings Panel with Format Column section selected and visible",
                 "uiLabel": "Show Format Column Popup"
             },
             {
@@ -6473,7 +6537,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showFreeTextColumnPopup",
                 "kind": "function",
-                "description": "Opens FreeTextColumn popup screen",
+                "description": "Opens Settings Panel with Free Text Column section selected and visible",
                 "uiLabel": "Show Free Text Column Popup"
             }
         ]
@@ -7100,6 +7164,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Returns the Primary Kev Value for a given Row Node",
                 "uiLabel": "Get Primary Key Value For Row Node"
             },
+            {
+                "name": "getPrimaryKeyValuesForRowNodes",
+                "kind": "function",
+                "description": "Returns the Primary Kev Values for a given Row Node collection",
+                "uiLabel": "Get Primary Key Values For Row Nodes"
+            },
             {
                 "name": "getRawValueFromRowNode",
                 "kind": "function",
@@ -7172,6 +7242,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Highlight a row using an adaptable style",
                 "uiLabel": "Highlight Row"
             },
+            {
+                "name": "highlightRows",
+                "kind": "function",
+                "description": "Highlight rows using an adaptable style",
+                "uiLabel": "Highlight Rows"
+            },
             {
                 "name": "isGridGroupable",
                 "kind": "function",
@@ -7247,15 +7323,21 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "refreshRowByPrimaryKey",
                 "kind": "function",
-                "description": "Forces a render of a row",
+                "description": "Forces a re-render of the row with the given primary key value",
                 "uiLabel": "Refresh Row By Primary Key"
             },
             {
                 "name": "refreshRowNode",
                 "kind": "function",
-                "description": "",
+                "description": "Forces a re-render of the given row",
                 "uiLabel": "Refresh Row Node"
             },
+            {
+                "name": "refreshRowNodes",
+                "kind": "function",
+                "description": "Forces a re-render of the given rows",
+                "uiLabel": "Refresh Row Nodes"
+            },
             {
                 "name": "selectAll",
                 "kind": "function",
@@ -7343,7 +7425,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showGridInfoPopup",
                 "kind": "function",
-                "description": "Opens Grid Info popup screen",
+                "description": "Opens Settings Panel with Grid Info section selected and visible",
                 "uiLabel": "Show Grid Info Popup"
             },
             {
@@ -7376,6 +7458,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Remove highlight from row",
                 "uiLabel": "Un Highlight Row"
             },
+            {
+                "name": "unHighlightRows",
+                "kind": "function",
+                "description": "Remove highlight from row",
+                "uiLabel": "Un Highlight Rows"
+            },
             {
                 "name": "updateGridData",
                 "kind": "function",
@@ -7435,6 +7523,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "EventInfo returned by GridDataChanged event",
         "properties": [
+            {
+                "name": "changedAt",
+                "kind": "number",
+                "description": "Timestamp of change occurrence (in milliseconds)",
+                "uiLabel": "Changed At"
+            },
             {
                 "name": "dataRows",
                 "kind": "unknown",
@@ -7444,7 +7538,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "rowNodes",
                 "kind": "unknown",
-                "description": "AG Grid Row Nodes that were affected by the Change",
+                "description": "Row Nodes that were affected by this change",
                 "uiLabel": "Row Nodes"
             },
             {
@@ -7949,7 +8043,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "ExpandedRowGroupValues",
                 "kind": "unknown",
-                "description": "Values of opened row groups",
+                "description": "Opened Row Groups - set if `displayRowGroups` in LayoutOptions is 'dynamic'",
                 "uiLabel": "Expanded Row Group Values",
                 "isOptional": true
             },
@@ -7994,6 +8088,12 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Provides run-time access to the Layout Module and associated state",
         "properties": [
+            {
+                "name": "areExpandedRowGroupsSavedInLayouts",
+                "kind": "function",
+                "description": "Returns true if Layouts will contain Expanded Row Groups information",
+                "uiLabel": "Are Expanded Row Groups Saved In Layouts"
+            },
             {
                 "name": "areLayoutsEqual",
                 "kind": "function",
@@ -8030,6 +8130,18 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Creates new Layout in the state",
                 "uiLabel": "Create Layout"
             },
+            {
+                "name": "deleteLayout",
+                "kind": "function",
+                "description": "Deletes an existing Layout (if not Default or only existing Layout)",
+                "uiLabel": "Delete Layout"
+            },
+            {
+                "name": "deleteLayoutByName",
+                "kind": "function",
+                "description": "Deletes an existing Layout provided by Name (if not Default or only existing Layout)",
+                "uiLabel": "Delete Layout By Name"
+            },
             {
                 "name": "doesLayoutExist",
                 "kind": "function",
@@ -8102,6 +8214,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves Layout section from Adaptable State",
                 "uiLabel": "Get Layout State"
             },
+            {
+                "name": "isCurrentLayoutDefault",
+                "kind": "function",
+                "description": "Checks if the Current Layout is Default Layout",
+                "uiLabel": "Is Current Layout Default"
+            },
+            {
+                "name": "isCurrentLayoutReadOnly",
+                "kind": "function",
+                "description": "Specifies where Current Layout is editable",
+                "uiLabel": "Is Current Layout Read Only"
+            },
+            {
+                "name": "isDefaultLayout",
+                "kind": "function",
+                "description": "Checks if the given Layout is Default Layout",
+                "uiLabel": "Is Default Layout"
+            },
             {
                 "name": "saveCurrentLayout",
                 "kind": "function",
@@ -8138,10 +8268,16 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Opens change column caption popup",
                 "uiLabel": "Show Change Column Caption"
             },
+            {
+                "name": "showLayoutEditor",
+                "kind": "function",
+                "description": "Opens Layout Editor - for Current or a named Layout",
+                "uiLabel": "Show Layout Editor"
+            },
             {
                 "name": "showLayoutPopup",
                 "kind": "function",
-                "description": "Opens Layout popup screen",
+                "description": "Opens Settings Panel with Layout section selected",
                 "uiLabel": "Show Layout Popup"
             }
         ]
@@ -8214,6 +8350,13 @@ exports.ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defaultValue": "false"
             },
+            {
+                "name": "displayRowGroups",
+                "kind": "unknown",
+                "description": "Whether RowGroups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",
+                "uiLabel": "Display Row Groups",
+                "isOptional": true
+            },
             {
                 "name": "includeExpandedRowGroups",
                 "kind": "boolean",
@@ -8931,7 +9074,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showPlusMinusPopup",
                 "kind": "function",
-                "description": "Opens Plus Minus popup screen",
+                "description": "Opens Settings Panel with Plus Minus section selected and visible",
                 "uiLabel": "Show Plus Minus Popup"
             },
             {
@@ -9344,7 +9487,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showQueryPopup",
                 "kind": "function",
-                "description": "Opens Query Popup screen",
+                "description": "Opens Settings Panel with Query section selected and visible",
                 "uiLabel": "Show Query Popup"
             }
         ]
@@ -9475,7 +9618,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showQuickSearchPopup",
                 "kind": "function",
-                "description": "Opens Quick Search popup screen",
+                "description": "Opens Settings Panel with Quick Search section selected and visible",
                 "uiLabel": "Show Quick Search Popup"
             }
         ]
@@ -9874,7 +10017,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showSchedulePopup",
                 "kind": "function",
-                "description": "Opens Schedule popup screen",
+                "description": "Opens Settings Panel with Schedule section selected and visible",
                 "uiLabel": "Show Schedule Popup"
             },
             {
@@ -10412,7 +10555,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showShortcutPopup",
                 "kind": "function",
-                "description": "Opens Shortcut popup screen",
+                "description": "Opens Settings Panel with Shortcut section selected and visible",
                 "uiLabel": "Show Shortcut Popup"
             },
             {
@@ -10486,7 +10629,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showSmartEditPopup",
                 "kind": "function",
-                "description": "Opens Smart Edit popup screen",
+                "description": "Opens Settings Panel with Smart Edit section selected and visible",
                 "uiLabel": "Show Smart Edit Popup"
             }
         ]
@@ -10818,7 +10961,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showTeamSharingPopup",
                 "kind": "function",
-                "description": "Opens Team Sharing popup screen",
+                "description": "Opens Settings Panel with Team Sharing section selected and visible",
                 "uiLabel": "Show Team Sharing Popup"
             }
         ]
@@ -10983,7 +11126,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showThemePopup",
                 "kind": "function",
-                "description": "Opens Theme popup screen",
+                "description": "Opens Settings Panel with Theme section selected and visible",
                 "uiLabel": "Show Theme Popup"
             }
         ]

package/src/types.d.ts

@@ -94,7 +94,7 @@ export type { SpecialColumnSettings } from './PredefinedConfig/Common/SpecialCol
 export type { CalculatedColumn, CalculatedColumnSettings, CalculatedColumnState, AdaptableCalculatedColumnQuery, } from './PredefinedConfig/CalculatedColumnState';
 export type { CellSummmary, CellSummaryOperation, CellSummaryOperationParams, } from './PredefinedConfig/Common/CellSummary';
 export type { FlashingCellDefinition, FlashingCellState, } from './PredefinedConfig/FlashingCellState';
-export type { AdaptableAlert } from './PredefinedConfig/Common/AdaptableAlert';
+export type { AdaptableAlert, AdaptableAlertType, AdaptableGenericAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert, AdaptableAlertBase, } from './PredefinedConfig/Common/AdaptableAlert';
 export type { AdaptableFlashingCell } from './PredefinedConfig/Common/AdaptableFlashingCell';
 export type { AdaptableColumn, AdaptableColumnBase, } from './PredefinedConfig/Common/AdaptableColumn';
 export type { AdaptableComparerFunction } from './PredefinedConfig/Common/AdaptableComparerFunction';
@@ -112,12 +112,13 @@ export type { AdaptableStyle } from './PredefinedConfig/Common/AdaptableStyle';
 export type { AdaptableIcon } from './PredefinedConfig/Common/AdaptableIcon';
 export type { CellHighlightInfo } from './PredefinedConfig/Common/CellHighlightInfo';
 export type { RowHighlightInfo } from './PredefinedConfig/Common/RowHighlightInfo';
+export type { RowsHighlightInfo } from './PredefinedConfig/Common/RowsHighlightInfo';
 export type { ColumnSort } from './PredefinedConfig/Common/ColumnSort';
 export type { DataChangedInfo } from './PredefinedConfig/Common/DataChangedInfo';
 export type { DataUpdateConfig } from './PredefinedConfig/Common/DataUpdateConfig';
 export type { AdaptableFormData, AdaptableForm, AdaptableFormField, } from './PredefinedConfig/Common/AdaptableForm';
 export type { AdaptableButton, ButtonContext } from './PredefinedConfig/Common/AdaptableButton';
-export type { AdaptableMenuItem, UserMenuItem, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
+export type { AdaptableMenuItem, UserMenuItem, BaseMenuContext, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
 export type { Schedule } from './PredefinedConfig/Common/Schedule';
 export type { ButtonStyle } from './PredefinedConfig/Common/ButtonStyle';
 export type { AdaptableModule, AdaptableToolPanel, AdaptableQLModule, } from './PredefinedConfig/Common/Types';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.7";
+declare const _default: "11.1.0";
 export default _default;

package/version.js

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