@adaptabletools/adaptable 16.0.0-canary.3 → 16.0.0-canary.5

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 (95) hide show
  1. package/README.md +2 -0
  2. package/base.css +31 -23
  3. package/base.css.map +1 -1
  4. package/bundle.cjs.js +184 -184
  5. package/index.css +43 -31
  6. package/index.css.map +1 -1
  7. package/package.json +10 -2
  8. package/publishTimestamp.d.ts +1 -1
  9. package/publishTimestamp.js +1 -1
  10. package/src/AdaptableInterfaces/IAdaptable.d.ts +2 -0
  11. package/src/AdaptableOptions/AdaptableOptions.d.ts +9 -4
  12. package/src/AdaptableOptions/ColumnOptions.d.ts +1 -10
  13. package/src/AdaptableOptions/Fdc3Options.d.ts +279 -0
  14. package/src/AdaptableOptions/Fdc3Options.js +5 -0
  15. package/src/AdaptableOptions/FinancePluginOptions.d.ts +25 -25
  16. package/src/AdaptableOptions/GroupingOptions.d.ts +8 -0
  17. package/src/AdaptableOptions/OpenFinPluginOptions.d.ts +1 -1
  18. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +6 -6
  19. package/src/Api/AdaptableApi.d.ts +7 -2
  20. package/src/Api/ColumnApi.d.ts +0 -5
  21. package/src/Api/EventApi.d.ts +3 -3
  22. package/src/Api/Events/ThemeChanged.d.ts +0 -6
  23. package/src/Api/Events/ThemeEdited.d.ts +11 -0
  24. package/src/Api/Fdc3Api.d.ts +91 -0
  25. package/src/Api/Fdc3Api.js +2 -0
  26. package/src/Api/FinanceApi.d.ts +13 -13
  27. package/src/Api/Implementation/AdaptableApiImpl.d.ts +2 -0
  28. package/src/Api/Implementation/AdaptableApiImpl.js +3 -0
  29. package/src/Api/Implementation/ApiBase.d.ts +4 -0
  30. package/src/Api/Implementation/ApiBase.js +6 -0
  31. package/src/Api/Implementation/ColumnApiImpl.d.ts +0 -1
  32. package/src/Api/Implementation/ColumnApiImpl.js +0 -3
  33. package/src/Api/Implementation/Fdc3ApiImpl.d.ts +28 -0
  34. package/src/Api/Implementation/Fdc3ApiImpl.js +87 -0
  35. package/src/Api/Implementation/OptionsApiImpl.d.ts +2 -0
  36. package/src/Api/Implementation/OptionsApiImpl.js +3 -0
  37. package/src/Api/Implementation/QuickSearchApiImpl.d.ts +2 -0
  38. package/src/Api/Implementation/QuickSearchApiImpl.js +7 -0
  39. package/src/Api/Internal/ActionRowInternalApi.js +1 -1
  40. package/src/Api/Internal/AdaptableInternalApi.d.ts +11 -4
  41. package/src/Api/Internal/AdaptableInternalApi.js +59 -10
  42. package/src/Api/Internal/ColumnInternalApi.d.ts +1 -0
  43. package/src/Api/Internal/ColumnInternalApi.js +4 -0
  44. package/src/Api/Internal/Fdc3InternalApi.d.ts +27 -0
  45. package/src/Api/Internal/Fdc3InternalApi.js +442 -0
  46. package/src/Api/OptionsApi.d.ts +5 -0
  47. package/src/Api/QuickSearchApi.d.ts +8 -0
  48. package/src/PredefinedConfig/Common/AdaptableButton.d.ts +1 -1
  49. package/src/PredefinedConfig/Common/AdaptableIcon.d.ts +1 -1
  50. package/src/PredefinedConfig/Common/{FDC3Context.d.ts → FDC3Context_DEPR.d.ts} +22 -22
  51. package/src/PredefinedConfig/Common/FDC3Context_DEPR.js +2 -0
  52. package/src/PredefinedConfig/Common/Fdc3Context.d.ts +55 -0
  53. package/src/PredefinedConfig/Common/Fdc3Context.js +36 -0
  54. package/src/PredefinedConfig/Common/Fdc3Intent.d.ts +71 -0
  55. package/src/PredefinedConfig/Common/Fdc3Intent.js +107 -0
  56. package/src/PredefinedConfig/Common/Types.d.ts +2 -2
  57. package/src/PredefinedConfig/SystemState.d.ts +3 -0
  58. package/src/Redux/ActionsReducers/SystemRedux.d.ts +12 -6
  59. package/src/Redux/ActionsReducers/SystemRedux.js +18 -2
  60. package/src/Redux/Store/AdaptableStore.js +2 -2
  61. package/src/Strategy/Fdc3Module.d.ts +13 -0
  62. package/src/Strategy/Fdc3Module.js +105 -0
  63. package/src/Utilities/Constants/GeneralConstants.d.ts +4 -0
  64. package/src/Utilities/Constants/GeneralConstants.js +6 -2
  65. package/src/Utilities/Constants/ModuleConstants.d.ts +3 -0
  66. package/src/Utilities/Constants/ModuleConstants.js +5 -2
  67. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +11 -1
  68. package/src/Utilities/Helpers/AdaptableHelper.js +3 -2
  69. package/src/Utilities/Services/Fdc3Service.d.ts +20 -0
  70. package/src/Utilities/Services/Fdc3Service.js +92 -0
  71. package/src/View/AdaptableView.js +9 -7
  72. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/AdaptableConfig.d.ts +9 -0
  73. package/src/View/Layout/Wizard/sections/Utilities.js +1 -1
  74. package/src/View/QuickSearch/FloatingQuickSearch/FloatingQuickSearch.d.ts +2 -0
  75. package/src/View/QuickSearch/FloatingQuickSearch/FloatingQuickSearch.js +26 -0
  76. package/src/View/QuickSearch/QuickSearchInput.d.ts +6 -0
  77. package/src/View/QuickSearch/QuickSearchInput.js +22 -0
  78. package/src/View/QuickSearch/QuickSearchViewPanel.d.ts +2 -5
  79. package/src/View/QuickSearch/QuickSearchViewPanel.js +5 -19
  80. package/src/agGrid/ActionColumnRenderer.js +2 -31
  81. package/src/agGrid/Adaptable.d.ts +2 -0
  82. package/src/agGrid/Adaptable.js +22 -16
  83. package/src/agGrid/agGridHelper.js +7 -2
  84. package/src/components/Drawer/index.d.ts +6 -0
  85. package/src/components/Drawer/index.js +60 -0
  86. package/src/components/ExpressionEditor/index.js +4 -2
  87. package/src/components/icons/fdc3.d.ts +3 -0
  88. package/src/components/icons/fdc3.js +9 -0
  89. package/src/components/icons/index.js +3 -1
  90. package/src/metamodel/adaptable.metamodel.d.ts +161 -19
  91. package/src/metamodel/adaptable.metamodel.js +1 -1
  92. package/src/types.d.ts +8 -4
  93. package/version.d.ts +1 -1
  94. package/version.js +1 -1
  95. /package/src/{PredefinedConfig/Common/FDC3Context.js → Api/Events/ThemeEdited.js} +0 -0
@@ -0,0 +1,279 @@
1
+ import { ChartContext, ChatInitSettingsContext, ContactContext, ContactListContext, CountryContext, CurrencyContext, EmailContext, Fdc3Context, Fdc3ContextType, Fdc3CustomContext, Fdc3CustomContextType, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext, TimeRangeContext, ValuationContext } from '../PredefinedConfig/Common/Fdc3Context';
2
+ import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
3
+ import { IRowNode } from '@ag-grid-community/core';
4
+ import { Context, ContextMetadata, IntentResult } from '@finos/fdc3';
5
+ import { CompatibleContext, Fdc3CustomIntentType, Fdc3IntentType } from '../PredefinedConfig/Common/Fdc3Intent';
6
+ import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
7
+ import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
8
+ /**
9
+ * Options for configuring FDC3 in AdapTable
10
+ */
11
+ export interface Fdc3Options {
12
+ /**
13
+ * Enable FDC3 in AdapTable
14
+ *
15
+ * @defaultValue false
16
+ */
17
+ enableFdc3?: boolean;
18
+ /**
19
+ * Enable logging of message exchanges in the Console
20
+ *
21
+ * @defaultValue false
22
+ */
23
+ enableLogging?: boolean;
24
+ /**
25
+ * Maps the Context Type to the AdapTable Grid Data
26
+ */
27
+ gridDataContextMapping?: GridDataContextMapping;
28
+ /**
29
+ * Builds the Context Data (useful for postprocessing the Context Data mapped from the grid data)
30
+ */
31
+ resolveContextData?: (context: ResolveContextDataContext) => Fdc3Context;
32
+ /**
33
+ * Configures the FDC3 standard Intents that AdaptTable will listen for and raise
34
+ */
35
+ intents?: {
36
+ /**
37
+ * Subscribe to the given standard Intent(s)
38
+ */
39
+ listensFor?: Fdc3IntentType[];
40
+ /**
41
+ * Raises the given standard Intent(s) on various Grid Actions
42
+ */
43
+ raises?: {
44
+ [K in Fdc3IntentType]?: RaiseIntentConfig<K>[];
45
+ };
46
+ };
47
+ /**
48
+ * Configures the FDC3 custom Intents that AdaptTable will listen for and raise
49
+ */
50
+ customIntents?: {
51
+ /**
52
+ * Subscribe to the given custom Intent(s)
53
+ */
54
+ listensFor?: Fdc3CustomIntentType[];
55
+ /**
56
+ * Raises the given custom Intent(s) on various Grid Actions
57
+ */
58
+ raises?: {
59
+ [K in Fdc3CustomIntentType]: RaiseIntentConfig[];
60
+ };
61
+ };
62
+ /**
63
+ * Configures the FDC3 standard Contexts that AdaptTable will listen for and broadcast
64
+ */
65
+ contexts?: {
66
+ /**
67
+ * Subscribe to the given standard Context(s)
68
+ */
69
+ listensFor?: Fdc3ContextType[];
70
+ /**
71
+ * Broadcasts the given standard Context(s) on various Grid Actions
72
+ */
73
+ broadcasts?: {
74
+ [K in Fdc3ContextType]?: BroadcastConfig;
75
+ };
76
+ };
77
+ /**
78
+ * Configures the FDC3 custom Contexts that AdaptTable will listen for and broadcast
79
+ */
80
+ customContexts?: {
81
+ /**
82
+ * Subscribe to the given custom Context(s)
83
+ */
84
+ listensFor?: Fdc3CustomContextType[];
85
+ /**
86
+ * Broadcasts the given custom Context(s) on various Grid Actions
87
+ */
88
+ broadcasts?: {
89
+ [K in Fdc3CustomContextType]?: BroadcastConfig;
90
+ };
91
+ };
92
+ /**
93
+ * Handles incoming Intents (both standard and custom)
94
+ */
95
+ handleIntent?: (context: HandleFdc3IntentContext) => Promise<IntentResult> | void;
96
+ /**
97
+ * Handles incoming Contexts (both standard and custom)
98
+ */
99
+ handleContext?: (context: HandleFdc3Context) => void;
100
+ /**
101
+ * Customises the FDC3 Actions column
102
+ */
103
+ actionColumnDefaultConfiguration?: {
104
+ /**
105
+ * @defaultValue 'FDC3 Actions'
106
+ */
107
+ headerName?: string;
108
+ /**
109
+ * @defaultValue '200' (pixels)
110
+ */
111
+ width?: number;
112
+ /**
113
+ * @defaultValue true
114
+ */
115
+ resizable?: boolean;
116
+ /**
117
+ * @defaultValue true
118
+ */
119
+ movable?: boolean;
120
+ };
121
+ }
122
+ /**
123
+ * Context used when resolving FDC3 Context Data
124
+ */
125
+ export interface ResolveContextDataContext extends BaseContext {
126
+ /**
127
+ * The FDC3 Context Type
128
+ */
129
+ contextType: Fdc3ContextType | Fdc3CustomContextType;
130
+ /**
131
+ * The FDC3 Context Data which has been mapped from the grid data based on the given configuration in `gridDataContextMapping`
132
+ */
133
+ contextMappedFromGridData?: Fdc3Context;
134
+ /**
135
+ * The row node which is the source of the context data
136
+ */
137
+ rowNode: IRowNode;
138
+ /**
139
+ * The row data which is the source of the context data
140
+ */
141
+ rowData: any;
142
+ /**
143
+ * Primary key value of row
144
+ */
145
+ primaryKeyValue: any;
146
+ }
147
+ /**
148
+ * Context used when handling incoming FDC3 messages
149
+ */
150
+ export interface HandleFdc3Context extends BaseContext {
151
+ /**
152
+ * The FDC3 Context
153
+ */
154
+ context: Context;
155
+ /**
156
+ * The FDC3 Context Metadata related to the context
157
+ */
158
+ metadata?: ContextMetadata;
159
+ }
160
+ /**
161
+ * Context used when handling incoming FDC3 messages
162
+ */
163
+ export interface HandleFdc3IntentContext extends HandleFdc3Context {
164
+ /**
165
+ * The FDC3 Intent
166
+ */
167
+ intent: Fdc3IntentType | Fdc3CustomIntentType;
168
+ }
169
+ /**
170
+ * Mapping of FDC3 Context Types to Grid Data/Columns
171
+ */
172
+ export interface GridDataContextMapping {
173
+ 'fdc3.chart'?: Fdc3ContentMapping<ChartContext>;
174
+ 'fdc3.chat.initSettings'?: Fdc3ContentMapping<ChatInitSettingsContext>;
175
+ 'fdc3.contact'?: Fdc3ContentMapping<ContactContext>;
176
+ 'fdc3.contactList'?: Fdc3ContentMapping<ContactListContext>;
177
+ 'fdc3.country'?: Fdc3ContentMapping<CountryContext>;
178
+ 'fdc3.currency'?: Fdc3ContentMapping<CurrencyContext>;
179
+ 'fdc3.email'?: Fdc3ContentMapping<EmailContext>;
180
+ 'fdc3.instrument'?: Fdc3ContentMapping<InstrumentContext>;
181
+ 'fdc3.instrumentList'?: Fdc3ContentMapping<InstrumentListContext>;
182
+ 'fdc3.organization'?: Fdc3ContentMapping<OrganizationContext>;
183
+ 'fdc3.portfolio'?: Fdc3ContentMapping<PortfolioContext>;
184
+ 'fdc3.position'?: Fdc3ContentMapping<PositionContext>;
185
+ 'fdc3.timerange'?: Fdc3ContentMapping<TimeRangeContext>;
186
+ 'fdc3.valuation'?: Fdc3ContentMapping<ValuationContext>;
187
+ }
188
+ export declare const ColumnRefTypePrefix = "_colId.";
189
+ export declare const FieldRefTypePrefix = "_field.";
190
+ export declare type GridDataRef = `_colId.${string}` | `_field.${string}`;
191
+ export declare type Fdc3ContentMapping<T> = PropertiesToGridRefs<Omit<T, 'type'>>;
192
+ export interface RaiseIntentConfig<K extends Fdc3IntentType = any> {
193
+ contextType: CompatibleContext<K>;
194
+ contextMenu?: {
195
+ columnIds: string[];
196
+ };
197
+ actionButton?: Fdc3AdaptableButton;
198
+ actionColumn?: {
199
+ columnId: string;
200
+ friendlyName?: string;
201
+ button: Fdc3AdaptableButton;
202
+ width?: number;
203
+ };
204
+ }
205
+ export interface BroadcastConfig {
206
+ contextMenu?: {
207
+ columnIds: string[];
208
+ };
209
+ actionButton?: Fdc3AdaptableButton;
210
+ actionColumn?: {
211
+ columnId: string;
212
+ friendlyName?: string;
213
+ button: Fdc3AdaptableButton;
214
+ defaultWidth?: number;
215
+ };
216
+ }
217
+ /**
218
+ * Context provided in dynamic FDC3 Buttons
219
+ */
220
+ export interface Fdc3ButtonContext extends BaseContext {
221
+ /**
222
+ * The FDC3 Context
223
+ */
224
+ context: Fdc3Context | Fdc3CustomContext;
225
+ /**
226
+ * The FDC3 Intent
227
+ */
228
+ intent?: Fdc3IntentType | Fdc3CustomIntentType;
229
+ /**
230
+ * The row node which is the source of the context data
231
+ */
232
+ rowNode: IRowNode;
233
+ /**
234
+ * The row data which is the source of the context data
235
+ */
236
+ rowData: any;
237
+ /**
238
+ * Primary key value of row
239
+ */
240
+ primaryKeyValue: any;
241
+ }
242
+ export interface Fdc3AdaptableButton {
243
+ /**
244
+ * Unique id for the button
245
+ */
246
+ id: string;
247
+ /**
248
+ * Icon for Button - can be object or function that provides a `AdaptableIcon` object
249
+ */
250
+ icon?: '_defaultFdc3' | AdaptableIcon | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => AdaptableIcon);
251
+ /**
252
+ * Label for Button - can be string or function that provides string
253
+ */
254
+ label?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);
255
+ /**
256
+ * Tooltip for Button - can be string or function that provides string
257
+ */
258
+ tooltip?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);
259
+ /**
260
+ * Style for Button - can be object or function that provides a `ButtonStyle` object
261
+ */
262
+ buttonStyle?: ButtonStyle | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => ButtonStyle);
263
+ /**
264
+ * Function that disables / enables the button based on its evaluation result
265
+ */
266
+ disabled?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;
267
+ /**
268
+ * Function which sets whether Button is hidden
269
+ */
270
+ hidden?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;
271
+ }
272
+ /**
273
+ * TypeScript magic to convert all non-string property types to string (but keep the object structures), incl. nested objects.
274
+ */
275
+ declare type PropertiesToGridRefs<Type> = Type extends object ? ReplaceTypes<Type> : Type extends string ? GridDataRef : Type extends Date ? GridDataRef : Type;
276
+ declare type ReplaceTypes<ObjType extends object> = {
277
+ [KeyType in keyof ObjType]: PropertiesToGridRefs<ObjType[KeyType]>;
278
+ };
279
+ export {};
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FieldRefTypePrefix = exports.ColumnRefTypePrefix = void 0;
4
+ exports.ColumnRefTypePrefix = '_colId.';
5
+ exports.FieldRefTypePrefix = '_field.';
@@ -1,5 +1,5 @@
1
- import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context, GridCell } from '../../types';
2
- import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context';
1
+ import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context_DEPR, GridCell } from '../../types';
2
+ import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context_DEPR';
3
3
  /**
4
4
  * Options required for when using the Finance plugin
5
5
  */
@@ -35,12 +35,12 @@ export interface FinancePluginOptions {
35
35
  /**
36
36
  * Custom FDC3 Intents
37
37
  */
38
- customFDC3Intents?: CustomFDC3Intent[];
38
+ customFDC3Intents?: CustomFDC3Intent_Depr[];
39
39
  };
40
40
  /**
41
41
  * Intents to which to subscribe.
42
42
  */
43
- availableFDC3Intents?: (FDC3Intent | CustomFDC3Intent)[];
43
+ availableFDC3Intents?: (FDC3Intent_Depr | CustomFDC3Intent_Depr)[];
44
44
  /**
45
45
  * Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )
46
46
  *
@@ -50,16 +50,16 @@ export interface FinancePluginOptions {
50
50
  /**
51
51
  * Called when an intent from `availableIntents` is raised.
52
52
  */
53
- onFDC3Intent?: (intent: FDC3Intent | CustomFDC3Intent, context: FDC3Context, adaptableApi: AdaptableApi) => void;
53
+ onFDC3Intent?: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr, context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
54
54
  /**
55
55
  * Called when a context changes.
56
56
  */
57
- onFDC3Context?: (context: FDC3Context, adaptableApi: AdaptableApi) => void;
57
+ onFDC3Context?: (context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
58
58
  }
59
59
  /**
60
60
  * An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
61
61
  */
62
- export interface FDC3Column {
62
+ export interface FDC3Column_Depr {
63
63
  /**
64
64
  * Id of Column defined as FDC3
65
65
  */
@@ -95,12 +95,12 @@ export interface FDC3Column {
95
95
  /**
96
96
  * Returns a custom icon to display in the Raise Intent Context Menu Item;
97
97
  */
98
- intentIcon?: (intent: FDC3Intent | CustomFDC3Intent) => AdaptableIcon;
98
+ intentIcon?: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr) => AdaptableIcon;
99
99
  }
100
100
  /**
101
101
  * A Column which will be defined as an FDC3 Instrument
102
102
  */
103
- export interface InstrumentColumn extends FDC3Column {
103
+ export interface InstrumentColumn extends FDC3Column_Depr {
104
104
  /**
105
105
  * Column which holds a ticker value as instrument data
106
106
  */
@@ -149,7 +149,7 @@ export declare type InstrumentIntent = 'ViewChart' | 'ViewQuote' | 'ViewNews' |
149
149
  /**
150
150
  * A (Numeric) Column which will be defined as an FDC3 Position
151
151
  */
152
- export interface PositionColumn extends FDC3Column {
152
+ export interface PositionColumn extends FDC3Column_Depr {
153
153
  /**
154
154
  * Column which contains the Instrument information of the FDC3 Message
155
155
  */
@@ -171,7 +171,7 @@ export declare type PositionIntent = 'ViewChart' | 'ViewNews' | 'ViewAnalysis';
171
171
  * A (String) Column which will be defined as an FDC3 Contact
172
172
  * columnId and at least one other property is required
173
173
  */
174
- export interface ContactColumn extends FDC3Column {
174
+ export interface ContactColumn extends FDC3Column_Depr {
175
175
  /**
176
176
  * Column which holds the email address of a Contact
177
177
  */
@@ -196,7 +196,7 @@ export declare type ContactIntent = 'StartCall' | 'StartChat' | 'ViewContact';
196
196
  /**
197
197
  * A (String) Column which will be defined as an FDC3 Organization
198
198
  */
199
- export interface OrganizationColumn extends FDC3Column {
199
+ export interface OrganizationColumn extends FDC3Column_Depr {
200
200
  /**
201
201
  * Column which contains the LEI
202
202
  */
@@ -225,7 +225,7 @@ export declare type OrganizationIntent = 'ViewNews' | 'ViewAnalysis';
225
225
  /**
226
226
  * A (String) Column which will be defined as an FDC3 Country
227
227
  */
228
- export interface CountryColumn extends FDC3Column {
228
+ export interface CountryColumn extends FDC3Column_Depr {
229
229
  /**
230
230
  * Column which contains the ISOALPHA2 Standard
231
231
  */
@@ -250,11 +250,11 @@ export declare type CountryIntent = 'ViewChart';
250
250
  /**
251
251
  * A Column which will be defined as Custom FDC3 (can be any datatype)
252
252
  */
253
- export interface CustomFDC3Column extends FDC3Column {
253
+ export interface CustomFDC3Column extends FDC3Column_Depr {
254
254
  /**
255
255
  * Custom FDC3 Intents available to the column
256
256
  */
257
- intents: CustomFDC3Intent[];
257
+ intents: CustomFDC3Intent_Depr[];
258
258
  /**
259
259
  * Function which creates FDC3 context for the current column and row
260
260
  */
@@ -263,11 +263,11 @@ export interface CustomFDC3Column extends FDC3Column {
263
263
  /**
264
264
  * Full list of FDC3 Intents available - each FDC3 Column can use a subset
265
265
  */
266
- export declare type FDC3Intent = 'StartCall' | 'StartChat' | 'ViewAnalysis' | 'ViewChart' | 'ViewContact' | 'ViewInstrument' | 'ViewNews' | 'ViewQuote';
266
+ export declare type FDC3Intent_Depr = 'StartCall' | 'StartChat' | 'ViewAnalysis' | 'ViewChart' | 'ViewContact' | 'ViewInstrument' | 'ViewNews' | 'ViewQuote';
267
267
  /**
268
268
  * Custom FDC3 Intent - just a string value
269
269
  */
270
- export declare type CustomFDC3Intent = string;
270
+ export declare type CustomFDC3Intent_Depr = string;
271
271
  /**
272
272
  * Context passed into Raise FDC3 Intent functions (e.g. get label)
273
273
  */
@@ -275,12 +275,12 @@ export interface RaiseFDC3IntentContext extends ContextMenuContext {
275
275
  /**
276
276
  * FDC3 Intent that was raised
277
277
  */
278
- intent: FDC3Intent | CustomFDC3Intent;
278
+ intent: FDC3Intent_Depr | CustomFDC3Intent_Depr;
279
279
  }
280
280
  /**
281
281
  * Function that handles FDC3 Context
282
282
  */
283
- export declare type FDC3ContextHandler = (context: FDC3Context) => void;
283
+ export declare type FDC3ContextHandler = (context: FDC3Context_DEPR) => void;
284
284
  /**
285
285
  * Defines a Desktop Agent which supports FDC3
286
286
  */
@@ -288,22 +288,22 @@ export interface FDC3DesktopAgent {
288
288
  /**
289
289
  * Raises an Intent
290
290
  */
291
- raiseIntent: (intent: FDC3Intent, context: FDC3Context) => void;
291
+ raiseIntent: (intent: FDC3Intent_Depr, context: FDC3Context_DEPR) => void;
292
292
  /**
293
293
  * Broadcasts an FDC3 Message
294
294
  */
295
- broadcast: (context: FDC3Context) => void;
295
+ broadcast: (context: FDC3Context_DEPR) => void;
296
296
  /**
297
297
  * Raises an FDC3 Intent for a given Context
298
298
  */
299
- raiseIntentForContext: (context: FDC3Context) => void;
299
+ raiseIntentForContext: (context: FDC3Context_DEPR) => void;
300
300
  /**
301
301
  * Adds an FDC3 Intent Listener
302
302
  */
303
- addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context) => void) => void;
303
+ addIntentListener: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr, listener: (context: FDC3Context_DEPR) => void) => void;
304
304
  /**
305
- * Adds an FDC3 Context Listener
306
- */
305
+ * Adds an FDC3 Context Listener
306
+ */
307
307
  addContextListener: (contextType: string | null, handler: FDC3ContextHandler) => {
308
308
  unsubscribe: () => void;
309
309
  };
@@ -21,6 +21,14 @@ export interface GroupingOptions<TData = any> {
21
21
  * @noCodeItem
22
22
  */
23
23
  restoreUngroupedColumns?: boolean;
24
+ /**
25
+ * Order Row Grouped Columns automatically, using Adaptable State if available (Custom or Column Sort)
26
+ *
27
+ * @defaultValue true
28
+ * @gridInfoItem
29
+ * @noCodeItem
30
+ */
31
+ autoOrderGroupedColumns?: boolean;
24
32
  }
25
33
  /**
26
34
  * Context used when setting a value for Unbalanced Row Groups
@@ -1,5 +1,5 @@
1
1
  import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
2
- import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context';
2
+ import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context_DEPR';
3
3
  /**
4
4
  * Options required for when using the OpenFin plugin
5
5
  */
@@ -31,23 +31,23 @@ export interface UserInterfaceOptions<TData = any> {
31
31
  */
32
32
  dateInputOptions?: DateInputOptions;
33
33
  /**
34
- * List of values which are permitted (e.g. to show in Filter, Custom Sort etc.)
34
+ * List of Column values to display (e.g. in Filter, Custom Sort etc.)
35
35
  */
36
36
  permittedValues?: PermittedValues<TData>[];
37
37
  /**
38
- * Dropdown values displayed when column is being edited; when not defined defaults to permittedValues
38
+ * Dropdown values displayed when column is being edited
39
39
  */
40
40
  editLookUpItems?: EditLookUpPermittedValues<TData>[];
41
41
  /**
42
- * Custom column values for 'IN' filter; when not defined defaults to permittedValues
42
+ * Custom column values for Values ('IN') Filter
43
43
  */
44
44
  filterPermittedValues?: FilterPermittedValues<TData>[];
45
45
  /**
46
- * Custom column values for defining Custom Sort; when not defined defaults to permittedValues
46
+ * Custom column values for defining Custom Sort
47
47
  */
48
48
  customSortPermittedValues?: CustomSortPermittedValues<TData>[];
49
49
  /**
50
- * Custom column values for editing via bulk-update; when not defined defaults to permittedValues
50
+ * Custom column values for editing via bulk-update
51
51
  */
52
52
  bulkUpdatePermittedValues?: BulkUpdatePermittedValues<TData>[];
53
53
  /**
@@ -92,7 +92,7 @@ export interface UserInterfaceOptions<TData = any> {
92
92
  */
93
93
  showAdapTableVersion?: boolean;
94
94
  /**
95
- * English variant to use in UI labels
95
+ * English variant to use in AdapTable UI
96
96
  *
97
97
  * @defaultValue 'GB'
98
98
  * @gridInfoItem
@@ -41,6 +41,7 @@ import { StyledColumnApi } from './StyledColumnApi';
41
41
  import { OptionsApi } from './OptionsApi';
42
42
  import { ActionColumnApi } from './ActionColumnApi';
43
43
  import { ActionRowApi } from './ActionRowApi';
44
+ import { Fdc3Api } from './Fdc3Api';
44
45
  /**
45
46
  *
46
47
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -53,8 +54,8 @@ export interface AdaptableApi {
53
54
  */
54
55
  actionColumnApi: ActionColumnApi;
55
56
  /**
56
- * Provides access to Action Rows
57
- */
57
+ * Provides access to Action Rows
58
+ */
58
59
  actionRowApi: ActionRowApi;
59
60
  /**
60
61
  * Provides access to the Alert Module
@@ -220,6 +221,10 @@ export interface AdaptableApi {
220
221
  * Manages User Interface Options where colours, styles and permitted values are configured
221
222
  */
222
223
  userInterfaceApi: UserInterfaceApi;
224
+ /**
225
+ * Manages the FDC3 capabilities of AdapTable
226
+ */
227
+ fdc3Api: Fdc3Api;
223
228
  /**
224
229
  * Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted.
225
230
  * This destroys the Adaptable instance.
@@ -243,11 +243,6 @@ export interface ColumnApi {
243
243
  * Retrieves current Primary Key Column in AdapTable
244
244
  */
245
245
  getPrimaryKeyColumn(): AdaptableColumn;
246
- /**
247
- * Checks if the Column with given ColumnId is an ActionRowButton column
248
- * @param columnId ColumnId to Check
249
- */
250
- isActionRowButtonColumn(columnId: string): boolean;
251
246
  /**
252
247
  * Returns the default Aggregation Function for a Column
253
248
  * @param columnId Column to Check
@@ -106,7 +106,7 @@ export interface EventApi {
106
106
  */
107
107
  off(eventName: 'SelectionChanged', callback: (selectionChangedInfo: SelectionChangedInfo) => void): void;
108
108
  /**
109
- * Event fired whenever the **selected theme of AdapTable is changed**.
109
+ * Event fired whenever the selected theme of AdapTable is changed
110
110
  * @param eventName ThemeChanged
111
111
  * @param callback ThemeChangedInfo which just contains the name of the current Theme
112
112
  * @returns the unsubscribe function
@@ -117,9 +117,9 @@ export interface EventApi {
117
117
  */
118
118
  off(eventName: 'ThemeChanged', callback: (themeChangedInfo: ThemeChangedInfo) => void): void;
119
119
  /**
120
- * Event fired whenever the a theme has been edited
120
+ * Event fired whenever a theme has been edited
121
121
  * @param eventName ThemeEdited
122
- * @param callback ThemeChangedInfo which just contains the name of the current Theme
122
+ * @param callback ThemeEditedInfo which just contains the name of the current Theme
123
123
  * @returns the unsubscribe function
124
124
  */
125
125
  on(eventName: 'ThemeEdited', callback: (themeEditedInfo: ThemeEditedInfo) => void): VoidFunction;
@@ -9,9 +9,3 @@ export interface ThemeChangedInfo extends BaseEventInfo {
9
9
  */
10
10
  theme: AdaptableTheme | string;
11
11
  }
12
- export interface ThemeEditedInfo extends BaseEventInfo {
13
- /**
14
- * The has been edited
15
- */
16
- theme: AdaptableTheme;
17
- }
@@ -0,0 +1,11 @@
1
+ import { AdaptableTheme } from '../../PredefinedConfig/ThemeState';
2
+ import { BaseEventInfo } from './BaseEventInfo';
3
+ /**
4
+ * Object returned by the `ThemeEdited` event
5
+ */
6
+ export interface ThemeEditedInfo extends BaseEventInfo {
7
+ /**
8
+ * Theme which has been edited
9
+ */
10
+ theme: AdaptableTheme;
11
+ }