@openui5/ts-types 1.125.0 → 1.126.1

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.125.0
282
+ // For Library Version: 1.126.1
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.
@@ -9353,7 +9353,7 @@ declare namespace sap {
9353
9353
  sNamespace: string
9354
9354
  ): void;
9355
9355
  /**
9356
- * Ensures that a given a namespace or hierarchy of nested namespaces exists in the current `window`.
9356
+ * Ensures that a given a namespace or hierarchy of nested namespaces exists in the current `globalThis`.
9357
9357
  *
9358
9358
  * @deprecated (since 1.1) - see {@link topic:c78c07c094e04ccfaab659378a1707c7 Creating Control and Class Modules}.
9359
9359
  *
@@ -16000,24 +16000,32 @@ declare namespace sap {
16000
16000
  * Returns the dragged control, if available within the same UI5 application frame.
16001
16001
  *
16002
16002
  * @ui5-protected Do not call from applications (only from related classes in the framework)
16003
+ *
16004
+ * @returns The dragged control
16003
16005
  */
16004
16006
  getDragControl(): sap.ui.core.Element | null;
16005
16007
  /**
16006
16008
  * The valid drop target underneath the dragged control.
16007
16009
  *
16008
16010
  * @ui5-protected Do not call from applications (only from related classes in the framework)
16011
+ *
16012
+ * @returns The drop target
16009
16013
  */
16010
16014
  getDropControl(): sap.ui.core.Element | null;
16011
16015
  /**
16012
16016
  * Returns the drop configuration corresponding to the drop control.
16013
16017
  *
16014
16018
  * @ui5-protected Do not call from applications (only from related classes in the framework)
16019
+ *
16020
+ * @returns The drop configuration
16015
16021
  */
16016
16022
  getDropInfo(): sap.ui.core.dnd.DropInfo | null;
16017
16023
  /**
16018
16024
  * Returns the calculated position of the drop action relative to the valid dropped control.
16019
16025
  *
16020
16026
  * @ui5-protected Do not call from applications (only from related classes in the framework)
16027
+ *
16028
+ * @returns The calculated position
16021
16029
  */
16022
16030
  getDropPosition(): sap.ui.core.dnd.RelativeDropPosition;
16023
16031
  /**
@@ -16071,11 +16079,16 @@ declare namespace sap {
16071
16079
  sData: string
16072
16080
  ): void;
16073
16081
  /**
16074
- * Set the valid drop control.
16082
+ * Set the valid target.
16075
16083
  *
16076
16084
  * @ui5-protected Do not call from applications (only from related classes in the framework)
16077
16085
  */
16078
- setDropControl(): void;
16086
+ setDropControl(
16087
+ /**
16088
+ * The dropped target
16089
+ */
16090
+ oControl: sap.ui.core.Element
16091
+ ): void;
16079
16092
  /**
16080
16093
  * Defines the visual configuration of the drop indicator for the current `DropInfo`.
16081
16094
  *
@@ -16135,6 +16148,24 @@ declare namespace sap {
16135
16148
  | boolean
16136
16149
  | sap.ui.base.ManagedObject.PropertyBindingInfo
16137
16150
  | `{${string}}`;
16151
+
16152
+ /**
16153
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
16154
+ * reordering.
16155
+ *
16156
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
16157
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
16158
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
16159
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
16160
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
16161
+ * cases, this property must not be set to `true`.
16162
+ *
16163
+ * @since 1.126
16164
+ */
16165
+ keyboardHandling?:
16166
+ | boolean
16167
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
16168
+ | `{${string}}`;
16138
16169
  }
16139
16170
 
16140
16171
  /**
@@ -16502,6 +16533,26 @@ declare namespace sap {
16502
16533
  * @returns Value of property `groupName`
16503
16534
  */
16504
16535
  getGroupName(): string;
16536
+ /**
16537
+ * Gets current value of property {@link #getKeyboardHandling keyboardHandling}.
16538
+ *
16539
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
16540
+ * reordering.
16541
+ *
16542
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
16543
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
16544
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
16545
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
16546
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
16547
+ * cases, this property must not be set to `true`.
16548
+ *
16549
+ * Default value is `false`.
16550
+ *
16551
+ * @since 1.126
16552
+ *
16553
+ * @returns Value of property `keyboardHandling`
16554
+ */
16555
+ getKeyboardHandling(): boolean;
16505
16556
  /**
16506
16557
  * Sets a new value for property {@link #getEnabled enabled}.
16507
16558
  *
@@ -16538,6 +16589,33 @@ declare namespace sap {
16538
16589
  */
16539
16590
  sGroupName?: string
16540
16591
  ): this;
16592
+ /**
16593
+ * Sets a new value for property {@link #getKeyboardHandling keyboardHandling}.
16594
+ *
16595
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
16596
+ * reordering.
16597
+ *
16598
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
16599
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
16600
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
16601
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
16602
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
16603
+ * cases, this property must not be set to `true`.
16604
+ *
16605
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16606
+ *
16607
+ * Default value is `false`.
16608
+ *
16609
+ * @since 1.126
16610
+ *
16611
+ * @returns Reference to `this` in order to allow method chaining
16612
+ */
16613
+ setKeyboardHandling(
16614
+ /**
16615
+ * New value for property `keyboardHandling`
16616
+ */
16617
+ bKeyboardHandling?: boolean
16618
+ ): this;
16541
16619
  }
16542
16620
  /**
16543
16621
  * Provides the configuration for drag-and-drop operations.
@@ -20988,14 +21066,64 @@ declare namespace sap {
20988
21066
  * **Note:** This static method is automatically propagated to subclasses of `ControllerExtension`.
20989
21067
  *
20990
21068
  *
20991
- * @returns A controller extension class
21069
+ * @returns The adapted controller extension class
20992
21070
  */
20993
- static override(
21071
+ static override<
21072
+ TheExtension extends new () => ControllerExtension,
21073
+ AddtlProps extends object,
21074
+ >(
21075
+ this: TheExtension,
20994
21076
  /**
20995
21077
  * The custom extension definition
20996
21078
  */
20997
- oExtension: Record<string, Function>
20998
- ): Function;
21079
+ customExtension: AddtlProps
21080
+ ): new () => InstanceType<TheExtension> & AddtlProps;
21081
+ /**
21082
+ * A marker method for applying controller extensions to controller class members in TypeScript code.
21083
+ * This method is only used to make TypeScript usage compatible to the UI5 runtime behavior, where an extension
21084
+ * *class* is assigned when the controller is defined, but each controller instance gets an *instance* of
21085
+ * this extension. This method call is removed in the class transformer when the ES class is transformed
21086
+ * to the traditional UI5 class definition syntax.
21087
+ *
21088
+ * To allow for proper removal, it may only be called directly on the base class `ControllerExtension`,
21089
+ * at the place where a controller extension is assigned to a member property of the new controller class.
21090
+ * The class transformation then removes this call. If it is not removed because it is used in any other
21091
+ * way, then it throws an error at runtime.
21092
+ *
21093
+ * Usage example:
21094
+ * ```javascript
21095
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
21096
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
21097
+ * ...
21098
+ * export default class App extends Controller {
21099
+ * routing = ControllerExtension.use(Routing);
21100
+ * ```
21101
+ *
21102
+ * Usage example with overriding extension callbacks:
21103
+ * ```javascript
21104
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
21105
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
21106
+ * ...
21107
+ * export default class App extends Controller {
21108
+ * routing = ControllerExtension.use(Routing.override({
21109
+ * ...
21110
+ * }));
21111
+ * ```
21112
+ *
21113
+ *
21114
+ *
21115
+ * @returns An instance of the given `ControllerExtension`. **NOTE:** this is only a dummy return type for
21116
+ * proper usage in TypeScript. This method does not actually return an instance of `ControllerExtension`,
21117
+ * but only throws an error at runtime. The sole purpose of this method is to mimic the actual runtime behavior
21118
+ * where a *class* is given when a controller is defined, but an *instance* is present in each controller
21119
+ * instance.
21120
+ */
21121
+ static use<TheExtension extends sap.ui.core.mvc.ControllerExtension>(
21122
+ /**
21123
+ * The ControllerExtension to use
21124
+ */
21125
+ extensionClass: new () => TheExtension
21126
+ ): TheExtension;
20999
21127
  /**
21000
21128
  * Returns an Element of the connected view with the given local ID.
21001
21129
  *
@@ -23677,12 +23805,7 @@ declare namespace sap {
23677
23805
  * Describes the settings that can be provided to the Hyphenation constructor.
23678
23806
  */
23679
23807
  interface $HyphenationSettings
23680
- extends sap.ui.base.$ManagedObjectSettings {
23681
- /**
23682
- * Fired if an error with initialization or hyphenation occurs.
23683
- */
23684
- error?: (oEvent: Hyphenation$ErrorEvent) => void;
23685
- }
23808
+ extends sap.ui.base.$ManagedObjectSettings {}
23686
23809
 
23687
23810
  /**
23688
23811
  * Parameters of the Hyphenation#error event.
@@ -23782,55 +23905,6 @@ declare namespace sap {
23782
23905
  * @returns Metadata object describing this class
23783
23906
  */
23784
23907
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
23785
- /**
23786
- * Attaches event handler `fnFunction` to the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
23787
- *
23788
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
23789
- * otherwise it will be bound to this `sap.ui.core.hyphenation.Hyphenation` itself.
23790
- *
23791
- * Fired if an error with initialization or hyphenation occurs.
23792
- *
23793
- *
23794
- * @returns Reference to `this` in order to allow method chaining
23795
- */
23796
- attachError(
23797
- /**
23798
- * An application-specific payload object that will be passed to the event handler along with the event
23799
- * object when firing the event
23800
- */
23801
- oData: object,
23802
- /**
23803
- * The function to be called when the event occurs
23804
- */
23805
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
23806
- /**
23807
- * Context object to call the event handler with. Defaults to this `sap.ui.core.hyphenation.Hyphenation`
23808
- * itself
23809
- */
23810
- oListener?: object
23811
- ): this;
23812
- /**
23813
- * Attaches event handler `fnFunction` to the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
23814
- *
23815
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
23816
- * otherwise it will be bound to this `sap.ui.core.hyphenation.Hyphenation` itself.
23817
- *
23818
- * Fired if an error with initialization or hyphenation occurs.
23819
- *
23820
- *
23821
- * @returns Reference to `this` in order to allow method chaining
23822
- */
23823
- attachError(
23824
- /**
23825
- * The function to be called when the event occurs
23826
- */
23827
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
23828
- /**
23829
- * Context object to call the event handler with. Defaults to this `sap.ui.core.hyphenation.Hyphenation`
23830
- * itself
23831
- */
23832
- oListener?: object
23833
- ): this;
23834
23908
  /**
23835
23909
  * Checks if native hyphenation works in the current browser for the given language. This check is performed
23836
23910
  * against the value of the "lang" HTML attribute of the page.
@@ -23858,37 +23932,6 @@ declare namespace sap {
23858
23932
  */
23859
23933
  sLang?: string
23860
23934
  ): boolean | null;
23861
- /**
23862
- * Detaches event handler `fnFunction` from the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
23863
- *
23864
- * The passed function and listener object must match the ones used for event registration.
23865
- *
23866
- *
23867
- * @returns Reference to `this` in order to allow method chaining
23868
- */
23869
- detachError(
23870
- /**
23871
- * The function to be called, when the event occurs
23872
- */
23873
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
23874
- /**
23875
- * Context object on which the given function had to be called
23876
- */
23877
- oListener?: object
23878
- ): this;
23879
- /**
23880
- * Fires event {@link #event:error error} to attached listeners.
23881
- *
23882
- * @ui5-protected Do not call from applications (only from related classes in the framework)
23883
- *
23884
- * @returns Reference to `this` in order to allow method chaining
23885
- */
23886
- fireError(
23887
- /**
23888
- * Parameters to pass along with the event
23889
- */
23890
- mParameters?: sap.ui.core.hyphenation.Hyphenation$ErrorEventParameters
23891
- ): this;
23892
23935
  /**
23893
23936
  * What languages were initialized with {@link sap.ui.core.hyphenation.Hyphenation#initialize Hyphenation#initialize}
23894
23937
  *
@@ -24001,6 +24044,33 @@ declare namespace sap {
24001
24044
  };
24002
24045
  }
24003
24046
 
24047
+ namespace LocaleData {
24048
+ /**
24049
+ * A relative time pattern.
24050
+ */
24051
+ type RelativeTimePattern = {
24052
+ /**
24053
+ * The string with the locale-specific representation of the relative time pattern
24054
+ */
24055
+ pattern: string;
24056
+ /**
24057
+ * The scale of the pattern
24058
+ */
24059
+ scale:
24060
+ | "day"
24061
+ | "hour"
24062
+ | "minute"
24063
+ | "month"
24064
+ | "second"
24065
+ | "week"
24066
+ | "year";
24067
+ /**
24068
+ * `-1`, if the pattern is for the past; `1` otherwise
24069
+ */
24070
+ sign: number;
24071
+ };
24072
+ }
24073
+
24004
24074
  namespace Popup {
24005
24075
  /**
24006
24076
  * Enumeration providing options for docking of some element to another.
@@ -31337,7 +31407,7 @@ declare namespace sap {
31337
31407
  /**
31338
31408
  * Class to mock http requests made to a remote server supporting the OData V2 REST protocol.
31339
31409
  */
31340
- abstract class MockServer extends sap.ui.base.ManagedObject {
31410
+ class MockServer extends sap.ui.base.ManagedObject {
31341
31411
  /**
31342
31412
  * Creates a mocked server. This helps to mock some back-end calls, e.g. for OData V2/JSON Models or simple
31343
31413
  * XHR calls, without changing the application code. This class can also be used for qunit tests.
@@ -32671,28 +32741,48 @@ declare namespace sap {
32671
32741
  /**
32672
32742
  * Marker interface for controls that can serve as a menu for a table column header.
32673
32743
  *
32674
- * Implementation of this interface implements the `openBy` and `getAriaHasPopupType` methods.
32744
+ * Implementation of this interface should include the `openBy`, `close`, `isOpen` and `getAriaHasPopupType`
32745
+ * methods and fire the `beforeOpen` and `afterClose` events.
32746
+ *
32747
+ * Refer to the base class {@link sap.m.table.columnmenu.MenuBase} for a detailed API description.
32675
32748
  *
32676
32749
  * @since 1.98
32677
- * @experimental (since 1.98)
32678
32750
  */
32679
32751
  interface IColumnHeaderMenu {
32680
32752
  __implements__sap_ui_core_IColumnHeaderMenu: boolean;
32681
32753
 
32682
32754
  /**
32683
- * Returns the sap.ui.core.aria.HasPopup<\code> type of the menu.
32755
+ * Closes the menu.
32756
+ *
32757
+ * @since 1.126
32758
+ */
32759
+ close(): void;
32760
+ /**
32761
+ * Returns the `sap.ui.core.aria.HasPopup` type of the menu.
32684
32762
  *
32685
32763
  * @since 1.98.0
32686
- * @experimental (since 1.98)
32687
32764
  *
32688
- * @returns sap.ui.core.aria.HasPopup<\code> type of the menu
32765
+ * @returns `sap.ui.core.aria.HasPopup` type of the menu
32689
32766
  */
32690
32767
  getAriaHasPopupType(): sap.ui.core.aria.HasPopup;
32768
+ /**
32769
+ * Determines whether the menu is open.
32770
+ *
32771
+ * @since 1.126
32772
+ *
32773
+ * @returns `true` if the menu is open, `false` otherwise
32774
+ */
32775
+ isOpen(
32776
+ /**
32777
+ * The element for which the menu is opened. If it is an `HTMLElement`, the closest control is passed for
32778
+ * this event (if it exists).
32779
+ */
32780
+ openBy: sap.ui.core.Element
32781
+ ): boolean;
32691
32782
  /**
32692
32783
  * Opens the menu using the column header.
32693
32784
  *
32694
32785
  * @since 1.98
32695
- * @experimental (since 1.98)
32696
32786
  */
32697
32787
  openBy(
32698
32788
  /**
@@ -44147,7 +44237,8 @@ declare namespace sap {
44147
44237
  getVariantSubtags(): string[];
44148
44238
  }
44149
44239
  /**
44150
- * Provides access to locale-specific data, such as date formats, number formats, and currencies.
44240
+ * Provides access to locale-specific data, such as date formats, number formats, and currencies. For more
44241
+ * information on terminology, such as field names used in the methods of this class, see {@link https://cldr.unicode.org/ Unicode CLDR}.
44151
44242
  */
44152
44243
  class LocaleData extends sap.ui.base.Object {
44153
44244
  /**
@@ -44209,7 +44300,7 @@ declare namespace sap {
44209
44300
  */
44210
44301
  firstDayStartsFirstWeek(): boolean;
44211
44302
  /**
44212
- * Returns the defined pattern for representing the calendar week number.
44303
+ * Returns the pattern for representing the calendar week number in the given style.
44213
44304
  *
44214
44305
  * @since 1.32.0
44215
44306
  *
@@ -44217,16 +44308,18 @@ declare namespace sap {
44217
44308
  */
44218
44309
  getCalendarWeek(
44219
44310
  /**
44220
- * the style of the pattern. It can only be either "wide" or "narrow".
44311
+ * the style of the pattern
44221
44312
  */
44222
- sStyle: string,
44313
+ sStyle: "narrow" | "wide",
44223
44314
  /**
44224
44315
  * the week number
44225
44316
  */
44226
44317
  iWeekNumber: int
44227
44318
  ): string;
44228
44319
  /**
44229
- * Get combined datetime pattern with given date and time style.
44320
+ * Get combined datetime pattern with given date and time style. The combined datetime pattern is the datetime
44321
+ * pattern as returned by {@link #getDateTimePattern}, where date and time placeholder are replaced with
44322
+ * the corresponding patterns for the given styles.
44230
44323
  *
44231
44324
  *
44232
44325
  * @returns the combined datetime pattern
@@ -44235,11 +44328,11 @@ declare namespace sap {
44235
44328
  /**
44236
44329
  * the required style for the date part
44237
44330
  */
44238
- sDateStyle: string,
44331
+ sDateStyle: "full" | "long" | "medium" | "short",
44239
44332
  /**
44240
44333
  * the required style for the time part
44241
44334
  */
44242
- sTimeStyle: string,
44335
+ sTimeStyle: "full" | "long" | "medium" | "short",
44243
44336
  /**
44244
44337
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44245
44338
  * or calculated from locale.
@@ -44295,28 +44388,29 @@ declare namespace sap {
44295
44388
  sCurrency: string
44296
44389
  ): int;
44297
44390
  /**
44298
- * Returns the short currency formats (like 1K USD, 1M USD....).
44391
+ * Returns the short currency format (like 1K USD, 1M USD....) of the given number in the given style and
44392
+ * plural category.
44299
44393
  *
44300
44394
  * @since 1.51.0
44301
44395
  *
44302
- * @returns decimal format
44396
+ * @returns the short currency format
44303
44397
  */
44304
44398
  getCurrencyFormat(
44305
44399
  /**
44306
- * short
44400
+ * the style
44307
44401
  */
44308
- sStyle: string,
44402
+ sStyle: "short",
44309
44403
  /**
44310
- * 1000, 10000 ...
44404
+ * the number in string representation as power of ten, for example "1000" or "10000"
44311
44405
  */
44312
44406
  sNumber: string,
44313
44407
  /**
44314
- * one or other (if not exists other is used)
44408
+ * the plural category; defaults to "other" if the given plural category does not exist for this locale
44315
44409
  */
44316
- sPlural: string
44410
+ sPlural?: "few" | "many" | "one" | "other" | "two" | "zero"
44317
44411
  ): string;
44318
44412
  /**
44319
- * Get currency format pattern.
44413
+ * Get currency format pattern for the given context.
44320
44414
  *
44321
44415
  * CLDR format pattern:
44322
44416
  * See:
@@ -44327,9 +44421,9 @@ declare namespace sap {
44327
44421
  */
44328
44422
  getCurrencyPattern(
44329
44423
  /**
44330
- * the context of the currency pattern (standard or accounting)
44424
+ * the context of the currency pattern
44331
44425
  */
44332
- sContext: string
44426
+ sContext: "accounting" | "standard"
44333
44427
  ): string;
44334
44428
  /**
44335
44429
  * Returns the currency symbol for the specified currency, if no symbol is found the ISO 4217 currency code
@@ -44414,7 +44508,7 @@ declare namespace sap {
44414
44508
  sCalendarType?: sap.ui.core.CalendarType
44415
44509
  ): string | string[];
44416
44510
  /**
44417
- * Get date pattern in format "short", "medium", "long" or "full".
44511
+ * Get date pattern in the given style.
44418
44512
  *
44419
44513
  *
44420
44514
  * @returns the selected date pattern
@@ -44423,7 +44517,7 @@ declare namespace sap {
44423
44517
  /**
44424
44518
  * the required style for the date pattern
44425
44519
  */
44426
- sStyle: string,
44520
+ sStyle: "full" | "long" | "medium" | "short",
44427
44521
  /**
44428
44522
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44429
44523
  * or calculated from locale.
@@ -44431,7 +44525,7 @@ declare namespace sap {
44431
44525
  sCalendarType?: sap.ui.core.CalendarType
44432
44526
  ): string;
44433
44527
  /**
44434
- * Get datetime pattern in style "short", "medium", "long" or "full".
44528
+ * Get datetime pattern in the given style.
44435
44529
  *
44436
44530
  *
44437
44531
  * @returns the selected datetime pattern
@@ -44440,7 +44534,7 @@ declare namespace sap {
44440
44534
  /**
44441
44535
  * the required style for the datetime pattern
44442
44536
  */
44443
- sStyle: string,
44537
+ sStyle: "full" | "long" | "medium" | "short",
44444
44538
  /**
44445
44539
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44446
44540
  * or calculated from locale.
@@ -44448,7 +44542,7 @@ declare namespace sap {
44448
44542
  sCalendarType?: sap.ui.core.CalendarType
44449
44543
  ): string;
44450
44544
  /**
44451
- * Get day periods in width "narrow", "abbreviated" or "wide".
44545
+ * Get day periods in the given width.
44452
44546
  *
44453
44547
  *
44454
44548
  * @returns array of day periods (AM, PM)
@@ -44457,15 +44551,15 @@ declare namespace sap {
44457
44551
  /**
44458
44552
  * the required width for the day period names
44459
44553
  */
44460
- sWidth: string,
44554
+ sWidth: "abbreviated" | "narrow" | "wide",
44461
44555
  /**
44462
44556
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44463
44557
  * or calculated from locale.
44464
44558
  */
44465
44559
  sCalendarType?: sap.ui.core.CalendarType
44466
- ): any[];
44560
+ ): string[];
44467
44561
  /**
44468
- * Get standalone day periods in width "narrow", "abbreviated" or "wide".
44562
+ * Get standalone day periods in the given width.
44469
44563
  *
44470
44564
  *
44471
44565
  * @returns array of day periods (AM, PM)
@@ -44474,15 +44568,15 @@ declare namespace sap {
44474
44568
  /**
44475
44569
  * the required width for the day period names
44476
44570
  */
44477
- sWidth: string,
44571
+ sWidth: "abbreviated" | "narrow" | "wide",
44478
44572
  /**
44479
44573
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44480
44574
  * or calculated from locale.
44481
44575
  */
44482
44576
  sCalendarType?: sap.ui.core.CalendarType
44483
- ): any[];
44577
+ ): string[];
44484
44578
  /**
44485
- * Get day names in width "narrow", "abbreviated" or "wide".
44579
+ * Get day names in the given width.
44486
44580
  *
44487
44581
  *
44488
44582
  * @returns array of day names (starting with Sunday)
@@ -44491,15 +44585,15 @@ declare namespace sap {
44491
44585
  /**
44492
44586
  * the required width for the day names
44493
44587
  */
44494
- sWidth: string,
44588
+ sWidth: "abbreviated" | "narrow" | "short" | "wide",
44495
44589
  /**
44496
44590
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44497
44591
  * or calculated from locale.
44498
44592
  */
44499
44593
  sCalendarType?: sap.ui.core.CalendarType
44500
- ): any[];
44594
+ ): string[];
44501
44595
  /**
44502
- * Get standalone day names in width "narrow", "abbreviated" or "wide".
44596
+ * Get standalone day names in the given width.
44503
44597
  *
44504
44598
  *
44505
44599
  * @returns array of day names (starting with Sunday)
@@ -44508,33 +44602,34 @@ declare namespace sap {
44508
44602
  /**
44509
44603
  * the required width for the day names
44510
44604
  */
44511
- sWidth: string,
44605
+ sWidth: "abbreviated" | "narrow" | "short" | "wide",
44512
44606
  /**
44513
44607
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44514
44608
  * or calculated from locale.
44515
44609
  */
44516
44610
  sCalendarType?: sap.ui.core.CalendarType
44517
- ): any[];
44611
+ ): string[];
44518
44612
  /**
44519
- * Returns the short decimal formats (like 1K, 1M....).
44613
+ * Returns the short decimal format (like 1K, 1M....) of the given number in the given style and plural
44614
+ * category.
44520
44615
  *
44521
44616
  * @since 1.25.0
44522
44617
  *
44523
- * @returns decimal format
44618
+ * @returns the short decimal format
44524
44619
  */
44525
44620
  getDecimalFormat(
44526
44621
  /**
44527
- * short or long
44622
+ * the style
44528
44623
  */
44529
- sStyle: string,
44624
+ sStyle: "long" | "short",
44530
44625
  /**
44531
- * 1000, 10000 ...
44626
+ * the number in string representation as power of ten, for example "1000" or "10000"
44532
44627
  */
44533
44628
  sNumber: string,
44534
44629
  /**
44535
- * one or other (if not exists other is used)
44630
+ * the plural category; defaults to "other" if the given plural category does not exist for this locale
44536
44631
  */
44537
- sPlural: string
44632
+ sPlural?: "one" | "other"
44538
44633
  ): string;
44539
44634
  /**
44540
44635
  * Get decimal format pattern.
@@ -44544,7 +44639,7 @@ declare namespace sap {
44544
44639
  */
44545
44640
  getDecimalPattern(): string;
44546
44641
  /**
44547
- * Returns the display name for a time unit (second, minute, hour, day, week, month, year).
44642
+ * Returns the display name for a time unit of the given type.
44548
44643
  *
44549
44644
  * @since 1.34.0
44550
44645
  *
@@ -44552,13 +44647,24 @@ declare namespace sap {
44552
44647
  */
44553
44648
  getDisplayName(
44554
44649
  /**
44555
- * Type (second, minute, hour, day, week, month, year)
44650
+ * the type
44556
44651
  */
44557
- sType: string,
44652
+ sType:
44653
+ | "day"
44654
+ | "era"
44655
+ | "hour"
44656
+ | "minute"
44657
+ | "month"
44658
+ | "quarter"
44659
+ | "second"
44660
+ | "week"
44661
+ | "weekday"
44662
+ | "year"
44663
+ | "zone",
44558
44664
  /**
44559
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
44665
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44560
44666
  */
44561
- sStyle?: string
44667
+ sStyle?: "narrow" | "short" | "wide"
44562
44668
  ): string;
44563
44669
  /**
44564
44670
  * Returns the map of era IDs to era dates.
@@ -44572,9 +44678,9 @@ declare namespace sap {
44572
44678
  * the type of calendar
44573
44679
  */
44574
44680
  sCalendarType?: sap.ui.core.CalendarType
44575
- ): any[];
44681
+ ): object[];
44576
44682
  /**
44577
- * Returns array of eras.
44683
+ * Returns array of eras in the given width.
44578
44684
  *
44579
44685
  * @since 1.32.0
44580
44686
  *
@@ -44582,14 +44688,15 @@ declare namespace sap {
44582
44688
  */
44583
44689
  getEras(
44584
44690
  /**
44585
- * the style of the era name. It can be 'wide', 'abbreviated' or 'narrow'
44691
+ * the width of the era name
44586
44692
  */
44587
- sWidth: string,
44693
+ sWidth: "abbreviated" | "narrow" | "wide",
44588
44694
  /**
44589
- * the type of calendar
44695
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
44696
+ * locale
44590
44697
  */
44591
44698
  sCalendarType?: sap.ui.core.CalendarType
44592
- ): any[];
44699
+ ): string[];
44593
44700
  /**
44594
44701
  * Returns the day that usually is regarded as the first day of a week in the current locale.
44595
44702
  *
@@ -44652,16 +44759,16 @@ declare namespace sap {
44652
44759
  */
44653
44760
  getLanguages(): Record<string, string>;
44654
44761
  /**
44655
- * Get lenient number symbols for "plusSign" or "minusSign".
44762
+ * Get lenient symbols for the sign of a number for the given symbol type.
44656
44763
  *
44657
44764
  *
44658
- * @returns the selected lenient number symbols, e.g. "-‒⁻₋−➖﹣"
44765
+ * @returns the selected lenient symbols for the sign of a number, e.g. "-‒⁻₋−➖﹣"
44659
44766
  */
44660
44767
  getLenientNumberSymbols(
44661
44768
  /**
44662
44769
  * the required type of symbol
44663
44770
  */
44664
- sType: string
44771
+ sType: "minusSign" | "plusSign"
44665
44772
  ): string;
44666
44773
  /**
44667
44774
  * Returns the required minimal number of days for the first week of a year.
@@ -44679,19 +44786,19 @@ declare namespace sap {
44679
44786
  */
44680
44787
  getMinimalDaysInFirstWeek(): int;
44681
44788
  /**
44682
- * Get miscellaneous pattern.
44789
+ * Get miscellaneous pattern for the given name.
44683
44790
  *
44684
44791
  *
44685
44792
  * @returns The pattern
44686
44793
  */
44687
44794
  getMiscPattern(
44688
44795
  /**
44689
- * the name of the misc pattern, can be "approximately", "atLeast", "atMost" or "range"
44796
+ * the name of the misc pattern
44690
44797
  */
44691
- sName: string
44798
+ sName: "approximately" | "atLeast" | "atMost" | "range"
44692
44799
  ): string;
44693
44800
  /**
44694
- * Get month names in width "narrow", "abbreviated" or "wide".
44801
+ * Get month names in the given width.
44695
44802
  *
44696
44803
  *
44697
44804
  * @returns The array of month names
@@ -44700,14 +44807,15 @@ declare namespace sap {
44700
44807
  /**
44701
44808
  * The required width for the month names
44702
44809
  */
44703
- sWidth: "narrow" | "abbreviated" | "wide",
44810
+ sWidth: "abbreviated" | "narrow" | "wide",
44704
44811
  /**
44705
- * The type of calendar; defaults to the calendar type either set in configuration or calculated from locale
44812
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
44813
+ * locale
44706
44814
  */
44707
44815
  sCalendarType?: sap.ui.core.CalendarType
44708
44816
  ): string[];
44709
44817
  /**
44710
- * Get standalone month names in width "narrow", "abbreviated" or "wide".
44818
+ * Get standalone month names in the given width.
44711
44819
  *
44712
44820
  *
44713
44821
  * @returns The array of standalone month names
@@ -44716,14 +44824,15 @@ declare namespace sap {
44716
44824
  /**
44717
44825
  * The required width for the month names
44718
44826
  */
44719
- sWidth: "narrow" | "abbreviated" | "wide",
44827
+ sWidth: "abbreviated" | "narrow" | "wide",
44720
44828
  /**
44721
- * The type of calendar; defaults to the calendar type either set in configuration or calculated from locale
44829
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
44830
+ * locale
44722
44831
  */
44723
44832
  sCalendarType?: sap.ui.core.CalendarType
44724
44833
  ): string[];
44725
44834
  /**
44726
- * Get number symbol "decimal", "group", "plusSign", "minusSign", "percentSign".
44835
+ * Get number symbol for the given type.
44727
44836
  *
44728
44837
  *
44729
44838
  * @returns the selected number symbol
@@ -44732,15 +44841,15 @@ declare namespace sap {
44732
44841
  /**
44733
44842
  * the required type of symbol
44734
44843
  */
44735
- sType: string
44844
+ sType: "decimal" | "group" | "minusSign" | "percentSign" | "plusSign"
44736
44845
  ): string;
44737
44846
  /**
44738
- * Get orientation (left-to-right or right-to-left).
44847
+ * Gets the text orientation.
44739
44848
  *
44740
44849
  *
44741
- * @returns character orientation for this locale
44850
+ * @returns text orientation
44742
44851
  */
44743
- getOrientation(): string;
44852
+ getOrientation(): "left-to-right" | "right-to-left";
44744
44853
  /**
44745
44854
  * Get percent format pattern.
44746
44855
  *
@@ -44755,7 +44864,7 @@ declare namespace sap {
44755
44864
  *
44756
44865
  * @returns The array of plural categories
44757
44866
  */
44758
- getPluralCategories(): any[];
44867
+ getPluralCategories(): string[];
44759
44868
  /**
44760
44869
  * Returns the plural category (zero, one, two, few, many or other) for the given number value. The number
44761
44870
  * must be passed as an unformatted number string with dot as decimal separator (for example "12345.67").
@@ -44789,15 +44898,15 @@ declare namespace sap {
44789
44898
  */
44790
44899
  getPreferredCalendarType(): sap.ui.core.CalendarType;
44791
44900
  /**
44792
- * Returns the preferred hour pattern symbol (h for 12, H for 24 hours) for the current locale.
44901
+ * Returns the preferred hour pattern symbol ("h" for 12, "H" for 24 hours) for the current locale.
44793
44902
  *
44794
44903
  * @since 1.34
44795
44904
  *
44796
44905
  * @returns the preferred hour symbol
44797
44906
  */
44798
- getPreferredHourSymbol(): string;
44907
+ getPreferredHourSymbol(): "h" | "H";
44799
44908
  /**
44800
- * Get quarter names in width "narrow", "abbreviated" or "wide".
44909
+ * Get quarter names in the given width.
44801
44910
  *
44802
44911
  *
44803
44912
  * @returns array of quarters
@@ -44806,15 +44915,15 @@ declare namespace sap {
44806
44915
  /**
44807
44916
  * the required width for the quarter names
44808
44917
  */
44809
- sWidth: string,
44918
+ sWidth: "abbreviated" | "narrow" | "wide",
44810
44919
  /**
44811
44920
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44812
44921
  * or calculated from locale.
44813
44922
  */
44814
44923
  sCalendarType?: sap.ui.core.CalendarType
44815
- ): any[];
44924
+ ): string[];
44816
44925
  /**
44817
- * Get standalone quarter names in width "narrow", "abbreviated" or "wide".
44926
+ * Get standalone quarter names in the given width.
44818
44927
  *
44819
44928
  *
44820
44929
  * @returns array of quarters
@@ -44823,13 +44932,13 @@ declare namespace sap {
44823
44932
  /**
44824
44933
  * the required width for the quarter names
44825
44934
  */
44826
- sWidth: string,
44935
+ sWidth: "abbreviated" | "narrow" | "wide",
44827
44936
  /**
44828
44937
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
44829
44938
  * or calculated from locale.
44830
44939
  */
44831
44940
  sCalendarType?: sap.ui.core.CalendarType
44832
- ): any[];
44941
+ ): string[];
44833
44942
  /**
44834
44943
  * Returns the relative day resource pattern (like "Today", "Yesterday", "{0} days ago") based on the given
44835
44944
  * difference of days (0 means today, 1 means tomorrow, -1 means yesterday, ...).
@@ -44844,9 +44953,9 @@ declare namespace sap {
44844
44953
  */
44845
44954
  iDiff: int,
44846
44955
  /**
44847
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
44956
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44848
44957
  */
44849
- sStyle?: string
44958
+ sStyle?: "narrow" | "short" | "wide"
44850
44959
  ): string;
44851
44960
  /**
44852
44961
  * Returns the relative resource pattern with unit 'hour' (like "in {0} hour(s)", "{0} hour(s) ago" under
@@ -44867,9 +44976,9 @@ declare namespace sap {
44867
44976
  */
44868
44977
  iDiff: int,
44869
44978
  /**
44870
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
44979
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44871
44980
  */
44872
- sStyle?: string
44981
+ sStyle?: "narrow" | "short" | "wide"
44873
44982
  ): string | null;
44874
44983
  /**
44875
44984
  * Returns the relative resource pattern with unit 'minute' (like "in {0} minute(s)", "{0} minute(s) ago"
@@ -44889,9 +44998,9 @@ declare namespace sap {
44889
44998
  */
44890
44999
  iDiff: int,
44891
45000
  /**
44892
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
45001
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44893
45002
  */
44894
- sStyle?: string
45003
+ sStyle?: "narrow" | "short" | "wide"
44895
45004
  ): string | null;
44896
45005
  /**
44897
45006
  * Returns the relative month resource pattern (like "This month", "Last month", "{0} months ago") based
@@ -44907,9 +45016,9 @@ declare namespace sap {
44907
45016
  */
44908
45017
  iDiff: int,
44909
45018
  /**
44910
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
45019
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44911
45020
  */
44912
- sStyle?: string
45021
+ sStyle?: "narrow" | "short" | "wide"
44913
45022
  ): string;
44914
45023
  /**
44915
45024
  * Returns the relative format pattern with given scale (year, month, week, ...) and difference value.
@@ -44922,7 +45031,14 @@ declare namespace sap {
44922
45031
  /**
44923
45032
  * the scale the relative pattern is needed for
44924
45033
  */
44925
- sScale: string,
45034
+ sScale:
45035
+ | "day"
45036
+ | "hour"
45037
+ | "minute"
45038
+ | "month"
45039
+ | "second"
45040
+ | "week"
45041
+ | "year",
44926
45042
  /**
44927
45043
  * the difference in the given scale unit
44928
45044
  */
@@ -44932,9 +45048,9 @@ declare namespace sap {
44932
45048
  */
44933
45049
  bFuture?: boolean,
44934
45050
  /**
44935
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
45051
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44936
45052
  */
44937
- sStyle?: string
45053
+ sStyle?: "narrow" | "short" | "wide"
44938
45054
  ): string;
44939
45055
  /**
44940
45056
  * Returns relative time patterns for the given scales as an array of objects containing scale, value and
@@ -44962,12 +45078,14 @@ declare namespace sap {
44962
45078
  /**
44963
45079
  * The scales for which the available patterns should be returned
44964
45080
  */
44965
- aScales: string[],
45081
+ aScales: Array<
45082
+ "day" | "hour" | "minute" | "month" | "second" | "week" | "year"
45083
+ >,
44966
45084
  /**
44967
- * Since 1.32.10 and 1.34.4, the style of the scale patterns; valid values are "wide", "short" and "narrow"
45085
+ * Since 1.32.10 and 1.34.4, the style of the scale patterns
44968
45086
  */
44969
- sStyle?: string
44970
- ): object[];
45087
+ sStyle?: "narrow" | "short" | "wide"
45088
+ ): sap.ui.core.LocaleData.RelativeTimePattern[];
44971
45089
  /**
44972
45090
  * Returns the relative resource pattern with unit 'second' (like now, "in {0} seconds", "{0} seconds ago"
44973
45091
  * under locale 'en') based on the given difference value (0 means now, positive value means in the future
@@ -44983,9 +45101,9 @@ declare namespace sap {
44983
45101
  */
44984
45102
  iDiff: int,
44985
45103
  /**
44986
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
45104
+ * Since 1.32.10 and 1.34.4, the style of the pattern
44987
45105
  */
44988
- sStyle?: string
45106
+ sStyle?: "narrow" | "short" | "wide"
44989
45107
  ): string;
44990
45108
  /**
44991
45109
  * Returns the relative week resource pattern (like "This week", "Last week", "{0} weeks ago") based on
@@ -45001,9 +45119,9 @@ declare namespace sap {
45001
45119
  */
45002
45120
  iDiff: int,
45003
45121
  /**
45004
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
45122
+ * Since 1.32.10 and 1.34.4, the style of the pattern
45005
45123
  */
45006
- sStyle?: string
45124
+ sStyle?: "narrow" | "short" | "wide"
45007
45125
  ): string;
45008
45126
  /**
45009
45127
  * Returns the relative year resource pattern (like "This year", "Last year", "{0} year ago") based on the
@@ -45019,9 +45137,9 @@ declare namespace sap {
45019
45137
  */
45020
45138
  iDiff: int,
45021
45139
  /**
45022
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
45140
+ * Since 1.32.10 and 1.34.4, the style of the pattern
45023
45141
  */
45024
- sStyle?: string
45142
+ sStyle?: "narrow" | "short" | "wide"
45025
45143
  ): string;
45026
45144
  /**
45027
45145
  * Retrieves the unit format pattern for a specific unit name considering the unit mappings.
@@ -45030,14 +45148,15 @@ declare namespace sap {
45030
45148
  *
45031
45149
  * @since 1.54
45032
45150
  *
45033
- * @returns The unit format configuration for the given unit name
45151
+ * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
45152
+ * to the corresponding pattern
45034
45153
  */
45035
45154
  getResolvedUnitFormat(
45036
45155
  /**
45037
45156
  * unit name, e.g. "duration-hour" or "my"
45038
45157
  */
45039
45158
  sUnit: string
45040
- ): object;
45159
+ ): Record<string, string>;
45041
45160
  /**
45042
45161
  * Gets locale-specific script names, as available in the CLDR raw data.
45043
45162
  *
@@ -45060,16 +45179,16 @@ declare namespace sap {
45060
45179
  */
45061
45180
  getTerritories(): Record<string, string>;
45062
45181
  /**
45063
- * Get time pattern in style "short", "medium", "long" or "full".
45182
+ * Get time pattern in the given style.
45064
45183
  *
45065
45184
  *
45066
45185
  * @returns the selected time pattern
45067
45186
  */
45068
45187
  getTimePattern(
45069
45188
  /**
45070
- * the required style for the date pattern
45189
+ * the required style for the time pattern
45071
45190
  */
45072
- sStyle: string,
45191
+ sStyle: "full" | "long" | "medium" | "short",
45073
45192
  /**
45074
45193
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
45075
45194
  * or calculated from locale.
@@ -45091,30 +45210,34 @@ declare namespace sap {
45091
45210
  sUnit: string
45092
45211
  ): string;
45093
45212
  /**
45094
- * Retrieves the unit format pattern for a specific unit name.
45213
+ * Retrieves the unit format pattern for a specific unit name, see {@link #getResolvedUnitFormat} for an
45214
+ * example of a unit format pattern.
45095
45215
  *
45096
45216
  * Note: Does not take unit mapping into consideration.
45097
45217
  *
45098
45218
  * @since 1.54
45099
45219
  *
45100
- * @returns The unit format configuration for the given unit name
45220
+ * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
45221
+ * to the corresponding pattern
45101
45222
  */
45102
45223
  getUnitFormat(
45103
45224
  /**
45104
45225
  * unit name, e.g. "duration-hour"
45105
45226
  */
45106
45227
  sUnit: string
45107
- ): object;
45228
+ ): Record<string, string>;
45108
45229
  /**
45109
- * Retrieves all unit format patterns merged.
45230
+ * Retrieves unit format patterns for all units see {@link #getResolvedUnitFormat} for an example of a unit
45231
+ * format pattern.
45110
45232
  *
45111
45233
  * Note: Does not take unit mapping into consideration.
45112
45234
  *
45113
45235
  * @since 1.54
45114
45236
  *
45115
- * @returns The unit format patterns
45237
+ * @returns The unit format patterns as a map from a unit key to a map from a pattern key like `"unitPattern-count-other"`
45238
+ * to the corresponding pattern
45116
45239
  */
45117
- getUnitFormats(): object;
45240
+ getUnitFormats(): Record<string, Record<string, string>>;
45118
45241
  /**
45119
45242
  * Looks up the unit from defined unit mapping. E.g. for defined unit mapping ` { "my": "my-custom-unit",
45120
45243
  * "cm": "length-centimeter" } `
@@ -54139,9 +54262,13 @@ declare namespace sap {
54139
54262
  oContext?: sap.ui.model.Context
54140
54263
  ): any | null | undefined;
54141
54264
  /**
54142
- * Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in
54143
- * the model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
54144
- * policy, the request can not successfully retrieve data from a different domain, subdomain, or protocol.
54265
+ * Loads JSON-encoded data from the server and stores the resulting JSON data in the model. Note: Due to
54266
+ * browser security restrictions, most "Ajax" requests are subject to the same origin policy, the request
54267
+ * can not successfully retrieve data from a different domain, subdomain, or protocol.
54268
+ *
54269
+ * Note: To send a JSON object in the body of a "POST" request to load the model data, `oParameters` has
54270
+ * to be the JSON-stringified value of the object to be sent, and `mHeaders` has to contain a `"Content-Type"`
54271
+ * property with the value `"application/json;charset=utf-8"`.
54145
54272
  *
54146
54273
  *
54147
54274
  * @returns in case bAsync is set to true a Promise is returned; this promise resolves/rejects based on
@@ -54149,15 +54276,16 @@ declare namespace sap {
54149
54276
  */
54150
54277
  loadData(
54151
54278
  /**
54152
- * A string containing the URL to which the request is sent.
54279
+ * A string containing the URL to which the request is sent
54153
54280
  */
54154
54281
  sURL: string,
54155
54282
  /**
54156
- * A map or string that is sent to the server with the request. If the value of this parameter is a string,
54157
- * it must already be url-encoded. If the value of this parameter is an object (map), it is converted to
54158
- * a string and then url-encoded. The resulting string is appended to the URL if the HTTP request method
54159
- * cannot have a request body, e.g. for a GET request. Otherwise, the resulting string is added to the request
54160
- * body.
54283
+ * The data to be sent to the server with the data-loading request. If `oParameters` is a string, it has
54284
+ * to be encoded based on the used content type. The default encoding is `'application/x-www-form-urlencoded;
54285
+ * charset=UTF-8'` but it may be overwritten via the `"Content-Type"` property given in `mHeaders`. If `oParameters`
54286
+ * is an object, a string is generated and the keys and values are URL-encoded. The resulting string is
54287
+ * appended to the URL if the HTTP request method cannot have a request body, e.g. for a "GET" request.
54288
+ * Otherwise, the resulting string is added to the request body.
54161
54289
  */
54162
54290
  oParameters?: object | string,
54163
54291
  /**
@@ -54167,8 +54295,7 @@ declare namespace sap {
54167
54295
  */
54168
54296
  bAsync?: boolean,
54169
54297
  /**
54170
- * The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such
54171
- * as PUT and DELETE, can also be used here, but they are not supported by all browsers.
54298
+ * The HTTP verb to use for the request ("GET" or "POST")
54172
54299
  */
54173
54300
  sType?: string,
54174
54301
  /**
@@ -62205,21 +62332,19 @@ declare namespace sap {
62205
62332
  /**
62206
62333
  * Parameters of the ODataListBinding#refresh event.
62207
62334
  */
62208
- interface ODataListBinding$RefreshEventParameters {
62209
- /**
62210
- * The reason for the 'refresh' event could be
62211
- * {@link sap.ui.model.ChangeReason.Context Context} when the binding's parent context is changed,
62212
- * {@link sap.ui.model.ChangeReason.Filter Filter} on {@link #filter} and {@link #setAggregation},
62213
- * {@link sap.ui.model.ChangeReason.Refresh Refresh} on {@link #refresh}, or when the binding is initialized,
62214
- * {@link sap.ui.model.ChangeReason.Sort Sort} on {@link #sort}. {@link #changeParameters} leads
62215
- * to {@link sap.ui.model.ChangeReason.Filter Filter} if one of the parameters '$filter' and '$search' is
62216
- * changed, otherwise it leads to {@link sap.ui.model.ChangeReason.Sort Sort} if the parameter '$orderby'
62217
- * is changed; in other cases, it leads to {@link sap.ui.model.ChangeReason.Change Change}.
62218
- * If APIs that would normally fire change events have been called while the binding is suspended, {@link #resume }
62219
- * leads to the "strongest" change reason in the order {@link sap.ui.model.ChangeReason.Filter Filter},
62220
- * {@link sap.ui.model.ChangeReason.Sort Sort}, {@link sap.ui.model.ChangeReason.Refresh Refresh}, {@link sap.ui.model.ChangeReason.Change Change}.
62221
- */
62222
- reason?: sap.ui.model.ChangeReason;
62335
+ interface ODataListBinding$RefreshEventParameters
62336
+ extends sap.ui.model.Binding$RefreshEventParameters {}
62337
+
62338
+ /**
62339
+ * Parameters of the ODataListBinding#selectionChanged event.
62340
+ *
62341
+ * @experimental (since 1.126.0)
62342
+ */
62343
+ interface ODataListBinding$SelectionChangedEventParameters {
62344
+ /**
62345
+ * The context for which {@link sap.ui.model.odata.v4.Context#setSelected} was called
62346
+ */
62347
+ context?: boolean;
62223
62348
  }
62224
62349
 
62225
62350
  /**
@@ -63129,8 +63254,9 @@ declare namespace sap {
63129
63254
  ): Promise<void>;
63130
63255
  /**
63131
63256
  * Destroys this context, that is, it removes this context from all dependent bindings and drops references
63132
- * to binding and model, so that the context cannot be used anymore; it keeps path and index for debugging
63133
- * purposes.
63257
+ * to {@link #getBinding binding} and {@link #getModel model}, so that the context cannot be used anymore;
63258
+ * it keeps path and index for debugging purposes. A destroyed context can be recognized by calling {@link #getBinding},
63259
+ * which returns `undefined`.
63134
63260
  *
63135
63261
  * **BEWARE:** Do not call this function! The lifetime of an OData V4 context is completely controlled by
63136
63262
  * its binding.
@@ -63378,7 +63504,11 @@ declare namespace sap {
63378
63504
  *
63379
63505
  * The move potentially changes the {@link #getIndex index} of this context, of all of its descendants,
63380
63506
  * and of all other nodes affected by the move. Any index change can, however, only be observed reliably
63381
- * for this context itself.
63507
+ * for this context itself or (since 1.126.0) the next sibling's context if that is {@link #isKeepAlive kept alive }
63508
+ * or {@link #isSelected selected} (and the preconditions of {@link #setKeepAlive} hold). For a kept-alive
63509
+ * or selected next sibling, the index must be retrieved as soon as the returned promise resolves. If such
63510
+ * a next sibling is not one of the binding's {@link sap.ui.model.odata.v4.ODataListBinding#getCurrentContexts current contexts }
63511
+ * after the move, it is not in the collection anymore and thus loses its index pretty soon.
63382
63512
  *
63383
63513
  * The move changes the {@link https://ui5.sap.com/#/topic/c9723f8265f644af91c0ed941e114d46/section_CST context states }
63384
63514
  * of the nodes as follows:
@@ -63748,16 +63878,20 @@ declare namespace sap {
63748
63878
  bRetry?: boolean
63749
63879
  ): Promise<void>;
63750
63880
  /**
63751
- * Sets whether this context is currently selected. While a context is currently {@link #delete deleted }
63881
+ * Sets whether this context is currently selected. If the selection state changes, a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
63882
+ * event is fired on the list binding which this context belongs to. While a context is currently {@link #delete deleted }
63752
63883
  * on the client, it does not appear as {@link #isSelected selected}. If the preconditions of {@link #setKeepAlive }
63753
63884
  * hold, a best effort is made to implicitly keep a selected context alive in order to preserve the selection
63754
63885
  * state. Once the selection is no longer needed, for example because you perform an operation on this context
63755
63886
  * which logically removes it from its list, you need to reset the selection.
63756
63887
  *
63757
63888
  * If this context is a header context of a list binding, the new selection state is propagated to all row
63758
- * contexts. This method can be called repeatedly with the same value to again select all row contexts.
63759
- * For example, if a row context was deselected explicitly, it is selected again by selecting the header
63760
- * context (even if the header context is already selected).
63889
+ * contexts. If the selection state of this header context changes, a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
63890
+ * event is fired for this header context. This method can be called repeatedly with the same value to again
63891
+ * select all row contexts. For example, if a row context was deselected explicitly, it is selected again
63892
+ * by selecting the header context (even if the header context is already selected). If the selection state
63893
+ * of any row context changes in this way, then a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
63894
+ * event is nevertheless fired for this header context, but not for the row context.
63761
63895
  *
63762
63896
  * **Note:** It is unsafe to keep a reference to a context instance which is not {@link #isKeepAlive kept alive}.
63763
63897
  * See:
@@ -64331,8 +64465,8 @@ declare namespace sap {
64331
64465
  /**
64332
64466
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
64333
64467
  * events: 'AggregatedDataStateChange', 'change', 'createActivate', 'createCompleted', 'createSent', 'dataReceived',
64334
- * 'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
64335
- * error is thrown.
64468
+ * 'dataRequested', 'DataStateChange', 'selectionChanged', 'patchCompleted', 'patchSent', and 'refresh'.
64469
+ * For other events, an error is thrown.
64336
64470
  *
64337
64471
  * @since 1.37.0
64338
64472
  */
@@ -64572,13 +64706,18 @@ declare namespace sap {
64572
64706
  * (which is immediately removed from the new child's data). It can be `null` or absent when creating a
64573
64707
  * new root node. `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
64574
64708
  * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
64575
- * (including collapse of some ancestor node) must happen while this creation is pending! When using the
64576
- * `createInPlace` parameter (see {@link #setAggregation}, @experimental as of version 1.125.0), the new
64577
- * {@link sap.ui.model.odata.v4.Context#isTransient transient} child is hidden until it becomes {@link sap.ui.model.odata.v4.Context#created created},
64578
- * and then it is shown at a position determined by the back end and the current sort order. The position
64579
- * of the new child can be retrieved by using its {@link sap.ui.model.odata.v4.Context#getIndex index}.
64709
+ * (including collapse of some ancestor node) must happen while this creation is pending!
64710
+ *
64711
+ * When using the `createInPlace` parameter (see {@link #setAggregation}, @experimental as of version 1.125.0),
64712
+ * 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 }
64713
+ * resolves, and then it is shown at a position determined by the back end and the current sort order. Note
64714
+ * that the returned context is not always part of this list binding's collection and can only be used for
64715
+ * the following scenarios:
64716
+ * The position of the new child can be retrieved by using its {@link sap.ui.model.odata.v4.Context#getIndex index}.
64580
64717
  * If the created child does not become part of the hierarchy due to the search or filter criteria, the
64581
- * context will be destroyed and its {@link sap.ui.model.odata.v4.Context#getIndex index} is set to `undefined`.
64718
+ * context will be {@link sap.ui.model.odata.v4.Context#destroy destroyed} and its {@link sap.ui.model.odata.v4.Context#getIndex index }
64719
+ * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
64720
+ * which can be used for {@link #getKeepAliveContext}.
64582
64721
  *
64583
64722
  * @since 1.43.0
64584
64723
  *
@@ -64922,7 +65061,7 @@ declare namespace sap {
64922
65061
  * it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
64923
65062
  * data and a request for its entity is sent.
64924
65063
  * See:
64925
- * sap.ui.model.odata.v4.Model#getKeepAliveContext
65064
+ * sap.ui.model.odata.v4.ODataModel#getKeepAliveContext
64926
65065
  *
64927
65066
  * @since 1.99.0
64928
65067
  *
@@ -66688,6 +66827,9 @@ declare namespace sap {
66688
66827
  * If the target type specified in the corresponding control property's binding info is "any" and the binding
66689
66828
  * is relative or points to metadata, the binding may have an object value; in this case and unless the
66690
66829
  * binding refers to an action advertisement the binding's mode must be {@link sap.ui.model.BindingMode.OneTime}.
66830
+ * {@link sap.ui.model.BindingMode.OneWay OneWay} is also supported (@experimental as of version 1.126.0),
66831
+ * but client-side updates of the object are not supported and `$$patchWithoutSideEffects` should be used
66832
+ * for the parent entity.
66691
66833
  * See:
66692
66834
  * sap.ui.base.ManagedObject#bindProperty
66693
66835
  * sap.ui.model.Model#bindProperty
@@ -67765,6 +67907,16 @@ declare namespace sap {
67765
67907
  ODataListBinding
67766
67908
  >;
67767
67909
 
67910
+ /**
67911
+ * Event object of the ODataListBinding#selectionChanged event.
67912
+ *
67913
+ * @experimental (since 1.126.0)
67914
+ */
67915
+ type ODataListBinding$SelectionChangedEvent = sap.ui.base.Event<
67916
+ ODataListBinding$SelectionChangedEventParameters,
67917
+ ODataListBinding
67918
+ >;
67919
+
67768
67920
  /**
67769
67921
  * Event object of the ODataModel#dataReceived event.
67770
67922
  */
@@ -74075,6 +74227,17 @@ declare namespace sap {
74075
74227
  dataState?: sap.ui.model.DataState;
74076
74228
  }
74077
74229
 
74230
+ /**
74231
+ * Parameters of the Binding#refresh event.
74232
+ */
74233
+ interface Binding$RefreshEventParameters {
74234
+ /**
74235
+ * A string stating the reason for the data change; some change reasons can be found in {@link sap.ui.model.ChangeReason},
74236
+ * but there may be additional reasons specified by a specific model implementation
74237
+ */
74238
+ reason?: string;
74239
+ }
74240
+
74078
74241
  /**
74079
74242
  * Parameters of the ListBinding#filter event.
74080
74243
  *
@@ -74409,24 +74572,6 @@ declare namespace sap {
74409
74572
  */
74410
74573
  oEvents: Record<string, Function>
74411
74574
  ): sap.ui.model.Binding;
74412
- /**
74413
- * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
74414
- *
74415
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
74416
- * otherwise it will be bound to this `sap.ui.model.Binding` itself.
74417
- *
74418
- * @ui5-protected Do not call from applications (only from related classes in the framework)
74419
- */
74420
- attachRefresh(
74421
- /**
74422
- * The function to be called when the event occurs
74423
- */
74424
- fnFunction: Function,
74425
- /**
74426
- * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
74427
- */
74428
- oListener?: object
74429
- ): void;
74430
74575
  /**
74431
74576
  * Removes all control messages for this binding from {@link module:sap/ui/core/Messaging} in addition to
74432
74577
  * the standard clean-up tasks.
@@ -74519,21 +74664,6 @@ declare namespace sap {
74519
74664
  */
74520
74665
  oEvents: Record<string, Function>
74521
74666
  ): sap.ui.model.Binding;
74522
- /**
74523
- * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
74524
- *
74525
- * @ui5-protected Do not call from applications (only from related classes in the framework)
74526
- */
74527
- detachRefresh(
74528
- /**
74529
- * The function to be called when the event occurs
74530
- */
74531
- fnFunction: Function,
74532
- /**
74533
- * Object on which to call the given function.
74534
- */
74535
- oListener?: object
74536
- ): void;
74537
74667
  /**
74538
74668
  * Fires event {@link #event:dataReceived dataReceived} to attached listeners.
74539
74669
  *
@@ -79269,6 +79399,14 @@ declare namespace sap {
79269
79399
  Binding
79270
79400
  >;
79271
79401
 
79402
+ /**
79403
+ * Event object of the Binding#refresh event.
79404
+ */
79405
+ type Binding$RefreshEvent = sap.ui.base.Event<
79406
+ Binding$RefreshEventParameters,
79407
+ Binding
79408
+ >;
79409
+
79272
79410
  /**
79273
79411
  * Event object of the ListBinding#filter event.
79274
79412
  *
@@ -85326,6 +85464,10 @@ declare namespace sap {
85326
85464
 
85327
85465
  "sap/ui/core/ExtensionPoint": undefined;
85328
85466
 
85467
+ "sap/ui/core/fieldhelp/FieldHelp": undefined;
85468
+
85469
+ "sap/ui/core/fieldhelp/FieldHelpUtil": undefined;
85470
+
85329
85471
  "sap/ui/core/format/DateFormat": undefined;
85330
85472
 
85331
85473
  "sap/ui/core/format/DateFormatTimezoneDisplay": undefined;
@@ -85674,8 +85816,6 @@ declare namespace sap {
85674
85816
 
85675
85817
  "sap/ui/model/DataState": undefined;
85676
85818
 
85677
- "sap/ui/model/FieldHelp": undefined;
85678
-
85679
85819
  "sap/ui/model/Filter": undefined;
85680
85820
 
85681
85821
  "sap/ui/model/FilterOperator": undefined;