@openui5/ts-types 1.120.10 → 1.121.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.120.10",
+  "version": "1.121.1",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.10
+// For Library Version: 1.121.1
 
 declare namespace sap {
   /**
@@ -649,6 +649,30 @@ declare namespace sap {
            */
           vBannerLine: int | string | sap.m.Text
         ): sap.m.Text | null;
+        /**
+         * Sets a new value for property {@link #getDataTimestamp dataTimestamp}.
+         *
+         * Defines the timestamp of the oldest data in the card. Use this to show to the end user how fresh the
+         * information in the card is.
+         *
+         * Must be specified in ISO 8601 format.
+         *
+         * Will be shown as a relative time like "5 minutes ago".
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `empty string`.
+         *
+         * @experimental (since 1.89) - this feature is experimental and the API may change.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setDataTimestamp(
+          /**
+           * New value for property `dataTimestamp`
+           */
+          sDataTimestamp?: string
+        ): this;
         /**
          * Sets a new value for property {@link #getStatusVisible statusVisible}.
          *
@@ -2347,6 +2371,8 @@ declare namespace sap {
       /**
        * Different options for the position of the header in controls that implement the {@link sap.f.ICard} interface.
        *
+       * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'cards.HeaderPosition'.
+       *
        * @since 1.65
        */
       enum HeaderPosition {
@@ -2362,6 +2388,8 @@ declare namespace sap {
       /**
        * Different options for the alignment of the side indicators in the numeric header.
        *
+       * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'cards.NumericHeaderSideIndicatorsAlignment'.
+       *
        * @since 1.96
        */
       enum NumericHeaderSideIndicatorsAlignment {
@@ -8514,9 +8542,10 @@ declare namespace sap {
        * displayed at once.
        *
        *  The interactions that may lead to a state change are:
-       * 	 - the property `layout` was changed indirectly by the user clicking a layout arrow
-       * 	 - the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that
-       *     can be displayed at once.
+       * 	 - The property `layout` was changed indirectly by the user dragging the column separator or clicking
+       *     on its arrow (where arrow is available).
+       * 	 - The user resized the browser window beyond a breakpoint, thus changing the maximum number of columns
+       *     that can be displayed at once.
        *
        *  **Note: **The event is suppressed while the control has zero width and will be fired the first time
        * it gets a non-zero width
@@ -9744,12 +9773,14 @@ declare namespace sap {
       maxColumnsCount?: int;
 
       /**
-       * Indicates whether the layout changed as a result of the user clicking a layout arrow
+       * Indicates whether the layout changed as a result of the user clicking a column separator's arrow or dragging
+       * the column separators
        */
       isNavigationArrow?: boolean;
 
       /**
-       * Indicates whether the maximum number of columns that can be displayed at once changed
+       * Indicates whether the maximum number of columns that can be displayed at once changed due to resize of
+       * the entire browser window
        */
       isResize?: boolean;
     }
@@ -9857,6 +9888,11 @@ declare namespace sap {
        * Reference to the button that has been pressed
        */
       image?: sap.m.Image;
+
+      /**
+       * Reference to the button that has been pressed
+       */
+      button?: sap.m.Button;
     }
 
     interface ShellBar$HomeIconPressedEventParameters {
@@ -10059,8 +10095,6 @@ declare namespace sap {
      * 	 - You want to use it for other visual content than avatars.
      *
      * @since 1.73
-     * @experimental (since 1.73) - This class is experimental and provides only limited functionality. Also
-     * the API might be changed in future.
      */
     class AvatarGroup extends sap.ui.core.Control {
       /**
@@ -11295,7 +11329,7 @@ declare namespace sap {
        *
        * @since 1.65
        */
-      getStickySubheaderProvider(): sap.ui.core.ID;
+      getStickySubheaderProvider(): sap.ui.core.ID | null;
       /**
        * Gets content of aggregation {@link #getTitle title}.
        *
@@ -13074,7 +13108,11 @@ declare namespace sap {
      * The width of the three columns is variable.
      *
      * There are several possible layouts that can be changed either with the control's API, or by the user
-     * with the help of layout arrows.
+     * with the help of the draggable column separators. The draggable column separators allow the user to customize
+     * the column widths for the current layout, or to switch to a new layout (if the user drags the column
+     * separator past a breakpoint that delimits two different layouts). After the user customized the column
+     * widths for a given layout, these user preferences are internally saved and automatically re-applied whenever
+     * the user re-visits the same layout.
      *
      * Internally the control makes use of three instances of {@link sap.m.NavContainer}, thus forming the three
      * columns.
@@ -13604,9 +13642,10 @@ declare namespace sap {
        * displayed at once.
        *
        *  The interactions that may lead to a state change are:
-       * 	 - the property `layout` was changed indirectly by the user clicking a layout arrow
-       * 	 - the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that
-       *     can be displayed at once.
+       * 	 - The property `layout` was changed indirectly by the user dragging the column separator or clicking
+       *     on its arrow (where arrow is available).
+       * 	 - The user resized the browser window beyond a breakpoint, thus changing the maximum number of columns
+       *     that can be displayed at once.
        *
        *  **Note: **The event is suppressed while the control has zero width and will be fired the first time
        * it gets a non-zero width
@@ -13639,9 +13678,10 @@ declare namespace sap {
        * displayed at once.
        *
        *  The interactions that may lead to a state change are:
-       * 	 - the property `layout` was changed indirectly by the user clicking a layout arrow
-       * 	 - the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that
-       *     can be displayed at once.
+       * 	 - The property `layout` was changed indirectly by the user dragging the column separator or clicking
+       *     on its arrow (where arrow is available).
+       * 	 - The user resized the browser window beyond a breakpoint, thus changing the maximum number of columns
+       *     that can be displayed at once.
        *
        *  **Note: **The event is suppressed while the control has zero width and will be fired the first time
        * it gets a non-zero width
@@ -14225,17 +14265,17 @@ declare namespace sap {
        * ID of the element which is the current target of the association {@link #getInitialBeginColumnPage initialBeginColumnPage},
        * or `null`.
        */
-      getInitialBeginColumnPage(): sap.ui.core.ID;
+      getInitialBeginColumnPage(): sap.ui.core.ID | null;
       /**
        * ID of the element which is the current target of the association {@link #getInitialEndColumnPage initialEndColumnPage},
        * or `null`.
        */
-      getInitialEndColumnPage(): sap.ui.core.ID;
+      getInitialEndColumnPage(): sap.ui.core.ID | null;
       /**
        * ID of the element which is the current target of the association {@link #getInitialMidColumnPage initialMidColumnPage},
        * or `null`.
        */
-      getInitialMidColumnPage(): sap.ui.core.ID;
+      getInitialMidColumnPage(): sap.ui.core.ID | null;
       /**
        * Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
        *
@@ -16204,7 +16244,7 @@ declare namespace sap {
         /**
          * The item to remove or its index or ID.
          */
-        vItem: int | string | sap.ui.core.Control
+        vItem: int | sap.ui.core.ID | sap.ui.core.Control
       ): sap.ui.core.Control | null;
       /**
        * Sets a new value for property {@link #getAllowDenseFill allowDenseFill}.
@@ -17643,7 +17683,7 @@ declare namespace sap {
        * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
        * or `null`.
        */
-      getSelectedItem(): sap.ui.core.ID;
+      getSelectedItem(): sap.ui.core.ID | null;
       /**
        * Checks for the provided `sap.f.ProductSwitchItem` in the aggregation {@link #getItems items}. and returns
        * its index if found or -1 otherwise.
@@ -17708,7 +17748,7 @@ declare namespace sap {
          * the item with this ID becomes the `selectedItem` association. Alternatively, a `sap.f.ProductSwitchItem`
          * instance may be given or `null` to clear the selection.
          */
-        vItem: string | sap.f.ProductSwitchItem | null
+        vItem: sap.ui.core.ID | sap.f.ProductSwitchItem | null
       ): this;
     }
     /**
@@ -19568,6 +19608,25 @@ declare namespace sap {
          */
         oMenu: sap.m.Menu
       ): this;
+      /**
+       * Sets a new value for property {@link #getNotificationsNumber notificationsNumber}.
+       *
+       * Defines the displayed number of upcoming notifications.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `empty string`.
+       *
+       * @since 1.64
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setNotificationsNumber(
+        /**
+         * New value for property `notificationsNumber`
+         */
+        sNotificationsNumber?: string
+      ): this;
       /**
        * Sets the aggregated {@link #getProfile profile}.
        *
@@ -20056,7 +20115,7 @@ declare namespace sap {
        * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
        * or `null`.
        */
-      getSelectedItem(): sap.ui.core.ID;
+      getSelectedItem(): sap.ui.core.ID | null;
       /**
        * Gets current value of property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
        *
@@ -20591,6 +20650,8 @@ declare namespace sap {
     /**
      * Group modes for the {@link sap.f.AvatarGroup} control.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'AvatarGroupType'.
+     *
      * @since 1.73
      * @experimental (since 1.73)
      */
@@ -20608,6 +20669,8 @@ declare namespace sap {
     /**
      * Defines the areas within the `sap.f.DynamicPageTitle` control.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'DynamicPageTitleArea'.
+     *
      * @since 1.50
      * @deprecated (since 1.54) - Consumers of the {@link sap.f.DynamicPageTitle} control should now use the
      * `areaShrinkRatio` property instead of the `primaryArea` property.
@@ -20627,19 +20690,25 @@ declare namespace sap {
      * Layouts, representing the number of columns to be displayed and their relative widths for a {@link sap.f.FlexibleColumnLayout }
      * control.
      *
-     * Each layout has a predefined ratio for the three columns, depending on device size. Based on the device
-     * and layout, some columns are hidden. For more information, refer to the ratios (in %) for each value,
-     * listed below: (dash "-" means non-accessible columns).
+     * Each layout has a default predefined ratio for the three columns, depending on device size. Based on
+     * the device and layout, some columns are hidden. For more information, refer to the ratios (in %) for
+     * each value, listed below: (dash "-" means non-accessible columns).
      *
-     * **Note:** Please note that on a phone device, due to the limited screen size, only one column can be
-     * displayed at a time. For all two-column layouts, this column is the `Mid` column, and for all three-column
-     * layouts - the `End` column, even though the respective column may be hidden on desktop and tablet for
-     * that particular layout. Therefore some of the names (such as `ThreeColumnsMidExpandedEndHidden` for example)
-     * are representative of the desktop scenario only.
+     * **Notes:**
+     * 	 - The user is allowed to customize the default ratio by dragging the column separators to resize the
+     *     columns. The user preferences are then internally saved (in browser localStorage) and automatically re-applied
+     *     whenever the user re-visits the same layout.
+     * 	 - Please note that on a phone device, due to the limited screen size, only one column can be displayed
+     *     at a time. For all two-column layouts, this column is the `Mid` column, and for all three-column layouts
+     *     - the `End` column, even though the respective column may be hidden on desktop and tablet for that particular
+     *     layout. Therefore some of the names (such as `ThreeColumnsMidExpandedEndHidden` for example) are representative
+     *     of the desktop scenario only.
      *
      * For more information, see {@link https://ui5.sap.com/#/topic/3b9f760da5b64adf8db7f95247879086 Types of Layout }
      * in the documentation.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'LayoutType'.
+     *
      * @since 1.46
      */
     enum LayoutType {
@@ -20674,20 +20743,23 @@ declare namespace sap {
        */
       OneColumn = "OneColumn",
       /**
-       * Desktop: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
+       * Desktop: default ratio is 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by
+       * dragging the column separators
        *
-       * Tablet: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
+       * Tablet: default ratio is 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by
+       * dragging the column separators
        *
        * Phone: -/-/100 only the End column is displayed
        *
        * Use to display the master and detail pages when the user should focus on the master. The detail-detail
-       * is still loaded and easily accessible with layout arrows.
+       * is still loaded and easily accessible by dragging the column separators.
        */
       ThreeColumnsBeginExpandedEndHidden = "ThreeColumnsBeginExpandedEndHidden",
       /**
-       * Desktop: 25/25/50 Begin, Mid and End (expanded) columns are displayed
+       * Desktop: default ratio is 25/25/50 Begin, Mid and End (expanded) columns are displayed
        *
-       * Tablet: 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by layout arrows
+       * Tablet: default ratio is 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by
+       * dragging the column separator to expand the column
        *
        * Phone: -/-/100 (only the End column is displayed)
        *
@@ -20695,9 +20767,10 @@ declare namespace sap {
        */
       ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",
       /**
-       * Desktop: 25/50/25 Begin, Mid (expanded) and End columns are displayed
+       * Desktop: default ratio is 25/50/25 Begin, Mid (expanded) and End columns are displayed
        *
-       * Tablet: 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by a layout arrow
+       * Tablet: default ratio is 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by
+       * dragging its adjacent column separator to expand the column.
        *
        * Phone: -/-/100 only the End column is displayed
        *
@@ -20705,20 +20778,22 @@ declare namespace sap {
        */
       ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",
       /**
-       * Desktop: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
+       * Desktop: default ratio is 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by
+       * dragging the column-separator to expand the column.
        *
-       * Tablet: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
+       * Tablet: default ratio is 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by
+       * dragging the column-separator to expand the column.
        *
        * Phone: -/-/100 only the End column is displayed
        *
        * Use to display the master and detail pages when the user should focus on the detail. The detail-detail
-       * is still loaded and easily accessible with a layout arrow.
+       * is still loaded and easily accessible upon dragging the column-separator to expand the column.
        */
       ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",
       /**
-       * Desktop: 67/33/- Begin (expanded) and Mid columns are displayed
+       * Desktop: default ratio is 67/33/- Begin (expanded) and Mid columns are displayed
        *
-       * Tablet: 67/33/- Begin (expanded) and Mid columns are displayed
+       * Tablet: default ratio is 67/33/- Begin (expanded) and Mid columns are displayed
        *
        * Phone: -/100/- only the Mid column is displayed
        *
@@ -20726,9 +20801,9 @@ declare namespace sap {
        */
       TwoColumnsBeginExpanded = "TwoColumnsBeginExpanded",
       /**
-       * Desktop: 33/67/- Begin and Mid (expanded) columns are displayed
+       * Desktop: default ratio is 33/67/- Begin and Mid (expanded) columns are displayed
        *
-       * Tablet: 33/67/- Begin and Mid (expanded) columns are displayed
+       * Tablet: default ratio is 33/67/- Begin and Mid (expanded) columns are displayed
        *
        * Phone: -/100/- only the Mid column is displayed
        *
@@ -20739,6 +20814,8 @@ declare namespace sap {
     /**
      * Enumeration for different navigation directions.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'NavigationDirection'.
+     *
      * @since 1.85
      */
     enum NavigationDirection {
@@ -20762,6 +20839,8 @@ declare namespace sap {
     /**
      * Enumeration for different SidePanel position.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'SidePanelPosition'.
+     *
      * @since 1.104
      */
     enum SidePanelPosition {