@openui5/types 1.124.2 → 1.126.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.124.2
282
+ // For Library Version: 1.126.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -3163,7 +3163,7 @@ declare module "sap/base/util/ObjectPath" {
3163
3163
  * is returned.
3164
3164
  *
3165
3165
  * The provided object path is used to navigate through the nested objects, starting with the root context.
3166
- * If no root context is provided, the object path begins with `window`.
3166
+ * If no root context is provided, the object path begins with `globalThis`.
3167
3167
  *
3168
3168
  *
3169
3169
  * @returns Returns the value located in the provided path, or `undefined` if the path does not exist completely.
@@ -13616,28 +13616,48 @@ declare module "sap/ui/core/library" {
13616
13616
  /**
13617
13617
  * Marker interface for controls that can serve as a menu for a table column header.
13618
13618
  *
13619
- * Implementation of this interface implements the `openBy` and `getAriaHasPopupType` methods.
13619
+ * Implementation of this interface should include the `openBy`, `close`, `isOpen` and `getAriaHasPopupType`
13620
+ * methods and fire the `beforeOpen` and `afterClose` events.
13621
+ *
13622
+ * Refer to the base class {@link sap.m.table.columnmenu.MenuBase} for a detailed API description.
13620
13623
  *
13621
13624
  * @since 1.98
13622
- * @experimental (since 1.98)
13623
13625
  */
13624
13626
  export interface IColumnHeaderMenu {
13625
13627
  __implements__sap_ui_core_IColumnHeaderMenu: boolean;
13626
13628
 
13627
13629
  /**
13628
- * Returns the sap.ui.core.aria.HasPopup<\code> type of the menu.
13630
+ * Closes the menu.
13631
+ *
13632
+ * @since 1.126
13633
+ */
13634
+ close(): void;
13635
+ /**
13636
+ * Returns the `sap.ui.core.aria.HasPopup` type of the menu.
13629
13637
  *
13630
13638
  * @since 1.98.0
13631
- * @experimental (since 1.98)
13632
13639
  *
13633
- * @returns sap.ui.core.aria.HasPopup<\code> type of the menu
13640
+ * @returns `sap.ui.core.aria.HasPopup` type of the menu
13634
13641
  */
13635
13642
  getAriaHasPopupType(): aria.HasPopup | keyof typeof aria.HasPopup;
13643
+ /**
13644
+ * Determines whether the menu is open.
13645
+ *
13646
+ * @since 1.126
13647
+ *
13648
+ * @returns `true` if the menu is open, `false` otherwise
13649
+ */
13650
+ isOpen(
13651
+ /**
13652
+ * The element for which the menu is opened. If it is an `HTMLElement`, the closest control is passed for
13653
+ * this event (if it exists).
13654
+ */
13655
+ openBy: UI5Element
13656
+ ): boolean;
13636
13657
  /**
13637
13658
  * Opens the menu using the column header.
13638
13659
  *
13639
13660
  * @since 1.98
13640
- * @experimental (since 1.98)
13641
13661
  */
13642
13662
  openBy(
13643
13663
  /**
@@ -15152,7 +15172,11 @@ declare module "sap/ui/core/Component" {
15152
15172
  */
15153
15173
  export default abstract class Component extends ManagedObject {
15154
15174
  /**
15155
- * Creates and initializes a new Component with the given `sId` and settings.
15175
+ * As `Component` is an abstract base class for components, applications should not call the constructor.
15176
+ * For many use cases the static {@link #.create Component.create} factory can be used to instantiate a
15177
+ * `Component`. Depending on the requirements, the framework also provides other ways to instantiate a `Component`,
15178
+ * documented under the {@link https://ui5.sap.com/#/topic/958ead51e2e94ab8bcdc90fb7e9d53d0 "Component" }
15179
+ * chapter.
15156
15180
  *
15157
15181
  * The set of allowed entries in the `mSettings` object depends on the concrete subclass and is described
15158
15182
  * there. See {@link sap.ui.core.Component} for a general description of this argument.
@@ -15171,7 +15195,11 @@ declare module "sap/ui/core/Component" {
15171
15195
  mSettings?: $ComponentSettings
15172
15196
  );
15173
15197
  /**
15174
- * Creates and initializes a new Component with the given `sId` and settings.
15198
+ * As `Component` is an abstract base class for components, applications should not call the constructor.
15199
+ * For many use cases the static {@link #.create Component.create} factory can be used to instantiate a
15200
+ * `Component`. Depending on the requirements, the framework also provides other ways to instantiate a `Component`,
15201
+ * documented under the {@link https://ui5.sap.com/#/topic/958ead51e2e94ab8bcdc90fb7e9d53d0 "Component" }
15202
+ * chapter.
15175
15203
  *
15176
15204
  * The set of allowed entries in the `mSettings` object depends on the concrete subclass and is described
15177
15205
  * there. See {@link sap.ui.core.Component} for a general description of this argument.
@@ -19363,22 +19391,28 @@ declare module "sap/ui/core/Core" {
19363
19391
  import Interface from "sap/ui/base/Interface";
19364
19392
 
19365
19393
  /**
19366
- * Core Class of the SAP UI Library.
19394
+ * Singleton Core instance of the SAP UI Library.
19367
19395
  *
19368
- * This class boots the Core framework and makes it available for the application by requiring `sap.ui.core.Core`.
19396
+ * The module export of `sap/ui/core/Core` is **not** a class, but the singleton Core instance itself. The
19397
+ * `sap.ui.core.Core` class itself must not be instantiated, except by the framework itself.
19369
19398
  *
19370
- * The Core provides a {@link #ready ready function} to execute code after the core was booted.
19399
+ * The Core provides a {@link #ready ready function} to execute code after the Core was booted.
19371
19400
  *
19372
19401
  * Example:
19373
19402
  * ```javascript
19374
19403
  *
19375
19404
  *
19376
- * oCore.ready(function() {
19405
+ * sap.ui.require(["sap/ui/core/Core"], async function(Core) {
19406
+ *
19407
+ * // Usage of a callback function
19408
+ * Core.ready(function() {
19377
19409
  * ...
19378
- * });
19410
+ * });
19379
19411
  *
19380
- * await oCore.ready();
19381
- * ...
19412
+ * // Usage of Core.ready() as a Promise
19413
+ * await Core.ready();
19414
+ * ...
19415
+ * });
19382
19416
  *
19383
19417
  * ```
19384
19418
  */
@@ -20739,7 +20773,8 @@ declare module "sap/ui/core/Core" {
20739
20773
  */
20740
20774
  notifyContentDensityChanged(): void;
20741
20775
  /**
20742
- * Returns a Promise that resolves if the Core is initialized.
20776
+ * Returns a Promise that resolves if the Core is initialized. Additionally, a callback function can be
20777
+ * passed, for use cases where using Promises is not an option.
20743
20778
  *
20744
20779
  * @since 1.118.0
20745
20780
  *
@@ -22097,6 +22132,26 @@ declare module "sap/ui/core/dnd/DragDropBase" {
22097
22132
  * @returns Value of property `groupName`
22098
22133
  */
22099
22134
  getGroupName(): string;
22135
+ /**
22136
+ * Gets current value of property {@link #getKeyboardHandling keyboardHandling}.
22137
+ *
22138
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
22139
+ * reordering.
22140
+ *
22141
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
22142
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
22143
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
22144
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
22145
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
22146
+ * cases, this property must not be set to `true`.
22147
+ *
22148
+ * Default value is `false`.
22149
+ *
22150
+ * @since 1.126
22151
+ *
22152
+ * @returns Value of property `keyboardHandling`
22153
+ */
22154
+ getKeyboardHandling(): boolean;
22100
22155
  /**
22101
22156
  * Sets a new value for property {@link #getEnabled enabled}.
22102
22157
  *
@@ -22133,6 +22188,33 @@ declare module "sap/ui/core/dnd/DragDropBase" {
22133
22188
  */
22134
22189
  sGroupName?: string
22135
22190
  ): this;
22191
+ /**
22192
+ * Sets a new value for property {@link #getKeyboardHandling keyboardHandling}.
22193
+ *
22194
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
22195
+ * reordering.
22196
+ *
22197
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
22198
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
22199
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
22200
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
22201
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
22202
+ * cases, this property must not be set to `true`.
22203
+ *
22204
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22205
+ *
22206
+ * Default value is `false`.
22207
+ *
22208
+ * @since 1.126
22209
+ *
22210
+ * @returns Reference to `this` in order to allow method chaining
22211
+ */
22212
+ setKeyboardHandling(
22213
+ /**
22214
+ * New value for property `keyboardHandling`
22215
+ */
22216
+ bKeyboardHandling?: boolean
22217
+ ): this;
22136
22218
  }
22137
22219
  /**
22138
22220
  * Describes the settings that can be provided to the DragDropBase constructor.
@@ -22150,6 +22232,21 @@ declare module "sap/ui/core/dnd/DragDropBase" {
22150
22232
  * @since 1.56
22151
22233
  */
22152
22234
  enabled?: boolean | PropertyBindingInfo | `{${string}}`;
22235
+
22236
+ /**
22237
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
22238
+ * reordering.
22239
+ *
22240
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
22241
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
22242
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
22243
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
22244
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
22245
+ * cases, this property must not be set to `true`.
22246
+ *
22247
+ * @since 1.126
22248
+ */
22249
+ keyboardHandling?: boolean | PropertyBindingInfo | `{${string}}`;
22153
22250
  }
22154
22251
  }
22155
22252
 
@@ -22938,24 +23035,32 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
22938
23035
  * Returns the dragged control, if available within the same UI5 application frame.
22939
23036
  *
22940
23037
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23038
+ *
23039
+ * @returns The dragged control
22941
23040
  */
22942
23041
  getDragControl(): UI5Element | null;
22943
23042
  /**
22944
23043
  * The valid drop target underneath the dragged control.
22945
23044
  *
22946
23045
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23046
+ *
23047
+ * @returns The drop target
22947
23048
  */
22948
23049
  getDropControl(): UI5Element | null;
22949
23050
  /**
22950
23051
  * Returns the drop configuration corresponding to the drop control.
22951
23052
  *
22952
23053
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23054
+ *
23055
+ * @returns The drop configuration
22953
23056
  */
22954
23057
  getDropInfo(): DropInfo | null;
22955
23058
  /**
22956
23059
  * Returns the calculated position of the drop action relative to the valid dropped control.
22957
23060
  *
22958
23061
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23062
+ *
23063
+ * @returns The calculated position
22959
23064
  */
22960
23065
  getDropPosition():
22961
23066
  | dnd.RelativeDropPosition
@@ -23011,11 +23116,16 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
23011
23116
  sData: string
23012
23117
  ): void;
23013
23118
  /**
23014
- * Set the valid drop control.
23119
+ * Set the valid target.
23015
23120
  *
23016
23121
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23017
23122
  */
23018
- setDropControl(): void;
23123
+ setDropControl(
23124
+ /**
23125
+ * The dropped target
23126
+ */
23127
+ oControl: UI5Element
23128
+ ): void;
23019
23129
  /**
23020
23130
  * Defines the visual configuration of the drop indicator for the current `DropInfo`.
23021
23131
  *
@@ -23346,17 +23456,20 @@ declare module "sap/ui/core/dnd/DropInfo" {
23346
23456
  /**
23347
23457
  * Fires event {@link #event:dragOver dragOver} to attached listeners.
23348
23458
  *
23459
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
23460
+ * event object. The return value of this method indicates whether the default action should be executed.
23461
+ *
23349
23462
  * @since 1.56
23350
23463
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23351
23464
  *
23352
- * @returns Reference to `this` in order to allow method chaining
23465
+ * @returns Whether or not to prevent the default action
23353
23466
  */
23354
23467
  fireDragOver(
23355
23468
  /**
23356
23469
  * Parameters to pass along with the event
23357
23470
  */
23358
23471
  mParameters?: DropInfo$DragOverEventParameters
23359
- ): this;
23472
+ ): boolean;
23360
23473
  /**
23361
23474
  * Fires event {@link #event:drop drop} to attached listeners.
23362
23475
  *
@@ -23555,6 +23668,13 @@ declare module "sap/ui/core/dnd/DropInfo" {
23555
23668
  */
23556
23669
  dragSession?: DragSession;
23557
23670
 
23671
+ /**
23672
+ * The calculated position of the drop action relative to the `target`
23673
+ */
23674
+ dropPosition?:
23675
+ | dnd.RelativeDropPosition
23676
+ | keyof typeof dnd.RelativeDropPosition;
23677
+
23558
23678
  /**
23559
23679
  * The underlying browser event
23560
23680
  */
@@ -28077,55 +28197,6 @@ declare module "sap/ui/core/hyphenation/Hyphenation" {
28077
28197
  * @returns Metadata object describing this class
28078
28198
  */
28079
28199
  static getMetadata(): ManagedObjectMetadata;
28080
- /**
28081
- * Attaches event handler `fnFunction` to the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
28082
- *
28083
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
28084
- * otherwise it will be bound to this `sap.ui.core.hyphenation.Hyphenation` itself.
28085
- *
28086
- * Fired if an error with initialization or hyphenation occurs.
28087
- *
28088
- *
28089
- * @returns Reference to `this` in order to allow method chaining
28090
- */
28091
- attachError(
28092
- /**
28093
- * An application-specific payload object that will be passed to the event handler along with the event
28094
- * object when firing the event
28095
- */
28096
- oData: object,
28097
- /**
28098
- * The function to be called when the event occurs
28099
- */
28100
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
28101
- /**
28102
- * Context object to call the event handler with. Defaults to this `sap.ui.core.hyphenation.Hyphenation`
28103
- * itself
28104
- */
28105
- oListener?: object
28106
- ): this;
28107
- /**
28108
- * Attaches event handler `fnFunction` to the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
28109
- *
28110
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
28111
- * otherwise it will be bound to this `sap.ui.core.hyphenation.Hyphenation` itself.
28112
- *
28113
- * Fired if an error with initialization or hyphenation occurs.
28114
- *
28115
- *
28116
- * @returns Reference to `this` in order to allow method chaining
28117
- */
28118
- attachError(
28119
- /**
28120
- * The function to be called when the event occurs
28121
- */
28122
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
28123
- /**
28124
- * Context object to call the event handler with. Defaults to this `sap.ui.core.hyphenation.Hyphenation`
28125
- * itself
28126
- */
28127
- oListener?: object
28128
- ): this;
28129
28200
  /**
28130
28201
  * Checks if native hyphenation works in the current browser for the given language. This check is performed
28131
28202
  * against the value of the "lang" HTML attribute of the page.
@@ -28153,37 +28224,6 @@ declare module "sap/ui/core/hyphenation/Hyphenation" {
28153
28224
  */
28154
28225
  sLang?: string
28155
28226
  ): boolean | null;
28156
- /**
28157
- * Detaches event handler `fnFunction` from the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
28158
- *
28159
- * The passed function and listener object must match the ones used for event registration.
28160
- *
28161
- *
28162
- * @returns Reference to `this` in order to allow method chaining
28163
- */
28164
- detachError(
28165
- /**
28166
- * The function to be called, when the event occurs
28167
- */
28168
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
28169
- /**
28170
- * Context object on which the given function had to be called
28171
- */
28172
- oListener?: object
28173
- ): this;
28174
- /**
28175
- * Fires event {@link #event:error error} to attached listeners.
28176
- *
28177
- * @ui5-protected Do not call from applications (only from related classes in the framework)
28178
- *
28179
- * @returns Reference to `this` in order to allow method chaining
28180
- */
28181
- fireError(
28182
- /**
28183
- * Parameters to pass along with the event
28184
- */
28185
- mParameters?: Hyphenation$ErrorEventParameters
28186
- ): this;
28187
28227
  /**
28188
28228
  * What languages were initialized with {@link sap.ui.core.hyphenation.Hyphenation#initialize Hyphenation#initialize}
28189
28229
  *
@@ -28255,12 +28295,7 @@ declare module "sap/ui/core/hyphenation/Hyphenation" {
28255
28295
  /**
28256
28296
  * Describes the settings that can be provided to the Hyphenation constructor.
28257
28297
  */
28258
- export interface $HyphenationSettings extends $ManagedObjectSettings {
28259
- /**
28260
- * Fired if an error with initialization or hyphenation occurs.
28261
- */
28262
- error?: (oEvent: Hyphenation$ErrorEvent) => void;
28263
- }
28298
+ export interface $HyphenationSettings extends $ManagedObjectSettings {}
28264
28299
 
28265
28300
  /**
28266
28301
  * Parameters of the Hyphenation#error event.
@@ -30967,7 +31002,8 @@ declare module "sap/ui/core/LocaleData" {
30967
31002
  import Metadata from "sap/ui/base/Metadata";
30968
31003
 
30969
31004
  /**
30970
- * Provides access to locale-specific data, such as date formats, number formats, and currencies.
31005
+ * Provides access to locale-specific data, such as date formats, number formats, and currencies. For more
31006
+ * information on terminology, such as field names used in the methods of this class, see {@link https://cldr.unicode.org/ Unicode CLDR}.
30971
31007
  */
30972
31008
  export default class LocaleData extends BaseObject {
30973
31009
  /**
@@ -31029,7 +31065,7 @@ declare module "sap/ui/core/LocaleData" {
31029
31065
  */
31030
31066
  firstDayStartsFirstWeek(): boolean;
31031
31067
  /**
31032
- * Returns the defined pattern for representing the calendar week number.
31068
+ * Returns the pattern for representing the calendar week number in the given style.
31033
31069
  *
31034
31070
  * @since 1.32.0
31035
31071
  *
@@ -31037,16 +31073,18 @@ declare module "sap/ui/core/LocaleData" {
31037
31073
  */
31038
31074
  getCalendarWeek(
31039
31075
  /**
31040
- * the style of the pattern. It can only be either "wide" or "narrow".
31076
+ * the style of the pattern
31041
31077
  */
31042
- sStyle: string,
31078
+ sStyle: "narrow" | "wide",
31043
31079
  /**
31044
31080
  * the week number
31045
31081
  */
31046
31082
  iWeekNumber: int
31047
31083
  ): string;
31048
31084
  /**
31049
- * Get combined datetime pattern with given date and time style.
31085
+ * Get combined datetime pattern with given date and time style. The combined datetime pattern is the datetime
31086
+ * pattern as returned by {@link #getDateTimePattern}, where date and time placeholder are replaced with
31087
+ * the corresponding patterns for the given styles.
31050
31088
  *
31051
31089
  *
31052
31090
  * @returns the combined datetime pattern
@@ -31055,11 +31093,11 @@ declare module "sap/ui/core/LocaleData" {
31055
31093
  /**
31056
31094
  * the required style for the date part
31057
31095
  */
31058
- sDateStyle: string,
31096
+ sDateStyle: "full" | "long" | "medium" | "short",
31059
31097
  /**
31060
31098
  * the required style for the time part
31061
31099
  */
31062
- sTimeStyle: string,
31100
+ sTimeStyle: "full" | "long" | "medium" | "short",
31063
31101
  /**
31064
31102
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31065
31103
  * or calculated from locale.
@@ -31115,28 +31153,29 @@ declare module "sap/ui/core/LocaleData" {
31115
31153
  sCurrency: string
31116
31154
  ): int;
31117
31155
  /**
31118
- * Returns the short currency formats (like 1K USD, 1M USD....).
31156
+ * Returns the short currency format (like 1K USD, 1M USD....) of the given number in the given style and
31157
+ * plural category.
31119
31158
  *
31120
31159
  * @since 1.51.0
31121
31160
  *
31122
- * @returns decimal format
31161
+ * @returns the short currency format
31123
31162
  */
31124
31163
  getCurrencyFormat(
31125
31164
  /**
31126
- * short
31165
+ * the style
31127
31166
  */
31128
- sStyle: string,
31167
+ sStyle: "short",
31129
31168
  /**
31130
- * 1000, 10000 ...
31169
+ * the number in string representation as power of ten, for example "1000" or "10000"
31131
31170
  */
31132
31171
  sNumber: string,
31133
31172
  /**
31134
- * one or other (if not exists other is used)
31173
+ * the plural category; defaults to "other" if the given plural category does not exist for this locale
31135
31174
  */
31136
- sPlural: string
31175
+ sPlural?: "few" | "many" | "one" | "other" | "two" | "zero"
31137
31176
  ): string;
31138
31177
  /**
31139
- * Get currency format pattern.
31178
+ * Get currency format pattern for the given context.
31140
31179
  *
31141
31180
  * CLDR format pattern:
31142
31181
  * See:
@@ -31147,9 +31186,9 @@ declare module "sap/ui/core/LocaleData" {
31147
31186
  */
31148
31187
  getCurrencyPattern(
31149
31188
  /**
31150
- * the context of the currency pattern (standard or accounting)
31189
+ * the context of the currency pattern
31151
31190
  */
31152
- sContext: string
31191
+ sContext: "accounting" | "standard"
31153
31192
  ): string;
31154
31193
  /**
31155
31194
  * Returns the currency symbol for the specified currency, if no symbol is found the ISO 4217 currency code
@@ -31234,7 +31273,7 @@ declare module "sap/ui/core/LocaleData" {
31234
31273
  sCalendarType?: CalendarType
31235
31274
  ): string | string[];
31236
31275
  /**
31237
- * Get date pattern in format "short", "medium", "long" or "full".
31276
+ * Get date pattern in the given style.
31238
31277
  *
31239
31278
  *
31240
31279
  * @returns the selected date pattern
@@ -31243,7 +31282,7 @@ declare module "sap/ui/core/LocaleData" {
31243
31282
  /**
31244
31283
  * the required style for the date pattern
31245
31284
  */
31246
- sStyle: string,
31285
+ sStyle: "full" | "long" | "medium" | "short",
31247
31286
  /**
31248
31287
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31249
31288
  * or calculated from locale.
@@ -31251,7 +31290,7 @@ declare module "sap/ui/core/LocaleData" {
31251
31290
  sCalendarType?: CalendarType
31252
31291
  ): string;
31253
31292
  /**
31254
- * Get datetime pattern in style "short", "medium", "long" or "full".
31293
+ * Get datetime pattern in the given style.
31255
31294
  *
31256
31295
  *
31257
31296
  * @returns the selected datetime pattern
@@ -31260,7 +31299,7 @@ declare module "sap/ui/core/LocaleData" {
31260
31299
  /**
31261
31300
  * the required style for the datetime pattern
31262
31301
  */
31263
- sStyle: string,
31302
+ sStyle: "full" | "long" | "medium" | "short",
31264
31303
  /**
31265
31304
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31266
31305
  * or calculated from locale.
@@ -31268,7 +31307,7 @@ declare module "sap/ui/core/LocaleData" {
31268
31307
  sCalendarType?: CalendarType
31269
31308
  ): string;
31270
31309
  /**
31271
- * Get day periods in width "narrow", "abbreviated" or "wide".
31310
+ * Get day periods in the given width.
31272
31311
  *
31273
31312
  *
31274
31313
  * @returns array of day periods (AM, PM)
@@ -31277,15 +31316,15 @@ declare module "sap/ui/core/LocaleData" {
31277
31316
  /**
31278
31317
  * the required width for the day period names
31279
31318
  */
31280
- sWidth: string,
31319
+ sWidth: "abbreviated" | "narrow" | "wide",
31281
31320
  /**
31282
31321
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31283
31322
  * or calculated from locale.
31284
31323
  */
31285
31324
  sCalendarType?: CalendarType
31286
- ): any[];
31325
+ ): string[];
31287
31326
  /**
31288
- * Get standalone day periods in width "narrow", "abbreviated" or "wide".
31327
+ * Get standalone day periods in the given width.
31289
31328
  *
31290
31329
  *
31291
31330
  * @returns array of day periods (AM, PM)
@@ -31294,15 +31333,15 @@ declare module "sap/ui/core/LocaleData" {
31294
31333
  /**
31295
31334
  * the required width for the day period names
31296
31335
  */
31297
- sWidth: string,
31336
+ sWidth: "abbreviated" | "narrow" | "wide",
31298
31337
  /**
31299
31338
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31300
31339
  * or calculated from locale.
31301
31340
  */
31302
31341
  sCalendarType?: CalendarType
31303
- ): any[];
31342
+ ): string[];
31304
31343
  /**
31305
- * Get day names in width "narrow", "abbreviated" or "wide".
31344
+ * Get day names in the given width.
31306
31345
  *
31307
31346
  *
31308
31347
  * @returns array of day names (starting with Sunday)
@@ -31311,15 +31350,15 @@ declare module "sap/ui/core/LocaleData" {
31311
31350
  /**
31312
31351
  * the required width for the day names
31313
31352
  */
31314
- sWidth: string,
31353
+ sWidth: "abbreviated" | "narrow" | "short" | "wide",
31315
31354
  /**
31316
31355
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31317
31356
  * or calculated from locale.
31318
31357
  */
31319
31358
  sCalendarType?: CalendarType
31320
- ): any[];
31359
+ ): string[];
31321
31360
  /**
31322
- * Get standalone day names in width "narrow", "abbreviated" or "wide".
31361
+ * Get standalone day names in the given width.
31323
31362
  *
31324
31363
  *
31325
31364
  * @returns array of day names (starting with Sunday)
@@ -31328,33 +31367,34 @@ declare module "sap/ui/core/LocaleData" {
31328
31367
  /**
31329
31368
  * the required width for the day names
31330
31369
  */
31331
- sWidth: string,
31370
+ sWidth: "abbreviated" | "narrow" | "short" | "wide",
31332
31371
  /**
31333
31372
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31334
31373
  * or calculated from locale.
31335
31374
  */
31336
31375
  sCalendarType?: CalendarType
31337
- ): any[];
31376
+ ): string[];
31338
31377
  /**
31339
- * Returns the short decimal formats (like 1K, 1M....).
31378
+ * Returns the short decimal format (like 1K, 1M....) of the given number in the given style and plural
31379
+ * category.
31340
31380
  *
31341
31381
  * @since 1.25.0
31342
31382
  *
31343
- * @returns decimal format
31383
+ * @returns the short decimal format
31344
31384
  */
31345
31385
  getDecimalFormat(
31346
31386
  /**
31347
- * short or long
31387
+ * the style
31348
31388
  */
31349
- sStyle: string,
31389
+ sStyle: "long" | "short",
31350
31390
  /**
31351
- * 1000, 10000 ...
31391
+ * the number in string representation as power of ten, for example "1000" or "10000"
31352
31392
  */
31353
31393
  sNumber: string,
31354
31394
  /**
31355
- * one or other (if not exists other is used)
31395
+ * the plural category; defaults to "other" if the given plural category does not exist for this locale
31356
31396
  */
31357
- sPlural: string
31397
+ sPlural?: "one" | "other"
31358
31398
  ): string;
31359
31399
  /**
31360
31400
  * Get decimal format pattern.
@@ -31364,7 +31404,7 @@ declare module "sap/ui/core/LocaleData" {
31364
31404
  */
31365
31405
  getDecimalPattern(): string;
31366
31406
  /**
31367
- * Returns the display name for a time unit (second, minute, hour, day, week, month, year).
31407
+ * Returns the display name for a time unit of the given type.
31368
31408
  *
31369
31409
  * @since 1.34.0
31370
31410
  *
@@ -31372,13 +31412,24 @@ declare module "sap/ui/core/LocaleData" {
31372
31412
  */
31373
31413
  getDisplayName(
31374
31414
  /**
31375
- * Type (second, minute, hour, day, week, month, year)
31415
+ * the type
31376
31416
  */
31377
- sType: string,
31417
+ sType:
31418
+ | "day"
31419
+ | "era"
31420
+ | "hour"
31421
+ | "minute"
31422
+ | "month"
31423
+ | "quarter"
31424
+ | "second"
31425
+ | "week"
31426
+ | "weekday"
31427
+ | "year"
31428
+ | "zone",
31378
31429
  /**
31379
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31430
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31380
31431
  */
31381
- sStyle?: string
31432
+ sStyle?: "narrow" | "short" | "wide"
31382
31433
  ): string;
31383
31434
  /**
31384
31435
  * Returns the map of era IDs to era dates.
@@ -31392,9 +31443,9 @@ declare module "sap/ui/core/LocaleData" {
31392
31443
  * the type of calendar
31393
31444
  */
31394
31445
  sCalendarType?: CalendarType
31395
- ): any[];
31446
+ ): object[];
31396
31447
  /**
31397
- * Returns array of eras.
31448
+ * Returns array of eras in the given width.
31398
31449
  *
31399
31450
  * @since 1.32.0
31400
31451
  *
@@ -31402,14 +31453,15 @@ declare module "sap/ui/core/LocaleData" {
31402
31453
  */
31403
31454
  getEras(
31404
31455
  /**
31405
- * the style of the era name. It can be 'wide', 'abbreviated' or 'narrow'
31456
+ * the width of the era name
31406
31457
  */
31407
- sWidth: string,
31458
+ sWidth: "abbreviated" | "narrow" | "wide",
31408
31459
  /**
31409
- * the type of calendar
31460
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
31461
+ * locale
31410
31462
  */
31411
31463
  sCalendarType?: CalendarType
31412
- ): any[];
31464
+ ): string[];
31413
31465
  /**
31414
31466
  * Returns the day that usually is regarded as the first day of a week in the current locale.
31415
31467
  *
@@ -31472,16 +31524,16 @@ declare module "sap/ui/core/LocaleData" {
31472
31524
  */
31473
31525
  getLanguages(): Record<string, string>;
31474
31526
  /**
31475
- * Get lenient number symbols for "plusSign" or "minusSign".
31527
+ * Get lenient symbols for the sign of a number for the given symbol type.
31476
31528
  *
31477
31529
  *
31478
- * @returns the selected lenient number symbols, e.g. "-‒⁻₋−➖﹣"
31530
+ * @returns the selected lenient symbols for the sign of a number, e.g. "-‒⁻₋−➖﹣"
31479
31531
  */
31480
31532
  getLenientNumberSymbols(
31481
31533
  /**
31482
31534
  * the required type of symbol
31483
31535
  */
31484
- sType: string
31536
+ sType: "minusSign" | "plusSign"
31485
31537
  ): string;
31486
31538
  /**
31487
31539
  * Returns the required minimal number of days for the first week of a year.
@@ -31499,19 +31551,19 @@ declare module "sap/ui/core/LocaleData" {
31499
31551
  */
31500
31552
  getMinimalDaysInFirstWeek(): int;
31501
31553
  /**
31502
- * Get miscellaneous pattern.
31554
+ * Get miscellaneous pattern for the given name.
31503
31555
  *
31504
31556
  *
31505
31557
  * @returns The pattern
31506
31558
  */
31507
31559
  getMiscPattern(
31508
31560
  /**
31509
- * the name of the misc pattern, can be "approximately", "atLeast", "atMost" or "range"
31561
+ * the name of the misc pattern
31510
31562
  */
31511
- sName: string
31563
+ sName: "approximately" | "atLeast" | "atMost" | "range"
31512
31564
  ): string;
31513
31565
  /**
31514
- * Get month names in width "narrow", "abbreviated" or "wide".
31566
+ * Get month names in the given width.
31515
31567
  *
31516
31568
  *
31517
31569
  * @returns The array of month names
@@ -31520,14 +31572,15 @@ declare module "sap/ui/core/LocaleData" {
31520
31572
  /**
31521
31573
  * The required width for the month names
31522
31574
  */
31523
- sWidth: "narrow" | "abbreviated" | "wide",
31575
+ sWidth: "abbreviated" | "narrow" | "wide",
31524
31576
  /**
31525
- * The type of calendar; defaults to the calendar type either set in configuration or calculated from locale
31577
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
31578
+ * locale
31526
31579
  */
31527
31580
  sCalendarType?: CalendarType
31528
31581
  ): string[];
31529
31582
  /**
31530
- * Get standalone month names in width "narrow", "abbreviated" or "wide".
31583
+ * Get standalone month names in the given width.
31531
31584
  *
31532
31585
  *
31533
31586
  * @returns The array of standalone month names
@@ -31536,14 +31589,15 @@ declare module "sap/ui/core/LocaleData" {
31536
31589
  /**
31537
31590
  * The required width for the month names
31538
31591
  */
31539
- sWidth: "narrow" | "abbreviated" | "wide",
31592
+ sWidth: "abbreviated" | "narrow" | "wide",
31540
31593
  /**
31541
- * The type of calendar; defaults to the calendar type either set in configuration or calculated from locale
31594
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
31595
+ * locale
31542
31596
  */
31543
31597
  sCalendarType?: CalendarType
31544
31598
  ): string[];
31545
31599
  /**
31546
- * Get number symbol "decimal", "group", "plusSign", "minusSign", "percentSign".
31600
+ * Get number symbol for the given type.
31547
31601
  *
31548
31602
  *
31549
31603
  * @returns the selected number symbol
@@ -31552,15 +31606,15 @@ declare module "sap/ui/core/LocaleData" {
31552
31606
  /**
31553
31607
  * the required type of symbol
31554
31608
  */
31555
- sType: string
31609
+ sType: "decimal" | "group" | "minusSign" | "percentSign" | "plusSign"
31556
31610
  ): string;
31557
31611
  /**
31558
- * Get orientation (left-to-right or right-to-left).
31612
+ * Gets the text orientation.
31559
31613
  *
31560
31614
  *
31561
- * @returns character orientation for this locale
31615
+ * @returns text orientation
31562
31616
  */
31563
- getOrientation(): string;
31617
+ getOrientation(): "left-to-right" | "right-to-left";
31564
31618
  /**
31565
31619
  * Get percent format pattern.
31566
31620
  *
@@ -31575,7 +31629,7 @@ declare module "sap/ui/core/LocaleData" {
31575
31629
  *
31576
31630
  * @returns The array of plural categories
31577
31631
  */
31578
- getPluralCategories(): any[];
31632
+ getPluralCategories(): string[];
31579
31633
  /**
31580
31634
  * Returns the plural category (zero, one, two, few, many or other) for the given number value. The number
31581
31635
  * must be passed as an unformatted number string with dot as decimal separator (for example "12345.67").
@@ -31609,15 +31663,15 @@ declare module "sap/ui/core/LocaleData" {
31609
31663
  */
31610
31664
  getPreferredCalendarType(): CalendarType;
31611
31665
  /**
31612
- * Returns the preferred hour pattern symbol (h for 12, H for 24 hours) for the current locale.
31666
+ * Returns the preferred hour pattern symbol ("h" for 12, "H" for 24 hours) for the current locale.
31613
31667
  *
31614
31668
  * @since 1.34
31615
31669
  *
31616
31670
  * @returns the preferred hour symbol
31617
31671
  */
31618
- getPreferredHourSymbol(): string;
31672
+ getPreferredHourSymbol(): "h" | "H";
31619
31673
  /**
31620
- * Get quarter names in width "narrow", "abbreviated" or "wide".
31674
+ * Get quarter names in the given width.
31621
31675
  *
31622
31676
  *
31623
31677
  * @returns array of quarters
@@ -31626,15 +31680,15 @@ declare module "sap/ui/core/LocaleData" {
31626
31680
  /**
31627
31681
  * the required width for the quarter names
31628
31682
  */
31629
- sWidth: string,
31683
+ sWidth: "abbreviated" | "narrow" | "wide",
31630
31684
  /**
31631
31685
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31632
31686
  * or calculated from locale.
31633
31687
  */
31634
31688
  sCalendarType?: CalendarType
31635
- ): any[];
31689
+ ): string[];
31636
31690
  /**
31637
- * Get standalone quarter names in width "narrow", "abbreviated" or "wide".
31691
+ * Get standalone quarter names in the given width.
31638
31692
  *
31639
31693
  *
31640
31694
  * @returns array of quarters
@@ -31643,13 +31697,13 @@ declare module "sap/ui/core/LocaleData" {
31643
31697
  /**
31644
31698
  * the required width for the quarter names
31645
31699
  */
31646
- sWidth: string,
31700
+ sWidth: "abbreviated" | "narrow" | "wide",
31647
31701
  /**
31648
31702
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31649
31703
  * or calculated from locale.
31650
31704
  */
31651
31705
  sCalendarType?: CalendarType
31652
- ): any[];
31706
+ ): string[];
31653
31707
  /**
31654
31708
  * Returns the relative day resource pattern (like "Today", "Yesterday", "{0} days ago") based on the given
31655
31709
  * difference of days (0 means today, 1 means tomorrow, -1 means yesterday, ...).
@@ -31664,9 +31718,9 @@ declare module "sap/ui/core/LocaleData" {
31664
31718
  */
31665
31719
  iDiff: int,
31666
31720
  /**
31667
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31721
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31668
31722
  */
31669
- sStyle?: string
31723
+ sStyle?: "narrow" | "short" | "wide"
31670
31724
  ): string;
31671
31725
  /**
31672
31726
  * Returns the relative resource pattern with unit 'hour' (like "in {0} hour(s)", "{0} hour(s) ago" under
@@ -31687,9 +31741,9 @@ declare module "sap/ui/core/LocaleData" {
31687
31741
  */
31688
31742
  iDiff: int,
31689
31743
  /**
31690
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31744
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31691
31745
  */
31692
- sStyle?: string
31746
+ sStyle?: "narrow" | "short" | "wide"
31693
31747
  ): string | null;
31694
31748
  /**
31695
31749
  * Returns the relative resource pattern with unit 'minute' (like "in {0} minute(s)", "{0} minute(s) ago"
@@ -31709,9 +31763,9 @@ declare module "sap/ui/core/LocaleData" {
31709
31763
  */
31710
31764
  iDiff: int,
31711
31765
  /**
31712
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31766
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31713
31767
  */
31714
- sStyle?: string
31768
+ sStyle?: "narrow" | "short" | "wide"
31715
31769
  ): string | null;
31716
31770
  /**
31717
31771
  * Returns the relative month resource pattern (like "This month", "Last month", "{0} months ago") based
@@ -31727,9 +31781,9 @@ declare module "sap/ui/core/LocaleData" {
31727
31781
  */
31728
31782
  iDiff: int,
31729
31783
  /**
31730
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31784
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31731
31785
  */
31732
- sStyle?: string
31786
+ sStyle?: "narrow" | "short" | "wide"
31733
31787
  ): string;
31734
31788
  /**
31735
31789
  * Returns the relative format pattern with given scale (year, month, week, ...) and difference value.
@@ -31742,7 +31796,7 @@ declare module "sap/ui/core/LocaleData" {
31742
31796
  /**
31743
31797
  * the scale the relative pattern is needed for
31744
31798
  */
31745
- sScale: string,
31799
+ sScale: "day" | "hour" | "minute" | "month" | "second" | "week" | "year",
31746
31800
  /**
31747
31801
  * the difference in the given scale unit
31748
31802
  */
@@ -31752,9 +31806,9 @@ declare module "sap/ui/core/LocaleData" {
31752
31806
  */
31753
31807
  bFuture?: boolean,
31754
31808
  /**
31755
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31809
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31756
31810
  */
31757
- sStyle?: string
31811
+ sStyle?: "narrow" | "short" | "wide"
31758
31812
  ): string;
31759
31813
  /**
31760
31814
  * Returns relative time patterns for the given scales as an array of objects containing scale, value and
@@ -31782,12 +31836,14 @@ declare module "sap/ui/core/LocaleData" {
31782
31836
  /**
31783
31837
  * The scales for which the available patterns should be returned
31784
31838
  */
31785
- aScales: string[],
31839
+ aScales: Array<
31840
+ "day" | "hour" | "minute" | "month" | "second" | "week" | "year"
31841
+ >,
31786
31842
  /**
31787
- * Since 1.32.10 and 1.34.4, the style of the scale patterns; valid values are "wide", "short" and "narrow"
31843
+ * Since 1.32.10 and 1.34.4, the style of the scale patterns
31788
31844
  */
31789
- sStyle?: string
31790
- ): object[];
31845
+ sStyle?: "narrow" | "short" | "wide"
31846
+ ): RelativeTimePattern[];
31791
31847
  /**
31792
31848
  * Returns the relative resource pattern with unit 'second' (like now, "in {0} seconds", "{0} seconds ago"
31793
31849
  * under locale 'en') based on the given difference value (0 means now, positive value means in the future
@@ -31803,9 +31859,9 @@ declare module "sap/ui/core/LocaleData" {
31803
31859
  */
31804
31860
  iDiff: int,
31805
31861
  /**
31806
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31862
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31807
31863
  */
31808
- sStyle?: string
31864
+ sStyle?: "narrow" | "short" | "wide"
31809
31865
  ): string;
31810
31866
  /**
31811
31867
  * Returns the relative week resource pattern (like "This week", "Last week", "{0} weeks ago") based on
@@ -31821,9 +31877,9 @@ declare module "sap/ui/core/LocaleData" {
31821
31877
  */
31822
31878
  iDiff: int,
31823
31879
  /**
31824
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31880
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31825
31881
  */
31826
- sStyle?: string
31882
+ sStyle?: "narrow" | "short" | "wide"
31827
31883
  ): string;
31828
31884
  /**
31829
31885
  * Returns the relative year resource pattern (like "This year", "Last year", "{0} year ago") based on the
@@ -31839,9 +31895,9 @@ declare module "sap/ui/core/LocaleData" {
31839
31895
  */
31840
31896
  iDiff: int,
31841
31897
  /**
31842
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31898
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31843
31899
  */
31844
- sStyle?: string
31900
+ sStyle?: "narrow" | "short" | "wide"
31845
31901
  ): string;
31846
31902
  /**
31847
31903
  * Retrieves the unit format pattern for a specific unit name considering the unit mappings.
@@ -31850,14 +31906,15 @@ declare module "sap/ui/core/LocaleData" {
31850
31906
  *
31851
31907
  * @since 1.54
31852
31908
  *
31853
- * @returns The unit format configuration for the given unit name
31909
+ * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
31910
+ * to the corresponding pattern
31854
31911
  */
31855
31912
  getResolvedUnitFormat(
31856
31913
  /**
31857
31914
  * unit name, e.g. "duration-hour" or "my"
31858
31915
  */
31859
31916
  sUnit: string
31860
- ): object;
31917
+ ): Record<string, string>;
31861
31918
  /**
31862
31919
  * Gets locale-specific script names, as available in the CLDR raw data.
31863
31920
  *
@@ -31880,16 +31937,16 @@ declare module "sap/ui/core/LocaleData" {
31880
31937
  */
31881
31938
  getTerritories(): Record<string, string>;
31882
31939
  /**
31883
- * Get time pattern in style "short", "medium", "long" or "full".
31940
+ * Get time pattern in the given style.
31884
31941
  *
31885
31942
  *
31886
31943
  * @returns the selected time pattern
31887
31944
  */
31888
31945
  getTimePattern(
31889
31946
  /**
31890
- * the required style for the date pattern
31947
+ * the required style for the time pattern
31891
31948
  */
31892
- sStyle: string,
31949
+ sStyle: "full" | "long" | "medium" | "short",
31893
31950
  /**
31894
31951
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31895
31952
  * or calculated from locale.
@@ -31911,30 +31968,34 @@ declare module "sap/ui/core/LocaleData" {
31911
31968
  sUnit: string
31912
31969
  ): string;
31913
31970
  /**
31914
- * Retrieves the unit format pattern for a specific unit name.
31971
+ * Retrieves the unit format pattern for a specific unit name, see {@link #getResolvedUnitFormat} for an
31972
+ * example of a unit format pattern.
31915
31973
  *
31916
31974
  * Note: Does not take unit mapping into consideration.
31917
31975
  *
31918
31976
  * @since 1.54
31919
31977
  *
31920
- * @returns The unit format configuration for the given unit name
31978
+ * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
31979
+ * to the corresponding pattern
31921
31980
  */
31922
31981
  getUnitFormat(
31923
31982
  /**
31924
31983
  * unit name, e.g. "duration-hour"
31925
31984
  */
31926
31985
  sUnit: string
31927
- ): object;
31986
+ ): Record<string, string>;
31928
31987
  /**
31929
- * Retrieves all unit format patterns merged.
31988
+ * Retrieves unit format patterns for all units see {@link #getResolvedUnitFormat} for an example of a unit
31989
+ * format pattern.
31930
31990
  *
31931
31991
  * Note: Does not take unit mapping into consideration.
31932
31992
  *
31933
31993
  * @since 1.54
31934
31994
  *
31935
- * @returns The unit format patterns
31995
+ * @returns The unit format patterns as a map from a unit key to a map from a pattern key like `"unitPattern-count-other"`
31996
+ * to the corresponding pattern
31936
31997
  */
31937
- getUnitFormats(): object;
31998
+ getUnitFormats(): Record<string, Record<string, string>>;
31938
31999
  /**
31939
32000
  * Looks up the unit from defined unit mapping. E.g. for defined unit mapping ` { "my": "my-custom-unit",
31940
32001
  * "cm": "length-centimeter" } `
@@ -31978,6 +32039,23 @@ declare module "sap/ui/core/LocaleData" {
31978
32039
  */
31979
32040
  getWeekendStart(): int;
31980
32041
  }
32042
+ /**
32043
+ * A relative time pattern.
32044
+ */
32045
+ export type RelativeTimePattern = {
32046
+ /**
32047
+ * The string with the locale-specific representation of the relative time pattern
32048
+ */
32049
+ pattern: string;
32050
+ /**
32051
+ * The scale of the pattern
32052
+ */
32053
+ scale: "day" | "hour" | "minute" | "month" | "second" | "week" | "year";
32054
+ /**
32055
+ * `-1`, if the pattern is for the past; `1` otherwise
32056
+ */
32057
+ sign: number;
32058
+ };
31981
32059
  }
31982
32060
 
31983
32061
  declare module "sap/ui/core/Manifest" {
@@ -45563,7 +45641,11 @@ declare module "sap/ui/core/UIComponent" {
45563
45641
  */
45564
45642
  export default abstract class UIComponent extends Component {
45565
45643
  /**
45566
- * Creates and initializes a new UIComponent with the given `sId` and settings.
45644
+ * As `UIComponent` is an abstract base class for UI components, applications should not call the constructor.
45645
+ * For many use cases the static {@link sap.ui.core.Component.create Component.create} factory can be used
45646
+ * to instantiate a `UIComponent`. Depending on the requirements, the framework also provides other ways
45647
+ * to instantiate a `UIComponent`, documented under the {@link https://ui5.sap.com/#/topic/958ead51e2e94ab8bcdc90fb7e9d53d0 "Component" }
45648
+ * chapter.
45567
45649
  *
45568
45650
  * The set of allowed entries in the `mSettings` object depends on the concrete subclass and is described
45569
45651
  * there. See {@link sap.ui.core.Component} for a general description of this argument.
@@ -45579,7 +45661,11 @@ declare module "sap/ui/core/UIComponent" {
45579
45661
  mSettings?: $UIComponentSettings
45580
45662
  );
45581
45663
  /**
45582
- * Creates and initializes a new UIComponent with the given `sId` and settings.
45664
+ * As `UIComponent` is an abstract base class for UI components, applications should not call the constructor.
45665
+ * For many use cases the static {@link sap.ui.core.Component.create Component.create} factory can be used
45666
+ * to instantiate a `UIComponent`. Depending on the requirements, the framework also provides other ways
45667
+ * to instantiate a `UIComponent`, documented under the {@link https://ui5.sap.com/#/topic/958ead51e2e94ab8bcdc90fb7e9d53d0 "Component" }
45668
+ * chapter.
45583
45669
  *
45584
45670
  * The set of allowed entries in the `mSettings` object depends on the concrete subclass and is described
45585
45671
  * there. See {@link sap.ui.core.Component} for a general description of this argument.
@@ -53280,24 +53366,6 @@ declare module "sap/ui/model/Binding" {
53280
53366
  */
53281
53367
  oEvents: Record<string, Function>
53282
53368
  ): Binding;
53283
- /**
53284
- * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
53285
- *
53286
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
53287
- * otherwise it will be bound to this `sap.ui.model.Binding` itself.
53288
- *
53289
- * @ui5-protected Do not call from applications (only from related classes in the framework)
53290
- */
53291
- attachRefresh(
53292
- /**
53293
- * The function to be called when the event occurs
53294
- */
53295
- fnFunction: Function,
53296
- /**
53297
- * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
53298
- */
53299
- oListener?: object
53300
- ): void;
53301
53369
  /**
53302
53370
  * Removes all control messages for this binding from {@link module:sap/ui/core/Messaging} in addition to
53303
53371
  * the standard clean-up tasks.
@@ -53390,21 +53458,6 @@ declare module "sap/ui/model/Binding" {
53390
53458
  */
53391
53459
  oEvents: Record<string, Function>
53392
53460
  ): Binding;
53393
- /**
53394
- * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
53395
- *
53396
- * @ui5-protected Do not call from applications (only from related classes in the framework)
53397
- */
53398
- detachRefresh(
53399
- /**
53400
- * The function to be called when the event occurs
53401
- */
53402
- fnFunction: Function,
53403
- /**
53404
- * Object on which to call the given function.
53405
- */
53406
- oListener?: object
53407
- ): void;
53408
53461
  /**
53409
53462
  * Fires event {@link #event:dataReceived dataReceived} to attached listeners.
53410
53463
  *
@@ -53675,6 +53728,25 @@ declare module "sap/ui/model/Binding" {
53675
53728
  Binding$DataStateChangeEventParameters,
53676
53729
  Binding
53677
53730
  >;
53731
+
53732
+ /**
53733
+ * Parameters of the Binding#refresh event.
53734
+ */
53735
+ export interface Binding$RefreshEventParameters {
53736
+ /**
53737
+ * A string stating the reason for the data change; some change reasons can be found in {@link sap.ui.model.ChangeReason},
53738
+ * but there may be additional reasons specified by a specific model implementation
53739
+ */
53740
+ reason?: string;
53741
+ }
53742
+
53743
+ /**
53744
+ * Event object of the Binding#refresh event.
53745
+ */
53746
+ export type Binding$RefreshEvent = Event<
53747
+ Binding$RefreshEventParameters,
53748
+ Binding
53749
+ >;
53678
53750
  }
53679
53751
 
53680
53752
  declare module "sap/ui/model/BindingMode" {
@@ -56053,9 +56125,11 @@ declare module "sap/ui/model/json/JSONModel" {
56053
56125
  /**
56054
56126
  * Constructor for a new JSONModel.
56055
56127
  *
56056
- * The observation feature is experimental! When observation is activated, the application can directly
56057
- * change the JS objects without the need to call setData, setProperty or refresh. Observation does only
56058
- * work for existing properties in the JSON, it cannot detect new properties or new array entries.
56128
+ * When observation is activated, the application can directly change the JS objects without the need to
56129
+ * call {@link sap.ui.model.json.JSONModel#setData}, {@link sap.ui.model.json.JSONModel#setProperty} or
56130
+ * {@link sap.ui.model.Model#refresh}. **Note:** Observation only works for existing properties in the JSON
56131
+ * model. Newly added or removed properties and newly added or removed array entries, for example, are not
56132
+ * detected.
56059
56133
  */
56060
56134
  constructor(
56061
56135
  /**
@@ -56063,7 +56137,7 @@ declare module "sap/ui/model/json/JSONModel" {
56063
56137
  */
56064
56138
  oData?: object | string,
56065
56139
  /**
56066
- * Whether to observe the JSON data for property changes (experimental)
56140
+ * Whether to observe the JSON data for property changes
56067
56141
  */
56068
56142
  bObserve?: boolean
56069
56143
  );
@@ -67264,8 +67338,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
67264
67338
  */
67265
67339
  useBatch?: boolean;
67266
67340
  /**
67267
- * Experimental - `true` when user credentials are to be included in a cross-origin request; please note
67268
- * that this only works if all requests are asynchronous
67341
+ * If set to `true`, the user credentials are included in a cross-origin request. **Note:** This only works
67342
+ * if all requests are asynchronous.
67269
67343
  */
67270
67344
  withCredentials?: boolean;
67271
67345
  /**
@@ -69326,7 +69400,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
69326
69400
  /**
69327
69401
  * Paths to be reset; if no array is passed, all changes are reset
69328
69402
  */
69329
- aPath?: any[],
69403
+ aPath?: string[],
69330
69404
  /**
69331
69405
  * Whether also deferred requests are taken into account so that they are aborted
69332
69406
  */
@@ -70973,9 +71047,9 @@ declare module "sap/ui/model/odata/v4/Context" {
70973
71047
  * depending on this context become unresolved, but no attempt is made to restore these bindings in case
70974
71048
  * of reset or failure.
70975
71049
  *
70976
- * Deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
70977
- * is supported (@experimental as of version 1.118.0). As a precondition, the context must not be {@link #setKeepAlive kept-alive }
70978
- * and hidden (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
71050
+ * Since 1.125.0, deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
71051
+ * is supported. As a precondition, the context must not be both {@link #setKeepAlive kept-alive} and hidden
71052
+ * (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
70979
71053
  * Such a deletion is not a pending change.
70980
71054
  * See:
70981
71055
  * #hasPendingChanges
@@ -71019,8 +71093,9 @@ declare module "sap/ui/model/odata/v4/Context" {
71019
71093
  ): Promise<void>;
71020
71094
  /**
71021
71095
  * Destroys this context, that is, it removes this context from all dependent bindings and drops references
71022
- * to binding and model, so that the context cannot be used anymore; it keeps path and index for debugging
71023
- * purposes.
71096
+ * to {@link #getBinding binding} and {@link #getModel model}, so that the context cannot be used anymore;
71097
+ * it keeps path and index for debugging purposes. A destroyed context can be recognized by calling {@link #getBinding},
71098
+ * which returns `undefined`.
71024
71099
  *
71025
71100
  * **BEWARE:** Do not call this function! The lifetime of an OData V4 context is completely controlled by
71026
71101
  * its binding.
@@ -71266,7 +71341,11 @@ declare module "sap/ui/model/odata/v4/Context" {
71266
71341
  *
71267
71342
  * The move potentially changes the {@link #getIndex index} of this context, of all of its descendants,
71268
71343
  * and of all other nodes affected by the move. Any index change can, however, only be observed reliably
71269
- * for this context itself.
71344
+ * for this context itself or (since 1.126.0) the next sibling's context if that is {@link #isKeepAlive kept alive }
71345
+ * or {@link #isSelected selected} (and the preconditions of {@link #setKeepAlive} hold). For a kept-alive
71346
+ * or selected next sibling, the index must be retrieved as soon as the returned promise resolves. If such
71347
+ * a next sibling is not one of the binding's {@link sap.ui.model.odata.v4.ODataListBinding#getCurrentContexts current contexts }
71348
+ * after the move, it is not in the collection anymore and thus loses its index pretty soon.
71270
71349
  *
71271
71350
  * The move changes the {@link https://ui5.sap.com/#/topic/c9723f8265f644af91c0ed941e114d46/section_CST context states }
71272
71351
  * of the nodes as follows:
@@ -71285,7 +71364,7 @@ declare module "sap/ui/model/odata/v4/Context" {
71285
71364
  * not be shown anymore due to the search or filter criteria. If the latter happens to this context, its
71286
71365
  * {@link #getIndex index} becomes `undefined`.
71287
71366
  *
71288
- * @experimental (since 1.119.0)
71367
+ * @since 1.125.0
71289
71368
  *
71290
71369
  * @returns A promise which is resolved without a defined result when the move is finished, or rejected
71291
71370
  * in case of an error
@@ -71296,12 +71375,12 @@ declare module "sap/ui/model/odata/v4/Context" {
71296
71375
  */
71297
71376
  oParameters: {
71298
71377
  /**
71299
- * The next sibling's context, or `null` to turn this node into the last sibling (since 1.124.0). Omitting
71300
- * the sibling moves this node to a position determined by the server.
71378
+ * The next sibling's context, or `null` to turn this node into the last sibling. Omitting the sibling moves
71379
+ * this node to a position determined by the server.
71301
71380
  */
71302
71381
  nextSibling?: Context | null;
71303
71382
  /**
71304
- * The new parent's context, or (since 1.121.0) `null` to turn this node into a root node
71383
+ * The new parent's context, or `null` to turn this node into a root node
71305
71384
  */
71306
71385
  parent: Context | null;
71307
71386
  }
@@ -71632,16 +71711,20 @@ declare module "sap/ui/model/odata/v4/Context" {
71632
71711
  bRetry?: boolean
71633
71712
  ): Promise<void>;
71634
71713
  /**
71635
- * Sets whether this context is currently selected. While a context is currently {@link #delete deleted }
71714
+ * Sets whether this context is currently selected. If the selection state changes, a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
71715
+ * event is fired on the list binding which this context belongs to. While a context is currently {@link #delete deleted }
71636
71716
  * on the client, it does not appear as {@link #isSelected selected}. If the preconditions of {@link #setKeepAlive }
71637
71717
  * hold, a best effort is made to implicitly keep a selected context alive in order to preserve the selection
71638
71718
  * state. Once the selection is no longer needed, for example because you perform an operation on this context
71639
71719
  * which logically removes it from its list, you need to reset the selection.
71640
71720
  *
71641
71721
  * If this context is a header context of a list binding, the new selection state is propagated to all row
71642
- * contexts. This method can be called repeatedly with the same value to again select all row contexts.
71643
- * For example, if a row context was deselected explicitly, it is selected again by selecting the header
71644
- * context (even if the header context is already selected).
71722
+ * contexts. If the selection state of this header context changes, a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
71723
+ * event is fired for this header context. This method can be called repeatedly with the same value to again
71724
+ * select all row contexts. For example, if a row context was deselected explicitly, it is selected again
71725
+ * by selecting the header context (even if the header context is already selected). If the selection state
71726
+ * of any row context changes in this way, then a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
71727
+ * event is nevertheless fired for this header context, but not for the row context.
71645
71728
  *
71646
71729
  * **Note:** It is unsafe to keep a reference to a context instance which is not {@link #isKeepAlive kept alive}.
71647
71730
  * See:
@@ -72329,17 +72412,16 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72329
72412
  Binding$ChangeEventParameters,
72330
72413
  Binding$DataReceivedEventParameters,
72331
72414
  Binding$DataRequestedEventParameters,
72415
+ Binding$RefreshEventParameters,
72332
72416
  } from "sap/ui/model/Binding";
72333
72417
 
72334
72418
  import Event from "sap/ui/base/Event";
72335
72419
 
72336
- import ChangeReason from "sap/ui/model/ChangeReason";
72337
-
72338
72420
  /**
72339
72421
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
72340
72422
  * events: 'AggregatedDataStateChange', 'change', 'createActivate', 'createCompleted', 'createSent', 'dataReceived',
72341
- * 'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
72342
- * error is thrown.
72423
+ * 'dataRequested', 'DataStateChange', 'selectionChanged', 'patchCompleted', 'patchSent', and 'refresh'.
72424
+ * For other events, an error is thrown.
72343
72425
  *
72344
72426
  * @since 1.37.0
72345
72427
  */
@@ -72570,14 +72652,24 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72570
72652
  * has been read or if the system query option `$count` is `true` and the binding has processed at least
72571
72653
  * one request.
72572
72654
  *
72573
- * Creating a new child beneath an existing and visible parent node (which must either be a leaf or expanded,
72574
- * but not collapsed) is supported (@experimental as of version 1.117.0) in case of a recursive hierarchy
72575
- * (see {@link #setAggregation}). The parent node must be identified via an {@link sap.ui.model.odata.v4.Context }
72576
- * instance given as `oInitialData["@$ui5.node.parent"]` (which is immediately removed from the new child's
72577
- * data). It can be `null` or absent when creating a new root node (@experimental as of version 1.120.0).
72578
- * `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other creation or {@link sap.ui.model.odata.v4.Context#move move }
72579
- * must be pending, and no other modification (including collapse of some ancestor node) must happen while
72580
- * this creation is pending!
72655
+ * Since 1.125.0, creating a new child beneath an existing and visible parent node (which must either be
72656
+ * a leaf or expanded, but not collapsed) is supported in case of a recursive hierarchy (see {@link #setAggregation}).
72657
+ * The parent node must be identified via an {@link sap.ui.model.odata.v4.Context} instance given as `oInitialData["@$ui5.node.parent"]`
72658
+ * (which is immediately removed from the new child's data). It can be `null` or absent when creating a
72659
+ * new root node. `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
72660
+ * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
72661
+ * (including collapse of some ancestor node) must happen while this creation is pending!
72662
+ *
72663
+ * When using the `createInPlace` parameter (see {@link #setAggregation}, @experimental as of version 1.125.0),
72664
+ * the new {@link sap.ui.model.odata.v4.Context#isTransient transient} child is hidden until its {@link sap.ui.model.odata.v4.Context#created created promise }
72665
+ * resolves, and then it is shown at a position determined by the back end and the current sort order. Note
72666
+ * that the returned context is not always part of this list binding's collection and can only be used for
72667
+ * the following scenarios:
72668
+ * The position of the new child can be retrieved by using its {@link sap.ui.model.odata.v4.Context#getIndex index}.
72669
+ * If the created child does not become part of the hierarchy due to the search or filter criteria, the
72670
+ * context will be {@link sap.ui.model.odata.v4.Context#destroy destroyed} and its {@link sap.ui.model.odata.v4.Context#getIndex index }
72671
+ * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
72672
+ * which can be used for {@link #getKeepAliveContext}.
72581
72673
  *
72582
72674
  * @since 1.43.0
72583
72675
  *
@@ -72765,7 +72857,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72765
72857
  getAggregation(
72766
72858
  /**
72767
72859
  * Whether to additionally return the "$"-prefixed values described below which obviously cannot be given
72768
- * back to the setter (@experimental as of version 1.111.0). They are retrieved from the pair of "Org.OData.Aggregation.V1.RecursiveHierarchy"
72860
+ * back to the setter (since 1.125.0). They are retrieved from the pair of "Org.OData.Aggregation.V1.RecursiveHierarchy"
72769
72861
  * and "com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy" annotations at this binding's entity type,
72770
72862
  * identified via the `hierarchyQualifier` given to {@link #setAggregation}.
72771
72863
  * "$DistanceFromRoot" holds the path to the property which provides the raw value for "@$ui5.node.level"
@@ -72921,7 +73013,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72921
73013
  * it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
72922
73014
  * data and a request for its entity is sent.
72923
73015
  * See:
72924
- * sap.ui.model.odata.v4.Model#getKeepAliveContext
73016
+ * sap.ui.model.odata.v4.ODataModel#getKeepAliveContext
72925
73017
  *
72926
73018
  * @since 1.99.0
72927
73019
  *
@@ -73218,14 +73310,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73218
73310
  * An object holding the information needed for data aggregation; see also OData
73219
73311
  * Extension for Data Aggregation Version 4.0. Since 1.76.0, `undefined` can be used to remove the data
73220
73312
  * aggregation object, which allows to set `$apply` explicitly afterwards. `null` is not supported.
73221
- * Since 1.89.0, the deprecated property `"grandTotal like 1.84" : true` can be used to turn on the handling
73222
- * of grand totals like in 1.84.0, using aggregates of aggregates and thus allowing to filter by aggregated
73223
- * properties while grand totals are needed. Beware that methods like "average" or "countdistinct" are not
73224
- * compatible with this approach, and it cannot be combined with group levels.
73225
- * Since 1.105.0, either a recursive hierarchy or pure data aggregation is supported, but no mix; `hierarchyQualifier`
73226
- * is the leading property that decides between those two use cases - this is an **experimental API** and
73227
- * is only supported if the model uses the `autoExpandSelect` parameter! Since 1.117.0, it is available
73228
- * for read-only hierarchies.
73313
+ * Since 1.89.0, the **deprecated** property `"grandTotal like 1.84" : true` can be used to turn on the
73314
+ * handling of grand totals like in 1.84.0, using aggregates of aggregates and thus allowing to filter by
73315
+ * aggregated properties while grand totals are needed. Beware that methods like "average" or "countdistinct"
73316
+ * are not compatible with this approach, and it cannot be combined with group levels.
73317
+ * Since 1.117.0, either a read-only recursive hierarchy or pure data aggregation is supported, but no
73318
+ * mix; `hierarchyQualifier` is the leading property that decides between those two use cases. Since 1.125.0,
73319
+ * maintenance of a recursive hierarchy is supported.
73229
73320
  */
73230
73321
  oAggregation?: {
73231
73322
  /**
@@ -73245,12 +73336,17 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73245
73336
  * `CASE WHEN MIN(Unit) = MAX(Unit) THEN MIN(Unit) END`)
73246
73337
  */
73247
73338
  aggregate?: object;
73339
+ /**
73340
+ * Whether created nodes are shown in place at the position specified by the service (@experimental as of
73341
+ * version 1.125.0); only the value `true` is allowed. Otherwise, created nodes are displayed out of place
73342
+ * as the first child of their parent.
73343
+ */
73344
+ createInPlace?: boolean;
73248
73345
  /**
73249
73346
  * The number (as a positive integer) of different levels initially available without calling {@link sap.ui.model.odata.v4.Context#expand }
73250
- * (@experimental as of version 1.105.0; available for read-only hierarchies since 1.117.0), supported only
73251
- * if a `hierarchyQualifier` is given. Root nodes are on the first level. By default, only root nodes are
73252
- * available; they are not yet expanded. Since 1.120.0, `expandTo >= Number.MAX_SAFE_INTEGER` can be used
73253
- * to expand all levels (`1E16` is recommended inside XML views for simplicity).
73347
+ * (since 1.117.0), supported only if a `hierarchyQualifier` is given. Root nodes are on the first level.
73348
+ * By default, only root nodes are available; they are not yet expanded. Since 1.120.0, `expandTo >= Number.MAX_SAFE_INTEGER`
73349
+ * can be used to expand all levels (`1E16` is recommended inside XML views for simplicity).
73254
73350
  */
73255
73351
  expandTo?: number;
73256
73352
  /**
@@ -73275,12 +73371,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73275
73371
  groupLevels?: string[];
73276
73372
  /**
73277
73373
  * The qualifier for the pair of "Org.OData.Aggregation.V1.RecursiveHierarchy" and "com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy"
73278
- * annotations at this binding's entity type (@experimental as of version 1.105.0; available for read-only
73279
- * hierarchies since 1.117.0). If present, a recursive hierarchy without data aggregation is defined, and
73280
- * the only other supported properties are `expandTo` and `search`. A recursive hierarchy cannot be combined
73281
- * with:
73282
- * "$search", the `vGroup` parameter of {@link sap.ui.model.Sorter} (since 1.107.0), shared
73283
- * requests (since 1.108.0).
73374
+ * annotations at this binding's entity type (since 1.117.0). If present, a recursive hierarchy without
73375
+ * data aggregation is defined, and the only other supported properties are `createInPlace`, `expandTo`,
73376
+ * and `search`. A recursive hierarchy cannot be combined with:
73377
+ * "$search", the `vGroup` parameter of {@link sap.ui.model.Sorter}, shared requests.
73284
73378
  */
73285
73379
  hierarchyQualifier?: string;
73286
73380
  /**
@@ -73592,22 +73686,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73592
73686
  /**
73593
73687
  * Parameters of the ODataListBinding#refresh event.
73594
73688
  */
73595
- export interface ODataListBinding$RefreshEventParameters {
73596
- /**
73597
- * The reason for the 'refresh' event could be
73598
- * {@link sap.ui.model.ChangeReason.Context Context} when the binding's parent context is changed,
73599
- * {@link sap.ui.model.ChangeReason.Filter Filter} on {@link #filter} and {@link #setAggregation},
73600
- * {@link sap.ui.model.ChangeReason.Refresh Refresh} on {@link #refresh}, or when the binding is initialized,
73601
- * {@link sap.ui.model.ChangeReason.Sort Sort} on {@link #sort}. {@link #changeParameters} leads
73602
- * to {@link sap.ui.model.ChangeReason.Filter Filter} if one of the parameters '$filter' and '$search' is
73603
- * changed, otherwise it leads to {@link sap.ui.model.ChangeReason.Sort Sort} if the parameter '$orderby'
73604
- * is changed; in other cases, it leads to {@link sap.ui.model.ChangeReason.Change Change}.
73605
- * If APIs that would normally fire change events have been called while the binding is suspended, {@link #resume }
73606
- * leads to the "strongest" change reason in the order {@link sap.ui.model.ChangeReason.Filter Filter},
73607
- * {@link sap.ui.model.ChangeReason.Sort Sort}, {@link sap.ui.model.ChangeReason.Refresh Refresh}, {@link sap.ui.model.ChangeReason.Change Change}.
73608
- */
73609
- reason?: ChangeReason;
73610
- }
73689
+ export interface ODataListBinding$RefreshEventParameters
73690
+ extends Binding$RefreshEventParameters {}
73611
73691
 
73612
73692
  /**
73613
73693
  * Event object of the ODataListBinding#refresh event.
@@ -73616,6 +73696,28 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73616
73696
  ODataListBinding$RefreshEventParameters,
73617
73697
  ODataListBinding
73618
73698
  >;
73699
+
73700
+ /**
73701
+ * Parameters of the ODataListBinding#selectionChanged event.
73702
+ *
73703
+ * @experimental (since 1.126.0)
73704
+ */
73705
+ export interface ODataListBinding$SelectionChangedEventParameters {
73706
+ /**
73707
+ * The context for which {@link sap.ui.model.odata.v4.Context#setSelected} was called
73708
+ */
73709
+ context?: boolean;
73710
+ }
73711
+
73712
+ /**
73713
+ * Event object of the ODataListBinding#selectionChanged event.
73714
+ *
73715
+ * @experimental (since 1.126.0)
73716
+ */
73717
+ export type ODataListBinding$SelectionChangedEvent = Event<
73718
+ ODataListBinding$SelectionChangedEventParameters,
73719
+ ODataListBinding
73720
+ >;
73619
73721
  }
73620
73722
 
73621
73723
  declare module "sap/ui/model/odata/v4/ODataMetaModel" {
@@ -74122,7 +74224,7 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
74122
74224
  * must refer to a function in `mParameters.scope` in case of a relative name starting with a dot, which
74123
74225
  * is stripped before lookup; see the `<template:alias>` instruction for XML Templating. In case of an
74124
74226
  * absolute name, it is searched in `mParameters.scope` first and then in the global namespace. (Using the
74125
- * global namespace is deprecated as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
74227
+ * global namespace is **deprecated** as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
74126
74228
  * default to {@link #requestCurrencyCodes} and {@link #requestUnitsOfMeasure} resp. if not present in `mParameters.scope`.
74127
74229
  * This function is called with the current object (or primitive value) and additional details and returns
74128
74230
  * the result of this {@link #requestObject} call. The additional details are given as an object with the
@@ -74231,8 +74333,8 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
74231
74333
  /**
74232
74334
  * Scope for lookup of aliases for computed annotations (since 1.43.0) as a map from alias to a module (like
74233
74335
  * `{AH : AnnotationHelper}`) or function (like `{format : AnnotationHelper.format}`); the alias must not
74234
- * contain a dot. Since 1.120.3 looking up a computed annotation via its global name is deprecated; always
74235
- * use this scope instead.
74336
+ * contain a dot. Since 1.120.3 looking up a computed annotation via its global name is **deprecated**;
74337
+ * always use this scope instead.
74236
74338
  */
74237
74339
  scope?: Record<string, object | Function>;
74238
74340
  }
@@ -74549,10 +74651,10 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
74549
74651
  */
74550
74652
  supportReferences?: boolean;
74551
74653
  /**
74654
+ * **deprecated:** As of Version 1.110.0, this parameter is obsolete; see also {@link https://ui5.sap.com/#/topic/648e360fa22d46248ca783dc6eb44531 Data Reuse }
74552
74655
  * (Controls synchronization between different bindings which refer to the same data for the case data changes
74553
74656
  * in one binding. Must be set to 'None' which means bindings are not synchronized at all; all other values
74554
- * are not supported and lead to an error.) **deprecated:** As of Version 1.110.0, this parameter is obsolete;
74555
- * see also {@link https://ui5.sap.com/#/topic/648e360fa22d46248ca783dc6eb44531 Data Reuse}
74657
+ * are not supported and lead to an error.)
74556
74658
  */
74557
74659
  synchronizationMode?: string;
74558
74660
  /**
@@ -74921,6 +75023,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
74921
75023
  * If the target type specified in the corresponding control property's binding info is "any" and the binding
74922
75024
  * is relative or points to metadata, the binding may have an object value; in this case and unless the
74923
75025
  * binding refers to an action advertisement the binding's mode must be {@link sap.ui.model.BindingMode.OneTime}.
75026
+ * {@link sap.ui.model.BindingMode.OneWay OneWay} is also supported (@experimental as of version 1.126.0),
75027
+ * but client-side updates of the object are not supported and `$$patchWithoutSideEffects` should be used
75028
+ * for the parent entity.
74924
75029
  * See:
74925
75030
  * sap.ui.base.ManagedObject#bindProperty
74926
75031
  * sap.ui.model.Model#bindProperty
@@ -75043,7 +75148,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
75043
75148
  * are not supported.
75044
75149
  *
75045
75150
  * It is possible to create binding contexts pointing to metadata. A '##' is recognized as separator in
75046
- * the resolved path and splits it into two parts; note that '#' may also be used as separator but is deprecated
75151
+ * the resolved path and splits it into two parts; note that '#' may also be used as separator but is **deprecated**
75047
75152
  * since 1.51. The part before the separator is transformed into a metadata context (see {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}).
75048
75153
  * The part following the separator is then interpreted relative to this metadata context, even if it starts
75049
75154
  * with a '/'; a trailing '/' is allowed here, see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject }
@@ -76545,7 +76650,7 @@ declare module "sap/ui/model/resource/ResourceModel" {
76545
76650
  */
76546
76651
  activeTerminologies?: string[];
76547
76652
  /**
76548
- * Whether the language bundle should be loaded asynchronously
76653
+ * **Deprecated as of Version 1.125**; always use asynchronous loading for performance reasons
76549
76654
  */
76550
76655
  async?: boolean;
76551
76656
  /**
@@ -86188,7 +86293,7 @@ declare namespace sap {
86188
86293
  sNamespace: string
86189
86294
  ): void;
86190
86295
  /**
86191
- * Ensures that a given a namespace or hierarchy of nested namespaces exists in the current `window`.
86296
+ * Ensures that a given a namespace or hierarchy of nested namespaces exists in the current `globalThis`.
86192
86297
  *
86193
86298
  * @deprecated (since 1.1) - see {@link topic:c78c07c094e04ccfaab659378a1707c7 Creating Control and Class Modules}.
86194
86299
  *
@@ -87388,6 +87493,10 @@ declare namespace sap {
87388
87493
 
87389
87494
  "sap/ui/core/ExtensionPoint": undefined;
87390
87495
 
87496
+ "sap/ui/core/fieldhelp/FieldHelp": undefined;
87497
+
87498
+ "sap/ui/core/fieldhelp/FieldHelpUtil": undefined;
87499
+
87391
87500
  "sap/ui/core/format/DateFormat": undefined;
87392
87501
 
87393
87502
  "sap/ui/core/format/DateFormatTimezoneDisplay": undefined;