@adaptabletools/adaptable 11.1.1-canary.0 → 11.1.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 (84) hide show
  1. package/README.md +6 -4
  2. package/agGrid.d.ts +2 -2
  3. package/base.css +4 -6
  4. package/bundle.cjs.js +67 -67
  5. package/index.css +4 -6
  6. package/package.json +2 -2
  7. package/publishTimestamp.d.ts +1 -1
  8. package/publishTimestamp.js +1 -1
  9. package/src/AdaptableInterfaces/IAdaptable.d.ts +2 -2
  10. package/src/AdaptableOptions/AlertOptions.d.ts +2 -2
  11. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +2 -2
  12. package/src/AdaptableOptions/EditOptions.d.ts +2 -2
  13. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +8 -12
  14. package/src/Api/AlertApi.d.ts +3 -5
  15. package/src/Api/DataChangeHistoryApi.d.ts +3 -3
  16. package/src/Api/Events/CellChanged.d.ts +2 -2
  17. package/src/Api/ExportApi.d.ts +3 -3
  18. package/src/Api/FreeTextColumnApi.d.ts +3 -3
  19. package/src/Api/GridApi.d.ts +4 -4
  20. package/src/Api/Implementation/AlertApiImpl.d.ts +3 -3
  21. package/src/Api/Implementation/AlertApiImpl.js +20 -20
  22. package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts +3 -3
  23. package/src/Api/Implementation/EventApiImpl.js +2 -1
  24. package/src/Api/Implementation/ExportApiImpl.d.ts +2 -2
  25. package/src/Api/Implementation/ExportApiImpl.js +7 -8
  26. package/src/Api/Implementation/FreeTextColumnApiImpl.d.ts +2 -2
  27. package/src/Api/Implementation/FreeTextColumnApiImpl.js +7 -7
  28. package/src/Api/Implementation/GridApiImpl.d.ts +3 -3
  29. package/src/Api/Implementation/GridApiImpl.js +5 -5
  30. package/src/Api/Implementation/InternalApiImpl.d.ts +2 -2
  31. package/src/Api/Implementation/InternalApiImpl.js +6 -6
  32. package/src/Api/Implementation/UserInterfaceApiImpl.js +3 -1
  33. package/src/Api/InternalApi.d.ts +2 -2
  34. package/src/Api/QueryLanguageApi.d.ts +6 -6
  35. package/src/PredefinedConfig/Common/AdaptableAlert.d.ts +2 -2
  36. package/src/PredefinedConfig/Common/AdaptableFlashingCell.d.ts +2 -2
  37. package/src/PredefinedConfig/Common/{DataChangedInfo.d.ts → CellDataChangedInfo.d.ts} +1 -5
  38. package/src/PredefinedConfig/Common/{DataChangedInfo.js → CellDataChangedInfo.js} +0 -0
  39. package/src/PredefinedConfig/Common/DataChangedScope.d.ts +4 -0
  40. package/src/PredefinedConfig/Common/DataChangedScope.js +2 -0
  41. package/src/PredefinedConfig/SystemState.d.ts +2 -2
  42. package/src/Redux/ActionsReducers/GridRedux.d.ts +5 -5
  43. package/src/Redux/ActionsReducers/SystemRedux.d.ts +5 -5
  44. package/src/Redux/ActionsReducers/SystemRedux.js +5 -5
  45. package/src/Redux/Store/AdaptableStore.js +15 -15
  46. package/src/Strategy/AlertModule.js +12 -10
  47. package/src/Strategy/BulkUpdateModule.js +2 -2
  48. package/src/Strategy/DataChangeHistoryModule.js +8 -6
  49. package/src/Strategy/FlashingCellModule.d.ts +2 -2
  50. package/src/Strategy/FlashingCellModule.js +21 -15
  51. package/src/Strategy/FormatColumnModule.js +4 -2
  52. package/src/Utilities/Constants/DocumentationLinkConstants.js +1 -1
  53. package/src/Utilities/Emitter.d.ts +1 -1
  54. package/src/Utilities/Emitter.js +3 -6
  55. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.d.ts +1 -1
  56. package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.d.ts +2 -2
  57. package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.js +1 -1
  58. package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.d.ts +1 -1
  59. package/src/Utilities/ObjectFactory.d.ts +2 -2
  60. package/src/Utilities/ObjectFactory.js +2 -2
  61. package/src/Utilities/Services/CalculatedColumnExpressionService.js +3 -3
  62. package/src/Utilities/Services/DataService.d.ts +5 -5
  63. package/src/Utilities/Services/DataService.js +12 -10
  64. package/src/Utilities/Services/Interface/IAlertService.d.ts +2 -2
  65. package/src/Utilities/Services/Interface/IDataService.d.ts +6 -6
  66. package/src/Utilities/Services/Interface/IQueryLanguageService.d.ts +3 -3
  67. package/src/Utilities/Services/Interface/IValidationService.d.ts +4 -4
  68. package/src/Utilities/Services/QueryLanguageService.d.ts +3 -3
  69. package/src/Utilities/Services/ValidationService.d.ts +4 -4
  70. package/src/Utilities/Services/ValidationService.js +17 -17
  71. package/src/View/DataChangeHistory/DataChangeHistoryGrid.d.ts +2 -2
  72. package/src/View/DataChangeHistory/DataChangeHistoryPopup.d.ts +2 -2
  73. package/src/agGrid/ActionColumnRenderer.d.ts +1 -6
  74. package/src/agGrid/ActionColumnRenderer.js +50 -59
  75. package/src/agGrid/Adaptable.d.ts +3 -2
  76. package/src/agGrid/Adaptable.js +97 -59
  77. package/src/agGrid/editors/AdaptableNumberEditor/index.d.ts +2 -0
  78. package/src/agGrid/editors/AdaptableNumberEditor/index.js +16 -2
  79. package/src/metamodel/adaptable.metamodel.d.ts +34 -34
  80. package/src/metamodel/adaptable.metamodel.js +77 -77
  81. package/src/types.d.ts +7 -1
  82. package/version.d.ts +1 -1
  83. package/version.js +1 -1
  84. package/LICENSE.md +0 -264
package/index.css CHANGED
@@ -3728,14 +3728,12 @@ html.ab--theme-dark .ab-ListBoxFilterForm--aggrid-style {
3728
3728
  width: 100%; }
3729
3729
 
3730
3730
  .ab-ActionColumn {
3731
- position: relative;
3732
- height: 100%; }
3731
+ height: 100%;
3732
+ display: flex;
3733
+ column-gap: var(--ab-space-1); }
3733
3734
 
3734
3735
  .ab-ActionColumn > button.ab-SimpleButton {
3735
- height: 100%;
3736
- position: absolute;
3737
- top: 0;
3738
- left: 0; }
3736
+ height: 100%; }
3739
3737
 
3740
3738
  .Toastify__toast-container {
3741
3739
  border-style: none;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "11.1.1-canary.0",
3
+ "version": "11.1.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",
@@ -17,7 +17,7 @@
17
17
  "blotter"
18
18
  ],
19
19
  "homepage": "http://www.adaptabletools.com/",
20
- "license": "SEE LICENSE IN LICENSE.md",
20
+ "license": "contact sales@adaptabletools.com for details",
21
21
  "author": {
22
22
  "name": "Jonny Wolfson",
23
23
  "email": "jonny.wolfson@adaptabletools.com"
@@ -1,2 +1,2 @@
1
- declare const _default: 1648213605950;
1
+ declare const _default: 1648553646478;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1648213605950;
3
+ exports.default = 1648553646478;
@@ -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';
@@ -164,7 +164,7 @@ export interface IAdaptable {
164
164
  lookupPlugins(propertyName: string, ...args: any): any;
165
165
  getPluginProperty(pluginId: string, propertyName: string, ...args: any): any;
166
166
  getPlugin(pluginId: string): AdaptablePlugin;
167
- setValue(dataChangedInfo: DataChangedInfo): void;
167
+ setValue(cellDataChangedInfo: CellDataChangedInfo): void;
168
168
  cancelEdit(): any;
169
169
  isCellEditable(rowNode: RowNode, column: Column): boolean;
170
170
  getFirstRowNode(): RowNode;
@@ -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
  *
@@ -33,29 +33,25 @@ export interface UserInterfaceOptions {
33
33
  */
34
34
  permittedValues?: PermittedValues[];
35
35
  /**
36
- * Dropdown values displayed when column is being edited.
37
- * When not defined it defaults to permittedValues.
36
+ * Dropdown values displayed when column is being edited; when not defined defaults to permittedValues
38
37
  */
39
38
  editLookUpItems?: EditLookUpPermittedValues[];
40
39
  /**
41
- * Dropdown values for filter options inside floating and header filter.
42
- * When not defined it defaults to permittedValues.
40
+ * Custom column values for 'IN' filter; when not defined defaults to permittedValues
43
41
  */
44
42
  filterPermittedValues?: FilterPermittedValues[];
45
43
  /**
46
- * Custom column values for defining custom sort.
47
- * When not defined it defaults to permittedValues.
44
+ * Custom column values for defining Custom Sort; when not defined defaults to permittedValues
48
45
  */
49
46
  customSortPermittedValues?: CustomSortPermittedValues[];
50
47
  /**
51
- * Custom column values for editing via bulk-update.
52
- * When not defined it defaults to permittedValues.
48
+ * Custom column values for editing via bulk-update; when not defined defaults to permittedValues
53
49
  */
54
50
  bulkUpdatePermittedValues?: BulkUpdatePermittedValues[];
55
51
  /**
56
- * Colours to display in Colour Picker (in place of AdapTable's default set)
52
+ * Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function
57
53
  */
58
- colorPalette?: string[] | (() => string[]);
54
+ colorPalette?: string[] | ((currentTheme: string) => string[]);
59
55
  /**
60
56
  * Columns which contain an AdapTable Button - used for performing Actions
61
57
  */
@@ -155,9 +151,9 @@ export interface ActionColumn extends AdaptableObject {
155
151
  */
156
152
  friendlyName?: string;
157
153
  /**
158
- * Button to display in the Column
154
+ * Button (or list of buttons) to display in the Column
159
155
  */
160
- actionColumnButton: AdaptableButton<ActionColumnButtonContext>;
156
+ actionColumnButton: AdaptableButton<ActionColumnButtonContext> | AdaptableButton<ActionColumnButtonContext>[];
161
157
  /**
162
158
  * Shows Action Column also in grouped rows
163
159
  */
@@ -1,5 +1,5 @@
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';
@@ -95,7 +95,7 @@ export interface AlertApi {
95
95
  */
96
96
  executeAlertAction(actionName: AdaptableAlertAction | string, details: {
97
97
  alertDefinition: AlertDefinition;
98
- dataChangedInfo?: DataChangedInfo;
98
+ cellDataChangedInfo?: CellDataChangedInfo;
99
99
  gridDataChangedInfo?: GridDataChangedInfo;
100
100
  formData?: AdaptableFormData;
101
101
  }): void;
@@ -103,8 +103,6 @@ export interface AlertApi {
103
103
  * Creates Alert formed from inputted values and displays it.
104
104
  * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)
105
105
  * @param alertMessage Main message of the alert
106
- * @param alertDefinition The Alert Definition which defines when the Alert is triggered
107
- * @param dataChangedInfo The (optional) DataChangedInfo object that might have triggered the Alert
108
106
  */
109
107
  showAlert(alertHeader: string, alertMessage: string, messageType: AdaptableMessageType, alertProperties?: AlertProperties): void;
110
108
  /**
@@ -166,7 +164,7 @@ export interface AlertApi {
166
164
  * Returns a description of an Alert Definition
167
165
  * @param alertDefinition Alert Definition to use
168
166
  */
169
- getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
167
+ getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
170
168
  /**
171
169
  * Returns a description of an Alert Definition's Rule
172
170
  * @param alertDefinition Alert Definition to use
@@ -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
  */
@@ -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
  }
@@ -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,7 +4,7 @@ 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';
@@ -75,9 +75,9 @@ export interface GridApi {
75
75
  }[]): void;
76
76
  /**
77
77
  * Reverses a data change (if triggered by cell edit)
78
- * @param dataChangedInfo data change to undo
78
+ * @param cellDataChangedInfo data change to undo
79
79
  */
80
- undoCellEdit(dataChangedInfo: DataChangedInfo): boolean;
80
+ undoCellEdit(cellDataChangedInfo: CellDataChangedInfo): boolean;
81
81
  /**
82
82
  * Returns all current Selected Cells in AdapTable
83
83
  */
@@ -330,7 +330,7 @@ export interface GridApi {
330
330
  /**
331
331
  * Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed
332
332
  */
333
- fireCellChangedEvent(cellChangedInfo: DataChangedInfo): void;
333
+ fireCellChangedEvent(cellChangedInfo: CellDataChangedInfo): void;
334
334
  /**
335
335
  * Fires Grid Data Changed Event - when a row has changed in AG Grid
336
336
  */
@@ -1,7 +1,7 @@
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';
@@ -24,7 +24,7 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
24
24
  executeAlertButton(button: AlertButton<AlertButtonContext>, context: AlertButtonContext): void;
25
25
  executeAlertAction(actionName: AdaptableAlertAction, details: {
26
26
  alertDefinition: AlertDefinition;
27
- dataChangedInfo?: DataChangedInfo;
27
+ cellDataChangedInfo?: CellDataChangedInfo;
28
28
  gridDataChangedInfo?: GridDataChangedInfo;
29
29
  formData?: AdaptableFormData;
30
30
  }): void;
@@ -42,6 +42,6 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
42
42
  editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
43
43
  suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
44
44
  unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
45
- getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
45
+ getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
46
46
  getAlertRuleDescription(alert: AlertDefinition): string;
47
47
  }
@@ -62,8 +62,8 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
62
62
  buttonOnClick === null || buttonOnClick === void 0 ? void 0 : buttonOnClick.handler(button, context);
63
63
  this.adaptable.api.alertApi.executeAlertAction(action, {
64
64
  alertDefinition: context.alert.alertDefinition,
65
- dataChangedInfo: AdaptableAlert_1.isAdaptableCellChangedAlert(context.alert)
66
- ? context.alert.dataChangedInfo
65
+ cellDataChangedInfo: AdaptableAlert_1.isAdaptableCellChangedAlert(context.alert)
66
+ ? context.alert.cellDataChangedInfo
67
67
  : null,
68
68
  gridDataChangedInfo: AdaptableAlert_1.isAdaptableRowChangedAlert(context.alert)
69
69
  ? context.alert.gridDataChangedInfo
@@ -74,7 +74,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
74
74
  }
75
75
  }
76
76
  executeAlertAction(actionName, details) {
77
- const { alertDefinition, dataChangedInfo, gridDataChangedInfo } = details;
77
+ const { alertDefinition, cellDataChangedInfo: cellDataChangedInfo, gridDataChangedInfo, } = details;
78
78
  const getBackgroundColor = (alertDefinition) => {
79
79
  var _a;
80
80
  const highlightType = (_a = alertDefinition.MessageType) !== null && _a !== void 0 ? _a : 'Info';
@@ -94,11 +94,11 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
94
94
  }
95
95
  return backgroundColor;
96
96
  };
97
- if (actionName === 'highlight-cell' && dataChangedInfo) {
97
+ if (actionName === 'highlight-cell' && cellDataChangedInfo) {
98
98
  const backgroundColor = getBackgroundColor(alertDefinition);
99
99
  this.adaptable.api.gridApi.highlightCell({
100
- columnId: dataChangedInfo.column.columnId,
101
- primaryKeyValue: dataChangedInfo.primaryKeyValue,
100
+ columnId: cellDataChangedInfo.column.columnId,
101
+ primaryKeyValue: cellDataChangedInfo.primaryKeyValue,
102
102
  highlightStyle: {
103
103
  BackColor: backgroundColor,
104
104
  },
@@ -120,8 +120,8 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
120
120
  };
121
121
  this.adaptable.api.gridApi.highlightRows(rowsHighlightInfo);
122
122
  }
123
- if (actionName === 'jump-to-cell' && dataChangedInfo) {
124
- this.adaptable.api.gridApi.jumpToCell(dataChangedInfo.primaryKeyValue, dataChangedInfo.column.columnId);
123
+ if (actionName === 'jump-to-cell' && cellDataChangedInfo) {
124
+ this.adaptable.api.gridApi.jumpToCell(cellDataChangedInfo.primaryKeyValue, cellDataChangedInfo.column.columnId);
125
125
  }
126
126
  if (actionName === 'jump-to-row' &&
127
127
  gridDataChangedInfo &&
@@ -133,14 +133,14 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
133
133
  this.adaptable.api.gridApi.jumpToRow(targetRowNodePrimaryKeyValue);
134
134
  }
135
135
  }
136
- if (actionName === 'jump-to-column' && dataChangedInfo) {
137
- this.adaptable.api.gridApi.jumpToColumn(dataChangedInfo.column.columnId);
136
+ if (actionName === 'jump-to-column' && cellDataChangedInfo) {
137
+ this.adaptable.api.gridApi.jumpToColumn(cellDataChangedInfo.column.columnId);
138
138
  }
139
139
  if (actionName === 'suspend') {
140
140
  this.adaptable.api.alertApi.suspendAlertDefinition(alertDefinition);
141
141
  }
142
- if (actionName === 'undo' && dataChangedInfo) {
143
- this.adaptable.api.gridApi.undoCellEdit(dataChangedInfo);
142
+ if (actionName === 'undo' && cellDataChangedInfo) {
143
+ this.adaptable.api.gridApi.undoCellEdit(cellDataChangedInfo);
144
144
  }
145
145
  }
146
146
  async displayAlert(alertToShow) {
@@ -188,8 +188,8 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
188
188
  // 4: Jump to the Cell
189
189
  if (alertProperties.JumpToCell &&
190
190
  AdaptableAlert_1.isAdaptableCellChangedAlert(alertToShow) &&
191
- alertToShow.dataChangedInfo) {
192
- this.adaptable.jumpToCell(alertToShow.dataChangedInfo.column.columnId, alertToShow.dataChangedInfo.rowNode);
191
+ alertToShow.cellDataChangedInfo) {
192
+ this.adaptable.jumpToCell(alertToShow.cellDataChangedInfo.column.columnId, alertToShow.cellDataChangedInfo.rowNode);
193
193
  }
194
194
  // 5: Jump to the Row
195
195
  else if (alertProperties.JumpToRow &&
@@ -204,13 +204,13 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
204
204
  // 6: Highlight the cell - we just refresh the cells to trigger a re-evaluation of the Adaptable.setupColumn[Style/Class]
205
205
  if (alertProperties.HighlightCell &&
206
206
  AdaptableAlert_1.isAdaptableCellChangedAlert(alertToShow) &&
207
- alertToShow.dataChangedInfo) {
208
- let alertNode = alertToShow.dataChangedInfo.rowNode;
207
+ alertToShow.cellDataChangedInfo) {
208
+ let alertNode = alertToShow.cellDataChangedInfo.rowNode;
209
209
  if (!alertNode) {
210
- alertNode = this.adaptable.getRowNodeForPrimaryKey(alertToShow.dataChangedInfo.primaryKeyValue);
210
+ alertNode = this.adaptable.getRowNodeForPrimaryKey(alertToShow.cellDataChangedInfo.primaryKeyValue);
211
211
  }
212
212
  if (alertNode) {
213
- this.adaptable.api.gridApi.refreshCells([alertNode], [alertToShow.dataChangedInfo.column.columnId]);
213
+ this.adaptable.api.gridApi.refreshCells([alertNode], [alertToShow.cellDataChangedInfo.column.columnId]);
214
214
  setTimeout(() => {
215
215
  this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
216
216
  }, this.adaptable.adaptableOptions.alertOptions.cellHighlightDuration);
@@ -275,11 +275,11 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
275
275
  this.dispatchAction(AlertRedux.AlertDefinitionUnSuspend(alertDefinition));
276
276
  return this.getAlertDefinitionById(alertDefinition.Uuid);
277
277
  }
278
- getAlertDescription(alertDefinition, dataChangedInfo) {
278
+ getAlertDescription(alertDefinition, cellDataChangedInfo) {
279
279
  var _a;
280
280
  const alertMessageFunction = (_a = this.adaptable.adaptableOptions.alertOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
281
281
  if (alertMessageFunction) {
282
- const returnText = alertMessageFunction(alertDefinition, dataChangedInfo);
282
+ const returnText = alertMessageFunction(alertDefinition, cellDataChangedInfo);
283
283
  if (returnText) {
284
284
  return returnText;
285
285
  }
@@ -1,12 +1,12 @@
1
1
  import { DataChangeHistoryApi } from '../DataChangeHistoryApi';
2
2
  import { ApiBase } from './ApiBase';
3
- import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
3
+ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
4
4
  export declare class DataChangeHistoryApiImpl extends ApiBase implements DataChangeHistoryApi {
5
5
  getDataChangeHistoryMode(): 'ACTIVE' | 'INACTIVE' | 'SUSPENDED';
6
6
  activateDataChangeHistory(forceReset?: boolean): void;
7
7
  deactivateDataChangeHistory(): void;
8
8
  suspendDataChangeHistory(): void;
9
- getDataChangeHistoryLog(): DataChangedInfo[];
10
- undoDataChangeHistoryEntry(dataChangeInfo: DataChangedInfo): void;
9
+ getDataChangeHistoryLog(): CellDataChangedInfo[];
10
+ undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
11
11
  showDataChangeHistoryPopup(): void;
12
12
  }
@@ -10,7 +10,8 @@ class EventApiImpl extends ApiBase_1.ApiBase {
10
10
  this.on = (eventName, callback) => {
11
11
  let result;
12
12
  if (eventName === 'AdaptableReady') {
13
- result = this.emitter.onIncludeFiredOnce(eventName, callback);
13
+ this.emitter.onIncludeFiredOnce(eventName).then(callback);
14
+ return () => { };
14
15
  }
15
16
  else {
16
17
  result = this.emitter.on(eventName, callback);
@@ -2,7 +2,7 @@ import { ExportApi } from '../ExportApi';
2
2
  import { ExportState, Report, ReportData, ReportSchedule, SystemReportNames } from '../../PredefinedConfig/ExportState';
3
3
  import { ApiBase } from './ApiBase';
4
4
  import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
5
- import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
5
+ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
6
6
  import { CustomDestination, ExportButtonContext } from '../../AdaptableOptions/ExportOptions';
7
7
  import { ExportDestination } from '../../PredefinedConfig/Common/Enums';
8
8
  export declare class ExportApiImpl extends ApiBase implements ExportApi {
@@ -25,7 +25,7 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
25
25
  showExportPopup(): void;
26
26
  editReport(report: Report): Report;
27
27
  editReports(reports: Report[]): Report[];
28
- isDataChangeInReport(dataChangedInfo: DataChangedInfo, report: Report): boolean;
28
+ isDataChangeInReport(cellDataChangedInfo: CellDataChangedInfo, report: Report): boolean;
29
29
  exportVisualDataToExcel(): void;
30
30
  runCustomReport(customReportName: string): ReportData | undefined;
31
31
  getReportDataForReport(reportName: string): ReportData | undefined;
@@ -95,7 +95,7 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
95
95
  });
96
96
  return reports === null || reports === void 0 ? void 0 : reports.map((report) => this.getReportById(report.Uuid));
97
97
  }
98
- isDataChangeInReport(dataChangedInfo, report) {
98
+ isDataChangeInReport(cellDataChangedInfo, report) {
99
99
  // for All Data Report any data change is true so get out asap
100
100
  if (report.Name == 'All Data') {
101
101
  return true;
@@ -111,22 +111,21 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
111
111
  break;
112
112
  case 'ScopeColumns':
113
113
  // use the Scope object which will tell us if the Column is relevant
114
- if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(dataChangedInfo.column, report.Scope)) {
114
+ if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(cellDataChangedInfo.column, report.Scope)) {
115
115
  return false;
116
116
  }
117
117
  break;
118
118
  case 'SelectedColumns':
119
119
  let selectedCellInfo = this.adaptable.api.gridApi.getSelectedCellInfo();
120
120
  if (selectedCellInfo) {
121
- if (selectedCellInfo.columns.find((c) => c.columnId == dataChangedInfo.column.columnId) ==
122
- null) {
121
+ if (selectedCellInfo.columns.find((c) => c.columnId == cellDataChangedInfo.column.columnId) == null) {
123
122
  return false;
124
123
  }
125
124
  }
126
125
  break;
127
126
  case 'VisibleColumns':
128
127
  // hope that visibile column property is updated whenever the layout changes... (need to check!)
129
- if (!dataChangedInfo.column.visible) {
128
+ if (!cellDataChangedInfo.column.visible) {
130
129
  return false;
131
130
  }
132
131
  break;
@@ -140,7 +139,7 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
140
139
  case 'SelectedCellRows':
141
140
  let selectedCellInfo = this.adaptable.api.gridApi.getSelectedCellInfo();
142
141
  if (selectedCellInfo && selectedCellInfo.gridCells) {
143
- if (selectedCellInfo.gridCells.find((gc) => gc.primaryKeyValue == dataChangedInfo.primaryKeyValue)) {
142
+ if (selectedCellInfo.gridCells.find((gc) => gc.primaryKeyValue == cellDataChangedInfo.primaryKeyValue)) {
144
143
  return true;
145
144
  }
146
145
  }
@@ -148,13 +147,13 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
148
147
  case 'SelectedRows':
149
148
  let selectedRowInfo = this.adaptable.api.gridApi.getSelectedRowInfo();
150
149
  if (selectedRowInfo && selectedRowInfo.gridRows) {
151
- if (selectedRowInfo.gridRows.find((gr) => gr.primaryKeyValue == dataChangedInfo.primaryKeyValue)) {
150
+ if (selectedRowInfo.gridRows.find((gr) => gr.primaryKeyValue == cellDataChangedInfo.primaryKeyValue)) {
152
151
  return true;
153
152
  }
154
153
  }
155
154
  return false;
156
155
  case 'VisibleRows':
157
- return this.adaptable.isRowNodeVisible(dataChangedInfo.rowNode);
156
+ return this.adaptable.isRowNodeVisible(cellDataChangedInfo.rowNode);
158
157
  }
159
158
  }
160
159
  exportVisualDataToExcel() {
@@ -1,7 +1,7 @@
1
1
  import { ApiBase } from './ApiBase';
2
2
  import { FreeTextColumnApi } from '../FreeTextColumnApi';
3
3
  import { FreeTextColumnState, FreeTextColumn, FreeTextStoredValue } from '../../PredefinedConfig/FreeTextColumnState';
4
- import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
4
+ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
5
5
  import { RowNode } from '@ag-grid-community/all-modules';
6
6
  export declare class FreeTextColumnApiImpl extends ApiBase implements FreeTextColumnApi {
7
7
  getFreeTextColumnState(): FreeTextColumnState;
@@ -16,6 +16,6 @@ export declare class FreeTextColumnApiImpl extends ApiBase implements FreeTextCo
16
16
  deleteFreeTextColumn(columnId: string): void;
17
17
  showFreeTextColumnPopup(): void;
18
18
  getFreeTextColumnValueFromRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;
19
- checkFreeTextColumnForDataChange(dataChangedInfo: DataChangedInfo): void;
19
+ checkFreeTextColumnForDataChange(cellDataChangedInfo: CellDataChangedInfo): void;
20
20
  getFreeTextColumnModuleReferences(freeTextColumn: FreeTextColumn): string[];
21
21
  }
@@ -94,20 +94,20 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
94
94
  return null;
95
95
  }
96
96
  }
97
- checkFreeTextColumnForDataChange(dataChangedInfo) {
98
- let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == dataChangedInfo.column.columnId);
97
+ checkFreeTextColumnForDataChange(cellDataChangedInfo) {
98
+ let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == cellDataChangedInfo.column.columnId);
99
99
  if (freeTextColumn) {
100
100
  let freeTextStoredValue = {
101
- PrimaryKey: dataChangedInfo.primaryKeyValue,
102
- FreeText: dataChangedInfo.newValue,
101
+ PrimaryKey: cellDataChangedInfo.primaryKeyValue,
102
+ FreeText: cellDataChangedInfo.newValue,
103
103
  };
104
104
  this.addEditFreeTextColumnStoredValue(freeTextColumn, freeTextStoredValue);
105
- var colsToRefresh = [dataChangedInfo.column.columnId];
106
- const refencedCalcColumns = this.adaptable.api.calculatedColumnApi.getCalculatedColumnsReferencingColumnId(dataChangedInfo.column.columnId);
105
+ var colsToRefresh = [cellDataChangedInfo.column.columnId];
106
+ const refencedCalcColumns = this.adaptable.api.calculatedColumnApi.getCalculatedColumnsReferencingColumnId(cellDataChangedInfo.column.columnId);
107
107
  refencedCalcColumns.forEach((calculatedColumn) => {
108
108
  colsToRefresh.push(calculatedColumn.ColumnId);
109
109
  });
110
- this.adaptable.refreshCells([dataChangedInfo.rowNode], colsToRefresh, false);
110
+ this.adaptable.refreshCells([cellDataChangedInfo.rowNode], colsToRefresh, false);
111
111
  }
112
112
  }
113
113
  getFreeTextColumnModuleReferences(freeTextColumn) {
@@ -10,7 +10,7 @@ import { CellHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightIn
10
10
  import { RowHighlightInfo } from '../../PredefinedConfig/Common/RowHighlightInfo';
11
11
  import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
12
12
  import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
13
- import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
13
+ import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
14
14
  import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
15
15
  import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightInfo';
16
16
  import { AccessLevel } from '../../PredefinedConfig/Common/Entitlement';
@@ -22,7 +22,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
22
22
  loadGridData(dataSource: any): void;
23
23
  updateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
24
24
  addGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
25
- undoCellEdit(dataChangedInfo: DataChangedInfo): boolean;
25
+ undoCellEdit(cellDataChangedInfo: CellDataChangedInfo): boolean;
26
26
  deleteGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
27
27
  setCellValue(columnId: string, newValue: any, primaryKeyValue: any): void;
28
28
  setCellsValue(gridCells: {
@@ -82,7 +82,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
82
82
  isQuickFilterAvailable(): boolean;
83
83
  redrawGrid(): void;
84
84
  fireSearchChangedEvent(searchChangedTrigger: 'DataSource' | 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort'): void;
85
- fireCellChangedEvent(dataChangedInfo: DataChangedInfo): void;
85
+ fireCellChangedEvent(cellDataChangedInfo: CellDataChangedInfo): void;
86
86
  fireGridDataChangedEvent(dataRows: any[], rowNodes: RowNode[], rowTrigger: 'Add' | 'Edit' | 'Delete'): void;
87
87
  jumpToRow(primaryKeyValue: any): void;
88
88
  jumpToColumn(columnId: string): void;