@sapui5/ts-types 1.119.2 → 1.120.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +58 -58
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +111 -1
  8. package/types/sap.f.d.ts +2 -2
  9. package/types/sap.fe.core.d.ts +10 -1
  10. package/types/sap.fe.macros.d.ts +78 -74
  11. package/types/sap.fe.navigation.d.ts +1 -1
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +11 -2
  14. package/types/sap.fe.test.d.ts +5 -5
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +933 -15
  18. package/types/sap.insights.d.ts +93 -12
  19. package/types/sap.m.d.ts +6447 -913
  20. package/types/sap.makit.d.ts +1 -1
  21. package/types/sap.me.d.ts +1 -1
  22. package/types/sap.ndc.d.ts +1 -1
  23. package/types/sap.ovp.d.ts +4 -3
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +848 -975
  26. package/types/sap.suite.ui.commons.d.ts +34 -2
  27. package/types/sap.suite.ui.generic.template.d.ts +29 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +47 -1
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +1 -1
  32. package/types/sap.ui.comp.d.ts +572 -35
  33. package/types/sap.ui.core.d.ts +1866 -242
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +1 -1
  36. package/types/sap.ui.fl.d.ts +3 -1
  37. package/types/sap.ui.generic.app.d.ts +1 -1
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +1 -1
  40. package/types/sap.ui.layout.d.ts +125 -102
  41. package/types/sap.ui.mdc.d.ts +1869 -1151
  42. package/types/sap.ui.richtexteditor.d.ts +4 -12
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +7 -1
  46. package/types/sap.ui.table.d.ts +117 -47
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +1 -1
  49. package/types/sap.ui.ux3.d.ts +1 -1
  50. package/types/sap.ui.vbm.d.ts +1 -1
  51. package/types/sap.ui.vk.d.ts +5 -11
  52. package/types/sap.ui.vtm.d.ts +1 -1
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +470 -136
  55. package/types/sap.ui.webc.main.d.ts +3623 -1052
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +1971 -832
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +1 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
  65. package/types/sap.landvisz.d.ts +0 -7875
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.119.0
1
+ // For Library Version: 1.120.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace sac {
@@ -12,19 +12,21 @@ declare namespace sap {
12
12
  namespace model {
13
13
  interface MultiDimModel$DataProviderAddedEventParameters {}
14
14
 
15
+ interface MultiDimModel$DataProviderRemovedEventParameters {}
16
+
15
17
  interface MultiDimModel$DataProviderUpdatedEventParameters {}
16
18
 
19
+ interface MultiDimModel$LoadedEventParameters {}
20
+
17
21
  /**
18
22
  * @since 1.119
19
- * @experimental
23
+ * @experimental (since 1.119)
20
24
  *
21
25
  * Axis Layout showing which dimensions are set on rows and which on columns.
22
26
  * ```javascript
23
27
  *
24
- * {
25
- * "Rows": [],
26
- * "Columns": []
27
- * }
28
+ * "Rows": [],
29
+ * "Columns": []
28
30
  * ```
29
31
  */
30
32
  class AxesLayout extends sap.ui.base.Object {
@@ -66,8 +68,8 @@ declare namespace sap {
66
68
  */
67
69
  setAxesLayout(
68
70
  /**
69
- * an array containing a containing the names of the dimensions on rows. The order in the array control
70
- * the position on the axis.
71
+ * an array containing the names of the dimensions on rows. The order in the array control the position
72
+ * on the axis.
71
73
  */
72
74
  aDimensionOnRowsAxis: string[],
73
75
  /**
@@ -78,20 +80,18 @@ declare namespace sap {
78
80
  ): sap.sac.df.model.AxesLayout;
79
81
  }
80
82
  /**
81
- * @experimental
82
- *
83
- * A `DataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol HANA
84
- * - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
83
+ * @since 1.119
84
+ * @experimental (since 1.119)
85
85
  *
86
- * Instances of this class should only be created by the {sap.sac.df.model.MultiDimModel}. The `MultiDimModel`
87
- * populates it's exposed data via Binding to Controls. The structure of data exposed by a DataProvider
88
- * is as follows:
86
+ * A data provider is an analytical query exposed via an analytical engine and accessed via InA protocol.
87
+ * It represents a navigable query manager and allows to access and change data. Instances of this class
88
+ * should only be created by the {@link sap.sac.df.model.MultiDimModel}.
89
89
  *
90
- * **Structure of Exposed Data**
90
+ * **Structure of Exposed Data:**
91
91
  * ```javascript
92
92
  *
93
93
  * "Name": "",
94
- * "QueryInfo": { },
94
+ * "DataSourceInfo": { },
95
95
  * "Variables": { }
96
96
  * "Dimensions": { },
97
97
  * "Measures": [ ],
@@ -104,31 +104,21 @@ declare namespace sap {
104
104
  * ```
105
105
  */
106
106
  class DataProvider extends sap.ui.base.Object {
107
- /**
108
- * Constructor for a new DataProvider.
109
- *
110
- * A DataProvider represents a navigable queryManager and allows to access and change data from servers
111
- * providing the InA Protocol.
112
- */
113
- constructor(
114
- /**
115
- * the model to which the DataProvider belongs
116
- */
117
- oMultiDimModel: sap.sac.df.model.MultiDimModel,
118
- /**
119
- * name of the DataProvider
120
- */
121
- sDataProviderName: string
122
- );
107
+ constructor();
123
108
  /**
124
109
  * AxesLayout
125
110
  */
126
111
  AxesLayout: sap.sac.df.model.AxesLayout;
127
112
 
113
+ /**
114
+ * DataSourceInfo
115
+ */
116
+ DataSourceInfo: sap.sac.df.model.DataSourceInfo;
117
+
128
118
  /**
129
119
  * Dimensions
130
120
  */
131
- Dimensions: sap.sac.df.model.Dimension;
121
+ Dimensions: Record<string, sap.sac.df.model.Dimension>;
132
122
 
133
123
  /**
134
124
  * Grid
@@ -138,12 +128,12 @@ declare namespace sap {
138
128
  /**
139
129
  * Measures
140
130
  */
141
- Measures: /* was: sap.sac.df.model.Measure */ any;
131
+ Measures: Record<string, /* was: sap.sac.df.model.Measure */ any>;
142
132
 
143
133
  /**
144
134
  * Variables
145
135
  */
146
- Variables: sap.sac.df.model.Variable;
136
+ Variables: Record<string, sap.sac.df.model.Variable>;
147
137
 
148
138
  /**
149
139
  * Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
@@ -175,243 +165,300 @@ declare namespace sap {
175
165
  */
176
166
  static getMetadata(): sap.ui.base.Metadata;
177
167
  /**
178
- * Updates the MultiDimModel from the given the model state including all aggregated `DataProvider`s
168
+ * Updates the multidimensional model from the given the state of a data provider
179
169
  *
180
- * @returns Promise Promise which resolves to the updated instance of the OlapModel.
170
+ * @returns Promise with reference to this in order to allow method chaining
181
171
  */
182
172
  deserialize(
183
173
  /**
184
- * the JSON object containing the persisted state of th MultiDimModel to be applied.
174
+ * the JSON object containing the persisted state of a data provider to be applied.
185
175
  */
186
176
  oModelState: object,
187
177
  /**
188
- * the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
178
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
179
+ */
180
+ sFormat?: string,
181
+ /**
182
+ * Indicator if the data provider updated should be suppressed after deserialization
189
183
  */
190
- sFormat: string
191
- ): undefined;
184
+ bSuppressUpdate?: boolean
185
+ ): Promise<this>;
192
186
  /**
193
187
  * Export Data
194
188
  */
195
189
  exportData(
196
190
  /**
197
- * data export configuration
191
+ * Data export configuration
198
192
  */
199
193
  oDataExportConfig: object
200
194
  ): void;
201
195
  /**
202
- * Get Axis Layout
196
+ * Get axis Layout
203
197
  *
204
- * @returns axis layout
198
+ * @returns Axis layout object
205
199
  */
206
200
  getAxesLayout(): sap.sac.df.model.AxesLayout;
207
201
  /**
208
- * Gets the scaling factor of a measure or data cell
202
+ * Get data source information
209
203
  *
210
- * @returns the current decimal places setting
204
+ * @returns data source information object
205
+ */
206
+ getDataSourceInfo(): sap.sac.df.model.DataSourceInfo;
207
+ /**
208
+ * Get the scaling factor of a measure or cell
209
+ *
210
+ * @returns Number of decimal places
211
211
  */
212
212
  getDecimalPlaces(
213
213
  /**
214
- * the Member of the Measure Structure
214
+ * Measure structure member
215
215
  */
216
- sMeasureMember: string,
216
+ sMeasureStructureMember: string,
217
217
  /**
218
- * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
218
+ * Structure (non-measure) member
219
219
  */
220
- sNonMeasureMember: string
220
+ sStructureMember: string
221
221
  ): int;
222
222
  /**
223
223
  * Get Dimension
224
224
  *
225
- * @returns a dimension object
225
+ * @returns Dimension object
226
226
  */
227
227
  getDimension(
228
228
  /**
229
- * dimension name
229
+ * Dimension name
230
230
  */
231
231
  sDimensionName: string
232
232
  ): sap.sac.df.model.Dimension;
233
233
  /**
234
- * Get Dimensions
234
+ * Get all dimensions
235
235
  *
236
- * @returns a dimension object
236
+ * @returns Object of all dimensions
237
237
  */
238
238
  getDimensions(): Record<string, sap.sac.df.model.Dimension>;
239
239
  /**
240
240
  * Get Grid
241
241
  *
242
- * @returns grid
242
+ * @returns Grid object
243
243
  */
244
244
  getGrid(): sap.sac.df.model.Grid;
245
245
  /**
246
246
  * Get measure
247
247
  *
248
- * @returns a dimension object
248
+ * @returns Measure object
249
249
  */
250
250
  getMeasure(
251
251
  /**
252
- * measure name
252
+ * Measure name
253
253
  */
254
254
  sMeasureName: string
255
255
  ): /* was: sap.sac.df.model.Measure */ any;
256
256
  /**
257
- * Get measures
257
+ * Get all measures
258
258
  *
259
- * @returns a dimension object
259
+ * @returns Object of all measures
260
260
  */
261
261
  getMeasures(): /* was: sap.sac.df.model.Measure */ any;
262
262
  /**
263
263
  * Get Measure Structure Dimension
264
264
  *
265
- * @returns measure structure dimension
265
+ * @returns Measure structure dimension
266
266
  */
267
267
  getMeasureStructureDimension(): sap.sac.df.model.Dimension;
268
268
  /**
269
- * Get Query Information
270
- *
271
- * @returns query information
272
- */
273
- getQueryInfo(): sap.sac.df.model.QueryInfo;
274
- /**
275
- * Get Result Set
269
+ * Get result set
276
270
  */
277
271
  getResultSet(
278
272
  /**
279
- * enforce result set update
273
+ * Enforce result set update
280
274
  */
281
- bForceResultSetUpdate?: boolean
275
+ bEnforceResultSetUpdate?: boolean
282
276
  ): void;
283
277
  /**
284
- * Gets the scaling factor of a measure
278
+ * Get the scaling factor of a measure or cell
285
279
  *
286
- * @returns the exponent of the scaling factor in Base 10
280
+ * @returns Scaling factor
287
281
  */
288
282
  getScalingFactor(
289
283
  /**
290
- * the Member of the Measure Structure
284
+ * Measure structure member
291
285
  */
292
- sMeasureMember: string,
286
+ sMeasureStructureMember: string,
293
287
  /**
294
- * the Member of the Non Measure Structure
288
+ * Structure (non-measure) member
295
289
  */
296
- sNonMeasureMember: string
290
+ sStructureMember: string
297
291
  ): int;
298
292
  /**
299
- * Get Non-Measure Structure Dimension
293
+ * Get structure (non-measure) dimension
300
294
  *
301
- * @returns non-measure structure dimension
295
+ * @returns Structure dimension object
302
296
  */
303
297
  getStructureDimension(): sap.sac.df.model.Dimension;
304
298
  /**
305
299
  * Get Variable
306
300
  *
307
- * @returns a variable object
301
+ * @returns Variable object
308
302
  */
309
303
  getVariable(
310
304
  /**
311
- * variable name
305
+ * Variable Name
312
306
  */
313
307
  sVariableName: string
314
308
  ): sap.sac.df.model.Variable;
315
309
  /**
316
- * Get Variables
310
+ * Get all variables
317
311
  *
318
- * @returns a variable object
312
+ * @returns Object of all variables
319
313
  */
320
314
  getVariables(): Record<string, sap.sac.df.model.Variable>;
321
315
  /**
322
- * Serialize the Data Provider to a JSON representation
316
+ * Serialize the data provider state to a JSON representation
323
317
  *
324
- * @returns a javascript object which represents the `DataProvider`.
318
+ * @returns A JSON object which represents the data provider
325
319
  */
326
320
  serialize(
327
321
  /**
328
- * the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `DataProvider` to be serialized
329
- * from an equivalent such Object.
322
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
330
323
  */
331
- sFormat: string
324
+ sFormat?: string
332
325
  ): object;
333
326
  /**
334
- * Sets the number of decimal of a measure/query cell
327
+ * Set the number of decimal places of a measure or cell
335
328
  *
336
- * @returns the MultiDimDataProvider
329
+ * @returns Reference to this in order to allow method chaining
337
330
  */
338
331
  setDecimalPlaces(
339
332
  /**
340
- * number of the decimal palaces to be shown after the separator
333
+ * Number of the decimal places
341
334
  */
342
335
  nNumberOfDecimalPlaces: int,
343
336
  /**
344
- * the Member of the Measure Structure
337
+ * Measure structure member
345
338
  */
346
- sMeasureMember: string,
339
+ sMeasureStructureMember: string,
347
340
  /**
348
- * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
341
+ * Structure (non-measure) member
349
342
  */
350
- the: string
343
+ sStructureMember: string
351
344
  ): this;
352
345
  /**
353
- * Sets the scaling factor of a measure/query cell
346
+ * Set the scaling factor of a measure or cell
354
347
  *
355
- * @returns the MultiDimDataProvider
348
+ * @returns Reference to this in order to allow method chaining
356
349
  */
357
350
  setScalingFactor(
358
351
  /**
359
- * the exponential of the scaling factor
352
+ * Scaling factor
360
353
  */
361
354
  nFactor: int,
362
355
  /**
363
- * the Member of the Measure Structure
356
+ * Measure structure member
364
357
  */
365
- sMeasureMember: string,
358
+ sMeasureStructureMember: string,
366
359
  /**
367
- * the Member of the Non Measure Structure
360
+ * Structure (non-measure) member
368
361
  */
369
- sNonMeasureMember: string
362
+ sStructureMember: string
370
363
  ): this;
371
364
  /**
372
- * Checks whether an InA capability is supported by the backend. Throws an error for unhandled capabilities.
373
- * List of handled capabilities can be seen in type sap.sac.df.model.Capability
365
+ * Checks whether an InA capability is supported by the server. Throws an error for unhandled capabilities.
366
+ * List of handled capabilities can be seen in type {@link sap.sac.df.model.Capability}
374
367
  *
375
- * @returns returns true, if the capability is supported, else false
368
+ * @returns Returns true, if the capability is supported, else false
376
369
  */
377
370
  supportsCapability(
378
371
  /**
379
- * the capability name
372
+ * Capability name
380
373
  */
381
374
  sCapability: undefined
382
375
  ): boolean;
383
376
  }
384
377
  /**
385
378
  * @since 1.119
386
- * @experimental
379
+ * @experimental (since 1.119)
380
+ *
381
+ * Query Info providing the following information
382
+ * ```javascript
383
+ *
384
+ * "QueryTitle": "",
385
+ * "QueryName": "",
386
+ * "QueryType": "",
387
+ * "SystemName": "",
388
+ * "CreatedBy": "",
389
+ * "CreatedOn": "",
390
+ * "QueryDueDateText": "",
391
+ * "CreatedOnText": "",
392
+ * "QueryDueDate": "",
393
+ * "ResultAlignmentRows": "",
394
+ * "ResultAlignmentColumns": "",
395
+ * "LastUpdated": "",
396
+ * "LastUpdatedBy": "",
397
+ * "LastUpdatedText": ""
398
+ * ```
399
+ */
400
+ class DataSourceInfo extends sap.ui.base.Object {
401
+ constructor();
402
+
403
+ /**
404
+ * Creates a new subclass of class sap.sac.df.model.DataSourceInfo with name `sClassName` and enriches it
405
+ * with the information contained in `oClassInfo`.
406
+ *
407
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
408
+ *
409
+ * @returns Created class / constructor function
410
+ */
411
+ static extend<T extends Record<string, unknown>>(
412
+ /**
413
+ * Name of the class being created
414
+ */
415
+ sClassName: string,
416
+ /**
417
+ * Object literal with information about the class
418
+ */
419
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.DataSourceInfo>,
420
+ /**
421
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
422
+ * used by this class
423
+ */
424
+ FNMetaImpl?: Function
425
+ ): Function;
426
+ /**
427
+ * Returns a metadata object for class sap.sac.df.model.DataSourceInfo.
428
+ *
429
+ * @returns Metadata object describing this class
430
+ */
431
+ static getMetadata(): sap.ui.base.Metadata;
432
+ }
433
+ /**
434
+ * @since 1.119
435
+ * @experimental (since 1.119)
387
436
  *
388
437
  * Dimension
389
438
  * ```javascript
390
439
  *
391
- * "Name": "",
392
- * "TechName": "",
393
- * "Description": "",
394
- * "Axis": "",
395
- * "Type": "",
396
- * "HierarchyActive": "",
397
- * "HasFilter": "",
398
- * "MemberFilter": [],
399
- * "SortDirection": "",
400
- * "Position": "",
401
- * "LastPosition": "",
402
- * "IsStructure": "",
403
- * "IsMeasureStructure": "",
404
- * "ValueType": "",
405
- * "SemanticObject": "",
406
- * "Members": [
407
- * {
408
- * "Key": "",
409
- * "Name": "",
410
- * "TechName": "",
411
- * "Description": "",
412
- * "SemanticObject": "
413
- * }
414
- * ]
440
+ * "Name": "",
441
+ * "TechName": "",
442
+ * "Description": "",
443
+ * "Axis": "",
444
+ * "Type": "",
445
+ * "HierarchyActive": "",
446
+ * "HasFilter": "",
447
+ * "MemberFilter": [],
448
+ * "SortDirection": "",
449
+ * "Position": "",
450
+ * "LastPosition": "",
451
+ * "IsStructure": "",
452
+ * "IsMeasureStructure": "",
453
+ * "ValueType": "",
454
+ * "SemanticObject": "",
455
+ * "Members": [{
456
+ * "Key": "",
457
+ * "Name": "",
458
+ * "TechName": "",
459
+ * "Description": "",
460
+ * "SemanticObject": "
461
+ * }]
415
462
  * ```
416
463
  */
417
464
  class Dimension extends sap.ui.base.Object {
@@ -446,12 +493,6 @@ declare namespace sap {
446
493
  * @returns Metadata object describing this class
447
494
  */
448
495
  static getMetadata(): sap.ui.base.Metadata;
449
- /**
450
- * Get Structure Members
451
- *
452
- * @returns array of structure members
453
- */
454
- static getStructureMembers(): any[];
455
496
  /**
456
497
  * Set Display Type of Dimension
457
498
  *
@@ -464,23 +505,45 @@ declare namespace sap {
464
505
  sDisplayType: string
465
506
  ): sap.sac.df.model.Dimension;
466
507
  /**
467
- * get the list of filters of a dimension
508
+ * Add dimension filters
509
+ *
510
+ * @returns Reference to this in order to allow method chaining
511
+ */
512
+ addMemberFilter(
513
+ /**
514
+ * a member filter object
515
+ */
516
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
517
+ ): this;
518
+ /**
519
+ * Add a member filter by its key
468
520
  *
469
- * @returns list of a range with components
521
+ * @returns Reference to this in order to allow method chaining
470
522
  */
471
- getMemberFilter(): sap.sac.df.model.MemberFilter;
523
+ addMemberFilterByKey(
524
+ /**
525
+ * (internal) key of a dimension member
526
+ */
527
+ sKey: string
528
+ ): this;
529
+ /**
530
+ * Get effective dimension filters
531
+ *
532
+ * @returns array of member filters
533
+ */
534
+ getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
472
535
  /**
473
- * Move a dimension one position down on it's axis
536
+ * Move dimension one position down on it's axis
474
537
  *
475
- * @returns the `Dimension` to allow chaining.
538
+ * @returns Reference to this in order to allow method chaining
476
539
  */
477
- moveDown(): sap.sac.df.model.Dimension;
540
+ moveDown(): this;
478
541
  /**
479
- * Move a dimension one position up on it's axis
542
+ * Move dimension one position up on it's axis
480
543
  *
481
- * @returns the `Dimension` to allow chaining.
544
+ * @returns Reference to this in order to allow method chaining
482
545
  */
483
- moveUp(): sap.sac.df.model.Dimension;
546
+ moveUp(): this;
484
547
  /**
485
548
  * Open a dialog to display and change the settings of a dimension of the `DataProvider`
486
549
  *
@@ -488,12 +551,17 @@ declare namespace sap {
488
551
  */
489
552
  openPropertyDialog(): Promise<boolean>;
490
553
  /**
491
- * Open a dialog to display and change the filter on a dimension of the `DataProvider`
554
+ * Open a dialog to display and change the filter on a dimension
492
555
  *
493
556
  * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
494
557
  * with Ok and dynamic filters of the given dimension are updated
495
558
  */
496
- openValueHelpDialog(): Promise<any>;
559
+ openValueHelpDialog(
560
+ /**
561
+ * if the model update should be suppressed
562
+ */
563
+ bSuppressModelUpdate: boolean
564
+ ): Promise<any>;
497
565
  /**
498
566
  * Set Display Hierarchy
499
567
  *
@@ -508,15 +576,58 @@ declare namespace sap {
508
576
  /**
509
577
  * Remove a drill operation on a dimension member
510
578
  *
511
- * @returns resolving to the `Dimension` to allow chaining.
579
+ * @returns Reference to this in order to allow method chaining
512
580
  */
513
- removeDrilldown(): sap.sac.df.model.Dimension;
581
+ removeDrilldown(): this;
514
582
  /**
515
583
  * Remove the filter of a dimension
516
584
  *
517
- * @returns resolving to the `Dimension` to allow chaining.
585
+ * @returns Reference to this in order to allow method chaining
586
+ */
587
+ removeMemberFilter(): this;
588
+ /**
589
+ * Remove a member filter by its key
590
+ *
591
+ * @returns Reference to this in order to allow method chaining
592
+ */
593
+ removeMemberFilterByKey(
594
+ /**
595
+ * (internal) key of a dimension member
596
+ */
597
+ sKey: string
598
+ ): this;
599
+ /**
600
+ * Performs the search for a given value
601
+ *
602
+ * @returns array of found member filters
518
603
  */
519
- removeMemberFilter(): sap.sac.df.model.Dimension;
604
+ searchMember(
605
+ /**
606
+ * string to search for
607
+ */
608
+ sSearchString: string,
609
+ /**
610
+ * if a fuzzy search is performed
611
+ */
612
+ bFuzzy: boolean,
613
+ /**
614
+ * if to search in text/description (default true)
615
+ */
616
+ bText: boolean,
617
+ /**
618
+ * if to search in key/id (default true)
619
+ */
620
+ bKey: boolean,
621
+ /**
622
+ * maximal number of search results (default 1)
623
+ */
624
+ iMaxNumberOfResults: int,
625
+ /**
626
+ * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
627
+ * is set)
628
+ */
629
+ bRequestParents: boolean
630
+ ): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
520
631
  /**
521
632
  * Set Display Hierarchy
522
633
  *
@@ -537,20 +648,31 @@ declare namespace sap {
537
648
  sVersion: string
538
649
  ): sap.sac.df.model.Dimension;
539
650
  /**
540
- * Set the filter for a dimension
651
+ * Set dimension filters
541
652
  *
542
- * @returns resolving to the `Dimension` to allow chaining.
653
+ * @returns Reference to this in order to allow method chaining
543
654
  */
544
655
  setMemberFilter(
545
656
  /**
546
- * the filter
657
+ * array of member filters
547
658
  */
548
- oFilter: sap.sac.df.model.MemberFilter
549
- ): sap.sac.df.model.Dimension;
659
+ aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
660
+ ): this;
661
+ /**
662
+ * Set a member filter by its key
663
+ *
664
+ * @returns Reference to this in order to allow method chaining
665
+ */
666
+ setMemberFilterByKey(
667
+ /**
668
+ * (internal) key of a dimension member
669
+ */
670
+ sKey: string
671
+ ): this;
550
672
  /**
551
673
  * Sort the members of a dimension
552
674
  *
553
- * @returns resolving to the `Dimension` to allow chaining.
675
+ * @returns Promise referencing to this in order to allow method chaining
554
676
  */
555
677
  sort(
556
678
  /**
@@ -567,21 +689,21 @@ declare namespace sap {
567
689
  sMember?: string
568
690
  ): Promise<sap.sac.df.model.Dimension>;
569
691
  /**
570
- * Move the dimension to the columns axis
692
+ * Move dimension to the columns axis
571
693
  *
572
- * @returns resolving to the Dimension to allow chaining.
694
+ * @returns Reference to this in order to allow method chaining
573
695
  */
574
- toColumns(): sap.sac.df.model.Dimension;
696
+ toColumns(): this;
575
697
  /**
576
- * Move the dimension to the rows axis
698
+ * Move dimension to the rows axis
577
699
  *
578
- * @returns resolving to the Dimension to allow chaining.
700
+ * @returns Reference to this in order to allow method chaining
579
701
  */
580
- toRows(): sap.sac.df.model.Dimension;
702
+ toRows(): this;
581
703
  }
582
704
  /**
583
705
  * @since 1.119
584
- * @experimental
706
+ * @experimental (since 1.119)
585
707
  *
586
708
  * Document Object
587
709
  */
@@ -737,6 +859,7 @@ declare namespace sap {
737
859
  ): Promise<boolean>;
738
860
  }
739
861
  /**
862
+ * @since 1.119
740
863
  * @experimental (since 1.119)
741
864
  *
742
865
  * Grid Object
@@ -795,139 +918,22 @@ declare namespace sap {
795
918
  }
796
919
  /**
797
920
  * @since 1.119
798
- * @experimental
921
+ * @experimental (since 1.119)
922
+ *
923
+ * The multidimensional model allows to access and change data accessed via the InA Protocol. The multidimensional
924
+ * model populate it's exposed data in JSON format via binding to controls.
799
925
  *
800
- * Member Filter
926
+ * **Structure of Exposed Data:**
801
927
  * ```javascript
802
928
  *
803
- * "Key": [],
804
- * "InternalKey": [],
805
- * "Text": [],
806
- * "Operator": "",
807
- * "Hierarchy": { }
929
+ * "DataProviders": { },
930
+ * "VariableGroups": { },
931
+ * "Messages": [ ]
808
932
  * ```
809
933
  */
810
- class MemberFilter extends sap.ui.base.Object {
811
- constructor(
812
- /**
813
- * array of (display) keys
814
- */
815
- aKey: string[],
816
- /**
817
- * array of internal keys
818
- */
819
- aInternalKey: string[],
820
- /**
821
- * array of texts
822
- */
823
- aText: string[],
824
- /**
825
- * filter operator
826
- */
827
- sOperator?: sap.ui.model.FilterOperator,
828
- /**
829
- * hierarchy object
830
- */
831
- oHierarchyInfo?: Object
832
- );
833
-
834
- /**
835
- * Create a member filter object from firefly
836
- *
837
- * @returns a Member Filter object
838
- */
839
- static createFromFFMemberFilter(
840
- /**
841
- * array of firefly member filters
842
- */
843
- aFFMemberFilter: any[]
844
- ): sap.sac.df.model.MemberFilter[];
845
- /**
846
- * Create a member filter object from filter operation
847
- *
848
- * @returns a Member Filter object
849
- */
850
- static createFromFilterOperation(
851
- /**
852
- * the name of the Variable to search
853
- */
854
- filterOperation: object
855
- ): sap.sac.df.model.MemberFilter;
856
- /**
857
- * Creates a new subclass of class sap.sac.df.model.MemberFilter with name `sClassName` and enriches it
858
- * with the information contained in `oClassInfo`.
859
- *
860
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
861
- *
862
- * @returns Created class / constructor function
863
- */
864
- static extend<T extends Record<string, unknown>>(
865
- /**
866
- * Name of the class being created
867
- */
868
- sClassName: string,
869
- /**
870
- * Object literal with information about the class
871
- */
872
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.MemberFilter>,
873
- /**
874
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
875
- * used by this class
876
- */
877
- FNMetaImpl?: Function
878
- ): Function;
879
- /**
880
- * Returns a metadata object for class sap.sac.df.model.MemberFilter.
881
- *
882
- * @returns Metadata object describing this class
883
- */
884
- static getMetadata(): sap.ui.base.Metadata;
885
- /**
886
- * Create a member filter object from filter
887
- *
888
- * @returns a Member Filter object
889
- */
890
- static transformFromFilterToMemberFilter(
891
- /**
892
- * object
893
- */
894
- oFilter: sap.ui.model.Filter
895
- ): sap.sac.df.model.MemberFilter;
896
- /**
897
- * Create a member filter object from filter
898
- *
899
- * @returns a Member Filter object
900
- */
901
- static transformFromMemberFilterToFilter(
902
- /**
903
- * object
904
- */
905
- oFilter: sap.sac.df.model.MemberFilter,
906
- /**
907
- * path to object
908
- */
909
- sPath: string
910
- ): sap.ui.model.Filter;
911
- /**
912
- * Return a member filter object as {@link sap.ui.model.Filter}
913
- *
914
- * @returns filter object
915
- */
916
- transformToFilter(): sap.ui.model.Filter;
917
- }
918
- /**
919
- * @experimental
920
- *
921
- * Model implementation for InA provider
922
- *
923
- * The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
924
- * data, mainly via the objects `DataProviders`, `VariableGroups` and `Messages`.
925
- */
926
- class MultiDimModel extends sap.ui.model.Model {
934
+ class MultiDimModel extends sap.ui.model.json.JSONModel {
927
935
  /**
928
- * Constructor for a new MultiDimModel.
929
- *
930
- * The Olap Model allows to access and change data from servers providing the InA Protocol.
936
+ * Constructor for a new MultiDimModel. After model creation you need to wait for the event {@link #event:loaded loaded}.
931
937
  */
932
938
  constructor(
933
939
  /**
@@ -935,25 +941,30 @@ declare namespace sap {
935
941
  */
936
942
  sId?: string,
937
943
  /**
938
- * Initial settings for the new control
944
+ * Initial settings for the new control.
939
945
  */
940
946
  mSettings?: object
941
947
  );
942
948
  /**
943
949
  * Data Providers
944
950
  */
945
- DataProviders: sap.sac.df.model.DataProvider;
951
+ DataProviders: Record<string, sap.sac.df.model.DataProvider>;
952
+
953
+ /**
954
+ * Messages
955
+ */
956
+ Messages: sap.ui.core.message.Message[];
946
957
 
947
958
  /**
948
959
  * Variable Groups
949
960
  */
950
- VariableGroups: sap.sac.df.model.VariableGroup;
961
+ VariableGroups: Record<string, sap.sac.df.model.VariableGroup>;
951
962
 
952
963
  /**
953
964
  * Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
954
965
  * with the information contained in `oClassInfo`.
955
966
  *
956
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
967
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
957
968
  *
958
969
  * @returns Created class / constructor function
959
970
  */
@@ -979,141 +990,145 @@ declare namespace sap {
979
990
  */
980
991
  static getMetadata(): sap.ui.base.Metadata;
981
992
  /**
982
- * Adds a new query as a new data provider
993
+ * Creates a new data provider and attaches it to the model.
983
994
  *
984
- * @returns Promise which resolves the Data Provider that was created
995
+ * @returns Promise which resolves the created data provider
985
996
  */
986
997
  addDataProvider(
987
998
  /**
988
- * the name of the new data provider
999
+ * Data provider name
989
1000
  */
990
1001
  sDataProviderName: string,
991
1002
  /**
992
- * the name of the query which the data provider is supposed to expose
1003
+ * Datasource name which the data provider is supposed to expose
993
1004
  */
994
- sQueryName: string,
1005
+ sDataSourceName: string,
995
1006
  /**
996
- * the name of the system in the landscape
1007
+ * System name
997
1008
  */
998
1009
  sSystem?: string,
999
1010
  /**
1000
- * the name of the package
1011
+ * Package name
1001
1012
  */
1002
1013
  sPackage?: string,
1003
1014
  /**
1004
- * the name of the schema
1015
+ * Schema name
1005
1016
  */
1006
1017
  sSchema?: string,
1007
1018
  /**
1008
- * the name of the type of the datasource
1019
+ * Data source type
1009
1020
  */
1010
- sType?: string
1021
+ sDataSourceType?: sap.sac.df.types.DataSourceType
1011
1022
  ): Promise<sap.sac.df.model.DataProvider>;
1012
1023
  /**
1013
- * Adds a variable group to the model
1024
+ * Creates a new variable group and attaches it to the model.
1014
1025
  *
1015
- * A Variable group defines what variables of teh underlying DataProvider behave in as one variable The
1016
- * group is defined by a name and a Rule. Rule is a function which accept the variable definition and decides
1017
- * if the variable has to be part of te group The first added variable becomes automatically the MergedVariable.
1026
+ * A variable group defines which variables of the underlying data providers should behave as the same variable.
1027
+ * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
1018
1028
  *
1019
- * The VariableGroup can be accessed/bound via the properties of MultiDimModel a
1020
- *
1021
- * @returns Promise which resolves the Variable Group that was created
1029
+ * @returns Promise which resolves the created variable group
1022
1030
  */
1023
1031
  addVariableGroup(
1024
1032
  /**
1025
- * the name of the variable
1033
+ * Variable group name
1026
1034
  */
1027
1035
  sVariableGroupName: string,
1028
1036
  /**
1029
- * function returning a boolean
1037
+ * Rule is a function which accept the variable definition and decides if the variable has to be part of
1038
+ * te group.
1030
1039
  */
1031
1040
  fnRule: Function,
1032
1041
  /**
1033
- * additional properties
1042
+ * Additional properties
1034
1043
  */
1035
1044
  oProperties: Object
1036
1045
  ): Promise<sap.sac.df.model.VariableGroup>;
1037
1046
  /**
1038
- * Resets the messages
1039
- *
1040
- * @returns for chaining
1041
- */
1042
- clearMessages(
1043
- /**
1044
- * if also property bindings have to be updated
1045
- */
1046
- bUpdateBindings: undefined
1047
- ): sap.sac.df.model.MultiDimModel;
1048
- /**
1049
- * Updates the MultiDimModel from the given the model state including all aggregated `DataProvider`s
1047
+ * Updates the model from the given the model state including all aggregated data providers
1050
1048
  *
1051
- * @returns Promise Promise which resolves to the updated instance of the OlapModel.
1049
+ * @returns Promise with reference to this in order to allow method chaining
1052
1050
  */
1053
1051
  deserialize(
1054
1052
  /**
1055
- * the JSON object containing the persisted state of th MultiDimModel to be applied.
1053
+ * A JSON object which represents the multidimensional model to be applied
1056
1054
  */
1057
1055
  oModelState: object,
1058
1056
  /**
1059
- * the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
1057
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
1060
1058
  */
1061
- sFormat: string
1062
- ): undefined;
1059
+ sFormat?: string
1060
+ ): Promise<this>;
1063
1061
  /**
1064
1062
  * Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
1065
1063
  *
1066
- * @returns the MultiDimModel
1064
+ * @returns Reference to this in order to allow method chaining
1067
1065
  */
1068
1066
  fireDataProviderAdded(
1069
1067
  /**
1070
1068
  * Parameters to pass along with the event
1071
1069
  */
1072
1070
  oParameters?: object
1073
- ): sap.sac.df.model.MultiDimModel;
1071
+ ): this;
1072
+ /**
1073
+ * Fires event {@link #event:dataProviderRemoved dataProviderRemoved} to attached listeners.
1074
+ *
1075
+ * @returns Reference to this in order to allow method chaining
1076
+ */
1077
+ fireDataProviderRemoved(
1078
+ /**
1079
+ * Parameters to pass along with the event
1080
+ */
1081
+ oParameters?: object
1082
+ ): this;
1074
1083
  /**
1075
1084
  * Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
1076
1085
  *
1077
- * @returns the MultiDimModel
1086
+ * @returns Reference to this in order to allow method chaining
1078
1087
  */
1079
1088
  fireDataProviderUpdated(
1080
1089
  /**
1081
1090
  * Parameters to pass along with the event
1082
1091
  */
1083
1092
  oParameters?: object
1084
- ): sap.sac.df.model.MultiDimModel;
1093
+ ): this;
1085
1094
  /**
1086
- * Get a Data Provider
1095
+ * Get a data provider
1087
1096
  *
1088
- * @returns DataProvider
1097
+ * @returns Data provider instance if found
1089
1098
  */
1090
1099
  getDataProvider(
1091
1100
  /**
1092
- * the name of the new DataProvider
1101
+ * Data provider name
1093
1102
  */
1094
1103
  sDataProviderName: string
1095
1104
  ): sap.sac.df.model.DataProvider;
1096
1105
  /**
1097
1106
  * Get all data providers
1098
1107
  *
1099
- * @returns object of all Data Providers
1108
+ * @returns Object of all data providers
1100
1109
  */
1101
1110
  getDataProviders(): Record<string, sap.sac.df.model.DataProvider>;
1111
+ /**
1112
+ * Get all messages
1113
+ *
1114
+ * @returns Array of messages
1115
+ */
1116
+ getMessages(): sap.ui.core.message.Message[];
1102
1117
  /**
1103
1118
  * Get a variable group
1104
1119
  *
1105
- * @returns variable group object
1120
+ * @returns Variable group object
1106
1121
  */
1107
1122
  getVariableGroup(
1108
1123
  /**
1109
- * the name of the variable
1124
+ * Variable group name
1110
1125
  */
1111
1126
  sVariableGroupName: string
1112
1127
  ): sap.sac.df.model.VariableGroup;
1113
1128
  /**
1114
1129
  * Get all variable groups
1115
1130
  *
1116
- * @returns variable group object
1131
+ * @returns Object of all variable groups
1117
1132
  */
1118
1133
  getVariableGroups(): Record<string, sap.sac.df.model.VariableGroup>;
1119
1134
  /**
@@ -1123,116 +1138,57 @@ declare namespace sap {
1123
1138
  */
1124
1139
  logoff(): Promise<void>;
1125
1140
  /**
1126
- * Remove existing data provider from model.
1141
+ * Remove existing data provider from the model.
1127
1142
  *
1128
- * @returns Promise which resolves when the removing has been finished
1143
+ * @returns Promise which resolves when the removing s finished
1129
1144
  */
1130
1145
  removeDataProvider(
1131
1146
  /**
1132
- * the name of the DataProvider to be removed
1147
+ * Data provider name to be removed
1133
1148
  */
1134
1149
  sDataProviderName: string
1135
1150
  ): Promise<void>;
1136
1151
  /**
1137
1152
  * Remove a variable group from the model
1138
1153
  *
1139
- * @returns Promise which resolves when the removing has been finished
1154
+ * @returns Promise which resolves when the removing s finished
1140
1155
  */
1141
1156
  removeVariableGroup(
1142
1157
  /**
1143
- * the name of the variable
1158
+ * Variable group name
1144
1159
  */
1145
1160
  sVariableGroupName: string
1146
1161
  ): Promise<void>;
1147
1162
  /**
1148
- * Reset the Olap Model to the default query
1163
+ * Reset the model to the initial state
1164
+ *
1165
+ * @returns Promise which resolves when reset is finished.
1149
1166
  */
1150
- resetModel(): void;
1167
+ resetModel(): Promise<void>;
1151
1168
  /**
1152
- * Serialize the Model with all aggregated `DataProvider` to a JSON representation
1169
+ * Serialize the model with all aggregated data providers to a JSON representation
1153
1170
  *
1154
- * @returns a javascript object which represents the `MultiDimModel`.
1171
+ * @returns A JSON object which represents the multidimensional model
1155
1172
  */
1156
1173
  serialize(
1157
1174
  /**
1158
- * the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `MultiDimModel` to be serialized
1159
- * from an equivalent such Object.
1175
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
1160
1176
  */
1161
- sFormat: string
1177
+ sFormat?: string
1162
1178
  ): object;
1163
1179
  /**
1164
- * Synchronizes all aggregated DataProviders by fetching their ResultSet.
1165
- *
1166
- * If the user does not choose an Analytic Query, then the promise is rejected
1167
- *
1168
- * @returns the MultiDimModel, to allow chaining
1169
- */
1170
- synchronize(
1171
- /**
1172
- * List of data provider that are to be synchronized (all if not supplied)
1173
- */
1174
- aDataProviderNames: string[]
1175
- ): Promise<sap.sac.df.model.MultiDimModel>;
1176
- }
1177
- /**
1178
- * @since 1.119
1179
- * @experimental
1180
- *
1181
- * Query Info providing the following information
1182
- * ```javascript
1183
- *
1184
- * "QueryTitle": "",
1185
- * "QueryName": "",
1186
- * "QueryType": "",
1187
- * "SystemName": "",
1188
- * "CreatedBy": "",
1189
- * "CreatedOn": "",
1190
- * "QueryDueDateText": "",
1191
- * "CreatedOnText": "",
1192
- * "QueryDueDate": "",
1193
- * "ResultAlignmentRows": "",
1194
- * "ResultAlignmentColumns": "",
1195
- * "LastUpdated": "",
1196
- * "LastUpdatedBy": "",
1197
- * "LastUpdatedText": ""
1198
- * ```
1199
- */
1200
- class QueryInfo extends sap.ui.base.Object {
1201
- constructor();
1202
-
1203
- /**
1204
- * Creates a new subclass of class sap.sac.df.model.QueryInfo with name `sClassName` and enriches it with
1205
- * the information contained in `oClassInfo`.
1206
- *
1207
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1208
- *
1209
- * @returns Created class / constructor function
1180
+ * Resets the messages
1210
1181
  */
1211
- static extend<T extends Record<string, unknown>>(
1182
+ setMessages(
1212
1183
  /**
1213
- * Name of the class being created
1214
- */
1215
- sClassName: string,
1216
- /**
1217
- * Object literal with information about the class
1218
- */
1219
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.QueryInfo>,
1220
- /**
1221
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1222
- * used by this class
1184
+ * The new messages for the model, mapping a binding path to an array of sap.ui.core.message.Message objects
1223
1185
  */
1224
- FNMetaImpl?: Function
1225
- ): Function;
1226
- /**
1227
- * Returns a metadata object for class sap.sac.df.model.QueryInfo.
1228
- *
1229
- * @returns Metadata object describing this class
1230
- */
1231
- static getMetadata(): sap.ui.base.Metadata;
1186
+ mMessages: Record<string, sap.ui.core.message.Message[]>
1187
+ ): void;
1232
1188
  }
1233
1189
  /**
1234
1190
  * @since 1.119
1235
- * @experimental
1191
+ * @experimental (since 1.119)
1236
1192
  *
1237
1193
  * Variable
1238
1194
  * ```javascript
@@ -1285,617 +1241,175 @@ declare namespace sap {
1285
1241
  */
1286
1242
  static getMetadata(): sap.ui.base.Metadata;
1287
1243
  /**
1288
- * Open a dialog to display and change the filter on a dimension of the `DataProvider`
1289
- *
1290
- * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
1291
- * with Ok and dynamic filters of the given dimension are updated
1292
- */
1293
- openValueHelpDialog(
1294
- /**
1295
- * if the model update should be suppressed
1296
- */
1297
- bSuppressModelUpdate: boolean
1298
- ): Promise<any>;
1299
- /**
1300
- * Performs the search in values of a given Variable
1301
- *
1302
- * @returns array members found values
1303
- */
1304
- searchMember(
1305
- /**
1306
- * string to search for
1307
- */
1308
- sSearchString: string,
1309
- /**
1310
- * if a fuzzy search is performed
1311
- */
1312
- bFuzzy: boolean,
1313
- /**
1314
- * if to search in text/description (default true)
1315
- */
1316
- bText: boolean,
1317
- /**
1318
- * if to search in key/id (default true)
1319
- */
1320
- bKey: boolean,
1321
- /**
1322
- * maximal number of search results (default 1)
1323
- */
1324
- iMaxNumberOfResults: int,
1325
- /**
1326
- * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
1327
- * is set)
1328
- */
1329
- bRequestParents: boolean
1330
- ): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
1331
- /**
1332
- * Set value of the variable
1333
- */
1334
- setMemberFilter(oFilter: sap.ui.model.Filter): void;
1335
- }
1336
- /**
1337
- * @since 1.119
1338
- * @experimental
1339
- *
1340
- * Variable Group
1341
- * ```javascript
1342
- *
1343
- * "Name": "string",
1344
- * "MergedVariable": { }
1345
- * ```
1346
- */
1347
- class VariableGroup extends sap.ui.base.Object {
1348
- constructor();
1349
- /**
1350
- * Merged Variable
1351
- */
1352
- MergedVariable: sap.sac.df.model.Variable;
1353
-
1354
- /**
1355
- * Name
1356
- */
1357
- Name: string;
1358
-
1359
- /**
1360
- * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
1361
- * with the information contained in `oClassInfo`.
1362
- *
1363
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1364
- *
1365
- * @returns Created class / constructor function
1366
- */
1367
- static extend<T extends Record<string, unknown>>(
1368
- /**
1369
- * Name of the class being created
1370
- */
1371
- sClassName: string,
1372
- /**
1373
- * Object literal with information about the class
1374
- */
1375
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.VariableGroup>,
1376
- /**
1377
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1378
- * used by this class
1379
- */
1380
- FNMetaImpl?: Function
1381
- ): Function;
1382
- /**
1383
- * Returns a metadata object for class sap.sac.df.model.VariableGroup.
1384
- *
1385
- * @returns Metadata object describing this class
1386
- */
1387
- static getMetadata(): sap.ui.base.Metadata;
1388
- /**
1389
- * Opens the value help dialog so the user choose a value for a VariableGroup After the value is selected
1390
- * only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
1391
- * with the next ResultSet fetch
1392
- *
1393
- * @returns to indicate if the VariableGroup has been updated
1394
- */
1395
- openValueHelpDialog(): Promise<boolean>;
1396
- /**
1397
- * Performs the search in values of a given Variable
1398
- *
1399
- * @returns array with found values
1400
- */
1401
- searchMember(
1402
- /**
1403
- * string to search for
1404
- */
1405
- sSearchString: string,
1406
- /**
1407
- * if a fuzzy search is performed
1408
- */
1409
- bFuzzy: boolean,
1410
- /**
1411
- * if to search in text/description (default true)
1412
- */
1413
- bText: boolean,
1414
- /**
1415
- * if to search in key/id (default true)
1416
- */
1417
- bKey: boolean,
1418
- /**
1419
- * maximal number of search results (default 1)
1420
- */
1421
- iMaxNumberOfResults: int,
1422
- /**
1423
- * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
1424
- * is set)
1425
- */
1426
- bRequestParents: boolean
1427
- ): Promise<sap.sac.df.model.MemberFilter[]>;
1428
- /**
1429
- * Sets new value
1430
- *
1431
- * @returns Promise which resolve when the value is set
1432
- */
1433
- setMemberFilter(
1434
- /**
1435
- * filter object
1436
- */
1437
- oFilter: sap.ui.model.Filter
1438
- ): undefined;
1439
- }
1440
-
1441
- type MultiDimModel$DataProviderAddedEvent = sap.ui.base.Event<
1442
- MultiDimModel$DataProviderAddedEventParameters,
1443
- MultiDimModel
1444
- >;
1445
-
1446
- type MultiDimModel$DataProviderUpdatedEvent = sap.ui.base.Event<
1447
- MultiDimModel$DataProviderUpdatedEventParameters,
1448
- MultiDimModel
1449
- >;
1450
- }
1451
-
1452
- namespace olap {
1453
- /**
1454
- * @deprecated (since 1.119) - Please use @link{sap.sac.df.model.DataProvider}.
1455
- * @experimental
1456
- *
1457
- * A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
1458
- * HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
1459
- *
1460
- * Instances of this class should only be created by the {sap.sac.df.olap.MultiDimModel}. The `MultiDimModel`
1461
- * populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
1462
- * is as follows:
1463
- *
1464
- * **Structure of Exposed Data**
1465
- *
1466
- *
1467
- * - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
1468
- * - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
1469
- * `Name`: the external name of the dimension `Description`: the language dependant description of
1470
- * the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
1471
- *
1472
- * - RowsDimensions: The list of all Dimensions lying on the Rows Axis
1473
- * Name: the external name of the dimension Description: the language dependant description of the
1474
- * dimension IsStructure: boolean flag indicating whether the dimension is a structure *
1475
- * - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
1476
- * Name: the external name of the dimension Description: the language dependant description of the
1477
- * dimension IsStructure: boolean flag indicating whether the dimension is a structure
1478
- * - Conditions: list of conditions (result set filters)
1479
- * - Exceptions: list of exceptions (conditional formats)
1480
- * - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
1481
- */
1482
- class MultiDimDataProvider {
1483
- /**
1484
- * Constructor for a new MultiDimDataProvider.
1485
- *
1486
- * A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
1487
- * servers providing the InA
1488
- * Protocol.
1489
- */
1490
- constructor(
1491
- /**
1492
- * the model to which the MultiDimDataProvider belongs
1493
- */
1494
- oMultiDimModel: sap.sac.df.olap.MultiDimModel,
1495
- /**
1496
- * name of the MultiDimDataProvider
1497
- */
1498
- sMultiDimDataProviderName: string,
1499
- /**
1500
- * the firefly application associated to the `MultiDimModel`
1501
- */
1502
- oApplication: object,
1503
- /**
1504
- * the firefly queryManager that is wrapped by the `MultiDimDataProvider`
1505
- */
1506
- oQueryManager: object
1507
- );
1508
-
1509
- /**
1510
- * add a new condition (aka resultset filter).
1511
- *
1512
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1513
- */
1514
- addCondition(
1515
- /**
1516
- * Condition Definiton
1517
- */
1518
- oData: object,
1519
- /**
1520
- * Target state of the condition
1521
- */
1522
- bActive: boolean
1523
- ): Promise<this>;
1524
- /**
1525
- * Do a drill operation on a dimension member on an Axis
1244
+ * Add variable filters
1526
1245
  *
1527
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1246
+ * @returns Reference to this in order to allow method chaining
1528
1247
  */
1529
- drill(
1248
+ addMemberFilter(
1530
1249
  /**
1531
- * the external name of the Dimension
1250
+ * a member filter object
1532
1251
  */
1533
- sDim: string,
1252
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any,
1534
1253
  /**
1535
- * the Tuple Index of the member in the resultset.
1254
+ * If true, the result set is invalidated and must be refreshed
1536
1255
  */
1537
- nIndex: int
1256
+ bInvalidateDataProvider: boolean
1538
1257
  ): this;
1539
1258
  /**
1540
- * Gets the scaling factor of a measure or data cell
1259
+ * Add a member filter by its key
1541
1260
  *
1542
- * @returns the current decimal places setting
1261
+ * @returns Reference to this in order to allow method chaining
1543
1262
  */
1544
- getDecimalPlaces(
1263
+ addMemberFilterByKey(
1545
1264
  /**
1546
- * the Member of the Measure Structure
1265
+ * (internal) key of a dimension member
1547
1266
  */
1548
- sMeasureMember: string,
1267
+ sKey: string,
1549
1268
  /**
1550
- * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
1551
- */
1552
- sNonMeasureMember: string
1553
- ): int;
1554
- /**
1555
- * get the list of filters of a dimension
1556
- *
1557
- * @returns list of a range with components
1558
- * `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
1559
- * EQ,LE,..,BT
1560
- */
1561
- getFilterOfDim(
1562
- /**
1563
- * the name of the dimension from which the filter is retrieved
1564
- */
1565
- sDim: string
1566
- ): object[];
1567
- /**
1568
- * get the current resultset from the InA Server
1569
- *
1570
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1571
- */
1572
- getResultSet(): Promise<this>;
1573
- /**
1574
- * get the list of the jump targets associated to a datacell defined via the report report interface.
1575
- *
1576
- * @returns resolving to the List of jump targets.
1577
- */
1578
- getRRITargets(
1579
- /**
1580
- * Row of the data cell
1269
+ * If true, the result set is invalidated and must be refreshed
1581
1270
  */
1582
- nRow: int,
1583
- /**
1584
- * Column of the data cell
1585
- */
1586
- nColumn: int
1587
- ): Promise<this>;
1588
- /**
1589
- * Gets the scaling factor of a measure
1590
- *
1591
- * @returns the exponent of the scaling factor in Base 10
1592
- */
1593
- getScalingFactor(
1594
- /**
1595
- * the Member of the Measure Structure
1596
- */
1597
- sMeasureMember: string,
1598
- /**
1599
- * the Member of the Non Measure Structure
1600
- */
1601
- sNonMeasureMember: string
1602
- ): int;
1603
- /**
1604
- * hasVariable Checks whether a Variable is influencing the MultiDimDataProvider
1605
- *
1606
- * @returns Whether the vairable influences the MultiDimDataProvider
1607
- */
1608
- hasVariable(
1609
- /**
1610
- * Name of the Variable
1611
- */
1612
- the: string
1613
- ): boolean;
1614
- /**
1615
- * move a dimension one position down on it's axis
1616
- *
1617
- * @returns the `MultiDimDataProvider` to allow chaining.
1618
- */
1619
- moveDown(
1620
- /**
1621
- * name of the dimension
1622
- */
1623
- sName: string,
1624
- /**
1625
- * Target state of the condition
1626
- */
1627
- bActive: boolean
1628
- ): this;
1629
- /**
1630
- * move a dimension one position up on it's axis
1631
- *
1632
- * @returns the `MultiDimDataProvider` to allow chaining.
1633
- */
1634
- moveUp(
1635
- /**
1636
- * name of the dimension
1637
- */
1638
- sName: string,
1639
- /**
1640
- * Target state of the condition
1641
- */
1642
- bActive: boolean
1271
+ bInvalidateDataProvider: boolean
1643
1272
  ): this;
1644
1273
  /**
1645
- * Open a dialog that allows to display and change the property of an `Axis` of the `MultiDimDataProvider`.
1646
- *
1647
- * @returns indicator whether the dialog was confirmed or canceled
1648
- */
1649
- openAxisDialog(
1650
- /**
1651
- * the external name of the Dimension
1652
- */
1653
- sDim: string
1654
- ): Promise<boolean>;
1655
- /**
1656
- * Open a dialog that allows to display and change the property of a `Query Cell` of the `MultiDimDataProvider`.
1657
- *
1658
- * @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
1659
- * Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
1660
- */
1661
- openCellDialog(
1662
- /**
1663
- * the external name of the first structure
1664
- */
1665
- sDim1?: string,
1666
- /**
1667
- * the external name of the member of the first structure
1668
- */
1669
- sMem1?: string,
1670
- /**
1671
- * the external name of the second structure
1672
- */
1673
- sDim2?: string,
1674
- /**
1675
- * the external name of the member of the second structure
1676
- */
1677
- sMem2?: string
1678
- ): Promise<this>;
1679
- /**
1680
- * Open a dialog that allows to display and change the currency translation settings of the `MultiDimDataProvider`.
1274
+ * Get effective variable filters
1681
1275
  *
1682
- * @returns indicator whether the dialog was confirmed or canceled in the dialog, the new resultset was
1683
- * retrieved before the promise gets resolved.
1276
+ * @returns array of member filters
1684
1277
  */
1685
- openCurrencyTranslationDialog(): Promise<boolean>;
1278
+ getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
1686
1279
  /**
1687
- * Open a dialog to display and change the settings of a dimension of the `MultiDimDataProvider`
1688
- *
1689
- * @returns indicator whether the dialog was confirmed or canceled
1690
- */
1691
- openDimDialog(
1692
- /**
1693
- * the external name of the Dimension
1694
- */
1695
- sDim: string
1696
- ): Promise<boolean>;
1697
- /**
1698
- * Open a dialog to display and change the filter on a dimension of the `MultiDimDataProvider`
1280
+ * Open a dialog to display and change the filter on a variable
1699
1281
  *
1700
1282
  * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
1701
1283
  * with Ok and dynamic filters of the given dimension are updated
1702
1284
  */
1703
- openSelector(
1285
+ openValueHelpDialog(
1704
1286
  /**
1705
- * the external name of the Dimension
1287
+ * If true, the result set is invalidated and must be refreshed
1706
1288
  */
1707
- sDimensionName: string
1289
+ bInvalidateDataProvider: boolean
1708
1290
  ): Promise<any>;
1709
1291
  /**
1710
- * Remove the filter of a dimension
1292
+ * Remove variable filter
1711
1293
  *
1712
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1294
+ * @returns Reference to this in order to allow method chaining
1713
1295
  */
1714
- removeFilter(
1296
+ removeMemberFilter(
1715
1297
  /**
1716
- * the external name
1298
+ * a member filter object
1717
1299
  */
1718
- sDim: string
1719
- ): this;
1720
- /**
1721
- * Distribute the dimension among the rows and columns
1722
- *
1723
- * @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
1724
- * Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
1725
- */
1726
- setAxesLayout(
1300
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any,
1727
1301
  /**
1728
- * an Object containing a `rows` member referencing a string array containing the names of the dimensions
1729
- * and a `columns` member referencing a string array containing the dimension on the columns. The order
1730
- * in the array control the positon on the axis.
1302
+ * If true, the result set is invalidated and must be refreshed
1731
1303
  */
1732
- mLayout: object
1304
+ bInvalidateDataProvider: boolean
1733
1305
  ): this;
1734
1306
  /**
1735
- * Sets the number of decimal of a measure/query cell
1307
+ * Remove a member filter by its key
1736
1308
  *
1737
- * @returns the MultiDimDataProvider
1309
+ * @returns Reference to this in order to allow method chaining
1738
1310
  */
1739
- setDecimalPlaces(
1740
- /**
1741
- * number of the decimal palaces to be shown after the separator
1742
- */
1743
- nNumberOfDecimalPlaces: int,
1311
+ removeMemberFilterByKey(
1744
1312
  /**
1745
- * the Member of the Measure Structure
1313
+ * (internal) key of a dimension member
1746
1314
  */
1747
- sMeasureMember: string,
1315
+ sKey: string,
1748
1316
  /**
1749
- * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
1317
+ * If true, the result set is invalidated and must be refreshed
1750
1318
  */
1751
- the: string
1319
+ bInvalidateDataProvider: boolean
1752
1320
  ): this;
1753
1321
  /**
1754
- * Set Display Hierachy
1322
+ * Performs the search for a given value
1755
1323
  *
1756
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1324
+ * @returns array of found member filters
1757
1325
  */
1758
- setDisplayHierarchy(
1326
+ searchMember(
1759
1327
  /**
1760
- * the external name of the structure on which the new restriction is created
1328
+ * string to search for
1761
1329
  */
1762
- sDim: string,
1330
+ sSearchString: string,
1763
1331
  /**
1764
- * whether the hierarchy should be activated
1332
+ * if a fuzzy search is performed
1765
1333
  */
1766
- bActive: boolean,
1334
+ bFuzzy: boolean,
1767
1335
  /**
1768
- * the name of the hierarchy (optional)
1336
+ * if to search in text/description (default true)
1769
1337
  */
1770
- sHierachy: string,
1338
+ bText: boolean,
1771
1339
  /**
1772
- * the version of the hierarchy (optional)
1340
+ * if to search in key/id (default true)
1773
1341
  */
1774
- sVersion: string
1775
- ): this;
1776
- /**
1777
- * Set the filter for a dimension
1778
- *
1779
- * @returns {{this} resolving to the `MultiDimDataProvider` to allow chaining.
1780
- */
1781
- setFilter(
1342
+ bKey: boolean,
1782
1343
  /**
1783
- * the external name
1344
+ * maximal number of search results (default 1)
1784
1345
  */
1785
- sDim: string,
1346
+ iMaxNumberOfResults: int,
1786
1347
  /**
1787
- * the filter
1348
+ * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
1349
+ * is set)
1788
1350
  */
1789
- oFilter: object
1790
- ): undefined;
1351
+ bRequestParents: boolean
1352
+ ): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
1791
1353
  /**
1792
- * Sets the scaling factor of a measure/query cell
1354
+ * Set variable filters
1793
1355
  *
1794
- * @returns the MultiDimDataProvider
1356
+ * @returns Reference to this in order to allow method chaining
1795
1357
  */
1796
- setScalingFactor(
1797
- /**
1798
- * the exponential of the scaling factor
1799
- */
1800
- nFactor: int,
1358
+ setMemberFilter(
1801
1359
  /**
1802
- * the Member of the Measure Structure
1360
+ * array of member filters
1803
1361
  */
1804
- sMeasureMember: string,
1362
+ aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[],
1805
1363
  /**
1806
- * the Member of the Non Measure Structure
1364
+ * If true, the result set is invalidated and must be refreshed
1807
1365
  */
1808
- sNonMeasureMember: string
1366
+ bInvalidateDataProvider: boolean
1809
1367
  ): this;
1810
1368
  /**
1811
- * Sort the members of a dimension
1369
+ * Set a member filter by its key
1812
1370
  *
1813
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1371
+ * @returns Reference to this in order to allow method chaining
1814
1372
  */
1815
- sort(
1373
+ setMemberFilterByKey(
1816
1374
  /**
1817
- * the external name of the Dimension
1375
+ * (internal) key of a dimension member
1818
1376
  */
1819
- sDim: string,
1377
+ sKey: string,
1820
1378
  /**
1821
- * of sorting
1379
+ * If true, the result set is invalidated and must be refreshed
1822
1380
  */
1823
- type: /* was: sap.sac.df.types.SortType */ any,
1824
- /**
1825
- * of sorting
1826
- */
1827
- direction: /* was: sap.sac.df.types.SortDirection */ any,
1828
- /**
1829
- * in case of a structure the measure according to which is sorted
1830
- */
1831
- sMember?: string
1832
- ): Promise<this>;
1833
- /**
1834
- * submit the value of the input enabled queries to the InA Server
1835
- *
1836
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1837
- */
1838
- submitVariables(): Promise<this>;
1839
- /**
1840
- * retrieve the data of the current naviation state `MultiDimDataProvider` from the InA Server.
1841
- *
1842
- * @returns to allow chaining.
1843
- */
1844
- synchronize(): Promise<this>;
1845
- /**
1846
- * Move a dimension to the columns axis
1847
- *
1848
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1849
- */
1850
- toColumns(
1851
- /**
1852
- * the external name of the Dimension
1853
- */
1854
- sDim: string
1855
- ): this;
1856
- /**
1857
- * Move a dimension to the rows axis
1858
- *
1859
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
1860
- */
1861
- toRows(
1862
- /**
1863
- * the external name of the Dimension
1864
- */
1865
- sDim: string
1381
+ bInvalidateDataProvider: boolean
1866
1382
  ): this;
1867
1383
  }
1868
1384
  /**
1869
- * @deprecated (since 1.119) - Please use @link{sap.sac.df.model.MultiDimModel}.
1870
- * @experimental
1871
- *
1872
- * Model implementation for InA provider
1873
- *
1874
- * The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
1875
- * data is as follows: **Structure of Exposed Data**
1385
+ * @since 1.119
1386
+ * @experimental (since 1.119)
1876
1387
  *
1388
+ * Variable Group
1389
+ * ```javascript
1877
1390
  *
1878
- * - DataProvider: The associative array of all `DataProvider` aggregated by the VariableGroups:
1879
- * The associative array of registered Variable Groups Messages: The list of all messages posted by
1880
- * the Analytical Engine
1391
+ * "Name": "",
1392
+ * "MergedVariable": { },
1393
+ * "Rule: function () {}
1394
+ * ```
1881
1395
  */
1882
- class MultiDimModel extends sap.ui.model.Model {
1396
+ class VariableGroup extends sap.ui.base.Object {
1397
+ constructor();
1398
+ /**
1399
+ * Merged Variable
1400
+ */
1401
+ MergedVariable: sap.sac.df.model.Variable;
1402
+
1883
1403
  /**
1884
- * Constructor for a new OlapMode.
1885
- *
1886
- * The Olap Model allows to access and change data from servers providing the InA Protocol.
1887
- *
1888
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1889
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1890
- * of the syntax of the settings object.
1404
+ * Name
1891
1405
  */
1892
- constructor();
1406
+ Name: string;
1893
1407
 
1894
1408
  /**
1895
- * Creates a new subclass of class sap.sac.df.olap.MultiDimModel with name `sClassName` and enriches it
1409
+ * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
1896
1410
  * with the information contained in `oClassInfo`.
1897
1411
  *
1898
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
1412
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1899
1413
  *
1900
1414
  * @returns Created class / constructor function
1901
1415
  */
@@ -1907,7 +1421,7 @@ declare namespace sap {
1907
1421
  /**
1908
1422
  * Object literal with information about the class
1909
1423
  */
1910
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.MultiDimModel>,
1424
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.VariableGroup>,
1911
1425
  /**
1912
1426
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1913
1427
  * used by this class
@@ -1915,34 +1429,60 @@ declare namespace sap {
1915
1429
  FNMetaImpl?: Function
1916
1430
  ): Function;
1917
1431
  /**
1918
- * Returns a metadata object for class sap.sac.df.olap.MultiDimModel.
1432
+ * Returns a metadata object for class sap.sac.df.model.VariableGroup.
1919
1433
  *
1920
1434
  * @returns Metadata object describing this class
1921
1435
  */
1922
1436
  static getMetadata(): sap.ui.base.Metadata;
1437
+ }
1438
+
1439
+ type MultiDimModel$DataProviderAddedEvent = sap.ui.base.Event<
1440
+ MultiDimModel$DataProviderAddedEventParameters,
1441
+ MultiDimModel
1442
+ >;
1443
+
1444
+ type MultiDimModel$DataProviderRemovedEvent = sap.ui.base.Event<
1445
+ MultiDimModel$DataProviderRemovedEventParameters,
1446
+ MultiDimModel
1447
+ >;
1448
+
1449
+ type MultiDimModel$DataProviderUpdatedEvent = sap.ui.base.Event<
1450
+ MultiDimModel$DataProviderUpdatedEventParameters,
1451
+ MultiDimModel
1452
+ >;
1453
+
1454
+ type MultiDimModel$LoadedEvent = sap.ui.base.Event<
1455
+ MultiDimModel$LoadedEventParameters,
1456
+ MultiDimModel
1457
+ >;
1458
+ }
1459
+
1460
+ namespace types {
1461
+ /**
1462
+ * Type of a data source
1463
+ */
1464
+ enum DataSourceType {
1923
1465
  /**
1924
- * Gets current value of property {@link #getApi api}.
1925
- *
1926
- * @returns Value of property `api`
1466
+ * CDS Projection View
1927
1467
  */
1928
- getApi(): undefined;
1468
+ CDSProjectionView = "CDSProjectionView",
1929
1469
  /**
1930
- * Sets a new value for property {@link #getApi api}.
1931
- *
1932
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1933
- *
1934
- * @returns Reference to `this` in order to allow method chaining
1470
+ * Cube
1935
1471
  */
1936
- setApi(
1937
- /**
1938
- * New value for property `api`
1939
- */
1940
- sApi: undefined
1941
- ): this;
1472
+ Cube = "Cube",
1473
+ /**
1474
+ * Ina Model
1475
+ */
1476
+ InAModel = "InAModel",
1477
+ /**
1478
+ * Query
1479
+ */
1480
+ Query = "Query",
1481
+ /**
1482
+ * View
1483
+ */
1484
+ View = "View",
1942
1485
  }
1943
- }
1944
-
1945
- namespace types {
1946
1486
  /**
1947
1487
  * System Type of an InA System
1948
1488
  */
@@ -1966,6 +1506,40 @@ declare namespace sap {
1966
1506
  }
1967
1507
  }
1968
1508
 
1509
+ interface $FilterBarSettings extends sap.ui.mdc.$FilterBarSettings {
1510
+ /**
1511
+ * ID of multiDimModel
1512
+ */
1513
+ multiDimModelId?:
1514
+ | string
1515
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1516
+
1517
+ /**
1518
+ * Mode
1519
+ */
1520
+ mode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1521
+
1522
+ /**
1523
+ * Defines whether the value and/or description of the field is shown and in which order.
1524
+ */
1525
+ display?:
1526
+ | sap.ui.mdc.enums.FieldDisplay
1527
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1528
+ | `{${string}}`;
1529
+
1530
+ /**
1531
+ * Fires before update variable of multidimension model after input value or open value help of variable.
1532
+ */
1533
+ beforeFilterChange?: (
1534
+ oEvent: FilterBar$BeforeFilterChangeEvent
1535
+ ) => void;
1536
+
1537
+ /**
1538
+ * Fires when cancel change in the value help dialog.
1539
+ */
1540
+ cancelFilterChange?: (oEvent: sap.ui.base.Event) => void;
1541
+ }
1542
+
1969
1543
  interface $FlexAnalysisSettings extends sap.ui.core.$ControlSettings {
1970
1544
  /**
1971
1545
  * Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
@@ -2197,6 +1771,297 @@ declare namespace sap {
2197
1771
  content?: sap.ui.core.Control;
2198
1772
  }
2199
1773
 
1774
+ interface FilterBar$BeforeFilterChangeEventParameters {
1775
+ /**
1776
+ * Indicates whether value help dialog is going to open.
1777
+ */
1778
+ beforeValueHelpOpen?: boolean;
1779
+ }
1780
+
1781
+ interface FilterBar$CancelFilterChangeEventParameters {}
1782
+
1783
+ /**
1784
+ * @experimental (since 1.119)
1785
+ *
1786
+ * A Filter Bar based on Multidimensional Model
1787
+ */
1788
+ class FilterBar extends sap.ui.mdc.FilterBar {
1789
+ /**
1790
+ * Constructor for a new Filter Bar.
1791
+ *
1792
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1793
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1794
+ * of the syntax of the settings object.
1795
+ */
1796
+ constructor();
1797
+
1798
+ /**
1799
+ * Creates a new subclass of class sap.sac.df.FilterBar with name `sClassName` and enriches it with the
1800
+ * information contained in `oClassInfo`.
1801
+ *
1802
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterBar.extend}.
1803
+ *
1804
+ * @returns Created class / constructor function
1805
+ */
1806
+ static extend<T extends Record<string, unknown>>(
1807
+ /**
1808
+ * Name of the class being created
1809
+ */
1810
+ sClassName: string,
1811
+ /**
1812
+ * Object literal with information about the class
1813
+ */
1814
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.FilterBar>,
1815
+ /**
1816
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1817
+ * used by this class
1818
+ */
1819
+ FNMetaImpl?: Function
1820
+ ): Function;
1821
+ /**
1822
+ * Returns a metadata object for class sap.sac.df.FilterBar.
1823
+ *
1824
+ * @returns Metadata object describing this class
1825
+ */
1826
+ static getMetadata(): sap.ui.core.ElementMetadata;
1827
+ /**
1828
+ * Attaches event handler `fnFunction` to the {@link #event:beforeFilterChange beforeFilterChange} event
1829
+ * of this `sap.sac.df.FilterBar`.
1830
+ *
1831
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1832
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
1833
+ *
1834
+ * Fires before update variable of multidimension model after input value or open value help of variable.
1835
+ *
1836
+ * @returns Reference to `this` in order to allow method chaining
1837
+ */
1838
+ attachBeforeFilterChange(
1839
+ /**
1840
+ * An application-specific payload object that will be passed to the event handler along with the event
1841
+ * object when firing the event
1842
+ */
1843
+ oData: object,
1844
+ /**
1845
+ * The function to be called when the event occurs
1846
+ */
1847
+ fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
1848
+ /**
1849
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
1850
+ */
1851
+ oListener?: object
1852
+ ): this;
1853
+ /**
1854
+ * Attaches event handler `fnFunction` to the {@link #event:beforeFilterChange beforeFilterChange} event
1855
+ * of this `sap.sac.df.FilterBar`.
1856
+ *
1857
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1858
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
1859
+ *
1860
+ * Fires before update variable of multidimension model after input value or open value help of variable.
1861
+ *
1862
+ * @returns Reference to `this` in order to allow method chaining
1863
+ */
1864
+ attachBeforeFilterChange(
1865
+ /**
1866
+ * The function to be called when the event occurs
1867
+ */
1868
+ fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
1869
+ /**
1870
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
1871
+ */
1872
+ oListener?: object
1873
+ ): this;
1874
+ /**
1875
+ * Attaches event handler `fnFunction` to the {@link #event:cancelFilterChange cancelFilterChange} event
1876
+ * of this `sap.sac.df.FilterBar`.
1877
+ *
1878
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1879
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
1880
+ *
1881
+ * Fires when cancel change in the value help dialog.
1882
+ *
1883
+ * @returns Reference to `this` in order to allow method chaining
1884
+ */
1885
+ attachCancelFilterChange(
1886
+ /**
1887
+ * An application-specific payload object that will be passed to the event handler along with the event
1888
+ * object when firing the event
1889
+ */
1890
+ oData: object,
1891
+ /**
1892
+ * The function to be called when the event occurs
1893
+ */
1894
+ fnFunction: (p1: sap.ui.base.Event) => void,
1895
+ /**
1896
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
1897
+ */
1898
+ oListener?: object
1899
+ ): this;
1900
+ /**
1901
+ * Attaches event handler `fnFunction` to the {@link #event:cancelFilterChange cancelFilterChange} event
1902
+ * of this `sap.sac.df.FilterBar`.
1903
+ *
1904
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1905
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
1906
+ *
1907
+ * Fires when cancel change in the value help dialog.
1908
+ *
1909
+ * @returns Reference to `this` in order to allow method chaining
1910
+ */
1911
+ attachCancelFilterChange(
1912
+ /**
1913
+ * The function to be called when the event occurs
1914
+ */
1915
+ fnFunction: (p1: sap.ui.base.Event) => void,
1916
+ /**
1917
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
1918
+ */
1919
+ oListener?: object
1920
+ ): this;
1921
+ /**
1922
+ * Detaches event handler `fnFunction` from the {@link #event:beforeFilterChange beforeFilterChange} event
1923
+ * of this `sap.sac.df.FilterBar`.
1924
+ *
1925
+ * The passed function and listener object must match the ones used for event registration.
1926
+ *
1927
+ * @returns Reference to `this` in order to allow method chaining
1928
+ */
1929
+ detachBeforeFilterChange(
1930
+ /**
1931
+ * The function to be called, when the event occurs
1932
+ */
1933
+ fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
1934
+ /**
1935
+ * Context object on which the given function had to be called
1936
+ */
1937
+ oListener?: object
1938
+ ): this;
1939
+ /**
1940
+ * Detaches event handler `fnFunction` from the {@link #event:cancelFilterChange cancelFilterChange} event
1941
+ * of this `sap.sac.df.FilterBar`.
1942
+ *
1943
+ * The passed function and listener object must match the ones used for event registration.
1944
+ *
1945
+ * @returns Reference to `this` in order to allow method chaining
1946
+ */
1947
+ detachCancelFilterChange(
1948
+ /**
1949
+ * The function to be called, when the event occurs
1950
+ */
1951
+ fnFunction: (p1: sap.ui.base.Event) => void,
1952
+ /**
1953
+ * Context object on which the given function had to be called
1954
+ */
1955
+ oListener?: object
1956
+ ): this;
1957
+ /**
1958
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1959
+ *
1960
+ * Fires event {@link #event:beforeFilterChange beforeFilterChange} to attached listeners.
1961
+ *
1962
+ * @returns Reference to `this` in order to allow method chaining
1963
+ */
1964
+ fireBeforeFilterChange(
1965
+ /**
1966
+ * Parameters to pass along with the event
1967
+ */
1968
+ mParameters?: sap.sac.df.FilterBar$BeforeFilterChangeEventParameters
1969
+ ): this;
1970
+ /**
1971
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1972
+ *
1973
+ * Fires event {@link #event:cancelFilterChange cancelFilterChange} to attached listeners.
1974
+ *
1975
+ * @returns Reference to `this` in order to allow method chaining
1976
+ */
1977
+ fireCancelFilterChange(
1978
+ /**
1979
+ * Parameters to pass along with the event
1980
+ */
1981
+ mParameters?: object
1982
+ ): this;
1983
+ /**
1984
+ * Gets current value of property {@link #getDisplay display}.
1985
+ *
1986
+ * Defines whether the value and/or description of the field is shown and in which order.
1987
+ *
1988
+ * Default value is `ValueDescription`.
1989
+ *
1990
+ * @returns Value of property `display`
1991
+ */
1992
+ getDisplay(): sap.ui.mdc.enums.FieldDisplay;
1993
+ /**
1994
+ * Gets current value of property {@link #getMode mode}.
1995
+ *
1996
+ * Mode
1997
+ *
1998
+ * Default value is `"VariablesOfDataProvider"`.
1999
+ *
2000
+ * @returns Value of property `mode`
2001
+ */
2002
+ getMode(): string;
2003
+ /**
2004
+ * Gets current value of property {@link #getMultiDimModelId multiDimModelId}.
2005
+ *
2006
+ * ID of multiDimModel
2007
+ *
2008
+ * Default value is `"om"`.
2009
+ *
2010
+ * @returns Value of property `multiDimModelId`
2011
+ */
2012
+ getMultiDimModelId(): string;
2013
+ /**
2014
+ * Sets a new value for property {@link #getDisplay display}.
2015
+ *
2016
+ * Defines whether the value and/or description of the field is shown and in which order.
2017
+ *
2018
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2019
+ *
2020
+ * Default value is `ValueDescription`.
2021
+ *
2022
+ * @returns Reference to `this` in order to allow method chaining
2023
+ */
2024
+ setDisplay(
2025
+ /**
2026
+ * New value for property `display`
2027
+ */
2028
+ sDisplay?: sap.ui.mdc.enums.FieldDisplay
2029
+ ): this;
2030
+ /**
2031
+ * Sets a new value for property {@link #getMode mode}.
2032
+ *
2033
+ * Mode
2034
+ *
2035
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2036
+ *
2037
+ * Default value is `"VariablesOfDataProvider"`.
2038
+ *
2039
+ * @returns Reference to `this` in order to allow method chaining
2040
+ */
2041
+ setMode(
2042
+ /**
2043
+ * New value for property `mode`
2044
+ */
2045
+ sMode?: string
2046
+ ): this;
2047
+ /**
2048
+ * Sets a new value for property {@link #getMultiDimModelId multiDimModelId}.
2049
+ *
2050
+ * ID of multiDimModel
2051
+ *
2052
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2053
+ *
2054
+ * Default value is `"om"`.
2055
+ *
2056
+ * @returns Reference to `this` in order to allow method chaining
2057
+ */
2058
+ setMultiDimModelId(
2059
+ /**
2060
+ * New value for property `multiDimModelId`
2061
+ */
2062
+ sMultiDimModelId?: string
2063
+ ): this;
2064
+ }
2200
2065
  /**
2201
2066
  * @experimental
2202
2067
  *
@@ -3176,10 +3041,22 @@ declare namespace sap {
3176
3041
  sTitle: string
3177
3042
  ): this;
3178
3043
  }
3044
+
3045
+ type FilterBar$BeforeFilterChangeEvent = sap.ui.base.Event<
3046
+ FilterBar$BeforeFilterChangeEventParameters,
3047
+ FilterBar
3048
+ >;
3049
+
3050
+ type FilterBar$CancelFilterChangeEvent = sap.ui.base.Event<
3051
+ FilterBar$CancelFilterChangeEventParameters,
3052
+ FilterBar
3053
+ >;
3179
3054
  }
3180
3055
  }
3181
3056
 
3182
3057
  interface IUI5DefineDependencyNames {
3058
+ "sap/sac/df/FilterBar": undefined;
3059
+
3183
3060
  "sap/sac/df/FlexAnalysis": undefined;
3184
3061
 
3185
3062
  "sap/sac/df/FlexAnalysisPanel": undefined;
@@ -3190,25 +3067,21 @@ declare namespace sap {
3190
3067
 
3191
3068
  "sap/sac/df/model/DataProvider": undefined;
3192
3069
 
3070
+ "sap/sac/df/model/DataSourceInfo": undefined;
3071
+
3193
3072
  "sap/sac/df/model/Dimension": undefined;
3194
3073
 
3195
3074
  "sap/sac/df/model/Document": undefined;
3196
3075
 
3197
3076
  "sap/sac/df/model/Grid": undefined;
3198
3077
 
3199
- "sap/sac/df/model/MemberFilter": undefined;
3200
-
3201
3078
  "sap/sac/df/model/MultiDimModel": undefined;
3202
3079
 
3203
- "sap/sac/df/model/QueryInfo": undefined;
3204
-
3205
3080
  "sap/sac/df/model/Variable": undefined;
3206
3081
 
3207
3082
  "sap/sac/df/model/VariableGroup": undefined;
3208
3083
 
3209
- "sap/sac/df/olap/MultiDimDataProvider": undefined;
3210
-
3211
- "sap/sac/df/olap/MultiDimModel": undefined;
3084
+ "sap/sac/df/types/DataSourceType": undefined;
3212
3085
 
3213
3086
  "sap/sac/df/types/SystemType": undefined;
3214
3087
  }