@adaptabletools/adaptable 14.0.0 → 14.0.1-canary.0

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 (71) hide show
  1. package/bundle.cjs.js +196 -191
  2. package/package.json +1 -1
  3. package/publishTimestamp.d.ts +1 -1
  4. package/publishTimestamp.js +1 -1
  5. package/src/AdaptableOptions/ActionOptions.d.ts +5 -3
  6. package/src/AdaptableOptions/AdaptableOptions.d.ts +16 -2
  7. package/src/AdaptableOptions/AdaptableQLOptions.d.ts +4 -5
  8. package/src/AdaptableOptions/AlertOptions.d.ts +1 -0
  9. package/src/AdaptableOptions/ChartingOptions.d.ts +1 -0
  10. package/src/AdaptableOptions/ColumnOptions.d.ts +3 -0
  11. package/src/AdaptableOptions/DashboardOptions.d.ts +3 -0
  12. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +1 -0
  13. package/src/AdaptableOptions/ExpressionOptions.d.ts +15 -15
  14. package/src/AdaptableOptions/FilterOptions.d.ts +9 -8
  15. package/src/AdaptableOptions/FinancePluginOptions.d.ts +0 -11
  16. package/src/AdaptableOptions/GeneralOptions.d.ts +3 -9
  17. package/src/AdaptableOptions/LayoutOptions.d.ts +2 -7
  18. package/src/AdaptableOptions/MenuOptions.d.ts +1 -1
  19. package/src/AdaptableOptions/NotificationsOptions.d.ts +1 -0
  20. package/src/AdaptableOptions/SearchOptions.d.ts +1 -0
  21. package/src/AdaptableOptions/SettingsPanelOptions.d.ts +2 -0
  22. package/src/AdaptableOptions/StateOptions.d.ts +0 -4
  23. package/src/AdaptableOptions/ToolPanelOptions.d.ts +1 -0
  24. package/src/Api/AlertApi.d.ts +3 -3
  25. package/src/Api/GridApi.d.ts +5 -5
  26. package/src/Api/Implementation/AlertApiImpl.d.ts +1 -1
  27. package/src/Api/Implementation/AlertApiImpl.js +1 -1
  28. package/src/Api/Implementation/GridApiImpl.js +1 -1
  29. package/src/Api/Implementation/StyledColumnApiImpl.d.ts +1 -0
  30. package/src/Api/Implementation/StyledColumnApiImpl.js +6 -0
  31. package/src/Api/Implementation/TeamSharingApiImpl.d.ts +2 -0
  32. package/src/Api/Implementation/TeamSharingApiImpl.js +7 -0
  33. package/src/Api/Internal/LayoutInternalApi.js +1 -2
  34. package/src/Api/Internal/PredicateInternalApi.js +0 -7
  35. package/src/Api/Internal/TeamSharingInternalApi.d.ts +0 -5
  36. package/src/Api/Internal/TeamSharingInternalApi.js +0 -9
  37. package/src/Api/StyledColumnApi.d.ts +7 -2
  38. package/src/Api/TeamSharingApi.d.ts +8 -0
  39. package/src/PredefinedConfig/AlertState.d.ts +1 -1
  40. package/src/PredefinedConfig/CalculatedColumnState.d.ts +2 -6
  41. package/src/PredefinedConfig/Common/Menu.d.ts +5 -5
  42. package/src/PredefinedConfig/Common/SpecialColumnSettings.d.ts +6 -2
  43. package/src/PredefinedConfig/FormatColumnState.d.ts +2 -3
  44. package/src/PredefinedConfig/FreeTextColumnState.d.ts +1 -6
  45. package/src/Strategy/FreeTextColumnModule.js +24 -5
  46. package/src/Strategy/StyledColumnModule.js +60 -28
  47. package/src/Strategy/TeamSharingModule.js +2 -2
  48. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +0 -3
  49. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.d.ts +1 -1
  50. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.js +11 -10
  51. package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.js +11 -7
  52. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.d.ts +1 -1
  53. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.js +26 -52
  54. package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.js +13 -13
  55. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.d.ts +1 -1
  56. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.js +101 -44
  57. package/src/Utilities/ObjectFactory.js +1 -1
  58. package/src/View/Components/Popups/AdaptablePopupConfirmation.js +1 -1
  59. package/src/View/FreeTextColumn/Wizard/FreeTextColumnSettingsWizardSection.js +18 -10
  60. package/src/agGrid/Adaptable.d.ts +0 -1
  61. package/src/agGrid/Adaptable.js +6 -20
  62. package/src/components/ExpressionEditor/BaseEditorInput.js +42 -7
  63. package/src/components/ExpressionEditor/editorButtonsCumulativeAggregatedScalar.js +5 -5
  64. package/src/components/ExpressionEditor/editorButtonsSearch.js +8 -12
  65. package/src/metamodel/adaptable.metamodel.d.ts +106 -58
  66. package/src/metamodel/adaptable.metamodel.js +1 -1
  67. package/src/parser/src/types.d.ts +5 -9
  68. package/src/parser/src/utils.js +6 -3
  69. package/src/types.d.ts +3 -3
  70. package/version.d.ts +1 -1
  71. package/version.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "14.0.0",
3
+ "version": "14.0.1-canary.0",
4
4
  "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
5
5
  "keywords": [
6
6
  "web-components",
@@ -1,2 +1,2 @@
1
- declare const _default: 1671833413485;
1
+ declare const _default: 1672558364064;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1671833413485;
3
+ exports.default = 1672558364064;
@@ -1,7 +1,5 @@
1
1
  import { RowNode } from '@ag-grid-community/core';
2
2
  import { ActionRowSubmittedInfo, ActionRowType, AdaptableButton, AdaptableColumn, AdaptableObject, BaseContext, FormContext } from '../types';
3
- interface ActionRowButtonsContext extends BaseContext {
4
- }
5
3
  /**
6
4
  * Options related to Action Columns and Buttons in Adaptable.
7
5
  */
@@ -212,4 +210,8 @@ export interface ActionRowButtonConfigurationContext extends BaseContext {
212
210
  */
213
211
  actionRowButtonType: ActionRowButtonType;
214
212
  }
215
- export {};
213
+ /**
214
+ * Context passed to Action Row Buttons
215
+ */
216
+ export interface ActionRowButtonsContext extends BaseContext {
217
+ }
@@ -84,16 +84,19 @@ export interface AdaptableOptions {
84
84
  actionOptions?: ActionOptions;
85
85
  /**
86
86
  * Options for managing AdapTableQL
87
+ * @noCodeContainer
87
88
  */
88
89
  adaptableQLOptions?: AdaptableQLOptions;
89
90
  /**
90
91
  * Options for managing Alerts in AdapTable
91
92
  *
92
93
  * @gridInfoContainer
94
+ * @noCodeContainer
93
95
  */
94
96
  alertOptions?: AlertOptions;
95
97
  /**
96
98
  * Options for managing AG Grid's Charting
99
+ * @noCodeContainer
97
100
  */
98
101
  chartingOptions?: ChartingOptions;
99
102
  /**
@@ -101,19 +104,22 @@ export interface AdaptableOptions {
101
104
  */
102
105
  containerOptions?: ContainerOptions;
103
106
  /**
104
- * Options for managing Columns
107
+ * Options related to Columns
108
+ * @noCodeContainer
105
109
  */
106
110
  columnOptions?: ColumnOptions;
107
111
  /**
108
- * Options related to managing the Dashboard in AdapTable
112
+ * Options for managing the Dashboard in AdapTable
109
113
  *
110
114
  * @gridInfoContainer
115
+ * @noCodeContainer
111
116
  */
112
117
  dashboardOptions?: DashboardOptions;
113
118
  /**
114
119
  * Options to manage Data Change History Module which provides an overview of all data changes
115
120
  *
116
121
  * @gridInfoContainer
122
+ * @noCodeContainer
117
123
  */
118
124
  dataChangeHistoryOptions?: DataChangeHistoryOptions;
119
125
  /**
@@ -138,6 +144,8 @@ export interface AdaptableOptions {
138
144
  * Options for managing Filtering in AdapTable
139
145
  *
140
146
  * @gridInfoContainer
147
+ * @noCodeContainer
148
+ *
141
149
  */
142
150
  filterOptions?: FilterOptions;
143
151
  /**
@@ -150,12 +158,14 @@ export interface AdaptableOptions {
150
158
  * General options to manage AdapTable e.g. grouping behaviour, Primary Keys
151
159
  *
152
160
  * @gridInfoContainer
161
+ * @noCodeContainer
153
162
  */
154
163
  generalOptions?: GeneralOptions;
155
164
  /**
156
165
  * Options related to Layouts
157
166
  *
158
167
  * @gridInfoContainer
168
+ * @noCodeContainer
159
169
  */
160
170
  layoutOptions?: LayoutOptions;
161
171
  /**
@@ -168,18 +178,21 @@ export interface AdaptableOptions {
168
178
  * Options for managing Notifications in AdapTable
169
179
  *
170
180
  * @gridInfoContainer
181
+ * @noCodeContainer
171
182
  */
172
183
  notificationsOptions?: NotificationsOptions;
173
184
  /**
174
185
  * Options for managing Search related functions in AdapTable
175
186
  *
176
187
  * @gridInfoContainer
188
+ * @noCodeContainer
177
189
  */
178
190
  searchOptions?: SearchOptions;
179
191
  /**
180
192
  * Setting panel options
181
193
  *
182
194
  * @gridInfoContainer
195
+ * @noCodeContainer
183
196
  */
184
197
  settingsPanelOptions?: SettingsPanelOptions;
185
198
  /**
@@ -196,6 +209,7 @@ export interface AdaptableOptions {
196
209
  * Options related to managing the Tool Panel elements in AdapTable
197
210
  *
198
211
  * @gridInfoContainer
212
+ * @noCodeContainer
199
213
  */
200
214
  toolPanelOptions?: ToolPanelOptions;
201
215
  /**
@@ -5,7 +5,7 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
5
5
  import { ExpressionOptions } from './ExpressionOptions';
6
6
  import { PredicateOptions } from './PredicateOptions';
7
7
  /**
8
- * Options for managing AdaptableQL - the Adaptable Query Language which evaluates Predicates and Expressions
8
+ * Options for managing AdapTableQL - the Adaptable Query Language which evaluates Predicates and Expressions
9
9
  */
10
10
  export interface AdaptableQLOptions {
11
11
  /**
@@ -21,13 +21,11 @@ export interface AdaptableQLOptions {
21
21
  */
22
22
  evaluateAdaptableQLExternally?: (context: EvaluateExpressionExternallyContext) => boolean;
23
23
  /**
24
- * Options for managing Expressions in AdaptableQL
25
- *
24
+ * Options for managing Expressions in AdapTableQL
26
25
  */
27
26
  expressionOptions?: ExpressionOptions;
28
27
  /**
29
- * Options for managing Predicates in AdaptableQL
30
- *
28
+ * Options for managing Predicates in AdapTableQL
31
29
  */
32
30
  predicateOptions?: PredicateOptions;
33
31
  /**
@@ -38,6 +36,7 @@ export interface AdaptableQLOptions {
38
36
  * Reference a Column's Header (FriendlyName) in all Expression overviews (instead of ColumnId)
39
37
  *
40
38
  * @defaultValue true
39
+ * @noCodeItem
41
40
  */
42
41
  displayColumnFriendlyNamesForExpressions?: boolean;
43
42
  }
@@ -12,6 +12,7 @@ export interface AlertOptions {
12
12
  *
13
13
  * @defaultValue 20
14
14
  * @gridInfoItem
15
+ * @noCodeItem
15
16
  */
16
17
  maxAlertsInStore?: number;
17
18
  /**
@@ -5,6 +5,7 @@ export interface ChartingOptions {
5
5
  /**
6
6
  * Behaviour for saving Charts: automatic, manual (via popup) or none
7
7
  * @defaultValue 'none'
8
+ * @noCodeItem
8
9
  */
9
10
  saveStrategy?: 'auto' | 'manual' | 'none';
10
11
  /**
@@ -18,6 +18,7 @@ export interface ColumnOptions {
18
18
  *
19
19
  * @defaultValue true
20
20
  * @gridInfoItem
21
+ * @noCodeItem
21
22
  */
22
23
  showMissingColumnsWarning?: boolean;
23
24
  /**
@@ -26,6 +27,7 @@ export interface ColumnOptions {
26
27
  * The default group order will be derived from (in the specified priority): 1. an active CustomSort, 2. the defined ColDef Comparator, 3. current Layout ColumnSort or 4. alphanumerically
27
28
  * @defaultValue true
28
29
  * @gridInfoItem
30
+ * @noCodeItem
29
31
  */
30
32
  autoOrderGroupedColumns?: boolean;
31
33
  /**
@@ -33,6 +35,7 @@ export interface ColumnOptions {
33
35
  *
34
36
  * @defaultValue false
35
37
  * @gridInfoItem
38
+ * @noCodeItem
36
39
  */
37
40
  hideColumnWhenGrouped?: boolean;
38
41
  }
@@ -12,6 +12,7 @@ export interface DashboardOptions {
12
12
  *
13
13
  * @defaultValue true
14
14
  * @gridInfoItem
15
+ * @noCodeItem
15
16
  */
16
17
  canFloat?: boolean;
17
18
  /**
@@ -19,6 +20,7 @@ export interface DashboardOptions {
19
20
  *
20
21
  * @defaultValue true
21
22
  * @gridInfoItem
23
+ * @noCodeItem
22
24
  */
23
25
  showQuickSearchInHeader?: boolean;
24
26
  /**
@@ -32,6 +34,7 @@ export interface DashboardOptions {
32
34
  /**
33
35
  * Where in Dashboard to display Module and Custom Buttons
34
36
  * @defaultValue 'right'
37
+ * @noCodeItem
35
38
  */
36
39
  buttonsLocation?: 'left' | 'right';
37
40
  }
@@ -36,6 +36,7 @@ export interface DataChangeHistoryOptions {
36
36
  *
37
37
  * @defaultValue false
38
38
  * @gridInfoItem
39
+ * @noCodeItem
39
40
  */
40
41
  activeByDefault?: boolean;
41
42
  /**
@@ -6,53 +6,53 @@ import { AggregatedBooleanFunctionName } from '../Utilities/ExpressionFunctions/
6
6
  import { AggregatedScalarFunctionName } from '../Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions';
7
7
  import { AdaptableModule, BaseContext, AdaptableColumnBase } from '../types';
8
8
  /**
9
- * Options for managing Expressions using AdaptableQL
9
+ * Options for managing Expressions using AdapTableQL
10
10
  */
11
11
  export interface ExpressionOptions {
12
12
  /**
13
- * System (built-in) Boolean Expression Functions available in AdaptableQL
13
+ * System (built-in) Boolean Expression Functions available in AdapTableQL
14
14
  *
15
15
  * @defaultValue null (sets all)
16
16
  * @gridInfoItem
17
17
  */
18
18
  systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
19
19
  /**
20
- * Custom (user defined) Boolean Expression Functions available in AdaptableQL
20
+ * Custom (user defined) Boolean Expression Functions available in AdapTableQL
21
21
  *
22
22
  * @defaultValue null (none)
23
23
  * @gridInfoItem
24
24
  */
25
25
  customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
26
26
  /**
27
- * System (built-in) Scalar Expression Functions available in AdaptableQL
27
+ * System (built-in) Scalar Expression Functions available in AdapTableQL
28
28
  *
29
29
  * @defaultValue null (sets all)
30
30
  * @gridInfoItem
31
31
  */
32
32
  systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
33
33
  /**
34
- * Custom (user defined) Scalar Expression Functions available in AdaptableQL
34
+ * Custom (user defined) Scalar Expression Functions available in AdapTableQL
35
35
  *
36
36
  * @defaultValue null (none)
37
37
  * @gridInfoItem
38
38
  */
39
39
  customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
40
40
  /**
41
- * System (built-in) Observable Expression Functions available in AdaptableQL
41
+ * System (built-in) Observable Expression Functions available in AdapTableQL
42
42
  *
43
43
  * @defaultValue null (sets all)
44
44
  * @gridInfoItem
45
45
  */
46
46
  systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
47
47
  /**
48
- * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
48
+ * System (built-in) AggregatedBoolean Expression Functions available in AdapTableQL
49
49
  *
50
50
  * @defaultValue null (sets all)
51
51
  * @gridInfoItem
52
52
  */
53
53
  systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
54
54
  /**
55
- * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
55
+ * System (built-in) AggregatedScalar Expression Functions available in AdapTableQL
56
56
  *
57
57
  * @defaultValue undefined (sets all)
58
58
  * @gridInfoItem
@@ -97,49 +97,49 @@ export declare type ModuleExpressionFunctionsMap = Partial<Record<AdaptableModul
97
97
  */
98
98
  export interface ModuleExpressionFunctions {
99
99
  /**
100
- * System (built-in) Boolean Expression Functions available in AdaptableQL
100
+ * System (built-in) Boolean Expression Functions available in AdapTableQL
101
101
  *
102
102
  * @defaultValue null (sets all)
103
103
  * @gridInfoItem
104
104
  */
105
105
  systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
106
106
  /**
107
- * Custom (user defined) Boolean Expression Functions available in AdaptableQL
107
+ * Custom (user defined) Boolean Expression Functions available in AdapTableQL
108
108
  *
109
109
  * @defaultValue null (none)
110
110
  * @gridInfoItem
111
111
  */
112
112
  customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
113
113
  /**
114
- * System (built-in) Scalar Expression Functions available in AdaptableQL
114
+ * System (built-in) Scalar Expression Functions available in AdapTableQL
115
115
  *
116
116
  * @defaultValue null (sets all)
117
117
  * @gridInfoItem
118
118
  */
119
119
  systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
120
120
  /**
121
- * Custom (user defined) Scalar Expression Functions available in AdaptableQL
121
+ * Custom (user defined) Scalar Expression Functions available in AdapTableQL
122
122
  *
123
123
  * @defaultValue null (none)
124
124
  * @gridInfoItem
125
125
  */
126
126
  customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
127
127
  /**
128
- * System (built-in) Observable Expression Functions available in AdaptableQL
128
+ * System (built-in) Observable Expression Functions available in AdapTableQL
129
129
  *
130
130
  * @defaultValue null (sets all)
131
131
  * @gridInfoItem
132
132
  */
133
133
  systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
134
134
  /**
135
- * System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL
135
+ * System (built-in) AggregatedBoolean Expression Functions available in AdapTableQL
136
136
  *
137
137
  * @defaultValue null (sets all)
138
138
  * @gridInfoItem
139
139
  */
140
140
  systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
141
141
  /**
142
- * System (built-in) AggregatedScalar Expression Functions available in AdaptableQL
142
+ * System (built-in) AggregatedScalar Expression Functions available in AdapTableQL
143
143
  *
144
144
  * @defaultValue null (sets all)
145
145
  * @gridInfoItem
@@ -1,6 +1,6 @@
1
1
  import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
2
2
  import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
3
- import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
3
+ import { SystemFilterPredicateId } from '../../types';
4
4
  import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
5
5
  /**
6
6
  * Options for managing Filtering in AdapTable
@@ -62,6 +62,7 @@ export interface FilterOptions {
62
62
  *
63
63
  * @defaultValue 'mouseenter'
64
64
  * @gridInfoItem
65
+ * @noCodeItem
65
66
  */
66
67
  quickFilterTrigger?: 'mouseenter' | 'click';
67
68
  /**
@@ -69,6 +70,7 @@ export interface FilterOptions {
69
70
  *
70
71
  * @defaultValue 'mouseenter'
71
72
  * @gridInfoItem
73
+ * @noCodeItem
72
74
  */
73
75
  quickFilterValuesTrigger?: 'mouseenter' | 'click';
74
76
  /**
@@ -147,14 +149,10 @@ export interface FilterOptions {
147
149
  * @gridInfoItem
148
150
  */
149
151
  enableFilterOnSpecialColumns?: boolean;
150
- /**
151
- * Set which System Filter Predicates are available
152
- * @deprecated use systemFilterPredicates in PredicateOptions
153
- */
154
- systemFilters?: SystemFilterPredicateIds;
155
152
  /**
156
153
  * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
157
154
  * @defaultValue true
155
+ * @noCodeItem
158
156
  */
159
157
  showQuickFilter?: boolean;
160
158
  /**
@@ -162,18 +160,21 @@ export interface FilterOptions {
162
160
  *
163
161
  * @defaultValue false
164
162
  * @gridInfoItem
163
+ * @noCodeItem
165
164
  */
166
165
  showDistinctFilteredValuesOnly?: boolean;
167
166
  /**
168
- * Display Clear Filter button in Toolbar and Toolpanel
167
+ * Display Clear Filter button in Toolbar and Tool Panel
169
168
  * @defaultValue false
170
169
  * @gridInfoItem
170
+ * @noCodeItem
171
171
  */
172
172
  showClearFilterButton?: boolean;
173
173
  /**
174
- * Display Suspend / Unsuspend Button in Toolbar and Toolpanel
174
+ * Display Suspend / Unsuspend Button in Toolbar and Tool Panel
175
175
  * @defaultValue false
176
176
  * @gridInfoItem
177
+ * @noCodeItem
177
178
  */
178
179
  showSuspendFilterButton?: boolean;
179
180
  }
@@ -41,10 +41,6 @@ export interface FinancePluginOptions {
41
41
  * Intents to which to subscribe.
42
42
  */
43
43
  availableFDC3Intents?: (FDC3Intent | CustomFDC3Intent)[];
44
- /**
45
- * @deprecated - use Weighted Average Layout Aggregation
46
- */
47
- weightedAverageColumns?: WeightedAverageColumn[];
48
44
  /**
49
45
  * Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )
50
46
  *
@@ -60,13 +56,6 @@ export interface FinancePluginOptions {
60
56
  */
61
57
  onFDC3Context?: (context: FDC3Context, adaptableApi: AdaptableApi) => void;
62
58
  }
63
- /**
64
- * @deprecated - use Weighted Average Layout Aggregation
65
- */
66
- export interface WeightedAverageColumn {
67
- columnId: string;
68
- weightedColumnId: string;
69
- }
70
59
  /**
71
60
  * An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
72
61
  */
@@ -17,13 +17,6 @@ export interface GeneralOptions {
17
17
  * @uiLabel Show Missing Primary Key Warning
18
18
  */
19
19
  showMissingPrimaryKeyAlert?: boolean;
20
- /**
21
- * Hides any grouped rows if there are no columns visible
22
- *
23
- * @defaultValue false
24
- * @deprecated starting with Adaptable v10
25
- */
26
- hideEmptyGroupRows?: boolean;
27
20
  /**
28
21
  * Show aggregated totals row at top of Grid when row grouping
29
22
  *
@@ -68,12 +61,13 @@ export interface GeneralOptions {
68
61
  /**
69
62
  * Places ungrouped columns at pre-grouping indexed position
70
63
  * @defaultValue false
64
+ * @noCodeItem
71
65
  */
72
66
  restoreUngroupedColumns?: boolean;
73
67
  /**
74
- * By default, a confirmation dialog is displayed whenever an AdaptableObject is deleted. This option allows to suppress the confirmation dialog.
75
- *
68
+ * Hides confirmation dialog which displays whenever an AdaptableObject is deleted
76
69
  * @defaultValue false
70
+ * @noCodeItem
77
71
  */
78
72
  disableDeleteConfirmation?: boolean;
79
73
  }
@@ -15,13 +15,6 @@ import { BaseContext } from '../../types';
15
15
  *
16
16
  */
17
17
  export interface LayoutOptions {
18
- /**
19
- * Layouts will include details of expanded grouped rows; if true these will be re-applied at start-up
20
- * @deprecated use displayRowGroups instead
21
- * @defaultValue false
22
- * @gridInfoItem
23
- */
24
- includeExpandedRowGroups?: boolean;
25
18
  /**
26
19
  * Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)
27
20
  * @defaultValue 'closed'
@@ -41,6 +34,7 @@ export interface LayoutOptions {
41
34
  *
42
35
  * @defaultValue false
43
36
  * @gridInfoItem
37
+ * @noCodeItem
44
38
  */
45
39
  autoSizeColumnsInLayout?: boolean;
46
40
  /**
@@ -48,6 +42,7 @@ export interface LayoutOptions {
48
42
  *
49
43
  * @defaultValue false
50
44
  * @gridInfoItem
45
+ * @noCodeItem
51
46
  */
52
47
  autoSizeColumnsInPivotLayout?: boolean;
53
48
  /**
@@ -32,7 +32,7 @@ export interface MenuOptions {
32
32
  */
33
33
  columnMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
34
34
  /**
35
- * Order in which AG grid, AdapTable and User Menu items will appear in Context Menu
35
+ * Order in which AG Grid, AdapTable and User Menu items will appear in Context Menu
36
36
  *
37
37
  * @defaultValue 'aggrid', 'adaptable', 'user'
38
38
  * @gridInfoItem
@@ -7,6 +7,7 @@ export interface NotificationsOptions {
7
7
  *
8
8
  * @defaultValue 3
9
9
  * @gridInfoItem
10
+ * noCodeItem
10
11
  */
11
12
  maxNotifications?: number;
12
13
  /**
@@ -28,6 +28,7 @@ export interface SearchOptions {
28
28
  *
29
29
  * @defaultValue false
30
30
  * @gridInfoItem
31
+ * @noCodeItem
31
32
  */
32
33
  filterResultsAfterQuickSearch?: boolean;
33
34
  }
@@ -18,12 +18,14 @@ export interface SettingsPanelOptions {
18
18
  * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard
19
19
  * @defaultValue false
20
20
  * @gridInfoItem
21
+ * @noCodeItem
21
22
  */
22
23
  alwaysShowInDashboard?: boolean;
23
24
  /**
24
25
  * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
25
26
  * @defaultValue false
26
27
  * @gridInfoItem
28
+ * @noCodeItem
27
29
  */
28
30
  alwaysShowInToolPanel?: boolean;
29
31
  /**
@@ -50,10 +50,6 @@ export interface AdaptableStateFunctionConfig {
50
50
  * current Adaptable user
51
51
  */
52
52
  userName: string;
53
- /**
54
- * @deprecated unused will be removed in v.13
55
- */
56
- url?: string;
57
53
  }
58
54
  /**
59
55
  * Allows customization of state persistence - used `persistState` function in StateOptions
@@ -12,6 +12,7 @@ export interface ToolPanelOptions {
12
12
  *
13
13
  * @defaultValue true
14
14
  * @gridInfoItem
15
+ * @noCodeItem
15
16
  */
16
17
  showToolPanelsDropdown?: boolean;
17
18
  /**
@@ -74,10 +74,10 @@ export interface AlertApi {
74
74
  */
75
75
  unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
76
76
  /**
77
- * Evaluate all existing alerts which match the given criteria
78
- * @param alertLookupCriteria AdaptableObjectLookupCriteria
77
+ * Evaluates the given Alert Definitions - will fire Alert if rule is met
78
+ * @param alertDefinitions Alert Definitions to evaluate
79
79
  */
80
- evaluateAlerts(alertDefinitions: AlertDefinition[]): void;
80
+ evaluateAlertDefinitions(alertDefinitions: AlertDefinition[]): void;
81
81
  /**
82
82
  * Find all Alert Definitions which match the given criteria
83
83
  * @param alertLookupCriteria lookup criteria
@@ -193,7 +193,7 @@ export interface GridApi {
193
193
  * Selects a group of cells in a given range using a query
194
194
  *
195
195
  * @param query query to use to select cells
196
- * @param gridCellRange range to select
196
+ * @param gridCellRange optional range to filter results
197
197
  * @param clearSelection whether to clear current selection in grid
198
198
  */
199
199
  selectCellRangeByQuery(query: string, gridCellRange?: GridCellRange, clearSelection?: boolean): void;
@@ -388,13 +388,13 @@ export interface GridApi {
388
388
  */
389
389
  highlightRows(rowsHighlightInfo: RowsHighlightInfo): void;
390
390
  /**
391
- * Remove highlight from row
392
- * @param primaryKeyValue
391
+ * Remove highlight from Row
392
+ * @param primaryKeyValue value in Primary Key Column
393
393
  */
394
394
  unHighlightRow(primaryKeyValue: RowHighlightInfo['primaryKeyValue']): void;
395
395
  /**
396
- * Remove highlight from row
397
- * @param primaryKeyValue
396
+ * Remove highlight from given Rows
397
+ * @param primaryKeyValues values in Primary Key Column
398
398
  */
399
399
  unHighlightRows(primaryKeyValues: RowsHighlightInfo['primaryKeyValues']): void;
400
400
  /**
@@ -40,7 +40,7 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
40
40
  editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
41
41
  suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
42
42
  unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
43
- evaluateAlerts(alertDefinitions: AlertDefinition[]): void;
43
+ evaluateAlertDefinitions(alertDefinitions: AlertDefinition[]): void;
44
44
  findAlertDefinitions(criteria: AdaptableObjectLookupCriteria): AlertDefinition[];
45
45
  private getRelevantColumnIdsForAlertDefinition;
46
46
  private createCellDataChangeInfoStubs;
@@ -181,7 +181,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
181
181
  this.dispatchAction(AlertRedux.AlertDefinitionUnSuspend(alertDefinition));
182
182
  return this.getAlertDefinitionById(alertDefinition.Uuid);
183
183
  }
184
- evaluateAlerts(alertDefinitions) {
184
+ evaluateAlertDefinitions(alertDefinitions) {
185
185
  const filterScopeAllDefinitions = (alertDefinition) => {
186
186
  if (this.getAdaptableApi().scopeApi.scopeIsAll(alertDefinition.Scope) &&
187
187
  !this.getAdaptableApi().queryLanguageApi.getAdaptableQueryExpression(alertDefinition.Rule)) {
@@ -240,7 +240,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
240
240
  }, [{}]);
241
241
  let preparedClearSelection = clearSelection;
242
242
  rowRanges.forEach((range) => {
243
- // clear only on fisrt range selection
243
+ // clear only on first range selection
244
244
  this.adaptable.selectCells(preapredGridCellRange.columnIds, range.startNode, range.endNode, preparedClearSelection);
245
245
  preparedClearSelection = false;
246
246
  });
@@ -22,6 +22,7 @@ export declare class StyledColumnApiImpl extends ApiBase implements StyledColumn
22
22
  deleteStyledColumn(styledColumn: StyledColumn): void;
23
23
  addStyledColumn(styledColumn: StyledColumn): void;
24
24
  getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
25
+ isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;
25
26
  isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
26
27
  fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
27
28
  getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;