@sapui5/types 1.114.0 → 1.115.1

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

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

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

@@ -1,14 +1,14 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.1
 
 declare module "sap/ui/export/library" {
   /**
-   * @SINCE 1.50.0
+   * @since 1.50.0
    *
    * EDM data types for document export.
    */
   export enum EdmType {
     /**
-     * @SINCE 1.60
+     * @since 1.60
      *
      * Property of type BigNumber.
      */
@@ -30,7 +30,7 @@ declare module "sap/ui/export/library" {
      */
     DateTime = "DateTime",
     /**
-     * @SINCE 1.58
+     * @since 1.58
      *
      * Property of type Enumeration.
      */
@@ -40,7 +40,7 @@ declare module "sap/ui/export/library" {
      */
     Number = "Number",
     /**
-     * @SINCE 1.87
+     * @since 1.87
      *
      * Property of type Percentage.
      */
@@ -55,7 +55,7 @@ declare module "sap/ui/export/library" {
     Time = "Time",
   }
   /**
-   * @SINCE 1.78
+   * @since 1.78
    *
    * File types for document export.
    */
@@ -78,8 +78,10 @@ declare module "sap/ui/export/ExportBase" {
 
   import TreeBinding from "sap/ui/model/TreeBinding";
 
+  import Event from "sap/ui/base/Event";
+
   /**
-   * @SINCE 1.96
+   * @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.
@@ -148,7 +150,7 @@ declare module "sap/ui/export/ExportBase" {
      */
     static getMetadata(): Metadata;
     /**
-     * @SINCE 1.96
+     * @since 1.96
      *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportBase#event:beforeExport} event
      * of this `sap.ui.export.ExportBase`.
@@ -174,7 +176,7 @@ declare module "sap/ui/export/ExportBase" {
       oListener?: object
     ): this;
     /**
-     * @SINCE 1.96
+     * @since 1.96
      *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportBase#event:beforeExport} event
      * of this `sap.ui.export.ExportBase`.
@@ -213,7 +215,7 @@ declare module "sap/ui/export/ExportBase" {
      */
     destroy(): void;
     /**
-     * @SINCE 1.96
+     * @since 1.96
      *
      * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportBase#event:beforeExport} event
      * of this `sap.ui.export.ExportBase`.
@@ -232,7 +234,7 @@ declare module "sap/ui/export/ExportBase" {
       oListener?: object
     ): this;
     /**
-     * @SINCE 1.112
+     * @since 1.112
      *
      * Returns the specific MIME type
      */
@@ -250,6 +252,16 @@ declare module "sap/ui/export/ExportBase" {
       oDataSource: object | ListBinding | TreeBinding
     ): object | null;
   }
+
+  export interface ExportBase$BeforeExportEventParameters {}
+
+  /**
+   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ExportBase$BeforeExportEventParameters'
+   * in 1.115.1 and any later releases.
+   */
+  export type $ExportBaseBeforeExportEventParameters = ExportBase$BeforeExportEventParameters;
+
+  export type ExportBase$BeforeExportEvent = Event<ExportBase$BeforeExportEventParameters>;
 }
 
 declare module "sap/ui/export/Spreadsheet" {
@@ -259,8 +271,10 @@ declare module "sap/ui/export/Spreadsheet" {
 
   import TreeBinding from "sap/ui/model/TreeBinding";
 
+  import Event from "sap/ui/base/Event";
+
   /**
-   * @SINCE 1.50
+   * @since 1.50
    *
    * The `sap.ui.export.Spreadsheet` class allows you to export table data from a UI5 application to a spreadsheet
    * file.
@@ -276,7 +290,7 @@ declare module "sap/ui/export/Spreadsheet" {
      * thread of the browser. The status of the process is visually presented to the user in a progress dialog
      * that can be suppressed. The user can cancel the process with the Cancel button of the dialog.
      *
-     * This class provides a low level API for spreadsheet export. The {@link sap.ui.comp.smarttable.SmartTable}
+     * This class provides a low level API for spreadsheet export. The {@link sap.ui.comp.smarttable.SmartTable }
      * control implements it internally and provides the export functionality out of the box. For special cases,
      * please refer to details below.
      *
@@ -293,23 +307,23 @@ declare module "sap/ui/export/Spreadsheet" {
      * 	`label` (string) - Column header text
      * 	 - `property` (string) - Field name or Array of field names in the data source feed
      * 	 - `type` (string) - Optional data type of the field. See {@link sap.ui.export.EdmType} for the list
-     * 			of supported types. If this property is omitted, the property is processed as a string field.
+     *     of supported types. If this property is omitted, the property is processed as a string field.
      * 	 - `width` (number) - Optional width of the column in characters. There is no 1:1 correspondence between
-     * 			character widths in the exported spreadsheet and CSS units.The width of one character is approximately
-     * 			0.5em in CSS units, depending on the fonts that are used in the table and in the resulting spreadsheet.
-     * 			The default value is 10 characters.
+     *     character widths in the exported spreadsheet and CSS units.The width of one character is approximately
+     *     0.5em in CSS units, depending on the fonts that are used in the table and in the resulting spreadsheet.
+     *     The default value is 10 characters.
      * 	 - `textAlign` (string) - Horizontal alignment of cell contents. The following values of the CSS `text-align`
-     * 			property are accepted: `[left, right, center, begin, end]`. If not specified, the columns are horizontally
-     * 			aligned based on the property type.
+     *     property are accepted: `[left, right, center, begin, end]`. If not specified, the columns are horizontally
+     *     aligned based on the property type.
      * 	 - `scale` (number) - Number of digits after decimal point for numeric values
      * 	 - `delimiter` (boolean) - Set to `true` to display thousands separators in numeric values. The default
-     * 			value is `false`.
+     *     value is `false`.
      * 	 - `unit` (string) - Text to display as the unit of measurement or currency next to the numeric value.
-     * 			It is treated as a string and has no influence on the value itself. For example, a value of 150 with
-     * 			the unit "%" is still 150 and not 1.5, as a user may expect.
+     *     It is treated as a string and has no influence on the value itself. For example, a value of 150 with
+     *     the unit "%" is still 150 and not 1.5, as a user may expect.
      * 	 - `unitProperty` (string) - Name of the data source field that contains the unit/currency text
      * 	 - `displayUnit` (boolean) - The property applies to currency values only and defines if the currency
-     * 			is shown in the column. The default value is `true`.
+     *     is shown in the column. The default value is `true`.
      * 	 - `trueValue` (string) - Textual representation of a boolean type that has the value `true`
      * 	 - `falseValue` (string) - Textual representation of a boolean type that has the value `false`
      * 	 - `template` (string) - Formatting template that supports indexed placeholders within curly brackets
@@ -317,45 +331,45 @@ declare module "sap/ui/export/Spreadsheet" {
      * 	 - `inputFormat` (string) - Formatting template for string formatted dates
      * 	 - `utc` (boolean) - Defines whether the `DateTime` is displayed as UTC or local time
      * 	 - `valueMap` (string) - Mapping object or Map containing the values that should be mapped to a particular
-     * 			key
+     *     key
      * 	 - `wrap` (boolean) - Indicates if wrapping is enabled for this particular column
      * 	 - `workbook.context` - Context object that will be applied to the generated file. It may contain the
-     * 			following fields:
+     *     following fields:
      * 	 - `application` (string) - The application that creates the XLSX document (default: "SAP UI5")
      * 	 - `version` (string) - Application version that creates the XLSX document (default: "${version}")
      * 	 - `title` (string) - Title of the XLSX document (NOT the filename)
      * 	 - `modifiedBy` (string) - User context for the XLSX document
      * 	 - `sheetName` (string) - The label of the data sheet
      * 	 - `metaSheetName` (string) - The label of the metadata sheet. The sheet will not be shown unless metadata
-     * 			entries are provided
+     *     entries are provided
      * 	 - `metainfo` (Array) - An Array of metadata groups. Each group has a name property and an items Array
-     * 			which contains key/value pairs
+     *     which contains key/value pairs
      * 	 - `workbook.hierarchyLevel` - Name of the property that contains the hierarchy level information of
-     * 			each line item
+     *     each line item
      * 	 - `dataSource` - Source of spreadsheet data. It can be a JSON array with row data, an URL or an OData
-     * 			properties object with the following fields:
+     *     properties object with the following fields:
      * 	`type` (string) - Type of the data source. Currently, only OData is supported and the value have to
      * be set to `"odata"`.
      * 	 - `dataUrl` (string) - URL to table data on the server, including all select, filter, and search query
-     * 			parameters
+     *     parameters
      * 	 - `serviceUrl` (string) - URL to the OData service. The parameter is required for OData batch requests.
      *
      * 	 - `count` (number) - Count of available records on the server
      * 	 - `useBatch` (boolean) - Set to `true` if OData batch requests are used to fetch the spreadsheet data.
-     * 			In this case, `serviceUrl` and `headers` have to be specified, too.
+     *     In this case, `serviceUrl` and `headers` have to be specified, too.
      * 	 - `headers` (object) - Map of HTTP request header properties. They should correspond to the HTTP request
-     * 			headers that are used to obtain table data for display in the browser.
+     *     headers that are used to obtain table data for display in the browser.
      * 	 - `sizeLimit` (number) - Maximal allowed number of records that can be obtained from the service in
-     * 			a single request
+     *     a single request
      * 	 - `count` (number) - The maximal number of records to export. If not specified, all data from the data
-     * 			source is fetched.
+     *     source is fetched.
      * 	 - `worker` (boolean) - Run export process in a worker thread. Set to `false` to disable worker and
-     * 			run export in a main thread. This is needed, for example, if a mock server is used to provide spreadsheet
-     * 			data.
+     *     run export in a main thread. This is needed, for example, if a mock server is used to provide spreadsheet
+     *     data.
      *  **Note:** In case of a strict content security policy, it is not always possible to create an export
      * worker. In this case, export runs in a main thread disregarding the `worker` value.
      * 	 - `fileName` (string) - Optional file name for the exported file. If not specified, the spreadsheet
-     * 			is exported as `export.xlsx`.
+     *     is exported as `export.xlsx`.
      * 	 - `showProgress` (boolean) - Set to `false` to suppress the progress dialog
      *
      * Usage: To start export, create a new `sap.ui.export.Spreadsheet` object and call the `build` method.
@@ -441,8 +455,7 @@ declare module "sap/ui/export/Spreadsheet" {
      * ```
      *
      *
-     * Restrictions: For a complete list of restrictions, see: {@link topic:2c641481649f44de9c1c22c9c3c49d13
-     * Spreadsheet Export Restrictions}
+     * Restrictions: For a complete list of restrictions, see: {@link https://ui5.sap.com/#/topic/2c641481649f44de9c1c22c9c3c49d13 Spreadsheet Export Restrictions}
      *
      * You can export only the primitive cell data types that are listed in {@link sap.ui.export.EdmType}. Icons,
      * images, check boxes, and complex controls in UI5 table cells are not supported.
@@ -473,7 +486,7 @@ declare module "sap/ui/export/Spreadsheet" {
      * The properties sheetName and metaSheetName on the workbook.context object are limited to 31 characters
      * each. If their value exceeds this maximum length, the value will be truncated.
      * See:
-     * 	{@link topic:2691788a08fc43f7bf269ea7c6336caf Spreadsheet}
+     * 	{@link https://ui5.sap.com/#/topic/2691788a08fc43f7bf269ea7c6336caf Spreadsheet}
      */
     constructor(
       /**
@@ -567,7 +580,7 @@ declare module "sap/ui/export/Spreadsheet" {
     );
 
     /**
-     * @SINCE 1.61
+     * @since 1.61
      *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.Spreadsheet#event:beforeSave} event of
      * this `sap.ui.export.Spreadsheet`.
@@ -593,7 +606,7 @@ declare module "sap/ui/export/Spreadsheet" {
       oListener?: object
     ): this;
     /**
-     * @SINCE 1.61
+     * @since 1.61
      *
      * Attaches event handler `fnFunction` to the {@link sap.ui.export.Spreadsheet#event:beforeSave} event of
      * this `sap.ui.export.Spreadsheet`.
@@ -614,7 +627,7 @@ declare module "sap/ui/export/Spreadsheet" {
       oListener?: object
     ): this;
     /**
-     * @SINCE 1.52
+     * @since 1.52
      *
      * Cancels a running export process. This method does nothing if no export is running.
      *
@@ -622,7 +635,7 @@ declare module "sap/ui/export/Spreadsheet" {
      */
     cancel(): this;
     /**
-     * @SINCE 1.61
+     * @since 1.61
      *
      * Detaches event handler `fnFunction` from the {@link sap.ui.export.Spreadsheet beforeSave} event of this
      * `sap.ui.export.Spreadsheet`.
@@ -641,7 +654,7 @@ declare module "sap/ui/export/Spreadsheet" {
       oListener?: object
     ): this;
     /**
-     * @SINCE 1.112
+     * @since 1.112
      *
      * Returns the specific MIME type
      *
@@ -649,7 +662,7 @@ declare module "sap/ui/export/Spreadsheet" {
      */
     getMimeType(): string;
     /**
-     * @SINCE 1.73
+     * @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.
@@ -664,6 +677,16 @@ declare module "sap/ui/export/Spreadsheet" {
       oDataSource: string | any[] | Object | ListBinding | TreeBinding
     ): object | null;
   }
+
+  export interface Spreadsheet$BeforeSaveEventParameters {}
+
+  /**
+   * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Spreadsheet$BeforeSaveEventParameters'
+   * in 1.115.1 and any later releases.
+   */
+  export type $SpreadsheetBeforeSaveEventParameters = Spreadsheet$BeforeSaveEventParameters;
+
+  export type Spreadsheet$BeforeSaveEvent = Event<Spreadsheet$BeforeSaveEventParameters>;
 }
 
 declare module "sap/ui/export/util/Filter" {
@@ -674,7 +697,7 @@ declare module "sap/ui/export/util/Filter" {
   import SimpleType from "sap/ui/model/SimpleType";
 
   /**
-   * @SINCE 1.110
+   * @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
@@ -757,7 +780,7 @@ declare module "sap/ui/export/util/Filter" {
      */
     static getMetadata(): Metadata;
     /**
-     * @SINCE 1.110
+     * @since 1.110
      *
      * Returns the filter label if available. Otherwise the name of the filter property will be returned.
      *
@@ -765,7 +788,7 @@ declare module "sap/ui/export/util/Filter" {
      */
     getLabel(): string;
     /**
-     * @SINCE 1.110
+     * @since 1.110
      *
      * Returns the technical name of the property on which the filter is applied.
      *
@@ -773,7 +796,7 @@ declare module "sap/ui/export/util/Filter" {
      */
     getProperty(): string;
     /**
-     * @SINCE 1.110
+     * @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
@@ -783,7 +806,7 @@ declare module "sap/ui/export/util/Filter" {
      */
     getValue(): string;
     /**
-     * @SINCE 1.110
+     * @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
@@ -802,7 +825,7 @@ declare module "sap/ui/export/util/Filter" {
       fnFormat: Function
     ): void;
     /**
-     * @SINCE 1.110
+     * @since 1.110
      *
      * Takes the given string as label of the filter.
      */
@@ -813,7 +836,7 @@ declare module "sap/ui/export/util/Filter" {
       sLabel: string
     ): void;
     /**
-     * @SINCE 1.110
+     * @since 1.110
      *
      * Uses the given `sap.ui.model.SimpleType` instance to format the filter values accordingly.
      */