@adaptabletools/adaptable 16.0.1-canary.0 → 16.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundle.cjs.js +162 -164
- package/package.json +1 -1
- package/publishTimestamp.d.ts +1 -1
- package/publishTimestamp.js +1 -1
- package/src/AdaptableInterfaces/IAdaptable.d.ts +2 -1
- package/src/AdaptableOptions/AdaptableOptions.d.ts +6 -1
- package/src/AdaptableOptions/AdaptablePlugin.js +2 -0
- package/src/AdaptableOptions/CalendarOptions.d.ts +3 -3
- package/src/AdaptableOptions/CommentsOptions.d.ts +23 -0
- package/src/AdaptableOptions/Fdc3Options.d.ts +69 -53
- package/src/AdaptableOptions/FilterOptions.d.ts +7 -2
- package/src/AdaptableOptions/FinancePluginOptions.d.ts +2 -306
- package/src/AdaptableOptions/OpenFinPluginOptions.d.ts +0 -6
- package/src/AdaptableOptions/UserInterfaceOptions.d.ts +0 -17
- package/src/Api/CommentsApi.d.ts +6 -6
- package/src/Api/EventApi.d.ts +2 -14
- package/src/Api/GridApi.d.ts +13 -13
- package/src/Api/Implementation/ApiBase.d.ts +2 -0
- package/src/Api/Implementation/ApiBase.js +3 -0
- package/src/Api/Implementation/CalendarApiImpl.js +1 -2
- package/src/Api/Implementation/CommentsApiImpl.d.ts +3 -3
- package/src/Api/Implementation/CommentsApiImpl.js +3 -3
- package/src/Api/Implementation/GridApiImpl.js +2 -2
- package/src/Api/Implementation/OptionsApiImpl.d.ts +2 -1
- package/src/Api/Implementation/OptionsApiImpl.js +3 -0
- package/src/Api/Implementation/PluginsApiImpl.d.ts +0 -2
- package/src/Api/Implementation/PluginsApiImpl.js +0 -6
- package/src/Api/Internal/AdaptableInternalApi.js +1 -1
- package/src/Api/Internal/Fdc3InternalApi.js +2 -2
- package/src/Api/OptionsApi.d.ts +5 -1
- package/src/Api/PluginsApi.d.ts +0 -5
- package/src/PredefinedConfig/CommentsState.d.ts +33 -3
- package/src/PredefinedConfig/Common/Entitlement.d.ts +1 -1
- package/src/PredefinedConfig/Common/Fdc3Context.d.ts +6 -0
- package/src/PredefinedConfig/SystemState.d.ts +2 -2
- package/src/Redux/ActionsReducers/SystemRedux.d.ts +4 -4
- package/src/Strategy/CommentsModule.d.ts +2 -2
- package/src/Strategy/CommentsModule.js +11 -11
- package/src/Strategy/Fdc3Module.d.ts +0 -1
- package/src/Strategy/Fdc3Module.js +0 -3
- package/src/Utilities/Constants/GeneralConstants.d.ts +0 -1
- package/src/Utilities/Constants/GeneralConstants.js +2 -3
- package/src/Utilities/Defaults/DefaultAdaptableOptions.js +1 -1
- package/src/Utilities/Services/ModuleService.js +1 -1
- package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationWizard.js +10 -7
- package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/FinanceForm/FinanceForm.d.ts +1 -7
- package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/FinanceForm/FinanceForm.js +621 -268
- package/src/View/Comments/CommentPopup.js +5 -5
- package/src/agGrid/Adaptable.d.ts +3 -2
- package/src/agGrid/Adaptable.js +8 -2
- package/src/agGrid/attachAddaptableColumnTypes.js +1 -0
- package/src/metamodel/adaptable.metamodel.d.ts +55 -394
- package/src/metamodel/adaptable.metamodel.js +1 -1
- package/src/types.d.ts +4 -6
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/src/Api/FinanceApi.d.ts +0 -125
- package/src/PredefinedConfig/Common/FDC3Context_DEPR.d.ts +0 -246
- package/src/PredefinedConfig/Common/FDC3Context_DEPR.js +0 -2
- package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/FinanceForm/index.d.ts +0 -1
- package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/FinanceForm/index.js +0 -5
- /package/src/{Api/FinanceApi.js → AdaptableOptions/CommentsOptions.js} +0 -0
|
@@ -1,310 +1,6 @@
|
|
|
1
|
-
import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context_DEPR, GridCell } from '../../types';
|
|
2
|
-
import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context_DEPR';
|
|
3
1
|
/**
|
|
4
|
-
*
|
|
2
|
+
* Removed in Version 16
|
|
3
|
+
* @deprecated - now provided in FDC3 Options
|
|
5
4
|
*/
|
|
6
5
|
export interface FinancePluginOptions {
|
|
7
|
-
/**
|
|
8
|
-
* Columns to be defined as FDC3-related
|
|
9
|
-
*/
|
|
10
|
-
fdc3Columns?: {
|
|
11
|
-
/**
|
|
12
|
-
* FDC3 Instruments
|
|
13
|
-
*/
|
|
14
|
-
instrumentColumns?: InstrumentColumn[];
|
|
15
|
-
/**
|
|
16
|
-
* FDC3 Positions
|
|
17
|
-
*/
|
|
18
|
-
positionColumns?: PositionColumn[];
|
|
19
|
-
/**
|
|
20
|
-
* FDC3 Contacts
|
|
21
|
-
*/
|
|
22
|
-
contactColumns?: ContactColumn[];
|
|
23
|
-
/**
|
|
24
|
-
* FDC3 Countries
|
|
25
|
-
*/
|
|
26
|
-
countryColumns?: CountryColumn[];
|
|
27
|
-
/**
|
|
28
|
-
* FDC3 Organizations
|
|
29
|
-
*/
|
|
30
|
-
organizationColumns?: OrganizationColumn[];
|
|
31
|
-
/**
|
|
32
|
-
* Custom FDC3 Columns
|
|
33
|
-
*/
|
|
34
|
-
customFDC3Columns?: CustomFDC3Column[];
|
|
35
|
-
/**
|
|
36
|
-
* Custom FDC3 Intents
|
|
37
|
-
*/
|
|
38
|
-
customFDC3Intents?: CustomFDC3Intent_Depr[];
|
|
39
|
-
};
|
|
40
|
-
/**
|
|
41
|
-
* Intents to which to subscribe.
|
|
42
|
-
*/
|
|
43
|
-
availableFDC3Intents?: (FDC3Intent_Depr | CustomFDC3Intent_Depr)[];
|
|
44
|
-
/**
|
|
45
|
-
* Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )
|
|
46
|
-
*
|
|
47
|
-
* @defaultValue TRUE
|
|
48
|
-
*/
|
|
49
|
-
autoHandleFDC3AdaptableMessages?: boolean;
|
|
50
|
-
/**
|
|
51
|
-
* Called when an intent from `availableIntents` is raised.
|
|
52
|
-
*/
|
|
53
|
-
onFDC3Intent?: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr, context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
|
|
54
|
-
/**
|
|
55
|
-
* Called when a context changes.
|
|
56
|
-
*/
|
|
57
|
-
onFDC3Context?: (context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
|
|
61
|
-
*/
|
|
62
|
-
export interface FDC3Column_Depr {
|
|
63
|
-
/**
|
|
64
|
-
* Id of Column defined as FDC3
|
|
65
|
-
*/
|
|
66
|
-
columnId: string;
|
|
67
|
-
/**
|
|
68
|
-
* If provided, will supply `name` property in FDC3 message
|
|
69
|
-
*/
|
|
70
|
-
nameColumnId?: string;
|
|
71
|
-
/**
|
|
72
|
-
* Should Column display a 'Broadcast' context menu item
|
|
73
|
-
*/
|
|
74
|
-
showBroadcastContextMenu?: boolean;
|
|
75
|
-
/**
|
|
76
|
-
* Should Column display a 'Raise Intent for Context' context menu item
|
|
77
|
-
*/
|
|
78
|
-
showRaiseIntentForContextMenu?: boolean;
|
|
79
|
-
/**
|
|
80
|
-
* Label to display in Broadcast Context Menu Item
|
|
81
|
-
*/
|
|
82
|
-
broadcastContextMenuLabel?: string | ((broadcastFDC3MessageContext: ContextMenuContext) => string);
|
|
83
|
-
/**
|
|
84
|
-
* Label to display in RaiseIntentForContext Context Menu Item
|
|
85
|
-
*/
|
|
86
|
-
raiseIntentForContextMenuLabel?: string | ((raiseFDC3IntentForContext: ContextMenuContext) => string);
|
|
87
|
-
/**
|
|
88
|
-
* FDC3 intents which the Column can raise
|
|
89
|
-
*/
|
|
90
|
-
intents?: any[];
|
|
91
|
-
/**
|
|
92
|
-
* Label to display in Intent Context Menu Item
|
|
93
|
-
*/
|
|
94
|
-
intentContextMenuLabel?: string | ((raiseFDC3IntentContext: RaiseFDC3IntentContext) => string);
|
|
95
|
-
/**
|
|
96
|
-
* Returns a custom icon to display in the Raise Intent Context Menu Item;
|
|
97
|
-
*/
|
|
98
|
-
intentIcon?: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr) => AdaptableIcon;
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* A Column which will be defined as an FDC3 Instrument
|
|
102
|
-
*/
|
|
103
|
-
export interface InstrumentColumn extends FDC3Column_Depr {
|
|
104
|
-
/**
|
|
105
|
-
* Column which holds a ticker value as instrument data
|
|
106
|
-
*/
|
|
107
|
-
tickerColumnId?: string;
|
|
108
|
-
/**
|
|
109
|
-
* Column which holds an ISIN value as instrument data
|
|
110
|
-
*/
|
|
111
|
-
isinColumnId?: string;
|
|
112
|
-
/**
|
|
113
|
-
* Column which holds a CUSIP value as instrument data
|
|
114
|
-
*/
|
|
115
|
-
cusipColumnId?: string;
|
|
116
|
-
/**
|
|
117
|
-
* Column which holds a SEDOL value as instrument data
|
|
118
|
-
*/
|
|
119
|
-
sedolColumnId?: string;
|
|
120
|
-
/**
|
|
121
|
-
* Column which holds a Reuters Instrument Code value as instrument data
|
|
122
|
-
*/
|
|
123
|
-
ricColumnId?: string;
|
|
124
|
-
/**
|
|
125
|
-
* Column which holds a Bloomberg Ticker value as instrument data
|
|
126
|
-
*/
|
|
127
|
-
bbgColumnId?: string;
|
|
128
|
-
/**
|
|
129
|
-
* Column which holds a PERMID value as instrument data
|
|
130
|
-
*/
|
|
131
|
-
permidColumnId?: string;
|
|
132
|
-
/**
|
|
133
|
-
* Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data
|
|
134
|
-
*/
|
|
135
|
-
figiColumnId?: string;
|
|
136
|
-
/**
|
|
137
|
-
* Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`
|
|
138
|
-
*/
|
|
139
|
-
intents?: InstrumentIntents;
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* All available Instrument Intents
|
|
143
|
-
*/
|
|
144
|
-
export declare type InstrumentIntents = InstrumentIntent[];
|
|
145
|
-
/**
|
|
146
|
-
* FDC3 Intents available to an Instrument Column
|
|
147
|
-
*/
|
|
148
|
-
export declare type InstrumentIntent = 'ViewChart' | 'ViewQuote' | 'ViewNews' | 'ViewAnalysis' | 'ViewInstrument';
|
|
149
|
-
/**
|
|
150
|
-
* A (Numeric) Column which will be defined as an FDC3 Position
|
|
151
|
-
*/
|
|
152
|
-
export interface PositionColumn extends FDC3Column_Depr {
|
|
153
|
-
/**
|
|
154
|
-
* Column which contains the Instrument information of the FDC3 Message
|
|
155
|
-
*/
|
|
156
|
-
instrumentColumnId: string;
|
|
157
|
-
/**
|
|
158
|
-
* Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`
|
|
159
|
-
*/
|
|
160
|
-
intents?: PositionIntents;
|
|
161
|
-
}
|
|
162
|
-
/**
|
|
163
|
-
* All available Position Intents
|
|
164
|
-
*/
|
|
165
|
-
export declare type PositionIntents = PositionIntent[];
|
|
166
|
-
/**
|
|
167
|
-
* FDC3 Intents available to a Position Column
|
|
168
|
-
*/
|
|
169
|
-
export declare type PositionIntent = 'ViewChart' | 'ViewNews' | 'ViewAnalysis';
|
|
170
|
-
/**
|
|
171
|
-
* A (String) Column which will be defined as an FDC3 Contact
|
|
172
|
-
* columnId and at least one other property is required
|
|
173
|
-
*/
|
|
174
|
-
export interface ContactColumn extends FDC3Column_Depr {
|
|
175
|
-
/**
|
|
176
|
-
* Column which holds the email address of a Contact
|
|
177
|
-
*/
|
|
178
|
-
emailColumnId?: string;
|
|
179
|
-
/**
|
|
180
|
-
* Column which holds an FDS_ID value a Contact
|
|
181
|
-
*/
|
|
182
|
-
fds_idColumnId?: string;
|
|
183
|
-
/**
|
|
184
|
-
* Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`
|
|
185
|
-
*/
|
|
186
|
-
intents?: ContactIntents;
|
|
187
|
-
}
|
|
188
|
-
/**
|
|
189
|
-
* All available Contact Intents
|
|
190
|
-
*/
|
|
191
|
-
export declare type ContactIntents = ContactIntent[];
|
|
192
|
-
/**
|
|
193
|
-
* FDC3 Intents available to a Contact Column
|
|
194
|
-
*/
|
|
195
|
-
export declare type ContactIntent = 'StartCall' | 'StartChat' | 'ViewContact';
|
|
196
|
-
/**
|
|
197
|
-
* A (String) Column which will be defined as an FDC3 Organization
|
|
198
|
-
*/
|
|
199
|
-
export interface OrganizationColumn extends FDC3Column_Depr {
|
|
200
|
-
/**
|
|
201
|
-
* Column which contains the LEI
|
|
202
|
-
*/
|
|
203
|
-
leiColumnId?: string;
|
|
204
|
-
/**
|
|
205
|
-
* Column which contains a PermId
|
|
206
|
-
*/
|
|
207
|
-
permidColumnId?: string;
|
|
208
|
-
/**
|
|
209
|
-
* Column which contains an FDS_ID
|
|
210
|
-
*/
|
|
211
|
-
fds_idColumnId?: string;
|
|
212
|
-
/**
|
|
213
|
-
* Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`
|
|
214
|
-
*/
|
|
215
|
-
intents?: OrganizationIntents;
|
|
216
|
-
}
|
|
217
|
-
/**
|
|
218
|
-
* All available Organization Intents
|
|
219
|
-
*/
|
|
220
|
-
export declare type OrganizationIntents = OrganizationIntent[];
|
|
221
|
-
/**
|
|
222
|
-
* FDC3 Intents available to an Organization Column
|
|
223
|
-
*/
|
|
224
|
-
export declare type OrganizationIntent = 'ViewNews' | 'ViewAnalysis';
|
|
225
|
-
/**
|
|
226
|
-
* A (String) Column which will be defined as an FDC3 Country
|
|
227
|
-
*/
|
|
228
|
-
export interface CountryColumn extends FDC3Column_Depr {
|
|
229
|
-
/**
|
|
230
|
-
* Column which contains the ISOALPHA2 Standard
|
|
231
|
-
*/
|
|
232
|
-
isoalpha2ColumnId?: string;
|
|
233
|
-
/**
|
|
234
|
-
* Column which contains the ISOALPHA3 Standard
|
|
235
|
-
*/
|
|
236
|
-
isoalpha3ColumnId?: string;
|
|
237
|
-
/**
|
|
238
|
-
* Country-related FDC3 Intents; can only be: `ViewChart`
|
|
239
|
-
*/
|
|
240
|
-
intents?: CountryIntents;
|
|
241
|
-
}
|
|
242
|
-
/**
|
|
243
|
-
* All available Country Intents
|
|
244
|
-
*/
|
|
245
|
-
export declare type CountryIntents = CountryIntent[];
|
|
246
|
-
/**
|
|
247
|
-
* FDC3 Intents available to a Country Column
|
|
248
|
-
*/
|
|
249
|
-
export declare type CountryIntent = 'ViewChart';
|
|
250
|
-
/**
|
|
251
|
-
* A Column which will be defined as Custom FDC3 (can be any datatype)
|
|
252
|
-
*/
|
|
253
|
-
export interface CustomFDC3Column extends FDC3Column_Depr {
|
|
254
|
-
/**
|
|
255
|
-
* Custom FDC3 Intents available to the column
|
|
256
|
-
*/
|
|
257
|
-
intents: CustomFDC3Intent_Depr[];
|
|
258
|
-
/**
|
|
259
|
-
* Function which creates FDC3 context for the current column and row
|
|
260
|
-
*/
|
|
261
|
-
createContext: (gridCell: GridCell) => CustomFDC3Context;
|
|
262
|
-
}
|
|
263
|
-
/**
|
|
264
|
-
* Full list of FDC3 Intents available - each FDC3 Column can use a subset
|
|
265
|
-
*/
|
|
266
|
-
export declare type FDC3Intent_Depr = 'StartCall' | 'StartChat' | 'ViewAnalysis' | 'ViewChart' | 'ViewContact' | 'ViewInstrument' | 'ViewNews' | 'ViewQuote';
|
|
267
|
-
/**
|
|
268
|
-
* Custom FDC3 Intent - just a string value
|
|
269
|
-
*/
|
|
270
|
-
export declare type CustomFDC3Intent_Depr = string;
|
|
271
|
-
/**
|
|
272
|
-
* Context passed into Raise FDC3 Intent functions (e.g. get label)
|
|
273
|
-
*/
|
|
274
|
-
export interface RaiseFDC3IntentContext extends ContextMenuContext {
|
|
275
|
-
/**
|
|
276
|
-
* FDC3 Intent that was raised
|
|
277
|
-
*/
|
|
278
|
-
intent: FDC3Intent_Depr | CustomFDC3Intent_Depr;
|
|
279
|
-
}
|
|
280
|
-
/**
|
|
281
|
-
* Function that handles FDC3 Context
|
|
282
|
-
*/
|
|
283
|
-
export declare type FDC3ContextHandler = (context: FDC3Context_DEPR) => void;
|
|
284
|
-
/**
|
|
285
|
-
* Defines a Desktop Agent which supports FDC3
|
|
286
|
-
*/
|
|
287
|
-
export interface FDC3DesktopAgent {
|
|
288
|
-
/**
|
|
289
|
-
* Raises an Intent
|
|
290
|
-
*/
|
|
291
|
-
raiseIntent: (intent: FDC3Intent_Depr, context: FDC3Context_DEPR) => void;
|
|
292
|
-
/**
|
|
293
|
-
* Broadcasts an FDC3 Message
|
|
294
|
-
*/
|
|
295
|
-
broadcast: (context: FDC3Context_DEPR) => void;
|
|
296
|
-
/**
|
|
297
|
-
* Raises an FDC3 Intent for a given Context
|
|
298
|
-
*/
|
|
299
|
-
raiseIntentForContext: (context: FDC3Context_DEPR) => void;
|
|
300
|
-
/**
|
|
301
|
-
* Adds an FDC3 Intent Listener
|
|
302
|
-
*/
|
|
303
|
-
addIntentListener: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr, listener: (context: FDC3Context_DEPR) => void) => void;
|
|
304
|
-
/**
|
|
305
|
-
* Adds an FDC3 Context Listener
|
|
306
|
-
*/
|
|
307
|
-
addContextListener: (contextType: string | null, handler: FDC3ContextHandler) => {
|
|
308
|
-
unsubscribe: () => void;
|
|
309
|
-
};
|
|
310
6
|
}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
|
|
2
|
-
import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context_DEPR';
|
|
3
2
|
/**
|
|
4
3
|
* Options required for when using the OpenFin plugin
|
|
5
4
|
*/
|
|
@@ -44,9 +43,4 @@ export interface OpenFinPluginOptions {
|
|
|
44
43
|
* Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure
|
|
45
44
|
*/
|
|
46
45
|
onValidationFailureInExcel?: 'override' | 'show-notification' | 'show-undo-notification';
|
|
47
|
-
/**
|
|
48
|
-
* Useful when you also use the finance plugin configured with fdc3 related columns - values in cells such columns can be broadcasted to fdc3, and this function
|
|
49
|
-
* will be called for broadcasting. It's your job to broadcast to the desired fdc3 channel
|
|
50
|
-
*/
|
|
51
|
-
onFDC3MessageSent?: (eventInfo: AdaptableFDC3EventInfo) => void;
|
|
52
46
|
}
|
|
@@ -110,10 +110,6 @@ export interface UserInterfaceOptions<TData = any> {
|
|
|
110
110
|
* @defaultValue null
|
|
111
111
|
*/
|
|
112
112
|
alternativeModuleNames?: AlternativeModuleName[];
|
|
113
|
-
/**
|
|
114
|
-
* Whether a cell can be commented on
|
|
115
|
-
*/
|
|
116
|
-
isCellCommentable?: (context: CommmentableCellContext) => boolean;
|
|
117
113
|
}
|
|
118
114
|
/**
|
|
119
115
|
* Base class for all Permitted Values related objects
|
|
@@ -210,19 +206,6 @@ export interface BulkUpdatePermittedValuesContext<TData = any> extends Permitted
|
|
|
210
206
|
*/
|
|
211
207
|
gridCells: GridCell<TData>[];
|
|
212
208
|
}
|
|
213
|
-
/**
|
|
214
|
-
* Context used when determining if a Comment can be added to a Cell
|
|
215
|
-
*/
|
|
216
|
-
export interface CommmentableCellContext extends BaseContext {
|
|
217
|
-
/**
|
|
218
|
-
* Value in Primary Key Column
|
|
219
|
-
*/
|
|
220
|
-
primaryKeyValue: string;
|
|
221
|
-
/**
|
|
222
|
-
* Column where Comment will be displayed
|
|
223
|
-
*/
|
|
224
|
-
columnId: string;
|
|
225
|
-
}
|
|
226
209
|
/**
|
|
227
210
|
* Sets of Tabs avilable in Grid Info Settings Panel
|
|
228
211
|
*/
|
package/src/Api/CommentsApi.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AdaptableComment, AdaptableComments,
|
|
1
|
+
import { AdaptableComment, AdaptableComments, CommentGridCell, CommentsState } from '../PredefinedConfig/CommentsState';
|
|
2
2
|
/**
|
|
3
3
|
* Provides run-time access to Comments Module and related State
|
|
4
4
|
*/
|
|
@@ -21,9 +21,9 @@ export interface CommentsApi {
|
|
|
21
21
|
getAllComments(): AdaptableComments;
|
|
22
22
|
/**
|
|
23
23
|
* Gets all comments for a cell
|
|
24
|
-
* @param
|
|
24
|
+
* @param commentGridCell comment position
|
|
25
25
|
*/
|
|
26
|
-
getCellComments(
|
|
26
|
+
getCellComments(commentGridCell: CommentGridCell): AdaptableComment[];
|
|
27
27
|
/**
|
|
28
28
|
* Returns a comment by uuid
|
|
29
29
|
* @param uuid comment uuid
|
|
@@ -31,10 +31,10 @@ export interface CommentsApi {
|
|
|
31
31
|
getCommentByUuid(uuid: string): AdaptableComment | undefined;
|
|
32
32
|
/**
|
|
33
33
|
* Gets all comments for a cell
|
|
34
|
-
* @param
|
|
34
|
+
* @param commentGridCell comment position
|
|
35
35
|
* @param editMode whether to show the comment in edit mode
|
|
36
36
|
*/
|
|
37
|
-
showComment(
|
|
37
|
+
showComment(commentGridCell: CommentGridCell, editMode?: boolean): void;
|
|
38
38
|
/**
|
|
39
39
|
* Hides the comment popup
|
|
40
40
|
*/
|
|
@@ -42,7 +42,7 @@ export interface CommentsApi {
|
|
|
42
42
|
/**
|
|
43
43
|
* Gets the comment position of the currently open comment popup
|
|
44
44
|
*/
|
|
45
|
-
|
|
45
|
+
getOpenCommentGridCell(): CommentGridCell | null;
|
|
46
46
|
/**
|
|
47
47
|
* Gets the comment edit mode
|
|
48
48
|
*/
|
package/src/Api/EventApi.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { SelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, CheckboxColumnClickedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, QueryRunInfo, ScheduleTriggeredInfo, ChartChangedInfo, ThemeEditedInfo, FilterAppliedInfo } from '../types';
|
|
2
2
|
/**
|
|
3
3
|
* Responsible for publishing the many Events that AdapTable fires
|
|
4
4
|
*/
|
|
@@ -308,21 +308,9 @@ export interface EventApi {
|
|
|
308
308
|
* Unsubscribe from AdaptableReady
|
|
309
309
|
*/
|
|
310
310
|
off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;
|
|
311
|
-
/**
|
|
312
|
-
* Fired when an FDC3Message is sent
|
|
313
|
-
* @param eventName - FDC3MessageSent
|
|
314
|
-
* @param callback - A callback for listening to `FDC3MessageSent`
|
|
315
|
-
* @returns the unsubscribe function
|
|
316
|
-
*
|
|
317
|
-
*/
|
|
318
|
-
on(eventName: 'FDC3MessageSent', callback: (eventInfo: AdaptableFDC3EventInfo) => void): VoidFunction;
|
|
319
|
-
/**
|
|
320
|
-
* Unsubscribe from FDC3MessageSent
|
|
321
|
-
*/
|
|
322
|
-
off(eventName: 'FDC3MessageSent', callback: (eventInfo: AdaptableFDC3EventInfo) => void): void;
|
|
323
311
|
emitSync(eventName: 'DashboardChanged', data?: any): any[];
|
|
324
312
|
emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
|
|
325
313
|
emitSync(eventName: 'AdaptableDestroy'): any[];
|
|
326
|
-
emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | '
|
|
314
|
+
emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | 'FilterApplied' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'QueryRun' | 'ScheduleTriggered' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited', data?: any): Promise<any>;
|
|
327
315
|
destroy(): void;
|
|
328
316
|
}
|
package/src/Api/GridApi.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo'
|
|
|
15
15
|
*/
|
|
16
16
|
export interface GridApi {
|
|
17
17
|
/**
|
|
18
|
-
* Returns Grid section from
|
|
18
|
+
* Returns Grid section from AdapTable State
|
|
19
19
|
*/
|
|
20
20
|
getGridState(): GridState;
|
|
21
21
|
/**
|
|
@@ -27,41 +27,41 @@ export interface GridApi {
|
|
|
27
27
|
*/
|
|
28
28
|
getFilteredData(): any[];
|
|
29
29
|
/**
|
|
30
|
-
* Repopulates grid with given data
|
|
31
|
-
* @param data any data
|
|
30
|
+
* Repopulates EXISTING grid with given data; fires GridDataChanged' Event
|
|
31
|
+
* @param data any data suitable as AG Grid data source
|
|
32
32
|
*/
|
|
33
33
|
setGridData(data: any[]): void;
|
|
34
34
|
/**
|
|
35
|
-
* Sets grid with given data;
|
|
36
|
-
* @param
|
|
35
|
+
* Sets grid with given data for FIRST use; doesn't fire 'GridDataChanged' Event
|
|
36
|
+
* @param dataany data suitable as AG Grid data source
|
|
37
37
|
*/
|
|
38
38
|
setInitialGridData(data: any): void;
|
|
39
39
|
/**
|
|
40
|
-
* Updates
|
|
41
|
-
* @param dataRows rows which have been updated - send whole row and
|
|
40
|
+
* Updates AdapTable (and AG Grid) with rows that have changed
|
|
41
|
+
* @param dataRows rows which have been updated - send whole row and AdapTable take cares of the rest
|
|
42
42
|
* @param config batch option and callback function to run post update
|
|
43
43
|
*/
|
|
44
44
|
updateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
|
|
45
45
|
/**
|
|
46
|
-
* Adds or Updates
|
|
46
|
+
* Adds or Updates AdapTable (and AG Grid) with new and changed rows
|
|
47
47
|
* @param dataRows rows to add or update
|
|
48
48
|
* @param config batch option and callback function to run post change
|
|
49
49
|
*/
|
|
50
50
|
addOrUpdateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
|
|
51
51
|
/**
|
|
52
|
-
* Adds rows to
|
|
52
|
+
* Adds rows to AdapTable (and AG Grid)
|
|
53
53
|
* @param dataRows rows to add; ensure all 'mandatory' fields are included and Primary Key is unique
|
|
54
54
|
* @param config batch option and callback function to run post addition
|
|
55
55
|
*/
|
|
56
56
|
addGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
|
|
57
57
|
/**
|
|
58
|
-
* Deletes rows from
|
|
58
|
+
* Deletes rows from AdapTable (and AG Grid)
|
|
59
59
|
* @param dataRows rows which should be deleted
|
|
60
60
|
* @param config batch option and callback function to run post deletion
|
|
61
61
|
*/
|
|
62
62
|
deleteGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
|
|
63
63
|
/**
|
|
64
|
-
* Updates cell in
|
|
64
|
+
* Updates cell in AdapTable (first performs Cell & Server Validation)
|
|
65
65
|
* @param cellUpdateRequest (contains columnId, newValue and primaryKeyValue
|
|
66
66
|
*
|
|
67
67
|
*/
|
|
@@ -88,7 +88,7 @@ export interface GridApi {
|
|
|
88
88
|
*/
|
|
89
89
|
getAgGridInstance(): GridOptions;
|
|
90
90
|
/**
|
|
91
|
-
* Returns Column Sort information in
|
|
91
|
+
* Returns Column Sort information in AdapTable
|
|
92
92
|
*/
|
|
93
93
|
getColumnSorts(): ColumnSort[];
|
|
94
94
|
/**
|
|
@@ -497,7 +497,7 @@ export interface GridApi {
|
|
|
497
497
|
*/
|
|
498
498
|
deselectAll(): void;
|
|
499
499
|
/**
|
|
500
|
-
* Returns the Grid Container in which the
|
|
500
|
+
* Returns the Grid Container in which the AdapTable Instance is present
|
|
501
501
|
*/
|
|
502
502
|
getGridContainerElement(): HTMLElement | null;
|
|
503
503
|
/**
|
|
@@ -21,6 +21,7 @@ import { ExpressionApi } from '../ExpressionApi';
|
|
|
21
21
|
import { CalendarOptions } from '../../AdaptableOptions/CalendarOptions';
|
|
22
22
|
import { Fdc3Api } from '../Fdc3Api';
|
|
23
23
|
import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
|
|
24
|
+
import { CommentOptions } from '../../AdaptableOptions/CommentsOptions';
|
|
24
25
|
export declare abstract class ApiBase {
|
|
25
26
|
protected adaptable: IAdaptable;
|
|
26
27
|
/**
|
|
@@ -64,6 +65,7 @@ export declare abstract class ApiBase {
|
|
|
64
65
|
protected getActionColumnOptions(): ActionColumnOptions;
|
|
65
66
|
protected getActionRowOptions(): ActionRowOptions;
|
|
66
67
|
protected getColumnOptions(): ColumnOptions;
|
|
68
|
+
protected getCommentOptions(): CommentOptions;
|
|
67
69
|
protected getCustomSortOptions(): CustomSortOptions;
|
|
68
70
|
protected getDataSetOptions(): DataSetOptions;
|
|
69
71
|
protected getCalendarOptions(): CalendarOptions;
|
|
@@ -102,6 +102,9 @@ class ApiBase {
|
|
|
102
102
|
getColumnOptions() {
|
|
103
103
|
return this.getOptions().columnOptions;
|
|
104
104
|
}
|
|
105
|
+
getCommentOptions() {
|
|
106
|
+
return this.getOptions().commentOptions;
|
|
107
|
+
}
|
|
105
108
|
getCustomSortOptions() {
|
|
106
109
|
return this.getOptions().customSortOptions;
|
|
107
110
|
}
|
|
@@ -27,8 +27,7 @@ class CalendarApiImpl extends ApiBase_1.ApiBase {
|
|
|
27
27
|
return dateToCheck.getDay() != 0 && dateToCheck.getDay() != 6;
|
|
28
28
|
}
|
|
29
29
|
for (let holiday of holidays) {
|
|
30
|
-
|
|
31
|
-
if (holidayDate.setHours(0, 0, 0, 0) == dateToCheck.setHours(0, 0, 0, 0)) {
|
|
30
|
+
if (holiday.setHours(0, 0, 0, 0) == dateToCheck.setHours(0, 0, 0, 0)) {
|
|
32
31
|
return false;
|
|
33
32
|
}
|
|
34
33
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ApiBase } from './ApiBase';
|
|
2
2
|
import { CommentsApi } from '../CommentsApi';
|
|
3
|
-
import { AdaptableComment, AdaptableComments,
|
|
3
|
+
import { AdaptableComment, AdaptableComments, CommentGridCell, CommentsState } from '../../PredefinedConfig/CommentsState';
|
|
4
4
|
export declare class CommentsApiImpl extends ApiBase implements CommentsApi {
|
|
5
5
|
addComment(comment: string, primaryKeyValue: any, columnId: string): void;
|
|
6
6
|
editComment(adaptableComment: AdaptableComment): void;
|
|
@@ -13,8 +13,8 @@ export declare class CommentsApiImpl extends ApiBase implements CommentsApi {
|
|
|
13
13
|
ColumnId: string;
|
|
14
14
|
}): AdaptableComments;
|
|
15
15
|
getCommentByUuid(uuid: string): AdaptableComment | undefined;
|
|
16
|
-
showComment(
|
|
16
|
+
showComment(commentGridCell: CommentGridCell, editMode?: boolean): void;
|
|
17
17
|
hideComment(): void;
|
|
18
|
-
|
|
18
|
+
getOpenCommentGridCell(): CommentGridCell | undefined;
|
|
19
19
|
getCommentPopupEditMode(): boolean;
|
|
20
20
|
}
|
|
@@ -43,13 +43,13 @@ class CommentsApiImpl extends ApiBase_1.ApiBase {
|
|
|
43
43
|
getCommentByUuid(uuid) {
|
|
44
44
|
return this.getAllComments().find((comment) => comment.Uuid === uuid);
|
|
45
45
|
}
|
|
46
|
-
showComment(
|
|
47
|
-
this.dispatchAction(SystemRedux.SystemCommentsShow(
|
|
46
|
+
showComment(commentGridCell, editMode) {
|
|
47
|
+
this.dispatchAction(SystemRedux.SystemCommentsShow(commentGridCell, editMode));
|
|
48
48
|
}
|
|
49
49
|
hideComment() {
|
|
50
50
|
this.dispatchAction(SystemRedux.SystemCommentsHide());
|
|
51
51
|
}
|
|
52
|
-
|
|
52
|
+
getOpenCommentGridCell() {
|
|
53
53
|
return SystemRedux.SystemCommentsSelector(this.getAdaptableState().System);
|
|
54
54
|
}
|
|
55
55
|
getCommentPopupEditMode() {
|
|
@@ -17,12 +17,12 @@ class GridApiImpl extends ApiBase_1.ApiBase {
|
|
|
17
17
|
return this.getAdaptableState().Grid;
|
|
18
18
|
}
|
|
19
19
|
setGridData(dataSource) {
|
|
20
|
-
this.adaptable.
|
|
20
|
+
this.adaptable.setGridData(dataSource);
|
|
21
21
|
const allRowNodes = this.getAllRowNodes();
|
|
22
22
|
this.internalApi.fireGridDataChangedEvent(dataSource, allRowNodes, 'Add');
|
|
23
23
|
}
|
|
24
24
|
setInitialGridData(data) {
|
|
25
|
-
this.adaptable.
|
|
25
|
+
this.adaptable.setInitialGridData(data);
|
|
26
26
|
}
|
|
27
27
|
getGridData() {
|
|
28
28
|
return this.adaptable.getGridData();
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ApiBase } from './ApiBase';
|
|
2
|
-
import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../../types';
|
|
2
|
+
import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, CommentOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../../types';
|
|
3
3
|
import { GroupingOptions } from '../../AdaptableOptions/GroupingOptions';
|
|
4
4
|
import { CustomSortOptions } from '../../AdaptableOptions/CustomSortOptions';
|
|
5
5
|
import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
|
|
@@ -16,6 +16,7 @@ export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
|
|
|
16
16
|
getCellSummaryOptions(): CellSummaryOptions;
|
|
17
17
|
getCalendarOptions(): CalendarOptions;
|
|
18
18
|
getColumnOptions(): ColumnOptions;
|
|
19
|
+
getCommentOptions(): CommentOptions;
|
|
19
20
|
getCustomSortOptions(): CustomSortOptions;
|
|
20
21
|
getContainerOptions(): ContainerOptions;
|
|
21
22
|
getDataSetOptions(): DataSetOptions;
|
|
@@ -39,6 +39,9 @@ class OptionsApiImpl extends ApiBase_1.ApiBase {
|
|
|
39
39
|
getColumnOptions() {
|
|
40
40
|
return this.getOptions().columnOptions;
|
|
41
41
|
}
|
|
42
|
+
getCommentOptions() {
|
|
43
|
+
return this.getOptions().commentOptions;
|
|
44
|
+
}
|
|
42
45
|
getCustomSortOptions() {
|
|
43
46
|
return this.getOptions().customSortOptions;
|
|
44
47
|
}
|
|
@@ -4,7 +4,6 @@ import { ApiBase } from './ApiBase';
|
|
|
4
4
|
import { IPushPullApi } from '../IPushPullApi';
|
|
5
5
|
import { Glue42Api } from '../Glue42Api';
|
|
6
6
|
import { OpenFinApi } from '../OpenFinApi';
|
|
7
|
-
import { FinanceApi } from '../FinanceApi';
|
|
8
7
|
import { FinsembleApi } from '../FinsembleApi';
|
|
9
8
|
import { Glue42WebApi } from '../Glue42WebApi';
|
|
10
9
|
export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
|
|
@@ -17,6 +16,5 @@ export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
|
|
|
17
16
|
getGlue42PluginApi(): Glue42Api;
|
|
18
17
|
getGlue42WebPluginApi(): Glue42WebApi;
|
|
19
18
|
getOpenFinPluginApi(): OpenFinApi;
|
|
20
|
-
getFinancePluginApi(): FinanceApi;
|
|
21
19
|
getFinsemblePluginApi(): FinsembleApi;
|
|
22
20
|
}
|
|
@@ -23,9 +23,6 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
|
|
|
23
23
|
if (pluginId === 'ipushpull') {
|
|
24
24
|
return api;
|
|
25
25
|
}
|
|
26
|
-
if (pluginId === 'finance') {
|
|
27
|
-
return api;
|
|
28
|
-
}
|
|
29
26
|
if (pluginId === 'glue42') {
|
|
30
27
|
return api;
|
|
31
28
|
}
|
|
@@ -56,9 +53,6 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
|
|
|
56
53
|
getOpenFinPluginApi() {
|
|
57
54
|
return this.getPluginApi('openfin');
|
|
58
55
|
}
|
|
59
|
-
getFinancePluginApi() {
|
|
60
|
-
return this.getPluginApi('finance');
|
|
61
|
-
}
|
|
62
56
|
getFinsemblePluginApi() {
|
|
63
57
|
return this.getPluginApi('finsemble');
|
|
64
58
|
}
|