@sapui5/ts-types-esm 1.133.0 → 1.134.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/unified/library" {
   /**
@@ -948,7 +948,10 @@ declare module "sap/ui/unified/Calendar" {
     /**
      * Gets current value of property {@link #getIntervalSelection intervalSelection}.
      *
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * Default value is `false`.
      *
@@ -1095,7 +1098,10 @@ declare module "sap/ui/unified/Calendar" {
     /**
      * Gets current value of property {@link #getSingleSelection singleSelection}.
      *
-     * If set, only a single date or interval, if intervalSelection is enabled, can be selected
+     * Determines if a single date or single interval, when `intervalSelection` is set to `true`, can be selected.
+     *
+     * **Note:** This property should be set to `true` if `intervalSelection` is set to `true`, as selecting
+     * multiple intervals is not supported.
      *
      * Default value is `true`.
      *
@@ -1369,24 +1375,6 @@ declare module "sap/ui/unified/Calendar" {
        */
       oInitialFocusedDate?: object
     ): this;
-    /**
-     * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
-     *
-     * If set, interval selection is allowed
-     *
-     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-     *
-     * Default value is `false`.
-     *
-     *
-     * @returns Reference to `this` in order to allow method chaining
-     */
-    setIntervalSelection(
-      /**
-       * New value for property `intervalSelection`
-       */
-      bIntervalSelection?: boolean
-    ): this;
     /**
      * Sets the associated {@link #getLegend legend}.
      *
@@ -1546,24 +1534,6 @@ declare module "sap/ui/unified/Calendar" {
        */
       bShowWeekNumbers?: boolean
     ): this;
-    /**
-     * Sets a new value for property {@link #getSingleSelection singleSelection}.
-     *
-     * If set, only a single date or interval, if intervalSelection is enabled, can be selected
-     *
-     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-     *
-     * Default value is `true`.
-     *
-     *
-     * @returns Reference to `this` in order to allow method chaining
-     */
-    setSingleSelection(
-      /**
-       * New value for property `singleSelection`
-       */
-      bSingleSelection?: boolean
-    ): this;
     /**
      * Sets a new value for property {@link #getWidth width}.
      *
@@ -1589,12 +1559,18 @@ declare module "sap/ui/unified/Calendar" {
    */
   export interface $CalendarSettings extends $ControlSettings {
     /**
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      */
     intervalSelection?: boolean | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * If set, only a single date or interval, if intervalSelection is enabled, can be selected
+     * Determines if a single date or single interval, when `intervalSelection` is set to `true`, can be selected.
+     *
+     * **Note:** This property should be set to `true` if `intervalSelection` is set to `true`, as selecting
+     * multiple intervals is not supported.
      */
     singleSelection?: boolean | PropertyBindingInfo | `{${string}}`;
 
@@ -4974,7 +4950,10 @@ declare module "sap/ui/unified/calendar/MonthPicker" {
     /**
      * Gets current value of property {@link #getIntervalSelection intervalSelection}.
      *
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * Default value is `false`.
      *
@@ -5150,7 +5129,10 @@ declare module "sap/ui/unified/calendar/MonthPicker" {
     /**
      * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
      *
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -5273,7 +5255,10 @@ declare module "sap/ui/unified/calendar/MonthPicker" {
     months?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * @since 1.74
      */
@@ -7294,7 +7279,10 @@ declare module "sap/ui/unified/calendar/YearPicker" {
     /**
      * Gets current value of property {@link #getIntervalSelection intervalSelection}.
      *
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * Default value is `false`.
      *
@@ -7461,7 +7449,10 @@ declare module "sap/ui/unified/calendar/YearPicker" {
     /**
      * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
      *
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -7552,7 +7543,10 @@ declare module "sap/ui/unified/calendar/YearPicker" {
     years?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * If set, interval selection is allowed
+     * Determines if an interval of dates can be selected.
+     *
+     * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
+     * multiple intervals is not supported.
      *
      * @since 1.74
      */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/ux3/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/vbm/library" {
   /**
@@ -7784,6 +7784,8 @@ declare module "sap/ui/vbm/GeoMap" {
 
   import Spot from "sap/ui/vbm/Spot";
 
+  import Legend from "sap/ui/vbm/Legend";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import VoBase from "sap/ui/vbm/VoBase";
@@ -8792,7 +8794,7 @@ declare module "sap/ui/vbm/GeoMap" {
      *
      * Legend for the Map
      */
-    getLegend(): /* was: sap.ui.vbm.Legend */ any;
+    getLegend(): Legend;
     /**
      * Gets current value of property {@link #getLegendVisible legendVisible}.
      *
@@ -9348,7 +9350,7 @@ declare module "sap/ui/vbm/GeoMap" {
       /**
        * The legend to set
        */
-      oLegend: /* was: sap.ui.vbm.Legend */ any
+      oLegend: Legend
     ): this;
     /**
      * Sets a new value for property {@link #getLegendVisible legendVisible}.
@@ -9661,7 +9663,7 @@ declare module "sap/ui/vbm/GeoMap" {
     /**
      * Legend for the Map
      */
-    legend?: /* was: sap.ui.vbm.Legend */ any;
+    legend?: Legend;
 
     /**
      * Aggregation of clusters.
@@ -10588,6 +10590,333 @@ declare module "sap/ui/vbm/HeatPoint" {
   }
 }
 
+declare module "sap/ui/vbm/Legend" {
+  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
+
+  import LegendItem from "sap/ui/vbm/LegendItem";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
+
+  import Event from "sap/ui/base/Event";
+
+  /**
+   * The Legend is a window in the GeoMap or AnalyticMap control wich can be used to display color/icon-text
+   * pairs on a map.
+   */
+  export default class Legend extends UI5Element {
+    /**
+     * Constructor for a new Legend.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * initial settings for the new control
+       */
+      mSettings?: $LegendSettings
+    );
+    /**
+     * Constructor for a new Legend.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * id for the new control, generated automatically if no id is given
+       */
+      sId?: string,
+      /**
+       * initial settings for the new control
+       */
+      mSettings?: $LegendSettings
+    );
+
+    /**
+     * Creates a new subclass of class sap.ui.vbm.Legend with name `sClassName` and enriches it with the information
+     * contained in `oClassInfo`.
+     *
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
+     *
+     *
+     * @returns Created class / constructor function
+     */
+    static extend<T extends Record<string, unknown>>(
+      /**
+       * Name of the class being created
+       */
+      sClassName: string,
+      /**
+       * Object literal with information about the class
+       */
+      oClassInfo?: sap.ClassInfo<T, Legend>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.ui.vbm.Legend.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): ElementMetadata;
+    /**
+     * Adds some item to the aggregation {@link #getItems items}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    addItem(
+      /**
+       * The item to add; if empty, nothing is inserted
+       */
+      oItem: LegendItem
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vbm.Legend`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.ui.vbm.Legend` itself.
+     *
+     * The event is raised when there is a click action on a legend.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachClick(
+      /**
+       * An application-specific payload object that will be passed to the event handler along with the event
+       * object when firing the event
+       */
+      oData: object,
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Legend$ClickEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.ui.vbm.Legend` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vbm.Legend`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.ui.vbm.Legend` itself.
+     *
+     * The event is raised when there is a click action on a legend.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachClick(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Legend$ClickEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.ui.vbm.Legend` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Destroys all the items in the aggregation {@link #getItems items}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    destroyItems(): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.vbm.Legend`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachClick(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: Legend$ClickEvent) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Fires event {@link #event:click click} to attached listeners.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    fireClick(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: Legend$ClickEventParameters
+    ): this;
+    /**
+     * Gets current value of property {@link #getCaption caption}.
+     *
+     * The caption of the legend.
+     *
+     * Default value is `...see text or source`.
+     *
+     *
+     * @returns Value of property `caption`
+     */
+    getCaption(): string;
+    /**
+     * Gets content of aggregation {@link #getItems items}.
+     *
+     * LegendItem object aggregation
+     */
+    getItems(): LegendItem[];
+    /**
+     * Checks for the provided `sap.ui.vbm.LegendItem` in the aggregation {@link #getItems items}. and returns
+     * its index if found or -1 otherwise.
+     *
+     *
+     * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+     */
+    indexOfItem(
+      /**
+       * The item whose index is looked for
+       */
+      oItem: LegendItem
+    ): int;
+    /**
+     * Inserts a item into the aggregation {@link #getItems items}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    insertItem(
+      /**
+       * The item to insert; if empty, nothing is inserted
+       */
+      oItem: LegendItem,
+      /**
+       * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
+       * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
+       * the last position
+       */
+      iIndex: int
+    ): this;
+    /**
+     * Removes all the controls from the aggregation {@link #getItems items}.
+     *
+     * Additionally, it unregisters them from the hosting UIArea.
+     *
+     *
+     * @returns An array of the removed elements (might be empty)
+     */
+    removeAllItems(): LegendItem[];
+    /**
+     * Removes a item from the aggregation {@link #getItems items}.
+     *
+     *
+     * @returns The removed item or `null`
+     */
+    removeItem(
+      /**
+       * The item to remove or its index or id
+       */
+      vItem: int | string | LegendItem
+    ): LegendItem | null;
+    /**
+     * Sets a new value for property {@link #getCaption caption}.
+     *
+     * The caption of the legend.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `...see text or source`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setCaption(
+      /**
+       * New value for property `caption`
+       */
+      sCaption?: string
+    ): this;
+  }
+  /**
+   * Describes the settings that can be provided to the Legend constructor.
+   */
+  export interface $LegendSettings extends $ElementSettings {
+    /**
+     * The caption of the legend.
+     */
+    caption?: string | PropertyBindingInfo;
+
+    /**
+     * LegendItem object aggregation
+     */
+    items?: LegendItem[] | LegendItem | AggregationBindingInfo | `{${string}}`;
+
+    /**
+     * The event is raised when there is a click action on a legend.
+     */
+    click?: (oEvent: Legend$ClickEvent) => void;
+  }
+
+  /**
+   * Parameters of the Legend#click event.
+   */
+  export interface Legend$ClickEventParameters {
+    /**
+     * Event data object
+     */
+    data?: object;
+
+    /**
+     * The row number where the click occurred
+     */
+    row?: int;
+
+    /**
+     * key modifier Ctrl pressed
+     */
+    ctrlKey?: boolean;
+
+    /**
+     * key modifier Shift pressed
+     */
+    shiftKey?: boolean;
+
+    /**
+     * key modifier Meta pressed
+     */
+    metaKey?: boolean;
+
+    /**
+     * key modifier Alt pressed
+     */
+    altKey?: boolean;
+  }
+
+  /**
+   * Event object of the Legend#click event.
+   */
+  export type Legend$ClickEvent = Event<Legend$ClickEventParameters, Legend>;
+}
+
 declare module "sap/ui/vbm/LegendItem" {
   import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
 
@@ -20915,6 +21244,8 @@ declare namespace sap {
 
     "sap/ui/vbm/HeatPoint": undefined;
 
+    "sap/ui/vbm/Legend": undefined;
+
     "sap/ui/vbm/LegendItem": undefined;
 
     "sap/ui/vbm/library": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/vk/library" {
   /**
@@ -2262,7 +2262,7 @@ declare module "sap/ui/vk/ContentConnector" {
       /**
        * The consumption scenario.
        */
-      consumptionScenario: /* was: sap.ui.vk.ConsumptionScenario */ any
+      consumptionScenario: string
     ): this;
     /**
      * Sets an object that decrypts content of encrypted models.
@@ -4393,7 +4393,7 @@ declare module "sap/ui/vk/ContentManager" {
       /**
        * The consumption scenario.
        */
-      consumptionScenario: /* was: sap.ui.vk.ConsumptionScenario */ any
+      consumptionScenario: string
     ): this;
     /**
      * Sets the maximum number of retry attempts for a download operation if the initial request to retrieve
@@ -39703,7 +39703,7 @@ declare module "sap/ui/vk/Viewer" {
       /**
        * The consumption scenario.
        */
-      consumptionScenario: /* was: sap.ui.vk.ConsumptionScenario */ any
+      consumptionScenario: string
     ): this;
     /**
      * Sets an object that decrypts content of encrypted models.

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/vtm/library" {
   import Vtm from "sap/ui/vtm/Vtm";

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/webc/common/library" {}
 

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/webc/fiori/library" {
   /**

package/types/sap.ui.webc.main.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ui/webc/main/library" {
   /**

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/uiext/inbox/library" {}