@sapui5/ts-types 1.123.2 → 1.124.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.123.2",
+  "version": "1.124.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -17,10 +17,10 @@
 /// <reference path="./sap.zen.dsh.d.ts"/>
 /// <reference path="./sap.zen.commons.d.ts"/>
 /// <reference path="./sap.sac.df.d.ts"/>
-/// <reference path="./commons-1.123.0-d.ts"/>
+/// <reference path="./sap.ui.commons.d.ts"/>
 /// <reference path="./sap.ui.comp.d.ts"/>
-/// <reference path="./core-1.123.0-d.ts"/>
-/// <reference path="./dt-1.123.0-d.ts"/>
+/// <reference path="./sap.ui.core.d.ts"/>
+/// <reference path="./sap.ui.dt.d.ts"/>
 /// <reference path="./sap.ui.export.d.ts"/>
 /// <reference path="./sap.f.d.ts"/>
 /// <reference path="./sap.ui.fl.d.ts"/>
@@ -32,8 +32,8 @@
 /// <reference path="./sap.ui.integration.d.ts"/>
 /// <reference path="./sap.ui.layout.d.ts"/>
 /// <reference path="./sap.makit.d.ts"/>
-/// <reference path="./mdc-1.123.0-d.ts"/>
-/// <reference path="./mobile-1.123.0-d.ts"/>
+/// <reference path="./sap.ui.mdc.d.ts"/>
+/// <reference path="./sap.m.d.ts"/>
 /// <reference path="./sap.me.d.ts"/>
 /// <reference path="./sap.ndc.d.ts"/>
 /// <reference path="./sap.ovp.d.ts"/>
@@ -60,12 +60,12 @@
 /// <reference path="./sap.ui.support.d.ts"/>
 /// <reference path="./sap.ui.table.d.ts"/>
 /// <reference path="./sap.ui.testrecorder.d.ts"/>
-/// <reference path="./tnt-1.123.0-d.ts"/>
+/// <reference path="./sap.tnt.d.ts"/>
 /// <reference path="./sap.ca.ui.d.ts"/>
 /// <reference path="./sap.ui.unified.d.ts"/>
 /// <reference path="./sap.ushell.d.ts"/>
 /// <reference path="./sap.ushell_abap.d.ts"/>
-/// <reference path="./ux3-1.123.0-d.ts"/>
+/// <reference path="./sap.ui.ux3.d.ts"/>
 /// <reference path="./sap.uxap.d.ts"/>
 /// <reference path="./sap.ui.vbm.d.ts"/>
 /// <reference path="./sap.viz.d.ts"/>

package/types/sap.apf.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   namespace ca {

package/types/sap.chart.d.ts

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

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**
@@ -36,7 +36,8 @@ declare namespace sap {
          */
         class Component
           extends sap.ui.core.UIComponent
-          implements sap.ui.core.IAsyncContentCreation {
+          implements sap.ui.core.IAsyncContentCreation
+        {
           __implements__sap_ui_core_IAsyncContentCreation: boolean;
           /**
            * Constructor for the Feed Component.
@@ -721,7 +722,8 @@ declare namespace sap {
            */
           class Component
             extends sap.ui.core.UIComponent
-            implements sap.ui.core.IAsyncContentCreation {
+            implements sap.ui.core.IAsyncContentCreation
+          {
             __implements__sap_ui_core_IAsyncContentCreation: boolean;
             /**
              * Constructor for the Feed Component.

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.0
+// For Library Version: 1.124.0
 
 declare namespace sap {
   namespace esh {
@@ -88,6 +88,8 @@ declare namespace sap {
            * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
            * of `resultViewTypes` and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * @since 1.98.0
            */
           resultViewTypes?:
@@ -105,6 +107,8 @@ declare namespace sap {
            * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
            * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * @since 1.98.0
            */
           resultViewType?:
@@ -119,6 +123,8 @@ declare namespace sap {
            * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
            * and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * @since 1.100.0
            */
           resultViewSettings?:
@@ -467,8 +473,20 @@ declare namespace sap {
            * @since 1.121
            */
           selectionChanged?: (oEvent: sap.ui.base.Event) => void;
+
+          /**
+           * Event is fired after result view type got changed (list, table or grid).
+           *
+           * @since 1.124
+           */
+          resultViewTypeChanged?: (oEvent: sap.ui.base.Event) => void;
         }
 
+        /**
+         * Parameters of the SearchCompositeControl#resultViewTypeChanged event.
+         */
+        interface SearchCompositeControl$ResultViewTypeChangedEventParameters {}
+
         /**
          * Parameters of the SearchCompositeControl#searchFinished event.
          */
@@ -569,6 +587,59 @@ declare namespace sap {
              */
             oContent: sap.ui.core.Control
           ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
+           * event of this `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * 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.esh.search.ui.SearchCompositeControl` itself.
+           *
+           * Event is fired after result view type got changed (list, table or grid).
+           *
+           * @since 1.124
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          attachResultViewTypeChanged(
+            /**
+             * 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: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+             * itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
+           * event of this `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * 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.esh.search.ui.SearchCompositeControl` itself.
+           *
+           * Event is fired after result view type got changed (list, table or grid).
+           *
+           * @since 1.124
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          attachResultViewTypeChanged(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+             * itself
+             */
+            oListener?: object
+          ): this;
           /**
            * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
            * `sap.esh.search.ui.SearchCompositeControl`.
@@ -733,6 +804,26 @@ declare namespace sap {
            * @returns Reference to `this` in order to allow method chaining
            */
           destroyContent(): this;
+          /**
+           * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
+           * event of this `sap.esh.search.ui.SearchCompositeControl`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           *
+           * @since 1.124
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          detachResultViewTypeChanged(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
           /**
            * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
            * `sap.esh.search.ui.SearchCompositeControl`.
@@ -793,6 +884,20 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
+           *
+           * @since 1.124
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          fireResultViewTypeChanged(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
           /**
            * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
            *
@@ -1204,6 +1309,8 @@ declare namespace sap {
            * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
            * and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * Default value is `...see text or source`.
            *
            * @since 1.100.0
@@ -1223,6 +1330,8 @@ declare namespace sap {
            * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
            * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * Default value is `"searchResultList"`.
            *
            * @since 1.98.0
@@ -1241,6 +1350,8 @@ declare namespace sap {
            * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
            * of `resultViewTypes` and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * Default value is `["searchResultList", "searchResultTable"]`.
            *
            * @since 1.98.0
@@ -1940,6 +2051,8 @@ declare namespace sap {
            * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
            * and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * 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`.
@@ -1966,6 +2079,8 @@ declare namespace sap {
            * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
            * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * Default value is `"searchResultList"`.
@@ -1991,6 +2106,8 @@ declare namespace sap {
            * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
            * of `resultViewTypes` and `resultViewType` must be compatible to each other.
            *
+           * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
+           *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * Default value is `["searchResultList", "searchResultTable"]`.
@@ -2118,6 +2235,15 @@ declare namespace sap {
           ): this;
         }
 
+        /**
+         * Event object of the SearchCompositeControl#resultViewTypeChanged event.
+         */
+        type SearchCompositeControl$ResultViewTypeChangedEvent =
+          sap.ui.base.Event<
+            SearchCompositeControl$ResultViewTypeChangedEventParameters,
+            SearchCompositeControl
+          >;
+
         /**
          * Event object of the SearchCompositeControl#searchFinished event.
          */

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.1
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**
@@ -439,6 +439,13 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.AggregationBindingInfo
           | `{${string}}`;
 
+        /**
+         * Micro Chart
+         *
+         * @experimental (since 1.124)
+         */
+        microChart?: sap.ui.core.Control;
+
         /**
          * Fires when the user presses the control.
          */
@@ -850,7 +857,8 @@ declare namespace sap {
        */
       class Header
         extends sap.f.cards.BaseHeader
-        implements sap.f.cards.IHeader {
+        implements sap.f.cards.IHeader
+      {
         __implements__sap_f_cards_IHeader: boolean;
         /**
          * Constructor for a new `Header`.
@@ -1395,7 +1403,8 @@ declare namespace sap {
        */
       class NumericHeader
         extends sap.f.cards.BaseHeader
-        implements sap.f.cards.IHeader {
+        implements sap.f.cards.IHeader
+      {
         __implements__sap_f_cards_IHeader: boolean;
         /**
          * Constructor for a new `NumericHeader`.
@@ -1518,6 +1527,14 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
+        /**
+         * Destroys the microChart in the aggregation {@link #getMicroChart microChart}.
+         *
+         * @experimental (since 1.124)
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        destroyMicroChart(): this;
         /**
          * Destroys all the sideIndicators in the aggregation {@link #getSideIndicators sideIndicators}.
          *
@@ -1700,6 +1717,14 @@ declare namespace sap {
          * @returns Value of property `iconVisible`
          */
         getIconVisible(): boolean;
+        /**
+         * Gets content of aggregation {@link #getMicroChart microChart}.
+         *
+         * Micro Chart
+         *
+         * @experimental (since 1.124)
+         */
+        getMicroChart(): sap.ui.core.Control;
         /**
          * Gets current value of property {@link #getNumber number}.
          *
@@ -2094,6 +2119,19 @@ declare namespace sap {
            */
           bIconVisible?: boolean
         ): this;
+        /**
+         * Sets the aggregated {@link #getMicroChart microChart}.
+         *
+         * @experimental (since 1.124)
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setMicroChart(
+          /**
+           * The microChart to set
+           */
+          oMicroChart: sap.ui.core.Control
+        ): this;
         /**
          * Sets a new value for property {@link #getNumber number}.
          *
@@ -2605,7 +2643,8 @@ declare namespace sap {
        */
       class GridDropInfo
         extends sap.ui.core.dnd.DropInfo
-        implements sap.ui.core.dnd.IDropInfo {
+        implements sap.ui.core.dnd.IDropInfo
+      {
         __implements__sap_ui_core_dnd_IDropInfo: boolean;
         /**
          * Constructor for a new GridDropInfo.
@@ -2687,9 +2726,7 @@ declare namespace sap {
          * @returns Value of property `dropIndicatorSize`
          */
         getDropIndicatorSize():
-          | ((
-              p1: sap.ui.core.Control
-            ) => {
+          | ((p1: sap.ui.core.Control) => {
               rows: int;
 
               columns: int;
@@ -2718,9 +2755,7 @@ declare namespace sap {
           /**
            * New value for property `dropIndicatorSize`
            */
-          fnDropIndicatorSize?: (
-            p1: sap.ui.core.Control
-          ) => {
+          fnDropIndicatorSize?: (p1: sap.ui.core.Control) => {
             rows: int;
 
             columns: int;
@@ -11160,7 +11195,8 @@ declare namespace sap {
      */
     class CardBase
       extends sap.ui.core.Control
-      implements sap.f.ICard, sap.m.IBadge {
+      implements sap.f.ICard, sap.m.IBadge
+    {
       __implements__sap_f_ICard: boolean;
       __implements__sap_m_IBadge: boolean;
       /**
@@ -13514,7 +13550,8 @@ declare namespace sap {
      */
     class FlexibleColumnLayout
       extends sap.ui.core.Control
-      implements sap.ui.core.IPlaceholderSupport {
+      implements sap.ui.core.IPlaceholderSupport
+    {
       __implements__sap_ui_core_IPlaceholderSupport: boolean;
       /**
        * Constructor for a new `sap.f.FlexibleColumnLayout`.
@@ -15935,7 +15972,8 @@ declare namespace sap {
      */
     class GridContainer
       extends sap.ui.core.Control
-      implements sap.f.dnd.IGridDroppable {
+      implements sap.f.dnd.IGridDroppable
+    {
       __implements__sap_f_dnd_IGridDroppable: boolean;
       /**
        * Constructor for a new `sap.f.GridContainer`.
@@ -17282,7 +17320,8 @@ declare namespace sap {
       extends sap.m.ListBase
       implements
         sap.ui.layout.cssgrid.IGridConfigurable,
-        sap.f.dnd.IGridDroppable {
+        sap.f.dnd.IGridDroppable
+    {
       __implements__sap_ui_layout_cssgrid_IGridConfigurable: boolean;
       __implements__sap_f_dnd_IGridDroppable: boolean;
       /**
@@ -18882,7 +18921,8 @@ declare namespace sap {
      */
     class ShellBar
       extends sap.ui.core.Control
-      implements sap.f.IShellBar, sap.m.IBar, sap.tnt.IToolHeader {
+      implements sap.f.IShellBar, sap.m.IBar, sap.tnt.IToolHeader
+    {
       __implements__sap_f_IShellBar: boolean;
       __implements__sap_m_IBar: boolean;
       __implements__sap_tnt_IToolHeader: boolean;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.123.1
+// For Library Version: 1.124.0
 
 declare namespace sap {
   /**
@@ -1030,7 +1030,7 @@ declare namespace sap {
             /**
              * Extensible array of promises to be resolved before continuing
              */
-            aPromises: Promise<any>,
+            aPromises: any,
             /**
              * Navigation type responsible for the applying the state
              */
@@ -1103,7 +1103,8 @@ declare namespace sap {
          * @experimental (since 1.92.0)
          */
         class Component
-          /* was: sap.fe.core.TemplateComponent */ extends Object {
+          extends /* was: sap.fe.core.TemplateComponent */ Object
+        {
           /**
            * Returns the current AppComponent.
            *
@@ -1144,7 +1145,7 @@ declare namespace sap {
          * @since 1.110.0
          */
         class Fcl
-          /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {}
+          extends /* was: sap.fe.core.rootView.RootViewBaseController */ Object {}
         /**
          * Base controller class for your own root view with a sap.m.NavContainer control.
          * By using or extending this controller you can use your own root view with the sap.fe.core.AppComponent
@@ -1155,7 +1156,7 @@ declare namespace sap {
          * @since 1.108.0
          */
         class NavContainer
-          /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {}
+          extends /* was: sap.fe.core.rootView.RootViewBaseController */ Object {}
       }
       /**
        * Describes the settings that can be provided to the AppComponent constructor.
@@ -1176,7 +1177,12 @@ declare namespace sap {
        *
        *  - sap.fe.core.rootView.Fcl when using sap.f.routing.Router (FCL use case)
        */
-      class AppComponent extends sap.ui.core.UIComponent {
+      class AppComponent
+        extends sap.ui.core.UIComponent
+        implements sap.ui.core.IAsyncContentCreation
+      {
+        __implements__sap_ui_core_IAsyncContentCreation: boolean;
+
         /**
          * Changes the page configuration of SAP Fiori elements.
          * This method enables you to change the page configuration of SAP Fiori elements.