@sapui5/ts-types 1.102.1 → 1.103.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.102.0
+// For Library Version: 1.103.0
 
 declare namespace sap {
   namespace ui {
@@ -262,8 +262,8 @@ declare namespace sap {
         /**
          * semantic type for cluster. The type specifies the icon and the color of the cluster control.
          */
-        type?: /* was: sap.ui.vbm.SemanticType */
-          | any
+        type?:
+          | sap.ui.vbm.SemanticType
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
       }
@@ -958,8 +958,8 @@ declare namespace sap {
         /**
          * The semantic spot type for the legend marker.
          */
-        semanticSpotType?: /* was: sap.ui.vbm.SemanticType */
-          | any
+        semanticSpotType?:
+          | sap.ui.vbm.SemanticType
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
@@ -1075,8 +1075,8 @@ declare namespace sap {
         /**
          * Type for semantic labels. A given semantic type will overrule color settings and add an icon.
          */
-        labelType?: /* was: sap.ui.vbm.SemanticType */
-          | any
+        labelType?:
+          | sap.ui.vbm.SemanticType
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
@@ -1189,8 +1189,8 @@ declare namespace sap {
          * Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest
          * path between two points, e.g. flightroutes
          */
-        routetype?: /* was: sap.ui.vbm.RouteType */
-          | any
+        routetype?:
+          | sap.ui.vbm.RouteType
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
@@ -1339,8 +1339,8 @@ declare namespace sap {
         /**
          * Spot type for semantic spots. A given semantic type will overrule settings for image, scale, and content.
          */
-        type?: /* was: sap.ui.vbm.SemanticType */
-          | any
+        type?:
+          | sap.ui.vbm.SemanticType
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
@@ -1719,8 +1719,8 @@ declare namespace sap {
         /**
          * Type for semantic labels. A given semantic type will overrule color settings and add an icon.
          */
-        labelType?: /* was: sap.ui.vbm.SemanticType */
-          | any
+        labelType?:
+          | sap.ui.vbm.SemanticType
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
@@ -2621,7 +2621,7 @@ declare namespace sap {
            * The region to remove or its index or id
            */
           vRegion: int | string | sap.ui.vbm.Region
-        ): sap.ui.vbm.Region;
+        ): sap.ui.vbm.Region | null;
         /**
          * Zoom to one ore more regions.
          */
@@ -3272,7 +3272,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Area
-        ): sap.ui.vbm.Area;
+        ): sap.ui.vbm.Area | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -3625,7 +3625,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Box
-        ): sap.ui.vbm.Box;
+        ): sap.ui.vbm.Box | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -4016,7 +4016,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Circle
-        ): sap.ui.vbm.Circle;
+        ): sap.ui.vbm.Circle | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -4159,7 +4159,7 @@ declare namespace sap {
          *
          * @returns Value of property `type`
          */
-        getType(): /* was: sap.ui.vbm.SemanticType */ any;
+        getType(): sap.ui.vbm.SemanticType;
         /**
          * Sets a new value for property {@link #getColor color}.
          *
@@ -4221,7 +4221,7 @@ declare namespace sap {
           /**
            * New value for property `type`
            */
-          sType?: /* was: sap.ui.vbm.SemanticType */ any
+          sType?: sap.ui.vbm.SemanticType
         ): this;
       }
       /**
@@ -4717,7 +4717,7 @@ declare namespace sap {
            * The clusterContainer to remove or its index or id
            */
           vClusterContainer: int | string | sap.ui.vbm.ClusterContainer
-        ): sap.ui.vbm.ClusterContainer;
+        ): sap.ui.vbm.ClusterContainer | null;
         /**
          * Removes a clusterVo from the aggregation {@link #getClusterVos clusterVos}.
          *
@@ -4728,7 +4728,7 @@ declare namespace sap {
            * The clusterVo to remove or its index or id
            */
           vClusterVo: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Sets a new value for property {@link #getAreaAlwaysVisible areaAlwaysVisible}.
          *
@@ -5626,7 +5626,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Container
-        ): sap.ui.vbm.Container;
+        ): sap.ui.vbm.Container | null;
       }
       /**
        * DragSource Aggregation element
@@ -6408,7 +6408,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Feature
-        ): sap.ui.vbm.Feature;
+        ): sap.ui.vbm.Feature | null;
       }
       /**
        * Specific Visual Object element for a GeoCircle. A GeoCircle is positioned with its centerpoint
@@ -6768,7 +6768,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.GeoCircle
-        ): sap.ui.vbm.GeoCircle;
+        ): sap.ui.vbm.GeoCircle | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -7218,7 +7218,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Feature
-        ): sap.ui.vbm.Feature;
+        ): sap.ui.vbm.Feature | null;
         /**
          * Sets a new value for property {@link #getData data}.
          *
@@ -8701,7 +8701,7 @@ declare namespace sap {
            * The cluster to remove or its index or id
            */
           vCluster: int | string | sap.ui.vbm.ClusterBase
-        ): sap.ui.vbm.ClusterBase;
+        ): sap.ui.vbm.ClusterBase | null;
         /**
          * @deprecated - This aggregation should not longer be used. Its functionality has been replaced by the
          * more generic`geoJsonLayers` aggregation.
@@ -8715,7 +8715,7 @@ declare namespace sap {
            * The featureCollection to remove or its index or id
            */
           vFeatureCollection: int | string | sap.ui.vbm.FeatureCollection
-        ): sap.ui.vbm.FeatureCollection;
+        ): sap.ui.vbm.FeatureCollection | null;
         /**
          * Removes a geoJsonLayer from the aggregation {@link #getGeoJsonLayers geoJsonLayers}.
          *
@@ -8726,7 +8726,7 @@ declare namespace sap {
            * The geoJsonLayer to remove or its index or id
            */
           vGeoJsonLayer: int | string | sap.ui.vbm.GeoJsonLayer
-        ): sap.ui.vbm.GeoJsonLayer;
+        ): sap.ui.vbm.GeoJsonLayer | null;
         /**
          * Removes a resource from the aggregation {@link #getResources resources}.
          *
@@ -8737,7 +8737,7 @@ declare namespace sap {
            * The resource to remove or its index or id
            */
           vResource: int | string | sap.ui.vbm.Resource
-        ): sap.ui.vbm.Resource;
+        ): sap.ui.vbm.Resource | null;
         /**
          * Removes a vo from the aggregation {@link #getVos vos}.
          *
@@ -8748,7 +8748,7 @@ declare namespace sap {
            * The vo to remove or its index or id
            */
           vVo: int | string | sap.ui.vbm.VoAbstract
-        ): sap.ui.vbm.VoAbstract;
+        ): sap.ui.vbm.VoAbstract | null;
         /**
          * Sets a new value for property {@link #getCenterPosition centerPosition}.
          *
@@ -9290,7 +9290,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.HeatPoint
-        ): sap.ui.vbm.HeatPoint;
+        ): sap.ui.vbm.HeatPoint | null;
         /**
          * Sets a new value for property {@link #getAlphaExponent alphaExponent}.
          *
@@ -9804,7 +9804,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.LegendItem
-        ): sap.ui.vbm.LegendItem;
+        ): sap.ui.vbm.LegendItem | null;
         /**
          * Sets a new value for property {@link #getCaption caption}.
          *
@@ -10008,7 +10008,7 @@ declare namespace sap {
          *
          * @returns Value of property `semanticSpotType`
          */
-        getSemanticSpotType(): /* was: sap.ui.vbm.SemanticType */ any;
+        getSemanticSpotType(): sap.ui.vbm.SemanticType;
         /**
          * Gets current value of property {@link #getText text}.
          *
@@ -10062,7 +10062,7 @@ declare namespace sap {
           /**
            * New value for property `semanticSpotType`
            */
-          sSemanticSpotType?: /* was: sap.ui.vbm.SemanticType */ any
+          sSemanticSpotType?: sap.ui.vbm.SemanticType
         ): this;
         /**
          * Sets a new value for property {@link #getText text}.
@@ -10236,7 +10236,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.PieItem
-        ): sap.ui.vbm.PieItem;
+        ): sap.ui.vbm.PieItem | null;
         /**
          * Sets a new value for property {@link #getPosition position}.
          *
@@ -10644,7 +10644,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Pie
-        ): sap.ui.vbm.Pie;
+        ): sap.ui.vbm.Pie | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -10966,7 +10966,7 @@ declare namespace sap {
          *
          * @returns Value of property `labelType`
          */
-        getLabelType(): /* was: sap.ui.vbm.SemanticType */ any;
+        getLabelType(): sap.ui.vbm.SemanticType;
         /**
          * Gets current value of property {@link #getSelect select}.
          *
@@ -11081,7 +11081,7 @@ declare namespace sap {
           /**
            * New value for property `labelType`
            */
-          sLabelType?: /* was: sap.ui.vbm.SemanticType */ any
+          sLabelType?: sap.ui.vbm.SemanticType
         ): this;
         /**
          * Sets a new value for property {@link #getSelect select}.
@@ -11480,7 +11480,7 @@ declare namespace sap {
          *
          * @returns Value of property `routetype`
          */
-        getRoutetype(): /* was: sap.ui.vbm.RouteType */ any;
+        getRoutetype(): sap.ui.vbm.RouteType;
         /**
          * Gets current value of property {@link #getStart start}.
          *
@@ -11576,7 +11576,7 @@ declare namespace sap {
            * The dragSource to remove or its index or id
            */
           vDragSource: int | string | sap.ui.vbm.DragSource
-        ): sap.ui.vbm.DragSource;
+        ): sap.ui.vbm.DragSource | null;
         /**
          * Removes a dropTarget from the aggregation {@link #getDropTarget dropTarget}.
          *
@@ -11587,7 +11587,7 @@ declare namespace sap {
            * The dropTarget to remove or its index or id
            */
           vDropTarget: int | string | sap.ui.vbm.DropTarget
-        ): sap.ui.vbm.DropTarget;
+        ): sap.ui.vbm.DropTarget | null;
         /**
          * Sets a new value for property {@link #getColor color}.
          *
@@ -11778,7 +11778,7 @@ declare namespace sap {
           /**
            * New value for property `routetype`
            */
-          sRoutetype?: /* was: sap.ui.vbm.RouteType */ any
+          sRoutetype?: sap.ui.vbm.RouteType
         ): this;
         /**
          * Sets a new value for property {@link #getStart start}.
@@ -12287,7 +12287,7 @@ declare namespace sap {
            * The dragSource to remove or its index or id
            */
           vDragSource: int | string | sap.ui.vbm.DragSource
-        ): sap.ui.vbm.DragSource;
+        ): sap.ui.vbm.DragSource | null;
         /**
          * Removes a dropTarget from the aggregation {@link #getDropTarget dropTarget}.
          *
@@ -12298,7 +12298,7 @@ declare namespace sap {
            * The dropTarget to remove or its index or id
            */
           vDropTarget: int | string | sap.ui.vbm.DropTarget
-        ): sap.ui.vbm.DropTarget;
+        ): sap.ui.vbm.DropTarget | null;
         /**
          * Removes a item from the aggregation {@link #getItems items}.
          *
@@ -12309,7 +12309,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Route
-        ): sap.ui.vbm.Route;
+        ): sap.ui.vbm.Route | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -12559,7 +12559,7 @@ declare namespace sap {
          *
          * @returns Value of property `type`
          */
-        getType(): /* was: sap.ui.vbm.SemanticType */ any;
+        getType(): sap.ui.vbm.SemanticType;
         /**
          * Checks for the provided `sap.ui.vbm.DragSource` in the aggregation {@link #getDragSource dragSource}.
          * and returns its index if found or -1 otherwise.
@@ -12644,7 +12644,7 @@ declare namespace sap {
            * The dragSource to remove or its index or id
            */
           vDragSource: int | string | sap.ui.vbm.DragSource
-        ): sap.ui.vbm.DragSource;
+        ): sap.ui.vbm.DragSource | null;
         /**
          * Removes a dropTarget from the aggregation {@link #getDropTarget dropTarget}.
          *
@@ -12655,7 +12655,7 @@ declare namespace sap {
            * The dropTarget to remove or its index or id
            */
           vDropTarget: int | string | sap.ui.vbm.DropTarget
-        ): sap.ui.vbm.DropTarget;
+        ): sap.ui.vbm.DropTarget | null;
         /**
          * Sets a new value for property {@link #getAlignment alignment}.
          *
@@ -12848,7 +12848,7 @@ declare namespace sap {
           /**
            * New value for property `type`
            */
-          sType?: /* was: sap.ui.vbm.SemanticType */ any
+          sType?: sap.ui.vbm.SemanticType
         ): this;
       }
       /**
@@ -13131,7 +13131,7 @@ declare namespace sap {
            * The dragSource to remove or its index or id
            */
           vDragSource: int | string | sap.ui.vbm.DragSource
-        ): sap.ui.vbm.DragSource;
+        ): sap.ui.vbm.DragSource | null;
         /**
          * Removes a dropTarget from the aggregation {@link #getDropTarget dropTarget}.
          *
@@ -13142,7 +13142,7 @@ declare namespace sap {
            * The dropTarget to remove or its index or id
            */
           vDropTarget: int | string | sap.ui.vbm.DropTarget
-        ): sap.ui.vbm.DropTarget;
+        ): sap.ui.vbm.DropTarget | null;
         /**
          * Removes a item from the aggregation {@link #getItems items}.
          *
@@ -13153,7 +13153,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.vbm.Spot
-        ): sap.ui.vbm.Spot;
+        ): sap.ui.vbm.Spot | null;
         /**
          * Sets a new value for property {@link #getPosChangeable posChangeable}.
          *
@@ -14202,7 +14202,7 @@ declare namespace sap {
           /**
            * Type of information which should be returned
            */
-          iType: /* was: sap.ui.vbm.ClusterInfoType */ any
+          iType: sap.ui.vbm.ClusterInfoType
         ): Object;
         /**
          * Gets current value of property {@link #getKeyEventDelay keyEventDelay}.
@@ -16415,7 +16415,7 @@ declare namespace sap {
          *
          * @returns Value of property `labelType`
          */
-        getLabelType(): /* was: sap.ui.vbm.SemanticType */ any;
+        getLabelType(): sap.ui.vbm.SemanticType;
         /**
          * Gets current value of property {@link #getSelect select}.
          *
@@ -16713,7 +16713,7 @@ declare namespace sap {
           /**
            * New value for property `labelType`
            */
-          sLabelType?: /* was: sap.ui.vbm.SemanticType */ any
+          sLabelType?: sap.ui.vbm.SemanticType
         ): this;
         /**
          * Sets a new value for property {@link #getSelect select}.
@@ -16750,6 +16750,81 @@ declare namespace sap {
           sSelectColor?: string
         ): this;
       }
+      /**
+       * Cluster Info Type
+       */
+      enum ClusterInfoType {
+        /**
+         * Type indicating that Cluster Info should return info on child cluster nodes (next LOD). This is only
+         * supported for tree clustering.
+         */
+        ChildCluster = "1",
+        /**
+         * Type indicating that Cluster Info should return only VOs covered by the Cluster object
+         */
+        ContainedVOs = "0",
+        /**
+         * Type indicating that Cluster Info should return info on Edges of the Voronoi Area for the cluster. This
+         * is only supported for tree clustering. Edges not merged with rectangles.
+         */
+        Edges = "11",
+        /**
+         * Type indicating that Cluster Info should return info on cluster node itself.
+         */
+        NodeInfo = "10",
+        /**
+         * Type indicating that Cluster Info should return info on parent cluster node (previous LOD). This is only
+         * supported for tree clustering.
+         */
+        ParentNode = "2",
+      }
+      /**
+       * Route type, determining how line between start and endpoint should be drawn.
+       */
+      enum RouteType {
+        /**
+         * Type indicating a geodesic connection
+         */
+        Geodesic = "Geodesic",
+        /**
+         * Type indicating a straight connection
+         */
+        Straight = "Straight",
+      }
+      /**
+       * Semantic type with pre-defined display properties, like colors, icon, pin image, and so on. Semantic
+       * types enforce to fiori guidelines.
+       */
+      enum SemanticType {
+        /**
+         * Type indicating the Default state
+         */
+        Default = "Default",
+        /**
+         * Type indicating an Error state
+         */
+        Error = "Error",
+        /**
+         * Type indicating a Hidden state
+         */
+        Hidden = "Hidden",
+        /**
+         * Type indicating an Inactive state
+         */
+        Inactive = "Inactive",
+        /**
+         * Type indicating no state
+         */
+        None = "None",
+        /**
+         * Type indicating a Success/Positive state
+         */
+        Success = "Success",
+        /**
+         * Type indicating a Warning state
+         */
+        Warning = "Warning",
+      }
     }
   }