@sapui5/ts-types 1.101.0 → 1.102.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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 +1747 -124
  5. package/types/sap.chart.d.ts +375 -29
  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 +1785 -100
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +70 -2
  11. package/types/sap.fe.macros.d.ts +78 -34
  12. package/types/sap.fe.navigation.d.ts +144 -4
  13. package/types/sap.fe.templates.d.ts +26 -5
  14. package/types/sap.fe.test.d.ts +497 -2
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7203 -502
  17. package/types/sap.insights.d.ts +80 -0
  18. package/types/sap.landvisz.d.ts +1015 -66
  19. package/types/sap.m.d.ts +16686 -1152
  20. package/types/sap.makit.d.ts +575 -54
  21. package/types/sap.me.d.ts +578 -51
  22. package/types/sap.ndc.d.ts +63 -5
  23. package/types/sap.ovp.d.ts +5 -6
  24. package/types/sap.rules.ui.d.ts +171 -15
  25. package/types/sap.sac.df.d.ts +1430 -215
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5515 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +157 -69
  29. package/types/sap.suite.ui.microchart.d.ts +1801 -160
  30. package/types/sap.tnt.d.ts +279 -19
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3784 -313
  33. package/types/sap.ui.comp.d.ts +3853 -276
  34. package/types/sap.ui.core.d.ts +6248 -313
  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 +1 -1
  38. package/types/sap.ui.generic.app.d.ts +238 -64
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +316 -23
  41. package/types/sap.ui.layout.d.ts +1851 -199
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +340 -49
  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 +1050 -80
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2704 -202
  50. package/types/sap.ui.ux3.d.ts +2379 -181
  51. package/types/sap.ui.vbm.d.ts +2002 -197
  52. package/types/sap.ui.vk.d.ts +5353 -310
  53. package/types/sap.ui.vtm.d.ts +1130 -41
  54. package/types/sap.uiext.inbox.d.ts +423 -22
  55. package/types/sap.ushell.d.ts +1488 -49
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +902 -87
  58. package/types/sap.viz.d.ts +5514 -380
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +165 -20
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +227 -14
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.101.0
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -28,6 +28,8 @@ declare namespace sap {
28
28
  * the information contained in `oClassInfo`.
29
29
  *
30
30
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
31
+ *
32
+ * @returns Created class / constructor function
31
33
  */
32
34
  static extend<T extends Record<string, unknown>>(
33
35
  /**
@@ -46,6 +48,8 @@ declare namespace sap {
46
48
  ): Function;
47
49
  /**
48
50
  * Returns a metadata object for class sap.zen.dsh.widgets.SDKModel.
51
+ *
52
+ * @returns Metadata object describing this class
49
53
  */
50
54
  static getMetadata(): sap.ui.base.Metadata;
51
55
  }
@@ -57,21 +61,26 @@ declare namespace sap {
57
61
  */
58
62
  width?:
59
63
  | sap.ui.core.CSSSize
60
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
64
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
65
+ | `{${string}}`;
61
66
 
62
67
  /**
63
68
  * Desired width of the AnalyticGrid control
64
69
  */
65
70
  height?:
66
71
  | sap.ui.core.CSSSize
67
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
72
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
73
+ | `{${string}}`;
68
74
 
69
75
  /**
70
76
  * A SelectionVariant specifying the initial selection state used by the AnalyticGrid. Depending on the
71
77
  * specific query and selection variant state, this will result in setting one or more variables' values
72
78
  * and setting one or more filters on the datasource.
73
79
  */
74
- selection?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
80
+ selection?:
81
+ | object
82
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
83
+ | `{${string}}`;
75
84
 
76
85
  /**
77
86
  * Name of the Query to bind the AnalyticGrid to.
@@ -117,14 +126,16 @@ declare namespace sap {
117
126
  */
118
127
  width?:
119
128
  | sap.ui.core.CSSSize
120
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
129
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
130
+ | `{${string}}`;
121
131
 
122
132
  /**
123
133
  * Desired height of the Design Studio Control
124
134
  */
125
135
  height?:
126
136
  | sap.ui.core.CSSSize
127
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
137
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
138
+ | `{${string}}`;
128
139
 
129
140
  /**
130
141
  * the type of deployment
@@ -151,17 +162,24 @@ declare namespace sap {
151
162
  */
152
163
  semanticMappings?:
153
164
  | object
154
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
165
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
166
+ | `{${string}}`;
155
167
 
156
168
  /**
157
169
  * the application component
158
170
  */
159
- appComponent?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
171
+ appComponent?:
172
+ | object
173
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
174
+ | `{${string}}`;
160
175
 
161
176
  /**
162
177
  * whether to defer the creation
163
178
  */
164
- deferCreation?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
179
+ deferCreation?:
180
+ | boolean
181
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
182
+ | `{${string}}`;
165
183
 
166
184
  /**
167
185
  * the system alias
@@ -187,14 +205,18 @@ declare namespace sap {
187
205
  */
188
206
  supportMultiselect?:
189
207
  | boolean
190
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
208
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
209
+ | `{${string}}`;
191
210
 
192
211
  /**
193
212
  * @SINCE 1.24
194
213
  *
195
214
  * Enables the ranges (conditions) feature in the dialog.
196
215
  */
197
- supportRanges?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
216
+ supportRanges?:
217
+ | boolean
218
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
219
+ | `{${string}}`;
198
220
 
199
221
  /**
200
222
  * @SINCE 1.24
@@ -203,7 +225,8 @@ declare namespace sap {
203
225
  */
204
226
  supportRangesOnly?:
205
227
  | boolean
206
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
228
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
229
+ | `{${string}}`;
207
230
 
208
231
  /**
209
232
  * @SINCE 1.24
@@ -218,7 +241,10 @@ declare namespace sap {
218
241
  *
219
242
  * Defines the list of additional keys of the column used for the internal key handling.
220
243
  */
221
- keys?: string[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
244
+ keys?:
245
+ | string[]
246
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
247
+ | `{${string}}`;
222
248
 
223
249
  /**
224
250
  * @SINCE 1.24
@@ -268,7 +294,10 @@ declare namespace sap {
268
294
  *
269
295
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
270
296
  */
271
- filterMode?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
297
+ filterMode?:
298
+ | boolean
299
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
300
+ | `{${string}}`;
272
301
 
273
302
  /**
274
303
  * Allows you to add a {@link sap.ui.comp.filterbar.FilterBar FilterBar} or {@link sap.ui.comp.smartfilterbar.SmartFilterBar
@@ -362,6 +391,8 @@ declare namespace sap {
362
391
  * the information contained in `oClassInfo`.
363
392
  *
364
393
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
394
+ *
395
+ * @returns Created class / constructor function
365
396
  */
366
397
  static extend<T extends Record<string, unknown>>(
367
398
  /**
@@ -380,6 +411,8 @@ declare namespace sap {
380
411
  ): Function;
381
412
  /**
382
413
  * Returns a metadata object for class sap.zen.dsh.AnalyticGrid.
414
+ *
415
+ * @returns Metadata object describing this class
383
416
  */
384
417
  static getMetadata(): sap.ui.core.ElementMetadata;
385
418
  /**
@@ -390,6 +423,8 @@ declare namespace sap {
390
423
  * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
391
424
  *
392
425
  * Event is triggered when the selection is changed.
426
+ *
427
+ * @returns Reference to `this` in order to allow method chaining
393
428
  */
394
429
  attachSelectionChange(
395
430
  /**
@@ -414,6 +449,8 @@ declare namespace sap {
414
449
  * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
415
450
  *
416
451
  * Event is triggered when the selection is changed.
452
+ *
453
+ * @returns Reference to `this` in order to allow method chaining
417
454
  */
418
455
  attachSelectionChange(
419
456
  /**
@@ -432,6 +469,8 @@ declare namespace sap {
432
469
  * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
433
470
  *
434
471
  * Event is triggered when the state of the AnalyticGrid is changed.
472
+ *
473
+ * @returns Reference to `this` in order to allow method chaining
435
474
  */
436
475
  attachStateChange(
437
476
  /**
@@ -455,6 +494,8 @@ declare namespace sap {
455
494
  * otherwise it will be bound to this `sap.zen.dsh.AnalyticGrid` itself.
456
495
  *
457
496
  * Event is triggered when the state of the AnalyticGrid is changed.
497
+ *
498
+ * @returns Reference to `this` in order to allow method chaining
458
499
  */
459
500
  attachStateChange(
460
501
  /**
@@ -471,6 +512,8 @@ declare namespace sap {
471
512
  * this `sap.zen.dsh.AnalyticGrid`.
472
513
  *
473
514
  * The passed function and listener object must match the ones used for event registration.
515
+ *
516
+ * @returns Reference to `this` in order to allow method chaining
474
517
  */
475
518
  detachSelectionChange(
476
519
  /**
@@ -486,6 +529,8 @@ declare namespace sap {
486
529
  * Detaches event handler `fnFunction` from the {@link #event:stateChange stateChange} event of this `sap.zen.dsh.AnalyticGrid`.
487
530
  *
488
531
  * The passed function and listener object must match the ones used for event registration.
532
+ *
533
+ * @returns Reference to `this` in order to allow method chaining
489
534
  */
490
535
  detachStateChange(
491
536
  /**
@@ -499,6 +544,8 @@ declare namespace sap {
499
544
  ): this;
500
545
  /**
501
546
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
547
+ *
548
+ * @returns Reference to `this` in order to allow method chaining
502
549
  */
503
550
  fireSelectionChange(
504
551
  /**
@@ -513,6 +560,8 @@ declare namespace sap {
513
560
  ): this;
514
561
  /**
515
562
  * Fires event {@link #event:stateChange stateChange} to attached listeners.
563
+ *
564
+ * @returns Reference to `this` in order to allow method chaining
516
565
  */
517
566
  fireStateChange(
518
567
  /**
@@ -529,12 +578,16 @@ declare namespace sap {
529
578
  * Gets current value of property {@link #getHeight height}.
530
579
  *
531
580
  * Desired width of the AnalyticGrid control
581
+ *
582
+ * @returns Value of property `height`
532
583
  */
533
584
  getHeight(): sap.ui.core.CSSSize;
534
585
  /**
535
586
  * Gets current value of property {@link #getQueryName queryName}.
536
587
  *
537
588
  * Name of the Query to bind the AnalyticGrid to.
589
+ *
590
+ * @returns Value of property `queryName`
538
591
  */
539
592
  getQueryName(): string;
540
593
  /**
@@ -543,6 +596,8 @@ declare namespace sap {
543
596
  * A SelectionVariant specifying the initial selection state used by the AnalyticGrid. Depending on the
544
597
  * specific query and selection variant state, this will result in setting one or more variables' values
545
598
  * and setting one or more filters on the datasource.
599
+ *
600
+ * @returns Value of property `selection`
546
601
  */
547
602
  getSelection(): object;
548
603
  /**
@@ -551,18 +606,24 @@ declare namespace sap {
551
606
  * A string representing the current state of the analytic grid, including data selection and navigation
552
607
  * state. Intended to be used for saving and recreating inner application state in navigation scenarios,
553
608
  * for example.
609
+ *
610
+ * @returns Value of property `state`
554
611
  */
555
612
  getState(): string;
556
613
  /**
557
614
  * Gets current value of property {@link #getSystemAlias systemAlias}.
558
615
  *
559
616
  * Target System alias for data connectivity
617
+ *
618
+ * @returns Value of property `systemAlias`
560
619
  */
561
620
  getSystemAlias(): string;
562
621
  /**
563
622
  * Gets current value of property {@link #getWidth width}.
564
623
  *
565
624
  * Desired width of the AnalyticGrid control
625
+ *
626
+ * @returns Value of property `width`
566
627
  */
567
628
  getWidth(): sap.ui.core.CSSSize;
568
629
  /**
@@ -571,6 +632,8 @@ declare namespace sap {
571
632
  * Desired width of the AnalyticGrid control
572
633
  *
573
634
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
635
+ *
636
+ * @returns Reference to `this` in order to allow method chaining
574
637
  */
575
638
  setHeight(
576
639
  /**
@@ -584,6 +647,8 @@ declare namespace sap {
584
647
  * Name of the Query to bind the AnalyticGrid to.
585
648
  *
586
649
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
650
+ *
651
+ * @returns Reference to `this` in order to allow method chaining
587
652
  */
588
653
  setQueryName(
589
654
  /**
@@ -599,6 +664,8 @@ declare namespace sap {
599
664
  * and setting one or more filters on the datasource.
600
665
  *
601
666
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
667
+ *
668
+ * @returns Reference to `this` in order to allow method chaining
602
669
  */
603
670
  setSelection(
604
671
  /**
@@ -614,6 +681,8 @@ declare namespace sap {
614
681
  * for example.
615
682
  *
616
683
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
684
+ *
685
+ * @returns Reference to `this` in order to allow method chaining
617
686
  */
618
687
  setState(
619
688
  /**
@@ -627,6 +696,8 @@ declare namespace sap {
627
696
  * Target System alias for data connectivity
628
697
  *
629
698
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
699
+ *
700
+ * @returns Reference to `this` in order to allow method chaining
630
701
  */
631
702
  setSystemAlias(
632
703
  /**
@@ -640,6 +711,8 @@ declare namespace sap {
640
711
  * Desired width of the AnalyticGrid control
641
712
  *
642
713
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
714
+ *
715
+ * @returns Reference to `this` in order to allow method chaining
643
716
  */
644
717
  setWidth(
645
718
  /**
@@ -691,6 +764,8 @@ declare namespace sap {
691
764
  * contained in `oClassInfo`.
692
765
  *
693
766
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
767
+ *
768
+ * @returns Created class / constructor function
694
769
  */
695
770
  static extend<T extends Record<string, unknown>>(
696
771
  /**
@@ -709,6 +784,8 @@ declare namespace sap {
709
784
  ): Function;
710
785
  /**
711
786
  * Returns a metadata object for class sap.zen.dsh.Dsh.
787
+ *
788
+ * @returns Metadata object describing this class
712
789
  */
713
790
  static getMetadata(): sap.ui.core.ElementMetadata;
714
791
 
@@ -735,12 +812,16 @@ declare namespace sap {
735
812
  * Gets current value of property {@link #getAppComponent appComponent}.
736
813
  *
737
814
  * the application component
815
+ *
816
+ * @returns Value of property `appComponent`
738
817
  */
739
818
  getAppComponent(): object;
740
819
  /**
741
820
  * Gets current value of property {@link #getClient client}.
742
821
  *
743
822
  * the client
823
+ *
824
+ * @returns Value of property `client`
744
825
  */
745
826
  getClient(): string;
746
827
 
@@ -763,6 +844,8 @@ declare namespace sap {
763
844
  * whether to defer the creation
764
845
  *
765
846
  * Default value is `false`.
847
+ *
848
+ * @returns Value of property `deferCreation`
766
849
  */
767
850
  getDeferCreation(): boolean;
768
851
  /**
@@ -771,6 +854,8 @@ declare namespace sap {
771
854
  * the type of deployment
772
855
  *
773
856
  * Default value is `"bw"`.
857
+ *
858
+ * @returns Value of property `deployment`
774
859
  */
775
860
  getDeployment(): string;
776
861
  /**
@@ -779,18 +864,24 @@ declare namespace sap {
779
864
  * Name of the Design Studio application to be opened.
780
865
  *
781
866
  * Default value is `"0ANALYSIS"`.
867
+ *
868
+ * @returns Value of property `dshAppName`
782
869
  */
783
870
  getDshAppName(): string;
784
871
  /**
785
872
  * Gets current value of property {@link #getHeight height}.
786
873
  *
787
874
  * Desired height of the Design Studio Control
875
+ *
876
+ * @returns Value of property `height`
788
877
  */
789
878
  getHeight(): sap.ui.core.CSSSize;
790
879
  /**
791
880
  * Gets current value of property {@link #getLanguage language}.
792
881
  *
793
882
  * the language
883
+ *
884
+ * @returns Value of property `language`
794
885
  */
795
886
  getLanguage(): string;
796
887
 
@@ -799,30 +890,40 @@ declare namespace sap {
799
890
  * Gets current value of property {@link #getProtocol protocol}.
800
891
  *
801
892
  * the protocol
893
+ *
894
+ * @returns Value of property `protocol`
802
895
  */
803
896
  getProtocol(): string;
804
897
  /**
805
898
  * Gets current value of property {@link #getRepoPath repoPath}.
806
899
  *
807
900
  * Path to application specified by dshAppName
901
+ *
902
+ * @returns Value of property `repoPath`
808
903
  */
809
904
  getRepoPath(): string;
810
905
  /**
811
906
  * Gets current value of property {@link #getSemanticMappings semanticMappings}.
812
907
  *
813
908
  * the semantic mappings
909
+ *
910
+ * @returns Value of property `semanticMappings`
814
911
  */
815
912
  getSemanticMappings(): object;
816
913
  /**
817
914
  * Gets current value of property {@link #getSystemAlias systemAlias}.
818
915
  *
819
916
  * the system alias
917
+ *
918
+ * @returns Value of property `systemAlias`
820
919
  */
821
920
  getSystemAlias(): string;
822
921
  /**
823
922
  * Gets current value of property {@link #getWidth width}.
824
923
  *
825
924
  * Desired width of the Design Studio Control
925
+ *
926
+ * @returns Value of property `width`
826
927
  */
827
928
  getWidth(): sap.ui.core.CSSSize;
828
929
  /**
@@ -857,6 +958,8 @@ declare namespace sap {
857
958
  * the application component
858
959
  *
859
960
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
961
+ *
962
+ * @returns Reference to `this` in order to allow method chaining
860
963
  */
861
964
  setAppComponent(
862
965
  /**
@@ -870,6 +973,8 @@ declare namespace sap {
870
973
  * the client
871
974
  *
872
975
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
976
+ *
977
+ * @returns Reference to `this` in order to allow method chaining
873
978
  */
874
979
  setClient(
875
980
  /**
@@ -885,6 +990,8 @@ declare namespace sap {
885
990
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
886
991
  *
887
992
  * Default value is `false`.
993
+ *
994
+ * @returns Reference to `this` in order to allow method chaining
888
995
  */
889
996
  setDeferCreation(
890
997
  /**
@@ -900,6 +1007,8 @@ declare namespace sap {
900
1007
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
901
1008
  *
902
1009
  * Default value is `"bw"`.
1010
+ *
1011
+ * @returns Reference to `this` in order to allow method chaining
903
1012
  */
904
1013
  setDeployment(
905
1014
  /**
@@ -915,6 +1024,8 @@ declare namespace sap {
915
1024
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
916
1025
  *
917
1026
  * Default value is `"0ANALYSIS"`.
1027
+ *
1028
+ * @returns Reference to `this` in order to allow method chaining
918
1029
  */
919
1030
  setDshAppName(
920
1031
  /**
@@ -928,6 +1039,8 @@ declare namespace sap {
928
1039
  * Desired height of the Design Studio Control
929
1040
  *
930
1041
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1042
+ *
1043
+ * @returns Reference to `this` in order to allow method chaining
931
1044
  */
932
1045
  setHeight(
933
1046
  /**
@@ -941,6 +1054,8 @@ declare namespace sap {
941
1054
  * the language
942
1055
  *
943
1056
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1057
+ *
1058
+ * @returns Reference to `this` in order to allow method chaining
944
1059
  */
945
1060
  setLanguage(
946
1061
  /**
@@ -954,6 +1069,8 @@ declare namespace sap {
954
1069
  * the protocol
955
1070
  *
956
1071
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1072
+ *
1073
+ * @returns Reference to `this` in order to allow method chaining
957
1074
  */
958
1075
  setProtocol(
959
1076
  /**
@@ -967,6 +1084,8 @@ declare namespace sap {
967
1084
  * Path to application specified by dshAppName
968
1085
  *
969
1086
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1087
+ *
1088
+ * @returns Reference to `this` in order to allow method chaining
970
1089
  */
971
1090
  setRepoPath(
972
1091
  /**
@@ -980,6 +1099,8 @@ declare namespace sap {
980
1099
  * the semantic mappings
981
1100
  *
982
1101
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1102
+ *
1103
+ * @returns Reference to `this` in order to allow method chaining
983
1104
  */
984
1105
  setSemanticMappings(
985
1106
  /**
@@ -993,6 +1114,8 @@ declare namespace sap {
993
1114
  * the system alias
994
1115
  *
995
1116
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1117
+ *
1118
+ * @returns Reference to `this` in order to allow method chaining
996
1119
  */
997
1120
  setSystemAlias(
998
1121
  /**
@@ -1006,6 +1129,8 @@ declare namespace sap {
1006
1129
  * Desired width of the Design Studio Control
1007
1130
  *
1008
1131
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1132
+ *
1133
+ * @returns Reference to `this` in order to allow method chaining
1009
1134
  */
1010
1135
  setWidth(
1011
1136
  /**
@@ -1056,6 +1181,8 @@ declare namespace sap {
1056
1181
  * the information contained in `oClassInfo`.
1057
1182
  *
1058
1183
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
1184
+ *
1185
+ * @returns Created class / constructor function
1059
1186
  */
1060
1187
  static extend<T extends Record<string, unknown>>(
1061
1188
  /**
@@ -1074,6 +1201,8 @@ declare namespace sap {
1074
1201
  ): Function;
1075
1202
  /**
1076
1203
  * Returns a metadata object for class sap.zen.dsh.ValueHelpDialog.
1204
+ *
1205
+ * @returns Metadata object describing this class
1077
1206
  */
1078
1207
  static getMetadata(): sap.ui.core.ElementMetadata;
1079
1208
  /**
@@ -1085,6 +1214,8 @@ declare namespace sap {
1085
1214
  * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1086
1215
  *
1087
1216
  * This event is fired when the Cancel button is pressed.
1217
+ *
1218
+ * @returns Reference to `this` in order to allow method chaining
1088
1219
  */
1089
1220
  attachCancel(
1090
1221
  /**
@@ -1110,6 +1241,8 @@ declare namespace sap {
1110
1241
  * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1111
1242
  *
1112
1243
  * This event is fired when the Cancel button is pressed.
1244
+ *
1245
+ * @returns Reference to `this` in order to allow method chaining
1113
1246
  */
1114
1247
  attachCancel(
1115
1248
  /**
@@ -1130,6 +1263,8 @@ declare namespace sap {
1130
1263
  * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1131
1264
  *
1132
1265
  * This event is fired when the OK button is pressed.
1266
+ *
1267
+ * @returns Reference to `this` in order to allow method chaining
1133
1268
  */
1134
1269
  attachOk(
1135
1270
  /**
@@ -1155,6 +1290,8 @@ declare namespace sap {
1155
1290
  * otherwise it will be bound to this `sap.zen.dsh.ValueHelpDialog` itself.
1156
1291
  *
1157
1292
  * This event is fired when the OK button is pressed.
1293
+ *
1294
+ * @returns Reference to `this` in order to allow method chaining
1158
1295
  */
1159
1296
  attachOk(
1160
1297
  /**
@@ -1178,6 +1315,8 @@ declare namespace sap {
1178
1315
  * This event is fired when the user selects an item in the items table.
1179
1316
  *
1180
1317
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1318
+ *
1319
+ * @returns Reference to `this` in order to allow method chaining
1181
1320
  */
1182
1321
  attachSelectionChange(
1183
1322
  /**
@@ -1206,6 +1345,8 @@ declare namespace sap {
1206
1345
  * This event is fired when the user selects an item in the items table.
1207
1346
  *
1208
1347
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1348
+ *
1349
+ * @returns Reference to `this` in order to allow method chaining
1209
1350
  */
1210
1351
  attachSelectionChange(
1211
1352
  /**
@@ -1228,6 +1369,8 @@ declare namespace sap {
1228
1369
  * This event is fired when the user removes one or multiple existing token(s) from the dialog.
1229
1370
  *
1230
1371
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1372
+ *
1373
+ * @returns Reference to `this` in order to allow method chaining
1231
1374
  */
1232
1375
  attachTokenRemove(
1233
1376
  /**
@@ -1255,6 +1398,8 @@ declare namespace sap {
1255
1398
  * This event is fired when the user removes one or multiple existing token(s) from the dialog.
1256
1399
  *
1257
1400
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1401
+ *
1402
+ * @returns Reference to `this` in order to allow method chaining
1258
1403
  */
1259
1404
  attachTokenRemove(
1260
1405
  /**
@@ -1278,6 +1423,8 @@ declare namespace sap {
1278
1423
  * This event is fired when the table gets an update and all existing tokens must be selected in the table.
1279
1424
  *
1280
1425
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1426
+ *
1427
+ * @returns Reference to `this` in order to allow method chaining
1281
1428
  */
1282
1429
  attachUpdateSelection(
1283
1430
  /**
@@ -1306,6 +1453,8 @@ declare namespace sap {
1306
1453
  * This event is fired when the table gets an update and all existing tokens must be selected in the table.
1307
1454
  *
1308
1455
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1456
+ *
1457
+ * @returns Reference to `this` in order to allow method chaining
1309
1458
  */
1310
1459
  attachUpdateSelection(
1311
1460
  /**
@@ -1319,6 +1468,8 @@ declare namespace sap {
1319
1468
  ): this;
1320
1469
  /**
1321
1470
  * Destroys the filterBar in the aggregation {@link #getFilterBar filterBar}.
1471
+ *
1472
+ * @returns Reference to `this` in order to allow method chaining
1322
1473
  */
1323
1474
  destroyFilterBar(): this;
1324
1475
  /**
@@ -1327,6 +1478,8 @@ declare namespace sap {
1327
1478
  * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1328
1479
  *
1329
1480
  * The passed function and listener object must match the ones used for event registration.
1481
+ *
1482
+ * @returns Reference to `this` in order to allow method chaining
1330
1483
  */
1331
1484
  detachCancel(
1332
1485
  /**
@@ -1344,6 +1497,8 @@ declare namespace sap {
1344
1497
  * Detaches event handler `fnFunction` from the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1345
1498
  *
1346
1499
  * The passed function and listener object must match the ones used for event registration.
1500
+ *
1501
+ * @returns Reference to `this` in order to allow method chaining
1347
1502
  */
1348
1503
  detachOk(
1349
1504
  /**
@@ -1362,6 +1517,8 @@ declare namespace sap {
1362
1517
  * this `sap.zen.dsh.ValueHelpDialog`.
1363
1518
  *
1364
1519
  * The passed function and listener object must match the ones used for event registration.
1520
+ *
1521
+ * @returns Reference to `this` in order to allow method chaining
1365
1522
  */
1366
1523
  detachSelectionChange(
1367
1524
  /**
@@ -1379,6 +1536,8 @@ declare namespace sap {
1379
1536
  * Detaches event handler `fnFunction` from the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1380
1537
  *
1381
1538
  * The passed function and listener object must match the ones used for event registration.
1539
+ *
1540
+ * @returns Reference to `this` in order to allow method chaining
1382
1541
  */
1383
1542
  detachTokenRemove(
1384
1543
  /**
@@ -1397,6 +1556,8 @@ declare namespace sap {
1397
1556
  * this `sap.zen.dsh.ValueHelpDialog`.
1398
1557
  *
1399
1558
  * The passed function and listener object must match the ones used for event registration.
1559
+ *
1560
+ * @returns Reference to `this` in order to allow method chaining
1400
1561
  */
1401
1562
  detachUpdateSelection(
1402
1563
  /**
@@ -1412,6 +1573,8 @@ declare namespace sap {
1412
1573
  * @SINCE 1.24
1413
1574
  *
1414
1575
  * Fires event {@link #event:cancel cancel} to attached listeners.
1576
+ *
1577
+ * @returns Reference to `this` in order to allow method chaining
1415
1578
  */
1416
1579
  fireCancel(
1417
1580
  /**
@@ -1423,6 +1586,8 @@ declare namespace sap {
1423
1586
  * @SINCE 1.24
1424
1587
  *
1425
1588
  * Fires event {@link #event:ok ok} to attached listeners.
1589
+ *
1590
+ * @returns Reference to `this` in order to allow method chaining
1426
1591
  */
1427
1592
  fireOk(
1428
1593
  /**
@@ -1439,6 +1604,8 @@ declare namespace sap {
1439
1604
  * @SINCE 1.32
1440
1605
  *
1441
1606
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
1607
+ *
1608
+ * @returns Reference to `this` in order to allow method chaining
1442
1609
  */
1443
1610
  fireSelectionChange(
1444
1611
  /**
@@ -1465,6 +1632,8 @@ declare namespace sap {
1465
1632
  * @SINCE 1.32
1466
1633
  *
1467
1634
  * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
1635
+ *
1636
+ * @returns Reference to `this` in order to allow method chaining
1468
1637
  */
1469
1638
  fireTokenRemove(
1470
1639
  /**
@@ -1485,6 +1654,8 @@ declare namespace sap {
1485
1654
  * @SINCE 1.32
1486
1655
  *
1487
1656
  * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
1657
+ *
1658
+ * @returns Reference to `this` in order to allow method chaining
1488
1659
  */
1489
1660
  fireUpdateSelection(
1490
1661
  /**
@@ -1510,6 +1681,8 @@ declare namespace sap {
1510
1681
  * bar used.
1511
1682
  *
1512
1683
  * Default value is `empty string`.
1684
+ *
1685
+ * @returns Value of property `basicSearchText`
1513
1686
  */
1514
1687
  getBasicSearchText(): string;
1515
1688
  /**
@@ -1520,6 +1693,8 @@ declare namespace sap {
1520
1693
  * Defines the key of the column used for the token text.
1521
1694
  *
1522
1695
  * Default value is `empty string`.
1696
+ *
1697
+ * @returns Value of property `descriptionKey`
1523
1698
  */
1524
1699
  getDescriptionKey(): string;
1525
1700
  /**
@@ -1531,6 +1706,8 @@ declare namespace sap {
1531
1706
  * value of the range (condition) is converted to uppercase letters.
1532
1707
  *
1533
1708
  * Default value is `empty string`.
1709
+ *
1710
+ * @returns Value of property `displayFormat`
1534
1711
  */
1535
1712
  getDisplayFormat(): string;
1536
1713
  /**
@@ -1541,6 +1718,8 @@ declare namespace sap {
1541
1718
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1542
1719
  *
1543
1720
  * Default value is `false`.
1721
+ *
1722
+ * @returns Value of property `filterMode`
1544
1723
  */
1545
1724
  getFilterMode(): boolean;
1546
1725
  /**
@@ -1552,6 +1731,8 @@ declare namespace sap {
1552
1731
  * the token key and also to identify the row in the table.
1553
1732
  *
1554
1733
  * Default value is `empty string`.
1734
+ *
1735
+ * @returns Value of property `key`
1555
1736
  */
1556
1737
  getKey(): string;
1557
1738
  /**
@@ -1560,6 +1741,8 @@ declare namespace sap {
1560
1741
  * Gets current value of property {@link #getKeys keys}.
1561
1742
  *
1562
1743
  * Defines the list of additional keys of the column used for the internal key handling.
1744
+ *
1745
+ * @returns Value of property `keys`
1563
1746
  */
1564
1747
  getKeys(): string[];
1565
1748
  /**
@@ -1570,6 +1753,8 @@ declare namespace sap {
1570
1753
  * Defines the maximum number of exclude ranges.
1571
1754
  *
1572
1755
  * Default value is `"-1"`.
1756
+ *
1757
+ * @returns Value of property `maxExcludeRanges`
1573
1758
  */
1574
1759
  getMaxExcludeRanges(): string;
1575
1760
  /**
@@ -1580,6 +1765,8 @@ declare namespace sap {
1580
1765
  * Defines the maximum number of include ranges.
1581
1766
  *
1582
1767
  * Default value is `"-1"`.
1768
+ *
1769
+ * @returns Value of property `maxIncludeRanges`
1583
1770
  */
1584
1771
  getMaxIncludeRanges(): string;
1585
1772
  /**
@@ -1590,6 +1777,8 @@ declare namespace sap {
1590
1777
  * Enables multi-selection in the table used.
1591
1778
  *
1592
1779
  * Default value is `true`.
1780
+ *
1781
+ * @returns Value of property `supportMultiselect`
1593
1782
  */
1594
1783
  getSupportMultiselect(): boolean;
1595
1784
  /**
@@ -1600,6 +1789,8 @@ declare namespace sap {
1600
1789
  * Enables the ranges (conditions) feature in the dialog.
1601
1790
  *
1602
1791
  * Default value is `false`.
1792
+ *
1793
+ * @returns Value of property `supportRanges`
1603
1794
  */
1604
1795
  getSupportRanges(): boolean;
1605
1796
  /**
@@ -1610,12 +1801,16 @@ declare namespace sap {
1610
1801
  * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1611
1802
  *
1612
1803
  * Default value is `false`.
1804
+ *
1805
+ * @returns Value of property `supportRangesOnly`
1613
1806
  */
1614
1807
  getSupportRangesOnly(): boolean;
1615
1808
  /**
1616
1809
  * @SINCE 1.28
1617
1810
  *
1618
1811
  * getTable Gives access to the internal table instance.
1812
+ *
1813
+ * @returns the used table instance
1619
1814
  */
1620
1815
  getTable(): object;
1621
1816
  /**
@@ -1627,6 +1822,8 @@ declare namespace sap {
1627
1822
  * values.
1628
1823
  *
1629
1824
  * Default value is `empty string`.
1825
+ *
1826
+ * @returns Value of property `tokenDisplayBehaviour`
1630
1827
  */
1631
1828
  getTokenDisplayBehaviour(): string;
1632
1829
  /**
@@ -1639,6 +1836,8 @@ declare namespace sap {
1639
1836
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1640
1837
  *
1641
1838
  * Default value is `empty string`.
1839
+ *
1840
+ * @returns Reference to `this` in order to allow method chaining
1642
1841
  */
1643
1842
  setDescriptionKey(
1644
1843
  /**
@@ -1657,6 +1856,8 @@ declare namespace sap {
1657
1856
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1658
1857
  *
1659
1858
  * Default value is `empty string`.
1859
+ *
1860
+ * @returns Reference to `this` in order to allow method chaining
1660
1861
  */
1661
1862
  setDisplayFormat(
1662
1863
  /**
@@ -1689,6 +1890,8 @@ declare namespace sap {
1689
1890
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1690
1891
  *
1691
1892
  * Default value is `false`.
1893
+ *
1894
+ * @returns Reference to `this` in order to allow method chaining
1692
1895
  */
1693
1896
  setFilterMode(
1694
1897
  /**
@@ -1722,6 +1925,8 @@ declare namespace sap {
1722
1925
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1723
1926
  *
1724
1927
  * Default value is `empty string`.
1928
+ *
1929
+ * @returns Reference to `this` in order to allow method chaining
1725
1930
  */
1726
1931
  setKey(
1727
1932
  /**
@@ -1737,6 +1942,8 @@ declare namespace sap {
1737
1942
  * Defines the list of additional keys of the column used for the internal key handling.
1738
1943
  *
1739
1944
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1945
+ *
1946
+ * @returns Reference to `this` in order to allow method chaining
1740
1947
  */
1741
1948
  setKeys(
1742
1949
  /**
@@ -1754,6 +1961,8 @@ declare namespace sap {
1754
1961
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1755
1962
  *
1756
1963
  * Default value is `"-1"`.
1964
+ *
1965
+ * @returns Reference to `this` in order to allow method chaining
1757
1966
  */
1758
1967
  setMaxExcludeRanges(
1759
1968
  /**
@@ -1771,6 +1980,8 @@ declare namespace sap {
1771
1980
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1772
1981
  *
1773
1982
  * Default value is `"-1"`.
1983
+ *
1984
+ * @returns Reference to `this` in order to allow method chaining
1774
1985
  */
1775
1986
  setMaxIncludeRanges(
1776
1987
  /**
@@ -1813,6 +2024,8 @@ declare namespace sap {
1813
2024
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1814
2025
  *
1815
2026
  * Default value is `empty string`.
2027
+ *
2028
+ * @returns Reference to `this` in order to allow method chaining
1816
2029
  */
1817
2030
  setTokenDisplayBehaviour(
1818
2031
  /**