@sapui5/types 1.120.7 → 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 +1112 -544
  5. package/types/sap.chart.d.ts +191 -43
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1870
  8. package/types/sap.f.d.ts +1605 -885
  9. package/types/sap.fe.core.d.ts +221 -191
  10. package/types/sap.fe.macros.d.ts +461 -568
  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 +9 -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 +3938 -1749
  19. package/types/sap.insights.d.ts +165 -43
  20. package/types/sap.m.d.ts +14948 -8390
  21. package/types/sap.makit.d.ts +377 -185
  22. package/types/sap.me.d.ts +235 -35
  23. package/types/sap.ndc.d.ts +40 -9
  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 +270 -47
  27. package/types/sap.suite.ui.commons.d.ts +4323 -1016
  28. package/types/sap.suite.ui.generic.template.d.ts +236 -171
  29. package/types/sap.suite.ui.microchart.d.ts +1024 -388
  30. package/types/sap.tnt.d.ts +904 -294
  31. package/types/sap.ui.codeeditor.d.ts +55 -22
  32. package/types/sap.ui.commons.d.ts +2084 -676
  33. package/types/sap.ui.comp.d.ts +3909 -2996
  34. package/types/sap.ui.core.d.ts +5771 -3523
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +88 -67
  37. package/types/sap.ui.fl.d.ts +184 -112
  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 +496 -390
  41. package/types/sap.ui.layout.d.ts +1337 -668
  42. package/types/sap.ui.mdc.d.ts +3384 -2021
  43. package/types/sap.ui.richtexteditor.d.ts +115 -55
  44. package/types/sap.ui.rta.d.ts +7 -7
  45. package/types/sap.ui.suite.d.ts +44 -10
  46. package/types/sap.ui.support.d.ts +58 -26
  47. package/types/sap.ui.table.d.ts +962 -626
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1976 -1246
  50. package/types/sap.ui.ux3.d.ts +1308 -488
  51. package/types/sap.ui.vbm.d.ts +6081 -3279
  52. package/types/sap.ui.vk.d.ts +2742 -837
  53. package/types/sap.ui.vtm.d.ts +681 -211
  54. package/types/sap.ui.webc.common.d.ts +7 -5
  55. package/types/sap.ui.webc.fiori.d.ts +884 -213
  56. package/types/sap.ui.webc.main.d.ts +2813 -599
  57. package/types/sap.uiext.inbox.d.ts +207 -36
  58. package/types/sap.ushell.d.ts +4972 -4262
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +621 -319
  61. package/types/sap.viz.d.ts +4118 -2318
  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 +81 -13
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.3
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/zen/dsh/library" {}
4
4
 
@@ -14,11 +14,11 @@ declare module "sap/zen/dsh/AnalyticGrid" {
14
14
  import Event from "sap/ui/base/Event";
15
15
 
16
16
  /**
17
+ * Control for embedding a Design Studio Analytic Grid in an S/4 HANA Fiori application
18
+ *
17
19
  * @since 1.46
18
20
  * @deprecated (since 1.89.0)
19
21
  * @experimental (since 1.46) - API is incomplete and may change incompatibly
20
- *
21
- * Control for embedding a Design Studio Analytic Grid in an S/4 HANA Fiori application
22
22
  */
23
23
  export default class AnalyticGrid extends Control {
24
24
  /**
@@ -58,6 +58,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
58
58
  *
59
59
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
60
60
  *
61
+ *
61
62
  * @returns Created class / constructor function
62
63
  */
63
64
  static extend<T extends Record<string, unknown>>(
@@ -78,6 +79,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
78
79
  /**
79
80
  * Returns a metadata object for class sap.zen.dsh.AnalyticGrid.
80
81
  *
82
+ *
81
83
  * @returns Metadata object describing this class
82
84
  */
83
85
  static getMetadata(): ElementMetadata;
@@ -90,6 +92,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
90
92
  *
91
93
  * Event is triggered when the selection is changed.
92
94
  *
95
+ *
93
96
  * @returns Reference to `this` in order to allow method chaining
94
97
  */
95
98
  attachSelectionChange(
@@ -116,6 +119,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
116
119
  *
117
120
  * Event is triggered when the selection is changed.
118
121
  *
122
+ *
119
123
  * @returns Reference to `this` in order to allow method chaining
120
124
  */
121
125
  attachSelectionChange(
@@ -136,6 +140,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
136
140
  *
137
141
  * Event is triggered when the state of the AnalyticGrid is changed.
138
142
  *
143
+ *
139
144
  * @returns Reference to `this` in order to allow method chaining
140
145
  */
141
146
  attachStateChange(
@@ -161,6 +166,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
161
166
  *
162
167
  * Event is triggered when the state of the AnalyticGrid is changed.
163
168
  *
169
+ *
164
170
  * @returns Reference to `this` in order to allow method chaining
165
171
  */
166
172
  attachStateChange(
@@ -179,6 +185,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
179
185
  *
180
186
  * The passed function and listener object must match the ones used for event registration.
181
187
  *
188
+ *
182
189
  * @returns Reference to `this` in order to allow method chaining
183
190
  */
184
191
  detachSelectionChange(
@@ -196,6 +203,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
196
203
  *
197
204
  * The passed function and listener object must match the ones used for event registration.
198
205
  *
206
+ *
199
207
  * @returns Reference to `this` in order to allow method chaining
200
208
  */
201
209
  detachStateChange(
@@ -209,10 +217,10 @@ declare module "sap/zen/dsh/AnalyticGrid" {
209
217
  oListener?: object
210
218
  ): this;
211
219
  /**
212
- * @ui5-protected Do not call from applications (only from related classes in the framework)
213
- *
214
220
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
215
221
  *
222
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
223
+ *
216
224
  * @returns Reference to `this` in order to allow method chaining
217
225
  */
218
226
  fireSelectionChange(
@@ -222,10 +230,10 @@ declare module "sap/zen/dsh/AnalyticGrid" {
222
230
  mParameters?: AnalyticGrid$SelectionChangeEventParameters
223
231
  ): this;
224
232
  /**
225
- * @ui5-protected Do not call from applications (only from related classes in the framework)
226
- *
227
233
  * Fires event {@link #event:stateChange stateChange} to attached listeners.
228
234
  *
235
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
236
+ *
229
237
  * @returns Reference to `this` in order to allow method chaining
230
238
  */
231
239
  fireStateChange(
@@ -239,6 +247,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
239
247
  *
240
248
  * Desired width of the AnalyticGrid control
241
249
  *
250
+ *
242
251
  * @returns Value of property `height`
243
252
  */
244
253
  getHeight(): CSSSize;
@@ -247,6 +256,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
247
256
  *
248
257
  * Name of the Query to bind the AnalyticGrid to.
249
258
  *
259
+ *
250
260
  * @returns Value of property `queryName`
251
261
  */
252
262
  getQueryName(): string;
@@ -257,6 +267,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
257
267
  * specific query and selection variant state, this will result in setting one or more variables' values
258
268
  * and setting one or more filters on the datasource.
259
269
  *
270
+ *
260
271
  * @returns Value of property `selection`
261
272
  */
262
273
  getSelection(): object;
@@ -267,6 +278,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
267
278
  * state. Intended to be used for saving and recreating inner application state in navigation scenarios,
268
279
  * for example.
269
280
  *
281
+ *
270
282
  * @returns Value of property `state`
271
283
  */
272
284
  getState(): string;
@@ -275,6 +287,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
275
287
  *
276
288
  * Target System alias for data connectivity
277
289
  *
290
+ *
278
291
  * @returns Value of property `systemAlias`
279
292
  */
280
293
  getSystemAlias(): string;
@@ -283,6 +296,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
283
296
  *
284
297
  * Desired width of the AnalyticGrid control
285
298
  *
299
+ *
286
300
  * @returns Value of property `width`
287
301
  */
288
302
  getWidth(): CSSSize;
@@ -293,6 +307,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
293
307
  *
294
308
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
295
309
  *
310
+ *
296
311
  * @returns Reference to `this` in order to allow method chaining
297
312
  */
298
313
  setHeight(
@@ -308,6 +323,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
308
323
  *
309
324
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
310
325
  *
326
+ *
311
327
  * @returns Reference to `this` in order to allow method chaining
312
328
  */
313
329
  setQueryName(
@@ -325,6 +341,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
325
341
  *
326
342
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
327
343
  *
344
+ *
328
345
  * @returns Reference to `this` in order to allow method chaining
329
346
  */
330
347
  setSelection(
@@ -342,6 +359,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
342
359
  *
343
360
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
344
361
  *
362
+ *
345
363
  * @returns Reference to `this` in order to allow method chaining
346
364
  */
347
365
  setState(
@@ -357,6 +375,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
357
375
  *
358
376
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
359
377
  *
378
+ *
360
379
  * @returns Reference to `this` in order to allow method chaining
361
380
  */
362
381
  setSystemAlias(
@@ -372,6 +391,7 @@ declare module "sap/zen/dsh/AnalyticGrid" {
372
391
  *
373
392
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
374
393
  *
394
+ *
375
395
  * @returns Reference to `this` in order to allow method chaining
376
396
  */
377
397
  setWidth(
@@ -463,10 +483,10 @@ declare module "sap/zen/dsh/Dsh" {
463
483
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
464
484
 
465
485
  /**
486
+ * Control for embedding a Design Studio application full-screen in an S/4 HANA Fiori application
487
+ *
466
488
  * @since 1.44
467
489
  * @deprecated (since 1.89)
468
- *
469
- * Control for embedding a Design Studio application full-screen in an S/4 HANA Fiori application
470
490
  */
471
491
  export default class Dsh extends Control {
472
492
  /**
@@ -506,6 +526,7 @@ declare module "sap/zen/dsh/Dsh" {
506
526
  *
507
527
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
508
528
  *
529
+ *
509
530
  * @returns Created class / constructor function
510
531
  */
511
532
  static extend<T extends Record<string, unknown>>(
@@ -526,6 +547,7 @@ declare module "sap/zen/dsh/Dsh" {
526
547
  /**
527
548
  * Returns a metadata object for class sap.zen.dsh.Dsh.
528
549
  *
550
+ *
529
551
  * @returns Metadata object describing this class
530
552
  */
531
553
  static getMetadata(): ElementMetadata;
@@ -554,6 +576,7 @@ declare module "sap/zen/dsh/Dsh" {
554
576
  *
555
577
  * the application component
556
578
  *
579
+ *
557
580
  * @returns Value of property `appComponent`
558
581
  */
559
582
  getAppComponent(): object;
@@ -562,6 +585,7 @@ declare module "sap/zen/dsh/Dsh" {
562
585
  *
563
586
  * the client
564
587
  *
588
+ *
565
589
  * @returns Value of property `client`
566
590
  */
567
591
  getClient(): string;
@@ -586,6 +610,7 @@ declare module "sap/zen/dsh/Dsh" {
586
610
  *
587
611
  * Default value is `false`.
588
612
  *
613
+ *
589
614
  * @returns Value of property `deferCreation`
590
615
  */
591
616
  getDeferCreation(): boolean;
@@ -596,6 +621,7 @@ declare module "sap/zen/dsh/Dsh" {
596
621
  *
597
622
  * Default value is `"bw"`.
598
623
  *
624
+ *
599
625
  * @returns Value of property `deployment`
600
626
  */
601
627
  getDeployment(): string;
@@ -606,6 +632,7 @@ declare module "sap/zen/dsh/Dsh" {
606
632
  *
607
633
  * Default value is `"0ANALYSIS"`.
608
634
  *
635
+ *
609
636
  * @returns Value of property `dshAppName`
610
637
  */
611
638
  getDshAppName(): string;
@@ -614,6 +641,7 @@ declare module "sap/zen/dsh/Dsh" {
614
641
  *
615
642
  * Desired height of the Design Studio Control
616
643
  *
644
+ *
617
645
  * @returns Value of property `height`
618
646
  */
619
647
  getHeight(): CSSSize;
@@ -622,6 +650,7 @@ declare module "sap/zen/dsh/Dsh" {
622
650
  *
623
651
  * the language
624
652
  *
653
+ *
625
654
  * @returns Value of property `language`
626
655
  */
627
656
  getLanguage(): string;
@@ -632,6 +661,7 @@ declare module "sap/zen/dsh/Dsh" {
632
661
  *
633
662
  * the protocol
634
663
  *
664
+ *
635
665
  * @returns Value of property `protocol`
636
666
  */
637
667
  getProtocol(): string;
@@ -640,6 +670,7 @@ declare module "sap/zen/dsh/Dsh" {
640
670
  *
641
671
  * Path to application specified by dshAppName
642
672
  *
673
+ *
643
674
  * @returns Value of property `repoPath`
644
675
  */
645
676
  getRepoPath(): string;
@@ -648,6 +679,7 @@ declare module "sap/zen/dsh/Dsh" {
648
679
  *
649
680
  * the semantic mappings
650
681
  *
682
+ *
651
683
  * @returns Value of property `semanticMappings`
652
684
  */
653
685
  getSemanticMappings(): object;
@@ -656,6 +688,7 @@ declare module "sap/zen/dsh/Dsh" {
656
688
  *
657
689
  * the system alias
658
690
  *
691
+ *
659
692
  * @returns Value of property `systemAlias`
660
693
  */
661
694
  getSystemAlias(): string;
@@ -664,6 +697,7 @@ declare module "sap/zen/dsh/Dsh" {
664
697
  *
665
698
  * Desired width of the Design Studio Control
666
699
  *
700
+ *
667
701
  * @returns Value of property `width`
668
702
  */
669
703
  getWidth(): CSSSize;
@@ -700,6 +734,7 @@ declare module "sap/zen/dsh/Dsh" {
700
734
  *
701
735
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
702
736
  *
737
+ *
703
738
  * @returns Reference to `this` in order to allow method chaining
704
739
  */
705
740
  setAppComponent(
@@ -715,6 +750,7 @@ declare module "sap/zen/dsh/Dsh" {
715
750
  *
716
751
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
717
752
  *
753
+ *
718
754
  * @returns Reference to `this` in order to allow method chaining
719
755
  */
720
756
  setClient(
@@ -732,6 +768,7 @@ declare module "sap/zen/dsh/Dsh" {
732
768
  *
733
769
  * Default value is `false`.
734
770
  *
771
+ *
735
772
  * @returns Reference to `this` in order to allow method chaining
736
773
  */
737
774
  setDeferCreation(
@@ -749,6 +786,7 @@ declare module "sap/zen/dsh/Dsh" {
749
786
  *
750
787
  * Default value is `"bw"`.
751
788
  *
789
+ *
752
790
  * @returns Reference to `this` in order to allow method chaining
753
791
  */
754
792
  setDeployment(
@@ -766,6 +804,7 @@ declare module "sap/zen/dsh/Dsh" {
766
804
  *
767
805
  * Default value is `"0ANALYSIS"`.
768
806
  *
807
+ *
769
808
  * @returns Reference to `this` in order to allow method chaining
770
809
  */
771
810
  setDshAppName(
@@ -781,6 +820,7 @@ declare module "sap/zen/dsh/Dsh" {
781
820
  *
782
821
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
783
822
  *
823
+ *
784
824
  * @returns Reference to `this` in order to allow method chaining
785
825
  */
786
826
  setHeight(
@@ -796,6 +836,7 @@ declare module "sap/zen/dsh/Dsh" {
796
836
  *
797
837
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
798
838
  *
839
+ *
799
840
  * @returns Reference to `this` in order to allow method chaining
800
841
  */
801
842
  setLanguage(
@@ -811,6 +852,7 @@ declare module "sap/zen/dsh/Dsh" {
811
852
  *
812
853
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
813
854
  *
855
+ *
814
856
  * @returns Reference to `this` in order to allow method chaining
815
857
  */
816
858
  setProtocol(
@@ -826,6 +868,7 @@ declare module "sap/zen/dsh/Dsh" {
826
868
  *
827
869
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
828
870
  *
871
+ *
829
872
  * @returns Reference to `this` in order to allow method chaining
830
873
  */
831
874
  setRepoPath(
@@ -841,6 +884,7 @@ declare module "sap/zen/dsh/Dsh" {
841
884
  *
842
885
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
843
886
  *
887
+ *
844
888
  * @returns Reference to `this` in order to allow method chaining
845
889
  */
846
890
  setSemanticMappings(
@@ -856,6 +900,7 @@ declare module "sap/zen/dsh/Dsh" {
856
900
  *
857
901
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
858
902
  *
903
+ *
859
904
  * @returns Reference to `this` in order to allow method chaining
860
905
  */
861
906
  setSystemAlias(
@@ -871,6 +916,7 @@ declare module "sap/zen/dsh/Dsh" {
871
916
  *
872
917
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
873
918
  *
919
+ *
874
920
  * @returns Reference to `this` in order to allow method chaining
875
921
  */
876
922
  setWidth(
@@ -960,9 +1006,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
960
1006
  import Control from "sap/ui/core/Control";
961
1007
 
962
1008
  /**
963
- * @deprecated (since 1.89)
964
- *
965
1009
  * The ValueHelpDialog control can be used to implement a value help for an input field.
1010
+ *
1011
+ * @deprecated (since 1.89)
966
1012
  */
967
1013
  export default class ValueHelpDialog extends Dialog {
968
1014
  /**
@@ -1002,6 +1048,7 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1002
1048
  *
1003
1049
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
1004
1050
  *
1051
+ *
1005
1052
  * @returns Created class / constructor function
1006
1053
  */
1007
1054
  static extend<T extends Record<string, unknown>>(
@@ -1022,12 +1069,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1022
1069
  /**
1023
1070
  * Returns a metadata object for class sap.zen.dsh.ValueHelpDialog.
1024
1071
  *
1072
+ *
1025
1073
  * @returns Metadata object describing this class
1026
1074
  */
1027
1075
  static getMetadata(): ElementMetadata;
1028
1076
  /**
1029
- * @since 1.24
1030
- *
1031
1077
  * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1032
1078
  *
1033
1079
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1035,6 +1081,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1035
1081
  *
1036
1082
  * This event is fired when the Cancel button is pressed.
1037
1083
  *
1084
+ * @since 1.24
1085
+ *
1038
1086
  * @returns Reference to `this` in order to allow method chaining
1039
1087
  */
1040
1088
  attachCancel(
@@ -1053,8 +1101,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1053
1101
  oListener?: object
1054
1102
  ): this;
1055
1103
  /**
1056
- * @since 1.24
1057
- *
1058
1104
  * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1059
1105
  *
1060
1106
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1062,6 +1108,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1062
1108
  *
1063
1109
  * This event is fired when the Cancel button is pressed.
1064
1110
  *
1111
+ * @since 1.24
1112
+ *
1065
1113
  * @returns Reference to `this` in order to allow method chaining
1066
1114
  */
1067
1115
  attachCancel(
@@ -1075,8 +1123,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1075
1123
  oListener?: object
1076
1124
  ): this;
1077
1125
  /**
1078
- * @since 1.24
1079
- *
1080
1126
  * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1081
1127
  *
1082
1128
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1084,6 +1130,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1084
1130
  *
1085
1131
  * This event is fired when the OK button is pressed.
1086
1132
  *
1133
+ * @since 1.24
1134
+ *
1087
1135
  * @returns Reference to `this` in order to allow method chaining
1088
1136
  */
1089
1137
  attachOk(
@@ -1102,8 +1150,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1102
1150
  oListener?: object
1103
1151
  ): this;
1104
1152
  /**
1105
- * @since 1.24
1106
- *
1107
1153
  * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1108
1154
  *
1109
1155
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1111,6 +1157,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1111
1157
  *
1112
1158
  * This event is fired when the OK button is pressed.
1113
1159
  *
1160
+ * @since 1.24
1161
+ *
1114
1162
  * @returns Reference to `this` in order to allow method chaining
1115
1163
  */
1116
1164
  attachOk(
@@ -1124,8 +1172,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1124
1172
  oListener?: object
1125
1173
  ): this;
1126
1174
  /**
1127
- * @since 1.32
1128
- *
1129
1175
  * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
1130
1176
  * `sap.zen.dsh.ValueHelpDialog`.
1131
1177
  *
@@ -1136,6 +1182,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1136
1182
  *
1137
1183
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1138
1184
  *
1185
+ * @since 1.32
1186
+ *
1139
1187
  * @returns Reference to `this` in order to allow method chaining
1140
1188
  */
1141
1189
  attachSelectionChange(
@@ -1154,8 +1202,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1154
1202
  oListener?: object
1155
1203
  ): this;
1156
1204
  /**
1157
- * @since 1.32
1158
- *
1159
1205
  * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
1160
1206
  * `sap.zen.dsh.ValueHelpDialog`.
1161
1207
  *
@@ -1166,6 +1212,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1166
1212
  *
1167
1213
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1168
1214
  *
1215
+ * @since 1.32
1216
+ *
1169
1217
  * @returns Reference to `this` in order to allow method chaining
1170
1218
  */
1171
1219
  attachSelectionChange(
@@ -1179,8 +1227,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1179
1227
  oListener?: object
1180
1228
  ): this;
1181
1229
  /**
1182
- * @since 1.32
1183
- *
1184
1230
  * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1185
1231
  *
1186
1232
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1190,6 +1236,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1190
1236
  *
1191
1237
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1192
1238
  *
1239
+ * @since 1.32
1240
+ *
1193
1241
  * @returns Reference to `this` in order to allow method chaining
1194
1242
  */
1195
1243
  attachTokenRemove(
@@ -1208,8 +1256,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1208
1256
  oListener?: object
1209
1257
  ): this;
1210
1258
  /**
1211
- * @since 1.32
1212
- *
1213
1259
  * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1214
1260
  *
1215
1261
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1219,6 +1265,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1219
1265
  *
1220
1266
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1221
1267
  *
1268
+ * @since 1.32
1269
+ *
1222
1270
  * @returns Reference to `this` in order to allow method chaining
1223
1271
  */
1224
1272
  attachTokenRemove(
@@ -1232,8 +1280,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1232
1280
  oListener?: object
1233
1281
  ): this;
1234
1282
  /**
1235
- * @since 1.32
1236
- *
1237
1283
  * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this
1238
1284
  * `sap.zen.dsh.ValueHelpDialog`.
1239
1285
  *
@@ -1244,6 +1290,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1244
1290
  *
1245
1291
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1246
1292
  *
1293
+ * @since 1.32
1294
+ *
1247
1295
  * @returns Reference to `this` in order to allow method chaining
1248
1296
  */
1249
1297
  attachUpdateSelection(
@@ -1262,8 +1310,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1262
1310
  oListener?: object
1263
1311
  ): this;
1264
1312
  /**
1265
- * @since 1.32
1266
- *
1267
1313
  * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this
1268
1314
  * `sap.zen.dsh.ValueHelpDialog`.
1269
1315
  *
@@ -1274,6 +1320,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1274
1320
  *
1275
1321
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1276
1322
  *
1323
+ * @since 1.32
1324
+ *
1277
1325
  * @returns Reference to `this` in order to allow method chaining
1278
1326
  */
1279
1327
  attachUpdateSelection(
@@ -1289,16 +1337,17 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1289
1337
  /**
1290
1338
  * Destroys the filterBar in the aggregation {@link #getFilterBar filterBar}.
1291
1339
  *
1340
+ *
1292
1341
  * @returns Reference to `this` in order to allow method chaining
1293
1342
  */
1294
1343
  destroyFilterBar(): this;
1295
1344
  /**
1296
- * @since 1.24
1297
- *
1298
1345
  * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1299
1346
  *
1300
1347
  * The passed function and listener object must match the ones used for event registration.
1301
1348
  *
1349
+ * @since 1.24
1350
+ *
1302
1351
  * @returns Reference to `this` in order to allow method chaining
1303
1352
  */
1304
1353
  detachCancel(
@@ -1312,12 +1361,12 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1312
1361
  oListener?: object
1313
1362
  ): this;
1314
1363
  /**
1315
- * @since 1.24
1316
- *
1317
1364
  * Detaches event handler `fnFunction` from the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1318
1365
  *
1319
1366
  * The passed function and listener object must match the ones used for event registration.
1320
1367
  *
1368
+ * @since 1.24
1369
+ *
1321
1370
  * @returns Reference to `this` in order to allow method chaining
1322
1371
  */
1323
1372
  detachOk(
@@ -1331,13 +1380,13 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1331
1380
  oListener?: object
1332
1381
  ): this;
1333
1382
  /**
1334
- * @since 1.32
1335
- *
1336
1383
  * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
1337
1384
  * this `sap.zen.dsh.ValueHelpDialog`.
1338
1385
  *
1339
1386
  * The passed function and listener object must match the ones used for event registration.
1340
1387
  *
1388
+ * @since 1.32
1389
+ *
1341
1390
  * @returns Reference to `this` in order to allow method chaining
1342
1391
  */
1343
1392
  detachSelectionChange(
@@ -1351,12 +1400,12 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1351
1400
  oListener?: object
1352
1401
  ): this;
1353
1402
  /**
1354
- * @since 1.32
1355
- *
1356
1403
  * Detaches event handler `fnFunction` from the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1357
1404
  *
1358
1405
  * The passed function and listener object must match the ones used for event registration.
1359
1406
  *
1407
+ * @since 1.32
1408
+ *
1360
1409
  * @returns Reference to `this` in order to allow method chaining
1361
1410
  */
1362
1411
  detachTokenRemove(
@@ -1370,13 +1419,13 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1370
1419
  oListener?: object
1371
1420
  ): this;
1372
1421
  /**
1373
- * @since 1.32
1374
- *
1375
1422
  * Detaches event handler `fnFunction` from the {@link #event:updateSelection updateSelection} event of
1376
1423
  * this `sap.zen.dsh.ValueHelpDialog`.
1377
1424
  *
1378
1425
  * The passed function and listener object must match the ones used for event registration.
1379
1426
  *
1427
+ * @since 1.32
1428
+ *
1380
1429
  * @returns Reference to `this` in order to allow method chaining
1381
1430
  */
1382
1431
  detachUpdateSelection(
@@ -1390,11 +1439,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1390
1439
  oListener?: object
1391
1440
  ): this;
1392
1441
  /**
1442
+ * Fires event {@link #event:cancel cancel} to attached listeners.
1443
+ *
1393
1444
  * @since 1.24
1394
1445
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1395
1446
  *
1396
- * Fires event {@link #event:cancel cancel} to attached listeners.
1397
- *
1398
1447
  * @returns Reference to `this` in order to allow method chaining
1399
1448
  */
1400
1449
  fireCancel(
@@ -1404,11 +1453,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1404
1453
  mParameters?: object
1405
1454
  ): this;
1406
1455
  /**
1456
+ * Fires event {@link #event:ok ok} to attached listeners.
1457
+ *
1407
1458
  * @since 1.24
1408
1459
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1409
1460
  *
1410
- * Fires event {@link #event:ok ok} to attached listeners.
1411
- *
1412
1461
  * @returns Reference to `this` in order to allow method chaining
1413
1462
  */
1414
1463
  fireOk(
@@ -1418,11 +1467,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1418
1467
  mParameters?: ValueHelpDialog$OkEventParameters
1419
1468
  ): this;
1420
1469
  /**
1470
+ * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
1471
+ *
1421
1472
  * @since 1.32
1422
1473
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1423
1474
  *
1424
- * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
1425
- *
1426
1475
  * @returns Reference to `this` in order to allow method chaining
1427
1476
  */
1428
1477
  fireSelectionChange(
@@ -1432,11 +1481,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1432
1481
  mParameters?: ValueHelpDialog$SelectionChangeEventParameters
1433
1482
  ): this;
1434
1483
  /**
1484
+ * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
1485
+ *
1435
1486
  * @since 1.32
1436
1487
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1437
1488
  *
1438
- * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
1439
- *
1440
1489
  * @returns Reference to `this` in order to allow method chaining
1441
1490
  */
1442
1491
  fireTokenRemove(
@@ -1446,11 +1495,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1446
1495
  mParameters?: ValueHelpDialog$TokenRemoveEventParameters
1447
1496
  ): this;
1448
1497
  /**
1498
+ * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
1499
+ *
1449
1500
  * @since 1.32
1450
1501
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1451
1502
  *
1452
- * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
1453
- *
1454
1503
  * @returns Reference to `this` in order to allow method chaining
1455
1504
  */
1456
1505
  fireUpdateSelection(
@@ -1460,8 +1509,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1460
1509
  mParameters?: ValueHelpDialog$UpdateSelectionEventParameters
1461
1510
  ): this;
1462
1511
  /**
1463
- * @since 1.24
1464
- *
1465
1512
  * Gets current value of property {@link #getBasicSearchText basicSearchText}.
1466
1513
  *
1467
1514
  * Defines the value for the basic search field. The value is set into the basic search field of the filter
@@ -1469,24 +1516,24 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1469
1516
  *
1470
1517
  * Default value is `empty string`.
1471
1518
  *
1519
+ * @since 1.24
1520
+ *
1472
1521
  * @returns Value of property `basicSearchText`
1473
1522
  */
1474
1523
  getBasicSearchText(): string;
1475
1524
  /**
1476
- * @since 1.24
1477
- *
1478
1525
  * Gets current value of property {@link #getDescriptionKey descriptionKey}.
1479
1526
  *
1480
1527
  * Defines the key of the column used for the token text.
1481
1528
  *
1482
1529
  * Default value is `empty string`.
1483
1530
  *
1531
+ * @since 1.24
1532
+ *
1484
1533
  * @returns Value of property `descriptionKey`
1485
1534
  */
1486
1535
  getDescriptionKey(): string;
1487
1536
  /**
1488
- * @since 1.24
1489
- *
1490
1537
  * Gets current value of property {@link #getDisplayFormat displayFormat}.
1491
1538
  *
1492
1539
  * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
@@ -1494,24 +1541,24 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1494
1541
  *
1495
1542
  * Default value is `empty string`.
1496
1543
  *
1544
+ * @since 1.24
1545
+ *
1497
1546
  * @returns Value of property `displayFormat`
1498
1547
  */
1499
1548
  getDisplayFormat(): string;
1500
1549
  /**
1501
- * @since 1.24
1502
- *
1503
1550
  * Gets current value of property {@link #getFilterMode filterMode}.
1504
1551
  *
1505
1552
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1506
1553
  *
1507
1554
  * Default value is `false`.
1508
1555
  *
1556
+ * @since 1.24
1557
+ *
1509
1558
  * @returns Value of property `filterMode`
1510
1559
  */
1511
1560
  getFilterMode(): boolean;
1512
1561
  /**
1513
- * @since 1.24
1514
- *
1515
1562
  * Gets current value of property {@link #getKey key}.
1516
1563
  *
1517
1564
  * Defines the key of the column used for the internal key handling. The value of the column is used for
@@ -1519,90 +1566,90 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1519
1566
  *
1520
1567
  * Default value is `empty string`.
1521
1568
  *
1569
+ * @since 1.24
1570
+ *
1522
1571
  * @returns Value of property `key`
1523
1572
  */
1524
1573
  getKey(): string;
1525
1574
  /**
1526
- * @since 1.24
1527
- *
1528
1575
  * Gets current value of property {@link #getKeys keys}.
1529
1576
  *
1530
1577
  * Defines the list of additional keys of the column used for the internal key handling.
1531
1578
  *
1579
+ * @since 1.24
1580
+ *
1532
1581
  * @returns Value of property `keys`
1533
1582
  */
1534
1583
  getKeys(): string[];
1535
1584
  /**
1536
- * @since 1.24
1537
- *
1538
1585
  * Gets current value of property {@link #getMaxExcludeRanges maxExcludeRanges}.
1539
1586
  *
1540
1587
  * Defines the maximum number of exclude ranges.
1541
1588
  *
1542
1589
  * Default value is `"-1"`.
1543
1590
  *
1591
+ * @since 1.24
1592
+ *
1544
1593
  * @returns Value of property `maxExcludeRanges`
1545
1594
  */
1546
1595
  getMaxExcludeRanges(): string;
1547
1596
  /**
1548
- * @since 1.24
1549
- *
1550
1597
  * Gets current value of property {@link #getMaxIncludeRanges maxIncludeRanges}.
1551
1598
  *
1552
1599
  * Defines the maximum number of include ranges.
1553
1600
  *
1554
1601
  * Default value is `"-1"`.
1555
1602
  *
1603
+ * @since 1.24
1604
+ *
1556
1605
  * @returns Value of property `maxIncludeRanges`
1557
1606
  */
1558
1607
  getMaxIncludeRanges(): string;
1559
1608
  /**
1560
- * @since 1.24
1561
- *
1562
1609
  * Gets current value of property {@link #getSupportMultiselect supportMultiselect}.
1563
1610
  *
1564
1611
  * Enables multi-selection in the table used.
1565
1612
  *
1566
1613
  * Default value is `true`.
1567
1614
  *
1615
+ * @since 1.24
1616
+ *
1568
1617
  * @returns Value of property `supportMultiselect`
1569
1618
  */
1570
1619
  getSupportMultiselect(): boolean;
1571
1620
  /**
1572
- * @since 1.24
1573
- *
1574
1621
  * Gets current value of property {@link #getSupportRanges supportRanges}.
1575
1622
  *
1576
1623
  * Enables the ranges (conditions) feature in the dialog.
1577
1624
  *
1578
1625
  * Default value is `false`.
1579
1626
  *
1627
+ * @since 1.24
1628
+ *
1580
1629
  * @returns Value of property `supportRanges`
1581
1630
  */
1582
1631
  getSupportRanges(): boolean;
1583
1632
  /**
1584
- * @since 1.24
1585
- *
1586
1633
  * Gets current value of property {@link #getSupportRangesOnly supportRangesOnly}.
1587
1634
  *
1588
1635
  * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1589
1636
  *
1590
1637
  * Default value is `false`.
1591
1638
  *
1639
+ * @since 1.24
1640
+ *
1592
1641
  * @returns Value of property `supportRangesOnly`
1593
1642
  */
1594
1643
  getSupportRangesOnly(): boolean;
1595
1644
  /**
1596
- * @since 1.28
1597
- *
1598
1645
  * getTable Gives access to the internal table instance.
1599
1646
  *
1647
+ * @since 1.28
1648
+ *
1600
1649
  * @returns the used table instance
1601
1650
  */
1602
1651
  getTable(): object;
1603
1652
  /**
1604
- * @since 1.24
1605
- *
1606
1653
  * Gets current value of property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}.
1607
1654
  *
1608
1655
  * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
@@ -1610,12 +1657,12 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1610
1657
  *
1611
1658
  * Default value is `empty string`.
1612
1659
  *
1660
+ * @since 1.24
1661
+ *
1613
1662
  * @returns Value of property `tokenDisplayBehaviour`
1614
1663
  */
1615
1664
  getTokenDisplayBehaviour(): string;
1616
1665
  /**
1617
- * @since 1.24
1618
- *
1619
1666
  * Sets a new value for property {@link #getDescriptionKey descriptionKey}.
1620
1667
  *
1621
1668
  * Defines the key of the column used for the token text.
@@ -1624,6 +1671,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1624
1671
  *
1625
1672
  * Default value is `empty string`.
1626
1673
  *
1674
+ * @since 1.24
1675
+ *
1627
1676
  * @returns Reference to `this` in order to allow method chaining
1628
1677
  */
1629
1678
  setDescriptionKey(
@@ -1633,8 +1682,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1633
1682
  sDescriptionKey?: string
1634
1683
  ): this;
1635
1684
  /**
1636
- * @since 1.24
1637
- *
1638
1685
  * Sets a new value for property {@link #getDisplayFormat displayFormat}.
1639
1686
  *
1640
1687
  * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
@@ -1644,6 +1691,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1644
1691
  *
1645
1692
  * Default value is `empty string`.
1646
1693
  *
1694
+ * @since 1.24
1695
+ *
1647
1696
  * @returns Reference to `this` in order to allow method chaining
1648
1697
  */
1649
1698
  setDisplayFormat(
@@ -1653,9 +1702,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1653
1702
  sDisplayFormat?: string
1654
1703
  ): this;
1655
1704
  /**
1656
- * @since 1.24
1657
- *
1658
1705
  * setExcludeRangeOperations Sets the array for the supported exclude range operations.
1706
+ *
1707
+ * @since 1.24
1659
1708
  */
1660
1709
  setExcludeRangeOperations(
1661
1710
  /**
@@ -1670,8 +1719,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1670
1719
  sType: string
1671
1720
  ): void;
1672
1721
  /**
1673
- * @since 1.24
1674
- *
1675
1722
  * Sets a new value for property {@link #getFilterMode filterMode}.
1676
1723
  *
1677
1724
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
@@ -1680,6 +1727,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1680
1727
  *
1681
1728
  * Default value is `false`.
1682
1729
  *
1730
+ * @since 1.24
1731
+ *
1683
1732
  * @returns Reference to `this` in order to allow method chaining
1684
1733
  */
1685
1734
  setFilterMode(
@@ -1689,9 +1738,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1689
1738
  bFilterMode?: boolean
1690
1739
  ): this;
1691
1740
  /**
1692
- * @since 1.24
1693
- *
1694
1741
  * setIncludeRangeOperations Sets the array for the supported include range operations.
1742
+ *
1743
+ * @since 1.24
1695
1744
  */
1696
1745
  setIncludeRangeOperations(
1697
1746
  /**
@@ -1706,8 +1755,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1706
1755
  sType: string
1707
1756
  ): void;
1708
1757
  /**
1709
- * @since 1.24
1710
- *
1711
1758
  * Sets a new value for property {@link #getKey key}.
1712
1759
  *
1713
1760
  * Defines the key of the column used for the internal key handling. The value of the column is used for
@@ -1717,6 +1764,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1717
1764
  *
1718
1765
  * Default value is `empty string`.
1719
1766
  *
1767
+ * @since 1.24
1768
+ *
1720
1769
  * @returns Reference to `this` in order to allow method chaining
1721
1770
  */
1722
1771
  setKey(
@@ -1726,14 +1775,14 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1726
1775
  sKey?: string
1727
1776
  ): this;
1728
1777
  /**
1729
- * @since 1.24
1730
- *
1731
1778
  * Sets a new value for property {@link #getKeys keys}.
1732
1779
  *
1733
1780
  * Defines the list of additional keys of the column used for the internal key handling.
1734
1781
  *
1735
1782
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1736
1783
  *
1784
+ * @since 1.24
1785
+ *
1737
1786
  * @returns Reference to `this` in order to allow method chaining
1738
1787
  */
1739
1788
  setKeys(
@@ -1743,8 +1792,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1743
1792
  sKeys?: string[]
1744
1793
  ): this;
1745
1794
  /**
1746
- * @since 1.24
1747
- *
1748
1795
  * Sets a new value for property {@link #getMaxExcludeRanges maxExcludeRanges}.
1749
1796
  *
1750
1797
  * Defines the maximum number of exclude ranges.
@@ -1753,6 +1800,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1753
1800
  *
1754
1801
  * Default value is `"-1"`.
1755
1802
  *
1803
+ * @since 1.24
1804
+ *
1756
1805
  * @returns Reference to `this` in order to allow method chaining
1757
1806
  */
1758
1807
  setMaxExcludeRanges(
@@ -1762,8 +1811,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1762
1811
  sMaxExcludeRanges?: string
1763
1812
  ): this;
1764
1813
  /**
1765
- * @since 1.24
1766
- *
1767
1814
  * Sets a new value for property {@link #getMaxIncludeRanges maxIncludeRanges}.
1768
1815
  *
1769
1816
  * Defines the maximum number of include ranges.
@@ -1772,6 +1819,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1772
1819
  *
1773
1820
  * Default value is `"-1"`.
1774
1821
  *
1822
+ * @since 1.24
1823
+ *
1775
1824
  * @returns Reference to `this` in order to allow method chaining
1776
1825
  */
1777
1826
  setMaxIncludeRanges(
@@ -1781,10 +1830,10 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1781
1830
  sMaxIncludeRanges?: string
1782
1831
  ): this;
1783
1832
  /**
1784
- * @since 1.24
1785
- *
1786
1833
  * setRangeKeyFields Sets a RangeKeyFields array. This method allows you to specify the KeyFields for the
1787
1834
  * ranges. You can set an array of objects with Key and Label properties to define the key fields.
1835
+ *
1836
+ * @since 1.24
1788
1837
  */
1789
1838
  setRangeKeyFields(
1790
1839
  /**
@@ -1793,10 +1842,10 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1793
1842
  aRangeKeyFields: object[]
1794
1843
  ): void;
1795
1844
  /**
1796
- * @since 1.32
1797
- *
1798
1845
  * setTable Sets the table used in the value help dialog. If not used, the dialog creates a sap.ui.table.Table
1799
1846
  * or sap.m.Table instance internally.
1847
+ *
1848
+ * @since 1.32
1800
1849
  */
1801
1850
  setTable(
1802
1851
  /**
@@ -1805,8 +1854,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1805
1854
  oTable: object
1806
1855
  ): void;
1807
1856
  /**
1808
- * @since 1.24
1809
- *
1810
1857
  * Sets a new value for property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}.
1811
1858
  *
1812
1859
  * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
@@ -1816,6 +1863,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1816
1863
  *
1817
1864
  * Default value is `empty string`.
1818
1865
  *
1866
+ * @since 1.24
1867
+ *
1819
1868
  * @returns Reference to `this` in order to allow method chaining
1820
1869
  */
1821
1870
  setTokenDisplayBehaviour(
@@ -1825,8 +1874,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1825
1874
  sTokenDisplayBehaviour?: string
1826
1875
  ): this;
1827
1876
  /**
1828
- * @since 1.24
1829
- *
1830
1877
  * Sets the array of tokens. The `sap.m.Tokens` are added to the dialog tokenizer Selected Items or Excluded
1831
1878
  * Items. Normal tokens are added to the Selected Items tokenizer only and are selected in the table. `
1832
1879
  * new sap.m.Token({key: "0001", text:"SAP A.G. (0001)"}); ` Tokens with the extra data with value 'range'
@@ -1834,6 +1881,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1834
1881
  * { "exclude": false, "operation": sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation.BT, "keyField":
1835
1882
  * "CompanyCode", "value1": "a", "value2": "z"}); ` The selected items or range tokens are returned in the
1836
1883
  * event parameters of the Ok event.
1884
+ *
1885
+ * @since 1.24
1837
1886
  */
1838
1887
  setTokens(
1839
1888
  /**
@@ -1842,102 +1891,102 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1842
1891
  aTokens: Token[]
1843
1892
  ): void;
1844
1893
  /**
1845
- * @since 1.24
1846
- *
1847
1894
  * Update the Control
1848
1895
  *
1849
1896
  * Updates the selection of rows in the table. This function must be called after a first binding or binding
1850
1897
  * update of the table. It will set a table row as selected if a token for this row exists.
1898
+ *
1899
+ * @since 1.24
1851
1900
  */
1852
1901
  update(): void;
1853
1902
  }
1854
1903
 
1855
1904
  export interface $ValueHelpDialogSettings extends $DialogSettings {
1856
1905
  /**
1857
- * @since 1.24
1858
- *
1859
1906
  * Defines the value for the basic search field. The value is set into the basic search field of the filter
1860
1907
  * bar used.
1908
+ *
1909
+ * @since 1.24
1861
1910
  */
1862
1911
  basicSearchText?: string | PropertyBindingInfo;
1863
1912
 
1864
1913
  /**
1865
- * @since 1.24
1866
- *
1867
1914
  * Enables multi-selection in the table used.
1915
+ *
1916
+ * @since 1.24
1868
1917
  */
1869
1918
  supportMultiselect?: boolean | PropertyBindingInfo | `{${string}}`;
1870
1919
 
1871
1920
  /**
1872
- * @since 1.24
1873
- *
1874
1921
  * Enables the ranges (conditions) feature in the dialog.
1922
+ *
1923
+ * @since 1.24
1875
1924
  */
1876
1925
  supportRanges?: boolean | PropertyBindingInfo | `{${string}}`;
1877
1926
 
1878
1927
  /**
1879
- * @since 1.24
1880
- *
1881
1928
  * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1929
+ *
1930
+ * @since 1.24
1882
1931
  */
1883
1932
  supportRangesOnly?: boolean | PropertyBindingInfo | `{${string}}`;
1884
1933
 
1885
1934
  /**
1886
- * @since 1.24
1887
- *
1888
1935
  * Defines the key of the column used for the internal key handling. The value of the column is used for
1889
1936
  * the token key and also to identify the row in the table.
1937
+ *
1938
+ * @since 1.24
1890
1939
  */
1891
1940
  key?: string | PropertyBindingInfo;
1892
1941
 
1893
1942
  /**
1894
- * @since 1.24
1895
- *
1896
1943
  * Defines the list of additional keys of the column used for the internal key handling.
1944
+ *
1945
+ * @since 1.24
1897
1946
  */
1898
1947
  keys?: string[] | PropertyBindingInfo | `{${string}}`;
1899
1948
 
1900
1949
  /**
1901
- * @since 1.24
1902
- *
1903
1950
  * Defines the key of the column used for the token text.
1951
+ *
1952
+ * @since 1.24
1904
1953
  */
1905
1954
  descriptionKey?: string | PropertyBindingInfo;
1906
1955
 
1907
1956
  /**
1908
- * @since 1.24
1909
- *
1910
1957
  * Defines the maximum number of include ranges.
1958
+ *
1959
+ * @since 1.24
1911
1960
  */
1912
1961
  maxIncludeRanges?: string | PropertyBindingInfo;
1913
1962
 
1914
1963
  /**
1915
- * @since 1.24
1916
- *
1917
1964
  * Defines the maximum number of exclude ranges.
1965
+ *
1966
+ * @since 1.24
1918
1967
  */
1919
1968
  maxExcludeRanges?: string | PropertyBindingInfo;
1920
1969
 
1921
1970
  /**
1922
- * @since 1.24
1923
- *
1924
1971
  * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
1925
1972
  * value of the range (condition) is converted to uppercase letters.
1973
+ *
1974
+ * @since 1.24
1926
1975
  */
1927
1976
  displayFormat?: string | PropertyBindingInfo;
1928
1977
 
1929
1978
  /**
1930
- * @since 1.24
1931
- *
1932
1979
  * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
1933
1980
  * values.
1981
+ *
1982
+ * @since 1.24
1934
1983
  */
1935
1984
  tokenDisplayBehaviour?: string | PropertyBindingInfo;
1936
1985
 
1937
1986
  /**
1938
- * @since 1.24
1939
- *
1940
1987
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1988
+ *
1989
+ * @since 1.24
1941
1990
  */
1942
1991
  filterMode?: boolean | PropertyBindingInfo | `{${string}}`;
1943
1992
 
@@ -1948,43 +1997,43 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1948
1997
  filterBar?: Control;
1949
1998
 
1950
1999
  /**
1951
- * @since 1.24
1952
- *
1953
2000
  * This event is fired when the OK button is pressed.
2001
+ *
2002
+ * @since 1.24
1954
2003
  */
1955
2004
  ok?: (oEvent: ValueHelpDialog$OkEvent) => void;
1956
2005
 
1957
2006
  /**
1958
- * @since 1.24
1959
- *
1960
2007
  * This event is fired when the Cancel button is pressed.
2008
+ *
2009
+ * @since 1.24
1961
2010
  */
1962
2011
  cancel?: (oEvent: Event) => void;
1963
2012
 
1964
2013
  /**
1965
- * @since 1.32
1966
- *
1967
2014
  * This event is fired when the user selects an item in the items table.
1968
2015
  *
1969
2016
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2017
+ *
2018
+ * @since 1.32
1970
2019
  */
1971
2020
  selectionChange?: (oEvent: ValueHelpDialog$SelectionChangeEvent) => void;
1972
2021
 
1973
2022
  /**
1974
- * @since 1.32
1975
- *
1976
2023
  * This event is fired when the user removes one or multiple existing token(s) from the dialog.
1977
2024
  *
1978
2025
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2026
+ *
2027
+ * @since 1.32
1979
2028
  */
1980
2029
  tokenRemove?: (oEvent: ValueHelpDialog$TokenRemoveEvent) => void;
1981
2030
 
1982
2031
  /**
1983
- * @since 1.32
1984
- *
1985
2032
  * This event is fired when the table gets an update and all existing tokens must be selected in the table.
1986
2033
  *
1987
2034
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2035
+ *
2036
+ * @since 1.32
1988
2037
  */
1989
2038
  updateSelection?: (oEvent: ValueHelpDialog$UpdateSelectionEvent) => void;
1990
2039
  }
@@ -2069,10 +2118,10 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
2069
2118
 
2070
2119
  declare module "sap/zen/dsh/ValueHelpRangeOperation" {
2071
2120
  /**
2121
+ * Sort Type
2122
+ *
2072
2123
  * @deprecated (since 1.89)
2073
2124
  * @experimental
2074
- *
2075
- * Sort Type
2076
2125
  */
2077
2126
  enum ValueHelpRangeOperation {
2078
2127
  /**
@@ -2121,9 +2170,9 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
2121
2170
  import Metadata from "sap/ui/base/Metadata";
2122
2171
 
2123
2172
  /**
2124
- * @deprecated (since 1.89.0)
2125
- *
2126
2173
  * Model implementation for JSON format
2174
+ *
2175
+ * @deprecated (since 1.89.0)
2127
2176
  */
2128
2177
  export default class SDKModel extends Model {
2129
2178
  /**
@@ -2142,6 +2191,7 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
2142
2191
  *
2143
2192
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
2144
2193
  *
2194
+ *
2145
2195
  * @returns Created class / constructor function
2146
2196
  */
2147
2197
  static extend<T extends Record<string, unknown>>(
@@ -2162,6 +2212,7 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
2162
2212
  /**
2163
2213
  * Returns a metadata object for class sap.zen.dsh.widgets.SDKModel.
2164
2214
  *
2215
+ *
2165
2216
  * @returns Metadata object describing this class
2166
2217
  */
2167
2218
  static getMetadata(): Metadata;