@sapui5/types 1.120.11 → 1.120.13

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 (55) hide show
  1. package/LICENSE.txt +13 -10
  2. package/README.md +1 -1
  3. package/package.json +1 -1
  4. package/types/sap.chart.d.ts +58 -6
  5. package/types/sap.esh.search.ui.d.ts +16 -2
  6. package/types/sap.f.d.ts +372 -54
  7. package/types/sap.fe.core.d.ts +11 -3
  8. package/types/sap.fe.macros.d.ts +96 -12
  9. package/types/sap.fe.navigation.d.ts +1 -1
  10. package/types/sap.fe.placeholder.d.ts +1 -1
  11. package/types/sap.fe.templates.d.ts +1 -1
  12. package/types/sap.fe.test.d.ts +1 -1
  13. package/types/sap.fe.tools.d.ts +1 -1
  14. package/types/sap.gantt.d.ts +1001 -139
  15. package/types/sap.insights.d.ts +4 -2
  16. package/types/sap.m.d.ts +3123 -276
  17. package/types/sap.makit.d.ts +115 -14
  18. package/types/sap.me.d.ts +84 -7
  19. package/types/sap.ndc.d.ts +22 -2
  20. package/types/sap.ovp.d.ts +1 -1
  21. package/types/sap.sac.df.d.ts +294 -44
  22. package/types/sap.suite.ui.commons.d.ts +1148 -118
  23. package/types/sap.suite.ui.generic.template.d.ts +10 -2
  24. package/types/sap.suite.ui.microchart.d.ts +184 -28
  25. package/types/sap.tnt.d.ts +40 -8
  26. package/types/sap.ui.codeeditor.d.ts +16 -2
  27. package/types/sap.ui.commons.d.ts +756 -90
  28. package/types/sap.ui.comp.d.ts +884 -50
  29. package/types/sap.ui.core.d.ts +1112 -135
  30. package/types/sap.ui.dt.d.ts +1 -1
  31. package/types/sap.ui.export.d.ts +19 -4
  32. package/types/sap.ui.fl.d.ts +44 -3
  33. package/types/sap.ui.integration.d.ts +144 -6
  34. package/types/sap.ui.layout.d.ts +166 -41
  35. package/types/sap.ui.mdc.d.ts +430 -38
  36. package/types/sap.ui.richtexteditor.d.ts +28 -2
  37. package/types/sap.ui.rta.d.ts +1 -1
  38. package/types/sap.ui.suite.d.ts +27 -3
  39. package/types/sap.ui.support.d.ts +1 -1
  40. package/types/sap.ui.table.d.ts +222 -19
  41. package/types/sap.ui.testrecorder.d.ts +1 -1
  42. package/types/sap.ui.unified.d.ts +431 -35
  43. package/types/sap.ui.ux3.d.ts +524 -31
  44. package/types/sap.ui.vbm.d.ts +6427 -3308
  45. package/types/sap.ui.webc.common.d.ts +7 -1
  46. package/types/sap.ui.webc.fiori.d.ts +351 -29
  47. package/types/sap.ui.webc.main.d.ts +1035 -83
  48. package/types/sap.uiext.inbox.d.ts +124 -13
  49. package/types/sap.ushell.d.ts +147 -12
  50. package/types/sap.ushell_abap.d.ts +1 -1
  51. package/types/sap.uxap.d.ts +118 -18
  52. package/types/sap.viz.d.ts +2619 -130
  53. package/types/sap.zen.commons.d.ts +104 -23
  54. package/types/sap.zen.crosstab.d.ts +96 -16
  55. package/types/sap.zen.dsh.d.ts +255 -149
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.3
1
+ // For Library Version: 1.120.5
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
- * @deprecated (since 1.89.0)
20
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
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(
@@ -381,7 +401,12 @@ declare module "sap/zen/dsh/AnalyticGrid" {
381
401
  sWidth?: CSSSize
382
402
  ): this;
383
403
  }
384
-
404
+ /**
405
+ * Describes the settings that can be provided to the AnalyticGrid constructor.
406
+ *
407
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
408
+ * @experimental (since 1.46) - API is incomplete and may change incompatibly
409
+ */
385
410
  export interface $AnalyticGridSettings extends $ControlSettings {
386
411
  /**
387
412
  * Desired width of the AnalyticGrid control
@@ -428,6 +453,9 @@ declare module "sap/zen/dsh/AnalyticGrid" {
428
453
  selectionChange?: (oEvent: AnalyticGrid$SelectionChangeEvent) => void;
429
454
  }
430
455
 
456
+ /**
457
+ * Parameters of the AnalyticGrid#selectionChange event.
458
+ */
431
459
  export interface AnalyticGrid$SelectionChangeEventParameters {
432
460
  /**
433
461
  * A SelectionVariant specifying the current selection state of the AnalyticGrid.
@@ -435,11 +463,17 @@ declare module "sap/zen/dsh/AnalyticGrid" {
435
463
  selection?: object;
436
464
  }
437
465
 
466
+ /**
467
+ * Event object of the AnalyticGrid#selectionChange event.
468
+ */
438
469
  export type AnalyticGrid$SelectionChangeEvent = Event<
439
470
  AnalyticGrid$SelectionChangeEventParameters,
440
471
  AnalyticGrid
441
472
  >;
442
473
 
474
+ /**
475
+ * Parameters of the AnalyticGrid#stateChange event.
476
+ */
443
477
  export interface AnalyticGrid$StateChangeEventParameters {
444
478
  /**
445
479
  * Serialized state string.
@@ -447,6 +481,9 @@ declare module "sap/zen/dsh/AnalyticGrid" {
447
481
  state?: string;
448
482
  }
449
483
 
484
+ /**
485
+ * Event object of the AnalyticGrid#stateChange event.
486
+ */
450
487
  export type AnalyticGrid$StateChangeEvent = Event<
451
488
  AnalyticGrid$StateChangeEventParameters,
452
489
  AnalyticGrid
@@ -463,10 +500,10 @@ declare module "sap/zen/dsh/Dsh" {
463
500
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
464
501
 
465
502
  /**
466
- * @since 1.44
467
- * @deprecated (since 1.89)
468
- *
469
503
  * Control for embedding a Design Studio application full-screen in an S/4 HANA Fiori application
504
+ *
505
+ * @since 1.44
506
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
470
507
  */
471
508
  export default class Dsh extends Control {
472
509
  /**
@@ -506,6 +543,7 @@ declare module "sap/zen/dsh/Dsh" {
506
543
  *
507
544
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
508
545
  *
546
+ *
509
547
  * @returns Created class / constructor function
510
548
  */
511
549
  static extend<T extends Record<string, unknown>>(
@@ -526,6 +564,7 @@ declare module "sap/zen/dsh/Dsh" {
526
564
  /**
527
565
  * Returns a metadata object for class sap.zen.dsh.Dsh.
528
566
  *
567
+ *
529
568
  * @returns Metadata object describing this class
530
569
  */
531
570
  static getMetadata(): ElementMetadata;
@@ -554,6 +593,7 @@ declare module "sap/zen/dsh/Dsh" {
554
593
  *
555
594
  * the application component
556
595
  *
596
+ *
557
597
  * @returns Value of property `appComponent`
558
598
  */
559
599
  getAppComponent(): object;
@@ -562,6 +602,7 @@ declare module "sap/zen/dsh/Dsh" {
562
602
  *
563
603
  * the client
564
604
  *
605
+ *
565
606
  * @returns Value of property `client`
566
607
  */
567
608
  getClient(): string;
@@ -586,6 +627,7 @@ declare module "sap/zen/dsh/Dsh" {
586
627
  *
587
628
  * Default value is `false`.
588
629
  *
630
+ *
589
631
  * @returns Value of property `deferCreation`
590
632
  */
591
633
  getDeferCreation(): boolean;
@@ -596,6 +638,7 @@ declare module "sap/zen/dsh/Dsh" {
596
638
  *
597
639
  * Default value is `"bw"`.
598
640
  *
641
+ *
599
642
  * @returns Value of property `deployment`
600
643
  */
601
644
  getDeployment(): string;
@@ -606,6 +649,7 @@ declare module "sap/zen/dsh/Dsh" {
606
649
  *
607
650
  * Default value is `"0ANALYSIS"`.
608
651
  *
652
+ *
609
653
  * @returns Value of property `dshAppName`
610
654
  */
611
655
  getDshAppName(): string;
@@ -614,6 +658,7 @@ declare module "sap/zen/dsh/Dsh" {
614
658
  *
615
659
  * Desired height of the Design Studio Control
616
660
  *
661
+ *
617
662
  * @returns Value of property `height`
618
663
  */
619
664
  getHeight(): CSSSize;
@@ -622,6 +667,7 @@ declare module "sap/zen/dsh/Dsh" {
622
667
  *
623
668
  * the language
624
669
  *
670
+ *
625
671
  * @returns Value of property `language`
626
672
  */
627
673
  getLanguage(): string;
@@ -632,6 +678,7 @@ declare module "sap/zen/dsh/Dsh" {
632
678
  *
633
679
  * the protocol
634
680
  *
681
+ *
635
682
  * @returns Value of property `protocol`
636
683
  */
637
684
  getProtocol(): string;
@@ -640,6 +687,7 @@ declare module "sap/zen/dsh/Dsh" {
640
687
  *
641
688
  * Path to application specified by dshAppName
642
689
  *
690
+ *
643
691
  * @returns Value of property `repoPath`
644
692
  */
645
693
  getRepoPath(): string;
@@ -648,6 +696,7 @@ declare module "sap/zen/dsh/Dsh" {
648
696
  *
649
697
  * the semantic mappings
650
698
  *
699
+ *
651
700
  * @returns Value of property `semanticMappings`
652
701
  */
653
702
  getSemanticMappings(): object;
@@ -656,6 +705,7 @@ declare module "sap/zen/dsh/Dsh" {
656
705
  *
657
706
  * the system alias
658
707
  *
708
+ *
659
709
  * @returns Value of property `systemAlias`
660
710
  */
661
711
  getSystemAlias(): string;
@@ -664,6 +714,7 @@ declare module "sap/zen/dsh/Dsh" {
664
714
  *
665
715
  * Desired width of the Design Studio Control
666
716
  *
717
+ *
667
718
  * @returns Value of property `width`
668
719
  */
669
720
  getWidth(): CSSSize;
@@ -700,6 +751,7 @@ declare module "sap/zen/dsh/Dsh" {
700
751
  *
701
752
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
702
753
  *
754
+ *
703
755
  * @returns Reference to `this` in order to allow method chaining
704
756
  */
705
757
  setAppComponent(
@@ -715,6 +767,7 @@ declare module "sap/zen/dsh/Dsh" {
715
767
  *
716
768
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
717
769
  *
770
+ *
718
771
  * @returns Reference to `this` in order to allow method chaining
719
772
  */
720
773
  setClient(
@@ -732,6 +785,7 @@ declare module "sap/zen/dsh/Dsh" {
732
785
  *
733
786
  * Default value is `false`.
734
787
  *
788
+ *
735
789
  * @returns Reference to `this` in order to allow method chaining
736
790
  */
737
791
  setDeferCreation(
@@ -749,6 +803,7 @@ declare module "sap/zen/dsh/Dsh" {
749
803
  *
750
804
  * Default value is `"bw"`.
751
805
  *
806
+ *
752
807
  * @returns Reference to `this` in order to allow method chaining
753
808
  */
754
809
  setDeployment(
@@ -766,6 +821,7 @@ declare module "sap/zen/dsh/Dsh" {
766
821
  *
767
822
  * Default value is `"0ANALYSIS"`.
768
823
  *
824
+ *
769
825
  * @returns Reference to `this` in order to allow method chaining
770
826
  */
771
827
  setDshAppName(
@@ -781,6 +837,7 @@ declare module "sap/zen/dsh/Dsh" {
781
837
  *
782
838
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
783
839
  *
840
+ *
784
841
  * @returns Reference to `this` in order to allow method chaining
785
842
  */
786
843
  setHeight(
@@ -796,6 +853,7 @@ declare module "sap/zen/dsh/Dsh" {
796
853
  *
797
854
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
798
855
  *
856
+ *
799
857
  * @returns Reference to `this` in order to allow method chaining
800
858
  */
801
859
  setLanguage(
@@ -811,6 +869,7 @@ declare module "sap/zen/dsh/Dsh" {
811
869
  *
812
870
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
813
871
  *
872
+ *
814
873
  * @returns Reference to `this` in order to allow method chaining
815
874
  */
816
875
  setProtocol(
@@ -826,6 +885,7 @@ declare module "sap/zen/dsh/Dsh" {
826
885
  *
827
886
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
828
887
  *
888
+ *
829
889
  * @returns Reference to `this` in order to allow method chaining
830
890
  */
831
891
  setRepoPath(
@@ -841,6 +901,7 @@ declare module "sap/zen/dsh/Dsh" {
841
901
  *
842
902
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
843
903
  *
904
+ *
844
905
  * @returns Reference to `this` in order to allow method chaining
845
906
  */
846
907
  setSemanticMappings(
@@ -856,6 +917,7 @@ declare module "sap/zen/dsh/Dsh" {
856
917
  *
857
918
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
858
919
  *
920
+ *
859
921
  * @returns Reference to `this` in order to allow method chaining
860
922
  */
861
923
  setSystemAlias(
@@ -871,6 +933,7 @@ declare module "sap/zen/dsh/Dsh" {
871
933
  *
872
934
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
873
935
  *
936
+ *
874
937
  * @returns Reference to `this` in order to allow method chaining
875
938
  */
876
939
  setWidth(
@@ -880,7 +943,11 @@ declare module "sap/zen/dsh/Dsh" {
880
943
  sWidth?: CSSSize
881
944
  ): this;
882
945
  }
883
-
946
+ /**
947
+ * Describes the settings that can be provided to the Dsh constructor.
948
+ *
949
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
950
+ */
884
951
  export interface $DshSettings extends $ControlSettings {
885
952
  /**
886
953
  * Name of the Design Studio application to be opened.
@@ -960,9 +1027,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
960
1027
  import Control from "sap/ui/core/Control";
961
1028
 
962
1029
  /**
963
- * @deprecated (since 1.89)
964
- *
965
1030
  * The ValueHelpDialog control can be used to implement a value help for an input field.
1031
+ *
1032
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
966
1033
  */
967
1034
  export default class ValueHelpDialog extends Dialog {
968
1035
  /**
@@ -1002,6 +1069,7 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1002
1069
  *
1003
1070
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
1004
1071
  *
1072
+ *
1005
1073
  * @returns Created class / constructor function
1006
1074
  */
1007
1075
  static extend<T extends Record<string, unknown>>(
@@ -1022,12 +1090,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1022
1090
  /**
1023
1091
  * Returns a metadata object for class sap.zen.dsh.ValueHelpDialog.
1024
1092
  *
1093
+ *
1025
1094
  * @returns Metadata object describing this class
1026
1095
  */
1027
1096
  static getMetadata(): ElementMetadata;
1028
1097
  /**
1029
- * @since 1.24
1030
- *
1031
1098
  * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1032
1099
  *
1033
1100
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1035,6 +1102,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1035
1102
  *
1036
1103
  * This event is fired when the Cancel button is pressed.
1037
1104
  *
1105
+ * @since 1.24
1106
+ *
1038
1107
  * @returns Reference to `this` in order to allow method chaining
1039
1108
  */
1040
1109
  attachCancel(
@@ -1053,8 +1122,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1053
1122
  oListener?: object
1054
1123
  ): this;
1055
1124
  /**
1056
- * @since 1.24
1057
- *
1058
1125
  * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1059
1126
  *
1060
1127
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1062,6 +1129,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1062
1129
  *
1063
1130
  * This event is fired when the Cancel button is pressed.
1064
1131
  *
1132
+ * @since 1.24
1133
+ *
1065
1134
  * @returns Reference to `this` in order to allow method chaining
1066
1135
  */
1067
1136
  attachCancel(
@@ -1075,8 +1144,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1075
1144
  oListener?: object
1076
1145
  ): this;
1077
1146
  /**
1078
- * @since 1.24
1079
- *
1080
1147
  * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1081
1148
  *
1082
1149
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1084,6 +1151,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1084
1151
  *
1085
1152
  * This event is fired when the OK button is pressed.
1086
1153
  *
1154
+ * @since 1.24
1155
+ *
1087
1156
  * @returns Reference to `this` in order to allow method chaining
1088
1157
  */
1089
1158
  attachOk(
@@ -1102,8 +1171,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1102
1171
  oListener?: object
1103
1172
  ): this;
1104
1173
  /**
1105
- * @since 1.24
1106
- *
1107
1174
  * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1108
1175
  *
1109
1176
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1111,6 +1178,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1111
1178
  *
1112
1179
  * This event is fired when the OK button is pressed.
1113
1180
  *
1181
+ * @since 1.24
1182
+ *
1114
1183
  * @returns Reference to `this` in order to allow method chaining
1115
1184
  */
1116
1185
  attachOk(
@@ -1124,8 +1193,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1124
1193
  oListener?: object
1125
1194
  ): this;
1126
1195
  /**
1127
- * @since 1.32
1128
- *
1129
1196
  * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
1130
1197
  * `sap.zen.dsh.ValueHelpDialog`.
1131
1198
  *
@@ -1136,6 +1203,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1136
1203
  *
1137
1204
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1138
1205
  *
1206
+ * @since 1.32
1207
+ *
1139
1208
  * @returns Reference to `this` in order to allow method chaining
1140
1209
  */
1141
1210
  attachSelectionChange(
@@ -1154,8 +1223,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1154
1223
  oListener?: object
1155
1224
  ): this;
1156
1225
  /**
1157
- * @since 1.32
1158
- *
1159
1226
  * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
1160
1227
  * `sap.zen.dsh.ValueHelpDialog`.
1161
1228
  *
@@ -1166,6 +1233,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1166
1233
  *
1167
1234
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1168
1235
  *
1236
+ * @since 1.32
1237
+ *
1169
1238
  * @returns Reference to `this` in order to allow method chaining
1170
1239
  */
1171
1240
  attachSelectionChange(
@@ -1179,8 +1248,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1179
1248
  oListener?: object
1180
1249
  ): this;
1181
1250
  /**
1182
- * @since 1.32
1183
- *
1184
1251
  * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1185
1252
  *
1186
1253
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1190,6 +1257,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1190
1257
  *
1191
1258
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1192
1259
  *
1260
+ * @since 1.32
1261
+ *
1193
1262
  * @returns Reference to `this` in order to allow method chaining
1194
1263
  */
1195
1264
  attachTokenRemove(
@@ -1208,8 +1277,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1208
1277
  oListener?: object
1209
1278
  ): this;
1210
1279
  /**
1211
- * @since 1.32
1212
- *
1213
1280
  * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1214
1281
  *
1215
1282
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -1219,6 +1286,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1219
1286
  *
1220
1287
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1221
1288
  *
1289
+ * @since 1.32
1290
+ *
1222
1291
  * @returns Reference to `this` in order to allow method chaining
1223
1292
  */
1224
1293
  attachTokenRemove(
@@ -1232,8 +1301,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1232
1301
  oListener?: object
1233
1302
  ): this;
1234
1303
  /**
1235
- * @since 1.32
1236
- *
1237
1304
  * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this
1238
1305
  * `sap.zen.dsh.ValueHelpDialog`.
1239
1306
  *
@@ -1244,6 +1311,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1244
1311
  *
1245
1312
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1246
1313
  *
1314
+ * @since 1.32
1315
+ *
1247
1316
  * @returns Reference to `this` in order to allow method chaining
1248
1317
  */
1249
1318
  attachUpdateSelection(
@@ -1262,8 +1331,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1262
1331
  oListener?: object
1263
1332
  ): this;
1264
1333
  /**
1265
- * @since 1.32
1266
- *
1267
1334
  * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this
1268
1335
  * `sap.zen.dsh.ValueHelpDialog`.
1269
1336
  *
@@ -1274,6 +1341,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1274
1341
  *
1275
1342
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
1276
1343
  *
1344
+ * @since 1.32
1345
+ *
1277
1346
  * @returns Reference to `this` in order to allow method chaining
1278
1347
  */
1279
1348
  attachUpdateSelection(
@@ -1289,16 +1358,17 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1289
1358
  /**
1290
1359
  * Destroys the filterBar in the aggregation {@link #getFilterBar filterBar}.
1291
1360
  *
1361
+ *
1292
1362
  * @returns Reference to `this` in order to allow method chaining
1293
1363
  */
1294
1364
  destroyFilterBar(): this;
1295
1365
  /**
1296
- * @since 1.24
1297
- *
1298
1366
  * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.zen.dsh.ValueHelpDialog`.
1299
1367
  *
1300
1368
  * The passed function and listener object must match the ones used for event registration.
1301
1369
  *
1370
+ * @since 1.24
1371
+ *
1302
1372
  * @returns Reference to `this` in order to allow method chaining
1303
1373
  */
1304
1374
  detachCancel(
@@ -1312,12 +1382,12 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1312
1382
  oListener?: object
1313
1383
  ): this;
1314
1384
  /**
1315
- * @since 1.24
1316
- *
1317
1385
  * Detaches event handler `fnFunction` from the {@link #event:ok ok} event of this `sap.zen.dsh.ValueHelpDialog`.
1318
1386
  *
1319
1387
  * The passed function and listener object must match the ones used for event registration.
1320
1388
  *
1389
+ * @since 1.24
1390
+ *
1321
1391
  * @returns Reference to `this` in order to allow method chaining
1322
1392
  */
1323
1393
  detachOk(
@@ -1331,13 +1401,13 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1331
1401
  oListener?: object
1332
1402
  ): this;
1333
1403
  /**
1334
- * @since 1.32
1335
- *
1336
1404
  * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
1337
1405
  * this `sap.zen.dsh.ValueHelpDialog`.
1338
1406
  *
1339
1407
  * The passed function and listener object must match the ones used for event registration.
1340
1408
  *
1409
+ * @since 1.32
1410
+ *
1341
1411
  * @returns Reference to `this` in order to allow method chaining
1342
1412
  */
1343
1413
  detachSelectionChange(
@@ -1351,12 +1421,12 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1351
1421
  oListener?: object
1352
1422
  ): this;
1353
1423
  /**
1354
- * @since 1.32
1355
- *
1356
1424
  * Detaches event handler `fnFunction` from the {@link #event:tokenRemove tokenRemove} event of this `sap.zen.dsh.ValueHelpDialog`.
1357
1425
  *
1358
1426
  * The passed function and listener object must match the ones used for event registration.
1359
1427
  *
1428
+ * @since 1.32
1429
+ *
1360
1430
  * @returns Reference to `this` in order to allow method chaining
1361
1431
  */
1362
1432
  detachTokenRemove(
@@ -1370,13 +1440,13 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1370
1440
  oListener?: object
1371
1441
  ): this;
1372
1442
  /**
1373
- * @since 1.32
1374
- *
1375
1443
  * Detaches event handler `fnFunction` from the {@link #event:updateSelection updateSelection} event of
1376
1444
  * this `sap.zen.dsh.ValueHelpDialog`.
1377
1445
  *
1378
1446
  * The passed function and listener object must match the ones used for event registration.
1379
1447
  *
1448
+ * @since 1.32
1449
+ *
1380
1450
  * @returns Reference to `this` in order to allow method chaining
1381
1451
  */
1382
1452
  detachUpdateSelection(
@@ -1390,11 +1460,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1390
1460
  oListener?: object
1391
1461
  ): this;
1392
1462
  /**
1463
+ * Fires event {@link #event:cancel cancel} to attached listeners.
1464
+ *
1393
1465
  * @since 1.24
1394
1466
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1395
1467
  *
1396
- * Fires event {@link #event:cancel cancel} to attached listeners.
1397
- *
1398
1468
  * @returns Reference to `this` in order to allow method chaining
1399
1469
  */
1400
1470
  fireCancel(
@@ -1404,11 +1474,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1404
1474
  mParameters?: object
1405
1475
  ): this;
1406
1476
  /**
1477
+ * Fires event {@link #event:ok ok} to attached listeners.
1478
+ *
1407
1479
  * @since 1.24
1408
1480
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1409
1481
  *
1410
- * Fires event {@link #event:ok ok} to attached listeners.
1411
- *
1412
1482
  * @returns Reference to `this` in order to allow method chaining
1413
1483
  */
1414
1484
  fireOk(
@@ -1418,11 +1488,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1418
1488
  mParameters?: ValueHelpDialog$OkEventParameters
1419
1489
  ): this;
1420
1490
  /**
1491
+ * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
1492
+ *
1421
1493
  * @since 1.32
1422
1494
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1423
1495
  *
1424
- * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
1425
- *
1426
1496
  * @returns Reference to `this` in order to allow method chaining
1427
1497
  */
1428
1498
  fireSelectionChange(
@@ -1432,11 +1502,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1432
1502
  mParameters?: ValueHelpDialog$SelectionChangeEventParameters
1433
1503
  ): this;
1434
1504
  /**
1505
+ * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
1506
+ *
1435
1507
  * @since 1.32
1436
1508
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1437
1509
  *
1438
- * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners.
1439
- *
1440
1510
  * @returns Reference to `this` in order to allow method chaining
1441
1511
  */
1442
1512
  fireTokenRemove(
@@ -1446,11 +1516,11 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1446
1516
  mParameters?: ValueHelpDialog$TokenRemoveEventParameters
1447
1517
  ): this;
1448
1518
  /**
1519
+ * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
1520
+ *
1449
1521
  * @since 1.32
1450
1522
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1451
1523
  *
1452
- * Fires event {@link #event:updateSelection updateSelection} to attached listeners.
1453
- *
1454
1524
  * @returns Reference to `this` in order to allow method chaining
1455
1525
  */
1456
1526
  fireUpdateSelection(
@@ -1460,8 +1530,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1460
1530
  mParameters?: ValueHelpDialog$UpdateSelectionEventParameters
1461
1531
  ): this;
1462
1532
  /**
1463
- * @since 1.24
1464
- *
1465
1533
  * Gets current value of property {@link #getBasicSearchText basicSearchText}.
1466
1534
  *
1467
1535
  * Defines the value for the basic search field. The value is set into the basic search field of the filter
@@ -1469,24 +1537,24 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1469
1537
  *
1470
1538
  * Default value is `empty string`.
1471
1539
  *
1540
+ * @since 1.24
1541
+ *
1472
1542
  * @returns Value of property `basicSearchText`
1473
1543
  */
1474
1544
  getBasicSearchText(): string;
1475
1545
  /**
1476
- * @since 1.24
1477
- *
1478
1546
  * Gets current value of property {@link #getDescriptionKey descriptionKey}.
1479
1547
  *
1480
1548
  * Defines the key of the column used for the token text.
1481
1549
  *
1482
1550
  * Default value is `empty string`.
1483
1551
  *
1552
+ * @since 1.24
1553
+ *
1484
1554
  * @returns Value of property `descriptionKey`
1485
1555
  */
1486
1556
  getDescriptionKey(): string;
1487
1557
  /**
1488
- * @since 1.24
1489
- *
1490
1558
  * Gets current value of property {@link #getDisplayFormat displayFormat}.
1491
1559
  *
1492
1560
  * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
@@ -1494,24 +1562,24 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1494
1562
  *
1495
1563
  * Default value is `empty string`.
1496
1564
  *
1565
+ * @since 1.24
1566
+ *
1497
1567
  * @returns Value of property `displayFormat`
1498
1568
  */
1499
1569
  getDisplayFormat(): string;
1500
1570
  /**
1501
- * @since 1.24
1502
- *
1503
1571
  * Gets current value of property {@link #getFilterMode filterMode}.
1504
1572
  *
1505
1573
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
1506
1574
  *
1507
1575
  * Default value is `false`.
1508
1576
  *
1577
+ * @since 1.24
1578
+ *
1509
1579
  * @returns Value of property `filterMode`
1510
1580
  */
1511
1581
  getFilterMode(): boolean;
1512
1582
  /**
1513
- * @since 1.24
1514
- *
1515
1583
  * Gets current value of property {@link #getKey key}.
1516
1584
  *
1517
1585
  * Defines the key of the column used for the internal key handling. The value of the column is used for
@@ -1519,90 +1587,90 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1519
1587
  *
1520
1588
  * Default value is `empty string`.
1521
1589
  *
1590
+ * @since 1.24
1591
+ *
1522
1592
  * @returns Value of property `key`
1523
1593
  */
1524
1594
  getKey(): string;
1525
1595
  /**
1526
- * @since 1.24
1527
- *
1528
1596
  * Gets current value of property {@link #getKeys keys}.
1529
1597
  *
1530
1598
  * Defines the list of additional keys of the column used for the internal key handling.
1531
1599
  *
1600
+ * @since 1.24
1601
+ *
1532
1602
  * @returns Value of property `keys`
1533
1603
  */
1534
1604
  getKeys(): string[];
1535
1605
  /**
1536
- * @since 1.24
1537
- *
1538
1606
  * Gets current value of property {@link #getMaxExcludeRanges maxExcludeRanges}.
1539
1607
  *
1540
1608
  * Defines the maximum number of exclude ranges.
1541
1609
  *
1542
1610
  * Default value is `"-1"`.
1543
1611
  *
1612
+ * @since 1.24
1613
+ *
1544
1614
  * @returns Value of property `maxExcludeRanges`
1545
1615
  */
1546
1616
  getMaxExcludeRanges(): string;
1547
1617
  /**
1548
- * @since 1.24
1549
- *
1550
1618
  * Gets current value of property {@link #getMaxIncludeRanges maxIncludeRanges}.
1551
1619
  *
1552
1620
  * Defines the maximum number of include ranges.
1553
1621
  *
1554
1622
  * Default value is `"-1"`.
1555
1623
  *
1624
+ * @since 1.24
1625
+ *
1556
1626
  * @returns Value of property `maxIncludeRanges`
1557
1627
  */
1558
1628
  getMaxIncludeRanges(): string;
1559
1629
  /**
1560
- * @since 1.24
1561
- *
1562
1630
  * Gets current value of property {@link #getSupportMultiselect supportMultiselect}.
1563
1631
  *
1564
1632
  * Enables multi-selection in the table used.
1565
1633
  *
1566
1634
  * Default value is `true`.
1567
1635
  *
1636
+ * @since 1.24
1637
+ *
1568
1638
  * @returns Value of property `supportMultiselect`
1569
1639
  */
1570
1640
  getSupportMultiselect(): boolean;
1571
1641
  /**
1572
- * @since 1.24
1573
- *
1574
1642
  * Gets current value of property {@link #getSupportRanges supportRanges}.
1575
1643
  *
1576
1644
  * Enables the ranges (conditions) feature in the dialog.
1577
1645
  *
1578
1646
  * Default value is `false`.
1579
1647
  *
1648
+ * @since 1.24
1649
+ *
1580
1650
  * @returns Value of property `supportRanges`
1581
1651
  */
1582
1652
  getSupportRanges(): boolean;
1583
1653
  /**
1584
- * @since 1.24
1585
- *
1586
1654
  * Gets current value of property {@link #getSupportRangesOnly supportRangesOnly}.
1587
1655
  *
1588
1656
  * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1589
1657
  *
1590
1658
  * Default value is `false`.
1591
1659
  *
1660
+ * @since 1.24
1661
+ *
1592
1662
  * @returns Value of property `supportRangesOnly`
1593
1663
  */
1594
1664
  getSupportRangesOnly(): boolean;
1595
1665
  /**
1596
- * @since 1.28
1597
- *
1598
1666
  * getTable Gives access to the internal table instance.
1599
1667
  *
1668
+ * @since 1.28
1669
+ *
1600
1670
  * @returns the used table instance
1601
1671
  */
1602
1672
  getTable(): object;
1603
1673
  /**
1604
- * @since 1.24
1605
- *
1606
1674
  * Gets current value of property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}.
1607
1675
  *
1608
1676
  * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
@@ -1610,12 +1678,12 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1610
1678
  *
1611
1679
  * Default value is `empty string`.
1612
1680
  *
1681
+ * @since 1.24
1682
+ *
1613
1683
  * @returns Value of property `tokenDisplayBehaviour`
1614
1684
  */
1615
1685
  getTokenDisplayBehaviour(): string;
1616
1686
  /**
1617
- * @since 1.24
1618
- *
1619
1687
  * Sets a new value for property {@link #getDescriptionKey descriptionKey}.
1620
1688
  *
1621
1689
  * Defines the key of the column used for the token text.
@@ -1624,6 +1692,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1624
1692
  *
1625
1693
  * Default value is `empty string`.
1626
1694
  *
1695
+ * @since 1.24
1696
+ *
1627
1697
  * @returns Reference to `this` in order to allow method chaining
1628
1698
  */
1629
1699
  setDescriptionKey(
@@ -1633,8 +1703,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1633
1703
  sDescriptionKey?: string
1634
1704
  ): this;
1635
1705
  /**
1636
- * @since 1.24
1637
- *
1638
1706
  * Sets a new value for property {@link #getDisplayFormat displayFormat}.
1639
1707
  *
1640
1708
  * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
@@ -1644,6 +1712,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1644
1712
  *
1645
1713
  * Default value is `empty string`.
1646
1714
  *
1715
+ * @since 1.24
1716
+ *
1647
1717
  * @returns Reference to `this` in order to allow method chaining
1648
1718
  */
1649
1719
  setDisplayFormat(
@@ -1653,9 +1723,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1653
1723
  sDisplayFormat?: string
1654
1724
  ): this;
1655
1725
  /**
1656
- * @since 1.24
1657
- *
1658
1726
  * setExcludeRangeOperations Sets the array for the supported exclude range operations.
1727
+ *
1728
+ * @since 1.24
1659
1729
  */
1660
1730
  setExcludeRangeOperations(
1661
1731
  /**
@@ -1670,8 +1740,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1670
1740
  sType: string
1671
1741
  ): void;
1672
1742
  /**
1673
- * @since 1.24
1674
- *
1675
1743
  * Sets a new value for property {@link #getFilterMode filterMode}.
1676
1744
  *
1677
1745
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
@@ -1680,6 +1748,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1680
1748
  *
1681
1749
  * Default value is `false`.
1682
1750
  *
1751
+ * @since 1.24
1752
+ *
1683
1753
  * @returns Reference to `this` in order to allow method chaining
1684
1754
  */
1685
1755
  setFilterMode(
@@ -1689,9 +1759,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1689
1759
  bFilterMode?: boolean
1690
1760
  ): this;
1691
1761
  /**
1692
- * @since 1.24
1693
- *
1694
1762
  * setIncludeRangeOperations Sets the array for the supported include range operations.
1763
+ *
1764
+ * @since 1.24
1695
1765
  */
1696
1766
  setIncludeRangeOperations(
1697
1767
  /**
@@ -1706,8 +1776,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1706
1776
  sType: string
1707
1777
  ): void;
1708
1778
  /**
1709
- * @since 1.24
1710
- *
1711
1779
  * Sets a new value for property {@link #getKey key}.
1712
1780
  *
1713
1781
  * Defines the key of the column used for the internal key handling. The value of the column is used for
@@ -1717,6 +1785,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1717
1785
  *
1718
1786
  * Default value is `empty string`.
1719
1787
  *
1788
+ * @since 1.24
1789
+ *
1720
1790
  * @returns Reference to `this` in order to allow method chaining
1721
1791
  */
1722
1792
  setKey(
@@ -1726,14 +1796,14 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1726
1796
  sKey?: string
1727
1797
  ): this;
1728
1798
  /**
1729
- * @since 1.24
1730
- *
1731
1799
  * Sets a new value for property {@link #getKeys keys}.
1732
1800
  *
1733
1801
  * Defines the list of additional keys of the column used for the internal key handling.
1734
1802
  *
1735
1803
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1736
1804
  *
1805
+ * @since 1.24
1806
+ *
1737
1807
  * @returns Reference to `this` in order to allow method chaining
1738
1808
  */
1739
1809
  setKeys(
@@ -1743,8 +1813,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1743
1813
  sKeys?: string[]
1744
1814
  ): this;
1745
1815
  /**
1746
- * @since 1.24
1747
- *
1748
1816
  * Sets a new value for property {@link #getMaxExcludeRanges maxExcludeRanges}.
1749
1817
  *
1750
1818
  * Defines the maximum number of exclude ranges.
@@ -1753,6 +1821,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1753
1821
  *
1754
1822
  * Default value is `"-1"`.
1755
1823
  *
1824
+ * @since 1.24
1825
+ *
1756
1826
  * @returns Reference to `this` in order to allow method chaining
1757
1827
  */
1758
1828
  setMaxExcludeRanges(
@@ -1762,8 +1832,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1762
1832
  sMaxExcludeRanges?: string
1763
1833
  ): this;
1764
1834
  /**
1765
- * @since 1.24
1766
- *
1767
1835
  * Sets a new value for property {@link #getMaxIncludeRanges maxIncludeRanges}.
1768
1836
  *
1769
1837
  * Defines the maximum number of include ranges.
@@ -1772,6 +1840,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1772
1840
  *
1773
1841
  * Default value is `"-1"`.
1774
1842
  *
1843
+ * @since 1.24
1844
+ *
1775
1845
  * @returns Reference to `this` in order to allow method chaining
1776
1846
  */
1777
1847
  setMaxIncludeRanges(
@@ -1781,10 +1851,10 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1781
1851
  sMaxIncludeRanges?: string
1782
1852
  ): this;
1783
1853
  /**
1784
- * @since 1.24
1785
- *
1786
1854
  * setRangeKeyFields Sets a RangeKeyFields array. This method allows you to specify the KeyFields for the
1787
1855
  * ranges. You can set an array of objects with Key and Label properties to define the key fields.
1856
+ *
1857
+ * @since 1.24
1788
1858
  */
1789
1859
  setRangeKeyFields(
1790
1860
  /**
@@ -1793,10 +1863,10 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1793
1863
  aRangeKeyFields: object[]
1794
1864
  ): void;
1795
1865
  /**
1796
- * @since 1.32
1797
- *
1798
1866
  * setTable Sets the table used in the value help dialog. If not used, the dialog creates a sap.ui.table.Table
1799
1867
  * or sap.m.Table instance internally.
1868
+ *
1869
+ * @since 1.32
1800
1870
  */
1801
1871
  setTable(
1802
1872
  /**
@@ -1805,8 +1875,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1805
1875
  oTable: object
1806
1876
  ): void;
1807
1877
  /**
1808
- * @since 1.24
1809
- *
1810
1878
  * Sets a new value for property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}.
1811
1879
  *
1812
1880
  * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
@@ -1816,6 +1884,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1816
1884
  *
1817
1885
  * Default value is `empty string`.
1818
1886
  *
1887
+ * @since 1.24
1888
+ *
1819
1889
  * @returns Reference to `this` in order to allow method chaining
1820
1890
  */
1821
1891
  setTokenDisplayBehaviour(
@@ -1825,8 +1895,6 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1825
1895
  sTokenDisplayBehaviour?: string
1826
1896
  ): this;
1827
1897
  /**
1828
- * @since 1.24
1829
- *
1830
1898
  * Sets the array of tokens. The `sap.m.Tokens` are added to the dialog tokenizer Selected Items or Excluded
1831
1899
  * Items. Normal tokens are added to the Selected Items tokenizer only and are selected in the table. `
1832
1900
  * new sap.m.Token({key: "0001", text:"SAP A.G. (0001)"}); ` Tokens with the extra data with value 'range'
@@ -1834,6 +1902,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1834
1902
  * { "exclude": false, "operation": sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation.BT, "keyField":
1835
1903
  * "CompanyCode", "value1": "a", "value2": "z"}); ` The selected items or range tokens are returned in the
1836
1904
  * event parameters of the Ok event.
1905
+ *
1906
+ * @since 1.24
1837
1907
  */
1838
1908
  setTokens(
1839
1909
  /**
@@ -1842,102 +1912,106 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1842
1912
  aTokens: Token[]
1843
1913
  ): void;
1844
1914
  /**
1845
- * @since 1.24
1846
- *
1847
1915
  * Update the Control
1848
1916
  *
1849
1917
  * Updates the selection of rows in the table. This function must be called after a first binding or binding
1850
1918
  * update of the table. It will set a table row as selected if a token for this row exists.
1919
+ *
1920
+ * @since 1.24
1851
1921
  */
1852
1922
  update(): void;
1853
1923
  }
1854
-
1924
+ /**
1925
+ * Describes the settings that can be provided to the ValueHelpDialog constructor.
1926
+ *
1927
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1928
+ */
1855
1929
  export interface $ValueHelpDialogSettings extends $DialogSettings {
1856
1930
  /**
1857
- * @since 1.24
1858
- *
1859
1931
  * Defines the value for the basic search field. The value is set into the basic search field of the filter
1860
1932
  * bar used.
1933
+ *
1934
+ * @since 1.24
1861
1935
  */
1862
1936
  basicSearchText?: string | PropertyBindingInfo;
1863
1937
 
1864
1938
  /**
1865
- * @since 1.24
1866
- *
1867
1939
  * Enables multi-selection in the table used.
1940
+ *
1941
+ * @since 1.24
1868
1942
  */
1869
1943
  supportMultiselect?: boolean | PropertyBindingInfo | `{${string}}`;
1870
1944
 
1871
1945
  /**
1872
- * @since 1.24
1873
- *
1874
1946
  * Enables the ranges (conditions) feature in the dialog.
1947
+ *
1948
+ * @since 1.24
1875
1949
  */
1876
1950
  supportRanges?: boolean | PropertyBindingInfo | `{${string}}`;
1877
1951
 
1878
1952
  /**
1879
- * @since 1.24
1880
- *
1881
1953
  * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature.
1954
+ *
1955
+ * @since 1.24
1882
1956
  */
1883
1957
  supportRangesOnly?: boolean | PropertyBindingInfo | `{${string}}`;
1884
1958
 
1885
1959
  /**
1886
- * @since 1.24
1887
- *
1888
1960
  * Defines the key of the column used for the internal key handling. The value of the column is used for
1889
1961
  * the token key and also to identify the row in the table.
1962
+ *
1963
+ * @since 1.24
1890
1964
  */
1891
1965
  key?: string | PropertyBindingInfo;
1892
1966
 
1893
1967
  /**
1894
- * @since 1.24
1895
- *
1896
1968
  * Defines the list of additional keys of the column used for the internal key handling.
1969
+ *
1970
+ * @since 1.24
1897
1971
  */
1898
1972
  keys?: string[] | PropertyBindingInfo | `{${string}}`;
1899
1973
 
1900
1974
  /**
1901
- * @since 1.24
1902
- *
1903
1975
  * Defines the key of the column used for the token text.
1976
+ *
1977
+ * @since 1.24
1904
1978
  */
1905
1979
  descriptionKey?: string | PropertyBindingInfo;
1906
1980
 
1907
1981
  /**
1908
- * @since 1.24
1909
- *
1910
1982
  * Defines the maximum number of include ranges.
1983
+ *
1984
+ * @since 1.24
1911
1985
  */
1912
1986
  maxIncludeRanges?: string | PropertyBindingInfo;
1913
1987
 
1914
1988
  /**
1915
- * @since 1.24
1916
- *
1917
1989
  * Defines the maximum number of exclude ranges.
1990
+ *
1991
+ * @since 1.24
1918
1992
  */
1919
1993
  maxExcludeRanges?: string | PropertyBindingInfo;
1920
1994
 
1921
1995
  /**
1922
- * @since 1.24
1923
- *
1924
1996
  * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered
1925
1997
  * value of the range (condition) is converted to uppercase letters.
1998
+ *
1999
+ * @since 1.24
1926
2000
  */
1927
2001
  displayFormat?: string | PropertyBindingInfo;
1928
2002
 
1929
2003
  /**
1930
- * @since 1.24
1931
- *
1932
2004
  * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour`
1933
2005
  * values.
2006
+ *
2007
+ * @since 1.24
1934
2008
  */
1935
2009
  tokenDisplayBehaviour?: string | PropertyBindingInfo;
1936
2010
 
1937
2011
  /**
1938
- * @since 1.24
1939
- *
1940
2012
  * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.
2013
+ *
2014
+ * @since 1.24
1941
2015
  */
1942
2016
  filterMode?: boolean | PropertyBindingInfo | `{${string}}`;
1943
2017
 
@@ -1948,54 +2022,63 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
1948
2022
  filterBar?: Control;
1949
2023
 
1950
2024
  /**
1951
- * @since 1.24
1952
- *
1953
2025
  * This event is fired when the OK button is pressed.
2026
+ *
2027
+ * @since 1.24
1954
2028
  */
1955
2029
  ok?: (oEvent: ValueHelpDialog$OkEvent) => void;
1956
2030
 
1957
2031
  /**
1958
- * @since 1.24
1959
- *
1960
2032
  * This event is fired when the Cancel button is pressed.
2033
+ *
2034
+ * @since 1.24
1961
2035
  */
1962
2036
  cancel?: (oEvent: Event) => void;
1963
2037
 
1964
2038
  /**
1965
- * @since 1.32
1966
- *
1967
2039
  * This event is fired when the user selects an item in the items table.
1968
2040
  *
1969
2041
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2042
+ *
2043
+ * @since 1.32
1970
2044
  */
1971
2045
  selectionChange?: (oEvent: ValueHelpDialog$SelectionChangeEvent) => void;
1972
2046
 
1973
2047
  /**
1974
- * @since 1.32
1975
- *
1976
2048
  * This event is fired when the user removes one or multiple existing token(s) from the dialog.
1977
2049
  *
1978
2050
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2051
+ *
2052
+ * @since 1.32
1979
2053
  */
1980
2054
  tokenRemove?: (oEvent: ValueHelpDialog$TokenRemoveEvent) => void;
1981
2055
 
1982
2056
  /**
1983
- * @since 1.32
1984
- *
1985
2057
  * This event is fired when the table gets an update and all existing tokens must be selected in the table.
1986
2058
  *
1987
2059
  * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
2060
+ *
2061
+ * @since 1.32
1988
2062
  */
1989
2063
  updateSelection?: (oEvent: ValueHelpDialog$UpdateSelectionEvent) => void;
1990
2064
  }
1991
2065
 
2066
+ /**
2067
+ * Parameters of the ValueHelpDialog#cancel event.
2068
+ */
1992
2069
  export interface ValueHelpDialog$CancelEventParameters {}
1993
2070
 
2071
+ /**
2072
+ * Event object of the ValueHelpDialog#cancel event.
2073
+ */
1994
2074
  export type ValueHelpDialog$CancelEvent = Event<
1995
2075
  ValueHelpDialog$CancelEventParameters,
1996
2076
  ValueHelpDialog
1997
2077
  >;
1998
2078
 
2079
+ /**
2080
+ * Parameters of the ValueHelpDialog#ok event.
2081
+ */
1999
2082
  export interface ValueHelpDialog$OkEventParameters {
2000
2083
  /**
2001
2084
  * The array of tokens created or modified on the ValueHelpDialog.
@@ -2003,11 +2086,17 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
2003
2086
  tokens?: Token[];
2004
2087
  }
2005
2088
 
2089
+ /**
2090
+ * Event object of the ValueHelpDialog#ok event.
2091
+ */
2006
2092
  export type ValueHelpDialog$OkEvent = Event<
2007
2093
  ValueHelpDialog$OkEventParameters,
2008
2094
  ValueHelpDialog
2009
2095
  >;
2010
2096
 
2097
+ /**
2098
+ * Parameters of the ValueHelpDialog#selectionChange event.
2099
+ */
2011
2100
  export interface ValueHelpDialog$SelectionChangeEventParameters {
2012
2101
  /**
2013
2102
  * The RowSelectionChange event parameter from the hosted table that contains the selected items.
@@ -2027,11 +2116,17 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
2027
2116
  useDefault?: boolean;
2028
2117
  }
2029
2118
 
2119
+ /**
2120
+ * Event object of the ValueHelpDialog#selectionChange event.
2121
+ */
2030
2122
  export type ValueHelpDialog$SelectionChangeEvent = Event<
2031
2123
  ValueHelpDialog$SelectionChangeEventParameters,
2032
2124
  ValueHelpDialog
2033
2125
  >;
2034
2126
 
2127
+ /**
2128
+ * Parameters of the ValueHelpDialog#tokenRemove event.
2129
+ */
2035
2130
  export interface ValueHelpDialog$TokenRemoveEventParameters {
2036
2131
  /**
2037
2132
  * The array of token keys that has been removed.
@@ -2044,11 +2139,17 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
2044
2139
  useDefault?: boolean;
2045
2140
  }
2046
2141
 
2142
+ /**
2143
+ * Event object of the ValueHelpDialog#tokenRemove event.
2144
+ */
2047
2145
  export type ValueHelpDialog$TokenRemoveEvent = Event<
2048
2146
  ValueHelpDialog$TokenRemoveEventParameters,
2049
2147
  ValueHelpDialog
2050
2148
  >;
2051
2149
 
2150
+ /**
2151
+ * Parameters of the ValueHelpDialog#updateSelection event.
2152
+ */
2052
2153
  export interface ValueHelpDialog$UpdateSelectionEventParameters {
2053
2154
  /**
2054
2155
  * The array of existing token keys for which the selection in the table has to be updated.
@@ -2061,6 +2162,9 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
2061
2162
  useDefault?: boolean;
2062
2163
  }
2063
2164
 
2165
+ /**
2166
+ * Event object of the ValueHelpDialog#updateSelection event.
2167
+ */
2064
2168
  export type ValueHelpDialog$UpdateSelectionEvent = Event<
2065
2169
  ValueHelpDialog$UpdateSelectionEventParameters,
2066
2170
  ValueHelpDialog
@@ -2069,10 +2173,10 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
2069
2173
 
2070
2174
  declare module "sap/zen/dsh/ValueHelpRangeOperation" {
2071
2175
  /**
2072
- * @deprecated (since 1.89)
2073
- * @experimental
2074
- *
2075
2176
  * Sort Type
2177
+ *
2178
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
2179
+ * @experimental
2076
2180
  */
2077
2181
  enum ValueHelpRangeOperation {
2078
2182
  /**
@@ -2121,9 +2225,9 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
2121
2225
  import Metadata from "sap/ui/base/Metadata";
2122
2226
 
2123
2227
  /**
2124
- * @deprecated (since 1.89.0)
2125
- *
2126
2228
  * Model implementation for JSON format
2229
+ *
2230
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
2127
2231
  */
2128
2232
  export default class SDKModel extends Model {
2129
2233
  /**
@@ -2142,6 +2246,7 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
2142
2246
  *
2143
2247
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
2144
2248
  *
2249
+ *
2145
2250
  * @returns Created class / constructor function
2146
2251
  */
2147
2252
  static extend<T extends Record<string, unknown>>(
@@ -2162,6 +2267,7 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
2162
2267
  /**
2163
2268
  * Returns a metadata object for class sap.zen.dsh.widgets.SDKModel.
2164
2269
  *
2270
+ *
2165
2271
  * @returns Metadata object describing this class
2166
2272
  */
2167
2273
  static getMetadata(): Metadata;