@sapui5/ts-types 1.122.2 → 1.123.0

package/types/sap.ui.vbm.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.0
+// For Library Version: 1.123.0
 
 declare namespace sap {
   namespace ui {
@@ -6,6 +6,9 @@ declare namespace sap {
      * SAP UI library: sap.ui.vbm
      */
     namespace vbm {
+      /**
+       * Describes the settings that can be provided to the Adapter constructor.
+       */
       interface $AdapterSettings extends sap.ui.core.$ElementSettings {
         /**
          * The GeoMap control associated with the Adapter. The adapter would invoke methods and subscribe to events
@@ -20,6 +23,9 @@ declare namespace sap {
         submit?: (oEvent: Adapter$SubmitEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Adapter3D constructor.
+       */
       interface $Adapter3DSettings extends sap.ui.core.$ElementSettings {
         /**
          * The {@link sap.ui.vbm.Viewport Viewport} control associated with the Adapter3D. The Adapter3D would invoke
@@ -33,6 +39,9 @@ declare namespace sap {
         submit?: (oEvent: Adapter3D$SubmitEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the AnalyticMap constructor.
+       */
       interface $AnalyticMapSettings extends sap.ui.vbm.$GeoMapSettings {
         /**
          * Regions that are different from the defaults. It is possible to specify the tooltip and color for regions.
@@ -67,6 +76,9 @@ declare namespace sap {
         regionDeselect?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Area constructor.
+       */
       interface $AreaSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position array for the Area. For single part areas the format is "lon0;lat0;0.0;...;lonN,latN,0.0".
@@ -104,6 +116,9 @@ declare namespace sap {
         edgeContextMenu?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Areas constructor.
+       */
       interface $AreasSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -134,6 +149,9 @@ declare namespace sap {
         edgeContextMenu?: (oEvent: Areas$EdgeContextMenuEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Box constructor.
+       */
       interface $BoxSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position of the Box. The format is "lon;lat;0".
@@ -156,6 +174,9 @@ declare namespace sap {
         colorBorder?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the Boxes constructor.
+       */
       interface $BoxesSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -185,6 +206,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the Circle constructor.
+       */
       interface $CircleSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position of the circle.
@@ -212,6 +236,9 @@ declare namespace sap {
         slices?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the Circles constructor.
+       */
       interface $CirclesSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -241,6 +268,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the Cluster constructor.
+       */
       interface $ClusterSettings extends sap.ui.core.$ControlSettings {
         /**
          * Set the color of the control. If a type is set then the semantic color of the type is taken instead.
@@ -270,6 +300,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the ClusterBase constructor.
+       */
       interface $ClusterBaseSettings extends sap.ui.core.$ElementSettings {
         /**
          * Flag controlling the visibility of the area convered by a cluster object.
@@ -337,9 +370,15 @@ declare namespace sap {
         contextMenu?: (oEvent: ClusterBase$ContextMenuEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ClusterContainer constructor.
+       */
       interface $ClusterContainerSettings
         extends sap.ui.vbm.$ContainerSettings {}
 
+      /**
+       * Describes the settings that can be provided to the ClusterDistance constructor.
+       */
       interface $ClusterDistanceSettings
         extends sap.ui.vbm.$ClusterBaseSettings {
         /**
@@ -353,6 +392,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the ClusterGrid constructor.
+       */
       interface $ClusterGridSettings extends sap.ui.vbm.$ClusterBaseSettings {
         /**
          * Size of grid cells in pixels. Format is "distanceX;distanceY"
@@ -398,6 +440,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the ClusterTree constructor.
+       */
       interface $ClusterTreeSettings extends sap.ui.vbm.$ClusterBaseSettings {
         /**
          * Indicates whether the split of a cluster object into sub clusterers or visual objects should be animated
@@ -408,6 +453,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the Container constructor.
+       */
       interface $ContainerSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position for the Container. The format is "lon;lat;0".
@@ -427,6 +475,9 @@ declare namespace sap {
         item?: sap.ui.core.Control;
       }
 
+      /**
+       * Describes the settings that can be provided to the ContainerBase constructor.
+       */
       interface $ContainerBaseSettings extends sap.ui.core.$ControlSettings {
         /**
          * Show fullscreen toggle button in toolbar
@@ -494,6 +545,9 @@ declare namespace sap {
         settingsPressed?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ContainerContent constructor.
+       */
       interface $ContainerContentSettings extends sap.ui.core.$ControlSettings {
         /**
          * Icon to show up in the toolbar
@@ -508,6 +562,9 @@ declare namespace sap {
         content?: sap.ui.core.Control;
       }
 
+      /**
+       * Describes the settings that can be provided to the Containers constructor.
+       */
       interface $ContainersSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Container object aggregation
@@ -519,6 +576,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the DragSource constructor.
+       */
       interface $DragSourceSettings extends sap.ui.core.$ElementSettings {
         /**
          * Drag type
@@ -526,6 +586,9 @@ declare namespace sap {
         type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the DropTarget constructor.
+       */
       interface $DropTargetSettings extends sap.ui.core.$ElementSettings {
         /**
          * Drop type
@@ -533,6 +596,9 @@ declare namespace sap {
         type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the Feature constructor.
+       */
       interface $FeatureSettings extends sap.ui.core.$ElementSettings {
         /**
          * The color, this should be provided in the rgba(r,g,b,a) format.
@@ -558,6 +624,9 @@ declare namespace sap {
         contextMenu?: (oEvent: Feature$ContextMenuEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the FeatureCollection constructor.
+       */
       interface $FeatureCollectionSettings
         extends sap.ui.vbm.$GeoJsonLayerSettings {
         /**
@@ -582,6 +651,9 @@ declare namespace sap {
         contextMenu?: (oEvent: FeatureCollection$ContextMenuEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the GeoCircle constructor.
+       */
       interface $GeoCircleSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position of the geocircle. The format is "lon;lat;0".
@@ -609,6 +681,9 @@ declare namespace sap {
         slices?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the GeoCircles constructor.
+       */
       interface $GeoCirclesSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -638,6 +713,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the GeoJsonLayer constructor.
+       */
       interface $GeoJsonLayerSettings extends sap.ui.core.$ElementSettings {
         /**
          * Source URL for GeoJSON
@@ -699,6 +777,9 @@ declare namespace sap {
         contextMenu?: (oEvent: GeoJsonLayer$ContextMenuEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the GeoMap constructor.
+       */
       interface $GeoMapSettings extends sap.ui.vbm.$VBISettings {
         /**
          * This is the map configuration for the geo map. The map configuration defines the used maps, the layering
@@ -909,6 +990,9 @@ declare namespace sap {
         keyUp?: (oEvent: GeoMap$KeyUpEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Heatmap constructor.
+       */
       interface $HeatmapSettings extends sap.ui.vbm.$VoAbstractSettings {
         /**
          * Gradient Definition. Can be either provided as Ressource - then it is type string.
@@ -971,6 +1055,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the HeatPoint constructor.
+       */
       interface $HeatPointSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position of a sample element of the heatmap. Should be bound. The format is "lon;lat;0"
@@ -988,6 +1075,9 @@ declare namespace sap {
         radius?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the LegendItem constructor.
+       */
       interface $LegendItemSettings extends sap.ui.core.$ElementSettings {
         /**
          * The color of the legend marker.
@@ -1018,6 +1108,12 @@ declare namespace sap {
         click?: (oEvent: LegendItem$ClickEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ListPanel constructor.
+       *
+       * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
+       * versions.
+       */
       interface $ListPanelSettings extends sap.ui.core.$ControlSettings {
         /**
          * Header text
@@ -1086,6 +1182,12 @@ declare namespace sap {
         itemPress?: (oEvent: ListPanel$ItemPressEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the ListPanelStack constructor.
+       *
+       * @experimental (since 1.38.0) - This class is experimental and might be modified or removed in future
+       * versions.
+       */
       interface $ListPanelStackSettings extends sap.ui.core.$ControlSettings {
         /**
          * Control width
@@ -1126,6 +1228,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the MapContainer constructor.
+       */
       interface $MapContainerSettings
         extends sap.ui.vbm.$ContainerBaseSettings {
         /**
@@ -1174,6 +1279,9 @@ declare namespace sap {
         listPanelStack?: /* was: sap.ui.vk.ListPanelStack */ any;
       }
 
+      /**
+       * Describes the settings that can be provided to the Pie constructor.
+       */
       interface $PieSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position of the Pie.
@@ -1196,6 +1304,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the PieItem constructor.
+       */
       interface $PieItemSettings extends sap.ui.core.$ElementSettings {
         /**
          * The name of the Pie item.
@@ -1219,6 +1330,9 @@ declare namespace sap {
         click?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Pies constructor.
+       */
       interface $PiesSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -1248,6 +1362,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the Region constructor.
+       */
       interface $RegionSettings extends sap.ui.core.$ElementSettings {
         /**
          * The color, this must be provided in the rgba(r,g,b,a) format.
@@ -1306,6 +1423,9 @@ declare namespace sap {
         contextMenu?: (oEvent: Region$ContextMenuEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Resource constructor.
+       */
       interface $ResourceSettings extends sap.ui.core.$ElementSettings {
         /**
          * Value of the resource. Base64 endode binary.
@@ -1325,6 +1445,9 @@ declare namespace sap {
         name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the Route constructor.
+       */
       interface $RouteSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0".
@@ -1424,6 +1547,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the Routes constructor.
+       */
       interface $RoutesSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -1477,6 +1603,9 @@ declare namespace sap {
         drop?: (oEvent: sap.ui.base.Event) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Spot constructor.
+       */
       interface $SpotSettings extends sap.ui.vbm.$VoBaseSettings {
         /**
          * The position of the spot. The format is "lon;lat;0"
@@ -1564,6 +1693,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the Spots constructor.
+       */
       interface $SpotsSettings extends sap.ui.vbm.$VoAggregationSettings {
         /**
          * Set to true if position may be changed at runtime. The actual changeability is control on each aggregated
@@ -1611,6 +1743,9 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the VBI constructor.
+       */
       interface $VBISettings extends sap.ui.core.$ControlSettings {
         /**
          * Set the width of the control.
@@ -1765,6 +1900,9 @@ declare namespace sap {
         containerDestroyed?: (oEvent: VBI$ContainerDestroyedEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the Viewport constructor.
+       */
       interface $ViewportSettings extends sap.ui.core.$ControlSettings {
         /**
          * Viewport width
@@ -1804,8 +1942,14 @@ declare namespace sap {
         cameraChange?: (oEvent: Viewport$CameraChangeEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the VoAbstract constructor.
+       */
       interface $VoAbstractSettings extends sap.ui.core.$ElementSettings {}
 
+      /**
+       * Describes the settings that can be provided to the VoAggregation constructor.
+       */
       interface $VoAggregationSettings extends sap.ui.vbm.$VoAbstractSettings {
         /**
          * Selection cardinality: minimum selected elements ("0" or "1" )
@@ -1869,6 +2013,9 @@ declare namespace sap {
         drop?: (oEvent: VoAggregation$DropEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the VoBase constructor.
+       */
       interface $VoBaseSettings extends sap.ui.core.$ElementSettings {
         /**
          * Unique identifier for the object. This is optional. If not provided the default identifier sId is used.
@@ -2020,10 +2167,16 @@ declare namespace sap {
         drop?: (oEvent: VoBase$DropEvent) => void;
       }
 
+      /**
+       * Parameters of the Adapter#submit event.
+       */
       interface Adapter$SubmitEventParameters {
         data?: string;
       }
 
+      /**
+       * Parameters of the Adapter3D#submit event.
+       */
       interface Adapter3D$SubmitEventParameters {
         /**
          * A string in the VBI JSON format.
@@ -2031,6 +2184,9 @@ declare namespace sap {
         data?: string;
       }
 
+      /**
+       * Parameters of the AnalyticMap#regionClick event.
+       */
       interface AnalyticMap$RegionClickEventParameters {
         /**
          * The regions code.
@@ -2038,6 +2194,9 @@ declare namespace sap {
         code?: string;
       }
 
+      /**
+       * Parameters of the AnalyticMap#regionContextMenu event.
+       */
       interface AnalyticMap$RegionContextMenuEventParameters {
         /**
          * The regions code.
@@ -2045,14 +2204,29 @@ declare namespace sap {
         code?: string;
       }
 
+      /**
+       * Parameters of the AnalyticMap#regionDeselect event.
+       */
       interface AnalyticMap$RegionDeselectEventParameters {}
 
+      /**
+       * Parameters of the AnalyticMap#regionSelect event.
+       */
       interface AnalyticMap$RegionSelectEventParameters {}
 
+      /**
+       * Parameters of the Area#edgeClick event.
+       */
       interface Area$EdgeClickEventParameters {}
 
+      /**
+       * Parameters of the Area#edgeContextMenu event.
+       */
       interface Area$EdgeContextMenuEventParameters {}
 
+      /**
+       * Parameters of the Areas#edgeClick event.
+       */
       interface Areas$EdgeClickEventParameters {
         /**
          * Clicked instance
@@ -2066,6 +2240,9 @@ declare namespace sap {
         edge?: int;
       }
 
+      /**
+       * Parameters of the Areas#edgeContextMenu event.
+       */
       interface Areas$EdgeContextMenuEventParameters {
         /**
          * Clicked instance
@@ -2079,6 +2256,9 @@ declare namespace sap {
         edge?: int;
       }
 
+      /**
+       * Parameters of the ClusterBase#click event.
+       */
       interface ClusterBase$ClickEventParameters {
         /**
          * ID of the clicked cluster object. Can serve as input for GeoMap function getInfoForCluster
@@ -2086,6 +2266,9 @@ declare namespace sap {
         clusterID?: string;
       }
 
+      /**
+       * Parameters of the ClusterBase#contextMenu event.
+       */
       interface ClusterBase$ContextMenuEventParameters {
         /**
          * ID of the clicked cluster object. Can serve as input for GeoMap function getInfoForCluster
@@ -2098,14 +2281,26 @@ declare namespace sap {
         menu?: sap.ui.unified.Menu;
       }
 
+      /**
+       * Parameters of the ContainerBase#contentChange event.
+       */
       interface ContainerBase$ContentChangeEventParameters {
         selectedItemId?: string;
       }
 
+      /**
+       * Parameters of the ContainerBase#settingsPressed event.
+       */
       interface ContainerBase$SettingsPressedEventParameters {}
 
+      /**
+       * Parameters of the Feature#click event.
+       */
       interface Feature$ClickEventParameters {}
 
+      /**
+       * Parameters of the Feature#contextMenu event.
+       */
       interface Feature$ContextMenuEventParameters {
         /**
          * Menu object to be used with openContextMenu().
@@ -2113,12 +2308,21 @@ declare namespace sap {
         menu?: sap.ui.unified.Menu;
       }
 
+      /**
+       * Parameters of the FeatureCollection#click event.
+       */
       interface FeatureCollection$ClickEventParameters
         extends sap.ui.vbm.GeoJsonLayer$ClickEventParameters {}
 
+      /**
+       * Parameters of the FeatureCollection#contextMenu event.
+       */
       interface FeatureCollection$ContextMenuEventParameters
         extends sap.ui.vbm.GeoJsonLayer$ContextMenuEventParameters {}
 
+      /**
+       * Parameters of the GeoJsonLayer#click event.
+       */
       interface GeoJsonLayer$ClickEventParameters {
         /**
          * Id of clicked Feature
@@ -2126,6 +2330,9 @@ declare namespace sap {
         featureId?: string;
       }
 
+      /**
+       * Parameters of the GeoJsonLayer#contextMenu event.
+       */
       interface GeoJsonLayer$ContextMenuEventParameters {
         /**
          * Id of clicked Feature
@@ -2133,6 +2340,9 @@ declare namespace sap {
         featureId?: string;
       }
 
+      /**
+       * Parameters of the GeoMap#centerChanged event.
+       */
       interface GeoMap$CenterChangedEventParameters {
         /**
          * Center point of the map. Format : Lon;Lat;0.0.
@@ -2150,6 +2360,9 @@ declare namespace sap {
         zoomLevel?: int;
       }
 
+      /**
+       * Parameters of the GeoMap#click event.
+       */
       interface GeoMap$ClickEventParameters {
         /**
          * Geo coordinates in format "<longitude>;<latitude>;0"
@@ -2157,6 +2370,9 @@ declare namespace sap {
         pos?: string;
       }
 
+      /**
+       * Parameters of the GeoMap#contextMenu event.
+       */
       interface GeoMap$ContextMenuEventParameters {
         /**
          * Client coordinate X
@@ -2174,6 +2390,9 @@ declare namespace sap {
         pos?: string;
       }
 
+      /**
+       * Parameters of the GeoMap#drop event.
+       */
       interface GeoMap$DropEventParameters {
         /**
          * Geo coordinates in format "<longitude>;<latitude>;0"
@@ -2181,6 +2400,9 @@ declare namespace sap {
         pos?: string;
       }
 
+      /**
+       * Parameters of the GeoMap#keyDown event.
+       */
       interface GeoMap$KeyDownEventParameters {
         /**
          * Key value of the key
@@ -2213,6 +2435,9 @@ declare namespace sap {
         meta?: boolean;
       }
 
+      /**
+       * Parameters of the GeoMap#keyPress event.
+       */
       interface GeoMap$KeyPressEventParameters {
         /**
          * Key value of the key
@@ -2245,6 +2470,9 @@ declare namespace sap {
         meta?: boolean;
       }
 
+      /**
+       * Parameters of the GeoMap#keyUp event.
+       */
       interface GeoMap$KeyUpEventParameters {
         /**
          * Key value of the key
@@ -2277,8 +2505,14 @@ declare namespace sap {
         meta?: boolean;
       }
 
+      /**
+       * Parameters of the GeoMap#select event.
+       */
       interface GeoMap$SelectEventParameters {}
 
+      /**
+       * Parameters of the GeoMap#zoomChanged event.
+       */
       interface GeoMap$ZoomChangedEventParameters {
         /**
          * Center point of the map. Format : Lon;Lat;0.0.
@@ -2296,6 +2530,9 @@ declare namespace sap {
         zoomLevel?: int;
       }
 
+      /**
+       * Parameters of the LegendItem#click event.
+       */
       interface LegendItem$ClickEventParameters {
         /**
          * Event data object
@@ -2323,10 +2560,19 @@ declare namespace sap {
         altKey?: boolean;
       }
 
+      /**
+       * Parameters of the ListPanel#expand event.
+       */
       interface ListPanel$ExpandEventParameters {}
 
+      /**
+       * Parameters of the ListPanel#headerIconPress event.
+       */
       interface ListPanel$HeaderIconPressEventParameters {}
 
+      /**
+       * Parameters of the ListPanel#itemPress event.
+       */
       interface ListPanel$ItemPressEventParameters {
         /**
          * The item which fired the pressed event.
@@ -2339,6 +2585,9 @@ declare namespace sap {
         srcControl?: sap.ui.core.Control;
       }
 
+      /**
+       * Parameters of the ListPanel#selectionChange event.
+       */
       interface ListPanel$SelectionChangeEventParameters {
         /**
          * The item whose selection has changed. In `MultiSelect` mode, only the up-most selected item is returned.
@@ -2357,8 +2606,17 @@ declare namespace sap {
         selected?: boolean;
       }
 
+      /**
+       * Parameters of the PieItem#click event.
+       *
+       * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
+       * Pie Item index when event occurs.
+       */
       interface PieItem$ClickEventParameters {}
 
+      /**
+       * Parameters of the Region#click event.
+       */
       interface Region$ClickEventParameters {
         /**
          * The region code.
@@ -2366,6 +2624,9 @@ declare namespace sap {
         code?: string;
       }
 
+      /**
+       * Parameters of the Region#contextMenu event.
+       */
       interface Region$ContextMenuEventParameters {
         /**
          * The region code.
@@ -2373,15 +2634,27 @@ declare namespace sap {
         code?: string;
       }
 
+      /**
+       * Parameters of the Routes#click event.
+       */
       interface Routes$ClickEventParameters
         extends sap.ui.vbm.VoAggregation$ClickEventParameters {}
 
+      /**
+       * Parameters of the Routes#contextMenu event.
+       */
       interface Routes$ContextMenuEventParameters
         extends sap.ui.vbm.VoAggregation$ContextMenuEventParameters {}
 
+      /**
+       * Parameters of the Routes#drop event.
+       */
       interface Routes$DropEventParameters
         extends sap.ui.vbm.VoAggregation$DropEventParameters {}
 
+      /**
+       * Parameters of the VBI#changeTrackingMode event.
+       */
       interface VBI$ChangeTrackingModeEventParameters {
         /**
          * tracking mode to set or reset
@@ -2394,6 +2667,9 @@ declare namespace sap {
         bSet?: boolean;
       }
 
+      /**
+       * Parameters of the VBI#closeWindow event.
+       */
       interface VBI$CloseWindowEventParameters {
         /**
          * DomRef of placeholder Div for content.
@@ -2406,6 +2682,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the VBI#containerCreated event.
+       */
       interface VBI$ContainerCreatedEventParameters {
         /**
          * DomRef of placeholder Div to render into.
@@ -2418,6 +2697,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the VBI#containerDestroyed event.
+       */
       interface VBI$ContainerDestroyedEventParameters {
         /**
          * DomRef of placeholder Div of content.
@@ -2430,6 +2712,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the VBI#move event.
+       */
       interface VBI$MoveEventParameters {
         /**
          * Canvas object to render into.
@@ -2437,6 +2722,9 @@ declare namespace sap {
         canvas?: object;
       }
 
+      /**
+       * Parameters of the VBI#openWindow event.
+       */
       interface VBI$OpenWindowEventParameters {
         /**
          * DomRef of placeholder Div to render into.
@@ -2449,6 +2737,9 @@ declare namespace sap {
         id?: string;
       }
 
+      /**
+       * Parameters of the VBI#render event.
+       */
       interface VBI$RenderEventParameters {
         /**
          * Canvas object to render into.
@@ -2456,6 +2747,9 @@ declare namespace sap {
         canvas?: object;
       }
 
+      /**
+       * Parameters of the VBI#submit event.
+       */
       interface VBI$SubmitEventParameters {
         /**
          * JSON (or possibly XML and case the plugin is used) string describing the delta state of Visual Business
@@ -2464,6 +2758,9 @@ declare namespace sap {
         data?: string;
       }
 
+      /**
+       * Parameters of the VBI#thumbnailClick event.
+       */
       interface VBI$ThumbnailClickEventParameters {
         /**
          * Geo coordinates in format "lon;lat;0"
@@ -2476,6 +2773,9 @@ declare namespace sap {
         zoomLevel?: int;
       }
 
+      /**
+       * Parameters of the VBI#zoom event.
+       */
       interface VBI$ZoomEventParameters {
         /**
          * Canvas object to render into
@@ -2483,6 +2783,9 @@ declare namespace sap {
         canvas?: object;
       }
 
+      /**
+       * Parameters of the Viewport#cameraChange event.
+       */
       interface Viewport$CameraChangeEventParameters {
         /**
          * Current position in camera history
@@ -2495,6 +2798,9 @@ declare namespace sap {
         historyLength?: int;
       }
 
+      /**
+       * Parameters of the VoAggregation#click event.
+       */
       interface VoAggregation$ClickEventParameters {
         /**
          * Clicked instance
@@ -2502,6 +2808,9 @@ declare namespace sap {
         instance?: sap.ui.vbm.VoBase;
       }
 
+      /**
+       * Parameters of the VoAggregation#contextMenu event.
+       */
       interface VoAggregation$ContextMenuEventParameters {
         /**
          * Clicked instance
@@ -2514,6 +2823,9 @@ declare namespace sap {
         menu?: sap.ui.unified.Menu;
       }
 
+      /**
+       * Parameters of the VoAggregation#deselect event.
+       */
       interface VoAggregation$DeselectEventParameters {
         /**
          * Array of deselected VOs
@@ -2521,6 +2833,9 @@ declare namespace sap {
         deselected?: any[];
       }
 
+      /**
+       * Parameters of the VoAggregation#drop event.
+       */
       interface VoAggregation$DropEventParameters {
         /**
          * Drop target instance
@@ -2533,6 +2848,9 @@ declare namespace sap {
         dragSource?: sap.ui.vbm.VoBase;
       }
 
+      /**
+       * Parameters of the VoAggregation#handleClick event.
+       */
       interface VoAggregation$HandleClickEventParameters {
         /**
          * Clicked instance
@@ -2545,6 +2863,9 @@ declare namespace sap {
         handle?: int;
       }
 
+      /**
+       * Parameters of the VoAggregation#handleContextMenu event.
+       */
       interface VoAggregation$HandleContextMenuEventParameters {
         /**
          * Clicked instance
@@ -2562,6 +2883,9 @@ declare namespace sap {
         handle?: int;
       }
 
+      /**
+       * Parameters of the VoAggregation#handleMoved event.
+       */
       interface VoAggregation$HandleMovedEventParameters {
         /**
          * Clicked instance
@@ -2574,6 +2898,9 @@ declare namespace sap {
         handle?: int;
       }
 
+      /**
+       * Parameters of the VoAggregation#select event.
+       */
       interface VoAggregation$SelectEventParameters {
         /**
          * Array of selected VOs
@@ -2581,8 +2908,14 @@ declare namespace sap {
         selected?: any[];
       }
 
+      /**
+       * Parameters of the VoBase#click event.
+       */
       interface VoBase$ClickEventParameters {}
 
+      /**
+       * Parameters of the VoBase#contextMenu event.
+       */
       interface VoBase$ContextMenuEventParameters {
         /**
          * Menu to open
@@ -2590,6 +2923,9 @@ declare namespace sap {
         menu?: sap.ui.unified.Menu;
       }
 
+      /**
+       * Parameters of the VoBase#drop event.
+       */
       interface VoBase$DropEventParameters {
         /**
          * Dragged instance
@@ -2597,6 +2933,9 @@ declare namespace sap {
         dragSource?: sap.ui.vbm.VoBase;
       }
 
+      /**
+       * Parameters of the VoBase#handleClick event.
+       */
       interface VoBase$HandleClickEventParameters {
         /**
          * The number of the handle where the click occured. Handles are numbered zero based.
@@ -2604,6 +2943,9 @@ declare namespace sap {
         handle?: int;
       }
 
+      /**
+       * Parameters of the VoBase#handleContextMenu event.
+       */
       interface VoBase$HandleContextMenuEventParameters {
         /**
          * The number of the handle where the click occured. Handles are numbered zero based.
@@ -2616,6 +2958,9 @@ declare namespace sap {
         menu?: sap.ui.unified.Menu;
       }
 
+      /**
+       * Parameters of the VoBase#handleMoved event.
+       */
       interface VoBase$HandleMovedEventParameters {
         /**
          * The number of the handle where the click occured. Handles are numbered zero based.
@@ -19703,315 +20048,512 @@ declare namespace sap {
          */
         Warning = "Warning",
       }
-
+      /**
+       * Event object of the Adapter#submit event.
+       */
       type Adapter$SubmitEvent = sap.ui.base.Event<
         Adapter$SubmitEventParameters,
         Adapter
       >;
 
+      /**
+       * Event object of the Adapter3D#submit event.
+       */
       type Adapter3D$SubmitEvent = sap.ui.base.Event<
         Adapter3D$SubmitEventParameters,
         Adapter3D
       >;
 
+      /**
+       * Event object of the AnalyticMap#regionClick event.
+       */
       type AnalyticMap$RegionClickEvent = sap.ui.base.Event<
         AnalyticMap$RegionClickEventParameters,
         AnalyticMap
       >;
 
+      /**
+       * Event object of the AnalyticMap#regionContextMenu event.
+       */
       type AnalyticMap$RegionContextMenuEvent = sap.ui.base.Event<
         AnalyticMap$RegionContextMenuEventParameters,
         AnalyticMap
       >;
 
+      /**
+       * Event object of the AnalyticMap#regionDeselect event.
+       */
       type AnalyticMap$RegionDeselectEvent = sap.ui.base.Event<
         AnalyticMap$RegionDeselectEventParameters,
         AnalyticMap
       >;
 
+      /**
+       * Event object of the AnalyticMap#regionSelect event.
+       */
       type AnalyticMap$RegionSelectEvent = sap.ui.base.Event<
         AnalyticMap$RegionSelectEventParameters,
         AnalyticMap
       >;
 
+      /**
+       * Event object of the Area#edgeClick event.
+       */
       type Area$EdgeClickEvent = sap.ui.base.Event<
         Area$EdgeClickEventParameters,
         Area
       >;
 
+      /**
+       * Event object of the Area#edgeContextMenu event.
+       */
       type Area$EdgeContextMenuEvent = sap.ui.base.Event<
         Area$EdgeContextMenuEventParameters,
         Area
       >;
 
+      /**
+       * Event object of the Areas#edgeClick event.
+       */
       type Areas$EdgeClickEvent = sap.ui.base.Event<
         Areas$EdgeClickEventParameters,
         Areas
       >;
 
+      /**
+       * Event object of the Areas#edgeContextMenu event.
+       */
       type Areas$EdgeContextMenuEvent = sap.ui.base.Event<
         Areas$EdgeContextMenuEventParameters,
         Areas
       >;
 
+      /**
+       * Event object of the ClusterBase#click event.
+       */
       type ClusterBase$ClickEvent = sap.ui.base.Event<
         ClusterBase$ClickEventParameters,
         ClusterBase
       >;
 
+      /**
+       * Event object of the ClusterBase#contextMenu event.
+       */
       type ClusterBase$ContextMenuEvent = sap.ui.base.Event<
         ClusterBase$ContextMenuEventParameters,
         ClusterBase
       >;
 
+      /**
+       * Event object of the ContainerBase#contentChange event.
+       */
       type ContainerBase$ContentChangeEvent = sap.ui.base.Event<
         ContainerBase$ContentChangeEventParameters,
         ContainerBase
       >;
 
+      /**
+       * Event object of the ContainerBase#settingsPressed event.
+       */
       type ContainerBase$SettingsPressedEvent = sap.ui.base.Event<
         ContainerBase$SettingsPressedEventParameters,
         ContainerBase
       >;
 
+      /**
+       * Event object of the Feature#click event.
+       */
       type Feature$ClickEvent = sap.ui.base.Event<
         Feature$ClickEventParameters,
         Feature
       >;
 
+      /**
+       * Event object of the Feature#contextMenu event.
+       */
       type Feature$ContextMenuEvent = sap.ui.base.Event<
         Feature$ContextMenuEventParameters,
         Feature
       >;
 
+      /**
+       * Event object of the FeatureCollection#click event.
+       */
       type FeatureCollection$ClickEvent = sap.ui.base.Event<
         FeatureCollection$ClickEventParameters,
         FeatureCollection
       >;
 
+      /**
+       * Event object of the FeatureCollection#contextMenu event.
+       */
       type FeatureCollection$ContextMenuEvent = sap.ui.base.Event<
         FeatureCollection$ContextMenuEventParameters,
         FeatureCollection
       >;
 
+      /**
+       * Event object of the GeoJsonLayer#click event.
+       */
       type GeoJsonLayer$ClickEvent = sap.ui.base.Event<
         GeoJsonLayer$ClickEventParameters,
         GeoJsonLayer
       >;
 
+      /**
+       * Event object of the GeoJsonLayer#contextMenu event.
+       */
       type GeoJsonLayer$ContextMenuEvent = sap.ui.base.Event<
         GeoJsonLayer$ContextMenuEventParameters,
         GeoJsonLayer
       >;
 
+      /**
+       * Event object of the GeoMap#centerChanged event.
+       */
       type GeoMap$CenterChangedEvent = sap.ui.base.Event<
         GeoMap$CenterChangedEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#click event.
+       */
       type GeoMap$ClickEvent = sap.ui.base.Event<
         GeoMap$ClickEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#contextMenu event.
+       */
       type GeoMap$ContextMenuEvent = sap.ui.base.Event<
         GeoMap$ContextMenuEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#drop event.
+       */
       type GeoMap$DropEvent = sap.ui.base.Event<
         GeoMap$DropEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#keyDown event.
+       */
       type GeoMap$KeyDownEvent = sap.ui.base.Event<
         GeoMap$KeyDownEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#keyPress event.
+       */
       type GeoMap$KeyPressEvent = sap.ui.base.Event<
         GeoMap$KeyPressEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#keyUp event.
+       */
       type GeoMap$KeyUpEvent = sap.ui.base.Event<
         GeoMap$KeyUpEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#select event.
+       */
       type GeoMap$SelectEvent = sap.ui.base.Event<
         GeoMap$SelectEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the GeoMap#zoomChanged event.
+       */
       type GeoMap$ZoomChangedEvent = sap.ui.base.Event<
         GeoMap$ZoomChangedEventParameters,
         GeoMap
       >;
 
+      /**
+       * Event object of the LegendItem#click event.
+       */
       type LegendItem$ClickEvent = sap.ui.base.Event<
         LegendItem$ClickEventParameters,
         LegendItem
       >;
 
+      /**
+       * Event object of the ListPanel#expand event.
+       */
       type ListPanel$ExpandEvent = sap.ui.base.Event<
         ListPanel$ExpandEventParameters,
         ListPanel
       >;
 
+      /**
+       * Event object of the ListPanel#headerIconPress event.
+       */
       type ListPanel$HeaderIconPressEvent = sap.ui.base.Event<
         ListPanel$HeaderIconPressEventParameters,
         ListPanel
       >;
 
+      /**
+       * Event object of the ListPanel#itemPress event.
+       */
       type ListPanel$ItemPressEvent = sap.ui.base.Event<
         ListPanel$ItemPressEventParameters,
         ListPanel
       >;
 
+      /**
+       * Event object of the ListPanel#selectionChange event.
+       */
       type ListPanel$SelectionChangeEvent = sap.ui.base.Event<
         ListPanel$SelectionChangeEventParameters,
         ListPanel
       >;
 
+      /**
+       * Event object of the PieItem#click event.
+       *
+       * @deprecated (since 1.31) - This event should no longer be used. Click event from Pie and Pies now includes
+       * Pie Item index when event occurs.
+       */
       type PieItem$ClickEvent = sap.ui.base.Event<
         PieItem$ClickEventParameters,
         PieItem
       >;
 
+      /**
+       * Event object of the Region#click event.
+       */
       type Region$ClickEvent = sap.ui.base.Event<
         Region$ClickEventParameters,
         Region
       >;
 
+      /**
+       * Event object of the Region#contextMenu event.
+       */
       type Region$ContextMenuEvent = sap.ui.base.Event<
         Region$ContextMenuEventParameters,
         Region
       >;
 
+      /**
+       * Event object of the Routes#click event.
+       */
       type Routes$ClickEvent = sap.ui.base.Event<
         Routes$ClickEventParameters,
         Routes
       >;
 
+      /**
+       * Event object of the Routes#contextMenu event.
+       */
       type Routes$ContextMenuEvent = sap.ui.base.Event<
         Routes$ContextMenuEventParameters,
         Routes
       >;
 
+      /**
+       * Event object of the Routes#drop event.
+       */
       type Routes$DropEvent = sap.ui.base.Event<
         Routes$DropEventParameters,
         Routes
       >;
 
+      /**
+       * Event object of the VBI#changeTrackingMode event.
+       */
       type VBI$ChangeTrackingModeEvent = sap.ui.base.Event<
         VBI$ChangeTrackingModeEventParameters,
         VBI
       >;
 
+      /**
+       * Event object of the VBI#closeWindow event.
+       */
       type VBI$CloseWindowEvent = sap.ui.base.Event<
         VBI$CloseWindowEventParameters,
         VBI
       >;
 
+      /**
+       * Event object of the VBI#containerCreated event.
+       */
       type VBI$ContainerCreatedEvent = sap.ui.base.Event<
         VBI$ContainerCreatedEventParameters,
         VBI
       >;
 
+      /**
+       * Event object of the VBI#containerDestroyed event.
+       */
       type VBI$ContainerDestroyedEvent = sap.ui.base.Event<
         VBI$ContainerDestroyedEventParameters,
         VBI
       >;
 
+      /**
+       * Event object of the VBI#move event.
+       */
       type VBI$MoveEvent = sap.ui.base.Event<VBI$MoveEventParameters, VBI>;
 
+      /**
+       * Event object of the VBI#openWindow event.
+       */
       type VBI$OpenWindowEvent = sap.ui.base.Event<
         VBI$OpenWindowEventParameters,
         VBI
       >;
 
+      /**
+       * Event object of the VBI#render event.
+       */
       type VBI$RenderEvent = sap.ui.base.Event<VBI$RenderEventParameters, VBI>;
 
+      /**
+       * Event object of the VBI#submit event.
+       */
       type VBI$SubmitEvent = sap.ui.base.Event<VBI$SubmitEventParameters, VBI>;
 
+      /**
+       * Event object of the VBI#thumbnailClick event.
+       */
       type VBI$ThumbnailClickEvent = sap.ui.base.Event<
         VBI$ThumbnailClickEventParameters,
         VBI
       >;
 
+      /**
+       * Event object of the VBI#zoom event.
+       */
       type VBI$ZoomEvent = sap.ui.base.Event<VBI$ZoomEventParameters, VBI>;
 
+      /**
+       * Event object of the Viewport#cameraChange event.
+       */
       type Viewport$CameraChangeEvent = sap.ui.base.Event<
         Viewport$CameraChangeEventParameters,
         Viewport
       >;
 
+      /**
+       * Event object of the VoAggregation#click event.
+       */
       type VoAggregation$ClickEvent = sap.ui.base.Event<
         VoAggregation$ClickEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#contextMenu event.
+       */
       type VoAggregation$ContextMenuEvent = sap.ui.base.Event<
         VoAggregation$ContextMenuEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#deselect event.
+       */
       type VoAggregation$DeselectEvent = sap.ui.base.Event<
         VoAggregation$DeselectEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#drop event.
+       */
       type VoAggregation$DropEvent = sap.ui.base.Event<
         VoAggregation$DropEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#handleClick event.
+       */
       type VoAggregation$HandleClickEvent = sap.ui.base.Event<
         VoAggregation$HandleClickEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#handleContextMenu event.
+       */
       type VoAggregation$HandleContextMenuEvent = sap.ui.base.Event<
         VoAggregation$HandleContextMenuEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#handleMoved event.
+       */
       type VoAggregation$HandleMovedEvent = sap.ui.base.Event<
         VoAggregation$HandleMovedEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoAggregation#select event.
+       */
       type VoAggregation$SelectEvent = sap.ui.base.Event<
         VoAggregation$SelectEventParameters,
         VoAggregation
       >;
 
+      /**
+       * Event object of the VoBase#click event.
+       */
       type VoBase$ClickEvent = sap.ui.base.Event<
         VoBase$ClickEventParameters,
         VoBase
       >;
 
+      /**
+       * Event object of the VoBase#contextMenu event.
+       */
       type VoBase$ContextMenuEvent = sap.ui.base.Event<
         VoBase$ContextMenuEventParameters,
         VoBase
       >;
 
+      /**
+       * Event object of the VoBase#drop event.
+       */
       type VoBase$DropEvent = sap.ui.base.Event<
         VoBase$DropEventParameters,
         VoBase
       >;
 
+      /**
+       * Event object of the VoBase#handleClick event.
+       */
       type VoBase$HandleClickEvent = sap.ui.base.Event<
         VoBase$HandleClickEventParameters,
         VoBase
       >;
 
+      /**
+       * Event object of the VoBase#handleContextMenu event.
+       */
       type VoBase$HandleContextMenuEvent = sap.ui.base.Event<
         VoBase$HandleContextMenuEventParameters,
         VoBase
       >;
 
+      /**
+       * Event object of the VoBase#handleMoved event.
+       */
       type VoBase$HandleMovedEvent = sap.ui.base.Event<
         VoBase$HandleMovedEventParameters,
         VoBase