@sapui5/types 1.120.6 → 1.120.8

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

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

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

@@ -1,16 +1,16 @@
-// For Library Version: 1.120.6
+// For Library Version: 1.120.8
 
 declare module "sap/ui/export/library" {
   /**
-   * @since 1.50.0
-   *
    * EDM data types for document export.
+   *
+   * @since 1.50.0
    */
   export enum EdmType {
     /**
-     * @since 1.60
-     *
      * Property of type BigNumber.
+     *
+     * @since 1.60
      */
     BigNumber = "BigNumber",
     /**
@@ -30,9 +30,9 @@ declare module "sap/ui/export/library" {
      */
     DateTime = "DateTime",
     /**
-     * @since 1.58
-     *
      * Property of type Enumeration.
+     *
+     * @since 1.58
      */
     Enumeration = "Enumeration",
     /**
@@ -40,9 +40,9 @@ declare module "sap/ui/export/library" {
      */
     Number = "Number",
     /**
-     * @since 1.87
-     *
      * Property of type Percentage.
+     *
+     * @since 1.87
      */
     Percentage = "Percentage",
     /**
@@ -54,22 +54,22 @@ declare module "sap/ui/export/library" {
      */
     Time = "Time",
     /**
-     * @since 1.118
-     *
      * Property of type Timezone
+     *
+     * @since 1.118
      */
     Timezone = "Timezone",
   }
   /**
-   * @since 1.78
-   *
    * File types for document export.
+   *
+   * @since 1.78
    */
   export enum FileType {
     /**
-     * @since 1.117
-     *
      * Portable Document Format (PDF) file type.
+     *
+     * @since 1.117
      */
     PDF = "PDF",
     /**
@@ -93,10 +93,10 @@ declare module "sap/ui/export/ExportBase" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * @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.
+   *
+   * @since 1.96
    */
   export default class ExportBase extends EventProvider {
     /**
@@ -138,6 +138,7 @@ declare module "sap/ui/export/ExportBase" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -158,18 +159,19 @@ declare module "sap/ui/export/ExportBase" {
     /**
      * Returns a metadata object for class sap.ui.export.ExportBase.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
     /**
-     * @since 1.96
-     *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportBase#event:beforeExport} event
      * of this `sap.ui.export.ExportBase`.
      *  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.ui.export.ExportBase` itself.
      *  This event is fired just before the export process is started.
      *
+     * @since 1.96
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachBeforeExport(
@@ -188,14 +190,14 @@ declare module "sap/ui/export/ExportBase" {
       oListener?: object
     ): this;
     /**
-     * @since 1.96
-     *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportBase#event:beforeExport} event
      * of this `sap.ui.export.ExportBase`.
      *  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.ui.export.ExportBase` itself.
      *  This event is fired just before the export process is started.
      *
+     * @since 1.96
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachBeforeExport(
@@ -211,6 +213,7 @@ declare module "sap/ui/export/ExportBase" {
     /**
      * Triggers the export process of the specific format.
      *
+     *
      * @returns Promise that gets resolved once the data has been exported
      */
     build(): Promise<any>;
@@ -227,12 +230,12 @@ declare module "sap/ui/export/ExportBase" {
      */
     destroy(): void;
     /**
-     * @since 1.96
-     *
      * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportBase#event:beforeExport} event
      * of this `sap.ui.export.ExportBase`.
      *  The passed function and listener object must match the ones used for event registration.
      *
+     * @since 1.96
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachBeforeExport(
@@ -246,15 +249,16 @@ declare module "sap/ui/export/ExportBase" {
       oListener?: object
     ): this;
     /**
-     * @since 1.112
-     *
      * Returns the specific MIME type
+     *
+     * @since 1.112
      */
     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.
      *
+     *
      * @returns - Valid dataSource object or null in case the dataSource configuration is not supported
      */
     processDataSource(
@@ -283,9 +287,9 @@ declare module "sap/ui/export/ExportHandler" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * @since 1.102
-   *
    * The `sap.ui.export.ExportHandler` class allows you to export table data from an SAPUI5 application.
+   *
+   * @since 1.102
    */
   export default class ExportHandler extends EventProvider {
     /**
@@ -305,6 +309,7 @@ declare module "sap/ui/export/ExportHandler" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -325,18 +330,19 @@ declare module "sap/ui/export/ExportHandler" {
     /**
      * Returns a metadata object for class sap.ui.export.ExportHandler.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
     /**
-     * @since 1.102
-     *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportHandler#event:beforeExport} event
      * of this `sap.ui.export.ExportHandler`.
      *  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.ui.export.ExportHandler` itself.
      *  This event is fired just before the export process is started.
      *
+     * @since 1.102
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachBeforeExport(
@@ -356,14 +362,14 @@ declare module "sap/ui/export/ExportHandler" {
       oListener?: object
     ): this;
     /**
-     * @since 1.102
-     *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportHandler#event:beforeExport} event
      * of this `sap.ui.export.ExportHandler`.
      *  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.ui.export.ExportHandler` itself.
      *  This event is fired just before the export process is started.
      *
+     * @since 1.102
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachBeforeExport(
@@ -386,12 +392,12 @@ declare module "sap/ui/export/ExportHandler" {
      */
     destroy(): void;
     /**
-     * @since 1.102
-     *
      * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportHandler#event:beforeExport} event
      * of this `sap.ui.export.ExportHandler`.
      *  The passed function and listener object must match the ones used for event registration.
      *
+     * @since 1.102
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachBeforeExport(
@@ -405,12 +411,12 @@ declare module "sap/ui/export/ExportHandler" {
       oListener?: object
     ): this;
     /**
-     * @since 1.102
-     *
      * Exports the data as defined via parameter. The function returns a `Promise` that will be resolved after
      * the export process has been finished. In case of an error, its message will be shown in a `Dialog`, and
      * the `Promise` will be rejected.
      *
+     * @since 1.102
+     *
      * @returns A `Promise` that gets resolved after the export process has been finished
      */
     export(
@@ -420,11 +426,11 @@ declare module "sap/ui/export/ExportHandler" {
       mExportSettings: object
     ): Promise<any>;
     /**
-     * @since 1.102
-     *
      * Exports the data as defined by the user. This function will show an export settings dialog where the
      * user can define certain settings that influence the output of the export functionality.
      *
+     * @since 1.102
+     *
      * @returns A `Promise` that resolves once the data has been exported
      */
     exportAs(
@@ -472,10 +478,10 @@ declare module "sap/ui/export/Spreadsheet" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * @since 1.50
-   *
    * The `sap.ui.export.Spreadsheet` class allows you to export table data from a UI5 application to a spreadsheet
    * file.
+   *
+   * @since 1.50
    */
   export default class Spreadsheet extends ExportBase {
     /**
@@ -778,14 +784,14 @@ declare module "sap/ui/export/Spreadsheet" {
     );
 
     /**
-     * @since 1.61
-     *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.Spreadsheet#event:beforeSave} event of
      * this `sap.ui.export.Spreadsheet`.
      *  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.ui.export.Spreadsheet` itself.
      *  This event is fired just before the generated file is saved to the file system.
      *
+     * @since 1.61
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachBeforeSave(
@@ -804,14 +810,14 @@ declare module "sap/ui/export/Spreadsheet" {
       oListener?: object
     ): this;
     /**
-     * @since 1.61
-     *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.Spreadsheet#event:beforeSave} event of
      * this `sap.ui.export.Spreadsheet`.
      *  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.ui.export.Spreadsheet` itself.
      *  This event is fired just before the generated file is saved to the file system.
      *
+     * @since 1.61
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     attachBeforeSave(
@@ -825,20 +831,20 @@ declare module "sap/ui/export/Spreadsheet" {
       oListener?: object
     ): this;
     /**
-     * @since 1.52
-     *
      * Cancels a running export process. This method does nothing if no export is running.
      *
+     * @since 1.52
+     *
      * @returns - Reference to `this` in order to allow method chaining
      */
     cancel(): this;
     /**
-     * @since 1.61
-     *
      * Detaches event handler `fnFunction` from the {@link sap.ui.export.Spreadsheet beforeSave} event of this
      * `sap.ui.export.Spreadsheet`.
      *  The passed function and listener object must match the ones used for event registration.
      *
+     * @since 1.61
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     detachBeforeSave(
@@ -852,19 +858,19 @@ declare module "sap/ui/export/Spreadsheet" {
       oListener?: object
     ): this;
     /**
-     * @since 1.112
-     *
      * Returns the specific MIME type
      *
+     * @since 1.112
+     *
      * @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.
      *
+     * @since 1.73
+     *
      * @returns - Valid dataSource object or null in case the dataSource configuration is not supported
      */
     processDataSource(
@@ -892,11 +898,11 @@ declare module "sap/ui/export/util/Filter" {
   import SimpleType from "sap/ui/model/SimpleType";
 
   /**
-   * @since 1.110
-   *
    * The `sap.ui.export.util.Filter` class represents filter settings that are used for the export. It provides
    * the capability to have a visual representation of the filters in the exported document and offers convenience
    * functions like `sap.ui.export.util.Filter#setType` to improve the result.
+   *
+   * @since 1.110
    */
   export default class Filter extends BaseObject {
     /**
@@ -951,6 +957,7 @@ declare module "sap/ui/export/util/Filter" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -971,38 +978,37 @@ declare module "sap/ui/export/util/Filter" {
     /**
      * Returns a metadata object for class sap.ui.export.util.Filter.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
     /**
-     * @since 1.110
-     *
      * Returns the filter label if available. Otherwise the name of the filter property will be returned.
      *
+     * @since 1.110
+     *
      * @returns Filter label
      */
     getLabel(): string;
     /**
-     * @since 1.110
-     *
      * Returns the technical name of the property on which the filter is applied.
      *
+     * @since 1.110
+     *
      * @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.
      *
+     * @since 1.110
+     *
      * @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.
@@ -1012,6 +1018,8 @@ declare module "sap/ui/export/util/Filter" {
      *
      * 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`.
+     *
+     * @since 1.110
      */
     setFormat(
       /**
@@ -1020,9 +1028,9 @@ declare module "sap/ui/export/util/Filter" {
       fnFormat: Function
     ): void;
     /**
-     * @since 1.110
-     *
      * Takes the given string as label of the filter.
+     *
+     * @since 1.110
      */
     setLabel(
       /**
@@ -1031,9 +1039,9 @@ declare module "sap/ui/export/util/Filter" {
       sLabel: string
     ): void;
     /**
-     * @since 1.110
-     *
      * Uses the given `sap.ui.model.SimpleType` instance to format the filter values accordingly.
+     *
+     * @since 1.110
      */
     setType(
       /**