@adaptabletools/adaptable 13.0.0-canary.8 → 13.0.0-canary.9

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 (49) hide show
  1. package/agGrid.d.ts +10 -10
  2. package/agGrid.js +10 -10
  3. package/bundle.cjs.js +154 -154
  4. package/package.json +1 -1
  5. package/publishTimestamp.d.ts +1 -1
  6. package/publishTimestamp.js +1 -1
  7. package/src/AdaptableInterfaces/IAdaptable.d.ts +4 -3
  8. package/src/AdaptableOptions/AdaptableOptions.d.ts +0 -2
  9. package/src/AdaptableOptions/AdaptableQLOptions.d.ts +87 -30
  10. package/src/AdaptableOptions/FinsemblePluginOptions.d.ts +32 -0
  11. package/src/AdaptableOptions/FinsemblePluginOptions.js +2 -0
  12. package/src/AdaptableOptions/GeneralOptions.d.ts +1 -2
  13. package/src/Api/ConditionalStyleApi.d.ts +20 -62
  14. package/src/Api/ConfigApi.d.ts +1 -2
  15. package/src/Api/FinsembleApi.d.ts +10 -0
  16. package/src/Api/FinsembleApi.js +2 -0
  17. package/src/Api/Implementation/PluginsApiImpl.d.ts +2 -0
  18. package/src/Api/Implementation/PluginsApiImpl.js +6 -0
  19. package/src/Api/PluginsApi.d.ts +5 -0
  20. package/src/PredefinedConfig/ConditionalStyleState.d.ts +10 -19
  21. package/src/PredefinedConfig/FormatColumnState.d.ts +0 -6
  22. package/src/Strategy/DataChangeHistoryModule.d.ts +1 -0
  23. package/src/Strategy/DataChangeHistoryModule.js +12 -0
  24. package/src/Strategy/FormatColumnModule.js +1 -1
  25. package/src/Strategy/Utilities/FormatColumn/getFormatColumnSettingsViewItems.d.ts +1 -1
  26. package/src/Strategy/Utilities/FormatColumn/getFormatColumnSettingsViewItems.js +3 -4
  27. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +5 -10
  28. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.d.ts +1 -1
  29. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.js +3 -4
  30. package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.d.ts +1 -1
  31. package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.js +3 -4
  32. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.d.ts +1 -1
  33. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.js +3 -4
  34. package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.d.ts +1 -1
  35. package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.js +3 -4
  36. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.d.ts +1 -1
  37. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.js +3 -4
  38. package/src/Utilities/ObjectFactory.js +0 -1
  39. package/src/Utilities/Services/QueryLanguageService.d.ts +1 -3
  40. package/src/Utilities/Services/QueryLanguageService.js +48 -52
  41. package/src/View/FormatColumn/Wizard/FormatColumnSettingsWizardSection.js +0 -22
  42. package/src/View/FormatColumn/Wizard/FormatColumnStyleWizardSection.js +0 -1
  43. package/src/agGrid/Adaptable.d.ts +2 -2
  44. package/src/agGrid/Adaptable.js +1 -14
  45. package/src/metamodel/adaptable.metamodel.d.ts +65 -47
  46. package/src/metamodel/adaptable.metamodel.js +1 -1
  47. package/src/types.d.ts +3 -1
  48. package/version.d.ts +1 -1
  49. package/version.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "13.0.0-canary.8",
3
+ "version": "13.0.0-canary.9",
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",
@@ -1,2 +1,2 @@
1
- declare const _default: 1663338382332;
1
+ declare const _default: 1663578684346;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1663338382332;
3
+ exports.default = 1663578684346;
@@ -1,4 +1,4 @@
1
- import { ChartModel, ChartRef, Column, GridOptions, RowNode } from '@ag-grid-community/core';
1
+ import { ChartModel, ChartRef, Column, GridOptions, ModuleNames, RowNode } from '@ag-grid-community/core';
2
2
  import { AdaptableApi } from '../Api/AdaptableApi';
3
3
  import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
4
4
  import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
@@ -216,6 +216,8 @@ export interface IAdaptable {
216
216
  exportVisualDataToExcel(): void;
217
217
  canGenerateCharts(): boolean;
218
218
  canHaveSparklines(): boolean;
219
+ showCharts(charts: ChartModel[]): ChartRef[];
220
+ getChartModels(): ChartModel[];
219
221
  getCurrentIPPStyle(): IPPStyle;
220
222
  getDefaultIPPStyle(): IPPStyle;
221
223
  getRowCount(): number;
@@ -255,6 +257,5 @@ export interface IAdaptable {
255
257
  skipSetupColumns?: boolean;
256
258
  }): void;
257
259
  getAgGridColumnForColumnId(columnId: string): Column;
258
- showCharts(charts: ChartModel[]): ChartRef[];
259
- getChartModels(): ChartModel[];
260
+ isAgGridModulePresent(moduleName: ModuleNames): boolean;
260
261
  }
@@ -50,8 +50,6 @@ export interface AdaptableOptions {
50
50
  autogeneratePrimaryKey?: boolean;
51
51
  /**
52
52
  * The AG Grid object which AdapTable interacts with. Note: if using AdapTable React or AdapTable Angular, no need to populate this property as AdapTable wires it up differently
53
- *
54
- * @defaultValue n/a (Mandatory)
55
53
  */
56
54
  gridOptions?: GridOptions;
57
55
  /**
@@ -41,7 +41,7 @@ export interface AdaptableQLOptions {
41
41
  */
42
42
  customPredicateDefs?: AdaptablePredicateDef[];
43
43
  /**
44
- * Reference a Column's Header (Friendlyname) in all Expression overviews (instead of ColumnId)
44
+ * Reference a Column's Header (FriendlyName) in all Expression overviews (instead of ColumnId)
45
45
  *
46
46
  * @defaultValue true
47
47
  */
@@ -52,44 +52,58 @@ export interface AdaptableQLOptions {
52
52
  */
53
53
  export interface ExpressionOptions {
54
54
  /**
55
- * Boolean Expression Functions available in AdaptableQL
55
+ * System (built-in) Boolean Expression Functions available in AdaptableQL
56
56
  *
57
57
  * @defaultValue null (sets all)
58
58
  * @gridInfoItem
59
59
  */
60
- defaultBooleanFunctions?: ExpressionFunctionDefinitions<BooleanFunctionName> | ((context: DefaultExpressionFunctionsContext<BooleanFunctionName>) => ExpressionFunctionDefinitions<BooleanFunctionName>);
60
+ systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
61
61
  /**
62
- * Scalar Expression Functions available in AdaptableQL
62
+ * Custom (user defined) Boolean Expression Functions available in AdaptableQL
63
63
  *
64
- * @defaultValue null (sets all)
64
+ * @defaultValue null (none)
65
65
  * @gridInfoItem
66
66
  */
67
- defaultScalarFunctions?: ExpressionFunctionDefinitions<ScalarFunctionName> | ((context: DefaultExpressionFunctionsContext<ScalarFunctionName>) => ExpressionFunctionDefinitions<ScalarFunctionName>);
67
+ customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
68
68
  /**
69
- * Observable Expression Functions available in AdaptableQL
69
+ * System (built-in) Scalar Expression Functions available in AdaptableQL
70
70
  *
71
71
  * @defaultValue null (sets all)
72
72
  * @gridInfoItem
73
73
  */
74
- defaultObservableFunctions?: ExpressionFunctionDefinitions<ObservableFunctionName> | ((context: DefaultExpressionFunctionsContext<ObservableFunctionName>) => ExpressionFunctionDefinitions<ObservableFunctionName>);
74
+ systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
75
+ /**
76
+ * Custom (user defined) Scalar Expression Functions available in AdaptableQL
77
+ *
78
+ * @defaultValue null (none)
79
+ * @gridInfoItem
80
+ */
81
+ customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
75
82
  /**
76
- * Aggregated Boolean Expression Functions available in AdaptableQL
83
+ * System (built-in) Observable Expression Functions available in AdaptableQL
77
84
  *
78
85
  * @defaultValue null (sets all)
79
86
  * @gridInfoItem
80
87
  */
81
- defaultAggregatedBooleanFunctions?: ExpressionFunctionDefinitions<AggregatedBooleanFunctionName> | ((context: DefaultExpressionFunctionsContext<AggregatedBooleanFunctionName>) => ExpressionFunctionDefinitions<AggregatedBooleanFunctionName>);
88
+ systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
82
89
  /**
83
- * Aggregated Scalar Expression Functions available in AdaptableQL
90
+ * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
84
91
  *
85
92
  * @defaultValue null (sets all)
86
93
  * @gridInfoItem
87
94
  */
88
- defaultAggregatedScalarFunctions?: ExpressionFunctionDefinitions<AggregatedScalarFunctionName> | ((context: DefaultExpressionFunctionsContext<AggregatedScalarFunctionName>) => ExpressionFunctionDefinitions<AggregatedScalarFunctionName>);
95
+ systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
96
+ /**
97
+ * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
98
+ *
99
+ * @defaultValue undefined (sets all)
100
+ * @gridInfoItem
101
+ */
102
+ systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
89
103
  /**
90
- * Module specific ExpressionFunctions; if not defined, it falls back to the defined default values
104
+ * Module specific ExpressionFunctions; if not defined, it falls back to the generally defined system and custom values
91
105
  *
92
- * @defaultValue undefined (defaults to default values)
106
+ * @defaultValue undefined (defaults to available system & custom values)
93
107
  * @gridInfoItem
94
108
  */
95
109
  moduleExpressionFunctions?: ModuleExpressionFunctionsMap | ((context: ModuleExpressionFunctionsContext) => ModuleExpressionFunctions | undefined);
@@ -119,10 +133,6 @@ export interface ExpressionOptions {
119
133
  */
120
134
  customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
121
135
  }
122
- /**
123
- * ExpressionFunctions which may be either referenced by name (for internal Adaptable functions) or provided with custom implementation
124
- */
125
- export declare type ExpressionFunctionDefinitions<T> = (T | Record<string, ExpressionFunction>)[];
126
136
  /**
127
137
  * Module specific Expression Functions
128
138
  */
@@ -131,16 +141,63 @@ export declare type ModuleExpressionFunctionsMap = Partial<Record<AdaptableModul
131
141
  * Type specific Expression Functions
132
142
  */
133
143
  export interface ModuleExpressionFunctions {
134
- booleanFunctions?: ExpressionFunctionDefinitions<BooleanFunctionName>;
135
- scalarFunctions?: ExpressionFunctionDefinitions<ScalarFunctionName>;
136
- observableFunctions?: ExpressionFunctionDefinitions<ObservableFunctionName>;
137
- aggregatedBooleanFunctions?: ExpressionFunctionDefinitions<AggregatedBooleanFunctionName>;
138
- aggregatedScalarFunctions?: ExpressionFunctionDefinitions<AggregatedScalarFunctionName>;
144
+ /**
145
+ * System (built-in) Boolean Expression Functions available in AdaptableQL
146
+ *
147
+ * @defaultValue null (sets all)
148
+ * @gridInfoItem
149
+ */
150
+ systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
151
+ /**
152
+ * Custom (user defined) Boolean Expression Functions available in AdaptableQL
153
+ *
154
+ * @defaultValue null (none)
155
+ * @gridInfoItem
156
+ */
157
+ customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
158
+ /**
159
+ * System (built-in) Scalar Expression Functions available in AdaptableQL
160
+ *
161
+ * @defaultValue null (sets all)
162
+ * @gridInfoItem
163
+ */
164
+ systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
165
+ /**
166
+ * Custom (user defined) Scalar Expression Functions available in AdaptableQL
167
+ *
168
+ * @defaultValue null (none)
169
+ * @gridInfoItem
170
+ */
171
+ customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
172
+ /**
173
+ * System (built-in) Observable Expression Functions available in AdaptableQL
174
+ *
175
+ * @defaultValue null (sets all)
176
+ * @gridInfoItem
177
+ */
178
+ systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
179
+ /**
180
+ * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
181
+ *
182
+ * @defaultValue null (sets all)
183
+ * @gridInfoItem
184
+ */
185
+ systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
186
+ /**
187
+ * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
188
+ *
189
+ * @defaultValue null (sets all)
190
+ * @gridInfoItem
191
+ */
192
+ systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
139
193
  }
140
194
  /**
141
- * Context provided to ExpressionOptions.defaultExpressionFunctions property callback
195
+ * Context provided to global expression functions properties property callback
142
196
  */
143
- export interface DefaultExpressionFunctionsContext<T> extends BaseContext {
197
+ export interface GlobalExpressionFunctionsContext<T> extends BaseContext {
198
+ /**
199
+ * The names of all expression functions available in this context
200
+ */
144
201
  availableExpressionFunctionNames: T[];
145
202
  }
146
203
  /**
@@ -148,11 +205,11 @@ export interface DefaultExpressionFunctionsContext<T> extends BaseContext {
148
205
  */
149
206
  export interface ModuleExpressionFunctionsContext extends BaseContext {
150
207
  module: AdaptableModule;
151
- defaultBooleanFunctionNames: BooleanFunctionName[];
152
- defaultScalarFunctionNames: ScalarFunctionName[];
153
- defaultObservableFunctionNames: ObservableFunctionName[];
154
- defaultAggregatedBooleanFunctionNames: AggregatedBooleanFunctionName[];
155
- defaultAggregatedScalarFunctionNames: AggregatedScalarFunctionName[];
208
+ availableBooleanFunctionNames: BooleanFunctionName[];
209
+ availableScalarFunctionNames: ScalarFunctionName[];
210
+ availableObservableFunctionNames: ObservableFunctionName[];
211
+ availableAggregatedBooleanFunctionNames: AggregatedBooleanFunctionName[];
212
+ availableAggregatedScalarFunctionNames: AggregatedScalarFunctionName[];
156
213
  }
157
214
  /**
158
215
  * Context passed when evaluating `ExpressionOptions.customQueryVariables`
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Options required for when using the Finsemble plugin
3
+ */
4
+ export interface FinsemblePluginOptions {
5
+ /**
6
+ * Application name - used to identify the application in Finsemble console
7
+ */
8
+ applicationName?: string;
9
+ /**
10
+ * Options for managing Adaptable State with Finsemble State
11
+ */
12
+ stateOptions?: FinsemblePluginStateOptions;
13
+ /**
14
+ * Should Adaptable's Alerts appear as Finsemble Notifications
15
+ * @defaultValue true
16
+ */
17
+ showAdaptableAlertsAsNotifications?: boolean;
18
+ }
19
+ export interface FinsemblePluginStateOptions {
20
+ /**
21
+ * Whether to persist AdapTable State inside Finsemble
22
+ */
23
+ persistInFinsemble: boolean;
24
+ /**
25
+ * Key used to persist/load AdapTable State in Finsemble
26
+ */
27
+ key: string;
28
+ /**
29
+ * Topic used to persist/load AdapTable State in Finsemble
30
+ */
31
+ topic: string;
32
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -66,8 +66,7 @@ export interface GeneralOptions {
66
66
  */
67
67
  unbalancedGroupsKey?: string | ((context: UnbalancedGroupsKeyContext) => string);
68
68
  /**
69
- * Starting with v13, ConditionalStyle module is deprecated, and it's functionality is merged into the FormatColumn module. By default, all existing conditional styles are migrated to format columns. By setting this property to TRUE, the conditional styles are not migrated.
70
- *
69
+ * Specifies whether Conditional Styles (deprecated in v13) will be auto-merged into Format Columns
71
70
  * @defaultValue false
72
71
  */
73
72
  keepDeprecatedConditionalStyles?: boolean;
@@ -2,127 +2,85 @@ import { ConditionalStyleState, ConditionalStyle } from '../PredefinedConfig/Con
2
2
  import { AdaptableColumn, AdaptableScope } from '../types';
3
3
  import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
4
4
  /**
5
- * Provides run-time access to Conditional Style Module and state
5
+ * Deprecated API section - use `FormatColumnAPI` instead
6
6
  */
7
7
  export interface ConditionalStyleApi {
8
8
  /**
9
- * Retrieves Conditional Style section from Adaptable State
10
- * @deprecated use `FormatColumn` instead
9
+ * @deprecated use `FormatColumnָAPI` instead
11
10
  */
12
11
  getConditionalStyleState(): ConditionalStyleState;
13
12
  /**
14
- * Gets all Conditional Styles in Adaptable State
15
- * @deprecated use `FormatColumn` instead
13
+ * @deprecated use `FormatColumnָAPI` instead
16
14
  */
17
15
  getAllConditionalStyle(config?: {
18
16
  includeLayoutNotAssociatedObjects?: boolean;
19
17
  }): ConditionalStyle[];
20
18
  /**
21
- * Get conditional style by id
22
- *
23
- * @deprecated use `FormatColumn` instead
24
- * @param id conditional style id
25
- * @returns conditional style
19
+ * @deprecated use `FormatColumnָAPI` instead
26
20
  */
27
21
  getConditionalStyleById(id: ConditionalStyle['Uuid']): ConditionalStyle;
28
22
  /**
29
- * Gets all Conditional Styles that are active (not-suspended) in Adaptable State
30
- * @deprecated use `FormatColumn` instead
31
- * @returns conditional styles
23
+ * @deprecated use `FormatColumnָAPI` instead
32
24
  */
33
25
  getAllActiveConditionalStyle(): ConditionalStyle[];
34
26
  /**
35
- * Gets all Conditional Styles that are suspended in Adaptable State
36
- * @deprecated use `FormatColumn` instead
37
- * @returns conditional styles
27
+ * @deprecated use `FormatColumnָAPI` instead
38
28
  */
39
29
  getAllSuspendedConditionalStyle(): ConditionalStyle[];
40
30
  /**
41
- * Opens Settings Panel with Conditional Style section selected and visible
42
- * @deprecated use `FormatColumn` instead
31
+ * @deprecated use `FormatColumnָAPI` instead
43
32
  */
44
33
  showConditionalStylePopup(): void;
45
34
  /**
46
- * Retrieves all Conditional Styles that style whole row
47
- * @deprecated use `FormatColumn` instead
48
- * @returns conditional styles
35
+ * @deprecated use `FormatColumnָAPI` instead
49
36
  */
50
37
  getRowConditionalStyles(): ConditionalStyle[] | undefined;
51
38
  /**
52
- * Retrieves all Conditional Styles which have an Expression
53
- * @deprecated use `FormatColumn` instead
54
- * @returns conditional styles
39
+ * @deprecated use `FormatColumnָAPI` instead
55
40
  */
56
41
  getConditionalStylesWithExpression(): ConditionalStyle[] | undefined;
57
42
  /**
58
- * Gets all Conditional Styles that style a given Column
59
- * @deprecated use `FormatColumn` instead
60
- * @param column Column to check
61
- * @returns conditional styles
43
+ * @deprecated use `FormatColumnָAPI` instead
62
44
  */
63
45
  getConditionalStylesForColumn(column: AdaptableColumn): ConditionalStyle[] | undefined;
64
46
  /**
65
- * Returns all Predicates usable in Conditional Styles
66
- * @deprecated use `FormatColumn` instead
47
+ * @deprecated use `FormatColumnָAPI` instead
67
48
  */
68
49
  getConditionalStylePredicateDefs(): AdaptablePredicateDef[];
69
50
  /**
70
- * Returns all Predicates appropriate for the given Scope
71
- * @deprecated use `FormatColumn` instead
72
- * @param scope Scope to check
51
+ * @deprecated use `FormatColumnָAPI` instead
73
52
  */
74
53
  getCondStylePredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
75
54
  /**
76
- * Retrieves all Conditional Styles ordered by Column then Row
77
- * @deprecated use `FormatColumn` instead
78
- * @returns conditional style
55
+ * @deprecated use `FormatColumnָAPI` instead
79
56
  */
80
57
  getOrderedConditionalStyles(): ConditionalStyle[] | undefined;
81
58
  /**
82
- * Replaces Conditional Style in State with given one
83
- * @deprecated use `FormatColumn` instead
84
- * @param conditionalStyle Conditional Style to edit
85
- * @returns conditional style
59
+ * @deprecated use `FormatColumnָAPI` instead
86
60
  */
87
61
  editConditionalStyle(conditionalStyle: ConditionalStyle): ConditionalStyle;
88
62
  /**
89
- * Replaces Conditional Styles in State with given ones
90
- * @deprecated use `FormatColumn` instead
91
- * @param conditionalStyles Conditional Styles to edit
92
- * @returns conditional styles
63
+ * @deprecated use `FormatColumnָAPI` instead
93
64
  */
94
65
  editConditionalStyles(conditionalStyles: ConditionalStyle[]): ConditionalStyle[];
95
66
  /**
96
- * Deletes a Conditional Style
97
- * @deprecated use `FormatColumn` instead
98
- * @param conditionalStyle Conditional Style to delete
67
+ * @deprecated use `FormatColumnָAPI` instead
99
68
  */
100
69
  deleteConditionalStyle(conditionalStyle: ConditionalStyle): void;
101
70
  /**
102
- * Deletes Conditional Styles
103
- * @deprecated use `FormatColumn` instead
104
- * @param conditionalStyles Conditional Styles to delete
71
+ * @deprecated use `FormatColumnָAPI` instead
105
72
  */
106
73
  deleteConditionalStyles(conditionalStyles: ConditionalStyle[]): void;
107
74
  /**
108
- * Adds new Conditional Style to State
109
- * @deprecated use `FormatColumn` instead
110
- * @param conditionalStyle Conditional Style to add
111
- * @returns conditional style
75
+ * @deprecated use `FormatColumnָAPI` instead
112
76
  */
113
77
  addConditionalStyle(conditionalStyle: ConditionalStyle): ConditionalStyle;
114
78
  /**
115
- * Suspends conditional style, a readonly object cannot be suspended
116
- * @deprecated use `FormatColumn` instead
117
- * @param conditionalStyle Conditional Style to suspend
118
- * @returns conditional style
79
+ * @deprecated use `FormatColumnָAPI` instead
119
80
  */
120
81
  suspendConditionalStyle(conditionalStyle: ConditionalStyle): ConditionalStyle;
121
82
  /**
122
- * Un-suspends or activates a suspended conditional style
123
- * @deprecated use `FormatColumn` instead
124
- * @param conditionalStyle Conditional Style to suspend
125
- * @returns conditional style
83
+ * @deprecated use `FormatColumnָAPI` instead
126
84
  */
127
85
  unSuspendConditionalStyle(conditionalStyle: ConditionalStyle): ConditionalStyle;
128
86
  }
@@ -116,8 +116,7 @@ export interface ConfigApi {
116
116
  */
117
117
  getCalculatedColumnState(returnJson: boolean): CalculatedColumnState;
118
118
  /**
119
- * Returns Conditional Style section of Adaptable State
120
- * @param returnJson return as JSON rather than object
119
+ * @deprecated use `getFormatColumnState` instead
121
120
  */
122
121
  getConditionalStyleState(returnJson: boolean): ConditionalStyleState;
123
122
  /**
@@ -0,0 +1,10 @@
1
+ import { FinsemblePluginOptions } from '../AdaptableOptions/FinsemblePluginOptions';
2
+ /**
3
+ * Provides run-time access to the Finsemble Plugin
4
+ */
5
+ export interface FinsembleApi {
6
+ /**
7
+ * Retrieves the FinsemblePlugOptions provided in Finsemble Plugin
8
+ */
9
+ getPluginOptions(): FinsemblePluginOptions;
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,6 +5,7 @@ import { IPushPullApi } from '../IPushPullApi';
5
5
  import { Glue42Api } from '../Glue42Api';
6
6
  import { OpenFinApi } from '../OpenFinApi';
7
7
  import { FinanceApi } from '../FinanceApi';
8
+ import { FinsembleApi } from '../FinsembleApi';
8
9
  export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
9
10
  getPluginsState(): PluginsState;
10
11
  getPluginState(pluginId: string): any;
@@ -15,4 +16,5 @@ export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
15
16
  getGlue42PluginApi(): Glue42Api;
16
17
  getOpenFinPluginApi(): OpenFinApi;
17
18
  getFinancePluginApi(): FinanceApi;
19
+ getFinsemblePluginApi(): FinsembleApi;
18
20
  }
@@ -32,6 +32,9 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
32
32
  if (pluginId === 'openfin') {
33
33
  return api;
34
34
  }
35
+ if (pluginId === 'finsemble') {
36
+ return api;
37
+ }
35
38
  return api;
36
39
  }
37
40
  catch (ex) {
@@ -50,5 +53,8 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
50
53
  getFinancePluginApi() {
51
54
  return this.getPluginApi('finance');
52
55
  }
56
+ getFinsemblePluginApi() {
57
+ return this.getPluginApi('finsemble');
58
+ }
53
59
  }
54
60
  exports.PluginsApiImpl = PluginsApiImpl;
@@ -3,6 +3,7 @@ import { IPushPullApi } from './IPushPullApi';
3
3
  import { Glue42Api } from './Glue42Api';
4
4
  import { OpenFinApi } from './OpenFinApi';
5
5
  import { FinanceApi } from './FinanceApi';
6
+ import { FinsembleApi } from './FinsembleApi';
6
7
  /**
7
8
  * API methods dealing with AdapTable plugins
8
9
  */
@@ -44,4 +45,8 @@ export interface PluginsApi {
44
45
  * Returns Finance API class in Adaptable API
45
46
  */
46
47
  getFinancePluginApi(): FinanceApi;
48
+ /**
49
+ * Returns Finsemble API class in Adaptable API
50
+ */
51
+ getFinsemblePluginApi(): FinsembleApi;
47
52
  }
@@ -7,41 +7,32 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
7
7
  import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
8
8
  import { SuspendableObject } from './Common/SuspendableObject';
9
9
  /**
10
- * Predefined Configuration for the Conditional Style Module
10
+ * Deprecated section of Adaptable State - use `FormatColumnState` instead
11
+ * @deprecated use `FormatColumnState` instead
11
12
  **/
12
13
  export interface ConditionalStyleState extends ConfigState {
13
- /**
14
- * Array of Conditional Styles to ship with AdapTable
15
- */
16
14
  ConditionalStyles?: ConditionalStyle[];
17
15
  }
18
16
  /**
19
- * Object used in Conditional Style function - contains Scope, a Rule and a Style
17
+ * Deprecated Adaptable Object - use `FormatColumn` instead
18
+ * @deprecated use `FormatColumn` instead
20
19
  */
21
20
  export interface ConditionalStyle extends SuspendableObject {
22
- /**
23
- * Where Style is applied - can be whole Row, some Columns or all Columns of given DataType
24
- */
25
21
  Scope: AdaptableScope;
26
- /**
27
- * Predicate-based Rule to use for deciding if a style needs to be applied.
28
- */
29
22
  Rule: ConditionalStyleRule;
30
- /**
31
- * Adaptable Style (e.g. font properties and colurs) to apply.
32
- */
33
23
  Style: AdaptableStyle;
34
- /**
35
- * Whether to apply Style in Grouped Rows and when Pivoting
36
- * @defaultValue false
37
- */
38
24
  IncludeGroupedRows?: boolean;
39
25
  }
26
+ /**
27
+ * Deprecated - use `FormatColumnPredicate` instead
28
+ * @deprecated use `FormatColumnPredicate` instead
29
+ */
40
30
  export interface ConditionalStylePredicate extends AdaptablePredicate {
41
31
  PredicateId: TypeHint<string, SystemConditionalStylePredicateId>;
42
32
  }
43
33
  /**
44
- * The Conditional Style Rule - can be either a Predicate or an Expression
34
+ * Deprecated - use `FormatColumnRule` instead
35
+ * @deprecated use `FormatColumnRule` instead
45
36
  */
46
37
  export declare type ConditionalStyleRule = XOR<{
47
38
  Predicate: ConditionalStylePredicate;
@@ -44,12 +44,6 @@ export interface FormatColumn extends SuspendableObject {
44
44
  * Aligns cells 'Left' or 'Right' or 'Center'
45
45
  */
46
46
  CellAlignment?: 'Left' | 'Right' | 'Center';
47
- /**
48
- * Text to display in Column Header (doesn't change ColumnId)
49
- *
50
- * @deprecated use `Layout.ColumnHeadersMap` instead
51
- */
52
- HeaderName?: string;
53
47
  /**
54
48
  * Whether to Format the Column in Grouped Rows
55
49
  * @defaultValue false
@@ -3,6 +3,7 @@ import { AdaptableModuleView, IModule } from './Interface/IModule';
3
3
  import { AdaptableApi } from '../Api/AdaptableApi';
4
4
  export declare class DataChangeHistoryModule extends AdaptableModuleBase implements IModule {
5
5
  constructor(api: AdaptableApi);
6
+ isModuleAvailable(): boolean;
6
7
  getPopupMaxWidth(): number;
7
8
  hasNamedQueryReferences(): boolean;
8
9
  private shouldLogDataChange;
@@ -6,6 +6,8 @@ const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
6
6
  const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
7
7
  const SystemRedux_1 = require("../Redux/ActionsReducers/SystemRedux");
8
8
  const DataChangeHistoryStatusBarContent_1 = require("../View/DataChangeHistory/DataChangeHistoryStatusBarContent");
9
+ const core_1 = require("@ag-grid-community/core");
10
+ const LoggingHelper_1 = require("../Utilities/Helpers/LoggingHelper");
9
11
  class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase {
10
12
  constructor(api) {
11
13
  super(ModuleConstants.DataChangeHistoryModuleId, ModuleConstants.DataChangeHistoryFriendlyName, 'track-changes', 'DataChangeHistoryPopup', 'Provides an overview of all previous changes, giving the possibility to undo specific changes', api);
@@ -19,6 +21,16 @@ class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase
19
21
  }
20
22
  });
21
23
  }
24
+ isModuleAvailable() {
25
+ const isAdaptableModuleAvailable = super.isModuleAvailable();
26
+ const isAgGridModuleAvailable = this.api.internalApi
27
+ .getAdaptableInstance()
28
+ .isAgGridModulePresent(core_1.ModuleNames.ClientSideRowModelModule);
29
+ if (isAdaptableModuleAvailable && !isAgGridModuleAvailable) {
30
+ (0, LoggingHelper_1.LogAdaptableWarning)(`Data Change History is NOT available due to missing required AG Grid module: ${core_1.ModuleNames.ClientSideRowModelModule}`);
31
+ }
32
+ return isAdaptableModuleAvailable && isAgGridModuleAvailable;
33
+ }
22
34
  getPopupMaxWidth() {
23
35
  return 1000;
24
36
  }
@@ -60,7 +60,7 @@ class FormatColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
60
60
  if ((_b = (_a = this.api.internalApi
61
61
  .getState()
62
62
  .FormatColumn) === null || _a === void 0 ? void 0 : _a.FormatColumns) === null || _b === void 0 ? void 0 : _b.some((formatColumn) => !!formatColumn.HeaderName)) {
63
- (0, LoggingHelper_1.ConsoleLogWarning)(`DEPRECATED: The 'FormatColumn.HeaderName' property is deprecated; use a Layout custom Column Header instead!`);
63
+ (0, LoggingHelper_1.ConsoleLogWarning)(`The 'FormatColumn.HeaderName' property was removed; use a Layout custom Column Header instead!`);
64
64
  }
65
65
  this.updateGradientColumnsOldConfig();
66
66
  const keepDeprecatedConditionalStyles = this.api.internalApi.shouldKeepDeprecatedConditionalStyles();
@@ -1,5 +1,5 @@
1
1
  import { FormatColumn } from '../../../../types';
2
- export declare const getFormatColumnSettingsViewItems: (calculatedColumn: FormatColumn) => {
2
+ export declare const getFormatColumnSettingsViewItems: (formatColumn: FormatColumn) => {
3
3
  name: string;
4
4
  values: string[];
5
5
  };
@@ -1,12 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getFormatColumnSettingsViewItems = void 0;
4
- const getFormatColumnSettingsViewItems = (calculatedColumn) => {
4
+ const getFormatColumnSettingsViewItems = (formatColumn) => {
5
5
  var _a;
6
6
  const values = [
7
- `Cell alignment: ${(_a = calculatedColumn.CellAlignment) !== null && _a !== void 0 ? _a : 'default'}`,
8
- calculatedColumn.HeaderName && `Header name: ${calculatedColumn.HeaderName}`,
9
- `Include grouped rows: ${calculatedColumn.IncludeGroupedRows ? 'Yes' : 'No'}`,
7
+ `Cell alignment: ${(_a = formatColumn.CellAlignment) !== null && _a !== void 0 ? _a : 'default'}`,
8
+ `Include grouped rows: ${formatColumn.IncludeGroupedRows ? 'Yes' : 'No'}`,
10
9
  ].filter(Boolean);
11
10
  return {
12
11
  name: 'Settings',