@sapui5/ts-types 1.111.1 → 1.112.1

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {
@@ -91,11 +91,81 @@ declare namespace sap {
            * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.base.Metadata;
+          /**
+           * @SINCE 1.110
+           *
+           * Returns the filter label if available. Otherwise the name of the filter property will be returned.
+           *
+           * @returns Filter label
+           */
+          getLabel(): string;
+          /**
+           * @SINCE 1.110
+           *
+           * Returns the technical name of the property on which the filter is applied.
+           *
+           * @returns Name of the property
+           */
+          getProperty(): string;
+          /**
+           * @SINCE 1.110
+           *
+           * Returns the formatted filter value(s) as string. If there are multiple filters for the same property,
+           * which are combined via `OR`, it will return a semicolon-separated list of the filter values including
+           * their operators.
+           *
+           * @returns Formatted and semicolon-separated filter settings
+           */
+          getValue(): string;
+          /**
+           * @SINCE 1.110
+           *
+           * Uses the given format function to format all filter values. The function has to accept a single parameter
+           * of type `string` and needs to return a string value. The function will be called for every single raw
+           * value without the corresponding filter operator.
+           *
+           * If there is a "between" filter, the function will be called twice. In case of an error, the function
+           * call will be skipped, and the raw value will be taken instead.
+           *
+           * The format function has priority over the type-dependent format. To reset the format function and return
+           * to type-dependent formatting, the format function needs to be set to `null`.
+           */
+          setFormat(
+            /**
+             * Format function that will be applied to the raw values
+             */
+            fnFormat: Function
+          ): void;
+          /**
+           * @SINCE 1.110
+           *
+           * Takes the given string as label of the filter.
+           */
+          setLabel(
+            /**
+             * Filter label
+             */
+            sLabel: string
+          ): void;
+          /**
+           * @SINCE 1.110
+           *
+           * Uses the given `sap.ui.model.SimpleType` instance to format the filter values accordingly.
+           */
+          setType(
+            /**
+             * Type instance that is used for formatting
+             */
+            oType: sap.ui.model.SimpleType
+          ): void;
         }
       }
 
       /**
        * @SINCE 1.96
+       *
+       * The `sap.ui.export.ExportBase` class allows you to export table data from a UI5 application to certain
+       * formats. This class is an abstract class that requires specific implementations for each file format.
        */
       class ExportBase extends sap.ui.base.EventProvider {
         /**
@@ -217,6 +287,14 @@ declare namespace sap {
          * Cancels the current export process.
          */
         cancel(): void;
+        /**
+         * Cleans up the internal structures and removes all event handlers.
+         *
+         * The object must not be used anymore after destroy was called.
+         * See:
+         * 	sap.ui.base.Object#destroy
+         */
+        destroy(): void;
         /**
          * @SINCE 1.96
          *
@@ -236,6 +314,12 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
+        /**
+         * @SINCE 1.112
+         *
+         * Returns the specific MIME type
+         */
+        getMimeType(): void;
         /**
          * Sets the data source configuration that will be used for exporting the data. If the passed parameter
          * is null, the call will be ignored.
@@ -254,6 +338,9 @@ declare namespace sap {
       }
       /**
        * @SINCE 1.50
+       *
+       * The `sap.ui.export.Spreadsheet` class allows you to export table data from a UI5 application to a spreadsheet
+       * file.
        */
       class Spreadsheet extends sap.ui.export.ExportBase {
         /**
@@ -630,6 +717,34 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
+        /**
+         * @SINCE 1.112
+         *
+         * Returns the specific MIME type
+         *
+         * @returns MIME type for Office Open XML Spreadsheet
+         */
+        getMimeType(): string;
+        /**
+         * @SINCE 1.73
+         *
+         * Sets the data source configuration that will be used for exporting the data. If the passed parameter
+         * is null, the call will be ignored.
+         *
+         * @returns - Valid dataSource object or null in case the dataSource configuration is not supported
+         */
+        processDataSource(
+          /**
+           * Possible types are a plain string that contains an URL of an OData service, an array of JSON objects,
+           * a data source configuration, a `sap.ui.model.ListBinding` or `sap.ui.model.TreeBinding`
+           */
+          oDataSource:
+            | string
+            | any[]
+            | Object
+            | sap.ui.model.ListBinding
+            | sap.ui.model.TreeBinding
+        ): object | null;
       }
       /**
        * @SINCE 1.50.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {
@@ -1205,10 +1205,14 @@ declare namespace sap {
   interface IUI5DefineDependencyNames {
     "sap/ui/fl/apply/_internal/changes/descriptor/app/AddAnnotationsToOData": undefined;
 
+    "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewInbound": undefined;
+
     "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeDataSource": undefined;
 
     "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeInbound": undefined;
 
+    "sap/ui/fl/apply/_internal/changes/descriptor/app/RemoveAllInboundsExceptOne": undefined;
+
     "sap/ui/fl/apply/_internal/changes/descriptor/app/SetTitle": undefined;
 
     "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;

package/types/sap.ui.generic.app.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {
@@ -820,6 +820,22 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
+          /**
+           * @SINCE 1.112
+           * @EXPERIMENTAL (since 1.112)
+           *
+           * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
+           *
+           * 	 - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
+           * 			in the manifest. If such configuration is missing, then the real data is loaded.
+           * 	 - When set to "Abstract", the card shows abstract placeholder without loading data.
+           * 	 - When set to "Off", the card displays real data.
+           */
+          previewMode?:
+            | sap.ui.integration.CardPreviewMode
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
           /**
            * @SINCE 1.85
            * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -844,6 +860,10 @@ declare namespace sap {
            * be done before its official public release. Use at your own discretion.
            *
            * Fired when an action is triggered on the card.
+           *
+           * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+           * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+           * one to handle the action by calling `oEvent.preventDefault()`.
            */
           action?: (oEvent: sap.ui.base.Event) => void;
 
@@ -1012,6 +1032,10 @@ declare namespace sap {
            *
            * Fired when an action is triggered on the card.
            *
+           * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+           * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+           * one to handle the action by calling `oEvent.preventDefault()`.
+           *
            * @returns Reference to `this` in order to allow method chaining
            */
           attachAction(
@@ -1040,6 +1064,10 @@ declare namespace sap {
            *
            * Fired when an action is triggered on the card.
            *
+           * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+           * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+           * one to handle the action by calling `oEvent.preventDefault()`.
+           *
            * @returns Reference to `this` in order to allow method chaining
            */
           attachAction(
@@ -1612,6 +1640,24 @@ declare namespace sap {
              */
             sPath: string
           ): any;
+          /**
+           * @SINCE 1.112
+           * @EXPERIMENTAL (since 1.112)
+           *
+           * Gets current value of property {@link #getPreviewMode previewMode}.
+           *
+           * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
+           *
+           * 	 - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
+           * 			in the manifest. If such configuration is missing, then the real data is loaded.
+           * 	 - When set to "Abstract", the card shows abstract placeholder without loading data.
+           * 	 - When set to "Off", the card displays real data.
+           *
+           * Default value is `Off`.
+           *
+           * @returns Value of property `previewMode`
+           */
+          getPreviewMode(): sap.ui.integration.CardPreviewMode;
           /**
            * Gets current value of property {@link #getReferenceId referenceId}.
            *
@@ -1952,6 +1998,31 @@ declare namespace sap {
              */
             sManifestChanges: object[]
           ): this;
+          /**
+           * @SINCE 1.112
+           * @EXPERIMENTAL (since 1.112)
+           *
+           * Sets a new value for property {@link #getPreviewMode previewMode}.
+           *
+           * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
+           *
+           * 	 - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
+           * 			in the manifest. If such configuration is missing, then the real data is loaded.
+           * 	 - When set to "Abstract", the card shows abstract placeholder without loading data.
+           * 	 - When set to "Off", the card displays real data.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `Off`.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setPreviewMode(
+            /**
+             * New value for property `previewMode`
+             */
+            sPreviewMode?: sap.ui.integration.CardPreviewMode
+          ): this;
           /**
            * Sets a new value for property {@link #getReferenceId referenceId}.
            *
@@ -2138,6 +2209,10 @@ declare namespace sap {
          * be done before its official public release. Use at your own discretion.
          *
          * Fired when an action is triggered in the card.
+         *
+         * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+         * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+         * one to handle the action by calling `oEvent.preventDefault()`.
          */
         action?: (oEvent: sap.ui.base.Event) => void;
       }
@@ -2175,6 +2250,10 @@ declare namespace sap {
          * be done before its official public release. Use at your own discretion.
          *
          * Fired when an action is triggered.
+         *
+         * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+         * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+         * one to handle the action by calling `oEvent.preventDefault()`.
          */
         action?: (oEvent: sap.ui.base.Event) => void;
 
@@ -2685,6 +2764,10 @@ declare namespace sap {
          *
          * Fired when an action is triggered in the card.
          *
+         * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+         * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+         * one to handle the action by calling `oEvent.preventDefault()`.
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         attachAction(
@@ -2713,6 +2796,10 @@ declare namespace sap {
          *
          * Fired when an action is triggered in the card.
          *
+         * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+         * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+         * one to handle the action by calling `oEvent.preventDefault()`.
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         attachAction(
@@ -2917,6 +3004,10 @@ declare namespace sap {
          *
          * Fired when an action is triggered.
          *
+         * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+         * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+         * one to handle the action by calling `oEvent.preventDefault()`.
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         attachAction(
@@ -2945,6 +3036,10 @@ declare namespace sap {
          *
          * Fired when an action is triggered.
          *
+         * When an action is triggered in the card it can be handled on several places by "action" event handlers.
+         * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
+         * one to handle the action by calling `oEvent.preventDefault()`.
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         attachAction(
@@ -3589,6 +3684,27 @@ declare namespace sap {
          */
         Transparent = "Transparent",
       }
+      /**
+       * @SINCE 1.112
+       * @EXPERIMENTAL (since 1.112)
+       *
+       * Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
+       * choosing or configuring a card.
+       */
+      enum CardPreviewMode {
+        /**
+         * Card displays abstract preview. No data requests are made.
+         */
+        Abstract = "Abstract",
+        /**
+         * Card displays mocked data, loaded using a data request as configured in the manifest.
+         */
+        MockData = "MockData",
+        /**
+         * Card displays real data.
+         */
+        Off = "Off",
+      }
       /**
        * @EXPERIMENTAL (since 1.79)
        *
@@ -3730,6 +3846,8 @@ declare namespace sap {
 
     "sap/ui/integration/editor/Editor": undefined;
 
+    "sap/ui/integration/editor/EditorResourceBundles": undefined;
+
     "sap/ui/integration/editor/Extension": undefined;
 
     "sap/ui/integration/editor/fields/BaseField": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {
@@ -106,6 +106,8 @@ declare namespace sap {
 
     "sap/ui/mdc/filterbar/FilterBarBase": undefined;
 
+    "sap/ui/mdc/filterbar/p13n/AdaptationFilterBar": undefined;
+
     "sap/ui/mdc/filterbar/vh/CollectiveSearchSelect": undefined;
 
     "sap/ui/mdc/filterbar/vh/FilterBar": undefined;
@@ -146,14 +148,10 @@ declare namespace sap {
 
     "sap/ui/mdc/odata/v4/ValueHelpDelegate": undefined;
 
-    "sap/ui/mdc/p13n/Engine": undefined;
-
     "sap/ui/mdc/p13n/panels/FilterPanel": undefined;
 
     "sap/ui/mdc/p13n/StateUtil": undefined;
 
-    "sap/ui/mdc/p13n/subcontroller/BaseController": undefined;
-
     "sap/ui/mdc/p13n/UIManager": undefined;
 
     "sap/ui/mdc/Table": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare module "sap/ui/rta/api/startAdaptation" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {
@@ -13,14 +13,16 @@ declare namespace sap {
           extends sap.ui.table.plugins.$SelectionPluginSettings {
           /**
            * Number of indices which can be selected in a range. Accepts positive integer values. If set to 0, the
-           * limit is disabled, and the Select All checkbox appears instead of the Deselect All button. **Note:**
-           * To avoid severe performance problems, the limit should only be set to 0 in the following cases:
+           * limit is disabled, and the Select All checkbox appears instead of the Deselect All button.
+           *
+           * **Note:** To avoid severe performance problems, the limit should only be set to 0 in the following cases:
            *
            * 	 - With client-side models
            * 	 - With server-side models if they are used in client mode
-           * 	 - If the entity set is small  In other cases, we recommend to set the limit to at least double
-           * 			the value of the {@link sap.ui.table.Table#getThreshold threshold} property of the related `sap.ui.table.Table`
-           * 			control.
+           * 	 - If the entity set is small
+           *
+           * In other cases, we recommend to set the limit to at least double the value of the {@link sap.ui.table.Table#getThreshold
+           * threshold} property of the related `sap.ui.table.Table` control.
            */
           limit?:
             | int
@@ -75,16 +77,16 @@ declare namespace sap {
          * Implements a plugin to enable a special multi-selection behavior:
          * 	 - No Select All checkbox, select all can only be done via range selection
          * 	 - Dedicated Deselect All button to clear the selection
-         * 	 - The number of indices which can be selected in a range is defined by the `limit` property by the
-         * 			application. If the user tries to select more indices, the selection is automatically limited, and the
-         * 			table scrolls to the last selected index.
+         * 	 - The number of indices which can be selected in a range is defined by the `limit` property. If the
+         * 			user tries to select more indices, the selection is automatically limited, and the table scrolls to the
+         * 			last selected index.
          * 	 - The plugin makes sure that the corresponding binding contexts up to the given limit are available,
          * 			by requesting them from the binding.
          * 	 - Multiple consecutive selections are possible
          *
-         * This plugin is intended for the multi-selection mode, but also supports single selection for ease of
-         * use. When this plugin is applied to the table, the table's selection mode is automatically set to MultiToggle
-         * and cannot be changed.
+         * This plugin is intended for server-side models and multi-selection mode. Range selections, including
+         * Select All, only work properly if the count is known. Make sure the model/binding is configured to request
+         * the count from the service. For ease of use, client-side models and single selection are also supported.
          */
         class MultiSelectionPlugin extends sap.ui.table.plugins
           .SelectionPlugin {
@@ -270,14 +272,16 @@ declare namespace sap {
            * Gets current value of property {@link #getLimit limit}.
            *
            * Number of indices which can be selected in a range. Accepts positive integer values. If set to 0, the
-           * limit is disabled, and the Select All checkbox appears instead of the Deselect All button. **Note:**
-           * To avoid severe performance problems, the limit should only be set to 0 in the following cases:
+           * limit is disabled, and the Select All checkbox appears instead of the Deselect All button.
+           *
+           * **Note:** To avoid severe performance problems, the limit should only be set to 0 in the following cases:
            *
            * 	 - With client-side models
            * 	 - With server-side models if they are used in client mode
-           * 	 - If the entity set is small  In other cases, we recommend to set the limit to at least double
-           * 			the value of the {@link sap.ui.table.Table#getThreshold threshold} property of the related `sap.ui.table.Table`
-           * 			control.
+           * 	 - If the entity set is small
+           *
+           * In other cases, we recommend to set the limit to at least double the value of the {@link sap.ui.table.Table#getThreshold
+           * threshold} property of the related `sap.ui.table.Table` control.
            *
            * Default value is `200`.
            *
@@ -378,14 +382,16 @@ declare namespace sap {
            * Sets a new value for property {@link #getLimit limit}.
            *
            * Number of indices which can be selected in a range. Accepts positive integer values. If set to 0, the
-           * limit is disabled, and the Select All checkbox appears instead of the Deselect All button. **Note:**
-           * To avoid severe performance problems, the limit should only be set to 0 in the following cases:
+           * limit is disabled, and the Select All checkbox appears instead of the Deselect All button.
+           *
+           * **Note:** To avoid severe performance problems, the limit should only be set to 0 in the following cases:
            *
            * 	 - With client-side models
            * 	 - With server-side models if they are used in client mode
-           * 	 - If the entity set is small  In other cases, we recommend to set the limit to at least double
-           * 			the value of the {@link sap.ui.table.Table#getThreshold threshold} property of the related `sap.ui.table.Table`
-           * 			control.
+           * 	 - If the entity set is small
+           *
+           * In other cases, we recommend to set the limit to at least double the value of the {@link sap.ui.table.Table#getThreshold
+           * threshold} property of the related `sap.ui.table.Table` control.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {
@@ -5714,7 +5714,12 @@ declare namespace sap {
            *
            * @returns `this` to allow method chaining.
            */
-          setShouldRenderFrame(): this;
+          setShouldRenderFrame(
+            /**
+             * If set to 'true', then hierarchy and matrix recomputation is not required, only redraw.
+             */
+            skipHierarchyProcessing: boolean
+          ): this;
           /**
            * Sets the current scene to use the camera view information acquired from the {@link sap.ui.vk.Viewport#getViewInfo
            * getViewInfo} method.

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.0
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.111.1
+// For Library Version: 1.112.0
 
 declare namespace sap {
   namespace ui {