@sapui5/ts-types-esm 1.132.1 → 1.134.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +12 -11
  3. package/types/sap.ca.ui.d.ts +413 -415
  4. package/types/sap.chart.d.ts +6 -6
  5. package/types/sap.collaboration.d.ts +31 -31
  6. package/types/sap.cux.home.d.ts +927 -110
  7. package/types/sap.esh.search.ui.d.ts +45 -1
  8. package/types/sap.f.d.ts +211 -183
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +40 -11
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +141 -99
  14. package/types/sap.fe.navigation.d.ts +3 -3
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +3 -8
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +576 -464
  22. package/types/sap.insights.d.ts +3 -3
  23. package/types/sap.m.d.ts +2574 -1193
  24. package/types/sap.makit.d.ts +182 -182
  25. package/types/sap.me.d.ts +25 -27
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +41 -41
  29. package/types/sap.sac.df.d.ts +465 -193
  30. package/types/sap.suite.ui.commons.d.ts +432 -487
  31. package/types/sap.suite.ui.generic.template.d.ts +80 -37
  32. package/types/sap.suite.ui.microchart.d.ts +55 -79
  33. package/types/sap.tnt.d.ts +335 -20
  34. package/types/sap.ui.codeeditor.d.ts +9 -7
  35. package/types/sap.ui.commons.d.ts +326 -335
  36. package/types/sap.ui.comp.d.ts +432 -445
  37. package/types/sap.ui.core.d.ts +46978 -46714
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +5 -5
  41. package/types/sap.ui.generic.app.d.ts +83 -66
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +322 -236
  44. package/types/sap.ui.layout.d.ts +90 -104
  45. package/types/sap.ui.mdc.d.ts +393 -153
  46. package/types/sap.ui.richtexteditor.d.ts +48 -8
  47. package/types/sap.ui.rta.d.ts +76 -1
  48. package/types/sap.ui.suite.d.ts +14 -14
  49. package/types/sap.ui.support.d.ts +2 -2
  50. package/types/sap.ui.table.d.ts +219 -197
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +170 -158
  53. package/types/sap.ui.ux3.d.ts +113 -117
  54. package/types/sap.ui.vbm.d.ts +391 -60
  55. package/types/sap.ui.vk.d.ts +138 -135
  56. package/types/sap.ui.vtm.d.ts +112 -103
  57. package/types/sap.ui.webc.common.d.ts +7 -7
  58. package/types/sap.ui.webc.fiori.d.ts +164 -176
  59. package/types/sap.ui.webc.main.d.ts +527 -531
  60. package/types/sap.uiext.inbox.d.ts +43 -43
  61. package/types/sap.ushell.d.ts +246 -126
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +39 -51
  64. package/types/sap.viz.d.ts +2782 -2858
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +17 -17
  67. package/types/sap.zen.crosstab.d.ts +10 -10
  68. package/types/sap.zen.dsh.d.ts +11 -11
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.132.0
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare module "sap/ui/vbm/library" {
4
4
  /**
@@ -3047,7 +3047,7 @@ declare module "sap/ui/vbm/Cluster" {
3047
3047
  *
3048
3048
  * @returns Value of property `type`
3049
3049
  */
3050
- getType(): SemanticType | keyof typeof SemanticType;
3050
+ getType(): SemanticType;
3051
3051
  /**
3052
3052
  * Sets a new value for property {@link #getColor color}.
3053
3053
  *
@@ -5398,7 +5398,7 @@ declare module "sap/ui/vbm/ContainerLegendItem" {
5398
5398
  /**
5399
5399
  * Legend item control
5400
5400
  *
5401
- * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
5401
+ * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
5402
5402
  * versions.
5403
5403
  */
5404
5404
  export default class ContainerLegendItem
@@ -5470,7 +5470,7 @@ declare module "sap/ui/vbm/ContainerLegendItem" {
5470
5470
  *
5471
5471
  * @returns Value of property `semanticSpotType`
5472
5472
  */
5473
- getSemanticSpotType(): SemanticType | keyof typeof SemanticType;
5473
+ getSemanticSpotType(): SemanticType;
5474
5474
  /**
5475
5475
  * Sets a new value for property {@link #getColor color}.
5476
5476
  *
@@ -7784,6 +7784,8 @@ declare module "sap/ui/vbm/GeoMap" {
7784
7784
 
7785
7785
  import Spot from "sap/ui/vbm/Spot";
7786
7786
 
7787
+ import Legend from "sap/ui/vbm/Legend";
7788
+
7787
7789
  import ElementMetadata from "sap/ui/core/ElementMetadata";
7788
7790
 
7789
7791
  import VoBase from "sap/ui/vbm/VoBase";
@@ -7885,8 +7887,8 @@ declare module "sap/ui/vbm/GeoMap" {
7885
7887
  /**
7886
7888
  * Adds some featureCollection to the aggregation {@link #getFeatureCollections featureCollections}.
7887
7889
  *
7888
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
7889
- * by the more generic`geoJsonLayers` aggregation.
7890
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
7891
+ * replaced by the more generic`geoJsonLayers` aggregation.
7890
7892
  *
7891
7893
  * @returns Reference to `this` in order to allow method chaining
7892
7894
  */
@@ -8369,8 +8371,8 @@ declare module "sap/ui/vbm/GeoMap" {
8369
8371
  /**
8370
8372
  * Destroys all the featureCollections in the aggregation {@link #getFeatureCollections featureCollections}.
8371
8373
  *
8372
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
8373
- * by the more generic`geoJsonLayers` aggregation.
8374
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
8375
+ * replaced by the more generic`geoJsonLayers` aggregation.
8374
8376
  *
8375
8377
  * @returns Reference to `this` in order to allow method chaining
8376
8378
  */
@@ -8705,7 +8707,7 @@ declare module "sap/ui/vbm/GeoMap" {
8705
8707
  /**
8706
8708
  * Gets current value of property {@link #getClustering clustering}.
8707
8709
  *
8708
- * @deprecated (since 1.31) - This property should not longer be used. Its functionality has been replaced
8710
+ * @deprecated As of version 1.31. This property should not longer be used. Its functionality has been replaced
8709
8711
  * by the `clusters` aggregation.
8710
8712
  *
8711
8713
  * @returns Value of property `clustering`
@@ -8753,8 +8755,8 @@ declare module "sap/ui/vbm/GeoMap" {
8753
8755
  /**
8754
8756
  * Gets content of aggregation {@link #getFeatureCollections featureCollections}.
8755
8757
  *
8756
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
8757
- * by the more generic`geoJsonLayers` aggregation.
8758
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
8759
+ * replaced by the more generic`geoJsonLayers` aggregation.
8758
8760
  */
8759
8761
  getFeatureCollections(): FeatureCollection[];
8760
8762
  /**
@@ -8792,7 +8794,7 @@ declare module "sap/ui/vbm/GeoMap" {
8792
8794
  *
8793
8795
  * Legend for the Map
8794
8796
  */
8795
- getLegend(): /* was: sap.ui.vbm.Legend */ any;
8797
+ getLegend(): Legend;
8796
8798
  /**
8797
8799
  * Gets current value of property {@link #getLegendVisible legendVisible}.
8798
8800
  *
@@ -8828,8 +8830,8 @@ declare module "sap/ui/vbm/GeoMap" {
8828
8830
  /**
8829
8831
  * Trigger the interactive creation mode to get a position or position array.
8830
8832
  *
8831
- * @experimental (since 1.30.0) - This method is experimental and might be modified or removerd in future
8832
- * versions.
8833
+ * @experimental As of version 1.30.0. This method is experimental and might be modified or removerd in
8834
+ * future versions.
8833
8835
  *
8834
8836
  * @returns Indicator whether the creation mode could be triggered successfully or not.
8835
8837
  */
@@ -8935,8 +8937,8 @@ declare module "sap/ui/vbm/GeoMap" {
8935
8937
  * Checks for the provided `sap.ui.vbm.FeatureCollection` in the aggregation {@link #getFeatureCollections featureCollections}.
8936
8938
  * and returns its index if found or -1 otherwise.
8937
8939
  *
8938
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
8939
- * by the more generic`geoJsonLayers` aggregation.
8940
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
8941
+ * replaced by the more generic`geoJsonLayers` aggregation.
8940
8942
  *
8941
8943
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
8942
8944
  */
@@ -9006,8 +9008,8 @@ declare module "sap/ui/vbm/GeoMap" {
9006
9008
  /**
9007
9009
  * Inserts a featureCollection into the aggregation {@link #getFeatureCollections featureCollections}.
9008
9010
  *
9009
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
9010
- * by the more generic`geoJsonLayers` aggregation.
9011
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
9012
+ * replaced by the more generic`geoJsonLayers` aggregation.
9011
9013
  *
9012
9014
  * @returns Reference to `this` in order to allow method chaining
9013
9015
  */
@@ -9109,8 +9111,8 @@ declare module "sap/ui/vbm/GeoMap" {
9109
9111
  *
9110
9112
  * Additionally, it unregisters them from the hosting UIArea.
9111
9113
  *
9112
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
9113
- * by the more generic`geoJsonLayers` aggregation.
9114
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
9115
+ * replaced by the more generic`geoJsonLayers` aggregation.
9114
9116
  *
9115
9117
  * @returns An array of the removed elements (might be empty)
9116
9118
  */
@@ -9157,8 +9159,8 @@ declare module "sap/ui/vbm/GeoMap" {
9157
9159
  /**
9158
9160
  * Removes a featureCollection from the aggregation {@link #getFeatureCollections featureCollections}.
9159
9161
  *
9160
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
9161
- * by the more generic`geoJsonLayers` aggregation.
9162
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
9163
+ * replaced by the more generic`geoJsonLayers` aggregation.
9162
9164
  *
9163
9165
  * @returns The removed featureCollection or `null`
9164
9166
  */
@@ -9225,7 +9227,7 @@ declare module "sap/ui/vbm/GeoMap" {
9225
9227
  /**
9226
9228
  * Set clustering definitions.
9227
9229
  *
9228
- * @deprecated (since 1.31) - This property should not longer be used. Its functionality has been replaced
9230
+ * @deprecated As of version 1.31. This property should not longer be used. Its functionality has been replaced
9229
9231
  * by the `clusters` aggregation.
9230
9232
  *
9231
9233
  * @returns This allows method chaining
@@ -9348,7 +9350,7 @@ declare module "sap/ui/vbm/GeoMap" {
9348
9350
  /**
9349
9351
  * The legend to set
9350
9352
  */
9351
- oLegend: /* was: sap.ui.vbm.Legend */ any
9353
+ oLegend: Legend
9352
9354
  ): this;
9353
9355
  /**
9354
9356
  * Sets a new value for property {@link #getLegendVisible legendVisible}.
@@ -9606,7 +9608,7 @@ declare module "sap/ui/vbm/GeoMap" {
9606
9608
  visualFrame?: object | PropertyBindingInfo | `{${string}}`;
9607
9609
 
9608
9610
  /**
9609
- * @deprecated (since 1.31) - This property should not longer be used. Its functionality has been replaced
9611
+ * @deprecated As of version 1.31. This property should not longer be used. Its functionality has been replaced
9610
9612
  * by the `clusters` aggregation.
9611
9613
  */
9612
9614
  clustering?: object | PropertyBindingInfo | `{${string}}`;
@@ -9644,8 +9646,8 @@ declare module "sap/ui/vbm/GeoMap" {
9644
9646
  | `{${string}}`;
9645
9647
 
9646
9648
  /**
9647
- * @deprecated (since 1.31) - This aggregation should not longer be used. Its functionality has been replaced
9648
- * by the more generic`geoJsonLayers` aggregation.
9649
+ * @deprecated As of version 1.31. This aggregation should not longer be used. Its functionality has been
9650
+ * replaced by the more generic`geoJsonLayers` aggregation.
9649
9651
  */
9650
9652
  featureCollections?:
9651
9653
  | FeatureCollection[]
@@ -9661,7 +9663,7 @@ declare module "sap/ui/vbm/GeoMap" {
9661
9663
  /**
9662
9664
  * Legend for the Map
9663
9665
  */
9664
- legend?: /* was: sap.ui.vbm.Legend */ any;
9666
+ legend?: Legend;
9665
9667
 
9666
9668
  /**
9667
9669
  * Aggregation of clusters.
@@ -10588,6 +10590,333 @@ declare module "sap/ui/vbm/HeatPoint" {
10588
10590
  }
10589
10591
  }
10590
10592
 
10593
+ declare module "sap/ui/vbm/Legend" {
10594
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
10595
+
10596
+ import LegendItem from "sap/ui/vbm/LegendItem";
10597
+
10598
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
10599
+
10600
+ import {
10601
+ PropertyBindingInfo,
10602
+ AggregationBindingInfo,
10603
+ } from "sap/ui/base/ManagedObject";
10604
+
10605
+ import Event from "sap/ui/base/Event";
10606
+
10607
+ /**
10608
+ * The Legend is a window in the GeoMap or AnalyticMap control wich can be used to display color/icon-text
10609
+ * pairs on a map.
10610
+ */
10611
+ export default class Legend extends UI5Element {
10612
+ /**
10613
+ * Constructor for a new Legend.
10614
+ *
10615
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
10616
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
10617
+ * of the syntax of the settings object.
10618
+ */
10619
+ constructor(
10620
+ /**
10621
+ * initial settings for the new control
10622
+ */
10623
+ mSettings?: $LegendSettings
10624
+ );
10625
+ /**
10626
+ * Constructor for a new Legend.
10627
+ *
10628
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
10629
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
10630
+ * of the syntax of the settings object.
10631
+ */
10632
+ constructor(
10633
+ /**
10634
+ * id for the new control, generated automatically if no id is given
10635
+ */
10636
+ sId?: string,
10637
+ /**
10638
+ * initial settings for the new control
10639
+ */
10640
+ mSettings?: $LegendSettings
10641
+ );
10642
+
10643
+ /**
10644
+ * Creates a new subclass of class sap.ui.vbm.Legend with name `sClassName` and enriches it with the information
10645
+ * contained in `oClassInfo`.
10646
+ *
10647
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
10648
+ *
10649
+ *
10650
+ * @returns Created class / constructor function
10651
+ */
10652
+ static extend<T extends Record<string, unknown>>(
10653
+ /**
10654
+ * Name of the class being created
10655
+ */
10656
+ sClassName: string,
10657
+ /**
10658
+ * Object literal with information about the class
10659
+ */
10660
+ oClassInfo?: sap.ClassInfo<T, Legend>,
10661
+ /**
10662
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
10663
+ * used by this class
10664
+ */
10665
+ FNMetaImpl?: Function
10666
+ ): Function;
10667
+ /**
10668
+ * Returns a metadata object for class sap.ui.vbm.Legend.
10669
+ *
10670
+ *
10671
+ * @returns Metadata object describing this class
10672
+ */
10673
+ static getMetadata(): ElementMetadata;
10674
+ /**
10675
+ * Adds some item to the aggregation {@link #getItems items}.
10676
+ *
10677
+ *
10678
+ * @returns Reference to `this` in order to allow method chaining
10679
+ */
10680
+ addItem(
10681
+ /**
10682
+ * The item to add; if empty, nothing is inserted
10683
+ */
10684
+ oItem: LegendItem
10685
+ ): this;
10686
+ /**
10687
+ * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vbm.Legend`.
10688
+ *
10689
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
10690
+ * otherwise it will be bound to this `sap.ui.vbm.Legend` itself.
10691
+ *
10692
+ * The event is raised when there is a click action on a legend.
10693
+ *
10694
+ *
10695
+ * @returns Reference to `this` in order to allow method chaining
10696
+ */
10697
+ attachClick(
10698
+ /**
10699
+ * An application-specific payload object that will be passed to the event handler along with the event
10700
+ * object when firing the event
10701
+ */
10702
+ oData: object,
10703
+ /**
10704
+ * The function to be called when the event occurs
10705
+ */
10706
+ fnFunction: (p1: Legend$ClickEvent) => void,
10707
+ /**
10708
+ * Context object to call the event handler with. Defaults to this `sap.ui.vbm.Legend` itself
10709
+ */
10710
+ oListener?: object
10711
+ ): this;
10712
+ /**
10713
+ * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vbm.Legend`.
10714
+ *
10715
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
10716
+ * otherwise it will be bound to this `sap.ui.vbm.Legend` itself.
10717
+ *
10718
+ * The event is raised when there is a click action on a legend.
10719
+ *
10720
+ *
10721
+ * @returns Reference to `this` in order to allow method chaining
10722
+ */
10723
+ attachClick(
10724
+ /**
10725
+ * The function to be called when the event occurs
10726
+ */
10727
+ fnFunction: (p1: Legend$ClickEvent) => void,
10728
+ /**
10729
+ * Context object to call the event handler with. Defaults to this `sap.ui.vbm.Legend` itself
10730
+ */
10731
+ oListener?: object
10732
+ ): this;
10733
+ /**
10734
+ * Destroys all the items in the aggregation {@link #getItems items}.
10735
+ *
10736
+ *
10737
+ * @returns Reference to `this` in order to allow method chaining
10738
+ */
10739
+ destroyItems(): this;
10740
+ /**
10741
+ * Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.vbm.Legend`.
10742
+ *
10743
+ * The passed function and listener object must match the ones used for event registration.
10744
+ *
10745
+ *
10746
+ * @returns Reference to `this` in order to allow method chaining
10747
+ */
10748
+ detachClick(
10749
+ /**
10750
+ * The function to be called, when the event occurs
10751
+ */
10752
+ fnFunction: (p1: Legend$ClickEvent) => void,
10753
+ /**
10754
+ * Context object on which the given function had to be called
10755
+ */
10756
+ oListener?: object
10757
+ ): this;
10758
+ /**
10759
+ * Fires event {@link #event:click click} to attached listeners.
10760
+ *
10761
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
10762
+ *
10763
+ * @returns Reference to `this` in order to allow method chaining
10764
+ */
10765
+ fireClick(
10766
+ /**
10767
+ * Parameters to pass along with the event
10768
+ */
10769
+ mParameters?: Legend$ClickEventParameters
10770
+ ): this;
10771
+ /**
10772
+ * Gets current value of property {@link #getCaption caption}.
10773
+ *
10774
+ * The caption of the legend.
10775
+ *
10776
+ * Default value is `...see text or source`.
10777
+ *
10778
+ *
10779
+ * @returns Value of property `caption`
10780
+ */
10781
+ getCaption(): string;
10782
+ /**
10783
+ * Gets content of aggregation {@link #getItems items}.
10784
+ *
10785
+ * LegendItem object aggregation
10786
+ */
10787
+ getItems(): LegendItem[];
10788
+ /**
10789
+ * Checks for the provided `sap.ui.vbm.LegendItem` in the aggregation {@link #getItems items}. and returns
10790
+ * its index if found or -1 otherwise.
10791
+ *
10792
+ *
10793
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
10794
+ */
10795
+ indexOfItem(
10796
+ /**
10797
+ * The item whose index is looked for
10798
+ */
10799
+ oItem: LegendItem
10800
+ ): int;
10801
+ /**
10802
+ * Inserts a item into the aggregation {@link #getItems items}.
10803
+ *
10804
+ *
10805
+ * @returns Reference to `this` in order to allow method chaining
10806
+ */
10807
+ insertItem(
10808
+ /**
10809
+ * The item to insert; if empty, nothing is inserted
10810
+ */
10811
+ oItem: LegendItem,
10812
+ /**
10813
+ * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
10814
+ * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
10815
+ * the last position
10816
+ */
10817
+ iIndex: int
10818
+ ): this;
10819
+ /**
10820
+ * Removes all the controls from the aggregation {@link #getItems items}.
10821
+ *
10822
+ * Additionally, it unregisters them from the hosting UIArea.
10823
+ *
10824
+ *
10825
+ * @returns An array of the removed elements (might be empty)
10826
+ */
10827
+ removeAllItems(): LegendItem[];
10828
+ /**
10829
+ * Removes a item from the aggregation {@link #getItems items}.
10830
+ *
10831
+ *
10832
+ * @returns The removed item or `null`
10833
+ */
10834
+ removeItem(
10835
+ /**
10836
+ * The item to remove or its index or id
10837
+ */
10838
+ vItem: int | string | LegendItem
10839
+ ): LegendItem | null;
10840
+ /**
10841
+ * Sets a new value for property {@link #getCaption caption}.
10842
+ *
10843
+ * The caption of the legend.
10844
+ *
10845
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10846
+ *
10847
+ * Default value is `...see text or source`.
10848
+ *
10849
+ *
10850
+ * @returns Reference to `this` in order to allow method chaining
10851
+ */
10852
+ setCaption(
10853
+ /**
10854
+ * New value for property `caption`
10855
+ */
10856
+ sCaption?: string
10857
+ ): this;
10858
+ }
10859
+ /**
10860
+ * Describes the settings that can be provided to the Legend constructor.
10861
+ */
10862
+ export interface $LegendSettings extends $ElementSettings {
10863
+ /**
10864
+ * The caption of the legend.
10865
+ */
10866
+ caption?: string | PropertyBindingInfo;
10867
+
10868
+ /**
10869
+ * LegendItem object aggregation
10870
+ */
10871
+ items?: LegendItem[] | LegendItem | AggregationBindingInfo | `{${string}}`;
10872
+
10873
+ /**
10874
+ * The event is raised when there is a click action on a legend.
10875
+ */
10876
+ click?: (oEvent: Legend$ClickEvent) => void;
10877
+ }
10878
+
10879
+ /**
10880
+ * Parameters of the Legend#click event.
10881
+ */
10882
+ export interface Legend$ClickEventParameters {
10883
+ /**
10884
+ * Event data object
10885
+ */
10886
+ data?: object;
10887
+
10888
+ /**
10889
+ * The row number where the click occurred
10890
+ */
10891
+ row?: int;
10892
+
10893
+ /**
10894
+ * key modifier Ctrl pressed
10895
+ */
10896
+ ctrlKey?: boolean;
10897
+
10898
+ /**
10899
+ * key modifier Shift pressed
10900
+ */
10901
+ shiftKey?: boolean;
10902
+
10903
+ /**
10904
+ * key modifier Meta pressed
10905
+ */
10906
+ metaKey?: boolean;
10907
+
10908
+ /**
10909
+ * key modifier Alt pressed
10910
+ */
10911
+ altKey?: boolean;
10912
+ }
10913
+
10914
+ /**
10915
+ * Event object of the Legend#click event.
10916
+ */
10917
+ export type Legend$ClickEvent = Event<Legend$ClickEventParameters, Legend>;
10918
+ }
10919
+
10591
10920
  declare module "sap/ui/vbm/LegendItem" {
10592
10921
  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
10593
10922
 
@@ -10773,7 +11102,7 @@ declare module "sap/ui/vbm/LegendItem" {
10773
11102
  *
10774
11103
  * @returns Value of property `semanticSpotType`
10775
11104
  */
10776
- getSemanticSpotType(): SemanticType | keyof typeof SemanticType;
11105
+ getSemanticSpotType(): SemanticType;
10777
11106
  /**
10778
11107
  * Gets current value of property {@link #getText text}.
10779
11108
  *
@@ -10939,7 +11268,7 @@ declare module "sap/ui/vbm/ListPanel" {
10939
11268
  /**
10940
11269
  * Aggregation control for the Legend
10941
11270
  *
10942
- * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
11271
+ * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
10943
11272
  * versions.
10944
11273
  */
10945
11274
  export default class ListPanel extends Control {
@@ -11573,7 +11902,7 @@ declare module "sap/ui/vbm/ListPanel" {
11573
11902
  /**
11574
11903
  * Describes the settings that can be provided to the ListPanel constructor.
11575
11904
  *
11576
- * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
11905
+ * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
11577
11906
  * versions.
11578
11907
  */
11579
11908
  export interface $ListPanelSettings extends $ControlSettings {
@@ -11731,7 +12060,7 @@ declare module "sap/ui/vbm/ListPanelStack" {
11731
12060
  /**
11732
12061
  * ListPanelStack control
11733
12062
  *
11734
- * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
12063
+ * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
11735
12064
  * versions.
11736
12065
  */
11737
12066
  export default class ListPanelStack extends Control {
@@ -11992,7 +12321,7 @@ declare module "sap/ui/vbm/ListPanelStack" {
11992
12321
  /**
11993
12322
  * Describes the settings that can be provided to the ListPanelStack constructor.
11994
12323
  *
11995
- * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
12324
+ * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
11996
12325
  * versions.
11997
12326
  */
11998
12327
  export interface $ListPanelStackSettings extends $ControlSettings {
@@ -12697,8 +13026,8 @@ declare module "sap/ui/vbm/PieItem" {
12697
13026
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
12698
13027
  * otherwise it will be bound to this `sap.ui.vbm.PieItem` itself.
12699
13028
  *
12700
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12701
- * Pie Item index when event occurs.
13029
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13030
+ * includes Pie Item index when event occurs.
12702
13031
  *
12703
13032
  * @returns Reference to `this` in order to allow method chaining
12704
13033
  */
@@ -12723,8 +13052,8 @@ declare module "sap/ui/vbm/PieItem" {
12723
13052
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
12724
13053
  * otherwise it will be bound to this `sap.ui.vbm.PieItem` itself.
12725
13054
  *
12726
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12727
- * Pie Item index when event occurs.
13055
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13056
+ * includes Pie Item index when event occurs.
12728
13057
  *
12729
13058
  * @returns Reference to `this` in order to allow method chaining
12730
13059
  */
@@ -12743,8 +13072,8 @@ declare module "sap/ui/vbm/PieItem" {
12743
13072
  *
12744
13073
  * The passed function and listener object must match the ones used for event registration.
12745
13074
  *
12746
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12747
- * Pie Item index when event occurs.
13075
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13076
+ * includes Pie Item index when event occurs.
12748
13077
  *
12749
13078
  * @returns Reference to `this` in order to allow method chaining
12750
13079
  */
@@ -12761,8 +13090,8 @@ declare module "sap/ui/vbm/PieItem" {
12761
13090
  /**
12762
13091
  * Fires event {@link #event:click click} to attached listeners.
12763
13092
  *
12764
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12765
- * Pie Item index when event occurs.
13093
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13094
+ * includes Pie Item index when event occurs.
12766
13095
  * @ui5-protected Do not call from applications (only from related classes in the framework)
12767
13096
  *
12768
13097
  * @returns Reference to `this` in order to allow method chaining
@@ -12873,8 +13202,8 @@ declare module "sap/ui/vbm/PieItem" {
12873
13202
  color?: string | PropertyBindingInfo;
12874
13203
 
12875
13204
  /**
12876
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12877
- * Pie Item index when event occurs.
13205
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13206
+ * includes Pie Item index when event occurs.
12878
13207
  */
12879
13208
  click?: (oEvent: Event) => void;
12880
13209
  }
@@ -12882,16 +13211,16 @@ declare module "sap/ui/vbm/PieItem" {
12882
13211
  /**
12883
13212
  * Parameters of the PieItem#click event.
12884
13213
  *
12885
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12886
- * Pie Item index when event occurs.
13214
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13215
+ * includes Pie Item index when event occurs.
12887
13216
  */
12888
13217
  export interface PieItem$ClickEventParameters {}
12889
13218
 
12890
13219
  /**
12891
13220
  * Event object of the PieItem#click event.
12892
13221
  *
12893
- * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
12894
- * Pie Item index when event occurs.
13222
+ * @deprecated As of version 1.31. This event should no longer be used. Click event from Pie and Pies now
13223
+ * includes Pie Item index when event occurs.
12895
13224
  */
12896
13225
  export type PieItem$ClickEvent = Event<PieItem$ClickEventParameters, PieItem>;
12897
13226
  }
@@ -13447,7 +13776,7 @@ declare module "sap/ui/vbm/Region" {
13447
13776
  *
13448
13777
  * @returns Value of property `labelType`
13449
13778
  */
13450
- getLabelType(): SemanticType | keyof typeof SemanticType;
13779
+ getLabelType(): SemanticType;
13451
13780
  /**
13452
13781
  * Gets current value of property {@link #getSelect select}.
13453
13782
  *
@@ -14120,12 +14449,12 @@ declare module "sap/ui/vbm/Route" {
14120
14449
  *
14121
14450
  * Default value is `'Straight'`.
14122
14451
  *
14123
- * @experimental (since 1.32.0) - this method is experimental and might be modified or removed in future
14452
+ * @experimental As of version 1.32.0. this method is experimental and might be modified or removed in future
14124
14453
  * versions.
14125
14454
  *
14126
14455
  * @returns Value of property `routetype`
14127
14456
  */
14128
- getRoutetype(): RouteType | keyof typeof RouteType;
14457
+ getRoutetype(): RouteType;
14129
14458
  /**
14130
14459
  * Gets current value of property {@link #getStart start}.
14131
14460
  *
@@ -14434,7 +14763,7 @@ declare module "sap/ui/vbm/Route" {
14434
14763
  *
14435
14764
  * Default value is `'Straight'`.
14436
14765
  *
14437
- * @experimental (since 1.32.0) - this method is experimental and might be modified or removed in future
14766
+ * @experimental As of version 1.32.0. this method is experimental and might be modified or removed in future
14438
14767
  * versions.
14439
14768
  *
14440
14769
  * @returns Reference to `this` in order to allow method chaining
@@ -14530,7 +14859,7 @@ declare module "sap/ui/vbm/Route" {
14530
14859
  * Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest
14531
14860
  * path between two points, e.g. flightroutes
14532
14861
  *
14533
- * @experimental (since 1.32.0) - this method is experimental and might be modified or removed in future
14862
+ * @experimental As of version 1.32.0. this method is experimental and might be modified or removed in future
14534
14863
  * versions.
14535
14864
  */
14536
14865
  routetype?:
@@ -15506,7 +15835,7 @@ declare module "sap/ui/vbm/Spot" {
15506
15835
  *
15507
15836
  * @returns Value of property `type`
15508
15837
  */
15509
- getType(): SemanticType | keyof typeof SemanticType;
15838
+ getType(): SemanticType;
15510
15839
  /**
15511
15840
  * Checks for the provided `sap.ui.vbm.DragSource` in the aggregation {@link #getDragSource dragSource}.
15512
15841
  * and returns its index if found or -1 otherwise.
@@ -17293,8 +17622,8 @@ declare module "sap/ui/vbm/VBI" {
17293
17622
  /**
17294
17623
  * Gets current value of property {@link #getConfig config}.
17295
17624
  *
17296
- * @deprecated (since 1.31) - This property should not longer be used. Its functionality is covered by method
17297
- * `load`.
17625
+ * @deprecated As of version 1.31. This property should not longer be used. Its functionality is covered
17626
+ * by method `load`.
17298
17627
  *
17299
17628
  * @returns Value of property `config`
17300
17629
  */
@@ -17566,8 +17895,8 @@ declare module "sap/ui/vbm/VBI" {
17566
17895
  *
17567
17896
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
17568
17897
  *
17569
- * @deprecated (since 1.31) - This property should not longer be used. Its functionality is covered by method
17570
- * `load`.
17898
+ * @deprecated As of version 1.31. This property should not longer be used. Its functionality is covered
17899
+ * by method `load`.
17571
17900
  *
17572
17901
  * @returns Reference to `this` in order to allow method chaining
17573
17902
  */
@@ -17755,8 +18084,8 @@ declare module "sap/ui/vbm/VBI" {
17755
18084
  height?: CSSSize | PropertyBindingInfo | `{${string}}`;
17756
18085
 
17757
18086
  /**
17758
- * @deprecated (since 1.31) - This property should not longer be used. Its functionality is covered by method
17759
- * `load`.
18087
+ * @deprecated As of version 1.31. This property should not longer be used. Its functionality is covered
18088
+ * by method `load`.
17760
18089
  */
17761
18090
  config?: object | PropertyBindingInfo | `{${string}}`;
17762
18091
 
@@ -20254,7 +20583,7 @@ declare module "sap/ui/vbm/VoBase" {
20254
20583
  *
20255
20584
  * @returns Value of property `labelType`
20256
20585
  */
20257
- getLabelType(): SemanticType | keyof typeof SemanticType;
20586
+ getLabelType(): SemanticType;
20258
20587
  /**
20259
20588
  * Gets current value of property {@link #getSelect select}.
20260
20589
  *
@@ -20915,6 +21244,8 @@ declare namespace sap {
20915
21244
 
20916
21245
  "sap/ui/vbm/HeatPoint": undefined;
20917
21246
 
21247
+ "sap/ui/vbm/Legend": undefined;
21248
+
20918
21249
  "sap/ui/vbm/LegendItem": undefined;
20919
21250
 
20920
21251
  "sap/ui/vbm/library": undefined;