@sapui5/ts-types 1.101.1 → 1.103.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +89 -1
  4. package/types/sap.ca.ui.d.ts +1757 -134
  5. package/types/sap.chart.d.ts +376 -30
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +1 -669
  8. package/types/sap.f.d.ts +1948 -123
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +29 -1091
  11. package/types/sap.fe.macros.d.ts +58 -589
  12. package/types/sap.fe.navigation.d.ts +7 -1175
  13. package/types/sap.fe.templates.d.ts +2 -140
  14. package/types/sap.fe.test.d.ts +476 -213
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7540 -559
  17. package/types/sap.insights.d.ts +21 -0
  18. package/types/sap.landvisz.d.ts +1029 -80
  19. package/types/sap.m.d.ts +17162 -1399
  20. package/types/sap.makit.d.ts +579 -58
  21. package/types/sap.me.d.ts +579 -52
  22. package/types/sap.ndc.d.ts +137 -7
  23. package/types/sap.ovp.d.ts +5 -1
  24. package/types/sap.rules.ui.d.ts +171 -15
  25. package/types/sap.sac.df.d.ts +1629 -252
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5573 -454
  28. package/types/sap.suite.ui.generic.template.d.ts +228 -54
  29. package/types/sap.suite.ui.microchart.d.ts +1814 -173
  30. package/types/sap.tnt.d.ts +282 -22
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3818 -347
  33. package/types/sap.ui.comp.d.ts +3965 -303
  34. package/types/sap.ui.core.d.ts +6395 -258
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +61 -6
  37. package/types/sap.ui.fl.d.ts +3 -1
  38. package/types/sap.ui.generic.app.d.ts +245 -64
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +318 -25
  41. package/types/sap.ui.layout.d.ts +1883 -239
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +341 -50
  44. package/types/sap.ui.rta.d.ts +5 -1
  45. package/types/sap.ui.suite.d.ts +87 -6
  46. package/types/sap.ui.support.d.ts +30 -1
  47. package/types/sap.ui.table.d.ts +1057 -87
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2738 -236
  50. package/types/sap.ui.ux3.d.ts +2421 -223
  51. package/types/sap.ui.vbm.d.ts +2006 -126
  52. package/types/sap.ui.vk.d.ts +5369 -326
  53. package/types/sap.ui.vtm.d.ts +1144 -52
  54. package/types/sap.uiext.inbox.d.ts +425 -24
  55. package/types/sap.ushell.d.ts +1500 -59
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +914 -99
  58. package/types/sap.viz.d.ts +5521 -387
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +168 -23
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +227 -14
@@ -1,13 +1,18 @@
1
- // For Library Version: 1.101.0
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace sac {
5
5
  /**
6
- * Design Studio Runtime Library. Intended only to be used within S/4 HANA Fiori applications.
6
+ * @EXPERIMENTAL
7
+ *
8
+ * Dragonfly Library. Provides models and control to access Multidimensional Dara via InA protocol and Firefly
9
+ * library
7
10
  */
8
11
  namespace df {
9
12
  namespace olap {
10
13
  /**
14
+ * @EXPERIMENTAL
15
+ *
11
16
  * A `DataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol HANA
12
17
  * - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
13
18
  *
@@ -65,6 +70,8 @@ declare namespace sap {
65
70
 
66
71
  /**
67
72
  * add a new condition (aka resultset filter).
73
+ *
74
+ * @returns resolving to the `DataProvider` to allow chaining.
68
75
  */
69
76
  addCondition(
70
77
  /**
@@ -78,6 +85,8 @@ declare namespace sap {
78
85
  ): Promise<this>;
79
86
  /**
80
87
  * Do a drill operation on a dimension member on an Axis
88
+ *
89
+ * @returns resolving to the `DataProvider` to allow chaining.
81
90
  */
82
91
  drill(
83
92
  /**
@@ -91,6 +100,8 @@ declare namespace sap {
91
100
  ): this;
92
101
  /**
93
102
  * Gets the scaling factor of a measure or data cell
103
+ *
104
+ * @returns the current decimal places setting
94
105
  */
95
106
  getDecimalPlaces(
96
107
  /**
@@ -104,6 +115,10 @@ declare namespace sap {
104
115
  ): int;
105
116
  /**
106
117
  * get the list of filters of a dimension
118
+ *
119
+ * @returns list of a range with components
120
+ * `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
121
+ * EQ,LE,..,BT
107
122
  */
108
123
  getFilterOfDim(
109
124
  /**
@@ -113,10 +128,14 @@ declare namespace sap {
113
128
  ): object[];
114
129
  /**
115
130
  * get the current resultset from the InA Server
131
+ *
132
+ * @returns resolving to the `DataProvider` to allow chaining.
116
133
  */
117
134
  getResultSet(): Promise<this>;
118
135
  /**
119
136
  * get the list of the jump targets associated to a datacell defined via the report report interface.
137
+ *
138
+ * @returns resolving to the List of jump targets.
120
139
  */
121
140
  getRRITargets(
122
141
  /**
@@ -130,6 +149,8 @@ declare namespace sap {
130
149
  ): Promise<this>;
131
150
  /**
132
151
  * Gets the scaling factor of a measure
152
+ *
153
+ * @returns the exponent of the scaling factor in Base 10
133
154
  */
134
155
  getScalingFactor(
135
156
  /**
@@ -143,6 +164,8 @@ declare namespace sap {
143
164
  ): int;
144
165
  /**
145
166
  * hasVariable Checks whether a Variable is influencing the DataProvider
167
+ *
168
+ * @returns Whether the vairable influences the DataProvider
146
169
  */
147
170
  hasVariable(
148
171
  /**
@@ -152,6 +175,8 @@ declare namespace sap {
152
175
  ): boolean;
153
176
  /**
154
177
  * move a dimension one position down on it's axis
178
+ *
179
+ * @returns the `DataProvider` to allow chaining.
155
180
  */
156
181
  moveDown(
157
182
  /**
@@ -165,6 +190,8 @@ declare namespace sap {
165
190
  ): this;
166
191
  /**
167
192
  * move a dimension one position up on it's axis
193
+ *
194
+ * @returns the `DataProvider` to allow chaining.
168
195
  */
169
196
  moveUp(
170
197
  /**
@@ -178,6 +205,8 @@ declare namespace sap {
178
205
  ): this;
179
206
  /**
180
207
  * Open a dialog that allows to display and change the property of an `Axis` of the `DataProvider`.
208
+ *
209
+ * @returns indicator whether the dialog was confirmed or canceled
181
210
  */
182
211
  openAxisDialog(
183
212
  /**
@@ -187,6 +216,9 @@ declare namespace sap {
187
216
  ): Promise<boolean>;
188
217
  /**
189
218
  * Open a dialog that allows to display and change the property of a `Query Cell` of the `DataProvider`.
219
+ *
220
+ * @returns resolving to the `DataProvider` to allow chaining. In case that a the Currency Translation Settings
221
+ * have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
190
222
  */
191
223
  openCellDialog(
192
224
  /**
@@ -208,10 +240,15 @@ declare namespace sap {
208
240
  ): Promise<this>;
209
241
  /**
210
242
  * Open a dialog that allows to display and change the currency translation settings of the `DataProvider`.
243
+ *
244
+ * @returns indicator whether the dialog was confirmed or canceled in the dialog, the new resultset was
245
+ * retrieved before the promise gets resolved.
211
246
  */
212
247
  openCurrencyTranslationDialog(): Promise<boolean>;
213
248
  /**
214
249
  * Open a dialog to display and change the settings of a dimension of the `DataProvider`
250
+ *
251
+ * @returns indicator whether the dialog was confirmed or canceled
215
252
  */
216
253
  openDimDialog(
217
254
  /**
@@ -221,6 +258,9 @@ declare namespace sap {
221
258
  ): Promise<boolean>;
222
259
  /**
223
260
  * Open a dialog to display and change the filter on a dimension of the `DataProvider`
261
+ *
262
+ * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
263
+ * with Ok and dynamic filters of the given dimension are updated
224
264
  */
225
265
  openSelector(
226
266
  /**
@@ -230,6 +270,8 @@ declare namespace sap {
230
270
  ): Promise<any>;
231
271
  /**
232
272
  * Remove the filter of a dimension
273
+ *
274
+ * @returns resolving to the `DataProvider` to allow chaining.
233
275
  */
234
276
  removeFilter(
235
277
  /**
@@ -239,6 +281,9 @@ declare namespace sap {
239
281
  ): this;
240
282
  /**
241
283
  * Distribute the dimension among the rows and columns
284
+ *
285
+ * @returns resolving to the `DataProvider` to allow chaining. In case that a the Currency Translation Settings
286
+ * have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
242
287
  */
243
288
  setAxesLayout(
244
289
  /**
@@ -250,6 +295,8 @@ declare namespace sap {
250
295
  ): this;
251
296
  /**
252
297
  * Sets the number of decimal of a measure/query cell
298
+ *
299
+ * @returns the DataProvider
253
300
  */
254
301
  setDecimalPlaces(
255
302
  /**
@@ -267,6 +314,8 @@ declare namespace sap {
267
314
  ): this;
268
315
  /**
269
316
  * Set Display Hierachy
317
+ *
318
+ * @returns resolving to the `DataProvider` to allow chaining.
270
319
  */
271
320
  setDisplayHierarchy(
272
321
  /**
@@ -288,6 +337,8 @@ declare namespace sap {
288
337
  ): this;
289
338
  /**
290
339
  * Set the filter for a dimension
340
+ *
341
+ * @returns {{this} resolving to the `DataProvider` to allow chaining.
291
342
  */
292
343
  setFilter(
293
344
  /**
@@ -311,6 +362,8 @@ declare namespace sap {
311
362
  ): void;
312
363
  /**
313
364
  * Sets the scaling factor of a measure/query cell
365
+ *
366
+ * @returns the DataProvider
314
367
  */
315
368
  setScalingFactor(
316
369
  /**
@@ -328,6 +381,8 @@ declare namespace sap {
328
381
  ): this;
329
382
  /**
330
383
  * Sort the members of a dimension
384
+ *
385
+ * @returns resolving to the `DataProvider` to allow chaining.
331
386
  */
332
387
  sort(
333
388
  /**
@@ -349,10 +404,14 @@ declare namespace sap {
349
404
  ): Promise<this>;
350
405
  /**
351
406
  * submit the value of the input enabled queries to the InA Server
407
+ *
408
+ * @returns resolving to the `DataProvider` to allow chaining.
352
409
  */
353
410
  submitVariables(): Promise<this>;
354
411
  /**
355
412
  * suppress a unit/currency from being populated to the result cells
413
+ *
414
+ * @returns the dataprovider to allow chaining
356
415
  */
357
416
  suppressUnit(
358
417
  /**
@@ -362,10 +421,14 @@ declare namespace sap {
362
421
  ): this;
363
422
  /**
364
423
  * retrieve the data of the current naviation state `DataProvider` from the InA Server.
424
+ *
425
+ * @returns to allow chaining.
365
426
  */
366
427
  synchronize(): Promise<this>;
367
428
  /**
368
429
  * Move a dimension to the columns axis
430
+ *
431
+ * @returns resolving to the `DataProvider` to allow chaining.
369
432
  */
370
433
  toColumns(
371
434
  /**
@@ -375,6 +438,8 @@ declare namespace sap {
375
438
  ): this;
376
439
  /**
377
440
  * Move a dimension to the rows axis
441
+ *
442
+ * @returns resolving to the `DataProvider` to allow chaining.
378
443
  */
379
444
  toRows(
380
445
  /**
@@ -384,377 +449,1659 @@ declare namespace sap {
384
449
  ): this;
385
450
  }
386
451
  /**
387
- * List binding implementation for `OlapModel`.
452
+ * @EXPERIMENTAL
453
+ *
454
+ * A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
455
+ * HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
456
+ *
457
+ * Instances of this class should only be created by the {sap.sac.df.olap.MultiDimModel}. The `MultiDimModel`
458
+ * populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
459
+ * is as follows:
460
+ *
461
+ * **Structure of Exposed Data**
462
+ *
463
+ *
464
+ * - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
465
+ * - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
466
+ * `Name`: the external name of the dimension `Description`: the language dependant description of
467
+ * the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
468
+ *
469
+ * - RowsDimensions: The list of all Dimensions lying on the Rows Axis
470
+ * Name: the external name of the dimension Description: the language dependant description of the
471
+ * dimension IsStructure: boolean flag indicating whether the dimension is a structure *
472
+ * - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
473
+ * Name: the external name of the dimension Description: the language dependant description of the
474
+ * dimension IsStructure: boolean flag indicating whether the dimension is a structure
475
+ * - Conditions: list of conditions (result set filters)
476
+ * - Exceptions: list of exceptions (conditional formats)
477
+ * - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
388
478
  */
389
- class OlapListBinding extends sap.ui.model.ListBinding {
390
- /**
391
- * Creates a new OlapListBinding.
392
- *
393
- * This constructor should only be called by subclasses or model implementations, not by application or
394
- * control code. Such code should use {@link sap.sac.df.olap.OlapModel#bindList OlapModel#bindList} on the
395
- * corresponding model instance instead.
396
- */
397
- constructor();
398
-
479
+ class MultiDimDataProvider {
399
480
  /**
400
- * Creates a new subclass of class sap.sac.df.olap.OlapListBinding with name `sClassName` and enriches it
401
- * with the information contained in `oClassInfo`.
481
+ * Constructor for a new MultiDimDataProvider.
402
482
  *
403
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
483
+ * A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
484
+ * servers providing the InA
485
+ * Protocol.
404
486
  */
405
- static extend<T extends Record<string, unknown>>(
487
+ constructor(
406
488
  /**
407
- * Name of the class being created
489
+ * the model to which the MultiDimDataProvider belongs
408
490
  */
409
- sClassName: string,
491
+ oMultiDimModel: sap.sac.df.olap.MultiDimModel,
410
492
  /**
411
- * Object literal with information about the class
493
+ * name of the MultiDimDataProvider
412
494
  */
413
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapListBinding>,
495
+ sMultiDimDataProviderName: string,
414
496
  /**
415
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
416
- * used by this class
497
+ * the firefly application associated to the `MultiDimModel`
417
498
  */
418
- FNMetaImpl?: Function
419
- ): Function;
420
- /**
421
- * Returns a metadata object for class sap.sac.df.olap.OlapListBinding.
422
- */
423
- static getMetadata(): sap.ui.base.Metadata;
424
- }
425
- /**
426
- * List binding implementation for `OlapModel`.
427
- */
428
- class OlapListGridBinding extends sap.ui.model.ListBinding {
429
- /**
430
- * Creates a new OlapListGridBinding.
431
- *
432
- * This constructor should only be called by subclasses or model implementations, not by application or
433
- * control code. Such code should use {@link sap.sac.df.OlapModel#bindList OlapModel#bindList} on the corresponding
434
- * model instance instead.
435
- */
436
- constructor();
499
+ oApplication: object,
500
+ /**
501
+ * the firefly queryManager that is wrapped by the `MultiDimDataProvider`
502
+ */
503
+ oQueryManager: object
504
+ );
437
505
 
438
506
  /**
439
- * Creates a new subclass of class sap.sac.df.olap.OlapListGridBinding with name `sClassName` and enriches
440
- * it with the information contained in `oClassInfo`.
507
+ * add a new condition (aka resultset filter).
441
508
  *
442
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
509
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
443
510
  */
444
- static extend<T extends Record<string, unknown>>(
445
- /**
446
- * Name of the class being created
447
- */
448
- sClassName: string,
511
+ addCondition(
449
512
  /**
450
- * Object literal with information about the class
513
+ * Condition Definiton
451
514
  */
452
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapListGridBinding>,
515
+ oData: object,
453
516
  /**
454
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
455
- * used by this class
517
+ * Target state of the condition
456
518
  */
457
- FNMetaImpl?: Function
458
- ): Function;
459
- /**
460
- * Returns a metadata object for class sap.sac.df.olap.OlapListGridBinding.
461
- */
462
- static getMetadata(): sap.ui.base.Metadata;
463
- }
464
- /**
465
- * Model implementation for InA provider
466
- *
467
- * The OlapModel can populate it's exposed data via Binding to Controls. The structure of the exposed data
468
- * is as follows: **Structure of Exposed Data**
469
- *
470
- *
471
- * - FlatVariables: The list of all input ready variables collected from all aggregated `DataProvider`
472
- *
473
- * - DataProvider: The associative array of all `DataProvider` aggregated by the semanticStyles:
474
- * The associative array of all `SemanticStyle` for the `OlapModel` Messages: The list of all messages
475
- * posted by the Analytical Engine
476
- */
477
- class OlapModel extends sap.ui.model.Model {
519
+ bActive: boolean
520
+ ): Promise<this>;
478
521
  /**
479
- * Constructor for a new OlapMode.
480
- *
481
- * The Olap Model allows to access and change data from servers providing the InA Protocol.
522
+ * Do a drill operation on a dimension member on an Axis
482
523
  *
483
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
484
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
485
- * of the syntax of the settings object.
524
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
486
525
  */
487
- constructor(
526
+ drill(
488
527
  /**
489
- * the settings for the new Olap Model.
490
- * systemLandscape: The list of addressable Analytic Engines dataProvider: The associative array of
491
- * all `DataProvider` aggregated by the
528
+ * the external name of the Dimension
492
529
  */
493
- mSettings?: object
494
- );
495
-
530
+ sDim: string,
531
+ /**
532
+ * the Tuple Index of the member in the resultset.
533
+ */
534
+ nIndex: int
535
+ ): this;
496
536
  /**
497
- * Creates a new subclass of class sap.sac.df.olap.OlapModel with name `sClassName` and enriches it with
498
- * the information contained in `oClassInfo`.
537
+ * Gets the scaling factor of a measure or data cell
499
538
  *
500
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
539
+ * @returns the current decimal places setting
501
540
  */
502
- static extend<T extends Record<string, unknown>>(
541
+ getDecimalPlaces(
503
542
  /**
504
- * Name of the class being created
543
+ * the Member of the Measure Structure
505
544
  */
506
- sClassName: string,
545
+ sMeasureMember: string,
507
546
  /**
508
- * Object literal with information about the class
547
+ * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
509
548
  */
510
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapModel>,
549
+ sNonMeasureMember: string
550
+ ): int;
551
+ /**
552
+ * get the list of filters of a dimension
553
+ *
554
+ * @returns list of a range with components
555
+ * `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
556
+ * EQ,LE,..,BT
557
+ */
558
+ getFilterOfDim(
511
559
  /**
512
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
513
- * used by this class
560
+ * the name of the dimension from which the filter is retrieved
514
561
  */
515
- FNMetaImpl?: Function
516
- ): Function;
562
+ sDim: string
563
+ ): object[];
517
564
  /**
518
- * Returns a metadata object for class sap.sac.df.olap.OlapModel.
565
+ * get the current resultset from the InA Server
566
+ *
567
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
519
568
  */
520
- static getMetadata(): sap.ui.base.Metadata;
569
+ getResultSet(): Promise<this>;
521
570
  /**
522
- * adds a new query as a new `DataProvider` . The query is supposed to be defined as an analytical annotated
523
- * CDS View the name of the query is the name of the DDIC view, prefixed by "2C"
571
+ * get the list of the jump targets associated to a datacell defined via the report report interface.
572
+ *
573
+ * @returns resolving to the List of jump targets.
524
574
  */
525
- addQuery(
526
- /**
527
- * the name of the new `DataProvider`.
528
- */
529
- sDataProviderName: string,
530
- /**
531
- * the name of the query which the `DataProvider` is supposed to expose.
532
- */
533
- sQueryName: string,
575
+ getRRITargets(
534
576
  /**
535
- * the name of the system in the landscape
577
+ * Row of the data cell
536
578
  */
537
- sSystem?: string,
579
+ nRow: int,
538
580
  /**
539
- * the name of the package
581
+ * Column of the data cell
540
582
  */
541
- sPackage?: string,
583
+ nColumn: int
584
+ ): Promise<this>;
585
+ /**
586
+ * Gets the scaling factor of a measure
587
+ *
588
+ * @returns the exponent of the scaling factor in Base 10
589
+ */
590
+ getScalingFactor(
542
591
  /**
543
- * the name of the schema
592
+ * the Member of the Measure Structure
544
593
  */
545
- sSchema?: string,
594
+ sMeasureMember: string,
546
595
  /**
547
- * the name of the type of the datasource
596
+ * the Member of the Non Measure Structure
548
597
  */
549
- sType?: string
550
- ): Promise<sap.sac.df.olap.DataProvider>;
598
+ sNonMeasureMember: string
599
+ ): int;
551
600
  /**
552
- * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
553
- * `sap.sac.df.olap.OlapModel`.
601
+ * hasVariable Checks whether a Variable is influencing the MultiDimDataProvider
554
602
  *
555
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
556
- * otherwise it will be bound to this `sap.sac.df.olap.OlapModel` itself.
603
+ * @returns Whether the vairable influences the MultiDimDataProvider
557
604
  */
558
- attachMetadataFailed(
605
+ hasVariable(
559
606
  /**
560
- * An application-specific payload object that will be passed to the event handler along with the event
561
- * object when firing the event
607
+ * Name of the Variable
562
608
  */
563
- oData: object,
609
+ the: string
610
+ ): boolean;
611
+ /**
612
+ * move a dimension one position down on it's axis
613
+ *
614
+ * @returns the `MultiDimDataProvider` to allow chaining.
615
+ */
616
+ moveDown(
564
617
  /**
565
- * The function to be called when the event occurs
618
+ * name of the dimension
566
619
  */
567
- fnFunction: (p1: sap.ui.base.Event) => void,
620
+ sName: string,
568
621
  /**
569
- * Context object to call the event handler with. Defaults to this `sap.sac.df.olap.OlapModel` itself
622
+ * Target state of the condition
570
623
  */
571
- oListener?: object
624
+ bActive: boolean
572
625
  ): this;
573
626
  /**
574
- * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
575
- * `sap.sac.df.olap.OlapModel`.
627
+ * move a dimension one position up on it's axis
576
628
  *
577
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
578
- * otherwise it will be bound to this `sap.sac.df.olap.OlapModel` itself.
629
+ * @returns the `MultiDimDataProvider` to allow chaining.
579
630
  */
580
- attachMetadataFailed(
631
+ moveUp(
581
632
  /**
582
- * The function to be called when the event occurs
633
+ * name of the dimension
583
634
  */
584
- fnFunction: (p1: sap.ui.base.Event) => void,
635
+ sName: string,
585
636
  /**
586
- * Context object to call the event handler with. Defaults to this `sap.sac.df.olap.OlapModel` itself
637
+ * Target state of the condition
587
638
  */
588
- oListener?: object
639
+ bActive: boolean
589
640
  ): this;
590
641
  /**
591
- * deserialize the Model with all aggregated `DataProvider` The `OlapModel` be be deserialized from an equivalent
592
- * such Object.
642
+ * Open a dialog that allows to display and change the property of an `Axis` of the `MultiDimDataProvider`.
643
+ *
644
+ * @returns indicator whether the dialog was confirmed or canceled
593
645
  */
594
- deserialize(): object;
646
+ openAxisDialog(
647
+ /**
648
+ * the external name of the Dimension
649
+ */
650
+ sDim: string
651
+ ): Promise<boolean>;
595
652
  /**
596
- * Detaches event handler `fnFunction` from the {@link #event:metadataFailed metadataFailed} event of this
597
- * `sap.sac.df.olap.OlapModel`.
653
+ * Open a dialog that allows to display and change the property of a `Query Cell` of the `MultiDimDataProvider`.
598
654
  *
599
- * The passed function and listener object must match the ones used for event registration.
655
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
656
+ * Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
600
657
  */
601
- detachMetadataFailed(
658
+ openCellDialog(
602
659
  /**
603
- * The function to be called, when the event occurs
660
+ * the external name of the first structure
604
661
  */
605
- fnFunction: (p1: sap.ui.base.Event) => void,
662
+ sDim1?: string,
606
663
  /**
607
- * Context object on which the given function had to be called
664
+ * the external name of the member of the first structure
608
665
  */
609
- oListener?: object
666
+ sMem1?: string,
667
+ /**
668
+ * the external name of the second structure
669
+ */
670
+ sDim2?: string,
671
+ /**
672
+ * the external name of the member of the second structure
673
+ */
674
+ sMem2?: string
675
+ ): Promise<this>;
676
+ /**
677
+ * Open a dialog that allows to display and change the currency translation settings of the `MultiDimDataProvider`.
678
+ *
679
+ * @returns indicator whether the dialog was confirmed or canceled in the dialog, the new resultset was
680
+ * retrieved before the promise gets resolved.
681
+ */
682
+ openCurrencyTranslationDialog(): Promise<boolean>;
683
+ /**
684
+ * Open a dialog to display and change the settings of a dimension of the `MultiDimDataProvider`
685
+ *
686
+ * @returns indicator whether the dialog was confirmed or canceled
687
+ */
688
+ openDimDialog(
689
+ /**
690
+ * the external name of the Dimension
691
+ */
692
+ sDim: string
693
+ ): Promise<boolean>;
694
+ /**
695
+ * Open a dialog to display and change the filter on a dimension of the `MultiDimDataProvider`
696
+ *
697
+ * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
698
+ * with Ok and dynamic filters of the given dimension are updated
699
+ */
700
+ openSelector(
701
+ /**
702
+ * the external name of the Dimension
703
+ */
704
+ sDimensionName: string
705
+ ): Promise<any>;
706
+ /**
707
+ * Remove the filter of a dimension
708
+ *
709
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
710
+ */
711
+ removeFilter(
712
+ /**
713
+ * the external name
714
+ */
715
+ sDim: string
610
716
  ): this;
611
717
  /**
612
- * Fires event {@link #event:metadataFailed metadataFailed} to attached listeners.
718
+ * Distribute the dimension among the rows and columns
719
+ *
720
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
721
+ * Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
613
722
  */
614
- fireMetadataFailed(
723
+ setAxesLayout(
615
724
  /**
616
- * Parameters to pass along with the event
725
+ * an Object containing a `rows` member referencing a string array containing the names of the dimensions
726
+ * and a `columns` member referencing a string array containing the dimension on the columns. The order
727
+ * in the array control the positon on the axis.
617
728
  */
618
- mParameters?: object
729
+ mLayout: object
619
730
  ): this;
620
731
  /**
621
- * retrieves a `DataProvider` aggregated by the `OlapModel`. sQueryName, sSystem
732
+ * Sets the number of decimal of a measure/query cell
733
+ *
734
+ * @returns the MultiDimDataProvider
622
735
  */
623
- getDataProvider(
736
+ setDecimalPlaces(
624
737
  /**
625
- * the name of the `DataProvider`.
738
+ * number of the decimal palaces to be shown after the separator
626
739
  */
627
- sDataProviderName: string
628
- ): sap.sac.df.olap.DataProvider;
740
+ nNumberOfDecimalPlaces: int,
741
+ /**
742
+ * the Member of the Measure Structure
743
+ */
744
+ sMeasureMember: string,
745
+ /**
746
+ * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
747
+ */
748
+ the: string
749
+ ): this;
750
+ /**
751
+ * Set Display Hierachy
752
+ *
753
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
754
+ */
755
+ setDisplayHierarchy(
756
+ /**
757
+ * the external name of the structure on which the new restriction is created
758
+ */
759
+ sDim: string,
760
+ /**
761
+ * whether the hierarchy should be activated
762
+ */
763
+ bActive: boolean,
764
+ /**
765
+ * the name of the hierarchy (optional)
766
+ */
767
+ sHierachy: string,
768
+ /**
769
+ * the version of the hierarchy (optional)
770
+ */
771
+ sVersion: string
772
+ ): this;
773
+ /**
774
+ * Set the filter for a dimension
775
+ *
776
+ * @returns {{this} resolving to the `MultiDimDataProvider` to allow chaining.
777
+ */
778
+ setFilter(
779
+ /**
780
+ * the external name
781
+ */
782
+ sDim: string,
783
+ /**
784
+ * the filter
785
+ */
786
+ oFilter: object
787
+ ): undefined;
788
+ /**
789
+ * sets the format property of the MultiDimDataProvider, this can influence the resultset that is aggregated
790
+ * in the `Grid.Cells` collection. Its main purpose is to influence the visualisation of a `sap.sac.df.PivotTable`
791
+ */
792
+ setFormat(
793
+ /**
794
+ * the format to be used
795
+ */
796
+ sFormat: sap.sac.grid.Format
797
+ ): void;
798
+ /**
799
+ * Sets the scaling factor of a measure/query cell
800
+ *
801
+ * @returns the MultiDimDataProvider
802
+ */
803
+ setScalingFactor(
804
+ /**
805
+ * the exponential of the scaling factor
806
+ */
807
+ nFactor: int,
808
+ /**
809
+ * the Member of the Measure Structure
810
+ */
811
+ sMeasureMember: string,
812
+ /**
813
+ * the Member of the Non Measure Structure
814
+ */
815
+ sNonMeasureMember: string
816
+ ): this;
817
+ /**
818
+ * Sort the members of a dimension
819
+ *
820
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
821
+ */
822
+ sort(
823
+ /**
824
+ * the external name of the Dimension
825
+ */
826
+ sDim: string,
827
+ /**
828
+ * of sorting
829
+ */
830
+ type: /* was: sap.sac.df.types.SortType */ any,
831
+ /**
832
+ * of sorting
833
+ */
834
+ direction: /* was: sap.sac.df.types.SortDirection */ any,
835
+ /**
836
+ * in case of a structure the measure according to which is sorted
837
+ */
838
+ sMember?: string
839
+ ): Promise<this>;
840
+ /**
841
+ * submit the value of the input enabled queries to the InA Server
842
+ *
843
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
844
+ */
845
+ submitVariables(): Promise<this>;
846
+ /**
847
+ * suppress a unit/currency from being populated to the result cells
848
+ *
849
+ * @returns the MultiDimDataProvider to allow chaining
850
+ */
851
+ suppressUnit(
852
+ /**
853
+ * the key of the suppressed unit
854
+ */
855
+ sUnit: string
856
+ ): this;
857
+ /**
858
+ * retrieve the data of the current naviation state `MultiDimDataProvider` from the InA Server.
859
+ *
860
+ * @returns to allow chaining.
861
+ */
862
+ synchronize(): Promise<this>;
863
+ /**
864
+ * Move a dimension to the columns axis
865
+ *
866
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
867
+ */
868
+ toColumns(
869
+ /**
870
+ * the external name of the Dimension
871
+ */
872
+ sDim: string
873
+ ): this;
874
+ /**
875
+ * Move a dimension to the rows axis
876
+ *
877
+ * @returns resolving to the `MultiDimDataProvider` to allow chaining.
878
+ */
879
+ toRows(
880
+ /**
881
+ * the external name of the Dimension
882
+ */
883
+ sDim: string
884
+ ): this;
885
+ }
886
+ /**
887
+ * @EXPERIMENTAL
888
+ *
889
+ * Model implementation for InA provider
890
+ *
891
+ * The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
892
+ * data is as follows: **Structure of Exposed Data**
893
+ *
894
+ *
895
+ * - DataProvider: The associative array of all `DataProvider` aggregated by the SemanticStyles:
896
+ * The associative array of all `SemanticStyle` for the `MultiDimModel` VariableGroups: The associative
897
+ * array of registered Variable Groups Messages: The list of all messages posted by the Analytical Engine
898
+ */
899
+ class MultiDimModel extends sap.ui.model.Model {
900
+ /**
901
+ * Constructor for a new OlapMode.
902
+ *
903
+ * The Olap Model allows to access and change data from servers providing the InA Protocol.
904
+ */
905
+ constructor();
906
+
907
+ /**
908
+ * Creates a new subclass of class sap.sac.df.olap.MultiDimModel with name `sClassName` and enriches it
909
+ * with the information contained in `oClassInfo`.
910
+ *
911
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
912
+ *
913
+ * @returns Created class / constructor function
914
+ */
915
+ static extend<T extends Record<string, unknown>>(
916
+ /**
917
+ * Name of the class being created
918
+ */
919
+ sClassName: string,
920
+ /**
921
+ * Object literal with information about the class
922
+ */
923
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.MultiDimModel>,
924
+ /**
925
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
926
+ * used by this class
927
+ */
928
+ FNMetaImpl?: Function
929
+ ): Function;
930
+ /**
931
+ * Returns a metadata object for class sap.sac.df.olap.MultiDimModel.
932
+ *
933
+ * @returns Metadata object describing this class
934
+ */
935
+ static getMetadata(): sap.ui.base.Metadata;
936
+ }
937
+ /**
938
+ * List binding implementation for `OlapModel`.
939
+ */
940
+ class OlapListBinding extends sap.ui.model.ListBinding {
941
+ /**
942
+ * Creates a new OlapListBinding.
943
+ *
944
+ * This constructor should only be called by subclasses or model implementations, not by application or
945
+ * control code. Such code should use {@link sap.sac.df.olap.OlapModel#bindList OlapModel#bindList} on the
946
+ * corresponding model instance instead.
947
+ */
948
+ constructor();
949
+
950
+ /**
951
+ * Creates a new subclass of class sap.sac.df.olap.OlapListBinding with name `sClassName` and enriches it
952
+ * with the information contained in `oClassInfo`.
953
+ *
954
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
955
+ *
956
+ * @returns Created class / constructor function
957
+ */
958
+ static extend<T extends Record<string, unknown>>(
959
+ /**
960
+ * Name of the class being created
961
+ */
962
+ sClassName: string,
963
+ /**
964
+ * Object literal with information about the class
965
+ */
966
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapListBinding>,
967
+ /**
968
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
969
+ * used by this class
970
+ */
971
+ FNMetaImpl?: Function
972
+ ): Function;
973
+ /**
974
+ * Returns a metadata object for class sap.sac.df.olap.OlapListBinding.
975
+ *
976
+ * @returns Metadata object describing this class
977
+ */
978
+ static getMetadata(): sap.ui.base.Metadata;
979
+ }
980
+ /**
981
+ * List binding implementation for `OlapModel`.
982
+ */
983
+ class OlapListGridBinding extends sap.ui.model.ListBinding {
984
+ /**
985
+ * Creates a new OlapListGridBinding.
986
+ *
987
+ * This constructor should only be called by subclasses or model implementations, not by application or
988
+ * control code. Such code should use {@link sap.sac.df.OlapModel#bindList OlapModel#bindList} on the corresponding
989
+ * model instance instead.
990
+ */
991
+ constructor();
992
+
993
+ /**
994
+ * Creates a new subclass of class sap.sac.df.olap.OlapListGridBinding with name `sClassName` and enriches
995
+ * it with the information contained in `oClassInfo`.
996
+ *
997
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
998
+ *
999
+ * @returns Created class / constructor function
1000
+ */
1001
+ static extend<T extends Record<string, unknown>>(
1002
+ /**
1003
+ * Name of the class being created
1004
+ */
1005
+ sClassName: string,
1006
+ /**
1007
+ * Object literal with information about the class
1008
+ */
1009
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapListGridBinding>,
1010
+ /**
1011
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1012
+ * used by this class
1013
+ */
1014
+ FNMetaImpl?: Function
1015
+ ): Function;
1016
+ /**
1017
+ * Returns a metadata object for class sap.sac.df.olap.OlapListGridBinding.
1018
+ *
1019
+ * @returns Metadata object describing this class
1020
+ */
1021
+ static getMetadata(): sap.ui.base.Metadata;
1022
+ }
1023
+ /**
1024
+ * @EXPERIMENTAL
1025
+ *
1026
+ * Model implementation for InA provider
1027
+ *
1028
+ * The OlapModel can populate it's exposed data via Binding to Controls. The structure of the exposed data
1029
+ * is as follows: **Structure of Exposed Data**
1030
+ *
1031
+ *
1032
+ * - FlatVariables: The list of all input ready variables collected from all aggregated `DataProvider`
1033
+ *
1034
+ * - DataProvider: The associative array of all `DataProvider` aggregated by the semanticStyles:
1035
+ * The associative array of all `SemanticStyle` for the `OlapModel` Messages: The list of all messages
1036
+ * posted by the Analytical Engine
1037
+ */
1038
+ class OlapModel extends sap.ui.model.Model {
1039
+ /**
1040
+ * Constructor for a new OlapMode.
1041
+ *
1042
+ * The Olap Model allows to access and change data from servers providing the InA Protocol.
1043
+ *
1044
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1045
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1046
+ * of the syntax of the settings object.
1047
+ */
1048
+ constructor(
1049
+ /**
1050
+ * the settings for the new Olap Model.
1051
+ * systemLandscape: The list of addressable Analytic Engines dataProvider: The associative array of
1052
+ * all `DataProvider` aggregated by the
1053
+ */
1054
+ mSettings?: object
1055
+ );
1056
+
1057
+ /**
1058
+ * Creates a new subclass of class sap.sac.df.olap.OlapModel with name `sClassName` and enriches it with
1059
+ * the information contained in `oClassInfo`.
1060
+ *
1061
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
1062
+ *
1063
+ * @returns Created class / constructor function
1064
+ */
1065
+ static extend<T extends Record<string, unknown>>(
1066
+ /**
1067
+ * Name of the class being created
1068
+ */
1069
+ sClassName: string,
1070
+ /**
1071
+ * Object literal with information about the class
1072
+ */
1073
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapModel>,
1074
+ /**
1075
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1076
+ * used by this class
1077
+ */
1078
+ FNMetaImpl?: Function
1079
+ ): Function;
1080
+ /**
1081
+ * Returns a metadata object for class sap.sac.df.olap.OlapModel.
1082
+ *
1083
+ * @returns Metadata object describing this class
1084
+ */
1085
+ static getMetadata(): sap.ui.base.Metadata;
1086
+ /**
1087
+ * adds a new query as a new `DataProvider` . The query is supposed to be defined as an analytical annotated
1088
+ * CDS View the name of the query is the name of the DDIC view, prefixed by "2C"
1089
+ *
1090
+ * @returns the Data Provider that was created
1091
+ */
1092
+ addQuery(
1093
+ /**
1094
+ * the name of the new `DataProvider`.
1095
+ */
1096
+ sDataProviderName: string,
1097
+ /**
1098
+ * the name of the query which the `DataProvider` is supposed to expose.
1099
+ */
1100
+ sQueryName: string,
1101
+ /**
1102
+ * the name of the system in the landscape
1103
+ */
1104
+ sSystem?: string,
1105
+ /**
1106
+ * the name of the package
1107
+ */
1108
+ sPackage?: string,
1109
+ /**
1110
+ * the name of the schema
1111
+ */
1112
+ sSchema?: string,
1113
+ /**
1114
+ * the name of the type of the datasource
1115
+ */
1116
+ sType?: string
1117
+ ): Promise<sap.sac.df.olap.DataProvider>;
1118
+ /**
1119
+ * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
1120
+ * `sap.sac.df.olap.OlapModel`.
1121
+ *
1122
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1123
+ * otherwise it will be bound to this `sap.sac.df.olap.OlapModel` itself.
1124
+ *
1125
+ * @returns Reference to `this` in order to allow method chaining
1126
+ */
1127
+ attachMetadataFailed(
1128
+ /**
1129
+ * An application-specific payload object that will be passed to the event handler along with the event
1130
+ * object when firing the event
1131
+ */
1132
+ oData: object,
1133
+ /**
1134
+ * The function to be called when the event occurs
1135
+ */
1136
+ fnFunction: (p1: sap.ui.base.Event) => void,
1137
+ /**
1138
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.olap.OlapModel` itself
1139
+ */
1140
+ oListener?: object
1141
+ ): this;
1142
+ /**
1143
+ * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
1144
+ * `sap.sac.df.olap.OlapModel`.
1145
+ *
1146
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1147
+ * otherwise it will be bound to this `sap.sac.df.olap.OlapModel` itself.
1148
+ *
1149
+ * @returns Reference to `this` in order to allow method chaining
1150
+ */
1151
+ attachMetadataFailed(
1152
+ /**
1153
+ * The function to be called when the event occurs
1154
+ */
1155
+ fnFunction: (p1: sap.ui.base.Event) => void,
1156
+ /**
1157
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.olap.OlapModel` itself
1158
+ */
1159
+ oListener?: object
1160
+ ): this;
1161
+ /**
1162
+ * deserialize the Model with all aggregated `DataProvider` The `OlapModel` be be deserialized from an equivalent
1163
+ * such Object.
1164
+ *
1165
+ * @returns a javascript object which represents the `OlapModel` and which can be JSON stringified.
1166
+ */
1167
+ deserialize(): object;
1168
+ /**
1169
+ * Detaches event handler `fnFunction` from the {@link #event:metadataFailed metadataFailed} event of this
1170
+ * `sap.sac.df.olap.OlapModel`.
1171
+ *
1172
+ * The passed function and listener object must match the ones used for event registration.
1173
+ *
1174
+ * @returns Reference to `this` in order to allow method chaining
1175
+ */
1176
+ detachMetadataFailed(
1177
+ /**
1178
+ * The function to be called, when the event occurs
1179
+ */
1180
+ fnFunction: (p1: sap.ui.base.Event) => void,
1181
+ /**
1182
+ * Context object on which the given function had to be called
1183
+ */
1184
+ oListener?: object
1185
+ ): this;
1186
+ /**
1187
+ * Fires event {@link #event:metadataFailed metadataFailed} to attached listeners.
1188
+ *
1189
+ * @returns Reference to `this` in order to allow method chaining
1190
+ */
1191
+ fireMetadataFailed(
1192
+ /**
1193
+ * Parameters to pass along with the event
1194
+ */
1195
+ mParameters?: object
1196
+ ): this;
1197
+ /**
1198
+ * retrieves a `DataProvider` aggregated by the `OlapModel`. sQueryName, sSystem
1199
+ *
1200
+ * @returns the Data Provider that was requested
1201
+ */
1202
+ getDataProvider(
1203
+ /**
1204
+ * the name of the `DataProvider`.
1205
+ */
1206
+ sDataProviderName: string
1207
+ ): sap.sac.df.olap.DataProvider;
1208
+ /**
1209
+ * Let the user choose a value for a variable in a dialog
1210
+ *
1211
+ * @returns the selected value
1212
+ */
1213
+ openVariableSelector(
1214
+ /**
1215
+ * the name of the variable
1216
+ */
1217
+ sVar: string
1218
+ ): Promise<string>;
1219
+ /**
1220
+ * Reset the Olap Model to the default query
1221
+ */
1222
+ resetModel(): void;
1223
+ /**
1224
+ * serialize the Model with all aggregated `DataProvider` The `OlapModel` to be deserialized from an equivalent
1225
+ * such Object.
1226
+ *
1227
+ * @returns a javascript object which represents the `OlapModel`.
1228
+ */
1229
+ serialize(): object;
1230
+ /**
1231
+ * Replace all input enabled variables with their entered values for all data providers
1232
+ *
1233
+ * @returns the OlapModel, to allow chaining
1234
+ */
1235
+ submitVariables(): Promise<this>;
1236
+ /**
1237
+ * snychronize all aggregated dataproviders if the user does not choose an Analytic Query, then the promise
1238
+ * is rejected
1239
+ *
1240
+ * @returns the OlapModel, to allow chaining
1241
+ */
1242
+ synchronize(
1243
+ /**
1244
+ * List of data provider that are to be synchronized (all if not supplied)
1245
+ */
1246
+ aDataProviderNames: string[]
1247
+ ): Promise<sap.sac.df.olap.OlapModel>;
1248
+ /**
1249
+ * undoes the last navigation step.
1250
+ *
1251
+ * @returns the Olap Model
1252
+ */
1253
+ undo(): Promise<this>;
1254
+ }
1255
+ /**
1256
+ * Property binding implementation for `OlapModel`.
1257
+ */
1258
+ class OlapPropertyBinding extends sap.ui.model.ListBinding {
1259
+ /**
1260
+ * Creates a new OlapPropertyBinding.
1261
+ *
1262
+ * This constructor should only be called by subclasses or model implementations, not by application or
1263
+ * control code. Such code should use {@link sap.sac.df.olap.OlapModel#bindProperty OlapModel#bindProperty}
1264
+ * on the corresponding model instance instead.
1265
+ */
1266
+ constructor();
1267
+
1268
+ /**
1269
+ * Creates a new subclass of class sap.sac.df.olap.OlapPropertyBinding with name `sClassName` and enriches
1270
+ * it with the information contained in `oClassInfo`.
1271
+ *
1272
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
1273
+ *
1274
+ * @returns Created class / constructor function
1275
+ */
1276
+ static extend<T extends Record<string, unknown>>(
1277
+ /**
1278
+ * Name of the class being created
1279
+ */
1280
+ sClassName: string,
1281
+ /**
1282
+ * Object literal with information about the class
1283
+ */
1284
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapPropertyBinding>,
1285
+ /**
1286
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1287
+ * used by this class
1288
+ */
1289
+ FNMetaImpl?: Function
1290
+ ): Function;
1291
+ /**
1292
+ * Returns a metadata object for class sap.sac.df.olap.OlapPropertyBinding.
1293
+ *
1294
+ * @returns Metadata object describing this class
1295
+ */
1296
+ static getMetadata(): sap.ui.base.Metadata;
1297
+ }
1298
+ }
1299
+
1300
+ namespace types {
1301
+ /**
1302
+ * Types of navigation commands.
1303
+ */
1304
+ enum NavigationCommandType {
1305
+ /**
1306
+ * Click on a cell
1307
+ */
1308
+ CellClick = "CellClick",
1309
+ /**
1310
+ * request for additional columns
1311
+ */
1312
+ ColumnRequest = "ColumnRequest",
1313
+ /**
1314
+ * Context menu entry
1315
+ */
1316
+ ContextMenuCmd = "ContextMenuCmd",
1317
+ /**
1318
+ * Hierachy drill operation
1319
+ */
1320
+ HierarchyNavigation = "HierarchyNavigation",
1321
+ /**
1322
+ * request for additional rows
1323
+ */
1324
+ RowRequest = "RowRequest",
1325
+ }
1326
+ /**
1327
+ * System Type of an InA System
1328
+ */
1329
+ enum SystemType {
1330
+ /**
1331
+ * The ABAP analytic engine
1332
+ */
1333
+ ABAP_MDS = "ABAP_MDS",
1334
+ /**
1335
+ * The BW analytic engine
1336
+ */
1337
+ BW = "BW",
1338
+ /**
1339
+ * The Data Warehouce Cloud analytic engine
1340
+ */
1341
+ DWC = "DWC",
1342
+ /**
1343
+ * The HANA/MDS analytic engine
1344
+ */
1345
+ HANA = "HANA",
1346
+ /**
1347
+ * The in place WASABI Engine
1348
+ */
1349
+ WASABI = "WASABI",
1350
+ }
1351
+ }
1352
+
1353
+ interface $FlexAnalysisSettings extends sap.ui.core.$ControlSettings {
1354
+ /**
1355
+ * URI of the advanced configuration to be fetched
1356
+ */
1357
+ configurationURI?:
1358
+ | string
1359
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1360
+
1361
+ /**
1362
+ * alternative the Json Object to be used for configuration
1363
+ */
1364
+ configObject?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1365
+
1366
+ /**
1367
+ * Id of the DFModel to be used
1368
+ */
1369
+ kernelId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1370
+
1371
+ /**
1372
+ * Width of the component
1373
+ */
1374
+ width?:
1375
+ | sap.ui.core.CSSSize
1376
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1377
+ | `{${string}}`;
1378
+
1379
+ /**
1380
+ * Height of the component
1381
+ */
1382
+ height?:
1383
+ | sap.ui.core.CSSSize
1384
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1385
+ | `{${string}}`;
1386
+
1387
+ /**
1388
+ * Sets if the status bar of FlexAnalysis is hidden
1389
+ */
1390
+ hideStatusBar?:
1391
+ | boolean
1392
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1393
+ | `{${string}}`;
1394
+
1395
+ /**
1396
+ * Sets if the menu bar of FlexAnalysis is hidden
1397
+ */
1398
+ hideMenuBar?:
1399
+ | boolean
1400
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1401
+ | `{${string}}`;
1402
+
1403
+ /**
1404
+ * Sets if the toolbar of FlexAnalysis is hidden
1405
+ */
1406
+ hideToolBar?:
1407
+ | boolean
1408
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1409
+ | `{${string}}`;
1410
+
1411
+ /**
1412
+ * Additional Flag to be passed to the control TODO: Document the possibilities
1413
+ */
1414
+ environment?:
1415
+ | string[]
1416
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1417
+ | `{${string}}`;
1418
+
1419
+ /**
1420
+ * System to take data from. If not set or set to "local" current url will be used to determine the system
1421
+ */
1422
+ systemName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1423
+
1424
+ /**
1425
+ * Data source (Query name/ View, InA model etc) to be used to get the data from
1426
+ */
1427
+ dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1428
+
1429
+ /**
1430
+ * Type the system to connect to get data
1431
+ */
1432
+ systemType?:
1433
+ | sap.sac.df.types.SystemType
1434
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1435
+ | `{${string}}`;
1436
+
1437
+ /**
1438
+ * Interval to keep the InA session alive. values less than 1 deactivates the keep alive handling
1439
+ */
1440
+ keepAliveInterval?:
1441
+ | int
1442
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1443
+ | `{${string}}`;
1444
+
1445
+ /**
1446
+ * Client Identifier to be used for underlying InA queries
1447
+ */
1448
+ clientIdentifier?:
1449
+ | string
1450
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1451
+
1452
+ /**
1453
+ * Dataprovider for
1454
+ */
1455
+ dataProvider?:
1456
+ | any
1457
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1458
+ | `{${string}}`;
1459
+
1460
+ /**
1461
+ * Id of the MutliDeimModel to use
1462
+ */
1463
+ modelId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1464
+
1465
+ /**
1466
+ * event called when the query is updated
1467
+ */
1468
+ queryExecuted?: (oEvent: sap.ui.base.Event) => void;
1469
+ }
1470
+
1471
+ interface $PivotTableSettings extends sap.ui.core.$ControlSettings {
1472
+ /**
1473
+ * Name of the Data Provider within {sap.sac.df.olap.OlapModel} with name `om`, which is displayed and available
1474
+ * for interactions
1475
+ */
1476
+ dataProviderName?:
1477
+ | string
1478
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1479
+
1480
+ /**
1481
+ * Property for different table formats
1482
+ */
1483
+ format?:
1484
+ | sap.sac.grid.Format
1485
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1486
+ | `{${string}}`;
1487
+
1488
+ /**
1489
+ * Fired when a user launches a navigation command
1490
+ */
1491
+ navigationCmd?: (oEvent: sap.ui.base.Event) => void;
1492
+ }
1493
+
1494
+ /**
1495
+ * @EXPERIMENTAL
1496
+ *
1497
+ * Model implementation to access Firefly kernel
1498
+ */
1499
+ class DFKernel extends sap.ui.model.Model {
1500
+ /**
1501
+ * The DFKernel is a UI5 model which provides access to Firefly kernel - core infrastructure like processes,
1502
+ * connections and system definitions. This shared parts can be used by other Controls, Models and Components
1503
+ * provided by sap.sac-df library.
1504
+ */
1505
+ constructor();
1506
+
1507
+ /**
1508
+ * Creates a new subclass of class sap.sac.df.DFKernel with name `sClassName` and enriches it with the information
1509
+ * contained in `oClassInfo`.
1510
+ *
1511
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
1512
+ *
1513
+ * @returns Created class / constructor function
1514
+ */
1515
+ static extend<T extends Record<string, unknown>>(
1516
+ /**
1517
+ * Name of the class being created
1518
+ */
1519
+ sClassName: string,
1520
+ /**
1521
+ * Object literal with information about the class
1522
+ */
1523
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.DFKernel>,
1524
+ /**
1525
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1526
+ * used by this class
1527
+ */
1528
+ FNMetaImpl?: Function
1529
+ ): Function;
1530
+ /**
1531
+ * Returns a metadata object for class sap.sac.df.DFKernel.
1532
+ *
1533
+ * @returns Metadata object describing this class
1534
+ */
1535
+ static getMetadata(): sap.ui.base.Metadata;
1536
+ }
1537
+ /**
1538
+ * @EXPERIMENTAL
1539
+ *
1540
+ * Enables users to view, navigate and change multidimensional data exposed via InA.
1541
+ *
1542
+ * Overview:
1543
+ *
1544
+ * The user can view the data in a Table, navigate in the data via a context menu or builder panels The
1545
+ * data source that the FlexAnalysis consumes renders has to be provided as a property value.
1546
+ */
1547
+ class FlexAnalysis extends sap.ui.core.Control {
1548
+ /**
1549
+ * Constructor for a new `FlexAnalysis`.
1550
+ *
1551
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1552
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1553
+ * of the syntax of the settings object.
1554
+ */
1555
+ constructor(
1556
+ /**
1557
+ * ID for the new control, generated automatically if no ID is given
1558
+ */
1559
+ sId?: string
1560
+ );
1561
+
1562
+ /**
1563
+ * Creates a new subclass of class sap.sac.df.FlexAnalysis with name `sClassName` and enriches it with the
1564
+ * information contained in `oClassInfo`.
1565
+ *
1566
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1567
+ *
1568
+ * @returns Created class / constructor function
1569
+ */
1570
+ static extend<T extends Record<string, unknown>>(
1571
+ /**
1572
+ * Name of the class being created
1573
+ */
1574
+ sClassName: string,
1575
+ /**
1576
+ * Object literal with information about the class
1577
+ */
1578
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.FlexAnalysis>,
1579
+ /**
1580
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1581
+ * used by this class
1582
+ */
1583
+ FNMetaImpl?: Function
1584
+ ): Function;
1585
+ /**
1586
+ * Returns a metadata object for class sap.sac.df.FlexAnalysis.
1587
+ *
1588
+ * @returns Metadata object describing this class
1589
+ */
1590
+ static getMetadata(): sap.ui.core.ElementMetadata;
1591
+ /**
1592
+ * Attaches event handler `fnFunction` to the {@link #event:queryExecuted queryExecuted} event of this `sap.sac.df.FlexAnalysis`.
1593
+ *
1594
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1595
+ * otherwise it will be bound to this `sap.sac.df.FlexAnalysis` itself.
1596
+ *
1597
+ * event called when the query is updated
1598
+ *
1599
+ * @returns Reference to `this` in order to allow method chaining
1600
+ */
1601
+ attachQueryExecuted(
1602
+ /**
1603
+ * An application-specific payload object that will be passed to the event handler along with the event
1604
+ * object when firing the event
1605
+ */
1606
+ oData: object,
1607
+ /**
1608
+ * The function to be called when the event occurs
1609
+ */
1610
+ fnFunction: (p1: sap.ui.base.Event) => void,
1611
+ /**
1612
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FlexAnalysis` itself
1613
+ */
1614
+ oListener?: object
1615
+ ): this;
1616
+ /**
1617
+ * Attaches event handler `fnFunction` to the {@link #event:queryExecuted queryExecuted} event of this `sap.sac.df.FlexAnalysis`.
1618
+ *
1619
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1620
+ * otherwise it will be bound to this `sap.sac.df.FlexAnalysis` itself.
1621
+ *
1622
+ * event called when the query is updated
1623
+ *
1624
+ * @returns Reference to `this` in order to allow method chaining
1625
+ */
1626
+ attachQueryExecuted(
1627
+ /**
1628
+ * The function to be called when the event occurs
1629
+ */
1630
+ fnFunction: (p1: sap.ui.base.Event) => void,
1631
+ /**
1632
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FlexAnalysis` itself
1633
+ */
1634
+ oListener?: object
1635
+ ): this;
1636
+ /**
1637
+ * Binds property {@link #getDataProvider dataProvider} to model data.
1638
+ *
1639
+ * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
1640
+ * of the possible properties of `oBindingInfo`
1641
+ *
1642
+ * @returns Reference to `this` in order to allow method chaining
1643
+ */
1644
+ bindDataProvider(
1645
+ /**
1646
+ * The binding information
1647
+ */
1648
+ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo
1649
+ ): this;
1650
+ /**
1651
+ * Detaches event handler `fnFunction` from the {@link #event:queryExecuted queryExecuted} event of this
1652
+ * `sap.sac.df.FlexAnalysis`.
1653
+ *
1654
+ * The passed function and listener object must match the ones used for event registration.
1655
+ *
1656
+ * @returns Reference to `this` in order to allow method chaining
1657
+ */
1658
+ detachQueryExecuted(
1659
+ /**
1660
+ * The function to be called, when the event occurs
1661
+ */
1662
+ fnFunction: (p1: sap.ui.base.Event) => void,
1663
+ /**
1664
+ * Context object on which the given function had to be called
1665
+ */
1666
+ oListener?: object
1667
+ ): this;
1668
+ /**
1669
+ * Fires event {@link #event:queryExecuted queryExecuted} to attached listeners.
1670
+ *
1671
+ * @returns Reference to `this` in order to allow method chaining
1672
+ */
1673
+ fireQueryExecuted(
1674
+ /**
1675
+ * Parameters to pass along with the event
1676
+ */
1677
+ mParameters?: object
1678
+ ): this;
1679
+ /**
1680
+ * Gets current value of property {@link #getClientIdentifier clientIdentifier}.
1681
+ *
1682
+ * Client Identifier to be used for underlying InA queries
1683
+ *
1684
+ * @returns Value of property `clientIdentifier`
1685
+ */
1686
+ getClientIdentifier(): string;
1687
+ /**
1688
+ * Gets current value of property {@link #getConfigObject configObject}.
1689
+ *
1690
+ * alternative the Json Object to be used for configuration
1691
+ *
1692
+ * @returns Value of property `configObject`
1693
+ */
1694
+ getConfigObject(): string;
1695
+ /**
1696
+ * Gets current value of property {@link #getConfigurationURI configurationURI}.
1697
+ *
1698
+ * URI of the advanced configuration to be fetched
1699
+ *
1700
+ * @returns Value of property `configurationURI`
1701
+ */
1702
+ getConfigurationURI(): string;
1703
+ /**
1704
+ * Gets current value of property {@link #getDataProvider dataProvider}.
1705
+ *
1706
+ * Dataprovider for
1707
+ *
1708
+ * @returns Value of property `dataProvider`
1709
+ */
1710
+ getDataProvider(): any;
1711
+ /**
1712
+ * Gets current value of property {@link #getDataSource dataSource}.
1713
+ *
1714
+ * Data source (Query name/ View, InA model etc) to be used to get the data from
1715
+ *
1716
+ * Default value is `"$datasource"`.
1717
+ *
1718
+ * @returns Value of property `dataSource`
1719
+ */
1720
+ getDataSource(): string;
1721
+ /**
1722
+ * Gets current value of property {@link #getEnvironment environment}.
1723
+ *
1724
+ * Additional Flag to be passed to the control TODO: Document the possibilities
1725
+ *
1726
+ * Default value is `[]`.
1727
+ *
1728
+ * @returns Value of property `environment`
1729
+ */
1730
+ getEnvironment(): string[];
1731
+ /**
1732
+ * Gets current value of property {@link #getHeight height}.
1733
+ *
1734
+ * Height of the component
1735
+ *
1736
+ * Default value is `"100%"`.
1737
+ *
1738
+ * @returns Value of property `height`
1739
+ */
1740
+ getHeight(): sap.ui.core.CSSSize;
1741
+ /**
1742
+ * Gets current value of property {@link #getHideMenuBar hideMenuBar}.
1743
+ *
1744
+ * Sets if the menu bar of FlexAnalysis is hidden
1745
+ *
1746
+ * Default value is `true`.
1747
+ *
1748
+ * @returns Value of property `hideMenuBar`
1749
+ */
1750
+ getHideMenuBar(): boolean;
1751
+ /**
1752
+ * Gets current value of property {@link #getHideStatusBar hideStatusBar}.
1753
+ *
1754
+ * Sets if the status bar of FlexAnalysis is hidden
1755
+ *
1756
+ * Default value is `true`.
1757
+ *
1758
+ * @returns Value of property `hideStatusBar`
1759
+ */
1760
+ getHideStatusBar(): boolean;
1761
+ /**
1762
+ * Gets current value of property {@link #getHideToolBar hideToolBar}.
1763
+ *
1764
+ * Sets if the toolbar of FlexAnalysis is hidden
1765
+ *
1766
+ * Default value is `true`.
1767
+ *
1768
+ * @returns Value of property `hideToolBar`
1769
+ */
1770
+ getHideToolBar(): boolean;
1771
+ /**
1772
+ * Gets current value of property {@link #getKeepAliveInterval keepAliveInterval}.
1773
+ *
1774
+ * Interval to keep the InA session alive. values less than 1 deactivates the keep alive handling
1775
+ *
1776
+ * Default value is `0`.
1777
+ *
1778
+ * @returns Value of property `keepAliveInterval`
1779
+ */
1780
+ getKeepAliveInterval(): int;
1781
+ /**
1782
+ * Gets current value of property {@link #getKernelId kernelId}.
1783
+ *
1784
+ * Id of the DFModel to be used
1785
+ *
1786
+ * Default value is `"dfk"`.
1787
+ *
1788
+ * @returns Value of property `kernelId`
1789
+ */
1790
+ getKernelId(): string;
1791
+ /**
1792
+ * Gets current value of property {@link #getModelId modelId}.
1793
+ *
1794
+ * Id of the MutliDeimModel to use
1795
+ *
1796
+ * Default value is `"om"`.
1797
+ *
1798
+ * @returns Value of property `modelId`
1799
+ */
1800
+ getModelId(): string;
1801
+ /**
1802
+ * Gets current value of property {@link #getSystemName systemName}.
1803
+ *
1804
+ * System to take data from. If not set or set to "local" current url will be used to determine the system
1805
+ *
1806
+ * Default value is `"local"`.
1807
+ *
1808
+ * @returns Value of property `systemName`
1809
+ */
1810
+ getSystemName(): string;
1811
+ /**
1812
+ * Gets current value of property {@link #getSystemType systemType}.
1813
+ *
1814
+ * Type the system to connect to get data
1815
+ *
1816
+ * Default value is `BW`.
1817
+ *
1818
+ * @returns Value of property `systemType`
1819
+ */
1820
+ getSystemType(): sap.sac.df.types.SystemType;
1821
+ /**
1822
+ * Gets current value of property {@link #getWidth width}.
1823
+ *
1824
+ * Width of the component
1825
+ *
1826
+ * Default value is `"100%"`.
1827
+ *
1828
+ * @returns Value of property `width`
1829
+ */
1830
+ getWidth(): sap.ui.core.CSSSize;
1831
+ /**
1832
+ * Sets a new value for property {@link #getClientIdentifier clientIdentifier}.
1833
+ *
1834
+ * Client Identifier to be used for underlying InA queries
1835
+ *
1836
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1837
+ *
1838
+ * @returns Reference to `this` in order to allow method chaining
1839
+ */
1840
+ setClientIdentifier(
629
1841
  /**
630
- * Let the user choose a value for a variable in a dialog
1842
+ * New value for property `clientIdentifier`
631
1843
  */
632
- openVariableSelector(
633
- /**
634
- * the name of the variable
635
- */
636
- sVar: string
637
- ): Promise<string>;
1844
+ sClientIdentifier: string
1845
+ ): this;
1846
+ /**
1847
+ * Sets a new value for property {@link #getConfigObject configObject}.
1848
+ *
1849
+ * alternative the Json Object to be used for configuration
1850
+ *
1851
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1852
+ *
1853
+ * @returns Reference to `this` in order to allow method chaining
1854
+ */
1855
+ setConfigObject(
638
1856
  /**
639
- * Reset the Olap Model to the default query
1857
+ * New value for property `configObject`
640
1858
  */
641
- resetModel(): void;
1859
+ sConfigObject: string
1860
+ ): this;
1861
+ /**
1862
+ * Sets a new value for property {@link #getConfigurationURI configurationURI}.
1863
+ *
1864
+ * URI of the advanced configuration to be fetched
1865
+ *
1866
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1867
+ *
1868
+ * @returns Reference to `this` in order to allow method chaining
1869
+ */
1870
+ setConfigurationURI(
642
1871
  /**
643
- * serialize the Model with all aggregated `DataProvider` The `OlapModel` to be deserialized from an equivalent
644
- * such Object.
1872
+ * New value for property `configurationURI`
645
1873
  */
646
- serialize(): object;
1874
+ sConfigurationURI: string
1875
+ ): this;
1876
+ /**
1877
+ * Sets a new value for property {@link #getDataProvider dataProvider}.
1878
+ *
1879
+ * Dataprovider for
1880
+ *
1881
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1882
+ *
1883
+ * @returns Reference to `this` in order to allow method chaining
1884
+ */
1885
+ setDataProvider(
647
1886
  /**
648
- * Replace all input enabled variables with their entered values for all data providers
1887
+ * New value for property `dataProvider`
649
1888
  */
650
- submitVariables(): Promise<this>;
1889
+ oDataProvider: any
1890
+ ): this;
1891
+ /**
1892
+ * Sets a new value for property {@link #getDataSource dataSource}.
1893
+ *
1894
+ * Data source (Query name/ View, InA model etc) to be used to get the data from
1895
+ *
1896
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1897
+ *
1898
+ * Default value is `"$datasource"`.
1899
+ *
1900
+ * @returns Reference to `this` in order to allow method chaining
1901
+ */
1902
+ setDataSource(
651
1903
  /**
652
- * snychronize all aggregated dataproviders if the user does not choose an Analytic Query, then the promise
653
- * is rejected
1904
+ * New value for property `dataSource`
654
1905
  */
655
- synchronize(
656
- /**
657
- * List of data provider that are to be synchronized (all if not supplied)
658
- */
659
- aDataProviderNames: string[]
660
- ): Promise<sap.sac.df.olap.OlapModel>;
1906
+ sDataSource?: string
1907
+ ): this;
1908
+ /**
1909
+ * Sets a new value for property {@link #getEnvironment environment}.
1910
+ *
1911
+ * Additional Flag to be passed to the control TODO: Document the possibilities
1912
+ *
1913
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1914
+ *
1915
+ * Default value is `[]`.
1916
+ *
1917
+ * @returns Reference to `this` in order to allow method chaining
1918
+ */
1919
+ setEnvironment(
661
1920
  /**
662
- * undoes the last navigation step.
1921
+ * New value for property `environment`
663
1922
  */
664
- undo(): Promise<this>;
665
- }
1923
+ sEnvironment?: string[]
1924
+ ): this;
666
1925
  /**
667
- * Property binding implementation for `OlapModel`.
1926
+ * Sets a new value for property {@link #getHeight height}.
1927
+ *
1928
+ * Height of the component
1929
+ *
1930
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1931
+ *
1932
+ * Default value is `"100%"`.
1933
+ *
1934
+ * @returns Reference to `this` in order to allow method chaining
668
1935
  */
669
- class OlapPropertyBinding extends sap.ui.model.ListBinding {
1936
+ setHeight(
670
1937
  /**
671
- * Creates a new OlapPropertyBinding.
672
- *
673
- * This constructor should only be called by subclasses or model implementations, not by application or
674
- * control code. Such code should use {@link sap.sac.df.olap.OlapModel#bindProperty OlapModel#bindProperty}
675
- * on the corresponding model instance instead.
1938
+ * New value for property `height`
676
1939
  */
677
- constructor();
678
-
1940
+ sHeight?: sap.ui.core.CSSSize
1941
+ ): this;
1942
+ /**
1943
+ * Sets a new value for property {@link #getHideMenuBar hideMenuBar}.
1944
+ *
1945
+ * Sets if the menu bar of FlexAnalysis is hidden
1946
+ *
1947
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1948
+ *
1949
+ * Default value is `true`.
1950
+ *
1951
+ * @returns Reference to `this` in order to allow method chaining
1952
+ */
1953
+ setHideMenuBar(
679
1954
  /**
680
- * Creates a new subclass of class sap.sac.df.olap.OlapPropertyBinding with name `sClassName` and enriches
681
- * it with the information contained in `oClassInfo`.
682
- *
683
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
1955
+ * New value for property `hideMenuBar`
684
1956
  */
685
- static extend<T extends Record<string, unknown>>(
686
- /**
687
- * Name of the class being created
688
- */
689
- sClassName: string,
690
- /**
691
- * Object literal with information about the class
692
- */
693
- oClassInfo?: sap.ClassInfo<T, sap.sac.df.olap.OlapPropertyBinding>,
694
- /**
695
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
696
- * used by this class
697
- */
698
- FNMetaImpl?: Function
699
- ): Function;
1957
+ bHideMenuBar?: boolean
1958
+ ): this;
1959
+ /**
1960
+ * Sets a new value for property {@link #getHideStatusBar hideStatusBar}.
1961
+ *
1962
+ * Sets if the status bar of FlexAnalysis is hidden
1963
+ *
1964
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1965
+ *
1966
+ * Default value is `true`.
1967
+ *
1968
+ * @returns Reference to `this` in order to allow method chaining
1969
+ */
1970
+ setHideStatusBar(
700
1971
  /**
701
- * Returns a metadata object for class sap.sac.df.olap.OlapPropertyBinding.
1972
+ * New value for property `hideStatusBar`
702
1973
  */
703
- static getMetadata(): sap.ui.base.Metadata;
704
- }
705
- }
706
-
707
- namespace types {
1974
+ bHideStatusBar?: boolean
1975
+ ): this;
708
1976
  /**
709
- * Types of navigation commands.
1977
+ * Sets a new value for property {@link #getHideToolBar hideToolBar}.
1978
+ *
1979
+ * Sets if the toolbar of FlexAnalysis is hidden
1980
+ *
1981
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1982
+ *
1983
+ * Default value is `true`.
1984
+ *
1985
+ * @returns Reference to `this` in order to allow method chaining
710
1986
  */
711
- enum NavigationCommandType {
1987
+ setHideToolBar(
712
1988
  /**
713
- * Click on a cell
1989
+ * New value for property `hideToolBar`
714
1990
  */
715
- CellClick = "CellClick",
1991
+ bHideToolBar?: boolean
1992
+ ): this;
1993
+ /**
1994
+ * Sets a new value for property {@link #getKeepAliveInterval keepAliveInterval}.
1995
+ *
1996
+ * Interval to keep the InA session alive. values less than 1 deactivates the keep alive handling
1997
+ *
1998
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1999
+ *
2000
+ * Default value is `0`.
2001
+ *
2002
+ * @returns Reference to `this` in order to allow method chaining
2003
+ */
2004
+ setKeepAliveInterval(
716
2005
  /**
717
- * request for additional columns
2006
+ * New value for property `keepAliveInterval`
718
2007
  */
719
- ColumnRequest = "ColumnRequest",
2008
+ iKeepAliveInterval?: int
2009
+ ): this;
2010
+ /**
2011
+ * Sets a new value for property {@link #getKernelId kernelId}.
2012
+ *
2013
+ * Id of the DFModel to be used
2014
+ *
2015
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2016
+ *
2017
+ * Default value is `"dfk"`.
2018
+ *
2019
+ * @returns Reference to `this` in order to allow method chaining
2020
+ */
2021
+ setKernelId(
720
2022
  /**
721
- * Context menu entry
2023
+ * New value for property `kernelId`
722
2024
  */
723
- ContextMenuCmd = "ContextMenuCmd",
2025
+ sKernelId?: string
2026
+ ): this;
2027
+ /**
2028
+ * Sets a new value for property {@link #getModelId modelId}.
2029
+ *
2030
+ * Id of the MutliDeimModel to use
2031
+ *
2032
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2033
+ *
2034
+ * Default value is `"om"`.
2035
+ *
2036
+ * @returns Reference to `this` in order to allow method chaining
2037
+ */
2038
+ setModelId(
724
2039
  /**
725
- * Hierachy drill operation
2040
+ * New value for property `modelId`
726
2041
  */
727
- HierarchyNavigation = "HierarchyNavigation",
2042
+ sModelId?: string
2043
+ ): this;
2044
+ /**
2045
+ * Sets a new value for property {@link #getSystemName systemName}.
2046
+ *
2047
+ * System to take data from. If not set or set to "local" current url will be used to determine the system
2048
+ *
2049
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2050
+ *
2051
+ * Default value is `"local"`.
2052
+ *
2053
+ * @returns Reference to `this` in order to allow method chaining
2054
+ */
2055
+ setSystemName(
728
2056
  /**
729
- * request for additional rows
2057
+ * New value for property `systemName`
730
2058
  */
731
- RowRequest = "RowRequest",
732
- }
733
- }
734
-
735
- interface $PivotTableSettings extends sap.ui.core.$ControlSettings {
2059
+ sSystemName?: string
2060
+ ): this;
736
2061
  /**
737
- * Name of the Data Provider within {sap.sac.df.olap.OlapModel} with name `om`, which is displayed and available
738
- * for interactions
2062
+ * Sets a new value for property {@link #getSystemType systemType}.
2063
+ *
2064
+ * Type the system to connect to get data
2065
+ *
2066
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2067
+ *
2068
+ * Default value is `BW`.
2069
+ *
2070
+ * @returns Reference to `this` in order to allow method chaining
739
2071
  */
740
- dataProviderName?:
741
- | string
742
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
743
-
2072
+ setSystemType(
2073
+ /**
2074
+ * New value for property `systemType`
2075
+ */
2076
+ sSystemType?: sap.sac.df.types.SystemType
2077
+ ): this;
744
2078
  /**
745
- * Property for different table formats
2079
+ * Sets a new value for property {@link #getWidth width}.
2080
+ *
2081
+ * Width of the component
2082
+ *
2083
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2084
+ *
2085
+ * Default value is `"100%"`.
2086
+ *
2087
+ * @returns Reference to `this` in order to allow method chaining
746
2088
  */
747
- format?:
748
- | sap.sac.grid.Format
749
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
750
-
2089
+ setWidth(
2090
+ /**
2091
+ * New value for property `width`
2092
+ */
2093
+ sWidth?: sap.ui.core.CSSSize
2094
+ ): this;
751
2095
  /**
752
- * Fired when a user launches a navigation command
2096
+ * Unbinds property {@link #getDataProvider dataProvider} from model data.
2097
+ *
2098
+ * @returns Reference to `this` in order to allow method chaining
753
2099
  */
754
- navigationCmd?: (oEvent: sap.ui.base.Event) => void;
2100
+ unbindDataProvider(): this;
755
2101
  }
756
-
757
2102
  /**
2103
+ * @EXPERIMENTAL
2104
+ *
758
2105
  * Enables users to view, navigate and change multidimensional data exposed via InA in a PivotTable.
759
2106
  *
760
2107
  * Overview:
@@ -805,6 +2152,8 @@ declare namespace sap {
805
2152
  * information contained in `oClassInfo`.
806
2153
  *
807
2154
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2155
+ *
2156
+ * @returns Created class / constructor function
808
2157
  */
809
2158
  static extend<T extends Record<string, unknown>>(
810
2159
  /**
@@ -823,6 +2172,8 @@ declare namespace sap {
823
2172
  ): Function;
824
2173
  /**
825
2174
  * Returns a metadata object for class sap.sac.df.PivotTable.
2175
+ *
2176
+ * @returns Metadata object describing this class
826
2177
  */
827
2178
  static getMetadata(): sap.ui.core.ElementMetadata;
828
2179
  /**
@@ -832,6 +2183,8 @@ declare namespace sap {
832
2183
  * otherwise it will be bound to this `sap.sac.df.PivotTable` itself.
833
2184
  *
834
2185
  * Fired when a user launches a navigation command
2186
+ *
2187
+ * @returns Reference to `this` in order to allow method chaining
835
2188
  */
836
2189
  attachNavigationCmd(
837
2190
  /**
@@ -855,6 +2208,8 @@ declare namespace sap {
855
2208
  * otherwise it will be bound to this `sap.sac.df.PivotTable` itself.
856
2209
  *
857
2210
  * Fired when a user launches a navigation command
2211
+ *
2212
+ * @returns Reference to `this` in order to allow method chaining
858
2213
  */
859
2214
  attachNavigationCmd(
860
2215
  /**
@@ -871,6 +2226,8 @@ declare namespace sap {
871
2226
  * `sap.sac.df.PivotTable`.
872
2227
  *
873
2228
  * The passed function and listener object must match the ones used for event registration.
2229
+ *
2230
+ * @returns Reference to `this` in order to allow method chaining
874
2231
  */
875
2232
  detachNavigationCmd(
876
2233
  /**
@@ -884,6 +2241,8 @@ declare namespace sap {
884
2241
  ): this;
885
2242
  /**
886
2243
  * Fires event {@link #event:navigationCmd navigationCmd} to attached listeners.
2244
+ *
2245
+ * @returns Reference to `this` in order to allow method chaining
887
2246
  */
888
2247
  fireNavigationCmd(
889
2248
  /**
@@ -916,6 +2275,8 @@ declare namespace sap {
916
2275
  * for interactions
917
2276
  *
918
2277
  * Default value is `"0"`.
2278
+ *
2279
+ * @returns Value of property `dataProviderName`
919
2280
  */
920
2281
  getDataProviderName(): string;
921
2282
  /**
@@ -924,6 +2285,8 @@ declare namespace sap {
924
2285
  * Property for different table formats
925
2286
  *
926
2287
  * Default value is `ExcelStyle`.
2288
+ *
2289
+ * @returns Value of property `format`
927
2290
  */
928
2291
  getFormat(): sap.sac.grid.Format;
929
2292
  /**
@@ -935,6 +2298,8 @@ declare namespace sap {
935
2298
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
936
2299
  *
937
2300
  * Default value is `"0"`.
2301
+ *
2302
+ * @returns Reference to `this` in order to allow method chaining
938
2303
  */
939
2304
  setDataProviderName(
940
2305
  /**
@@ -950,6 +2315,8 @@ declare namespace sap {
950
2315
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
951
2316
  *
952
2317
  * Default value is `ExcelStyle`.
2318
+ *
2319
+ * @returns Reference to `this` in order to allow method chaining
953
2320
  */
954
2321
  setFormat(
955
2322
  /**
@@ -962,10 +2329,18 @@ declare namespace sap {
962
2329
  }
963
2330
 
964
2331
  interface IUI5DefineDependencyNames {
2332
+ "sap/sac/df/DFKernel": undefined;
2333
+
2334
+ "sap/sac/df/FlexAnalysis": undefined;
2335
+
965
2336
  "sap/sac/df/library": undefined;
966
2337
 
967
2338
  "sap/sac/df/olap/DataProvider": undefined;
968
2339
 
2340
+ "sap/sac/df/olap/MultiDimDataProvider": undefined;
2341
+
2342
+ "sap/sac/df/olap/MultiDimModel": undefined;
2343
+
969
2344
  "sap/sac/df/olap/OlapListBinding": undefined;
970
2345
 
971
2346
  "sap/sac/df/olap/OlapListGridBinding": undefined;
@@ -977,5 +2352,7 @@ declare namespace sap {
977
2352
  "sap/sac/df/PivotTable": undefined;
978
2353
 
979
2354
  "sap/sac/df/types/NavigationCommandType": undefined;
2355
+
2356
+ "sap/sac/df/types/SystemType": undefined;
980
2357
  }
981
2358
  }