@sapui5/ts-types 1.133.0 → 1.134.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace ui {
@@ -933,7 +933,7 @@ declare namespace sap {
         /**
          * Legend for the Map
          */
-        legend?: /* was: sap.ui.vbm.Legend */ any;
+        legend?: sap.ui.vbm.Legend;
 
         /**
          * Aggregation of clusters.
@@ -1075,6 +1075,30 @@ declare namespace sap {
         radius?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
+      /**
+       * Describes the settings that can be provided to the Legend constructor.
+       */
+      interface $LegendSettings extends sap.ui.core.$ElementSettings {
+        /**
+         * The caption of the legend.
+         */
+        caption?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * LegendItem object aggregation
+         */
+        items?:
+          | sap.ui.vbm.LegendItem[]
+          | sap.ui.vbm.LegendItem
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
+
+        /**
+         * The event is raised when there is a click action on a legend.
+         */
+        click?: (oEvent: Legend$ClickEvent) => void;
+      }
+
       /**
        * Describes the settings that can be provided to the LegendItem constructor.
        */
@@ -2530,6 +2554,41 @@ declare namespace sap {
         zoomLevel?: int;
       }
 
+      /**
+       * Parameters of the Legend#click event.
+       */
+      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;
+      }
+
       /**
        * Parameters of the LegendItem#click event.
        */
@@ -10340,7 +10399,7 @@ declare namespace sap {
          *
          * Legend for the Map
          */
-        getLegend(): /* was: sap.ui.vbm.Legend */ any;
+        getLegend(): sap.ui.vbm.Legend;
         /**
          * Gets current value of property {@link #getLegendVisible legendVisible}.
          *
@@ -10896,7 +10955,7 @@ declare namespace sap {
           /**
            * The legend to set
            */
-          oLegend: /* was: sap.ui.vbm.Legend */ any
+          oLegend: sap.ui.vbm.Legend
         ): this;
         /**
          * Sets a new value for property {@link #getLegendVisible legendVisible}.
@@ -11612,6 +11671,258 @@ declare namespace sap {
           sValue?: string
         ): this;
       }
+      /**
+       * The Legend is a window in the GeoMap or AnalyticMap control wich can be used to display color/icon-text
+       * pairs on a map.
+       */
+      class Legend extends sap.ui.core.Element {
+        /**
+         * 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?: sap.ui.vbm.$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?: sap.ui.vbm.$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, sap.ui.vbm.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(): sap.ui.core.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: sap.ui.vbm.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?: sap.ui.vbm.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(): sap.ui.vbm.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: sap.ui.vbm.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: sap.ui.vbm.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(): sap.ui.vbm.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 | sap.ui.vbm.LegendItem
+        ): sap.ui.vbm.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;
+      }
       /**
        * Aggregation element for the Legend. A LegendItem consists of marker and an associated text. The marker
        * is either a rectangle in the given color or the given image or a semantic spot type. If no marker but
@@ -20281,6 +20592,14 @@ declare namespace sap {
         GeoMap
       >;
 
+      /**
+       * Event object of the Legend#click event.
+       */
+      type Legend$ClickEvent = sap.ui.base.Event<
+        Legend$ClickEventParameters,
+        Legend
+      >;
+
       /**
        * Event object of the LegendItem#click event.
        */
@@ -20623,6 +20942,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 namespace sap {
   namespace ui {
@@ -24664,7 +24664,7 @@ declare namespace sap {
           /**
            * The consumption scenario.
            */
-          consumptionScenario: /* was: sap.ui.vk.ConsumptionScenario */ any
+          consumptionScenario: string
         ): this;
         /**
          * Sets an object that decrypts content of encrypted models.
@@ -25210,7 +25210,7 @@ declare namespace sap {
           /**
            * 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
@@ -39422,7 +39422,7 @@ declare namespace sap {
           /**
            * 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 namespace sap {
   namespace ui {

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 namespace sap {
   namespace ui {

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 namespace sap {
   namespace ui {

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 namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace uiext {

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   /**
@@ -230,6 +230,10 @@ declare namespace sap {
            * Version of the framework
            */
           appFrameworkVersion: string;
+          /**
+           * The FLP URL with the current hash included.
+           */
+          url: string;
         };
 
         /**
@@ -789,6 +793,30 @@ declare namespace sap {
            */
           showOnHome(): this;
         }
+        /**
+         * The UserSettingsEntry defines an entry in the user settings dialog. To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
+         *
+         * **Restriction:** Does not work when called from within an iframe. The calling function has to be in
+         * the 'same frame' as the launchpad itself.
+         *
+         * @since 1.134.0
+         */
+        class UserSettingsEntry {
+          /**
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           */
+          protected constructor();
+
+          /**
+           * Opens the user settings entry.
+           *
+           * The dialog is opened and then navigated to the new entry. If a group is available, the function navigates
+           * to the group and entry (tab).
+           *
+           * @since 1.134.0
+           */
+          open(): void;
+        }
       }
 
       namespace Navigation {
@@ -4687,7 +4715,7 @@ declare namespace sap {
          *
          * @since 1.124.0
          *
-         * @returns Resolves once the settings entry was added.
+         * @returns Resolves with the new entry once the settings entry was added.
          */
         addUserSettingsEntry(
           /**
@@ -4704,7 +4732,7 @@ declare namespace sap {
              */
             title: string;
             /**
-             * A string to be presented as the sub title of the entry OR a function which resolves the sub title.
+             * A string to be presented as the subtitle of the entry OR a function which resolves the sub title.
              */
             value: string | (() => Promise<string>);
             /**
@@ -4727,7 +4755,7 @@ declare namespace sap {
              */
             provideEmptyWrapper?: boolean;
           }
-        ): Promise<any>;
+        ): Promise<sap.ushell.services.FrameBoundExtension.UserSettingsEntry>;
         /**
          * Creates a new footer which is positioned below the launchpad content.
          *
@@ -13791,6 +13819,8 @@ declare namespace sap {
 
     "sap/ushell/api/S4MyHome": undefined;
 
+    "sap/ushell/api/SAPBusinessClient": undefined;
+
     "sap/ushell/api/workpage/Designtime": undefined;
 
     "sap/ushell/api/workpage/Runtime": undefined;
@@ -13855,6 +13885,8 @@ declare namespace sap {
 
     "sap/ushell/services/FrameBoundExtension/ToolArea": undefined;
 
+    "sap/ushell/services/FrameBoundExtension/UserSettingsEntry": undefined;
+
     "sap/ushell/services/LaunchPage": undefined;
 
     "sap/ushell/services/Message": undefined;

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   /**
@@ -1139,6 +1139,9 @@ declare namespace sap {
 
       /**
        * The list of Subsections.
+       *
+       * Note: If multiple subsections are used, it is highly recommended to set a title for the section for accessibility
+       * reasons.
        */
       subSections?:
         | sap.uxap.ObjectPageSubSection[]
@@ -7095,6 +7098,9 @@ declare namespace sap {
        * Gets content of aggregation {@link #getSubSections subSections}.
        *
        * The list of Subsections.
+       *
+       * Note: If multiple subsections are used, it is highly recommended to set a title for the section for accessibility
+       * reasons.
        */
       getSubSections(): sap.uxap.ObjectPageSubSection[];
       /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   /**

package/types/sap.webanalytics.core.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {}

package/types/sap.zen.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace zen {

package/types/sap.zen.crosstab.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace zen {

package/types/sap.zen.dsh.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace zen {