@openui5/ts-types 1.130.0 → 1.131.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.130.0
282
+ // For Library Version: 1.131.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -6657,7 +6657,7 @@ declare module "sap/ui/test/OpaBuilder" {
6657
6657
  * the Opa5 instance to call {@link sap.ui.test.Opa5#waitFor} on
6658
6658
  */
6659
6659
  oOpaInstance?: sap.ui.test.Opa5
6660
- ): /* was: sap.ui.test.Opa5.Chain */ any;
6660
+ ): sap.ui.test.Opa5;
6661
6661
  /**
6662
6662
  * Sets the `fragmentId` parameter.
6663
6663
  *
@@ -18982,7 +18982,11 @@ declare namespace sap {
18982
18982
  */
18983
18983
  plusSign?: string;
18984
18984
  /**
18985
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
18985
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
18986
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
18987
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
18988
+ * **Example:** With a `precision` of 2, `234.567` is formatted to `235`. **Note:** The formatted output
18989
+ * may differ depending on locale.
18986
18990
  */
18987
18991
  precision?: int;
18988
18992
  /**
@@ -19137,7 +19141,12 @@ declare namespace sap {
19137
19141
  */
19138
19142
  plusSign?: string;
19139
19143
  /**
19140
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
19144
+ * **Note:** Only considered if the number format leads to a representation with decimal places, e.g. if
19145
+ * the option `style: "short"` is set. The maximum number of digits in the formatted representation of a
19146
+ * number; if the `precision` is less than the overall length of the number, its fractional part is truncated
19147
+ * through rounding. As the `precision` only affects the rounding of a number, its integer part can retain
19148
+ * more digits than defined by this parameter. **Example:** With a `precision` of 2 and `style: "short"`,
19149
+ * `234567` is formatted to `"235K"`. **Note:** The formatted output may differ depending on locale.
19141
19150
  */
19142
19151
  precision?: int;
19143
19152
  /**
@@ -19290,7 +19299,11 @@ declare namespace sap {
19290
19299
  */
19291
19300
  plusSign?: string;
19292
19301
  /**
19293
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
19302
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
19303
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
19304
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
19305
+ * **Example:** With a `precision` of 2, `234.567` is formatted to `"23,457%"`. **Note:** The formatted
19306
+ * output may differ depending on locale.
19294
19307
  */
19295
19308
  precision?: int;
19296
19309
  /**
@@ -19442,7 +19455,11 @@ declare namespace sap {
19442
19455
  */
19443
19456
  plusSign?: string;
19444
19457
  /**
19445
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
19458
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
19459
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
19460
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
19461
+ * **Example:** With a `precision` of 2, the parameters `"234.567", "mass-kilogram"` are formatted to `"235
19462
+ * kg"`. **Note:** The formatted output may differ depending on locale.
19446
19463
  */
19447
19464
  precision?: int;
19448
19465
  /**
@@ -23675,7 +23692,7 @@ declare namespace sap {
23675
23692
  * - the first week of the year.
23676
23693
  *
23677
23694
  * @since 1.108.0
23678
- * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarWeekNumbering} instead.
23695
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/date/CalendarWeekNumbering} instead.
23679
23696
  */
23680
23697
  enum CalendarWeekNumbering {
23681
23698
  /**
@@ -32936,13 +32953,15 @@ declare namespace sap {
32936
32953
  }
32937
32954
 
32938
32955
  /**
32939
- * Marker interface for controls that can be used as content of `sap.ui.layout.form.SemanticFormElement`.
32956
+ * Marker interface for controls that can be used as content of {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
32940
32957
  *
32941
32958
  * If the value-holding property of the control is not `valuetext`, the name of the value-holding
32942
- * property must be returned in the `getFormValueProperty` function.
32959
+ * property must be returned in the {@link sap.ui.core.ISemanticFormContent.getFormValueProperty getFormValueProperty }
32960
+ * function.
32943
32961
  *
32944
32962
  * If the value of the control needs some special output formatting (to show a description instead of a
32945
- * key), this formatted text needs to be returned in the `getFormFormattedValue` function.
32963
+ * key), this formatted text needs to be returned in the {@link sap.ui.core.ISemanticFormContent.getFormFormattedValue getFormFormattedValue }
32964
+ * function.
32946
32965
  *
32947
32966
  * @since 1.86.0
32948
32967
  */
@@ -32950,12 +32969,13 @@ declare namespace sap {
32950
32969
  __implements__sap_ui_core_ISemanticFormContent: boolean;
32951
32970
 
32952
32971
  /**
32953
- * Returns the formatted value of a control used in a `SemanticFormElement`.
32972
+ * Returns the formatted value of a control used in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
32954
32973
  *
32955
- * In the `SemanticFormElement` element, the assigned fields are rendered in edit mode. In display mode,
32956
- * a text is rendered that concatenates the values of all assigned fields. In some cases the displayed text
32957
- * does not match the value of the field and needs some formatting. In other cases the control does not
32958
- * have a `value` property, so the `SemanticFormElement` element cannot determine the value.
32974
+ * In the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} element, the assigned fields
32975
+ * are rendered in edit mode. In display mode, a text is rendered that concatenates the values of all assigned
32976
+ * fields. In some cases the displayed text does not match the value of the field and needs some formatting.
32977
+ * In other cases the control does not have a `value` property, so the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement }
32978
+ * element cannot determine the value.
32959
32979
  *
32960
32980
  * This is an optional method. If not defined, the `value` property or the `text` property is used to determine
32961
32981
  * the value.
@@ -32966,15 +32986,16 @@ declare namespace sap {
32966
32986
  */
32967
32987
  getFormFormattedValue?(): string | Promise<string>;
32968
32988
  /**
32969
- * Returns the names of the properties of a control that might update the rendering in a `SemanticFormElement`.
32989
+ * Returns the names of the properties of a control that might update the rendering in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
32970
32990
  *
32971
- * In the `SemanticFormElement` element, the assigned fields are rendered in edit mode. In display mode,
32972
- * depending on `getFormRenderAsControl`, either a text is rendered, which concatenates the values of all
32973
- * assigned fields, or the control is rendered. So if a property of the control changes that might lead
32974
- * to a different rendering (some controls have a special rendering in display mode), the `SemanticFormElement`
32991
+ * In the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} element, the assigned fields
32992
+ * are rendered in edit mode. In display mode, depending on {@link sap.ui.core.ISemanticFormContent.getFormRenderAsControl getFormRenderAsControl},
32993
+ * either a text is rendered, which concatenates the values of all assigned fields, or the control is rendered.
32994
+ * So if a property of the control changes that might lead to a different rendering (some controls have
32995
+ * a special rendering in display mode), the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement }
32975
32996
  * needs to check the rendering.
32976
32997
  *
32977
- * This is an optional method. If not defined, no check for updates (only for property defined in `getFormValueProperty`)
32998
+ * This is an optional method. If not defined, no check for updates (only for property defined in {@link sap.ui.core.ISemanticFormContent.getFormValueProperty getFormValueProperty})
32978
32999
  * is done once the control has been assigned.
32979
33000
  *
32980
33001
  * @since 1.117.0
@@ -32983,8 +33004,8 @@ declare namespace sap {
32983
33004
  */
32984
33005
  getFormObservingProperties?(): string[];
32985
33006
  /**
32986
- * If set to `true`, the `SemanticFormElement` also renders the control in display mode, if the used `FormLayout`
32987
- * supports this.
33007
+ * If set to `true`, the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} also renders
33008
+ * the control in display mode, if the used {@link sap.ui.layout.form.FormLayout FormLayout} supports this.
32988
33009
  *
32989
33010
  * This is an optional method. If not defined, just the text is rendered.
32990
33011
  *
@@ -32994,12 +33015,13 @@ declare namespace sap {
32994
33015
  */
32995
33016
  getFormRenderAsControl?(): string;
32996
33017
  /**
32997
- * Returns the name of the value-holding property of a control used in a `SemanticFormElement`.
33018
+ * Returns the name of the value-holding property of a control used in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
32998
33019
  *
32999
- * In the `SemanticFormElement` element, the assigned fields are rendered in edit mode. In display mode,
33000
- * a text is rendered that concatenates the values of all assigned fields. So the concatenated text needs
33001
- * to be updated if the value of a control changes. If a control does not have a `value` property, the `SemanticFormElement`
33002
- * element needs to know the propery it has to listen for changes.
33020
+ * In the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} element, the assigned fields
33021
+ * are rendered in edit mode. In display mode, a text is rendered that concatenates the values of all assigned
33022
+ * fields. So the concatenated text needs to be updated if the value of a control changes. If a control
33023
+ * does not have a `value` property, the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement }
33024
+ * element needs to know the property it has to listen to for changes.
33003
33025
  *
33004
33026
  * This is an optional method. If not defined, the `value` property or the `text` property is used to determine
33005
33027
  * the value.
@@ -40478,6 +40500,27 @@ declare namespace sap {
40478
40500
  */
40479
40501
  FNMetaImpl?: Function
40480
40502
  ): Function;
40503
+ /**
40504
+ * Fires a "focusfail" event to handle focus redirection when the current element loses focus due to a state
40505
+ * change (e.g., disabled, invisible, or destroyed). The event is propagated to the parent of the current
40506
+ * element to manage the focus shift.
40507
+ *
40508
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
40509
+ */
40510
+ static fireFocusFail(
40511
+ /**
40512
+ * The mode of focus handling, determining whether the focus should be handled sync or async.
40513
+ */
40514
+ sFocusHandlingMode: string,
40515
+ /**
40516
+ * The parent element that will handle the "focusfail" event.
40517
+ */
40518
+ oParent: sap.ui.core.Element,
40519
+ /**
40520
+ * Optional DOM area to be skipped during focus redirection.
40521
+ */
40522
+ oSkipArea?: HTMLElement
40523
+ ): void;
40481
40524
  /**
40482
40525
  * Returns the element currently in focus.
40483
40526
  *
@@ -40775,6 +40818,25 @@ declare namespace sap {
40775
40818
  */
40776
40819
  bSuppressInvalidate?: boolean
40777
40820
  ): void;
40821
+ /**
40822
+ * Destroys all child elements of a specified aggregation and handles focus management for elements that
40823
+ * are currently focused. If the currently focused element belongs to the aggregation being destroyed, a
40824
+ * "focusfail" event is triggered to shift the focus to a relevant element.
40825
+ *
40826
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
40827
+ *
40828
+ * @returns Returns `this` to allow method chaining
40829
+ */
40830
+ destroyAggregation(
40831
+ /**
40832
+ * The name of the aggregation
40833
+ */
40834
+ sAggregationName: string,
40835
+ /**
40836
+ * If true, this ManagedObject is not marked as changed
40837
+ */
40838
+ bSuppressInvalidate?: boolean
40839
+ ): this;
40778
40840
  /**
40779
40841
  * Destroys all the customData in the aggregation {@link #getCustomData customData}.
40780
40842
  *
@@ -41214,8 +41276,8 @@ declare namespace sap {
41214
41276
  isFocusable(): boolean;
41215
41277
  /**
41216
41278
  * Handles the 'focusfail' event by attempting to find and focus on a tabbable element. The 'focusfail'
41217
- * event is triggered when the current element, which initially holds the focus, becomes disabled or invisible.
41218
- * The event is received by the parent of the element that failed to retain the focus.
41279
+ * event is triggered when the current element, which initially holds the focus, becomes disabled, invisible,
41280
+ * or destroyed. The event is received by the parent of the element that failed to retain the focus.
41219
41281
  *
41220
41282
  * @ui5-protected Do not call from applications (only from related classes in the framework)
41221
41283
  */
@@ -41245,6 +41307,50 @@ declare namespace sap {
41245
41307
  */
41246
41308
  oValue?: any
41247
41309
  ): any | this;
41310
+ /**
41311
+ * Removes an object from the aggregation named `sAggregationName` with cardinality 0..n and manages focus
41312
+ * handling in case the removed object was focused. If the removed object held the focus, a "focusfail"
41313
+ * event is triggered to proper focus redirection.
41314
+ *
41315
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
41316
+ *
41317
+ * @returns the removed object or `null`
41318
+ */
41319
+ removeAggregation(
41320
+ /**
41321
+ * the string identifying the aggregation that the given object should be removed from
41322
+ */
41323
+ sAggregationName: string,
41324
+ /**
41325
+ * the position or ID of the ManagedObject that should be removed or that ManagedObject itself; if `vObject`
41326
+ * is invalid, a negative value or a value greater or equal than the current size of the aggregation, nothing
41327
+ * is removed.
41328
+ */
41329
+ vObject: int | string | sap.ui.base.ManagedObject,
41330
+ /**
41331
+ * if true, this ManagedObject is not marked as changed
41332
+ */
41333
+ bSuppressInvalidate?: boolean
41334
+ ): sap.ui.base.ManagedObject | null;
41335
+ /**
41336
+ * Removes all child elements of a specified aggregation and handles focus management for elements that
41337
+ * are currently focused. If the currently focused element belongs to the aggregation being removed, a "focusfail"
41338
+ * event is triggered to shift the focus to a relevant element.
41339
+ *
41340
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
41341
+ *
41342
+ * @returns An array of the removed elements (might be empty)
41343
+ */
41344
+ removeAllAggregation(
41345
+ /**
41346
+ * The name of the aggregation
41347
+ */
41348
+ sAggregationName: string,
41349
+ /**
41350
+ * If true, this ManagedObject is not marked as changed
41351
+ */
41352
+ bSuppressInvalidate?: boolean
41353
+ ): sap.ui.base.ManagedObject[];
41248
41354
  /**
41249
41355
  * Removes all the controls from the aggregation {@link #getCustomData customData}.
41250
41356
  *
@@ -41343,6 +41449,29 @@ declare namespace sap {
41343
41449
  * @ui5-protected Do not call from applications (only from related classes in the framework)
41344
41450
  */
41345
41451
  rerender(): void;
41452
+ /**
41453
+ * Sets a new object in the named 0..1 aggregation of this ManagedObject and marks this ManagedObject as
41454
+ * changed. Manages the focus handling if the current aggregation is removed (i.e., when the object is set
41455
+ * to `null`). If the previous object in the aggregation was focused, a "focusfail" event is triggered.
41456
+ *
41457
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
41458
+ *
41459
+ * @returns Returns `this` to allow method chaining
41460
+ */
41461
+ setAggregation(
41462
+ /**
41463
+ * name of an 0..1 aggregation
41464
+ */
41465
+ sAggregationName: string,
41466
+ /**
41467
+ * the managed object that is set as aggregated object
41468
+ */
41469
+ oObject: sap.ui.base.ManagedObject,
41470
+ /**
41471
+ * if true, this ManagedObject is not marked as changed
41472
+ */
41473
+ bSuppressInvalidate?: boolean
41474
+ ): this;
41346
41475
  /**
41347
41476
  * Sets the associated {@link #getFieldHelpDisplay fieldHelpDisplay}.
41348
41477
  *
@@ -44410,7 +44539,9 @@ declare namespace sap {
44410
44539
  /**
44411
44540
  * The locale or language tag
44412
44541
  */
44413
- vLocale: sap.ui.core.Locale | /* was: sap.base.i18n.LanguageTag */ any
44542
+ vLocale:
44543
+ | sap.ui.core.Locale
44544
+ | import("sap/base/i18n/LanguageTag").default
44414
44545
  ): sap.ui.core.LocaleData;
44415
44546
  /**
44416
44547
  * Returns a metadata object for class sap.ui.core.LocaleData.
@@ -51358,223 +51489,6 @@ declare namespace sap {
51358
51489
  TooltipBase
51359
51490
  >;
51360
51491
  }
51361
- /**
51362
- * Provides access to UI5 loader configuration.
51363
- *
51364
- * The configuration is used by {@link sap.ui.require} and {@link sap.ui.define}.
51365
- */
51366
- namespace loader {
51367
- /**
51368
- * Sets the configuration for the UI5 loader. The configuration can be updated multiple times. Later changes
51369
- * do not impact modules that have been loaded before.
51370
- *
51371
- * If no parameter is given, a partial copy of UI5 loader configuration in use is returned.
51372
- *
51373
- * The configuration options are aligned with the "Common Config" draft of the AMD spec (https://github.com/amdjs/amdjs-api/blob/master/CommonConfig.md).
51374
- *
51375
- * The following code shows an example of what a UI5 loader configuration might look like:
51376
- * ```javascript
51377
- *
51378
- *
51379
- * sap.ui.loader.config({
51380
- *
51381
- * // location from where to load all modules by default
51382
- * baseUrl: '../../resources/',
51383
- *
51384
- * paths: {
51385
- * // load modules whose ID equals to or starts with 'my/module' from example.com
51386
- * 'my/module': 'https://example.com/resources/my/module'
51387
- * },
51388
- *
51389
- * map: {
51390
- * // if any module requires 'sinon', load module 'sap/ui/thirdparty/sinon-4'
51391
- * '*': {
51392
- * 'sinon': 'sap/ui/thirdparty/sinon-4'
51393
- * },
51394
- * // but if a module whose ID equals to or starts with 'app' requires 'sinon'
51395
- * // then load a legacy version instead
51396
- * "app": {
51397
- * 'sinon': 'sap/ui/legacy/sinon'
51398
- * }
51399
- * },
51400
- *
51401
- * // define two bundles that consists of JS modules only
51402
- * bundles: {
51403
- * bundle1: ['module1', 'module2'],
51404
- * bundle2: ['moduleX', 'moduleY']
51405
- * },
51406
- *
51407
- * // define a bundle that also contains non-JS resources
51408
- * bundlesUI5: {
51409
- * 'all.js': ['Component.js', 'manifest.json',
51410
- * 'App.controller.js', 'App.view.xml']
51411
- * },
51412
- *
51413
- * // activate real async loading and module definitions
51414
- * async: true,
51415
- *
51416
- * // provide dependency and export metadata for non-UI5 modules
51417
- * shim: {
51418
- * 'sap/ui/thirdparty/blanket': {
51419
- * amd: true,
51420
- * exports: 'blanket'
51421
- * }
51422
- * }
51423
- *
51424
- * });
51425
- *
51426
- * ```
51427
- *
51428
- *
51429
- * @since 1.56.0
51430
- *
51431
- * @returns UI5 loader configuration in use.
51432
- */
51433
- function config(
51434
- /**
51435
- * The provided configuration gets merged with the UI5 loader configuration in use. If `cfg` is omitted
51436
- * or `undefined`, a copy of the current configuration gets returned, containing at least the properties
51437
- * `amd` and `async`.
51438
- */
51439
- cfg?: {
51440
- /**
51441
- * Default location to load modules from. If none of the configured `paths` prefixes matches a module ID,
51442
- * the module will be loaded from the concatenation of the `baseUrl` and the module ID.
51443
- *
51444
- * If the `baseUrl` itself is a relative URL, it is evaluated relative to `document.baseURI`.
51445
- */
51446
- baseUrl?: string;
51447
- /**
51448
- * A map of resource locations keyed by a corresponding module ID prefix. When a module is to be loaded,
51449
- * the longest key in `paths` is searched that is a prefix of the module ID. The module will be loaded from
51450
- * the concatenation of the corresponding value in `paths` and the remainder of the module ID (after the
51451
- * prefix). If no entry in `paths` matches, then the module will be loaded from the `baseUrl`.
51452
- *
51453
- * The prefixes (keys) must not contain relative segments (./ or ../), a trailing slash will be removed,
51454
- * and only full name segment matches are considered a match (prefix 'sap/m' does not match a module ID
51455
- * 'sap/main').
51456
- *
51457
- * **Note**: In contrast to the "Common Config" of the AMD spec, the paths (values in the map) are interpreted
51458
- * relative to `document.baseURI`, not relative to `cfg.baseUrl`.
51459
- */
51460
- paths?: Record<string, string>;
51461
- /**
51462
- * A map of maps that defines how to map module IDs to other module IDs (inner maps) in the context of a
51463
- * specific set of modules (keys of outer map).
51464
- *
51465
- * Each key of the outer map represents a module ID prefix that describes the context for which its value
51466
- * (inner map) has to be used. The special key `*` describes the default context which applies for any module.
51467
- * Only the most specific matching context will be taken into account.
51468
- *
51469
- * Each inner map maps a module ID or module ID prefix to another module ID or module ID prefix. Again,
51470
- * only the most specific match is taken into account and only one mapping is evaluated (the evaluation
51471
- * of the mappings is not done recursively).
51472
- *
51473
- * Matches are always complete matches, a prefix 'a/b/c' does not match the module ID 'a/b/com'.
51474
- */
51475
- map?: Record<string, Record<string, string>>;
51476
- /**
51477
- * Defines additional metadata for modules for which the normal behavior of the AMD APIs is not sufficient.
51478
- *
51479
- * A typical example are scripts that don't use `define` or `sap.ui.define`, but export to a global name.
51480
- * With the `exports` property, one or more export names can be specified, and the loader can retrieve the
51481
- * exported value after executing the corresponding module. If such a module has dependencies, they can
51482
- * be specified in the `deps` array and are loaded and executed before executing the module.
51483
- *
51484
- * The `amd` flag of a shim is a ui5loader-specific extension of the standard AMD shims. If set, the ui5loader
51485
- * hides a currently active AMD loader before executing the module and restores it afterwards. Otherwise,
51486
- * it might miss the export of third party modules that check for an AMD loader and register with it instead
51487
- * of exporting to a global name. A future version of the ui5loader might ignore this flag when it acts
51488
- * as an AMD loader by itself.
51489
- *
51490
- * **Note:** The ui5loader does not support the `init` option described by the "Common Config" section of
51491
- * the AMD spec.
51492
- */
51493
- shim?: Record<
51494
- string,
51495
- {
51496
- amd: boolean;
51497
-
51498
- deps: string[];
51499
-
51500
- exports: string | string[];
51501
- }
51502
- >;
51503
- /**
51504
- * A map of arrays that each define the modules contained in a bundle.
51505
- *
51506
- * Each key of the map represents the module ID of a bundle file. The array value represents the set of
51507
- * JavaScript modules (their module IDs) that are contained in the bundle.
51508
- *
51509
- * When a module is required that has not been loaded yet, and for which a containing bundle is known, that
51510
- * bundle will be required first. Only then the original module will be required again and usually be taken
51511
- * from the just loaded bundle.
51512
- *
51513
- * A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
51514
- * for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
51515
- * loaded synchronously to fulfill API contracts.
51516
- *
51517
- * **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
51518
- * of multiple bundles, only the last one will be taken into account.
51519
- *
51520
- * This configuration option is basically provided to be compatible with requireJS or SystemJS configuration.
51521
- */
51522
- bundles?: Record<string, string[]>;
51523
- /**
51524
- * A map of arrays that each define the resources contained in a bundle.
51525
- *
51526
- * This is similar to `bundles`, but all strings are unified resource names including a file type extension,
51527
- * not only module IDs. This allows to represent more than just JavaScript modules.
51528
- *
51529
- * Each key of the map represents the resource name (in unified resource name syntax) of a bundle file.
51530
- * The array value represents the set of resources (also in unified resource name syntax) that are contained
51531
- * in the bundle. The array can contain JavaScript as well as other textual resource types (e.g. *.xml or
51532
- * *.json resources).
51533
- *
51534
- * When a module is required that has not been loaded yet, and for which a containing bundle is known, that
51535
- * bundle will be required first. Only then the original module will be required again and usually be taken
51536
- * from the just loaded bundle.
51537
- *
51538
- * A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
51539
- * for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
51540
- * loaded synchronously to fulfill API contracts.
51541
- *
51542
- * **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
51543
- * of multiple bundles, only the last one will be taken into account.
51544
- *
51545
- * **Note:** Although non-JS resources can be declared to be part of a bundle, only requests for JavaScript
51546
- * modules will currently trigger the loading of a bundle.
51547
- */
51548
- bundlesUI5?: Record<string, string[]>;
51549
- /**
51550
- * When set to true, `sap.ui.require` loads modules asynchronously via script tags and `sap.ui.define` executes
51551
- * asynchronously. To enable this feature, it is recommended to set the attribute `data-sap-ui-async="true"`
51552
- * on the application bootstrap tag.
51553
- *
51554
- * **Note:** Switching back from async to sync is not supported and trying to do so will throw an `Error`
51555
- */
51556
- async?: boolean;
51557
- /**
51558
- * When set to true, the ui5loader will overwrite the global properties `define` and `require` with its
51559
- * own implementations. Any previously active AMD loader will be remembered internally and can be restored
51560
- * by setting `amd` to false again.
51561
- *
51562
- * **Note:** Switching to the `amd` mode, the ui5loader will set `async` to true implicitly for activating
51563
- * asynchronous loading. Once the loading behaviour has been defined to be asynchronous, it can not be changed
51564
- * to synchronous behaviour again, also not via setting `amd` to false.
51565
- */
51566
- amd?: boolean;
51567
- }
51568
- ):
51569
- | {
51570
- amd: boolean;
51571
-
51572
- async: boolean;
51573
-
51574
- noConflict: boolean;
51575
- }
51576
- | undefined;
51577
- }
51578
51492
  /**
51579
51493
  * The SAPUI5 Data Binding API.
51580
51494
  *
@@ -53828,10 +53742,10 @@ declare namespace sap {
53828
53742
  */
53829
53743
  oContext: sap.ui.model.Context,
53830
53744
  /**
53831
- * Parameters, specifying the aggregation level for which contexts shall be fetched or (legacy signature
53832
- * variant) index of first child entry to return from the parent context (zero-based)
53745
+ * Parameters, specifying the aggregation level for which contexts shall be fetched or the index of the
53746
+ * first child entry to return from the parent contexts
53833
53747
  */
53834
- mParameters:
53748
+ mParameters?:
53835
53749
  | {
53836
53750
  /**
53837
53751
  * Level number for oContext, because it might occur at multiple levels; context with group ID `"/"` has
@@ -53943,7 +53857,7 @@ declare namespace sap {
53943
53857
  * value can be set to define the parameter `startIndex` as described in this parameter list. In this case,
53944
53858
  * the function parameters `iLength`, `iNumberOfExpandedLevels` and `iThreshold` become mandatory.
53945
53859
  */
53946
- mParameters:
53860
+ mParameters?:
53947
53861
  | {
53948
53862
  /**
53949
53863
  * Number of entries to return at and after the given start index; defaults to the model's size limit, see
@@ -59236,7 +59150,10 @@ declare namespace sap {
59236
59150
  *
59237
59151
  * @ui5-protected Do not call from applications (only from related classes in the framework)
59238
59152
  *
59239
- * @returns The array of already available contexts with the first entry containing the context for `iStartIndex`
59153
+ * @returns The array of already available contexts with the first entry containing the context for `iStartIndex`.
59154
+ * Since 1.131.0, the array has an additional property `bExpectMore`, which is `true` if the response is
59155
+ * not complete, a {@link #event:change 'change'} event will follow, and a busy indicator should be switched
59156
+ * on.
59240
59157
  */
59241
59158
  getContexts(
59242
59159
  /**
@@ -62446,6 +62363,33 @@ declare namespace sap {
62446
62363
  context?: boolean;
62447
62364
  }
62448
62365
 
62366
+ /**
62367
+ * Parameters of the ODataListBinding#separateReceived event.
62368
+ *
62369
+ * @experimental (since 1.131.0)
62370
+ */
62371
+ interface ODataListBinding$SeparateReceivedEventParameters {
62372
+ /**
62373
+ * The requested property name
62374
+ */
62375
+ property?: string;
62376
+
62377
+ /**
62378
+ * The start index of the requested range
62379
+ */
62380
+ start?: number;
62381
+
62382
+ /**
62383
+ * The length of the requested range
62384
+ */
62385
+ length?: number;
62386
+
62387
+ /**
62388
+ * A UI5 message of type {@link module:sap/ui/core/message/MessageType MessageType.Error}
62389
+ */
62390
+ errorMessage?: sap.ui.core.message.Message;
62391
+ }
62392
+
62449
62393
  /**
62450
62394
  * Parameters of the ODataModel#dataReceived event.
62451
62395
  */
@@ -68041,6 +67985,16 @@ declare namespace sap {
68041
67985
  ODataListBinding
68042
67986
  >;
68043
67987
 
67988
+ /**
67989
+ * Event object of the ODataListBinding#separateReceived event.
67990
+ *
67991
+ * @experimental (since 1.131.0)
67992
+ */
67993
+ type ODataListBinding$SeparateReceivedEvent = sap.ui.base.Event<
67994
+ ODataListBinding$SeparateReceivedEventParameters,
67995
+ ODataListBinding
67996
+ >;
67997
+
68044
67998
  /**
68045
67999
  * Event object of the ODataModel#dataReceived event.
68046
68000
  */
@@ -75506,11 +75460,11 @@ declare namespace sap {
75506
75460
  */
75507
75461
  getCount(): number | undefined;
75508
75462
  /**
75509
- * Return node contexts for the tree
75463
+ * Return node contexts for the tree.
75510
75464
  *
75511
75465
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75512
75466
  *
75513
- * @returns the contexts array
75467
+ * @returns the context's array
75514
75468
  */
75515
75469
  getNodeContexts(
75516
75470
  /**
@@ -75518,42 +75472,44 @@ declare namespace sap {
75518
75472
  */
75519
75473
  oContext: sap.ui.model.Context,
75520
75474
  /**
75521
- * the startIndex where to start the retrieval of contexts
75475
+ * the index from which to start the retrieval of contexts
75522
75476
  */
75523
- iStartIndex: int,
75477
+ iStartIndex?: int,
75524
75478
  /**
75525
- * determines how many contexts to retrieve beginning from the start index.
75479
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
75480
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
75526
75481
  */
75527
- iLength: int
75482
+ iLength?: int
75528
75483
  ): sap.ui.model.Context[];
75529
75484
  /**
75530
- * Return root contexts for the tree
75485
+ * Return root contexts for the tree.
75531
75486
  *
75532
75487
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75533
75488
  *
75534
- * @returns the contexts array
75489
+ * @returns the context's array
75535
75490
  */
75536
75491
  getRootContexts(
75537
75492
  /**
75538
- * the startIndex where to start the retrieval of contexts
75493
+ * the index from which to start the retrieval of contexts
75539
75494
  */
75540
- iStartIndex: int,
75495
+ iStartIndex?: int,
75541
75496
  /**
75542
- * determines how many contexts to retrieve beginning from the start index.
75497
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
75498
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
75543
75499
  */
75544
- iLength: int
75545
- ): object[];
75500
+ iLength?: int
75501
+ ): sap.ui.model.Context[];
75546
75502
  /**
75547
75503
  * Returns if the node has child nodes.
75548
75504
  *
75549
75505
  *
75550
- * @returns true if node has children
75506
+ * @returns `true` if the node has children
75551
75507
  */
75552
75508
  hasChildren(
75553
75509
  /**
75554
75510
  * the context element of the node
75555
75511
  */
75556
- oContext: object
75512
+ oContext: sap.ui.model.Context
75557
75513
  ): boolean;
75558
75514
  /**
75559
75515
  * Sorts the contexts of this ClientTreeBinding. The tree will be sorted level by level. So the nodes are
@@ -76677,7 +76633,8 @@ declare namespace sap {
76677
76633
  */
76678
76634
  constructor(
76679
76635
  /**
76680
- * Filter info object or a path or an array of filters
76636
+ * Filter info object or a path or an array of filters; if a filter info object is given, the other constructor
76637
+ * parameters are ignored
76681
76638
  */
76682
76639
  vFilterInfo:
76683
76640
  | {
@@ -78835,21 +78792,41 @@ declare namespace sap {
78835
78792
  */
78836
78793
  constructor(
78837
78794
  /**
78838
- * the binding path used for sorting
78795
+ * The binding path used for sorting or the sorter info object; if a sorter info object is given, the other
78796
+ * constructor parameters are ignored
78839
78797
  */
78840
- sPath: string,
78798
+ vSorterInfo:
78799
+ | string
78800
+ | {
78801
+ /**
78802
+ * See `fnComparator` parameter
78803
+ */
78804
+ comparator?: Function;
78805
+ /**
78806
+ * See `bDescending` parameter
78807
+ */
78808
+ descending?: boolean;
78809
+ /**
78810
+ * See `vGroup` parameter
78811
+ */
78812
+ group?: boolean | Function;
78813
+ /**
78814
+ * The binding path for this sorter
78815
+ */
78816
+ path?: string;
78817
+ },
78841
78818
  /**
78842
- * whether the sort order should be descending
78819
+ * Whether the sort order is descending
78843
78820
  */
78844
78821
  bDescending?: boolean,
78845
78822
  /**
78846
- * configure grouping of the content, can either be true to enable grouping based on the raw model property
78847
- * value, or a function which calculates the group value out of the context (e.g. oContext.getProperty("date").getYear()
78848
- * for year grouping). The control needs to implement the grouping behaviour for the aggregation which you
78849
- * want to group. In case a function is provided it must either return a primitive type value as the group
78850
- * key or an object containing a "key" property and additional properties needed for group visualization.
78851
- * This object or the object with the primitive type return value as "key" property is passed to the `groupHeaderFactory`
78852
- * function that has been specified to create the group header for the control aggregation; see {@link sap.ui.base.ManagedObject#bindAggregation}.
78823
+ * Configure grouping of the content, can either be `true` to enable grouping based on the raw model property
78824
+ * value, or a function which calculates the group value out of the context (e.g. `oContext.getProperty("date").getYear()`
78825
+ * for year grouping). The control needs to implement the grouping behaviour. In case a function is provided
78826
+ * it must either return a primitive type value as the group key or an object containing a "key" property
78827
+ * and additional properties needed for group visualization. This object or the object with the primitive
78828
+ * type return value as "key" property is passed to the `groupHeaderFactory` function that has been specified
78829
+ * to create the group header for the control aggregation; see {@link sap.ui.base.ManagedObject#bindAggregation}.
78853
78830
  * **Note:** Grouping via `vGroup=true` is only possible (and only makes sense) for the primary sort property.
78854
78831
  * A more complicated grouping is possible by providing a grouping function. The sort order needs to fit
78855
78832
  * to the grouping also in this case. See also {@link https://ui5.sap.com/#/topic/ec79a5d5918f4f7f9cbc2150e66778cc Sorting, Grouping, and Filtering for List Binding}.
@@ -78857,7 +78834,7 @@ declare namespace sap {
78857
78834
  vGroup?: boolean | Function,
78858
78835
  /**
78859
78836
  * A custom comparator function, which is used for client-side sorting instead of the default comparator
78860
- * method. Information about parameters and expected return values of such a method can be found in the
78837
+ * method; information about parameters and expected return values of such a method can be found in the
78861
78838
  * {@link #.defaultComparator default comparator} documentation. **Note:** Custom comparator functions are
78862
78839
  * meant to be used on the client. Models that implement sorting in the backend usually don't support custom
78863
78840
  * comparator functions. Consult the documentation of the specific model implementation.
@@ -78942,6 +78919,22 @@ declare namespace sap {
78942
78919
  * @returns The group function
78943
78920
  */
78944
78921
  getGroupFunction(): Function;
78922
+ /**
78923
+ * Returns the binding path for this sorter; see the path parameter of {@link sap.ui.model.Sorter#constructor}.
78924
+ *
78925
+ * @since 1.131.0
78926
+ *
78927
+ * @returns The binding path
78928
+ */
78929
+ getPath(): string;
78930
+ /**
78931
+ * Whether to sort in descending order; see the descending parameter of {@link sap.ui.model.Sorter#constructor}.
78932
+ *
78933
+ * @since 1.131.0
78934
+ *
78935
+ * @returns Whether to sort in descending order
78936
+ */
78937
+ isDescending(): boolean;
78945
78938
  }
78946
78939
  /**
78947
78940
  * The `StaticBinding` allows to define static values within a {@link sap.ui.model.CompositeBinding}. It
@@ -79014,7 +79007,7 @@ declare namespace sap {
79014
79007
  /**
79015
79008
  * Context object for this binding (optional)
79016
79009
  */
79017
- oContext?: object,
79010
+ oContext?: sap.ui.model.Context,
79018
79011
  /**
79019
79012
  * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
79020
79013
  * to replace them
@@ -79023,7 +79016,7 @@ declare namespace sap {
79023
79016
  /**
79024
79017
  * Additional model specific parameters (optional)
79025
79018
  */
79026
- mParameters?: string,
79019
+ mParameters?: object,
79027
79020
  /**
79028
79021
  * The sorters used initially; call {@link #sort} to replace them
79029
79022
  */
@@ -79115,7 +79108,7 @@ declare namespace sap {
79115
79108
  sFilterType?: sap.ui.model.FilterType
79116
79109
  ): void;
79117
79110
  /**
79118
- * Returns the number of child nodes of a specific context
79111
+ * Returns the number of child nodes of a specific context.
79119
79112
  *
79120
79113
  *
79121
79114
  * @returns the number of children
@@ -79124,7 +79117,7 @@ declare namespace sap {
79124
79117
  /**
79125
79118
  * the context element of the node
79126
79119
  */
79127
- oContext: Object
79120
+ oContext: sap.ui.model.Context
79128
79121
  ): int;
79129
79122
  /**
79130
79123
  * Returns the count of entries in the tree, or `undefined` if it is unknown. If the tree is filtered, the
@@ -79140,7 +79133,7 @@ declare namespace sap {
79140
79133
  */
79141
79134
  getCount(): number | undefined;
79142
79135
  /**
79143
- * Returns the current value of the bound target
79136
+ * Returns the current value of the bound target.
79144
79137
  *
79145
79138
  *
79146
79139
  * @returns the array of child contexts for the given node
@@ -79151,41 +79144,43 @@ declare namespace sap {
79151
79144
  */
79152
79145
  oContext: sap.ui.model.Context,
79153
79146
  /**
79154
- * the startIndex where to start the retrieval of contexts
79147
+ * the index from which to start the retrieval of contexts
79155
79148
  */
79156
- iStartIndex: int,
79149
+ iStartIndex?: int,
79157
79150
  /**
79158
- * determines how many contexts to retrieve beginning from the start index.
79151
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
79152
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
79159
79153
  */
79160
- iLength: int
79154
+ iLength?: int
79161
79155
  ): sap.ui.model.Context[];
79162
79156
  /**
79163
- * Returns the current value of the bound target
79157
+ * Returns the current value of the bound target.
79164
79158
  *
79165
79159
  *
79166
79160
  * @returns the array of child contexts for the root node
79167
79161
  */
79168
79162
  getRootContexts(
79169
79163
  /**
79170
- * the startIndex where to start the retrieval of contexts
79164
+ * the index from which to start the retrieval of contexts
79171
79165
  */
79172
- iStartIndex: int,
79166
+ iStartIndex?: int,
79173
79167
  /**
79174
- * determines how many contexts to retrieve beginning from the start index.
79168
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
79169
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
79175
79170
  */
79176
- iLength: int
79177
- ): any[];
79171
+ iLength?: int
79172
+ ): sap.ui.model.Context[];
79178
79173
  /**
79179
- * Returns if the node has child nodes
79174
+ * Returns `true` if the node has child nodes.
79180
79175
  *
79181
79176
  *
79182
- * @returns true if node has children
79177
+ * @returns `true` if the node has children
79183
79178
  */
79184
79179
  hasChildren(
79185
79180
  /**
79186
79181
  * the context element of the node
79187
79182
  */
79188
- oContext: Object
79183
+ oContext: sap.ui.model.Context
79189
79184
  ): boolean;
79190
79185
  /**
79191
79186
  * Sorts the tree according to the sorter definitions.