@adaptabletools/adaptable 11.0.9 → 11.1.1-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. package/base.css +19 -11
  2. package/bundle.cjs.js +125 -125
  3. package/index.css +23 -11
  4. package/package.json +2 -2
  5. package/publishTimestamp.d.ts +1 -1
  6. package/publishTimestamp.js +1 -1
  7. package/src/AdaptableInterfaces/IAdaptable.d.ts +4 -2
  8. package/src/AdaptableOptions/AlertOptions.d.ts +2 -2
  9. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +2 -2
  10. package/src/AdaptableOptions/EditOptions.d.ts +2 -2
  11. package/src/AdaptableOptions/LayoutOptions.d.ts +5 -1
  12. package/src/Api/AlertApi.d.ts +5 -6
  13. package/src/Api/BulkUpdateApi.d.ts +5 -0
  14. package/src/Api/ConfigApi.d.ts +1 -1
  15. package/src/Api/DataChangeHistoryApi.d.ts +3 -3
  16. package/src/Api/EventApi.d.ts +1 -1
  17. package/src/Api/Events/CellChanged.d.ts +2 -2
  18. package/src/Api/Events/GridDataChanged.d.ts +5 -1
  19. package/src/Api/ExportApi.d.ts +3 -3
  20. package/src/Api/FreeTextColumnApi.d.ts +3 -3
  21. package/src/Api/GridApi.d.ts +27 -6
  22. package/src/Api/Implementation/AlertApiImpl.d.ts +7 -4
  23. package/src/Api/Implementation/AlertApiImpl.js +86 -59
  24. package/src/Api/Implementation/BulkUpdateApiImpl.d.ts +1 -0
  25. package/src/Api/Implementation/BulkUpdateApiImpl.js +4 -0
  26. package/src/Api/Implementation/ConfigApiImpl.d.ts +1 -1
  27. package/src/Api/Implementation/ConfigApiImpl.js +7 -2
  28. package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts +3 -3
  29. package/src/Api/Implementation/EventApiImpl.js +1 -1
  30. package/src/Api/Implementation/ExportApiImpl.d.ts +2 -2
  31. package/src/Api/Implementation/ExportApiImpl.js +7 -8
  32. package/src/Api/Implementation/FreeTextColumnApiImpl.d.ts +2 -2
  33. package/src/Api/Implementation/FreeTextColumnApiImpl.js +7 -7
  34. package/src/Api/Implementation/GridApiImpl.d.ts +11 -3
  35. package/src/Api/Implementation/GridApiImpl.js +29 -8
  36. package/src/Api/Implementation/InternalApiImpl.d.ts +11 -4
  37. package/src/Api/Implementation/InternalApiImpl.js +41 -5
  38. package/src/Api/Implementation/LayoutApiImpl.d.ts +2 -1
  39. package/src/Api/Implementation/LayoutApiImpl.js +19 -4
  40. package/src/Api/Implementation/ScheduleApiImpl.js +1 -0
  41. package/src/Api/Implementation/SettingsPanelApiImpl.js +7 -1
  42. package/src/Api/InternalApi.d.ts +10 -3
  43. package/src/Api/LayoutApi.d.ts +14 -3
  44. package/src/PredefinedConfig/AlertState.d.ts +7 -3
  45. package/src/PredefinedConfig/Common/AdaptableAlert.d.ts +35 -6
  46. package/src/PredefinedConfig/Common/AdaptableAlert.js +7 -0
  47. package/src/PredefinedConfig/Common/AdaptableFlashingCell.d.ts +2 -2
  48. package/src/PredefinedConfig/Common/AdaptablePredicate.js +20 -0
  49. package/src/PredefinedConfig/Common/{DataChangedInfo.d.ts → CellDataChangedInfo.d.ts} +2 -6
  50. package/src/PredefinedConfig/Common/{DataChangedInfo.js → CellDataChangedInfo.js} +0 -0
  51. package/src/PredefinedConfig/Common/CellHighlightInfo.d.ts +1 -1
  52. package/src/PredefinedConfig/Common/DataChangedScope.d.ts +4 -0
  53. package/src/PredefinedConfig/Common/DataChangedScope.js +2 -0
  54. package/src/PredefinedConfig/Common/Entitlement.d.ts +2 -2
  55. package/src/PredefinedConfig/Common/Menu.d.ts +3 -0
  56. package/src/PredefinedConfig/Common/RowsHighlightInfo.d.ts +15 -0
  57. package/src/PredefinedConfig/Common/RowsHighlightInfo.js +2 -0
  58. package/src/PredefinedConfig/ConfigState.d.ts +4 -1
  59. package/src/PredefinedConfig/LayoutState.d.ts +1 -1
  60. package/src/PredefinedConfig/PopupState.d.ts +2 -1
  61. package/src/PredefinedConfig/SystemState.d.ts +2 -2
  62. package/src/Redux/ActionsReducers/FlashingCellRedux.js +4 -8
  63. package/src/Redux/ActionsReducers/GridRedux.d.ts +5 -5
  64. package/src/Redux/ActionsReducers/PopupRedux.d.ts +18 -0
  65. package/src/Redux/ActionsReducers/PopupRedux.js +36 -1
  66. package/src/Redux/ActionsReducers/SystemRedux.d.ts +16 -5
  67. package/src/Redux/ActionsReducers/SystemRedux.js +37 -6
  68. package/src/Redux/Store/AdaptableReduxMerger.d.ts +1 -0
  69. package/src/Redux/Store/AdaptableReduxMerger.js +40 -4
  70. package/src/Redux/Store/AdaptableStore.js +76 -34
  71. package/src/Strategy/AlertModule.d.ts +5 -3
  72. package/src/Strategy/AlertModule.js +68 -22
  73. package/src/Strategy/BulkUpdateModule.js +7 -2
  74. package/src/Strategy/DataChangeHistoryModule.js +8 -6
  75. package/src/Strategy/ExportModule.js +1 -0
  76. package/src/Strategy/FlashingCellModule.d.ts +2 -2
  77. package/src/Strategy/FlashingCellModule.js +21 -15
  78. package/src/Strategy/FormatColumnModule.js +4 -2
  79. package/src/Strategy/SmartEditModule.js +6 -0
  80. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +1 -0
  81. package/src/Utilities/Defaults/DefaultSettingsPanel.d.ts +1 -1
  82. package/src/Utilities/Defaults/DefaultSettingsPanel.js +6 -2
  83. package/src/Utilities/Emitter.d.ts +1 -1
  84. package/src/Utilities/Emitter.js +6 -3
  85. package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.d.ts +2 -2
  86. package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.js +1 -1
  87. package/src/Utilities/Interface/MessagePopups.d.ts +13 -0
  88. package/src/Utilities/ObjectFactory.d.ts +9 -7
  89. package/src/Utilities/ObjectFactory.js +26 -12
  90. package/src/Utilities/Services/CalculatedColumnExpressionService.js +3 -3
  91. package/src/Utilities/Services/DataService.d.ts +5 -5
  92. package/src/Utilities/Services/DataService.js +12 -10
  93. package/src/Utilities/Services/Interface/IAlertService.d.ts +2 -2
  94. package/src/Utilities/Services/Interface/IDataService.d.ts +6 -6
  95. package/src/Utilities/Services/Interface/IQueryLanguageService.d.ts +3 -3
  96. package/src/Utilities/Services/Interface/IValidationService.d.ts +4 -4
  97. package/src/Utilities/Services/LicenseService.js +1 -1
  98. package/src/Utilities/Services/ModuleService.js +1 -1
  99. package/src/Utilities/Services/QueryLanguageService.d.ts +3 -3
  100. package/src/Utilities/Services/ValidationService.d.ts +4 -4
  101. package/src/Utilities/Services/ValidationService.js +18 -17
  102. package/src/View/AdaptableView.js +2 -0
  103. package/src/View/Alert/Wizard/AlertBehaviourWizardSection.js +16 -9
  104. package/src/View/Alert/Wizard/AlertButtonsEditor.js +13 -3
  105. package/src/View/Alert/Wizard/AlertDisplayWizardSection.js +2 -0
  106. package/src/View/Alert/Wizard/AlertWizard.js +83 -1
  107. package/src/View/CellSummary/CellSummaryViewPanel.js +1 -2
  108. package/src/View/Components/FilterForm/FilterForm.js +2 -2
  109. package/src/View/Components/Panels/PanelFooter.d.ts +10 -0
  110. package/src/View/Components/Panels/PanelFooter.js +14 -0
  111. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopup.js +12 -7
  112. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupDialog.js +1 -1
  113. package/src/View/Components/Popups/AdaptablePopup/useMenuItems.js +3 -1
  114. package/src/View/Components/Popups/{AdaptablePopup/Utilities.d.ts → Utilities.d.ts} +4 -0
  115. package/src/View/Components/Popups/{AdaptablePopup/Utilities.js → Utilities.js} +5 -2
  116. package/src/View/Components/Popups/WindowPopups/WindowPopups.d.ts +6 -0
  117. package/src/View/Components/Popups/WindowPopups/WindowPopups.js +32 -0
  118. package/src/View/Components/Popups/WindowPopups/windowFactory.d.ts +4 -0
  119. package/src/View/Components/Popups/WindowPopups/windowFactory.js +8 -0
  120. package/src/View/DataChangeHistory/DataChangeHistoryGrid.d.ts +2 -2
  121. package/src/View/DataChangeHistory/DataChangeHistoryPopup.d.ts +2 -2
  122. package/src/View/Layout/LayoutEditorStandalonePopup.d.ts +3 -0
  123. package/src/View/Layout/LayoutEditorStandalonePopup.js +76 -0
  124. package/src/View/Layout/LayoutPopup.js +3 -24
  125. package/src/View/Layout/LayoutViewPanel.d.ts +1 -4
  126. package/src/View/Layout/LayoutViewPanel.js +5 -18
  127. package/src/View/Layout/Wizard/LayoutEditor/ColumnLabels.d.ts +9 -0
  128. package/src/View/Layout/Wizard/LayoutEditor/ColumnLabels.js +55 -0
  129. package/src/View/Layout/Wizard/LayoutEditor/index.js +3 -68
  130. package/src/View/Layout/Wizard/LayoutEditorWizard.d.ts +1 -0
  131. package/src/View/Layout/Wizard/LayoutEditorWizard.js +35 -7
  132. package/src/View/SystemStatus/SystemStatusEntityRow.js +1 -2
  133. package/src/agGrid/Adaptable.d.ts +6 -4
  134. package/src/agGrid/Adaptable.js +115 -117
  135. package/src/agGrid/agGridHelper.d.ts +1 -1
  136. package/src/agGrid/agGridHelper.js +23 -8
  137. package/src/agGrid/editors/AdaptableDateEditor/index.js +1 -1
  138. package/src/agGrid/editors/AdaptableNumberEditor/index.js +1 -1
  139. package/src/components/Dialog/index.js +1 -1
  140. package/src/components/Modal/index.js +1 -1
  141. package/src/components/WindowModal/WindowModal.d.ts +10 -8
  142. package/src/components/WindowModal/WindowModal.js +4 -2
  143. package/src/components/WindowModal/useStacking.d.ts +9 -0
  144. package/src/components/WindowModal/useStacking.js +45 -0
  145. package/src/env.js +3 -3
  146. package/src/metamodel/adaptable.metamodel.d.ts +85 -45
  147. package/src/metamodel/adaptable.metamodel.js +185 -84
  148. package/src/types.d.ts +5 -3
  149. package/version.d.ts +1 -1
  150. package/version.js +1 -1
package/index.css CHANGED
@@ -2139,8 +2139,12 @@ template {
2139
2139
  overflow: auto;
2140
2140
  display: grid;
2141
2141
  padding: var(--ab-space-2);
2142
- grid-template-rows: 1fr 1fr;
2143
- grid-template-columns: 28rem 1fr 1fr;
2142
+ flex: 1 1 0;
2143
+ min-height: 0;
2144
+ grid-template-columns: 28rem 1fr;
2145
+ grid-template-rows: repeat(3, 1fr);
2146
+ grid-column-gap: 0px;
2147
+ grid-row-gap: 0px;
2144
2148
  row-gap: var(--ab-space-2);
2145
2149
  column-gap: var(--ab-space-2);
2146
2150
  grid-gap: var(--ab-space-2); }
@@ -2153,21 +2157,16 @@ template {
2153
2157
  overflow: auto; }
2154
2158
 
2155
2159
  .ab-LayoutEditor__ColumnListPanel {
2156
- grid-row: 1 /3;
2157
- grid-column: 1 /1;
2158
- max-height: initial; }
2160
+ grid-area: 1 / 1 / 4 / 2; }
2159
2161
 
2160
2162
  .ab-LayoutEditor__ColumnSortListPanel {
2161
- grid-row: 1 /1;
2162
- grid-column: 2 /2; }
2163
+ grid-area: 1 / 2 / 2 / 3; }
2163
2164
 
2164
2165
  .ab-LayoutEditor__RowGroupsListPanel {
2165
- grid-row: 2 / 2;
2166
- grid-column: 2 /2; }
2166
+ grid-area: 2 / 2 / 3 / 3; }
2167
2167
 
2168
2168
  .ab-LayoutEditor__PivotListPanel {
2169
- grid-row: 2 / 2;
2170
- grid-column: 3 /3; }
2169
+ grid-area: 3 / 2 / 4 / 3; }
2171
2170
 
2172
2171
  .ab-LayoutEditor__PivotList--empty,
2173
2172
  .ab-LayoutEditor__RowGroupsList--empty,
@@ -2274,6 +2273,9 @@ template {
2274
2273
  --ab-cmp-adaptable-popup-panel-title__font-size: var(--ab-font-size-5);
2275
2274
  --ab-cmp-adaptable-popup-panel-body__padding: var(--ab-space-2); }
2276
2275
 
2276
+ :root {
2277
+ --ab-cmp-adaptable-window-popup__box-shadow: var(--ab-cmp-adaptable-popup__box-shadow); }
2278
+
2277
2279
  :root {
2278
2280
  --ab-cmp-adaptable-object-list-tag__margin-right: var(--ab-space-2);
2279
2281
  --ab-cmp-adaptable-object-list-tag__margin-top: var(--ab-space-2);
@@ -3636,6 +3638,16 @@ html.ab--theme-dark .ab-ListBoxFilterForm--aggrid-style {
3636
3638
  .ab-Adaptable-Popup--window.ab-Adaptable-Popup--action-popup .ab-Panel__header {
3637
3639
  cursor: move; }
3638
3640
 
3641
+ .ab-Window-Modal .ab-Panel__header {
3642
+ cursor: move; }
3643
+
3644
+ .ab-Window-Modal {
3645
+ max-height: 100%;
3646
+ box-shadow: var(--ab-cmp-adaptable-window-popup__box-shadow); }
3647
+
3648
+ .ab-Window-Modal .ab-Panel {
3649
+ max-height: initial; }
3650
+
3639
3651
  .ab-Adaptable-Object-List {
3640
3652
  list-style: none;
3641
3653
  padding: 0; }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "11.0.9",
3
+ "version": "11.1.1-canary.1",
4
4
  "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
5
5
  "keywords": [
6
6
  "web-components",
@@ -56,6 +56,6 @@
56
56
  "uuid": "^3.3.2"
57
57
  },
58
58
  "peerDependencies": {
59
- "@ag-grid-community/all-modules": ">=27.0.0"
59
+ "@ag-grid-community/all-modules": ">=27.1.0"
60
60
  }
61
61
  }
@@ -1,2 +1,2 @@
1
- declare const _default: 1647786684508;
1
+ declare const _default: 1648368512196;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1647786684508;
3
+ exports.default = 1648368512196;
@@ -2,7 +2,7 @@ import { Column, RowNode } from '@ag-grid-community/all-modules';
2
2
  import { AdaptableApi } from '../Api/AdaptableApi';
3
3
  import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
4
4
  import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
5
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
5
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
6
6
  import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
7
7
  import { ReportData } from '../PredefinedConfig/ExportState';
8
8
  import { Layout } from '../PredefinedConfig/LayoutState';
@@ -109,6 +109,7 @@ export interface IAdaptable {
109
109
  redrawBody(): void;
110
110
  redrawHeader(): void;
111
111
  redrawRow(rowNode: RowNode): void;
112
+ redrawRows(rowNodes: RowNode[]): void;
112
113
  refreshCells(rowNodes: RowNode[], columns: (string | any)[], forceUpdate: boolean, suppressFlash?: boolean): void;
113
114
  setSelectedCells(): SelectedCellInfo | undefined;
114
115
  setSelectedRows(): SelectedRowInfo | undefined;
@@ -163,7 +164,7 @@ export interface IAdaptable {
163
164
  lookupPlugins(propertyName: string, ...args: any): any;
164
165
  getPluginProperty(pluginId: string, propertyName: string, ...args: any): any;
165
166
  getPlugin(pluginId: string): AdaptablePlugin;
166
- setValue(dataChangedInfo: DataChangedInfo): void;
167
+ setValue(cellDataChangedInfo: CellDataChangedInfo): void;
167
168
  cancelEdit(): any;
168
169
  isCellEditable(rowNode: RowNode, column: Column): boolean;
169
170
  getFirstRowNode(): RowNode;
@@ -171,6 +172,7 @@ export interface IAdaptable {
171
172
  forAllRowNodesDo(func: (rowNode: RowNode) => void): void;
172
173
  forAllVisibleRowNodesDo(func: (rowNode: RowNode) => void): void;
173
174
  getVisibleRowNodes(): RowNode[];
175
+ getRowsInViewport(): RowNode[];
174
176
  isGroupRowNode(rowNode: RowNode): boolean;
175
177
  isVisibleNode(rowNode: RowNode): boolean;
176
178
  selectNodes(rowNodes: RowNode[], clearSelection: boolean): void;
@@ -2,7 +2,7 @@ import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
2
2
  import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
3
3
  import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
4
4
  import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
5
- import { DataChangedInfo } from '../types';
5
+ import { CellDataChangedInfo } from '../types';
6
6
  /**
7
7
  * Options related to Alerts in Adaptable.
8
8
  */
@@ -39,7 +39,7 @@ export interface AlertOptions {
39
39
  /**
40
40
  * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
41
41
  */
42
- alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
42
+ alertMessageText?: (alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo) => string | undefined;
43
43
  }
44
44
  /**
45
45
  * Handles a Form Button Action
@@ -1,4 +1,4 @@
1
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
1
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
2
2
  /**
3
3
  * Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes
4
4
  */
@@ -16,5 +16,5 @@ export interface DataChangeHistoryOptions {
16
16
  * @defaultValue undefined (all data changes are logged)
17
17
  * @gridInfoItem
18
18
  */
19
- showDataChange?: (dataChangeInfo: DataChangedInfo) => boolean;
19
+ showDataChange?: (cellDataChangedInfo: CellDataChangedInfo) => boolean;
20
20
  }
@@ -1,4 +1,4 @@
1
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
1
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
2
2
  import { GridCell } from '../PredefinedConfig/Selection/GridCell';
3
3
  /**
4
4
  * Options related to Editing in Adaptable.
@@ -9,7 +9,7 @@ export interface EditOptions {
9
9
  /**
10
10
  * Function to validate on Server Adaptable data edits
11
11
  */
12
- validateOnServer?: (dataChangedInfo: DataChangedInfo) => Promise<ValidationResult>;
12
+ validateOnServer?: (cellDataChangedInfo: CellDataChangedInfo) => Promise<ValidationResult>;
13
13
  /**
14
14
  * Displays message after Server Validation
15
15
  *
@@ -5,11 +5,15 @@
5
5
  export interface LayoutOptions {
6
6
  /**
7
7
  * Layouts will include details of expanded grouped rows; if true these will be re-applied at start-up
8
- *
8
+ * @deprecated use displayRowGroups instead
9
9
  * @defaultValue false
10
10
  * @gridInfoItem
11
11
  */
12
12
  includeExpandedRowGroups?: boolean;
13
+ /**
14
+ * Whether RowGroups display all as expanded, all as closed or dynamically (i.e. saved in Layout)
15
+ */
16
+ displayRowGroups?: 'dynamic' | 'expanded' | 'closed';
13
17
  /**
14
18
  * Layouts save whenever Grid's column / sort info changes; if false, a Save button will display
15
19
  *
@@ -1,10 +1,10 @@
1
1
  import { AlertState, AlertDefinition, AdaptableAlertAction, AlertButton } from '../PredefinedConfig/AlertState';
2
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
2
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
3
3
  import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
4
4
  import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
5
5
  import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
6
6
  import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
7
- import { AdaptableMessageType, AlertButtonContext, AlertProperties } from '../types';
7
+ import { AdaptableMessageType, AlertButtonContext, AlertProperties, GridDataChangedInfo } from '../types';
8
8
  /**
9
9
  * Provides run-time access to Alert function and associated State
10
10
  */
@@ -95,15 +95,14 @@ export interface AlertApi {
95
95
  */
96
96
  executeAlertAction(actionName: AdaptableAlertAction | string, details: {
97
97
  alertDefinition: AlertDefinition;
98
- dataChangedInfo?: DataChangedInfo;
98
+ cellDataChangedInfo?: CellDataChangedInfo;
99
+ gridDataChangedInfo?: GridDataChangedInfo;
99
100
  formData?: AdaptableFormData;
100
101
  }): void;
101
102
  /**
102
103
  * Creates Alert formed from inputted values and displays it.
103
104
  * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
104
105
  * @param alertMessage Main message of the alert
105
- * @param alertDefinition The Alert Definition which defines when the Alert is triggered
106
- * @param dataChangedInfo The (optional) DataChangedInfo object that might have triggered the Alert
107
106
  */
108
107
  showAlert(alertHeader: string, alertMessage: string, messageType: AdaptableMessageType, alertProperties?: AlertProperties): void;
109
108
  /**
@@ -165,7 +164,7 @@ export interface AlertApi {
165
164
  * Returns a description of an Alert Definition
166
165
  * @param alertDefinition Alert Definition to use
167
166
  */
168
- getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
167
+ getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
169
168
  /**
170
169
  * Returns a description of an Alert Definition's Rule
171
170
  * @param alertDefinition Alert Definition to use
@@ -16,4 +16,9 @@ export interface BulkUpdateApi {
16
16
  * @param gridCells Cells to apply the Bulk Update
17
17
  */
18
18
  applyBulkUpdate(gridCells: GridCell[]): void;
19
+ /**
20
+ * Sets Bulk Update value
21
+ * @param bulkUpdateValue the value to use in Bulk Update Operation
22
+ */
23
+ setBulkUpdateValue(bulkUpdateValue: string): void;
19
24
  }
@@ -96,7 +96,7 @@ export interface ConfigApi {
96
96
  * Adds '1' to current revision number of State element
97
97
  * @param stateKey Adaptable State Key to update
98
98
  */
99
- incrementUerStateRevision(stateKey: AdaptableStateKey): void;
99
+ incrementUserStateRevision(stateKey: AdaptableStateKey): void;
100
100
  /**
101
101
  * Returns Alert section of Adaptable State
102
102
  * @param returnJson return as JSON rather than object
@@ -1,4 +1,4 @@
1
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
1
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
2
2
  /**
3
3
  * Provides run-time access to the Data Change History Module
4
4
  **/
@@ -24,13 +24,13 @@ export interface DataChangeHistoryApi {
24
24
  /**
25
25
  * Retrieves all data changes which are currently available
26
26
  */
27
- getDataChangeHistoryLog(): DataChangedInfo[];
27
+ getDataChangeHistoryLog(): CellDataChangedInfo[];
28
28
  /**
29
29
  * Reverts the provided data change to its previous value
30
30
  *
31
31
  * @param dataChangeInfo the change to be undone
32
32
  */
33
- undoDataChangeHistoryEntry(dataChangeInfo: DataChangedInfo): void;
33
+ undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
34
34
  /**
35
35
  * Opens Data Change History screen
36
36
  */
@@ -58,7 +58,7 @@ export interface EventApi {
58
58
  */
59
59
  off(eventName: 'TeamSharingEntityChanged', callback: (TeamSharingEntityChangedInfo: TeamSharingEntityChangedInfo) => void): void;
60
60
  /**
61
- * Event fired when data changes in the Grid
61
+ * Event fired when a row is added, deleted or updated in the Grid
62
62
  * @param eventName GridDataChanged
63
63
  * @param callback GridDataChangedInfo which includes full details of what changed
64
64
  * @returns the unsubscribe function
@@ -1,4 +1,4 @@
1
- import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
1
+ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
2
2
  import { BaseEventInfo } from './BaseEventInfo';
3
3
  /**
4
4
  * EventInfo returned by CellChanged event
@@ -7,5 +7,5 @@ export interface CellChangedInfo extends BaseEventInfo {
7
7
  /**
8
8
  * Object providing full information of the cell (and column and row) that changed
9
9
  */
10
- cellChange: DataChangedInfo;
10
+ cellChange: CellDataChangedInfo;
11
11
  }
@@ -4,6 +4,10 @@ import { BaseEventInfo } from './BaseEventInfo';
4
4
  * EventInfo returned by GridDataChanged event
5
5
  */
6
6
  export interface GridDataChangedInfo extends BaseEventInfo {
7
+ /**
8
+ * Timestamp of change occurrence (in milliseconds)
9
+ */
10
+ changedAt: number;
7
11
  /**
8
12
  * Data rows that have been added, updated, or deleted
9
13
  */
@@ -13,7 +17,7 @@ export interface GridDataChangedInfo extends BaseEventInfo {
13
17
  */
14
18
  rowTrigger: 'Add' | 'Edit' | 'Delete';
15
19
  /**
16
- * AG Grid Row Nodes that were affected by the Change
20
+ * Row Nodes that were affected by this change
17
21
  */
18
22
  rowNodes: RowNode[];
19
23
  }
@@ -1,6 +1,6 @@
1
1
  import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
2
2
  import { ExportState, Report, ReportData, ReportSchedule, SystemReportNames } from '../PredefinedConfig/ExportState';
3
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
3
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
4
4
  import { CustomDestination, ExportButtonContext } from '../AdaptableOptions/ExportOptions';
5
5
  import { ExportDestination } from '../PredefinedConfig/Common/Enums';
6
6
  /**
@@ -109,10 +109,10 @@ export interface ExportApi {
109
109
  getExportDestinationForm(destinationName: string): AdaptableForm<ExportButtonContext> | undefined;
110
110
  /**
111
111
  * Whether given data change affects given report
112
- * @param dataChangedInfo data change to check
112
+ * @param cellDataChangedInfo data change to check
113
113
  * @param report report to check
114
114
  */
115
- isDataChangeInReport(dataChangedInfo: DataChangedInfo, report: Report): boolean;
115
+ isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
116
116
  /**
117
117
  * Exports data currently in grid to Excel as What-You-See-Is-What-You-Get
118
118
  */
@@ -1,5 +1,5 @@
1
1
  import { FreeTextColumnState, FreeTextColumn, FreeTextStoredValue } from '../PredefinedConfig/FreeTextColumnState';
2
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
2
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
3
3
  import { RowNode } from '@ag-grid-community/all-modules';
4
4
  /**
5
5
  * Provides run-time access to FreeTextColumn Module and associated state
@@ -61,9 +61,9 @@ export interface FreeTextColumnApi {
61
61
  getFreeTextColumnValueFromRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;
62
62
  /**
63
63
  * Checks if a User Edit was in a Free Text Column
64
- * @param dataChangedInfo change to check
64
+ * @param cellDataChangedInfo change to check
65
65
  */
66
- checkFreeTextColumnForDataChange(dataChangedInfo: DataChangedInfo): void;
66
+ checkFreeTextColumnForDataChange(cellDataChangedInfo: CellDataChangedInfo): void;
67
67
  /**
68
68
  * Opens Settings Panel with Free Text Column section selected and visible
69
69
  */
@@ -4,13 +4,14 @@ import { SelectedRowInfo } from '../PredefinedConfig/Selection/SelectedRowInfo';
4
4
  import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
5
5
  import { GridCell } from '../PredefinedConfig/Selection/GridCell';
6
6
  import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
7
- import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
7
+ import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
8
8
  import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
9
9
  import { RowHighlightInfo } from '../PredefinedConfig/Common/RowHighlightInfo';
10
10
  import { AdaptableModule } from '../PredefinedConfig/Common/Types';
11
11
  import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
12
12
  import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
13
13
  import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
14
+ import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo';
14
15
  /**
15
16
  * Provides access to important properites of AdapTable e.g. sorting, selected cells etc.
16
17
  */
@@ -74,9 +75,9 @@ export interface GridApi {
74
75
  }[]): void;
75
76
  /**
76
77
  * Reverses a data change (if triggered by cell edit)
77
- * @param dataChangedInfo data change to undo
78
+ * @param cellDataChangedInfo data change to undo
78
79
  */
79
- undoCellEdit(dataChangedInfo: DataChangedInfo): boolean;
80
+ undoCellEdit(cellDataChangedInfo: CellDataChangedInfo): boolean;
80
81
  /**
81
82
  * Returns all current Selected Cells in AdapTable
82
83
  */
@@ -214,6 +215,11 @@ export interface GridApi {
214
215
  * @param rowNode rowNode to look up
215
216
  */
216
217
  getPrimaryKeyValueForRowNode(rowNode: RowNode): any;
218
+ /**
219
+ * Returns the Primary Kev Values for a given Row Node collection
220
+ * @param rowNode rowNodes to look up
221
+ */
222
+ getPrimaryKeyValuesForRowNodes(rowNodes: RowNode[]): any[];
217
223
  /**
218
224
  * Retrieves Cell in given Row and Column
219
225
  * @param rowNode Row to use
@@ -324,7 +330,7 @@ export interface GridApi {
324
330
  /**
325
331
  * Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed
326
332
  */
327
- fireCellChangedEvent(cellChangedInfo: DataChangedInfo): void;
333
+ fireCellChangedEvent(cellChangedInfo: CellDataChangedInfo): void;
328
334
  /**
329
335
  * Fires Grid Data Changed Event - when a row has changed in AG Grid
330
336
  */
@@ -365,11 +371,21 @@ export interface GridApi {
365
371
  * @param rowHighlightInfo highlight instructions
366
372
  */
367
373
  highlightRow(rowHighlightInfo: RowHighlightInfo): void;
374
+ /**
375
+ * Highlight rows using an adaptable style
376
+ * @param rowHighlightInfo highlight instructions
377
+ */
378
+ highlightRows(rowsHighlightInfo: RowsHighlightInfo): void;
368
379
  /**
369
380
  * Remove highlight from row
370
381
  * @param primaryKeyValue
371
382
  */
372
383
  unHighlightRow(primaryKeyValue: RowHighlightInfo['primaryKeyValue']): void;
384
+ /**
385
+ * Remove highlight from row
386
+ * @param primaryKeyValue
387
+ */
388
+ unHighlightRows(primaryKeyValues: RowsHighlightInfo['primaryKeyValues']): void;
373
389
  /**
374
390
  * Remove all highlighted rows
375
391
  */
@@ -381,15 +397,20 @@ export interface GridApi {
381
397
  */
382
398
  refreshCells(rowNodes: RowNode[], columnIds: string[]): void;
383
399
  /**
384
- * Forces a render of a row
400
+ * Forces a re-render of the row with the given primary key value
385
401
  * @param primaryKey row primary key
386
402
  */
387
403
  refreshRowByPrimaryKey(primaryKey: any): void;
388
404
  /**
389
- *
405
+ * Forces a re-render of the given row
390
406
  * @param rowNode ag-grid row
391
407
  */
392
408
  refreshRowNode(rowNode: RowNode): void;
409
+ /**
410
+ * Forces a re-render of the given rows
411
+ * @param rowNodes ag-grid rows
412
+ */
413
+ refreshRowNodes(rowNodes: RowNode[]): void;
393
414
  /**
394
415
  * Returns number of rows in Data Source
395
416
  */
@@ -1,12 +1,14 @@
1
1
  import { ApiBase } from './ApiBase';
2
2
  import { AlertApi } from '../AlertApi';
3
3
  import { AlertState, AlertDefinition, AlertProperties, AdaptableAlertAction, AlertButton } from '../../PredefinedConfig/AlertState';
4
- import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
4
+ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
5
5
  import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
6
6
  import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
7
7
  import { AdaptableAlert } from '../../PredefinedConfig/Common/AdaptableAlert';
8
8
  import { AdaptableForm, AdaptableFormData } from '../../PredefinedConfig/Common/AdaptableForm';
9
- import { AdaptableMessageType, AlertButtonContext } from '../../types';
9
+ import { AlertButtonContext } from '../../AdaptableOptions/AlertOptions';
10
+ import { AdaptableMessageType } from '../../PredefinedConfig/Common/AdaptableMessageType';
11
+ import { GridDataChangedInfo } from '../Events/GridDataChanged';
10
12
  export declare class AlertApiImpl extends ApiBase implements AlertApi {
11
13
  getAlertState(): AlertState;
12
14
  getAdaptableFormByName(name: string): AdaptableForm<AlertButtonContext> | undefined;
@@ -22,7 +24,8 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
22
24
  executeAlertButton(button: AlertButton<AlertButtonContext>, context: AlertButtonContext): void;
23
25
  executeAlertAction(actionName: AdaptableAlertAction, details: {
24
26
  alertDefinition: AlertDefinition;
25
- dataChangedInfo?: DataChangedInfo;
27
+ cellDataChangedInfo?: CellDataChangedInfo;
28
+ gridDataChangedInfo?: GridDataChangedInfo;
26
29
  formData?: AdaptableFormData;
27
30
  }): void;
28
31
  displayAlert(alertToShow: AdaptableAlert): Promise<any>;
@@ -39,6 +42,6 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
39
42
  editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
40
43
  suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
41
44
  unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
42
- getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
45
+ getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
43
46
  getAlertRuleDescription(alert: AlertDefinition): string;
44
47
  }