@sapui5/ts-types 1.120.8 → 1.121.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 (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +50 -18
  4. package/types/sap.ca.ui.d.ts +1114 -546
  5. package/types/sap.chart.d.ts +17 -1
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1960
  8. package/types/sap.f.d.ts +124 -45
  9. package/types/sap.fe.core.d.ts +212 -191
  10. package/types/sap.fe.macros.d.ts +371 -531
  11. package/types/sap.fe.navigation.d.ts +59 -26
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +7 -0
  14. package/types/sap.fe.templates.d.ts +16 -11
  15. package/types/sap.fe.test.d.ts +333 -33
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +3947 -1754
  19. package/types/sap.insights.d.ts +162 -43
  20. package/types/sap.m.d.ts +2023 -289
  21. package/types/sap.makit.d.ts +11 -1
  22. package/types/sap.me.d.ts +7 -1
  23. package/types/sap.ndc.d.ts +1 -1
  24. package/types/sap.ovp.d.ts +9 -7
  25. package/types/sap.rules.ui.d.ts +134 -75
  26. package/types/sap.sac.df.d.ts +272 -49
  27. package/types/sap.suite.ui.commons.d.ts +4231 -1008
  28. package/types/sap.suite.ui.generic.template.d.ts +38 -48
  29. package/types/sap.suite.ui.microchart.d.ts +66 -1
  30. package/types/sap.tnt.d.ts +601 -116
  31. package/types/sap.ui.codeeditor.d.ts +10 -6
  32. package/types/sap.ui.commons.d.ts +86 -8
  33. package/types/sap.ui.comp.d.ts +259 -110
  34. package/types/sap.ui.core.d.ts +471 -186
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +16 -3
  37. package/types/sap.ui.fl.d.ts +91 -68
  38. package/types/sap.ui.generic.app.d.ts +250 -193
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +51 -4
  41. package/types/sap.ui.layout.d.ts +221 -26
  42. package/types/sap.ui.mdc.d.ts +1516 -787
  43. package/types/sap.ui.richtexteditor.d.ts +4 -1
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +3 -1
  46. package/types/sap.ui.support.d.ts +28 -4
  47. package/types/sap.ui.table.d.ts +65 -11
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +157 -54
  50. package/types/sap.ui.ux3.d.ts +30 -12
  51. package/types/sap.ui.vbm.d.ts +5300 -2517
  52. package/types/sap.ui.vk.d.ts +2742 -836
  53. package/types/sap.ui.vtm.d.ts +685 -215
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +49 -1
  56. package/types/sap.ui.webc.main.d.ts +144 -9
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +977 -535
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +55 -5
  61. package/types/sap.viz.d.ts +86 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +79 -18
  64. package/types/sap.zen.crosstab.d.ts +83 -15
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,12 +1,12 @@
1
- // For Library Version: 1.120.3
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace sac {
5
5
  /**
6
- * @experimental
7
- *
8
6
  * Dragonfly Library. Provides models and control to access Multidimensional Data via InA protocol and Firefly
9
7
  * library
8
+ *
9
+ * @experimental
10
10
  */
11
11
  namespace df {
12
12
  namespace changeHandler {
@@ -14,14 +14,14 @@ declare namespace sap {
14
14
  extends sap.ui.mdc.$ControlSettings {}
15
15
 
16
16
  /**
17
- * @since 1.120
18
- * @experimental (since 1.120)
19
- *
20
17
  * Control to handle changes of {@link sap.sac.df.model.MultiDimModel }. To store the changes in {@link sap.ui.fl.variants.VariantManagement }
21
18
  * you need to include this change handler control as a dependent somewhere in the view tree for which the
22
19
  * variant management is responsible. Each time the event `requestCompleted` is fired a new change will
23
20
  * be created. The method `registerMultiDimModel` needs to be called once to register the {@link sap.sac.df.model.MultiDimModel }
24
21
  * to the change handler.
22
+ *
23
+ * @since 1.120
24
+ * @experimental (since 1.120)
25
25
  */
26
26
  class MultiDimModelChangeHandler extends sap.ui.mdc.Control {
27
27
  /**
@@ -40,6 +40,7 @@ declare namespace sap {
40
40
  *
41
41
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.Control.extend}.
42
42
  *
43
+ *
43
44
  * @returns Created class / constructor function
44
45
  */
45
46
  static extend<T extends Record<string, unknown>>(
@@ -63,6 +64,7 @@ declare namespace sap {
63
64
  /**
64
65
  * Returns a metadata object for class sap.sac.df.changeHandler.MultiDimModelChangeHandler.
65
66
  *
67
+ *
66
68
  * @returns Metadata object describing this class
67
69
  */
68
70
  static getMetadata(): sap.ui.core.ElementMetadata;
@@ -89,9 +91,6 @@ declare namespace sap {
89
91
  interface MultiDimModel$LoadedEventParameters {}
90
92
 
91
93
  /**
92
- * @since 1.119
93
- * @experimental (since 1.119)
94
- *
95
94
  * Axis Layout showing which dimensions are set on rows and which on columns.
96
95
  *
97
96
  * **Structure of Exposed Data:**
@@ -100,9 +99,16 @@ declare namespace sap {
100
99
  * "Rows": [],
101
100
  * "Columns": []
102
101
  * ```
102
+ *
103
+ *
104
+ * @since 1.119
105
+ * @experimental (since 1.119)
103
106
  */
104
107
  class AxesLayout extends sap.ui.base.Object {
105
- constructor();
108
+ /**
109
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
110
+ */
111
+ protected constructor();
106
112
 
107
113
  /**
108
114
  * Creates a new subclass of class sap.sac.df.model.AxesLayout with name `sClassName` and enriches it with
@@ -110,6 +116,7 @@ declare namespace sap {
110
116
  *
111
117
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
112
118
  *
119
+ *
113
120
  * @returns Created class / constructor function
114
121
  */
115
122
  static extend<T extends Record<string, unknown>>(
@@ -130,12 +137,14 @@ declare namespace sap {
130
137
  /**
131
138
  * Returns a metadata object for class sap.sac.df.model.AxesLayout.
132
139
  *
140
+ *
133
141
  * @returns Metadata object describing this class
134
142
  */
135
143
  static getMetadata(): sap.ui.base.Metadata;
136
144
  /**
137
145
  * Distribute the dimension among the rows and columns
138
146
  *
147
+ *
139
148
  * @returns resolving to the axes layout object to allow chaining
140
149
  */
141
150
  setAxesLayout(
@@ -152,9 +161,6 @@ declare namespace sap {
152
161
  ): sap.sac.df.model.AxesLayout;
153
162
  }
154
163
  /**
155
- * @since 1.119
156
- * @experimental (since 1.119)
157
- *
158
164
  * A data provider is an analytical query exposed via an analytical engine and accessed via InA protocol.
159
165
  * It represents a navigable query manager and allows to access and change data. Instances of this class
160
166
  * should only be created by the {@link sap.sac.df.model.MultiDimModel}.
@@ -174,9 +180,16 @@ declare namespace sap {
174
180
  * "Grid": { },
175
181
  * "Messages": [ ]
176
182
  * ```
183
+ *
184
+ *
185
+ * @since 1.119
186
+ * @experimental (since 1.119)
177
187
  */
178
188
  class DataProvider extends sap.ui.base.Object {
179
- constructor();
189
+ /**
190
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
191
+ */
192
+ protected constructor();
180
193
  /**
181
194
  * AxesLayout
182
195
  */
@@ -213,6 +226,7 @@ declare namespace sap {
213
226
  *
214
227
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
215
228
  *
229
+ *
216
230
  * @returns Created class / constructor function
217
231
  */
218
232
  static extend<T extends Record<string, unknown>>(
@@ -233,12 +247,14 @@ declare namespace sap {
233
247
  /**
234
248
  * Returns a metadata object for class sap.sac.df.model.DataProvider.
235
249
  *
250
+ *
236
251
  * @returns Metadata object describing this class
237
252
  */
238
253
  static getMetadata(): sap.ui.base.Metadata;
239
254
  /**
240
255
  * Updates the multidimensional model from the given the state of a data provider
241
256
  *
257
+ *
242
258
  * @returns Promise with reference to this in order to allow method chaining
243
259
  */
244
260
  deserialize(
@@ -267,18 +283,21 @@ declare namespace sap {
267
283
  /**
268
284
  * Get axis Layout
269
285
  *
286
+ *
270
287
  * @returns Axis layout object
271
288
  */
272
289
  getAxesLayout(): sap.sac.df.model.AxesLayout;
273
290
  /**
274
291
  * Get data source information
275
292
  *
293
+ *
276
294
  * @returns data source information object
277
295
  */
278
296
  getDataSourceInfo(): sap.sac.df.model.DataSourceInfo;
279
297
  /**
280
298
  * Get the scaling factor of a measure or cell
281
299
  *
300
+ *
282
301
  * @returns Number of decimal places
283
302
  */
284
303
  getDecimalPlaces(
@@ -294,6 +313,7 @@ declare namespace sap {
294
313
  /**
295
314
  * Get Dimension
296
315
  *
316
+ *
297
317
  * @returns Dimension object
298
318
  */
299
319
  getDimension(
@@ -305,18 +325,21 @@ declare namespace sap {
305
325
  /**
306
326
  * Get all dimensions
307
327
  *
328
+ *
308
329
  * @returns Object of all dimensions
309
330
  */
310
331
  getDimensions(): Record<string, sap.sac.df.model.Dimension>;
311
332
  /**
312
333
  * Get Grid
313
334
  *
335
+ *
314
336
  * @returns Grid object
315
337
  */
316
338
  getGrid(): sap.sac.df.model.Grid;
317
339
  /**
318
340
  * Get measure
319
341
  *
342
+ *
320
343
  * @returns Measure object
321
344
  */
322
345
  getMeasure(
@@ -328,12 +351,14 @@ declare namespace sap {
328
351
  /**
329
352
  * Get all measures
330
353
  *
354
+ *
331
355
  * @returns Object of all measures
332
356
  */
333
357
  getMeasures(): /* was: sap.sac.df.model.Measure */ any;
334
358
  /**
335
359
  * Get Measure Structure Dimension
336
360
  *
361
+ *
337
362
  * @returns Measure structure dimension
338
363
  */
339
364
  getMeasureStructureDimension(): sap.sac.df.model.Dimension;
@@ -349,6 +374,7 @@ declare namespace sap {
349
374
  /**
350
375
  * Get the scaling factor of a measure or cell
351
376
  *
377
+ *
352
378
  * @returns Scaling factor
353
379
  */
354
380
  getScalingFactor(
@@ -364,12 +390,14 @@ declare namespace sap {
364
390
  /**
365
391
  * Get structure (non-measure) dimension
366
392
  *
393
+ *
367
394
  * @returns Structure dimension object
368
395
  */
369
396
  getStructureDimension(): sap.sac.df.model.Dimension;
370
397
  /**
371
398
  * Get Variable
372
399
  *
400
+ *
373
401
  * @returns Variable object
374
402
  */
375
403
  getVariable(
@@ -381,12 +409,14 @@ declare namespace sap {
381
409
  /**
382
410
  * Get all variables
383
411
  *
412
+ *
384
413
  * @returns Object of all variables
385
414
  */
386
415
  getVariables(): Record<string, sap.sac.df.model.Variable>;
387
416
  /**
388
417
  * Serialize the data provider state to a JSON representation
389
418
  *
419
+ *
390
420
  * @returns A JSON object which represents the data provider
391
421
  */
392
422
  serialize(
@@ -398,6 +428,7 @@ declare namespace sap {
398
428
  /**
399
429
  * Set the number of decimal places of a measure or cell
400
430
  *
431
+ *
401
432
  * @returns Reference to this in order to allow method chaining
402
433
  */
403
434
  setDecimalPlaces(
@@ -417,6 +448,7 @@ declare namespace sap {
417
448
  /**
418
449
  * Set the scaling factor of a measure or cell
419
450
  *
451
+ *
420
452
  * @returns Reference to this in order to allow method chaining
421
453
  */
422
454
  setScalingFactor(
@@ -437,6 +469,7 @@ declare namespace sap {
437
469
  * Checks whether an InA capability is supported by the server. Throws an error for unhandled capabilities.
438
470
  * List of handled capabilities can be seen in type {@link sap.sac.df.model.Capability}
439
471
  *
472
+ *
440
473
  * @returns Returns true, if the capability is supported, else false
441
474
  */
442
475
  supportsCapability(
@@ -447,9 +480,6 @@ declare namespace sap {
447
480
  ): boolean;
448
481
  }
449
482
  /**
450
- * @since 1.119
451
- * @experimental (since 1.119)
452
- *
453
483
  * Data source information.
454
484
  *
455
485
  * **Structure of Exposed Data:**
@@ -470,9 +500,16 @@ declare namespace sap {
470
500
  * "LastUpdatedBy": "",
471
501
  * "LastUpdatedText": ""
472
502
  * ```
503
+ *
504
+ *
505
+ * @since 1.119
506
+ * @experimental (since 1.119)
473
507
  */
474
508
  class DataSourceInfo extends sap.ui.base.Object {
475
- constructor();
509
+ /**
510
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
511
+ */
512
+ protected constructor();
476
513
 
477
514
  /**
478
515
  * Creates a new subclass of class sap.sac.df.model.DataSourceInfo with name `sClassName` and enriches it
@@ -480,6 +517,7 @@ declare namespace sap {
480
517
  *
481
518
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
482
519
  *
520
+ *
483
521
  * @returns Created class / constructor function
484
522
  */
485
523
  static extend<T extends Record<string, unknown>>(
@@ -500,14 +538,12 @@ declare namespace sap {
500
538
  /**
501
539
  * Returns a metadata object for class sap.sac.df.model.DataSourceInfo.
502
540
  *
541
+ *
503
542
  * @returns Metadata object describing this class
504
543
  */
505
544
  static getMetadata(): sap.ui.base.Metadata;
506
545
  }
507
546
  /**
508
- * @since 1.119
509
- * @experimental (since 1.119)
510
- *
511
547
  * Dimension Object
512
548
  *
513
549
  * **Structure of Exposed Data:**
@@ -536,9 +572,16 @@ declare namespace sap {
536
572
  * "SemanticObject": "
537
573
  * }]
538
574
  * ```
575
+ *
576
+ *
577
+ * @since 1.119
578
+ * @experimental (since 1.119)
539
579
  */
540
580
  class Dimension extends sap.ui.base.Object {
541
- constructor();
581
+ /**
582
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
583
+ */
584
+ protected constructor();
542
585
 
543
586
  /**
544
587
  * Creates a new subclass of class sap.sac.df.model.Dimension with name `sClassName` and enriches it with
@@ -546,6 +589,7 @@ declare namespace sap {
546
589
  *
547
590
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
548
591
  *
592
+ *
549
593
  * @returns Created class / constructor function
550
594
  */
551
595
  static extend<T extends Record<string, unknown>>(
@@ -566,12 +610,14 @@ declare namespace sap {
566
610
  /**
567
611
  * Returns a metadata object for class sap.sac.df.model.Dimension.
568
612
  *
613
+ *
569
614
  * @returns Metadata object describing this class
570
615
  */
571
616
  static getMetadata(): sap.ui.base.Metadata;
572
617
  /**
573
618
  * Set Display Type of Dimension
574
619
  *
620
+ *
575
621
  * @returns } resolving to the Dimension to allow chaining.
576
622
  */
577
623
  static setDimensionDisplay(
@@ -583,6 +629,7 @@ declare namespace sap {
583
629
  /**
584
630
  * Add dimension filters
585
631
  *
632
+ *
586
633
  * @returns Reference to this in order to allow method chaining
587
634
  */
588
635
  addMemberFilter(
@@ -598,6 +645,7 @@ declare namespace sap {
598
645
  /**
599
646
  * Add a member filter by its key
600
647
  *
648
+ *
601
649
  * @returns Reference to this in order to allow method chaining
602
650
  */
603
651
  addMemberFilterByKey(
@@ -613,6 +661,7 @@ declare namespace sap {
613
661
  /**
614
662
  * Clear the filter of a dimension
615
663
  *
664
+ *
616
665
  * @returns Reference to this in order to allow method chaining
617
666
  */
618
667
  clearMemberFilter(
@@ -624,30 +673,35 @@ declare namespace sap {
624
673
  /**
625
674
  * Get effective dimension filters
626
675
  *
676
+ *
627
677
  * @returns array of member filters
628
678
  */
629
679
  getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
630
680
  /**
631
681
  * Move dimension one position down on it's axis
632
682
  *
683
+ *
633
684
  * @returns Reference to this in order to allow method chaining
634
685
  */
635
686
  moveDown(): this;
636
687
  /**
637
688
  * Move dimension one position up on it's axis
638
689
  *
690
+ *
639
691
  * @returns Reference to this in order to allow method chaining
640
692
  */
641
693
  moveUp(): this;
642
694
  /**
643
695
  * Open a dialog to display and change the settings of a dimension of the `DataProvider`
644
696
  *
697
+ *
645
698
  * @returns indicator whether the dialog was confirmed or canceled
646
699
  */
647
700
  openPropertyDialog(): Promise<boolean>;
648
701
  /**
649
702
  * Open a dialog to display and change the filter on a dimension
650
703
  *
704
+ *
651
705
  * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
652
706
  * with Ok and dynamic filters of the given dimension are updated
653
707
  */
@@ -660,6 +714,7 @@ declare namespace sap {
660
714
  /**
661
715
  * Set Display Hierarchy
662
716
  *
717
+ *
663
718
  * @returns resolving to the `Dimension` to allow chaining.
664
719
  */
665
720
  readHierarchy(
@@ -671,12 +726,14 @@ declare namespace sap {
671
726
  /**
672
727
  * Remove a drill operation on a dimension member
673
728
  *
729
+ *
674
730
  * @returns Reference to this in order to allow method chaining
675
731
  */
676
732
  removeDrilldown(): this;
677
733
  /**
678
734
  * Remove the filter of a dimension
679
735
  *
736
+ *
680
737
  * @returns Reference to this in order to allow method chaining
681
738
  */
682
739
  removeMemberFilter(
@@ -692,6 +749,7 @@ declare namespace sap {
692
749
  /**
693
750
  * Remove a member filter by its key
694
751
  *
752
+ *
695
753
  * @returns Reference to this in order to allow method chaining
696
754
  */
697
755
  removeMemberFilterByKey(
@@ -707,6 +765,7 @@ declare namespace sap {
707
765
  /**
708
766
  * Performs the search for a given value
709
767
  *
768
+ *
710
769
  * @returns array of found member filters
711
770
  */
712
771
  searchMember(
@@ -739,6 +798,7 @@ declare namespace sap {
739
798
  /**
740
799
  * Set Display Hierarchy
741
800
  *
801
+ *
742
802
  * @returns resolving to the `Dimension` to allow chaining.
743
803
  */
744
804
  setDisplayHierarchy(
@@ -758,6 +818,7 @@ declare namespace sap {
758
818
  /**
759
819
  * Set dimension filters
760
820
  *
821
+ *
761
822
  * @returns Reference to this in order to allow method chaining
762
823
  */
763
824
  setMemberFilter(
@@ -773,6 +834,7 @@ declare namespace sap {
773
834
  /**
774
835
  * Set a member filter by its key
775
836
  *
837
+ *
776
838
  * @returns Reference to this in order to allow method chaining
777
839
  */
778
840
  setMemberFilterByKey(
@@ -788,6 +850,7 @@ declare namespace sap {
788
850
  /**
789
851
  * Sort the members of a dimension
790
852
  *
853
+ *
791
854
  * @returns Promise referencing to this in order to allow method chaining
792
855
  */
793
856
  sort(
@@ -807,24 +870,29 @@ declare namespace sap {
807
870
  /**
808
871
  * Move dimension to the columns axis
809
872
  *
873
+ *
810
874
  * @returns Reference to this in order to allow method chaining
811
875
  */
812
876
  toColumns(): this;
813
877
  /**
814
878
  * Move dimension to the rows axis
815
879
  *
880
+ *
816
881
  * @returns Reference to this in order to allow method chaining
817
882
  */
818
883
  toRows(): this;
819
884
  }
820
885
  /**
886
+ * Document Object
887
+ *
821
888
  * @since 1.119
822
889
  * @experimental (since 1.119)
823
- *
824
- * Document Object
825
890
  */
826
891
  class Document extends sap.ui.base.Object {
827
- constructor();
892
+ /**
893
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
894
+ */
895
+ protected constructor();
828
896
 
829
897
  /**
830
898
  * Creates a new subclass of class sap.sac.df.model.Document with name `sClassName` and enriches it with
@@ -832,6 +900,7 @@ declare namespace sap {
832
900
  *
833
901
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
834
902
  *
903
+ *
835
904
  * @returns Created class / constructor function
836
905
  */
837
906
  static extend<T extends Record<string, unknown>>(
@@ -852,12 +921,14 @@ declare namespace sap {
852
921
  /**
853
922
  * Returns a metadata object for class sap.sac.df.model.Document.
854
923
  *
924
+ *
855
925
  * @returns Metadata object describing this class
856
926
  */
857
927
  static getMetadata(): sap.ui.base.Metadata;
858
928
  /**
859
929
  * Creates a document in the document store
860
930
  *
931
+ *
861
932
  * @returns a promise which resolves to true if create operation is successful, otherwise false.
862
933
  */
863
934
  createDocument(
@@ -873,6 +944,7 @@ declare namespace sap {
873
944
  /**
874
945
  * Creates a document ID for a data cell in the result set
875
946
  *
947
+ *
876
948
  * @returns a promise which resolves with the newly created document ID
877
949
  */
878
950
  createDocumentId(
@@ -888,6 +960,7 @@ declare namespace sap {
888
960
  /**
889
961
  * Deletes a document in the document store
890
962
  *
963
+ *
891
964
  * @returns a promise which resolves to true if delete operation is successful, otherwise false.
892
965
  */
893
966
  deleteDocument(
@@ -899,6 +972,7 @@ declare namespace sap {
899
972
  /**
900
973
  * Deletes a document ID for a data cell in the result set
901
974
  *
975
+ *
902
976
  * @returns a promise which resolves to true if the delete operation is successful, otherwise false.
903
977
  */
904
978
  deleteDocumentId(
@@ -914,6 +988,7 @@ declare namespace sap {
914
988
  /**
915
989
  * Gets a document ID of a data cell in the result set
916
990
  *
991
+ *
917
992
  * @returns a promise which resolves with the document ID
918
993
  */
919
994
  getDocumentId(
@@ -929,12 +1004,14 @@ declare namespace sap {
929
1004
  /**
930
1005
  * Gets the type of DocumentsSupport.
931
1006
  *
1007
+ *
932
1008
  * @returns DocumentsSupport type
933
1009
  */
934
1010
  getDocumentsSupportType(): string;
935
1011
  /**
936
1012
  * Retrieves a document from the document store
937
1013
  *
1014
+ *
938
1015
  * @returns a promise which resolves with the version(s) of the document.
939
1016
  */
940
1017
  retrieveDocument(
@@ -950,6 +1027,7 @@ declare namespace sap {
950
1027
  /**
951
1028
  * Retrieves multiple documents from the document store
952
1029
  *
1030
+ *
953
1031
  * @returns a promise which resolves with all documents and its versions.
954
1032
  */
955
1033
  retrieveMultipleDocuments(
@@ -961,6 +1039,7 @@ declare namespace sap {
961
1039
  /**
962
1040
  * Updates a document in the document store
963
1041
  *
1042
+ *
964
1043
  * @returns a promise which resolves to true if update operation is successful, otherwise false.
965
1044
  */
966
1045
  updateDocument(
@@ -975,13 +1054,16 @@ declare namespace sap {
975
1054
  ): Promise<boolean>;
976
1055
  }
977
1056
  /**
1057
+ * Grid Object
1058
+ *
978
1059
  * @since 1.119
979
1060
  * @experimental (since 1.119)
980
- *
981
- * Grid Object
982
1061
  */
983
1062
  class Grid extends sap.ui.base.Object {
984
- constructor();
1063
+ /**
1064
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1065
+ */
1066
+ protected constructor();
985
1067
  /**
986
1068
  * Documents
987
1069
  */
@@ -993,6 +1075,7 @@ declare namespace sap {
993
1075
  *
994
1076
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
995
1077
  *
1078
+ *
996
1079
  * @returns Created class / constructor function
997
1080
  */
998
1081
  static extend<T extends Record<string, unknown>>(
@@ -1013,12 +1096,14 @@ declare namespace sap {
1013
1096
  /**
1014
1097
  * Returns a metadata object for class sap.sac.df.model.Grid.
1015
1098
  *
1099
+ *
1016
1100
  * @returns Metadata object describing this class
1017
1101
  */
1018
1102
  static getMetadata(): sap.ui.base.Metadata;
1019
1103
  /**
1020
1104
  * Gets the cell context for a data cell in the result set
1021
1105
  *
1106
+ *
1022
1107
  * @returns a promise which resolves with the retrieved cell context
1023
1108
  */
1024
1109
  getCellContext(
@@ -1034,6 +1119,7 @@ declare namespace sap {
1034
1119
  /**
1035
1120
  * Get the list of the jump targets associated to a cell defined via the Report-To-Report Interface.
1036
1121
  *
1122
+ *
1037
1123
  * @returns resolving to the List of jump targets.
1038
1124
  */
1039
1125
  getRRITargets(
@@ -1048,9 +1134,6 @@ declare namespace sap {
1048
1134
  ): Promise<any>;
1049
1135
  }
1050
1136
  /**
1051
- * @since 1.119
1052
- * @experimental (since 1.119)
1053
- *
1054
1137
  * The multidimensional model allows to access and change data accessed via the InA Protocol. The multidimensional
1055
1138
  * model populate it's exposed data in JSON format via binding to controls.
1056
1139
  *
@@ -1061,6 +1144,10 @@ declare namespace sap {
1061
1144
  * "VariableGroups": { },
1062
1145
  * "Messages": [ ]
1063
1146
  * ```
1147
+ *
1148
+ *
1149
+ * @since 1.119
1150
+ * @experimental (since 1.119)
1064
1151
  */
1065
1152
  class MultiDimModel extends sap.ui.model.json.JSONModel {
1066
1153
  /**
@@ -1097,6 +1184,7 @@ declare namespace sap {
1097
1184
  *
1098
1185
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
1099
1186
  *
1187
+ *
1100
1188
  * @returns Created class / constructor function
1101
1189
  */
1102
1190
  static extend<T extends Record<string, unknown>>(
@@ -1117,12 +1205,14 @@ declare namespace sap {
1117
1205
  /**
1118
1206
  * Returns a metadata object for class sap.sac.df.model.MultiDimModel.
1119
1207
  *
1208
+ *
1120
1209
  * @returns Metadata object describing this class
1121
1210
  */
1122
1211
  static getMetadata(): sap.ui.base.Metadata;
1123
1212
  /**
1124
1213
  * Creates a new data provider and attaches it to the model.
1125
1214
  *
1215
+ *
1126
1216
  * @returns Promise which resolves the created data provider
1127
1217
  */
1128
1218
  addDataProvider(
@@ -1157,6 +1247,7 @@ declare namespace sap {
1157
1247
  * A variable group defines which variables of the underlying data providers should behave as the same variable.
1158
1248
  * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
1159
1249
  *
1250
+ *
1160
1251
  * @returns Promise which resolves the created variable group
1161
1252
  */
1162
1253
  addVariableGroup(
@@ -1177,6 +1268,7 @@ declare namespace sap {
1177
1268
  /**
1178
1269
  * Updates the model from the given the model state including all aggregated data providers
1179
1270
  *
1271
+ *
1180
1272
  * @returns Promise with reference to this in order to allow method chaining
1181
1273
  */
1182
1274
  deserialize(
@@ -1192,6 +1284,7 @@ declare namespace sap {
1192
1284
  /**
1193
1285
  * Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
1194
1286
  *
1287
+ *
1195
1288
  * @returns Reference to this in order to allow method chaining
1196
1289
  */
1197
1290
  fireDataProviderAdded(
@@ -1203,6 +1296,7 @@ declare namespace sap {
1203
1296
  /**
1204
1297
  * Fires event {@link #event:dataProviderRemoved dataProviderRemoved} to attached listeners.
1205
1298
  *
1299
+ *
1206
1300
  * @returns Reference to this in order to allow method chaining
1207
1301
  */
1208
1302
  fireDataProviderRemoved(
@@ -1214,6 +1308,7 @@ declare namespace sap {
1214
1308
  /**
1215
1309
  * Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
1216
1310
  *
1311
+ *
1217
1312
  * @returns Reference to this in order to allow method chaining
1218
1313
  */
1219
1314
  fireDataProviderUpdated(
@@ -1225,6 +1320,7 @@ declare namespace sap {
1225
1320
  /**
1226
1321
  * Get a data provider
1227
1322
  *
1323
+ *
1228
1324
  * @returns Data provider instance if found
1229
1325
  */
1230
1326
  getDataProvider(
@@ -1236,18 +1332,21 @@ declare namespace sap {
1236
1332
  /**
1237
1333
  * Get all data providers
1238
1334
  *
1335
+ *
1239
1336
  * @returns Object of all data providers
1240
1337
  */
1241
1338
  getDataProviders(): Record<string, sap.sac.df.model.DataProvider>;
1242
1339
  /**
1243
1340
  * Get all messages
1244
1341
  *
1342
+ *
1245
1343
  * @returns Array of messages
1246
1344
  */
1247
1345
  getMessages(): sap.ui.core.message.Message[];
1248
1346
  /**
1249
1347
  * Get a variable group
1250
1348
  *
1349
+ *
1251
1350
  * @returns Variable group object
1252
1351
  */
1253
1352
  getVariableGroup(
@@ -1259,18 +1358,21 @@ declare namespace sap {
1259
1358
  /**
1260
1359
  * Get all variable groups
1261
1360
  *
1361
+ *
1262
1362
  * @returns Object of all variable groups
1263
1363
  */
1264
1364
  getVariableGroups(): Record<string, sap.sac.df.model.VariableGroup>;
1265
1365
  /**
1266
1366
  * Ensures all aggregated DataProviders are logged off.
1267
1367
  *
1368
+ *
1268
1369
  * @returns Promise which resolves when logoff is finished.
1269
1370
  */
1270
1371
  logoff(): Promise<void>;
1271
1372
  /**
1272
1373
  * Remove existing data provider from the model.
1273
1374
  *
1375
+ *
1274
1376
  * @returns Promise which resolves when the removing s finished
1275
1377
  */
1276
1378
  removeDataProvider(
@@ -1282,6 +1384,7 @@ declare namespace sap {
1282
1384
  /**
1283
1385
  * Remove a variable group from the model
1284
1386
  *
1387
+ *
1285
1388
  * @returns Promise which resolves when the removing s finished
1286
1389
  */
1287
1390
  removeVariableGroup(
@@ -1293,12 +1396,14 @@ declare namespace sap {
1293
1396
  /**
1294
1397
  * Reset the model to the initial state
1295
1398
  *
1399
+ *
1296
1400
  * @returns Promise which resolves when reset is finished.
1297
1401
  */
1298
1402
  resetModel(): Promise<void>;
1299
1403
  /**
1300
1404
  * Serialize the model with all aggregated data providers to a JSON representation
1301
1405
  *
1406
+ *
1302
1407
  * @returns A JSON object which represents the multidimensional model
1303
1408
  */
1304
1409
  serialize(
@@ -1318,9 +1423,6 @@ declare namespace sap {
1318
1423
  ): void;
1319
1424
  }
1320
1425
  /**
1321
- * @since 1.119
1322
- * @experimental (since 1.119)
1323
- *
1324
1426
  * Variable Object
1325
1427
  *
1326
1428
  * **Structure of Exposed Data:**
@@ -1340,9 +1442,16 @@ declare namespace sap {
1340
1442
  * "DataProviderName": "",
1341
1443
  * "MemberFilter": []
1342
1444
  * ```
1445
+ *
1446
+ *
1447
+ * @since 1.119
1448
+ * @experimental (since 1.119)
1343
1449
  */
1344
1450
  class Variable extends sap.ui.base.Object {
1345
- constructor();
1451
+ /**
1452
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1453
+ */
1454
+ protected constructor();
1346
1455
 
1347
1456
  /**
1348
1457
  * Creates a new subclass of class sap.sac.df.model.Variable with name `sClassName` and enriches it with
@@ -1350,6 +1459,7 @@ declare namespace sap {
1350
1459
  *
1351
1460
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1352
1461
  *
1462
+ *
1353
1463
  * @returns Created class / constructor function
1354
1464
  */
1355
1465
  static extend<T extends Record<string, unknown>>(
@@ -1370,12 +1480,14 @@ declare namespace sap {
1370
1480
  /**
1371
1481
  * Returns a metadata object for class sap.sac.df.model.Variable.
1372
1482
  *
1483
+ *
1373
1484
  * @returns Metadata object describing this class
1374
1485
  */
1375
1486
  static getMetadata(): sap.ui.base.Metadata;
1376
1487
  /**
1377
1488
  * Add variable filters
1378
1489
  *
1490
+ *
1379
1491
  * @returns Reference to this in order to allow method chaining
1380
1492
  */
1381
1493
  addMemberFilter(
@@ -1391,6 +1503,7 @@ declare namespace sap {
1391
1503
  /**
1392
1504
  * Add a member filter by its key
1393
1505
  *
1506
+ *
1394
1507
  * @returns Reference to this in order to allow method chaining
1395
1508
  */
1396
1509
  addMemberFilterByKey(
@@ -1406,6 +1519,7 @@ declare namespace sap {
1406
1519
  /**
1407
1520
  * Clear variable filter
1408
1521
  *
1522
+ *
1409
1523
  * @returns Reference to this in order to allow method chaining
1410
1524
  */
1411
1525
  clearMemberFilter(
@@ -1417,12 +1531,14 @@ declare namespace sap {
1417
1531
  /**
1418
1532
  * Get effective variable filters
1419
1533
  *
1534
+ *
1420
1535
  * @returns array of member filters
1421
1536
  */
1422
1537
  getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
1423
1538
  /**
1424
1539
  * Open a dialog to display and change the filter on a variable
1425
1540
  *
1541
+ *
1426
1542
  * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
1427
1543
  * with Ok and dynamic filters of the given dimension are updated
1428
1544
  */
@@ -1435,6 +1551,7 @@ declare namespace sap {
1435
1551
  /**
1436
1552
  * Remove variable filter
1437
1553
  *
1554
+ *
1438
1555
  * @returns Reference to this in order to allow method chaining
1439
1556
  */
1440
1557
  removeMemberFilter(
@@ -1450,6 +1567,7 @@ declare namespace sap {
1450
1567
  /**
1451
1568
  * Remove a member filter by its key
1452
1569
  *
1570
+ *
1453
1571
  * @returns Reference to this in order to allow method chaining
1454
1572
  */
1455
1573
  removeMemberFilterByKey(
@@ -1465,6 +1583,7 @@ declare namespace sap {
1465
1583
  /**
1466
1584
  * Performs the search for a given value
1467
1585
  *
1586
+ *
1468
1587
  * @returns array of found member filters
1469
1588
  */
1470
1589
  searchMember(
@@ -1497,6 +1616,7 @@ declare namespace sap {
1497
1616
  /**
1498
1617
  * Set variable filters
1499
1618
  *
1619
+ *
1500
1620
  * @returns Reference to this in order to allow method chaining
1501
1621
  */
1502
1622
  setMemberFilter(
@@ -1512,6 +1632,7 @@ declare namespace sap {
1512
1632
  /**
1513
1633
  * Set a member filter by its key
1514
1634
  *
1635
+ *
1515
1636
  * @returns Reference to this in order to allow method chaining
1516
1637
  */
1517
1638
  setMemberFilterByKey(
@@ -1526,9 +1647,6 @@ declare namespace sap {
1526
1647
  ): this;
1527
1648
  }
1528
1649
  /**
1529
- * @since 1.119
1530
- * @experimental (since 1.119)
1531
- *
1532
1650
  * Variable Group Object
1533
1651
  *
1534
1652
  * **Structure of Exposed Data:**
@@ -1538,9 +1656,16 @@ declare namespace sap {
1538
1656
  * "MergedVariable": { },
1539
1657
  * "Rule: function () {}
1540
1658
  * ```
1659
+ *
1660
+ *
1661
+ * @since 1.119
1662
+ * @experimental (since 1.119)
1541
1663
  */
1542
1664
  class VariableGroup extends sap.ui.base.Object {
1543
- constructor();
1665
+ /**
1666
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1667
+ */
1668
+ protected constructor();
1544
1669
  /**
1545
1670
  * Merged Variable
1546
1671
  */
@@ -1557,6 +1682,7 @@ declare namespace sap {
1557
1682
  *
1558
1683
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1559
1684
  *
1685
+ *
1560
1686
  * @returns Created class / constructor function
1561
1687
  */
1562
1688
  static extend<T extends Record<string, unknown>>(
@@ -1577,12 +1703,14 @@ declare namespace sap {
1577
1703
  /**
1578
1704
  * Returns a metadata object for class sap.sac.df.model.VariableGroup.
1579
1705
  *
1706
+ *
1580
1707
  * @returns Metadata object describing this class
1581
1708
  */
1582
1709
  static getMetadata(): sap.ui.base.Metadata;
1583
1710
  /**
1584
1711
  * Add variable group filters
1585
1712
  *
1713
+ *
1586
1714
  * @returns Reference to this in order to allow method chaining
1587
1715
  */
1588
1716
  addMemberFilter(
@@ -1598,6 +1726,7 @@ declare namespace sap {
1598
1726
  /**
1599
1727
  * Add a member filter by its key
1600
1728
  *
1729
+ *
1601
1730
  * @returns Reference to this in order to allow method chaining
1602
1731
  */
1603
1732
  addMemberFilterByKey(
@@ -1613,6 +1742,7 @@ declare namespace sap {
1613
1742
  /**
1614
1743
  * Clear variable group filter
1615
1744
  *
1745
+ *
1616
1746
  * @returns Reference to this in order to allow method chaining
1617
1747
  */
1618
1748
  clearMemberFilter(
@@ -1624,6 +1754,7 @@ declare namespace sap {
1624
1754
  /**
1625
1755
  * Get effective variable group filters
1626
1756
  *
1757
+ *
1627
1758
  * @returns array of member filters
1628
1759
  */
1629
1760
  getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
@@ -1632,6 +1763,7 @@ declare namespace sap {
1632
1763
  * only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
1633
1764
  * with the next ResultSet fetch
1634
1765
  *
1766
+ *
1635
1767
  * @returns to indicate if the VariableGroup has been updated
1636
1768
  */
1637
1769
  openValueHelpDialog(
@@ -1643,6 +1775,7 @@ declare namespace sap {
1643
1775
  /**
1644
1776
  * Remove variable group filter
1645
1777
  *
1778
+ *
1646
1779
  * @returns Reference to this in order to allow method chaining
1647
1780
  */
1648
1781
  removeMemberFilter(
@@ -1658,6 +1791,7 @@ declare namespace sap {
1658
1791
  /**
1659
1792
  * Remove a member filter by its key
1660
1793
  *
1794
+ *
1661
1795
  * @returns Reference to this in order to allow method chaining
1662
1796
  */
1663
1797
  removeMemberFilterByKey(
@@ -1673,6 +1807,7 @@ declare namespace sap {
1673
1807
  /**
1674
1808
  * Performs the search in values of a given Variable
1675
1809
  *
1810
+ *
1676
1811
  * @returns array with found values
1677
1812
  */
1678
1813
  searchMember(
@@ -1705,6 +1840,7 @@ declare namespace sap {
1705
1840
  /**
1706
1841
  * Set variable group filters
1707
1842
  *
1843
+ *
1708
1844
  * @returns Promise which resolve when the value is set
1709
1845
  */
1710
1846
  setMemberFilter(
@@ -1720,6 +1856,7 @@ declare namespace sap {
1720
1856
  /**
1721
1857
  * Set a member filter by its key
1722
1858
  *
1859
+ *
1723
1860
  * @returns Reference to this in order to allow method chaining
1724
1861
  */
1725
1862
  setMemberFilterByKey(
@@ -2079,9 +2216,9 @@ declare namespace sap {
2079
2216
  interface FilterBar$CancelFilterChangeEventParameters {}
2080
2217
 
2081
2218
  /**
2082
- * @experimental (since 1.119)
2083
- *
2084
2219
  * A Filter Bar based on Multidimensional Model
2220
+ *
2221
+ * @experimental (since 1.119)
2085
2222
  */
2086
2223
  class FilterBar extends sap.ui.mdc.FilterBar {
2087
2224
  /**
@@ -2099,6 +2236,7 @@ declare namespace sap {
2099
2236
  *
2100
2237
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterBar.extend}.
2101
2238
  *
2239
+ *
2102
2240
  * @returns Created class / constructor function
2103
2241
  */
2104
2242
  static extend<T extends Record<string, unknown>>(
@@ -2119,6 +2257,7 @@ declare namespace sap {
2119
2257
  /**
2120
2258
  * Returns a metadata object for class sap.sac.df.FilterBar.
2121
2259
  *
2260
+ *
2122
2261
  * @returns Metadata object describing this class
2123
2262
  */
2124
2263
  static getMetadata(): sap.ui.core.ElementMetadata;
@@ -2131,6 +2270,7 @@ declare namespace sap {
2131
2270
  *
2132
2271
  * Fires before update variable of multidimension model after input value or open value help of variable.
2133
2272
  *
2273
+ *
2134
2274
  * @returns Reference to `this` in order to allow method chaining
2135
2275
  */
2136
2276
  attachBeforeFilterChange(
@@ -2157,6 +2297,7 @@ declare namespace sap {
2157
2297
  *
2158
2298
  * Fires before update variable of multidimension model after input value or open value help of variable.
2159
2299
  *
2300
+ *
2160
2301
  * @returns Reference to `this` in order to allow method chaining
2161
2302
  */
2162
2303
  attachBeforeFilterChange(
@@ -2178,6 +2319,7 @@ declare namespace sap {
2178
2319
  *
2179
2320
  * Fires when cancel change in the value help dialog.
2180
2321
  *
2322
+ *
2181
2323
  * @returns Reference to `this` in order to allow method chaining
2182
2324
  */
2183
2325
  attachCancelFilterChange(
@@ -2204,6 +2346,7 @@ declare namespace sap {
2204
2346
  *
2205
2347
  * Fires when cancel change in the value help dialog.
2206
2348
  *
2349
+ *
2207
2350
  * @returns Reference to `this` in order to allow method chaining
2208
2351
  */
2209
2352
  attachCancelFilterChange(
@@ -2222,6 +2365,7 @@ declare namespace sap {
2222
2365
  *
2223
2366
  * The passed function and listener object must match the ones used for event registration.
2224
2367
  *
2368
+ *
2225
2369
  * @returns Reference to `this` in order to allow method chaining
2226
2370
  */
2227
2371
  detachBeforeFilterChange(
@@ -2240,6 +2384,7 @@ declare namespace sap {
2240
2384
  *
2241
2385
  * The passed function and listener object must match the ones used for event registration.
2242
2386
  *
2387
+ *
2243
2388
  * @returns Reference to `this` in order to allow method chaining
2244
2389
  */
2245
2390
  detachCancelFilterChange(
@@ -2253,10 +2398,10 @@ declare namespace sap {
2253
2398
  oListener?: object
2254
2399
  ): this;
2255
2400
  /**
2256
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2257
- *
2258
2401
  * Fires event {@link #event:beforeFilterChange beforeFilterChange} to attached listeners.
2259
2402
  *
2403
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2404
+ *
2260
2405
  * @returns Reference to `this` in order to allow method chaining
2261
2406
  */
2262
2407
  fireBeforeFilterChange(
@@ -2266,10 +2411,10 @@ declare namespace sap {
2266
2411
  mParameters?: sap.sac.df.FilterBar$BeforeFilterChangeEventParameters
2267
2412
  ): this;
2268
2413
  /**
2269
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2270
- *
2271
2414
  * Fires event {@link #event:cancelFilterChange cancelFilterChange} to attached listeners.
2272
2415
  *
2416
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2417
+ *
2273
2418
  * @returns Reference to `this` in order to allow method chaining
2274
2419
  */
2275
2420
  fireCancelFilterChange(
@@ -2285,6 +2430,7 @@ declare namespace sap {
2285
2430
  *
2286
2431
  * Default value is `ValueDescription`.
2287
2432
  *
2433
+ *
2288
2434
  * @returns Value of property `display`
2289
2435
  */
2290
2436
  getDisplay(): sap.ui.mdc.enums.FieldDisplay;
@@ -2295,6 +2441,7 @@ declare namespace sap {
2295
2441
  *
2296
2442
  * Default value is `"VariablesOfDataProvider"`.
2297
2443
  *
2444
+ *
2298
2445
  * @returns Value of property `mode`
2299
2446
  */
2300
2447
  getMode(): string;
@@ -2305,6 +2452,7 @@ declare namespace sap {
2305
2452
  *
2306
2453
  * Default value is `"om"`.
2307
2454
  *
2455
+ *
2308
2456
  * @returns Value of property `multiDimModelId`
2309
2457
  */
2310
2458
  getMultiDimModelId(): string;
@@ -2317,6 +2465,7 @@ declare namespace sap {
2317
2465
  *
2318
2466
  * Default value is `ValueDescription`.
2319
2467
  *
2468
+ *
2320
2469
  * @returns Reference to `this` in order to allow method chaining
2321
2470
  */
2322
2471
  setDisplay(
@@ -2334,6 +2483,7 @@ declare namespace sap {
2334
2483
  *
2335
2484
  * Default value is `"VariablesOfDataProvider"`.
2336
2485
  *
2486
+ *
2337
2487
  * @returns Reference to `this` in order to allow method chaining
2338
2488
  */
2339
2489
  setMode(
@@ -2351,6 +2501,7 @@ declare namespace sap {
2351
2501
  *
2352
2502
  * Default value is `"om"`.
2353
2503
  *
2504
+ *
2354
2505
  * @returns Reference to `this` in order to allow method chaining
2355
2506
  */
2356
2507
  setMultiDimModelId(
@@ -2361,14 +2512,14 @@ declare namespace sap {
2361
2512
  ): this;
2362
2513
  }
2363
2514
  /**
2364
- * @experimental
2365
- *
2366
2515
  * Enables users to view, navigate and change multidimensional data exposed via InA.
2367
2516
  *
2368
2517
  * Overview:
2369
2518
  *
2370
2519
  * The user can view the data in a Table, navigate in the data via a context menu or builder panels The
2371
2520
  * data source that the FlexAnalysis consumes or renders has to be provided as a property value.
2521
+ *
2522
+ * @experimental
2372
2523
  */
2373
2524
  class FlexAnalysis extends sap.ui.core.Control {
2374
2525
  /**
@@ -2391,6 +2542,7 @@ declare namespace sap {
2391
2542
  *
2392
2543
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2393
2544
  *
2545
+ *
2394
2546
  * @returns Created class / constructor function
2395
2547
  */
2396
2548
  static extend<T extends Record<string, unknown>>(
@@ -2411,12 +2563,14 @@ declare namespace sap {
2411
2563
  /**
2412
2564
  * Returns a metadata object for class sap.sac.df.FlexAnalysis.
2413
2565
  *
2566
+ *
2414
2567
  * @returns Metadata object describing this class
2415
2568
  */
2416
2569
  static getMetadata(): sap.ui.core.ElementMetadata;
2417
2570
  /**
2418
2571
  * Adds some customPanel to the aggregation {@link #getCustomPanels customPanels}.
2419
2572
  *
2573
+ *
2420
2574
  * @returns Reference to `this` in order to allow method chaining
2421
2575
  */
2422
2576
  addCustomPanel(
@@ -2431,6 +2585,7 @@ declare namespace sap {
2431
2585
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
2432
2586
  * of the possible properties of `oBindingInfo`
2433
2587
  *
2588
+ *
2434
2589
  * @returns Reference to `this` in order to allow method chaining
2435
2590
  */
2436
2591
  bindDataProvider(
@@ -2442,6 +2597,7 @@ declare namespace sap {
2442
2597
  /**
2443
2598
  * Destroys all the customPanels in the aggregation {@link #getCustomPanels customPanels}.
2444
2599
  *
2600
+ *
2445
2601
  * @returns Reference to `this` in order to allow method chaining
2446
2602
  */
2447
2603
  destroyCustomPanels(): this;
@@ -2452,6 +2608,7 @@ declare namespace sap {
2452
2608
  *
2453
2609
  * Default value is `true`.
2454
2610
  *
2611
+ *
2455
2612
  * @returns Value of property `autoUpdate`
2456
2613
  */
2457
2614
  getAutoUpdate(): boolean;
@@ -2460,6 +2617,7 @@ declare namespace sap {
2460
2617
  *
2461
2618
  * Client Identifier to be used for underlying InA queries
2462
2619
  *
2620
+ *
2463
2621
  * @returns Value of property `clientIdentifier`
2464
2622
  */
2465
2623
  getClientIdentifier(): string;
@@ -2468,6 +2626,7 @@ declare namespace sap {
2468
2626
  *
2469
2627
  * configuration Id
2470
2628
  *
2629
+ *
2471
2630
  * @returns Value of property `configId`
2472
2631
  */
2473
2632
  getConfigId(): string;
@@ -2476,6 +2635,7 @@ declare namespace sap {
2476
2635
  *
2477
2636
  * JSON object containing the configuration (alternative to configurationURI)
2478
2637
  *
2638
+ *
2479
2639
  * @returns Value of property `configObject`
2480
2640
  */
2481
2641
  getConfigObject(): object;
@@ -2484,6 +2644,7 @@ declare namespace sap {
2484
2644
  *
2485
2645
  * URI of the advanced configuration to be fetched
2486
2646
  *
2647
+ *
2487
2648
  * @returns Value of property `configurationURI`
2488
2649
  */
2489
2650
  getConfigurationURI(): string;
@@ -2498,6 +2659,7 @@ declare namespace sap {
2498
2659
  *
2499
2660
  * Name of the Data Provider from the corresponding MultiDimModel to be used
2500
2661
  *
2662
+ *
2501
2663
  * @returns Value of property `dataProvider`
2502
2664
  */
2503
2665
  getDataProvider(): any;
@@ -2508,6 +2670,7 @@ declare namespace sap {
2508
2670
  *
2509
2671
  * Default value is `"$datasource"`.
2510
2672
  *
2673
+ *
2511
2674
  * @returns Value of property `dataSource`
2512
2675
  */
2513
2676
  getDataSource(): string;
@@ -2518,6 +2681,7 @@ declare namespace sap {
2518
2681
  *
2519
2682
  * Default value is `[]`.
2520
2683
  *
2684
+ *
2521
2685
  * @returns Value of property `environment`
2522
2686
  */
2523
2687
  getEnvironment(): string[];
@@ -2528,6 +2692,7 @@ declare namespace sap {
2528
2692
  *
2529
2693
  * Default value is `"100%"`.
2530
2694
  *
2695
+ *
2531
2696
  * @returns Value of property `height`
2532
2697
  */
2533
2698
  getHeight(): sap.ui.core.CSSSize;
@@ -2538,6 +2703,7 @@ declare namespace sap {
2538
2703
  *
2539
2704
  * Default value is `true`.
2540
2705
  *
2706
+ *
2541
2707
  * @returns Value of property `hideDesignPanel`
2542
2708
  */
2543
2709
  getHideDesignPanel(): boolean;
@@ -2548,6 +2714,7 @@ declare namespace sap {
2548
2714
  *
2549
2715
  * Default value is `false`.
2550
2716
  *
2717
+ *
2551
2718
  * @returns Value of property `hideFilterLine`
2552
2719
  */
2553
2720
  getHideFilterLine(): boolean;
@@ -2558,6 +2725,7 @@ declare namespace sap {
2558
2725
  *
2559
2726
  * Default value is `true`.
2560
2727
  *
2728
+ *
2561
2729
  * @returns Value of property `hideLandingPage`
2562
2730
  */
2563
2731
  getHideLandingPage(): boolean;
@@ -2568,6 +2736,7 @@ declare namespace sap {
2568
2736
  *
2569
2737
  * Default value is `true`.
2570
2738
  *
2739
+ *
2571
2740
  * @returns Value of property `hideMenuBar`
2572
2741
  */
2573
2742
  getHideMenuBar(): boolean;
@@ -2578,6 +2747,7 @@ declare namespace sap {
2578
2747
  *
2579
2748
  * Default value is `false`.
2580
2749
  *
2750
+ *
2581
2751
  * @returns Value of property `hideSideNavigation`
2582
2752
  */
2583
2753
  getHideSideNavigation(): boolean;
@@ -2588,6 +2758,7 @@ declare namespace sap {
2588
2758
  *
2589
2759
  * Default value is `true`.
2590
2760
  *
2761
+ *
2591
2762
  * @returns Value of property `hideStatusBar`
2592
2763
  */
2593
2764
  getHideStatusBar(): boolean;
@@ -2598,6 +2769,7 @@ declare namespace sap {
2598
2769
  *
2599
2770
  * Default value is `true`.
2600
2771
  *
2772
+ *
2601
2773
  * @returns Value of property `hideStylePanel`
2602
2774
  */
2603
2775
  getHideStylePanel(): boolean;
@@ -2608,6 +2780,7 @@ declare namespace sap {
2608
2780
  *
2609
2781
  * Default value is `true`.
2610
2782
  *
2783
+ *
2611
2784
  * @returns Value of property `hideToolBar`
2612
2785
  */
2613
2786
  getHideToolBar(): boolean;
@@ -2619,6 +2792,7 @@ declare namespace sap {
2619
2792
  *
2620
2793
  * Default value is `true`.
2621
2794
  *
2795
+ *
2622
2796
  * @returns Value of property `implicitVariableHandling`
2623
2797
  */
2624
2798
  getImplicitVariableHandling(): boolean;
@@ -2629,6 +2803,7 @@ declare namespace sap {
2629
2803
  *
2630
2804
  * Default value is `0`.
2631
2805
  *
2806
+ *
2632
2807
  * @returns Value of property `keepAliveInterval`
2633
2808
  */
2634
2809
  getKeepAliveInterval(): int;
@@ -2639,6 +2814,7 @@ declare namespace sap {
2639
2814
  *
2640
2815
  * Default value is `"om"`.
2641
2816
  *
2817
+ *
2642
2818
  * @returns Value of property `multiDimModelId`
2643
2819
  */
2644
2820
  getMultiDimModelId(): string;
@@ -2649,6 +2825,7 @@ declare namespace sap {
2649
2825
  *
2650
2826
  * Default value is `false`.
2651
2827
  *
2828
+ *
2652
2829
  * @returns Value of property `showTitle`
2653
2830
  */
2654
2831
  getShowTitle(): boolean;
@@ -2658,6 +2835,7 @@ declare namespace sap {
2658
2835
  * Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
2659
2836
  * corresponding MultiDimModel
2660
2837
  *
2838
+ *
2661
2839
  * @returns Value of property `styleTemplateName`
2662
2840
  */
2663
2841
  getStyleTemplateName(): string;
@@ -2666,6 +2844,7 @@ declare namespace sap {
2666
2844
  *
2667
2845
  * System to take data from. If not set or set to "local" current url will be used to determine the system
2668
2846
  *
2847
+ *
2669
2848
  * @returns Value of property `systemName`
2670
2849
  */
2671
2850
  getSystemName(): string;
@@ -2676,6 +2855,7 @@ declare namespace sap {
2676
2855
  *
2677
2856
  * Default value is `BW`.
2678
2857
  *
2858
+ *
2679
2859
  * @returns Value of property `systemType`
2680
2860
  */
2681
2861
  getSystemType(): sap.sac.df.types.SystemType;
@@ -2684,6 +2864,7 @@ declare namespace sap {
2684
2864
  *
2685
2865
  * Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
2686
2866
  *
2867
+ *
2687
2868
  * @returns Value of property `title`
2688
2869
  */
2689
2870
  getTitle(): string;
@@ -2694,6 +2875,7 @@ declare namespace sap {
2694
2875
  *
2695
2876
  * Default value is `"100%"`.
2696
2877
  *
2878
+ *
2697
2879
  * @returns Value of property `width`
2698
2880
  */
2699
2881
  getWidth(): sap.ui.core.CSSSize;
@@ -2701,6 +2883,7 @@ declare namespace sap {
2701
2883
  * Checks for the provided `sap.sac.df.FlexAnalysisPanel` in the aggregation {@link #getCustomPanels customPanels}.
2702
2884
  * and returns its index if found or -1 otherwise.
2703
2885
  *
2886
+ *
2704
2887
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2705
2888
  */
2706
2889
  indexOfCustomPanel(
@@ -2712,6 +2895,7 @@ declare namespace sap {
2712
2895
  /**
2713
2896
  * Inserts a customPanel into the aggregation {@link #getCustomPanels customPanels}.
2714
2897
  *
2898
+ *
2715
2899
  * @returns Reference to `this` in order to allow method chaining
2716
2900
  */
2717
2901
  insertCustomPanel(
@@ -2731,12 +2915,14 @@ declare namespace sap {
2731
2915
  *
2732
2916
  * Additionally, it unregisters them from the hosting UIArea.
2733
2917
  *
2918
+ *
2734
2919
  * @returns An array of the removed elements (might be empty)
2735
2920
  */
2736
2921
  removeAllCustomPanels(): sap.sac.df.FlexAnalysisPanel[];
2737
2922
  /**
2738
2923
  * Removes a customPanel from the aggregation {@link #getCustomPanels customPanels}.
2739
2924
  *
2925
+ *
2740
2926
  * @returns The removed customPanel or `null`
2741
2927
  */
2742
2928
  removeCustomPanel(
@@ -2754,6 +2940,7 @@ declare namespace sap {
2754
2940
  *
2755
2941
  * Default value is `true`.
2756
2942
  *
2943
+ *
2757
2944
  * @returns Reference to `this` in order to allow method chaining
2758
2945
  */
2759
2946
  setAutoUpdate(
@@ -2769,6 +2956,7 @@ declare namespace sap {
2769
2956
  *
2770
2957
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2771
2958
  *
2959
+ *
2772
2960
  * @returns Reference to `this` in order to allow method chaining
2773
2961
  */
2774
2962
  setClientIdentifier(
@@ -2784,6 +2972,7 @@ declare namespace sap {
2784
2972
  *
2785
2973
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2786
2974
  *
2975
+ *
2787
2976
  * @returns Reference to `this` in order to allow method chaining
2788
2977
  */
2789
2978
  setConfigId(
@@ -2799,6 +2988,7 @@ declare namespace sap {
2799
2988
  *
2800
2989
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2801
2990
  *
2991
+ *
2802
2992
  * @returns Reference to `this` in order to allow method chaining
2803
2993
  */
2804
2994
  setConfigObject(
@@ -2814,6 +3004,7 @@ declare namespace sap {
2814
3004
  *
2815
3005
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2816
3006
  *
3007
+ *
2817
3008
  * @returns Reference to `this` in order to allow method chaining
2818
3009
  */
2819
3010
  setConfigurationURI(
@@ -2829,6 +3020,7 @@ declare namespace sap {
2829
3020
  *
2830
3021
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2831
3022
  *
3023
+ *
2832
3024
  * @returns Reference to `this` in order to allow method chaining
2833
3025
  */
2834
3026
  setDataProvider(
@@ -2846,6 +3038,7 @@ declare namespace sap {
2846
3038
  *
2847
3039
  * Default value is `"$datasource"`.
2848
3040
  *
3041
+ *
2849
3042
  * @returns Reference to `this` in order to allow method chaining
2850
3043
  */
2851
3044
  setDataSource(
@@ -2863,6 +3056,7 @@ declare namespace sap {
2863
3056
  *
2864
3057
  * Default value is `[]`.
2865
3058
  *
3059
+ *
2866
3060
  * @returns Reference to `this` in order to allow method chaining
2867
3061
  */
2868
3062
  setEnvironment(
@@ -2880,6 +3074,7 @@ declare namespace sap {
2880
3074
  *
2881
3075
  * Default value is `"100%"`.
2882
3076
  *
3077
+ *
2883
3078
  * @returns Reference to `this` in order to allow method chaining
2884
3079
  */
2885
3080
  setHeight(
@@ -2897,6 +3092,7 @@ declare namespace sap {
2897
3092
  *
2898
3093
  * Default value is `true`.
2899
3094
  *
3095
+ *
2900
3096
  * @returns Reference to `this` in order to allow method chaining
2901
3097
  */
2902
3098
  setHideDesignPanel(
@@ -2914,6 +3110,7 @@ declare namespace sap {
2914
3110
  *
2915
3111
  * Default value is `false`.
2916
3112
  *
3113
+ *
2917
3114
  * @returns Reference to `this` in order to allow method chaining
2918
3115
  */
2919
3116
  setHideFilterLine(
@@ -2931,6 +3128,7 @@ declare namespace sap {
2931
3128
  *
2932
3129
  * Default value is `true`.
2933
3130
  *
3131
+ *
2934
3132
  * @returns Reference to `this` in order to allow method chaining
2935
3133
  */
2936
3134
  setHideLandingPage(
@@ -2948,6 +3146,7 @@ declare namespace sap {
2948
3146
  *
2949
3147
  * Default value is `true`.
2950
3148
  *
3149
+ *
2951
3150
  * @returns Reference to `this` in order to allow method chaining
2952
3151
  */
2953
3152
  setHideMenuBar(
@@ -2965,6 +3164,7 @@ declare namespace sap {
2965
3164
  *
2966
3165
  * Default value is `false`.
2967
3166
  *
3167
+ *
2968
3168
  * @returns Reference to `this` in order to allow method chaining
2969
3169
  */
2970
3170
  setHideSideNavigation(
@@ -2982,6 +3182,7 @@ declare namespace sap {
2982
3182
  *
2983
3183
  * Default value is `true`.
2984
3184
  *
3185
+ *
2985
3186
  * @returns Reference to `this` in order to allow method chaining
2986
3187
  */
2987
3188
  setHideStatusBar(
@@ -2999,6 +3200,7 @@ declare namespace sap {
2999
3200
  *
3000
3201
  * Default value is `true`.
3001
3202
  *
3203
+ *
3002
3204
  * @returns Reference to `this` in order to allow method chaining
3003
3205
  */
3004
3206
  setHideStylePanel(
@@ -3016,6 +3218,7 @@ declare namespace sap {
3016
3218
  *
3017
3219
  * Default value is `true`.
3018
3220
  *
3221
+ *
3019
3222
  * @returns Reference to `this` in order to allow method chaining
3020
3223
  */
3021
3224
  setHideToolBar(
@@ -3034,6 +3237,7 @@ declare namespace sap {
3034
3237
  *
3035
3238
  * Default value is `true`.
3036
3239
  *
3240
+ *
3037
3241
  * @returns Reference to `this` in order to allow method chaining
3038
3242
  */
3039
3243
  setImplicitVariableHandling(
@@ -3051,6 +3255,7 @@ declare namespace sap {
3051
3255
  *
3052
3256
  * Default value is `0`.
3053
3257
  *
3258
+ *
3054
3259
  * @returns Reference to `this` in order to allow method chaining
3055
3260
  */
3056
3261
  setKeepAliveInterval(
@@ -3068,6 +3273,7 @@ declare namespace sap {
3068
3273
  *
3069
3274
  * Default value is `"om"`.
3070
3275
  *
3276
+ *
3071
3277
  * @returns Reference to `this` in order to allow method chaining
3072
3278
  */
3073
3279
  setMultiDimModelId(
@@ -3085,6 +3291,7 @@ declare namespace sap {
3085
3291
  *
3086
3292
  * Default value is `false`.
3087
3293
  *
3294
+ *
3088
3295
  * @returns Reference to `this` in order to allow method chaining
3089
3296
  */
3090
3297
  setShowTitle(
@@ -3101,6 +3308,7 @@ declare namespace sap {
3101
3308
  *
3102
3309
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3103
3310
  *
3311
+ *
3104
3312
  * @returns Reference to `this` in order to allow method chaining
3105
3313
  */
3106
3314
  setStyleTemplateName(
@@ -3116,6 +3324,7 @@ declare namespace sap {
3116
3324
  *
3117
3325
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3118
3326
  *
3327
+ *
3119
3328
  * @returns Reference to `this` in order to allow method chaining
3120
3329
  */
3121
3330
  setSystemName(
@@ -3133,6 +3342,7 @@ declare namespace sap {
3133
3342
  *
3134
3343
  * Default value is `BW`.
3135
3344
  *
3345
+ *
3136
3346
  * @returns Reference to `this` in order to allow method chaining
3137
3347
  */
3138
3348
  setSystemType(
@@ -3148,6 +3358,7 @@ declare namespace sap {
3148
3358
  *
3149
3359
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3150
3360
  *
3361
+ *
3151
3362
  * @returns Reference to `this` in order to allow method chaining
3152
3363
  */
3153
3364
  setTitle(
@@ -3165,6 +3376,7 @@ declare namespace sap {
3165
3376
  *
3166
3377
  * Default value is `"100%"`.
3167
3378
  *
3379
+ *
3168
3380
  * @returns Reference to `this` in order to allow method chaining
3169
3381
  */
3170
3382
  setWidth(
@@ -3176,14 +3388,15 @@ declare namespace sap {
3176
3388
  /**
3177
3389
  * Unbinds property {@link #getDataProvider dataProvider} from model data.
3178
3390
  *
3391
+ *
3179
3392
  * @returns Reference to `this` in order to allow method chaining
3180
3393
  */
3181
3394
  unbindDataProvider(): this;
3182
3395
  }
3183
3396
  /**
3184
- * @experimental
3185
- *
3186
3397
  * A panel to be added into FlexAnalysis control
3398
+ *
3399
+ * @experimental
3187
3400
  */
3188
3401
  class FlexAnalysisPanel extends sap.ui.core.Element {
3189
3402
  /**
@@ -3223,6 +3436,7 @@ declare namespace sap {
3223
3436
  *
3224
3437
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3225
3438
  *
3439
+ *
3226
3440
  * @returns Created class / constructor function
3227
3441
  */
3228
3442
  static extend<T extends Record<string, unknown>>(
@@ -3243,12 +3457,14 @@ declare namespace sap {
3243
3457
  /**
3244
3458
  * Returns a metadata object for class sap.sac.df.FlexAnalysisPanel.
3245
3459
  *
3460
+ *
3246
3461
  * @returns Metadata object describing this class
3247
3462
  */
3248
3463
  static getMetadata(): sap.ui.core.ElementMetadata;
3249
3464
  /**
3250
3465
  * Destroys the content in the aggregation {@link #getContent content}.
3251
3466
  *
3467
+ *
3252
3468
  * @returns Reference to `this` in order to allow method chaining
3253
3469
  */
3254
3470
  destroyContent(): this;
@@ -3263,6 +3479,7 @@ declare namespace sap {
3263
3479
  *
3264
3480
  * The description of the panel, displayed as tooltip on the side navigation item.
3265
3481
  *
3482
+ *
3266
3483
  * @returns Value of property `description`
3267
3484
  */
3268
3485
  getDescription(): string;
@@ -3271,6 +3488,7 @@ declare namespace sap {
3271
3488
  *
3272
3489
  * The icon of the panel, displayed on the side navigation item and the panel header.
3273
3490
  *
3491
+ *
3274
3492
  * @returns Value of property `icon`
3275
3493
  */
3276
3494
  getIcon(): sap.ui.core.URI;
@@ -3279,12 +3497,14 @@ declare namespace sap {
3279
3497
  *
3280
3498
  * The title of the panel header.
3281
3499
  *
3500
+ *
3282
3501
  * @returns Value of property `title`
3283
3502
  */
3284
3503
  getTitle(): string;
3285
3504
  /**
3286
3505
  * Sets the aggregated {@link #getContent content}.
3287
3506
  *
3507
+ *
3288
3508
  * @returns Reference to `this` in order to allow method chaining
3289
3509
  */
3290
3510
  setContent(
@@ -3300,6 +3520,7 @@ declare namespace sap {
3300
3520
  *
3301
3521
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3302
3522
  *
3523
+ *
3303
3524
  * @returns Reference to `this` in order to allow method chaining
3304
3525
  */
3305
3526
  setDescription(
@@ -3315,6 +3536,7 @@ declare namespace sap {
3315
3536
  *
3316
3537
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3317
3538
  *
3539
+ *
3318
3540
  * @returns Reference to `this` in order to allow method chaining
3319
3541
  */
3320
3542
  setIcon(
@@ -3330,6 +3552,7 @@ declare namespace sap {
3330
3552
  *
3331
3553
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3332
3554
  *
3555
+ *
3333
3556
  * @returns Reference to `this` in order to allow method chaining
3334
3557
  */
3335
3558
  setTitle(