@openui5/ts-types-esm 1.98.0 → 1.101.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types-esm",
-  "version": "1.98.0",
+  "version": "1.101.0",
   "description": "OpenUI5 TypeScript Definitions - ES Modules",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",
@@ -13,5 +13,9 @@
     "openui5",
     "ui5",
     "typescript"
-  ]
+  ],
+  "dependencies": {
+    "@types/jquery": "3.5.13",
+    "@types/qunit": "2.5.4"
+  }
 }

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.101.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -1697,6 +1697,16 @@ declare module "sap/f/cards/Header" {
      * Default value is `empty string`.
      */
     getSubtitle(): string;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Gets current value of property {@link #getSubtitleMaxLines subtitleMaxLines}.
+     *
+     * Limits the number of lines for the subtitle.
+     *
+     * Default value is `2`.
+     */
+    getSubtitleMaxLines(): int;
     /**
      * Gets current value of property {@link #getTitle title}.
      *
@@ -1705,6 +1715,16 @@ declare module "sap/f/cards/Header" {
      * Default value is `empty string`.
      */
     getTitle(): string;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Gets current value of property {@link #getTitleMaxLines titleMaxLines}.
+     *
+     * Limits the number of lines for the title.
+     *
+     * Default value is `3`.
+     */
+    getTitleMaxLines(): int;
     /**
      * @EXPERIMENTAL (since 1.81)
      *
@@ -1814,6 +1834,23 @@ declare module "sap/f/cards/Header" {
        */
       sSubtitle?: string
     ): this;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Sets a new value for property {@link #getSubtitleMaxLines subtitleMaxLines}.
+     *
+     * Limits the number of lines for the subtitle.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `2`.
+     */
+    setSubtitleMaxLines(
+      /**
+       * New value for property `subtitleMaxLines`
+       */
+      iSubtitleMaxLines?: int
+    ): this;
     /**
      * Sets a new value for property {@link #getTitle title}.
      *
@@ -1829,6 +1866,23 @@ declare module "sap/f/cards/Header" {
        */
       sTitle?: string
     ): this;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Sets a new value for property {@link #getTitleMaxLines titleMaxLines}.
+     *
+     * Limits the number of lines for the title.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `3`.
+     */
+    setTitleMaxLines(
+      /**
+       * New value for property `titleMaxLines`
+       */
+      iTitleMaxLines?: int
+    ): this;
   }
 
   export interface $HeaderSettings extends $BaseHeaderSettings {
@@ -1837,11 +1891,25 @@ declare module "sap/f/cards/Header" {
      */
     title?: string | PropertyBindingInfo;
 
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Limits the number of lines for the title.
+     */
+    titleMaxLines?: int | PropertyBindingInfo;
+
     /**
      * Defines the subtitle.
      */
     subtitle?: string | PropertyBindingInfo;
 
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Limits the number of lines for the subtitle.
+     */
+    subtitleMaxLines?: int | PropertyBindingInfo;
+
     /**
      * Defines the status text.
      */
@@ -2066,6 +2134,16 @@ declare module "sap/f/cards/NumericHeader" {
      * Additional text which adds more details to what is shown in the numeric header.
      */
     getDetails(): string;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Gets current value of property {@link #getDetailsMaxLines detailsMaxLines}.
+     *
+     * Limits the number of lines for the details.
+     *
+     * Default value is `1`.
+     */
+    getDetailsMaxLines(): int;
     /**
      * Gets current value of property {@link #getNumber number}.
      *
@@ -2122,12 +2200,32 @@ declare module "sap/f/cards/NumericHeader" {
      * The subtitle of the card
      */
     getSubtitle(): string;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Gets current value of property {@link #getSubtitleMaxLines subtitleMaxLines}.
+     *
+     * Limits the number of lines for the subtitle.
+     *
+     * Default value is `2`.
+     */
+    getSubtitleMaxLines(): int;
     /**
      * Gets current value of property {@link #getTitle title}.
      *
      * The title of the card
      */
     getTitle(): string;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Gets current value of property {@link #getTitleMaxLines titleMaxLines}.
+     *
+     * Limits the number of lines for the title.
+     *
+     * Default value is `3`.
+     */
+    getTitleMaxLines(): int;
     /**
      * Gets current value of property {@link #getTrend trend}.
      *
@@ -2183,31 +2281,63 @@ declare module "sap/f/cards/NumericHeader" {
       vSideIndicator: int | string | NumericSideIndicator
     ): NumericSideIndicator;
     /**
-     * Sets additional text which adds more details to what is shown in the numeric header.
+     * Sets a new value for property {@link #getDetails details}.
+     *
+     * Additional text which adds more details to what is shown in the numeric header.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      */
     setDetails(
       /**
-       * The text of the details
+       * New value for property `details`
        */
-      sValue: string
+      sDetails: string
+    ): this;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Sets a new value for property {@link #getDetailsMaxLines detailsMaxLines}.
+     *
+     * Limits the number of lines for the details.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `1`.
+     */
+    setDetailsMaxLines(
+      /**
+       * New value for property `detailsMaxLines`
+       */
+      iDetailsMaxLines?: int
     ): this;
     /**
-     * Sets the value of the main number indicator.
+     * Sets a new value for property {@link #getNumber number}.
+     *
+     * The numeric value of the main number indicator. If the value contains more than five characters, only
+     * the first five are displayed. Without rounding the number.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      */
     setNumber(
       /**
-       * A string representation of the number
+       * New value for property `number`
        */
-      sValue: string
+      sNumber: string
     ): this;
     /**
-     * Sets the unit of measurement (scaling prefix) for the main indicator.
+     * Sets a new value for property {@link #getScale scale}.
+     *
+     * Defines the unit of measurement (scaling prefix) for the main indicator. Financial characters can be
+     * used for currencies and counters. The International System of Units (SI) prefixes can be used. If the
+     * unit contains more than three characters, only the first three characters are displayed.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      */
     setScale(
       /**
-       * The text of the title
+       * New value for property `scale`
        */
-      sValue: string
+      sScale: string
     ): this;
     /**
      * Sets a new value for property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
@@ -2227,13 +2357,21 @@ declare module "sap/f/cards/NumericHeader" {
         | keyof typeof cards.NumericHeaderSideIndicatorsAlignment
     ): this;
     /**
-     * Sets the semantic color which represents the state of the main number indicator.
+     * @EXPERIMENTAL (since 1.64)
+     *
+     * Sets a new value for property {@link #getState state}.
+     *
+     * The semantic color which represents the state of the main number indicator.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"Neutral"`.
      */
     setState(
       /**
-       * The semantic color which represents the state
+       * New value for property `state`
        */
-      sValue: ValueColor | keyof typeof ValueColor
+      sState?: ValueColor | keyof typeof ValueColor
     ): this;
     /**
      * Sets a new value for property {@link #getStatusText statusText}.
@@ -2251,40 +2389,92 @@ declare module "sap/f/cards/NumericHeader" {
       sStatusText?: string
     ): this;
     /**
-     * Sets the subtitle.
+     * Sets a new value for property {@link #getSubtitle subtitle}.
+     *
+     * The subtitle of the card
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      */
     setSubtitle(
       /**
-       * The text of the subtitle
+       * New value for property `subtitle`
        */
-      sValue: string
+      sSubtitle: string
     ): this;
     /**
-     * Sets the title.
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Sets a new value for property {@link #getSubtitleMaxLines subtitleMaxLines}.
+     *
+     * Limits the number of lines for the subtitle.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `2`.
+     */
+    setSubtitleMaxLines(
+      /**
+       * New value for property `subtitleMaxLines`
+       */
+      iSubtitleMaxLines?: int
+    ): this;
+    /**
+     * Sets a new value for property {@link #getTitle title}.
+     *
+     * The title of the card
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      */
     setTitle(
       /**
-       * The text of the title
+       * New value for property `title`
        */
-      sValue: string
+      sTitle: string
+    ): this;
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Sets a new value for property {@link #getTitleMaxLines titleMaxLines}.
+     *
+     * Limits the number of lines for the title.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `3`.
+     */
+    setTitleMaxLines(
+      /**
+       * New value for property `titleMaxLines`
+       */
+      iTitleMaxLines?: int
     ): this;
     /**
-     * Sets the direction of the trend arrow.
+     * Sets a new value for property {@link #getTrend trend}.
+     *
+     * The direction of the trend arrow. Shows deviation for the value of the main number indicator.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"None"`.
      */
     setTrend(
       /**
-       * The direction of the trend arrow
+       * New value for property `trend`
        */
-      sValue: DeviationIndicator | keyof typeof DeviationIndicator
+      sTrend?: DeviationIndicator | keyof typeof DeviationIndicator
     ): this;
     /**
-     * Sets the general unit of measurement for the header. Displayed as side information to the subtitle.
+     * Sets a new value for property {@link #getUnitOfMeasurement unitOfMeasurement}.
+     *
+     * General unit of measurement for the header. Displayed as side information to the subtitle.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      */
     setUnitOfMeasurement(
       /**
-       * The value of the unit of measurement
+       * New value for property `unitOfMeasurement`
        */
-      sValue: string
+      sUnitOfMeasurement: string
     ): this;
   }
 
@@ -2294,11 +2484,25 @@ declare module "sap/f/cards/NumericHeader" {
      */
     title?: string | PropertyBindingInfo;
 
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Limits the number of lines for the title.
+     */
+    titleMaxLines?: int | PropertyBindingInfo;
+
     /**
      * The subtitle of the card
      */
     subtitle?: string | PropertyBindingInfo;
 
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Limits the number of lines for the subtitle.
+     */
+    subtitleMaxLines?: int | PropertyBindingInfo;
+
     /**
      * Defines the status text.
      */
@@ -2341,6 +2545,13 @@ declare module "sap/f/cards/NumericHeader" {
      */
     details?: string | PropertyBindingInfo;
 
+    /**
+     * @EXPERIMENTAL (since 1.101)
+     *
+     * Limits the number of lines for the details.
+     */
+    detailsMaxLines?: int | PropertyBindingInfo;
+
     /**
      * The alignment of the side indicators.
      */
@@ -7489,72 +7700,14 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
       oSettings?: object
     ): FlexibleColumnLayoutSemanticHelper;
     /**
-     * Returns an object, describing the current state of the control and the expected action buttons for each
+     * Returns an object describing the current state of the control and the expected action buttons for each
      * column.
      *
-     * The returned object has the following structure:
-     * 	 - layout - the value of the `layout` property
-     * 	 - maxColumnsCount - the maximum number of columns that can be displayed at once based on the control
-     * 			width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
-     * 	 - columnsSizes - an object with fields `beginColumn, midColumn, endColumn`, representing the relative
-     * 			percentage sizes of the three columns as integers
-     * 	 - columnsVisibility - an object with fields `beginColumn, midColumn, endColumn`, representing the visibility
-     * 			of the three columns
-     * 	 - isFullScreen - `true` if only one column is visible at the moment, `false` otherwise **Note:** This
-     * 			may be due to small screen size (phone) or due to a layout, for which a single column takes up the whole
-     * 			width
-     * 	 - isLogicallyFullScreen - `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn,
-     * 			sap.f.LayoutType.MidColumnFullScreen, sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise **Note:**
-     * 			While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
-     * 			will only be `true` for the layout values, listed above.
-     * 	 - actionButtonsInfo - an object with fields `midColumn, endColumn`, each containing an object, telling
-     * 			whether action buttons should be shown in the `mid` and `end` columns, and what value of the `layout`
-     * 			property should be set upon clicking these buttons. Each of these objects has the following fields: `closeColumn,
-     * 			fullScreen, exitFullScreen`. If `null`, then the respective action button should not be shown, otherwise
-     * 			provides the value of `layout` property for the action button.
-     *
      * **Note:** This method relies on the internal `FlexibleColumnLayout` reference to be rendered in the DOM
      * tree. For convenience, use methods {@link sap.f.FlexibleColumnLayoutSemanticHelper#isDOMReady} and {@link
      * sap.f.FlexibleColumnLayoutSemanticHelper#whenDOMReady}.
-     *
-     * Example value:
-     *
-     *
-     * ```javascript
-     *
-     *
-     *  {
-     * 	   "layout":"ThreeColumnsMidExpanded",
-     * 	   "maxColumnsCount":3,
-     * 	   "columnsSizes":{
-     * 		  "beginColumn":25,
-     * 		  "midColumn":50,
-     * 		  "endColumn":25
-     * 	   },
-     * 	   "columnsVisibility":{
-     * 		  "beginColumn":true,
-     * 		  "midColumn":true,
-     * 		  "endColumn":true
-     * 	   },
-     * 	   "isFullScreen":false,
-     * 	   "isLogicallyFullScreen":false,
-     * 	   "actionButtonsInfo":{
-     * 		  "midColumn":{
-     * 			 "fullScreen":null,
-     * 			 "exitFullScreen":null,
-     * 			 "closeColumn":null
-     * 		  },
-     * 		  "endColumn":{
-     * 			 "fullScreen":"EndColumnFullScreen",
-     * 			 "exitFullScreen":null,
-     * 			 "closeColumn":"TwoColumnsBeginExpanded"
-     * 		  }
-     * 	   }
-     * 	}
-     *
-     *  ```
-     */
-    getCurrentUIState(): object;
+     */
+    getCurrentUIState(): UIState;
     /**
      * Returns the default layout types for the different numbers of columns.
      *
@@ -7570,8 +7723,6 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
     /**
      * Returns an object, describing the state that the control will have after navigating to a different view
      * level.
-     *
-     * About the format of return value, see: {@link sap.f.FlexibleColumnLayoutSemanticHelper#getCurrentUIState}
      */
     getNextUIState(
       /**
@@ -7579,7 +7730,7 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
        * 3 and above - subsequent views
        */
       iNextLevel: int
-    ): object;
+    ): UIState;
     /**
      * @SINCE 1.72
      *
@@ -7608,6 +7759,155 @@ declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
      */
     whenReady(): Promise<any>;
   }
+  /**
+   * The configuration of the navigation actions in the columns.
+   */
+  export type ColumnsNavigationActions = {
+    /**
+     * Configuration of the navigation actions of the mid column.
+     */
+    midColumn?: NavigationActionsTargets;
+    /**
+     * Configuration of the navigation actions of the end column.
+     */
+    endColumn?: NavigationActionsTargets;
+  };
+
+  /**
+   * Represents the relative percentage sizes of all columns as integers.
+   */
+  export type ColumnsSizes = {
+    /**
+     * The relative percentage width of the begin column as integer.
+     */
+    beginColumn?: number;
+    /**
+     * The relative percentage width of the mid column as integer.
+     */
+    midColumn?: number;
+    /**
+     * The relative percentage width of the end column as integer.
+     */
+    endColumn?: number;
+  };
+
+  /**
+   * Represents the visibility of the columns.
+   */
+  export type ColumnsVisibility = {
+    /**
+     * The visibility of the begin column.
+     */
+    beginColumn?: boolean;
+    /**
+     * The visibility of the mid column.
+     */
+    midColumn?: boolean;
+    /**
+     * The visibility of the end column.
+     */
+    endColumn?: boolean;
+  };
+
+  /**
+   * Configures the target layouts of the navigation acion buttons in a column.
+   */
+  export type NavigationActionsTargets = {
+    /**
+     * The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `fullscreen` navigation action
+     * button is pressed. If null, then the respective action button should not be shown.
+     */
+    fullScreen?: string | null;
+    /**
+     * The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `exitFullScreen` navigation action
+     * button is pressed. If null, then the respective action button should not be shown.
+     */
+    exitFullScreen?: string | null;
+    /**
+     * The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `closeColumn` navigation action
+     * button is pressed. If null, then the respective action button should not be shown.
+     */
+    closeColumn?: string | null;
+  };
+
+  /**
+   * Configuration of the state of the `FlexibleColumnLayout` control and the expected action buttons for
+   * each column.
+   *
+   * Example value:
+   *
+   *
+   * ```javascript
+   *
+   *
+   *  {
+   * 	   "layout":"ThreeColumnsMidExpanded",
+   * 	   "maxColumnsCount":3,
+   * 	   "columnsSizes":{
+   * 		  "beginColumn":25,
+   * 		  "midColumn":50,
+   * 		  "endColumn":25
+   * 	   },
+   * 	   "columnsVisibility":{
+   * 		  "beginColumn":true,
+   * 		  "midColumn":true,
+   * 		  "endColumn":true
+   * 	   },
+   * 	   "isFullScreen":false,
+   * 	   "isLogicallyFullScreen":false,
+   * 	   "actionButtonsInfo":{
+   * 		  "midColumn":{
+   * 			 "fullScreen":null,
+   * 			 "exitFullScreen":null,
+   * 			 "closeColumn":null
+   * 		  },
+   * 		  "endColumn":{
+   * 			 "fullScreen":"EndColumnFullScreen",
+   * 			 "exitFullScreen":null,
+   * 			 "closeColumn":"TwoColumnsBeginExpanded"
+   * 		  }
+   * 	   }
+   * 	}
+   *
+   *  ```
+   */
+  export type UIState = {
+    /**
+     * The value of the {@link sap.f.FlexibleColumnLayout#getLayout layout} property.
+     */
+    layout?: string;
+    /**
+     * The maximum number of columns that can be displayed at once based on the control width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
+     */
+    maxColumnsCount?: number;
+    /**
+     * Represents the relative percentage sizes of all columns as integers.
+     */
+    columnsSizes?: ColumnsSizes;
+    /**
+     * Represents the visibility of the columns.
+     */
+    columnsVisibility?: ColumnsVisibility;
+    /**
+     * The value is `true` if only one column is visible at the moment, `false` otherwise.
+     *
+     * **Note:** This may be due to small screen size (phone) or due to a layout, for which a single column
+     * takes up the whole width.
+     */
+    isFullScreen?: boolean;
+    /**
+     * The value is `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn, sap.f.LayoutType.MidColumnFullScreen,
+     * sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise.
+     *
+     * **Note:** While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
+     * will only be `true` for the layout values, listed above.
+     */
+    isLogicallyFullScreen?: boolean;
+    /**
+     * The configuration of the navigation actions in the columns.
+     */
+    actionButtonsInfo?: ColumnsNavigationActions;
+  };
 }
 
 declare module "sap/f/GridContainer" {