@sapui5/ts-types 1.120.8 → 1.121.0

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.7
+// For Library Version: 1.121.0
 
 declare namespace sap {
   namespace suite {
@@ -659,7 +659,7 @@ declare namespace sap {
                 /**
                  * Can be used to add the standard footer bar for detail pages to this canvas page. It also allows to pass
                  * an array of buttons to be added to the footer. Note that the usage of the standard footer bar must have
-                 * been switched on in the settings of the page
+                 * been switched on in the settings of the page.
                  */
                 addFooterBarToPage(
                   /**
@@ -704,10 +704,13 @@ declare namespace sap {
                   fnFunction: Function
                 ): void;
                 /**
-                 * Get the Flexible Column Layout Action Buttons(Fullscreen, Exit Fullscreen and Close).
+                 * Get the Flexible Column Layout Action Buttons (Fullscreen, Exit Fullscreen and Close). Note that the
+                 * usage of the Flexible Column Layout Action Buttons must have been switched on in the settings of the
+                 * page.
                  *
                  *
-                 * @returns Flexible Column Layout Action Buttons
+                 * @returns Flexible Column Layout Action Buttons (resp. `undefined` when no FCL Action Buttons should be
+                 * shown on this page)
                  */
                 getFlexibleColumnLayoutActionButtons(): object;
                 /**
@@ -2679,25 +2682,6 @@ declare namespace sap {
                  * @returns the view id
                  */
                 getViewId(): string;
-                /**
-                 * Hides Section and/or SubSection's title for embedded components and custom section(s), if the Section
-                 * and/or SubSection's title matches with the inner Control's title. In case the control's resolved title
-                 * is provided and is same as section's title, then the section's title is also automatically hidden. It's
-                 * meant to be invoked from the onSubSectionEnteredExtension ExtensionAPI.
-                 *
-                 * @experimental
-                 */
-                hideDuplicateSectionOrSubSectionTitle(
-                  /**
-                   * the ID identifying the Sub-Section to which you want to hide the title
-                   */
-                  sSubSectionId: string,
-                  /**
-                   * Optional parameter which represents the resolved title of the inner conrol defined in the Resue Component
-                   * or Custom Section/SubSection
-                   */
-                  sTitle?: string
-                ): void;
                 /**
                  * Invokes multiple time the action with the given name and submits changes to the back-end.
                  *
@@ -2844,14 +2828,38 @@ declare namespace sap {
                   }
                 ): Promise<any>;
                 /**
-                 * Provide an option for showing an own message in the message bar above an OP table
+                 * Defines a control to be the **title owner** for its subsection. As the title owners of standard subsections
+                 * are determined automatically it is recommended to use this function for custom subsections and embedded
+                 * components only. The title owner should be a control possessing properties header and headerLevel
+                 * and headerStyle (like {@link sap.ui.comp.smarttable.SmartTable} and {@link sap.ui.comp.smartchart.SmartChart})
+                 * or text and level and titleStyle (like {@link sap.m.Title}). The framework will
+                 * adapt the values of these properties to be aligned with the title which is shown in the anchor bar (or
+                 * icon tab bar) for the subsection. Moreover, the title of the subsection (and if applicable also of the
+                 * section) will be hidden in order to prevent redundant titles if the subsection possesses a title owner.
+                 *  Note that this method should only be used in case that there exists one single suitable control which
+                 * represents the complete content of the subsection or embedded component.
+                 */
+                setAsTitleOwner(
+                  /**
+                   * title owner of the subsection containing this control. The control must possess properties header
+                   * and headerLevel and headerStyle or text and level and titleStyle.
+                   * As a special case you can also pass a subsection itself which would remove a potential title owner from
+                   * this subsection.
+                   */
+                  the: sap.ui.core.Control
+                ): void;
+                /**
+                 * Provide an option for showing an own message in the message bar above an OP table or page header.
+                 *
+                 * If you want to display message on page header then you should pass `oMessage` only keeping all other
+                 * parameter as empty Note - Message bar on Page header will be shown only in display mode for dynamic header
                  */
                 setCustomMessage(
                   /**
                    * custom message along with type to set on table. If this parameter is faulty an existing message will
                    * be removed.
                    */
-                  oMessage: {
+                  oMessage?: {
                     /**
                      * message string to display
                      */
@@ -2863,30 +2871,9 @@ declare namespace sap {
                     type: string;
                   },
                   /**
-                   * Id of the table for which message should be set
-                   */
-                  sSmartTableId: string,
-                  /**
-                   * If switching between different table views is enabled, this parameter can be used to identify the views
-                   * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
-                   * the value should either be one string or an array of strings identifying the affected variant items.
-                   */
-                  vTabKey?: any[] | string,
-                  /**
-                   * A function that is called when the user closes the message bar. Note that the messages for all tabs specified
-                   * via `vTabKey` will be considered to be obsolete when the user closes the message bar while one of them
-                   * is active.
-                   */
-                  onClose?: Function
-                ): void;
-                /**
-                 * Provide an option for showing an own message in the message bar above an OP table
-                 */
-                setCustomMessage(
-                  /**
-                   * Id of the table for which message should be set
+                   * Id of the table for which message should be set.
                    */
-                  sSmartTableId: string,
+                  sSmartTableId?: string,
                   /**
                    * If switching between different table views is enabled, this parameter can be used to identify the views
                    * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
@@ -3376,6 +3363,9 @@ declare namespace sap {
 
           /**
            * A static enumeration type which indicates the mode of targeted page while using navigateInternal extensionAPI
+           *
+           * This enum is part of the 'sap/suite/ui/generic/template/library' module export and must be accessed by
+           * the property 'displayMode'.
            */
           enum displayMode {
             /**

package/types/sap.suite.ui.microchart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.8
+// For Library Version: 1.121.0
 
 declare namespace sap {
   namespace suite {
@@ -1912,6 +1912,17 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
+          /**
+           * If set to true, the percentage symbol(%) is displayed. If set to false, the percentage symbol(%) is not
+           * displayed.
+           *
+           * @since 1.121.0
+           */
+          showPercentageSymbol?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
           /**
            * Controls or IDs that label this control. Can be used by screen reader software.
            *
@@ -12278,6 +12289,19 @@ declare namespace sap {
            * @returns Value of property `percentage`
            */
           getPercentage(): float;
+          /**
+           * Gets current value of property {@link #getShowPercentageSymbol showPercentageSymbol}.
+           *
+           * If set to true, the percentage symbol(%) is displayed. If set to false, the percentage symbol(%) is not
+           * displayed.
+           *
+           * Default value is `true`.
+           *
+           * @since 1.121.0
+           *
+           * @returns Value of property `showPercentageSymbol`
+           */
+          getShowPercentageSymbol(): boolean;
           /**
            * Gets current value of property {@link #getSize size}.
            *
@@ -12428,6 +12452,26 @@ declare namespace sap {
              */
             fPercentage?: float
           ): this;
+          /**
+           * Sets a new value for property {@link #getShowPercentageSymbol showPercentageSymbol}.
+           *
+           * If set to true, the percentage symbol(%) is displayed. If set to false, the percentage symbol(%) is not
+           * displayed.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `true`.
+           *
+           * @since 1.121.0
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setShowPercentageSymbol(
+            /**
+             * New value for property `showPercentageSymbol`
+             */
+            bShowPercentageSymbol?: boolean
+          ): this;
           /**
            * Sets a new value for property {@link #getSize size}.
            *
@@ -13192,6 +13236,9 @@ declare namespace sap {
         /**
          * Enum of available views for the area micro chart concerning the position of the labels.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'AreaMicroChartViewType'.
+         *
          * @since 1.34
          */
         enum AreaMicroChartViewType {
@@ -13208,6 +13255,9 @@ declare namespace sap {
          * Defines if the horizontal bar represents a current value only or if it represents the delta between a
          * current value and a threshold value.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'BulletMicroChartModeType'.
+         *
          * @since 1.34
          */
         enum BulletMicroChartModeType {
@@ -13223,6 +13273,9 @@ declare namespace sap {
         /**
          * Lists the available theme-specific background colors.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'CommonBackgroundType'.
+         *
          * @since 1.34
          */
         enum CommonBackgroundType {
@@ -13266,6 +13319,9 @@ declare namespace sap {
         /**
          * Lists the views of the comparison micro chart concerning the position of titles and labels.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'ComparisonMicroChartViewType'.
+         *
          * @since 1.34
          */
         enum ComparisonMicroChartViewType {
@@ -13286,6 +13342,9 @@ declare namespace sap {
         /**
          * Lists the views of the delta micro chart concerning the position of titles.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'DeltaMicroChartViewType'.
+         *
          * @since 1.61
          */
         enum DeltaMicroChartViewType {
@@ -13306,6 +13365,9 @@ declare namespace sap {
         /**
          * Alignment type for the microchart content.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'HorizontalAlignmentType'.
+         *
          * @since 1.62
          */
         enum HorizontalAlignmentType {
@@ -13325,6 +13387,9 @@ declare namespace sap {
         /**
          * Type of the microchart line.
          *
+         * This enum is part of the 'sap/suite/ui/microchart/library' module export and must be accessed by the
+         * property 'LineType'.
+         *
          * @since 1.60
          */
         enum LineType {