@openui5/ts-types 1.95.0 → 1.96.3

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.
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.95.0
267
+ // For Library Version: 1.96.3
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -13300,206 +13300,6 @@ declare namespace sap {
13300
13300
  ): number | any[] | string;
13301
13301
  }
13302
13302
  }
13303
- /**
13304
- * The IconPool is a static class for retrieving or registering icons. It also provides helping methods
13305
- * for easier consumption of icons. There are already icons registered in IconPool, please use the Demo
13306
- * App named "Icon Explorer" to find the name of the icon.
13307
- *
13308
- * In order to use the icon inside an existing control, please call {@link sap.ui.core.IconPool.getIconURI}
13309
- * and assign the URI to the control's property which supports icons. If you want to support both, icons
13310
- * and standard images in your own control, please use the static method {@link sap.ui.core.IconPool.createControlByURI}
13311
- * to either create an Icon in case the first argument is an icon-URL or another control which you define
13312
- * by providing it as the second argument.
13313
- */
13314
- namespace IconPool {
13315
- /**
13316
- * Register an additional icon to the sap.ui.core.IconPool.
13317
- */
13318
- function addIcon(
13319
- /**
13320
- * the name of the icon.
13321
- */
13322
- iconName: string,
13323
- /**
13324
- * the name of icon collection. The built in icons are with empty collectionName, so if additional icons
13325
- * need to be registered in IconPool, the collectionName can't be empty.
13326
- */
13327
- collectionName: string,
13328
- /**
13329
- * the icon info which contains the following properties:
13330
- */
13331
- iconInfo: {
13332
- /**
13333
- * is the name of the font when importing the font using @font-face in CSS
13334
- */
13335
- fontFamily: string;
13336
- /**
13337
- * is the special hexadecimal code without the prefix, for example "e000" or several of them
13338
- */
13339
- content: string | string[];
13340
- /**
13341
- * indicates if already registered icons should be overwritten when the same name and collection are given.
13342
- * The built in icons can never be overwritten.
13343
- */
13344
- overWrite?: boolean;
13345
- /**
13346
- * indicates whether this icon should NOT be mirrored in RTL (right to left) mode.
13347
- */
13348
- suppressMirroring?: boolean;
13349
- /**
13350
- * ResourceBundle to be used for translation. Key format: "Icon.".
13351
- */
13352
- resourceBundle?: import("sap/base/i18n/ResourceBundle").default;
13353
- }
13354
- ): object;
13355
- /**
13356
- * Creates an instance of {@link sap.ui.core.Icon} if the given URI is an icon URI, otherwise the given
13357
- * constructor is called. The given URI is set to the src property of the control.
13358
- */
13359
- function createControlByURI(
13360
- /**
13361
- * Contains the properties which will be used to instantiate the returned control. All properties of the
13362
- * associated constructor can be used. Unknown properties are ignored. It should contain at least a property
13363
- * named src. If it's given with a string type, it will be taken as the value of src property.
13364
- */
13365
- setting: string | object,
13366
- /**
13367
- * The constructor function which is called when the given URI isn't an icon URI
13368
- */
13369
- constructor: Function
13370
- ): sap.ui.core.Control;
13371
- /**
13372
- * @SINCE 1.56.0
13373
- *
13374
- * Checks if the icon font is loaded
13375
- */
13376
- function fontLoaded(
13377
- /**
13378
- * icon collection name
13379
- */
13380
- sCollectionName: string
13381
- ): Promise<any> | undefined;
13382
- /**
13383
- * Returns all names of registered collections in IconPool
13384
- */
13385
- function getIconCollectionNames(): any[];
13386
- /**
13387
- * @SINCE 1.25.0
13388
- *
13389
- * Returns the icon url based on the given mime type
13390
- */
13391
- function getIconForMimeType(
13392
- /**
13393
- * the mime type of a file (e.g. "application/zip")
13394
- */
13395
- sMimeType: string
13396
- ): string;
13397
- /**
13398
- * Returns an info object for the icon with the given `iconName` and `collectionName`.
13399
- *
13400
- * Instead of giving name and collection, a complete icon-URI can be provided as `iconName`. The method
13401
- * will determine name and collection from the URI, see {@link #.isIconURI IconPool.isIconURI} for details.
13402
- *
13403
- * The returned info object has the following properties:
13404
- * - `string: name` Name of the icon
13405
- * - `string: collection` Name of the collection that contains the icon or `undefined` in case of the
13406
- * default collection
13407
- * - `string: uri` Icon URI that identifies the icon
13408
- * - `string: fontFamily` CSS font family to use for this icon
13409
- * - `string: content` Character sequence that represents the icon in the icon font
13410
- * - `string: text` Alternative text describing the icon (optional, might be empty)
13411
- * - `boolean: suppressMirroring` Whether the icon needs no mirroring in right-to-left mode
13412
- */
13413
- function getIconInfo(
13414
- /**
13415
- * Name of the icon, or a complete icon-URI with icon collection and icon name; must not be empty
13416
- */
13417
- iconName: string,
13418
- /**
13419
- * Name of the icon collection; to access built-in icons, omit the collection name
13420
- */
13421
- collectionName?: string,
13422
- /**
13423
- * The approach for loading the icon info, if it is not already available: sync - font metadata is loaded
13424
- * synchronously and the icon info is returned immediately async - a promise is returned that returns the
13425
- * icon info when the font metadata is loaded mixed - until the font metadata is loaded a promise is returned,
13426
- * afterwards the icon info
13427
- */
13428
- loadingMode?: string
13429
- ): object | Promise<any> | undefined;
13430
- /**
13431
- * Returns all name of icons that are registered under the given collection.
13432
- */
13433
- function getIconNames(
13434
- /**
13435
- * the name of collection where icon names are retrieved.
13436
- */
13437
- collectionName: string
13438
- ): any[];
13439
- /**
13440
- * Returns the URI of the icon in the pool which has the given `iconName` and `collectionName`.
13441
- */
13442
- function getIconURI(
13443
- /**
13444
- * Name of the icon, must not be empty
13445
- */
13446
- iconName: string,
13447
- /**
13448
- * Name of the icon collection; to access built-in icons, omit the collection name
13449
- */
13450
- collectionName?: string
13451
- ): string;
13452
- /**
13453
- * Returns whether the given `uri` is an icon URI.
13454
- *
13455
- * A string is an icon URI when it can be parsed as a URI and when it has one of the two forms
13456
- * - sap-icon://collectionName/iconName
13457
- * - sap-icon://iconName where collectionName and iconName must be non-empty.
13458
- */
13459
- function isIconURI(
13460
- /**
13461
- * The URI to check
13462
- */
13463
- uri: string
13464
- ): boolean;
13465
- /**
13466
- * @SINCE 1.56.0
13467
- *
13468
- * Registers an additional icon font to the icon pool
13469
- */
13470
- function registerFont(
13471
- /**
13472
- * configuration object for registering the font
13473
- */
13474
- oConfig: {
13475
- /**
13476
- * the file name of the font face
13477
- */
13478
- fontFamily: string;
13479
- /**
13480
- * a collection name for the font, if not specified the font face will be used
13481
- */
13482
- collectionName?: string;
13483
- /**
13484
- * the location where the font files are physically located
13485
- */
13486
- fontURI: sap.ui.core.URI;
13487
- /**
13488
- * a configuration object mapping the icon name to the hexadecimal icon address in the font
13489
- */
13490
- metadata?: object;
13491
- /**
13492
- * an URI to a file containing the configuration object specified with oConfig.metadata
13493
- */
13494
- metadataURI?: object;
13495
- /**
13496
- * load the icon font metadata only when an icon is requested with {@link #.getIconInfo} if not specified
13497
- * a JSON file with the name oConfig.fontFamily will be loaded from the location specified in oConfig.fontURI
13498
- */
13499
- lazy?: boolean;
13500
- }
13501
- ): void;
13502
- }
13503
13303
 
13504
13304
  namespace message {
13505
13305
  /**
@@ -16251,14 +16051,6 @@ declare namespace sap {
16251
16051
  * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
16252
16052
  * API calls for the same parameter name will always result in the same parameter value.
16253
16053
  *
16254
- * **Important, since 1.93:** When using the `Parameters.get()` API to retrieve theming parameters defined
16255
- * as CSS variables, please be aware that the API can also unknowingly retrieve arbitrary CSS variables
16256
- * defined in the DOM. All CSS variables defined via the `:root` pseudo-class can be retrieved this way.
16257
- * Please make sure to only access theming parameters defined in a UI5 theme/library.
16258
- *
16259
- *
16260
- *
16261
- *
16262
16054
  * The following API variants are available (see also the below examples):
16263
16055
  * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
16264
16056
  * returned
@@ -18417,7 +18209,7 @@ declare namespace sap {
18417
18209
  * The hash to be matched
18418
18210
  */
18419
18211
  sHash: string
18420
- ): object | undefined;
18212
+ ): sap.ui.core.routing.RouteInfo | undefined;
18421
18213
  /**
18422
18214
  * Returns a target by its name.
18423
18215
  *
@@ -19652,6 +19444,17 @@ declare namespace sap {
19652
19444
  fullHash?: string;
19653
19445
  };
19654
19446
 
19447
+ type RouteInfo = {
19448
+ /**
19449
+ * The route name
19450
+ */
19451
+ name: string;
19452
+ /**
19453
+ * The route data
19454
+ */
19455
+ arguments: Record<string, string>;
19456
+ };
19457
+
19655
19458
  /**
19656
19459
  * @SINCE 1.84.0
19657
19460
  *
@@ -25696,6 +25499,225 @@ declare namespace sap {
25696
25499
  }
25697
25500
  const ExtensionPoint: ExtensionPoint;
25698
25501
 
25502
+ /**
25503
+ * The IconPool is a static class for retrieving or registering icons. It also provides helping methods
25504
+ * for easier consumption of icons. There are already icons registered in IconPool, please use the Demo
25505
+ * App named "Icon Explorer" to find the name of the icon.
25506
+ *
25507
+ * In order to use the icon inside an existing control, please call {@link sap.ui.core.IconPool.getIconURI}
25508
+ * and assign the URI to the control's property which supports icons. If you want to support both, icons
25509
+ * and standard images in your own control, please use the static method {@link sap.ui.core.IconPool.createControlByURI}
25510
+ * to either create an Icon in case the first argument is an icon-URL or another control which you define
25511
+ * by providing it as the second argument.
25512
+ */
25513
+ interface IconPool {
25514
+ /**
25515
+ * Register an additional icon to the sap.ui.core.IconPool.
25516
+ */
25517
+ addIcon(
25518
+ /**
25519
+ * the name of the icon.
25520
+ */
25521
+ iconName: string,
25522
+ /**
25523
+ * the name of icon collection. The built in icons are with empty collectionName, so if additional icons
25524
+ * need to be registered in IconPool, the collectionName can't be empty.
25525
+ */
25526
+ collectionName: string,
25527
+ /**
25528
+ * the icon info which contains the following properties:
25529
+ */
25530
+ iconInfo: {
25531
+ /**
25532
+ * is the name of the font when importing the font using @font-face in CSS
25533
+ */
25534
+ fontFamily: string;
25535
+ /**
25536
+ * is the special hexadecimal code without the prefix, for example "e000" or several of them
25537
+ */
25538
+ content: string | string[];
25539
+ /**
25540
+ * indicates if already registered icons should be overwritten when the same name and collection are given.
25541
+ * The built in icons can never be overwritten.
25542
+ */
25543
+ overWrite?: boolean;
25544
+ /**
25545
+ * indicates whether this icon should NOT be mirrored in RTL (right to left) mode.
25546
+ */
25547
+ suppressMirroring?: boolean;
25548
+ /**
25549
+ * ResourceBundle to be used for translation. Key format: "Icon.".
25550
+ */
25551
+ resourceBundle?: import("sap/base/i18n/ResourceBundle").default;
25552
+ }
25553
+ ): object;
25554
+ /**
25555
+ * Creates an instance of {@link sap.ui.core.Icon} if the given URI is an icon URI, otherwise the given
25556
+ * constructor is called. The given URI is set to the src property of the control.
25557
+ */
25558
+ createControlByURI(
25559
+ /**
25560
+ * Contains the properties which will be used to instantiate the returned control. All properties of the
25561
+ * associated constructor can be used. Unknown properties are ignored. It should contain at least a property
25562
+ * named src. If it's given with a string type, it will be taken as the value of src property.
25563
+ */
25564
+ setting: string | object,
25565
+ /**
25566
+ * The constructor function which is called when the given URI isn't an icon URI
25567
+ */
25568
+ constructor: Function
25569
+ ): sap.ui.core.Control;
25570
+ /**
25571
+ * @SINCE 1.56.0
25572
+ *
25573
+ * Checks if the icon font is loaded
25574
+ */
25575
+ fontLoaded(
25576
+ /**
25577
+ * icon collection name
25578
+ */
25579
+ sCollectionName: string
25580
+ ): Promise<any> | undefined;
25581
+ /**
25582
+ * Returns all names of registered collections in IconPool
25583
+ */
25584
+ getIconCollectionNames(): any[];
25585
+ /**
25586
+ * @SINCE 1.25.0
25587
+ *
25588
+ * Returns the icon url based on the given mime type
25589
+ */
25590
+ getIconForMimeType(
25591
+ /**
25592
+ * the mime type of a file (e.g. "application/zip")
25593
+ */
25594
+ sMimeType: string
25595
+ ): string;
25596
+ /**
25597
+ * Returns an info object for the icon with the given `iconName` and `collectionName`.
25598
+ *
25599
+ * Instead of giving name and collection, a complete icon-URI can be provided as `iconName`. The method
25600
+ * will determine name and collection from the URI, see {@link #.isIconURI IconPool.isIconURI} for details.
25601
+ *
25602
+ * The returned info object has the following properties:
25603
+ * - `string: name` Name of the icon
25604
+ * - `string: collection` Name of the collection that contains the icon or `undefined` in case of the
25605
+ * default collection
25606
+ * - `string: uri` Icon URI that identifies the icon
25607
+ * - `string: fontFamily` CSS font family to use for this icon
25608
+ * - `string: content` Character sequence that represents the icon in the icon font
25609
+ * - `string: text` Alternative text describing the icon (optional, might be empty)
25610
+ * - `boolean: suppressMirroring` Whether the icon needs no mirroring in right-to-left mode
25611
+ */
25612
+ getIconInfo(
25613
+ /**
25614
+ * Name of the icon, or a complete icon-URI with icon collection and icon name; must not be empty
25615
+ */
25616
+ iconName: string,
25617
+ /**
25618
+ * Name of the icon collection; to access built-in icons, omit the collection name
25619
+ */
25620
+ collectionName?: string,
25621
+ /**
25622
+ * The approach for loading the icon info, if it is not already available: sync - font metadata is loaded
25623
+ * synchronously and the icon info is returned immediately async - a promise is returned that returns the
25624
+ * icon info when the font metadata is loaded mixed - until the font metadata is loaded a promise is returned,
25625
+ * afterwards the icon info
25626
+ */
25627
+ loadingMode?: string
25628
+ ): object | Promise<any> | undefined;
25629
+ /**
25630
+ * Returns all name of icons that are registered under the given collection.
25631
+ */
25632
+ getIconNames(
25633
+ /**
25634
+ * the name of collection where icon names are retrieved.
25635
+ */
25636
+ collectionName: string
25637
+ ): any[];
25638
+ /**
25639
+ * Returns the URI of the icon in the pool which has the given `iconName` and `collectionName`.
25640
+ */
25641
+ getIconURI(
25642
+ /**
25643
+ * Name of the icon, must not be empty
25644
+ */
25645
+ iconName: string,
25646
+ /**
25647
+ * Name of the icon collection; to access built-in icons, omit the collection name
25648
+ */
25649
+ collectionName?: string
25650
+ ): string;
25651
+ /**
25652
+ * Adds CSS code to load an icon font to the DOM
25653
+ */
25654
+ insertFontFaceStyle(
25655
+ /**
25656
+ * the file name of the font face
25657
+ */
25658
+ sFontFace: string,
25659
+ /**
25660
+ * the path to the font file
25661
+ */
25662
+ sPath: string,
25663
+ /**
25664
+ * the collection name, if not specified the font face is used
25665
+ */
25666
+ sCollectionName?: string
25667
+ ): void;
25668
+ /**
25669
+ * Returns whether the given `uri` is an icon URI.
25670
+ *
25671
+ * A string is an icon URI when it can be parsed as a URI and when it has one of the two forms
25672
+ * - sap-icon://collectionName/iconName
25673
+ * - sap-icon://iconName where collectionName and iconName must be non-empty.
25674
+ */
25675
+ isIconURI(
25676
+ /**
25677
+ * The URI to check
25678
+ */
25679
+ uri: string
25680
+ ): boolean;
25681
+ /**
25682
+ * @SINCE 1.56.0
25683
+ *
25684
+ * Registers an additional icon font to the icon pool
25685
+ */
25686
+ registerFont(
25687
+ /**
25688
+ * configuration object for registering the font
25689
+ */
25690
+ oConfig: {
25691
+ /**
25692
+ * the file name of the font face
25693
+ */
25694
+ fontFamily: string;
25695
+ /**
25696
+ * a collection name for the font, if not specified the font face will be used
25697
+ */
25698
+ collectionName?: string;
25699
+ /**
25700
+ * the location where the font files are physically located
25701
+ */
25702
+ fontURI: sap.ui.core.URI;
25703
+ /**
25704
+ * a configuration object mapping the icon name to the hexadecimal icon address in the font
25705
+ */
25706
+ metadata?: object;
25707
+ /**
25708
+ * an URI to a file containing the configuration object specified with oConfig.metadata
25709
+ */
25710
+ metadataURI?: object;
25711
+ /**
25712
+ * load the icon font metadata only when an icon is requested with {@link #.getIconInfo} if not specified
25713
+ * a JSON file with the name oConfig.fontFamily will be loaded from the location specified in oConfig.fontURI
25714
+ */
25715
+ lazy?: boolean;
25716
+ }
25717
+ ): void;
25718
+ }
25719
+ const IconPool: IconPool;
25720
+
25699
25721
  /**
25700
25722
  * @SINCE 1.66
25701
25723
  *
@@ -27283,12 +27305,6 @@ declare namespace sap {
27283
27305
  * Container width in CSS size
27284
27306
  */
27285
27307
  getWidth(): sap.ui.core.CSSSize;
27286
- /**
27287
- * @SINCE 1.91
27288
- *
27289
- * Hides the placeholder that is shown on the component container.
27290
- */
27291
- hidePlaceholder(): void;
27292
27308
  /**
27293
27309
  * Sets a new value for property {@link #getAsync async}.
27294
27310
  *
@@ -27493,22 +27509,6 @@ declare namespace sap {
27493
27509
  */
27494
27510
  sWidth?: sap.ui.core.CSSSize
27495
27511
  ): this;
27496
- /**
27497
- * @SINCE 1.91
27498
- *
27499
- * Shows the provided placeholder on the component container.
27500
- */
27501
- showPlaceholder(
27502
- /**
27503
- * Object containing the placeholder object
27504
- */
27505
- mSettings: {
27506
- /**
27507
- * The placeholder instance
27508
- */
27509
- placeholder: /* was: sap.ui.core.Placeholder */ any;
27510
- }
27511
- ): Promise<any>;
27512
27512
  }
27513
27513
  /**
27514
27514
  * @SINCE 1.9.2
@@ -36179,7 +36179,7 @@ declare namespace sap {
36179
36179
  * A `sap.ui.core.UIComponent` subclass can additionally implement the {@link sap.ui.core.IAsyncContentCreation}
36180
36180
  * interface. When implementing this interface the loading and processing of an asynchronous `rootView`
36181
36181
  * will be chained into the result Promise of the {@link sap.ui.core.Component.create Component.create}
36182
- * factory. See Sample 1 below.
36182
+ * factory. An additional async flag can be omitted. See Sample 1 below.
36183
36183
  *
36184
36184
  * Samples 2 and 3 show how subclasses can overwrite the `createContent` function to run asynchronously.
36185
36185
  * To create the root control asynchronously, the subclass has to define the `sap.ui.core.IAsyncContentCreation`
@@ -37934,11 +37934,11 @@ declare namespace sap {
37934
37934
  /**
37935
37935
  * The SAPUI5 Data Binding API.
37936
37936
  *
37937
- * The default binding mode for model implementations (if not implemented otherwise) is two way and the
37938
- * supported binding modes by the model are one way, two way and one time. The default binding mode can
37937
+ * The default binding mode for model implementations (if not implemented otherwise) is two-way and the
37938
+ * supported binding modes by the model are one-way, two-way and one-time. The default binding mode can
37939
37939
  * be changed by the application for each model instance. A model implementation should specify its supported
37940
- * binding modes and set the default binding mode accordingly (e.g. if the model supports only one way binding
37941
- * the default binding mode should also be set to one way).
37940
+ * binding modes and set the default binding mode accordingly (e.g. if the model supports only one-way binding
37941
+ * the default binding mode should also be set to one-way).
37942
37942
  *
37943
37943
  * The default size limit for models is 100. The size limit determines the number of entries used for the
37944
37944
  * list bindings.
@@ -39548,10 +39548,9 @@ declare namespace sap {
39548
39548
  /**
39549
39549
  * A comma-separated list of property names that need to be selected.
39550
39550
  * If the `select` parameter is given, it has to contain all properties that are contained in the analytical
39551
- * information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}) and their associated
39552
- * dimensions and measures. It must not contain additional dimensions or measures or associated properties
39553
- * for additional dimensions or measures. But it may contain additional properties like a text property
39554
- * of a dimension that is also selected.
39551
+ * information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}). It must not
39552
+ * contain additional dimensions or measures or associated properties for additional dimensions or measures.
39553
+ * But it may contain additional properties like a text property of a dimension that is also selected.
39555
39554
  * All properties of the `select` parameter are also considered in {@link sap.ui.model.analytics.AnalyticalBinding#getDownloadUrl}.
39556
39555
  * The `select` parameter must not contain any duplicate entry.
39557
39556
  * If the `select` parameter does not fit to the analytical information or if the `select` parameter contains
@@ -39910,34 +39909,41 @@ declare namespace sap {
39910
39909
  * Updates the binding's structure with new analytical information.
39911
39910
  *
39912
39911
  * Analytical information is the mapping of UI columns to properties in the bound OData entity set. Every
39913
- * column object contains the name of the bound property and in addition:
39912
+ * column object contains the `name` of the bound property and in addition:
39914
39913
  * - A column bound to a dimension property has further boolean properties:
39915
- * grouped: dimension will be used for building groups
39916
- * - visible: if the column is visible, values for the related property will be fetched from the OData
39917
- * service
39914
+ * grouped: dimension is used for building groups
39918
39915
  * - inResult: if the column is not visible, but declared to be part of the result, values for the related
39919
- * property will also be fetched from the OData service
39916
+ * property are also fetched from the OData service
39917
+ * - visible: if the column is visible, values for the related property are fetched from the OData service
39918
+ *
39920
39919
  * - A column bound to a measure property has further boolean properties:
39921
- * total: totals and sub-totals will be provided for the measure at all aggregation levels
39920
+ * inResult: if the column is not visible, but declared to be part of the result, values for the related
39921
+ * property are also fetched from the OData service
39922
+ * - total: totals and sub-totals are provided for the measure at all aggregation levels
39923
+ * - visible: if the column is visible, values for the related property are fetched from the OData service
39922
39924
  *
39923
39925
  * - A column bound to a hierarchy property has further properties:
39924
- * grouped: boolean value; indicates whether the hierarchy will be used for building groups
39926
+ * grouped: boolean value; indicates whether the hierarchy is used for building groups
39925
39927
  * - level: integer value; the hierarchy level is mandatory for at least one of those columns that represent
39926
- * the same hierarchy.
39928
+ * the same hierarchy
39927
39929
  *
39928
39930
  * Invoking this function resets the state of the binding and subsequent data requests such as calls to
39929
- * getNodeContexts() will need to trigger OData requests in order to fetch the data that are in line with
39930
- * this analytical information.
39931
+ * getNodeContexts() trigger OData requests in order to fetch the data that are in line with this analytical
39932
+ * information.
39931
39933
  *
39932
- * Please be aware that a call of this function might lead to additional back-end requests, as well as a
39933
- * control re-rendering later on. Whenever possible use the API of the analytical control, instead of relying
39934
- * on the binding.
39934
+ * Be aware that a call of this function might lead to additional back-end requests, as well as a control
39935
+ * re-rendering later on. Whenever possible use the API of the analytical control, instead of relying on
39936
+ * the binding.
39935
39937
  */
39936
39938
  updateAnalyticalInfo(
39937
39939
  /**
39938
- * an array with objects holding the analytical information for every column, from left to right.
39940
+ * An array with objects holding the analytical information for every column
39941
+ */
39942
+ aColumns: object[],
39943
+ /**
39944
+ * Whether to fire a change event asynchronously even if columns didn't change
39939
39945
  */
39940
- aColumns: any[]
39946
+ bForceChange: boolean
39941
39947
  ): void;
39942
39948
  }
39943
39949
 
@@ -40392,17 +40398,17 @@ declare namespace sap {
40392
40398
  */
40393
40399
  static getMetadata(): sap.ui.base.Metadata;
40394
40400
  /**
40395
- * Returns the value for the property with the given `sPropertyName`
40401
+ * Returns the value for the property with the given `sPropertyName`.
40396
40402
  */
40397
40403
  getProperty(
40398
40404
  /**
40399
- * the path to the property
40405
+ * The path to the property
40400
40406
  */
40401
40407
  sPath: string,
40402
40408
  /**
40403
- * the context which will be used to retrieve the property
40409
+ * The context to resolve a relative path with
40404
40410
  */
40405
- oContext?: object
40411
+ oContext?: sap.ui.model.Context
40406
40412
  ): any;
40407
40413
  /**
40408
40414
  * Sets the message data to the model.
@@ -40419,7 +40425,20 @@ declare namespace sap {
40419
40425
  * Other models provide this method to set a new value for a specific property. `MessageModel` does not
40420
40426
  * support it as it supports the `OneWay` mode only.
40421
40427
  */
40422
- setProperty(): void;
40428
+ setProperty(
40429
+ /**
40430
+ * Unused in this implementation
40431
+ */
40432
+ sPath: string,
40433
+ /**
40434
+ * Unused in this implementation
40435
+ */
40436
+ oValue: object,
40437
+ /**
40438
+ * Unused in this implementation
40439
+ */
40440
+ oContext: sap.ui.model.Context
40441
+ ): void;
40423
40442
  }
40424
40443
  }
40425
40444
  /**
@@ -42942,6 +42961,7 @@ declare namespace sap {
42942
42961
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
42943
42962
  * - an OData binding
42944
42963
  * - a view element
42964
+ * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
42945
42965
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
42946
42966
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
42947
42967
  */
@@ -42973,6 +42993,18 @@ declare namespace sap {
42973
42993
  * Returns a metadata object for class sap.ui.model.odata.v2.Context.
42974
42994
  */
42975
42995
  static getMetadata(): sap.ui.base.Metadata;
42996
+ /**
42997
+ * @SINCE 1.96.0
42998
+ *
42999
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry};
43000
+ * otherwise returns `undefined`.
43001
+ *
43002
+ * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
43003
+ *
43004
+ * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
43005
+ * returns a path including the key predicate of the new entity.
43006
+ */
43007
+ created(): Promise<any>;
42976
43008
  /**
42977
43009
  * @SINCE 1.94.0
42978
43010
  *
@@ -43593,6 +43625,14 @@ declare namespace sap {
43593
43625
  * Defines the count mode of this binding; if not specified, the default count mode of the `oModel` is applied
43594
43626
  */
43595
43627
  countMode?: sap.ui.model.odata.CountMode;
43628
+ /**
43629
+ * A key used in combination with the resolved path of this binding to identify the entities created this
43630
+ * binding's {@link #create} method.
43631
+ *
43632
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
43633
+ * `createdEntitiesKey` values.
43634
+ */
43635
+ createdEntitiesKey?: string;
43596
43636
  /**
43597
43637
  * An optional map of custom query parameters. Custom parameters must not start with `$`
43598
43638
  */
@@ -44305,6 +44345,14 @@ declare namespace sap {
44305
44345
  * Count mode for this binding; if not specified, the default count mode for this model is used
44306
44346
  */
44307
44347
  countMode?: sap.ui.model.odata.CountMode;
44348
+ /**
44349
+ * A key used in combination with the resolved path of the binding to identify the entities created via
44350
+ * the binding's {@link #create} method.
44351
+ *
44352
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
44353
+ * `createdEntitiesKey` values.
44354
+ */
44355
+ createdEntitiesKey?: string;
44308
44356
  /**
44309
44357
  * Operation mode for this binding; if not specified, the default operation mode of this model is used
44310
44358
  */
@@ -44746,8 +44794,11 @@ declare namespace sap {
44746
44794
  * Name. A context object is returned which can be used to bind against the newly created object.
44747
44795
  *
44748
44796
  * For each created entry a request is created and stored in a request queue. The request queue can be submitted
44749
- * by calling {@link #submitChanges}. To delete a created entry from the request queue call {@link #resetChanges}
44750
- * with the context path and the `bDeleteCreatedEntities` parameter set to `true`.
44797
+ * by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
44798
+ * {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the `bDeleteCreatedEntities` parameter set
44799
+ * to `true` can be used to delete the created entity again.
44800
+ *
44801
+ * If the creation of the entity on the server failed, it is repeated automatically.
44751
44802
  *
44752
44803
  * The optional parameter `mParameters.properties` can be used as follows:
44753
44804
  * - `properties` could be an array containing the property names which should be included in the new
@@ -44758,7 +44809,7 @@ declare namespace sap {
44758
44809
  *
44759
44810
  * If there are no values specified, the properties will have `undefined` values.
44760
44811
  *
44761
- * Please note that deep creates (including data defined by navigation properties) are not supported.
44812
+ * The `properties` can be modified via property bindings relative to the returned context instance.
44762
44813
  *
44763
44814
  * The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
44764
44815
  * are expanded automatically with the same $batch request in which the POST request for the creation is
@@ -44777,6 +44828,14 @@ declare namespace sap {
44777
44828
  * handler is called with the data and the response of the POST request. The response object of the success
44778
44829
  * handler call and the response parameter of the corresponding `requestFailed` and `requestCompleted` events
44779
44830
  * have an additional property `expandAfterCreateFailed` set to `true`.
44831
+ *
44832
+ * Note: If a server requires a property in the request, you must supply this property in the initial data,
44833
+ * for example if the server requires a unit for an amount. This also applies if this property has a default
44834
+ * value.
44835
+ *
44836
+ * Note: A deep create (including data defined by navigation properties) is not supported. The dependent
44837
+ * entity has to be created using a second list binding, after this entity has been saved successfully in
44838
+ * the back-end system.
44780
44839
  */
44781
44840
  createEntry(
44782
44841
  /**
@@ -45706,8 +45765,8 @@ declare namespace sap {
45706
45765
  */
45707
45766
  changeSetId?: string;
45708
45767
  /**
45709
- * Since 1.46; defines whether to update all bindings after submitting this change operation. See {@link
45710
- * #setRefreshAfterChange} If given, this overrules the model-wide `refreshAfterChange` flag for this operation
45768
+ * Since 1.46; defines whether to update all bindings after submitting this change operation, see {@link
45769
+ * #setRefreshAfterChange}. If given, this overrules the model-wide `refreshAfterChange` flag for this operation
45711
45770
  * only.
45712
45771
  */
45713
45772
  refreshAfterChange?: boolean;
@@ -48037,6 +48096,19 @@ declare namespace sap {
48037
48096
  *
48038
48097
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
48039
48098
  * be set on each filter, it is not inherited from a multi-filter.
48099
+ *
48100
+ * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
48101
+ * defined by the control that owns the binding, and another list for filters that an application can define
48102
+ * in addition. When executing the filter operation, both sets of filters are combined.
48103
+ *
48104
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
48105
+ * is modified.
48106
+ *
48107
+ * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
48108
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
48109
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
48110
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
48111
+ * of both is not supported.
48040
48112
  * See:
48041
48113
  * sap.ui.model.ListBinding#filter
48042
48114
  * #setAggregation
@@ -49389,9 +49461,8 @@ declare namespace sap {
49389
49461
  $$groupId?: string;
49390
49462
  /**
49391
49463
  * For operation bindings only: Whether $expand and $select from the parent binding are used in the request
49392
- * sent on {@link #execute}. If set to `true`, the binding must not set the $expand or $select parameter
49393
- * itself, the operation must be bound, and the return value and the binding parameter must belong to the
49394
- * same entity set.
49464
+ * sent on {@link #execute}. If set to `true`, the binding must not set the $expand itself, the operation
49465
+ * must be bound, and the return value and the binding parameter must belong to the same entity set.
49395
49466
  */
49396
49467
  $$inheritExpandSelect?: boolean;
49397
49468
  /**
@@ -53431,35 +53502,35 @@ declare namespace sap {
53431
53502
  */
53432
53503
  static getMetadata(): sap.ui.base.Metadata;
53433
53504
  /**
53434
- * Returns the object for the given `path`
53505
+ * Returns the object for the given path and context.
53435
53506
  */
53436
53507
  getObject(
53437
53508
  /**
53438
- * the path to the object
53509
+ * The path to the object
53439
53510
  */
53440
53511
  sPath: string,
53441
53512
  /**
53442
- * the context which will be used to retrieve the object
53513
+ * The context which will be used to retrieve the object
53443
53514
  */
53444
53515
  oContext?: object
53445
- ): any;
53516
+ ): object;
53446
53517
  /**
53447
- * Returns the value for the property with the given `sPropertyName`
53518
+ * Returns the value for the property with the given `sPropertyName`.
53448
53519
  */
53449
53520
  getProperty(
53450
53521
  /**
53451
- * the path to the property
53522
+ * The path to the property
53452
53523
  */
53453
53524
  sPath: string,
53454
53525
  /**
53455
- * the context which will be used to retrieve the property
53526
+ * The context which will be used to retrieve the property
53456
53527
  */
53457
53528
  oContext?: object
53458
- ): any;
53529
+ ): string;
53459
53530
  /**
53460
53531
  * Serializes the current XML data of the model into a string.
53461
53532
  */
53462
- getXML(): undefined;
53533
+ getXML(): string;
53463
53534
  /**
53464
53535
  * Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the
53465
53536
  * model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
@@ -53507,11 +53578,11 @@ declare namespace sap {
53507
53578
  */
53508
53579
  setNameSpace(
53509
53580
  /**
53510
- * the namespace URI
53581
+ * The namespace URI
53511
53582
  */
53512
53583
  sNameSpace: string,
53513
53584
  /**
53514
- * the prefix for the namespace (optional)
53585
+ * The prefix for the namespace
53515
53586
  */
53516
53587
  sPrefix?: string
53517
53588
  ): void;
@@ -53521,19 +53592,19 @@ declare namespace sap {
53521
53592
  */
53522
53593
  setProperty(
53523
53594
  /**
53524
- * path of the property to set
53595
+ * Path of the property to set
53525
53596
  */
53526
53597
  sPath: string,
53527
53598
  /**
53528
- * value to set the property to
53599
+ * Value to set the property to
53529
53600
  */
53530
53601
  oValue: any,
53531
53602
  /**
53532
- * the context which will be used to set the property
53603
+ * The context which will be used to set the property
53533
53604
  */
53534
53605
  oContext?: object,
53535
53606
  /**
53536
- * whether to update other bindings dependent on this property asynchronously
53607
+ * Whether to update other bindings dependent on this property asynchronously
53537
53608
  */
53538
53609
  bAsyncUpdate?: boolean
53539
53610
  ): boolean;
@@ -53922,8 +53993,12 @@ declare namespace sap {
53922
53993
  * Returns a metadata object for class sap.ui.model.type.Date.
53923
53994
  */
53924
53995
  static getMetadata(): sap.ui.base.Metadata;
53925
-
53926
- getOutputPattern(): void;
53996
+ /**
53997
+ * Returns the output pattern.
53998
+ * See:
53999
+ * sap.ui.core.format.DateFormat.getDateInstance
54000
+ */
54001
+ getOutputPattern(): string;
53927
54002
  }
53928
54003
  /**
53929
54004
  * This class represents the Date interval composite type.
@@ -54743,18 +54818,20 @@ declare namespace sap {
54743
54818
  */
54744
54819
  constructor(
54745
54820
  /**
54746
- * the model
54821
+ * The model
54747
54822
  */
54748
54823
  oModel: sap.ui.model.Model,
54749
54824
  /**
54750
- * the path
54825
+ * The path
54751
54826
  */
54752
54827
  sPath: string,
54753
54828
  /**
54754
- * the context object
54829
+ * The context object
54755
54830
  */
54756
54831
  oContext: sap.ui.model.Context,
54757
-
54832
+ /**
54833
+ * Additional, implementation-specific parameters
54834
+ */
54758
54835
  mParameters?: object
54759
54836
  );
54760
54837
 
@@ -54792,27 +54869,27 @@ declare namespace sap {
54792
54869
  */
54793
54870
  attachAggregatedDataStateChange(
54794
54871
  /**
54795
- * The function to be called, when the event occurs
54872
+ * The function to be called when the event occurs
54796
54873
  */
54797
54874
  fnFunction: Function,
54798
54875
  /**
54799
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54876
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54800
54877
  */
54801
54878
  oListener?: object
54802
54879
  ): void;
54803
54880
  /**
54804
- * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.model.Model`.
54881
+ * Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
54805
54882
  *
54806
54883
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
54807
54884
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
54808
54885
  */
54809
54886
  attachChange(
54810
54887
  /**
54811
- * The function to be called, when the event occurs
54888
+ * The function to be called when the event occurs
54812
54889
  */
54813
54890
  fnFunction: Function,
54814
54891
  /**
54815
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54892
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54816
54893
  */
54817
54894
  oListener?: object
54818
54895
  ): void;
@@ -54824,11 +54901,11 @@ declare namespace sap {
54824
54901
  */
54825
54902
  attachDataReceived(
54826
54903
  /**
54827
- * Function to be called, when the event occurs
54904
+ * Function to be called when the event occurs
54828
54905
  */
54829
54906
  fnFunction: Function,
54830
54907
  /**
54831
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54908
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54832
54909
  */
54833
54910
  oListener?: object
54834
54911
  ): void;
@@ -54840,35 +54917,40 @@ declare namespace sap {
54840
54917
  */
54841
54918
  attachDataRequested(
54842
54919
  /**
54843
- * The function to be called, when the event occurs
54920
+ * The function to be called when the event occurs
54844
54921
  */
54845
54922
  fnFunction: Function,
54846
54923
  /**
54847
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54924
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54848
54925
  */
54849
54926
  oListener?: object
54850
54927
  ): void;
54851
54928
  /**
54852
- * Attaches event handler `fnFunction` to the {@link #event:DataStateChange DataStateChange} event of this
54853
- * `sap.ui.model.Binding`.
54929
+ * Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
54930
+ * thi `sap.ui.model.Binding`.
54854
54931
  *
54855
54932
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
54856
54933
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
54857
54934
  */
54858
54935
  attachDataStateChange(
54859
54936
  /**
54860
- * Function to be called, when the event occurs
54937
+ * Function to be called when the event occurs
54861
54938
  */
54862
54939
  fnFunction: Function,
54863
54940
  /**
54864
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54941
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54865
54942
  */
54866
54943
  oListener?: object
54867
54944
  ): void;
54868
54945
  /**
54869
54946
  * Attach multiple events.
54870
54947
  */
54871
- attachEvents(oEvents: Record<string, Function>): void;
54948
+ attachEvents(
54949
+ /**
54950
+ * Events to attach to this binding
54951
+ */
54952
+ oEvents: Record<string, Function>
54953
+ ): sap.ui.model.Binding;
54872
54954
  /**
54873
54955
  * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
54874
54956
  *
@@ -54877,11 +54959,11 @@ declare namespace sap {
54877
54959
  */
54878
54960
  attachRefresh(
54879
54961
  /**
54880
- * The function to be called, when the event occurs
54962
+ * The function to be called when the event occurs
54881
54963
  */
54882
54964
  fnFunction: Function,
54883
54965
  /**
54884
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54966
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54885
54967
  */
54886
54968
  oListener?: object
54887
54969
  ): void;
@@ -54898,7 +54980,7 @@ declare namespace sap {
54898
54980
  */
54899
54981
  detachAggregatedDataStateChange(
54900
54982
  /**
54901
- * The function to be called, when the event occurs
54983
+ * The function to be called when the event occurs
54902
54984
  */
54903
54985
  fnFunction: Function,
54904
54986
  /**
@@ -54911,7 +54993,7 @@ declare namespace sap {
54911
54993
  */
54912
54994
  detachChange(
54913
54995
  /**
54914
- * Function to be called, when the event occurs
54996
+ * Function to be called when the event occurs
54915
54997
  */
54916
54998
  fnFunction: Function,
54917
54999
  /**
@@ -54924,7 +55006,7 @@ declare namespace sap {
54924
55006
  */
54925
55007
  detachDataReceived(
54926
55008
  /**
54927
- * Function to be called, when the event occurs
55009
+ * Function to be called when the event occurs
54928
55010
  */
54929
55011
  fnFunction: Function,
54930
55012
  /**
@@ -54938,7 +55020,7 @@ declare namespace sap {
54938
55020
  */
54939
55021
  detachDataRequested(
54940
55022
  /**
54941
- * The function to be called, when the event occurs
55023
+ * The function to be called when the event occurs
54942
55024
  */
54943
55025
  fnFunction: Function,
54944
55026
  /**
@@ -54952,7 +55034,7 @@ declare namespace sap {
54952
55034
  */
54953
55035
  detachDataStateChange(
54954
55036
  /**
54955
- * The function to be called, when the event occurs
55037
+ * The function to be called when the event occurs
54956
55038
  */
54957
55039
  fnFunction: Function,
54958
55040
  /**
@@ -54963,17 +55045,22 @@ declare namespace sap {
54963
55045
  /**
54964
55046
  * Detach multiple events.
54965
55047
  */
54966
- detachEvents(oEvents: Record<string, Function>): void;
55048
+ detachEvents(
55049
+ /**
55050
+ * Events to detach from this binding
55051
+ */
55052
+ oEvents: Record<string, Function>
55053
+ ): sap.ui.model.Binding;
54967
55054
  /**
54968
55055
  * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
54969
55056
  */
54970
55057
  detachRefresh(
54971
55058
  /**
54972
- * The function to be called, when the event occurs
55059
+ * The function to be called when the event occurs
54973
55060
  */
54974
55061
  fnFunction: Function,
54975
55062
  /**
54976
- * object on which to call the given function.
55063
+ * Object on which to call the given function.
54977
55064
  */
54978
55065
  oListener?: object
54979
55066
  ): void;
@@ -54984,11 +55071,11 @@ declare namespace sap {
54984
55071
  */
54985
55072
  fireDataReceived(
54986
55073
  /**
54987
- * Parameters to pass along with the event.
55074
+ * Parameters to pass along with the event
54988
55075
  */
54989
55076
  oParameters: {
54990
55077
  /**
54991
- * Data received. In error cases it will be undefined.
55078
+ * Data received; on error cases it will be undefined
54992
55079
  */
54993
55080
  data?: object;
54994
55081
  }
@@ -54998,7 +55085,7 @@ declare namespace sap {
54998
55085
  */
54999
55086
  fireDataRequested(
55000
55087
  /**
55001
- * Parameters to pass along with the event.
55088
+ * Parameters to pass along with the event
55002
55089
  */
55003
55090
  oParameters: object
55004
55091
  ): void;
@@ -55044,11 +55131,11 @@ declare namespace sap {
55044
55131
  */
55045
55132
  initialize(): void;
55046
55133
  /**
55047
- * Returns whether the binding is initial, which means it did not get an initial value yet
55134
+ * Returns whether the binding is initial, which means it did not get an initial value yet.
55048
55135
  */
55049
55136
  isInitial(): boolean;
55050
55137
  /**
55051
- * Returns whether the binding is relative, which means its path does not start with a slash ('/')
55138
+ * Returns whether the binding is relative, which means its path does not start with a slash.
55052
55139
  */
55053
55140
  isRelative(): boolean;
55054
55141
  /**
@@ -55081,8 +55168,8 @@ declare namespace sap {
55081
55168
  /**
55082
55169
  * Resumes the binding update. Change events will be fired again.
55083
55170
  *
55084
- * When the binding is resumed, a change event will be fired immediately, if the data has changed while
55085
- * the binding was suspended. For server-side models, a request to the server will be triggered, if a refresh
55171
+ * When the binding is resumed, a change event will be fired immediately if the data has changed while the
55172
+ * binding was suspended. For server-side models, a request to the server will be triggered if a refresh
55086
55173
  * was requested while the binding was suspended.
55087
55174
  */
55088
55175
  resume(): void;
@@ -55548,7 +55635,7 @@ declare namespace sap {
55548
55635
  *
55549
55636
  * A `CompositeBinding` combines the values from all its binding parts (each an instance of `PropertyBinding`),
55550
55637
  * either by calling a formatter function or by involving a {@link sap.ui.model.CompositeType composite
55551
- * type}. When a formatter function is used, then the composite binding is automatically limited to `OneWay`
55638
+ * type}. When a formatter function is used, the composite binding is automatically limited to `OneWay`
55552
55639
  * mode. When a type is used, the binding can also operate in `TwoWay` mode.
55553
55640
  *
55554
55641
  * Higher layers of the framework derive composite bindings from easy-to-write string representations (the
@@ -55614,7 +55701,7 @@ declare namespace sap {
55614
55701
  */
55615
55702
  fnFunction: Function,
55616
55703
  /**
55617
- * object on which to call the given function.
55704
+ * Object on which to call the given function
55618
55705
  */
55619
55706
  oListener?: object
55620
55707
  ): void;
@@ -55630,7 +55717,7 @@ declare namespace sap {
55630
55717
  */
55631
55718
  fnFunction: Function,
55632
55719
  /**
55633
- * object on which to call the given function
55720
+ * Object on which to call the given function
55634
55721
  */
55635
55722
  oListener?: object
55636
55723
  ): void;
@@ -55646,7 +55733,7 @@ declare namespace sap {
55646
55733
  */
55647
55734
  fnFunction: Function,
55648
55735
  /**
55649
- * object on which to call the given function
55736
+ * Object on which to call the given function
55650
55737
  */
55651
55738
  oListener?: object
55652
55739
  ): void;
@@ -55659,7 +55746,7 @@ declare namespace sap {
55659
55746
  */
55660
55747
  fnFunction: Function,
55661
55748
  /**
55662
- * object on which to call the given function
55749
+ * Object on which to call the given function
55663
55750
  */
55664
55751
  oListener?: object
55665
55752
  ): void;
@@ -55672,7 +55759,7 @@ declare namespace sap {
55672
55759
  */
55673
55760
  fnFunction: Function,
55674
55761
  /**
55675
- * object on which to call the given function
55762
+ * Object on which to call the given function
55676
55763
  */
55677
55764
  oListener?: object
55678
55765
  ): void;
@@ -55685,7 +55772,7 @@ declare namespace sap {
55685
55772
  */
55686
55773
  fnFunction: Function,
55687
55774
  /**
55688
- * object on which to call the given function
55775
+ * Object on which to call the given function
55689
55776
  */
55690
55777
  oListener?: object
55691
55778
  ): void;
@@ -55699,12 +55786,12 @@ declare namespace sap {
55699
55786
  getExternalValue(): object;
55700
55787
  /**
55701
55788
  * Returns the current internal value of the bound target which is an array of the internal (JS native)
55702
- * values of nested bindings
55789
+ * values of nested bindings.
55703
55790
  */
55704
55791
  getInternalValue(): any[];
55705
55792
  /**
55706
55793
  * Returns the current raw value of the bound target which is an array of the raw (model) values of nested
55707
- * bindings
55794
+ * bindings.
55708
55795
  */
55709
55796
  getRawValue(): any[];
55710
55797
  /**
@@ -55713,10 +55800,10 @@ declare namespace sap {
55713
55800
  getValue(): object;
55714
55801
  /**
55715
55802
  * Initialize the binding. The method should be called when creating a binding. The default implementation
55716
- * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nestend bindings, it
55717
- * is sufficient to call checkUpdate when all nested bindings are initialized.
55803
+ * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nested bindings, it is
55804
+ * sufficient to call checkUpdate when all nested bindings are initialized.
55718
55805
  */
55719
- initialize(): void;
55806
+ initialize(): this;
55720
55807
  /**
55721
55808
  * Suspends the binding update. No change events will be fired.
55722
55809
  *
@@ -55727,12 +55814,12 @@ declare namespace sap {
55727
55814
  resume(): void;
55728
55815
  /**
55729
55816
  * Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
55730
- * implementation assumes a space separated list of values. This will cause the setValue to be called for
55817
+ * implementation assumes a space-separated list of values. This will cause the setValue to be called for
55731
55818
  * each nested binding, except for undefined values in the array.
55732
55819
  */
55733
55820
  setExternalValue(
55734
55821
  /**
55735
- * the value to set for this binding
55822
+ * The value to set for this binding
55736
55823
  */
55737
55824
  oValue: object
55738
55825
  ): undefined | Promise<any>;
@@ -55745,7 +55832,7 @@ declare namespace sap {
55745
55832
  * the new values of the nested bindings
55746
55833
  */
55747
55834
  aValues: any[]
55748
- ): void;
55835
+ ): undefined | Promise<any>;
55749
55836
  /**
55750
55837
  * Sets the raw value of the bound target. Parameter must be an array of values matching the raw (model)
55751
55838
  * types of nested bindings.
@@ -55755,7 +55842,7 @@ declare namespace sap {
55755
55842
  * the new values of the nested bindings
55756
55843
  */
55757
55844
  aValues: any[]
55758
- ): void;
55845
+ ): undefined | Promise<any>;
55759
55846
  /**
55760
55847
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
55761
55848
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -55763,11 +55850,11 @@ declare namespace sap {
55763
55850
  */
55764
55851
  setType(
55765
55852
  /**
55766
- * the type for the binding
55853
+ * The type for the binding
55767
55854
  */
55768
55855
  oType: sap.ui.model.CompositeType,
55769
55856
  /**
55770
- * the internal type of the element property which this binding is bound against.
55857
+ * The internal type of the element property which this binding is bound against.
55771
55858
  */
55772
55859
  sInternalType: string
55773
55860
  ): void;
@@ -55777,7 +55864,7 @@ declare namespace sap {
55777
55864
  */
55778
55865
  setValue(
55779
55866
  /**
55780
- * the values to set for this binding
55867
+ * The values to set for this binding
55781
55868
  */
55782
55869
  aValues: any[]
55783
55870
  ): void;
@@ -56369,17 +56456,19 @@ declare namespace sap {
56369
56456
  * You either pass a single object literal with the filter parameters or use the individual constructor
56370
56457
  * arguments. No matter which variant is used, only certain combinations of parameters are supported (the
56371
56458
  * following list uses the names from the object literal):
56372
- * - A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator
56373
- * - A `path` and a custom filter function `test`
56374
- * - An array of other filters named `filters` and a Boolean flag `and` that specifies whether to combine
56375
- * the filters with an AND (`true`) or an OR (`false`) operator. An error will be logged to the console
56376
- * if an invalid combination of parameters is provided. Please note that a model implementation may not
56377
- * support a custom filter function, e.g. if the model does not perform client side filtering. It also depends
56378
- * on the model implementation if the filtering is case sensitive or not. Client models filter case insensitive
56379
- * compared to the OData models which filter case sensitive by default. See particular model documentation
56380
- * for details The filter operators `Any` and `All` are only supported in V4 OData models. When creating
56381
- * a filter instance with these filter operators, the argument `variable` only accepts a string identifier
56382
- * and `condition` needs to be another filter instance.
56459
+ * A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator A `path`
56460
+ * and a custom filter function `test` An array of other filters named `filters` and a Boolean flag
56461
+ * `and` that specifies whether to combine the filters with an AND (`true`) or an OR (`false`) operator.
56462
+ * An error will be logged to the console if an invalid combination of parameters is provided.
56463
+ *
56464
+ * Please note that a model implementation may not support a custom filter function, e.g. if the model does
56465
+ * not perform client-side filtering. It also depends on the model implementation if the filtering is case
56466
+ * sensitive or not. Client models filter case insensitive compared to the OData models which filter case
56467
+ * sensitive by default. See particular model documentation for details.
56468
+ *
56469
+ * The filter operators {@link sap.ui.model.FilterOperator.Any "Any"} and {@link sap.ui.model.FilterOperator.All
56470
+ * "All"} are only supported in V4 OData models. When creating a filter instance with these filter operators,
56471
+ * the argument `variable` only accepts a string identifier and `condition` needs to be another filter instance.
56383
56472
  */
56384
56473
  constructor(
56385
56474
  /**
@@ -56392,15 +56481,19 @@ declare namespace sap {
56392
56481
  */
56393
56482
  path?: string;
56394
56483
  /**
56395
- * Function which is used to filter the items and which should return a Boolean value to indicate whether
56396
- * the current item passes the filter
56484
+ * Function used for the client-side filtering of items. It should return a Boolean indicating whether the
56485
+ * current item passes the filter. If no test function is given, a default test function is used, based
56486
+ * on the given filter operator and the comparator function.
56397
56487
  */
56398
- test?: Function;
56488
+ test?: (p1: any) => boolean;
56399
56489
  /**
56400
- * Function which is used to compare two values, this is used for processing of equal, less than and greater
56401
- * than operators
56490
+ * Function used to compare two values for equality and order during client-side filtering. Two values are
56491
+ * given as parameters. The function is expected to return:
56492
+ * a negative number if the first value is smaller than the second value, `0` if the two values are
56493
+ * equal, a positive number if the first value is larger than the second value, `NaN` for non-comparable
56494
+ * values. If no function is given, {@link sap.ui.model.Filter.defaultComparator} is used.
56402
56495
  */
56403
- comparator?: Function;
56496
+ comparator?: (p1: any, p2: any) => number;
56404
56497
  /**
56405
56498
  * Operator used for the filter
56406
56499
  */
@@ -56410,44 +56503,52 @@ declare namespace sap {
56410
56503
  */
56411
56504
  value1?: any;
56412
56505
  /**
56413
- * Second value to use with the filter operator (only for some operators)
56506
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
56507
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
56414
56508
  */
56415
56509
  value2?: any;
56416
56510
  /**
56417
- * The variable used in lambda operators (`Any` and `All`)
56511
+ * The variable name used in lambda operators ({@link sap.ui.model.FilterOperator.Any "Any"} and {@link
56512
+ * sap.ui.model.FilterOperator.All "All"})
56418
56513
  */
56419
56514
  variable?: string;
56420
56515
  /**
56421
- * A `Filter` instance which will be used as the condition for the lambda operator
56516
+ * A filter instance which will be used as the condition for lambda operators ({@link sap.ui.model.FilterOperator.Any
56517
+ * "Any"} and {@link sap.ui.model.FilterOperator.All "All"})
56422
56518
  */
56423
56519
  condition?: sap.ui.model.Filter;
56424
56520
  /**
56425
- * Array of filters on which logical conjunction is applied
56521
+ * An array of filters on which the logical conjunction is applied
56426
56522
  */
56427
56523
  filters?: sap.ui.model.Filter[];
56428
56524
  /**
56429
56525
  * Indicates whether an "AND" logical conjunction is applied on the filters. If it's not set or set to `false`,
56430
- * an "OR" conjunction is applied
56526
+ * an "OR" conjunction is applied.
56431
56527
  */
56432
56528
  and?: boolean;
56433
56529
  /**
56434
- * Indicates whether a string value should be compared case sensitive or not.
56530
+ * Indicates whether a string value should be compared case sensitive or not. The handling of `undefined`
56531
+ * depends on the model implementation.
56435
56532
  */
56436
56533
  caseSensitive?: boolean;
56437
56534
  }
56438
56535
  | string
56439
56536
  | sap.ui.model.Filter[],
56440
56537
  /**
56441
- * Either a filter operator or a custom filter function or a Boolean flag that defines how to combine multiple
56442
- * filters
56538
+ * Either a filter operator or a custom filter function or a `boolean` flag that defines how to combine
56539
+ * multiple filters
56443
56540
  */
56444
- vOperator?: sap.ui.model.FilterOperator | Function | boolean,
56541
+ vOperator?:
56542
+ | sap.ui.model.FilterOperator
56543
+ | ((p1: any) => boolean)
56544
+ | boolean,
56445
56545
  /**
56446
56546
  * First value to use with the given filter operator
56447
56547
  */
56448
56548
  vValue1?: any,
56449
56549
  /**
56450
- * Second value to use with the given filter operator (only for some operators)
56550
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
56551
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
56451
56552
  */
56452
56553
  vValue2?: any
56453
56554
  );
@@ -56455,7 +56556,7 @@ declare namespace sap {
56455
56556
  /**
56456
56557
  * Compares two values
56457
56558
  *
56458
- * This is the default comparator function used for clientside filtering, if no custom comparator is given
56559
+ * This is the default comparator function used for client-side filtering, if no custom comparator is given
56459
56560
  * in the constructor. It does compare just by using equal/less than/greater than with automatic type casting,
56460
56561
  * except for null values, which are neither less or greater, and string values where localeCompare is used.
56461
56562
  *
@@ -56470,7 +56571,7 @@ declare namespace sap {
56470
56571
  * the second value to compare
56471
56572
  */
56472
56573
  b: any
56473
- ): int;
56574
+ ): number;
56474
56575
  /**
56475
56576
  * Creates a new subclass of class sap.ui.model.Filter with name `sClassName` and enriches it with the information
56476
56577
  * contained in `oClassInfo`.
@@ -56496,6 +56597,83 @@ declare namespace sap {
56496
56597
  * Returns a metadata object for class sap.ui.model.Filter.
56497
56598
  */
56498
56599
  static getMetadata(): sap.ui.base.Metadata;
56600
+ /**
56601
+ * @SINCE 1.96.0
56602
+ *
56603
+ * Returns the comparator function as provided on construction of this filter, see {@link sap.ui.model.Filter#constructor},
56604
+ * parameter `vFilterInfo.comparator`.
56605
+ */
56606
+ getComparator(): ((p1: any) => boolean) | undefined;
56607
+ /**
56608
+ * @SINCE 1.96.0
56609
+ *
56610
+ * Returns the filter instance which is used as the condition for lambda operators, see {@link sap.ui.model.Filter#constructor},
56611
+ * parameter `vFilterInfo.condition`.
56612
+ */
56613
+ getCondition(): sap.ui.model.Filter | undefined;
56614
+ /**
56615
+ * @SINCE 1.96.0
56616
+ *
56617
+ * Returns the array of filters as specified on construction of this filter, see {@link sap.ui.model.Filter#constructor},
56618
+ * parameter `vFilterInfo.filters`
56619
+ */
56620
+ getFilters(): sap.ui.model.Filter[] | undefined;
56621
+ /**
56622
+ * @SINCE 1.96.0
56623
+ *
56624
+ * Returns the filter operator used for this filter, see {@link sap.ui.model.Filter#constructor}, parameter
56625
+ * `vFilterInfo.operator` or `vOperator`.
56626
+ */
56627
+ getOperator(): sap.ui.model.FilterOperator | undefined;
56628
+ /**
56629
+ * @SINCE 1.96.0
56630
+ *
56631
+ * Returns the binding path for this filter, see {@link sap.ui.model.Filter#constructor}, parameter `vFilterInfo`
56632
+ * or `vFilterInfo.path`.
56633
+ */
56634
+ getPath(): string | undefined;
56635
+ /**
56636
+ * @SINCE 1.96.0
56637
+ *
56638
+ * Returns the test function which is used to filter the items, see {@link sap.ui.model.Filter#constructor},
56639
+ * parameter `vFilterInfo.test`.
56640
+ */
56641
+ getTest(): ((p1: any, p2: any) => boolean) | undefined;
56642
+ /**
56643
+ * @SINCE 1.96.0
56644
+ *
56645
+ * Returns the first value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
56646
+ * parameter `vFilterInfo.value1` or `vValue1`.
56647
+ */
56648
+ getValue1(): any;
56649
+ /**
56650
+ * @SINCE 1.96.0
56651
+ *
56652
+ * Returns the second value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
56653
+ * parameter `vFilterInfo.value2` or `vValue2`.
56654
+ */
56655
+ getValue2(): any;
56656
+ /**
56657
+ * @SINCE 1.96.0
56658
+ *
56659
+ * Returns the variable name used in lambda operators, see {@link sap.ui.model.Filter#constructor}, parameter
56660
+ * `vFilterInfo.variable`.
56661
+ */
56662
+ getVariable(): string | undefined;
56663
+ /**
56664
+ * @SINCE 1.96.0
56665
+ *
56666
+ * Indicates whether an "AND" logical conjunction is applied on the filters, see {@link sap.ui.model.Filter#constructor},
56667
+ * parameter `vFilterInfo.and`.
56668
+ */
56669
+ isAnd(): boolean;
56670
+ /**
56671
+ * @SINCE 1.96.0
56672
+ *
56673
+ * Indicates whether a string value should be compared case sensitive, see {@link sap.ui.model.Filter#constructor},
56674
+ * parameter `vFilterInfo.caseSensitive`.
56675
+ */
56676
+ isCaseSensitive(): boolean;
56499
56677
  }
56500
56678
  /**
56501
56679
  * Instances of this exception are thrown when converting a model value to its representation on the UI
@@ -56590,7 +56768,7 @@ declare namespace sap {
56590
56768
  */
56591
56769
  fnFunction: Function,
56592
56770
  /**
56593
- * Context object to call the event handler with, defaults to this `ListBinding` itself
56771
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
56594
56772
  */
56595
56773
  oListener?: object
56596
56774
  ): void;
@@ -56609,7 +56787,7 @@ declare namespace sap {
56609
56787
  */
56610
56788
  fnFunction: Function,
56611
56789
  /**
56612
- * Context object to call the event handler with, defaults to this `ListBinding` itself
56790
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
56613
56791
  */
56614
56792
  oListener?: object
56615
56793
  ): void;
@@ -56624,7 +56802,7 @@ declare namespace sap {
56624
56802
  */
56625
56803
  fnFunction: Function,
56626
56804
  /**
56627
- * on which the given function had to be called
56805
+ * On which object the given function had to be called
56628
56806
  */
56629
56807
  oListener?: object
56630
56808
  ): void;
@@ -56680,7 +56858,11 @@ declare namespace sap {
56680
56858
  * The path of the property containing the key or a function getting the context as only parameter to calculate
56681
56859
  * a key to identify an entry
56682
56860
  */
56683
- vKey: Function | string
56861
+ vKey: Function | string,
56862
+ /**
56863
+ * The configuration for the change detection
56864
+ */
56865
+ oExtendedChangeDetectionConfig: object
56684
56866
  ): void;
56685
56867
  /**
56686
56868
  * Applies a new set of filters to the list represented by this binding.
@@ -56689,18 +56871,18 @@ declare namespace sap {
56689
56871
  * a server and it might execute asynchronously.
56690
56872
  *
56691
56873
  * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
56692
- * defined by the control that owns the binding and another list for filters that an application can define
56874
+ * defined by the control that owns the binding, and another list for filters that an application can define
56693
56875
  * in addition. When executing the filter operation, both sets of filters are combined.
56694
56876
  *
56695
- * By using the second parameter `sFilterType` of method `filter`, the caller can control which set of filters
56877
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
56696
56878
  * is modified. If no type is given, then the behavior depends on the model implementation and should be
56697
56879
  * documented in the API reference for that model.
56698
56880
  *
56699
56881
  * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
56700
- * to the same group are ORed and after that the results of all groups are ANDed. Usually this means, all
56701
- * filters applied to a single table column are ORed, while filters on different table columns are ANDed.
56702
- * Please either use the automatic grouping of filters (where applicable) or use explicit AND/OR filters,
56703
- * a mixture of both is not supported.
56882
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
56883
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
56884
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
56885
+ * of both is not supported.
56704
56886
  */
56705
56887
  filter(
56706
56888
  /**
@@ -56729,22 +56911,22 @@ declare namespace sap {
56729
56911
  */
56730
56912
  getContexts(
56731
56913
  /**
56732
- * the startIndex where to start the retrieval of contexts
56914
+ * The startIndex where to start the retrieval of contexts
56733
56915
  */
56734
56916
  iStartIndex?: int,
56735
56917
  /**
56736
- * determines how many contexts to retrieve beginning from the start index.
56918
+ * Determines how many contexts to retrieve beginning from the start index.
56737
56919
  */
56738
56920
  iLength?: int,
56739
56921
  /**
56740
56922
  * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
56741
- * data that is likely to be needed soon, e.g. when scrolling down in a table. This parameter is model-specific
56742
- * and not implemented by all models.
56923
+ * data that is likely to be needed soon, e.g. when scrolling down in a table; this parameter is model-specific
56924
+ * and not implemented by all models
56743
56925
  */
56744
56926
  iMaximumPrefetchSize?: int,
56745
56927
  /**
56746
56928
  * Whether this call keeps the result of {@link #getCurrentContexts} untouched; since 1.86.0. This parameter
56747
- * is model-specific and not implemented by all models.
56929
+ * is model-specific and not implemented by all models
56748
56930
  */
56749
56931
  bKeepCurrent?: boolean
56750
56932
  ): sap.ui.model.Context[];
@@ -56766,7 +56948,7 @@ declare namespace sap {
56766
56948
  *
56767
56949
  * Returns an array of currently used binding contexts of the bound control.
56768
56950
  *
56769
- * This method does not trigger any data requests from the backend or delta calculation, but just returns
56951
+ * This method does not trigger any data requests from the back end or a delta calculation, but just returns
56770
56952
  * the context array as last requested by the control. This can be used by the application to get access
56771
56953
  * to the data currently displayed by a list control.
56772
56954
  */
@@ -56780,6 +56962,17 @@ declare namespace sap {
56780
56962
  */
56781
56963
  sPath: string
56782
56964
  ): any[];
56965
+ /**
56966
+ * @SINCE 1.96.0
56967
+ *
56968
+ * Returns the filters set via the constructor or via {@link #filter} for the given {@link sap.ui.model.FilterType}.
56969
+ */
56970
+ getFilters(
56971
+ /**
56972
+ * The FilterType
56973
+ */
56974
+ sFilterType: sap.ui.model.FilterType
56975
+ ): sap.ui.model.Filter[];
56783
56976
  /**
56784
56977
  * Gets the group for the given context. Must only be called if `isGrouped()` returns that grouping is enabled
56785
56978
  * for this binding. The grouping will be performed using the first sorter (in case multiple sorters are
@@ -56803,8 +56996,8 @@ declare namespace sap {
56803
56996
  */
56804
56997
  getLength(): int;
56805
56998
  /**
56806
- * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding, if at
56807
- * least one sorter exists on the binding and the first sorter is a grouping sorter.
56999
+ * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding if at least
57000
+ * one sorter exists on the binding and the first sorter is a grouping sorter.
56808
57001
  */
56809
57002
  isGrouped(): boolean;
56810
57003
  /**
@@ -56841,7 +57034,7 @@ declare namespace sap {
56841
57034
  * Instead of a single sorter also an array of sorters can be passed to the sort method. In this case they
56842
57035
  * are processed in the sequence in which they are contained in the array.
56843
57036
  *
56844
- * Grouping: Sorting and grouping are closely related, in case a list should be grouped, it must be sorted
57037
+ * Grouping: Sorting and grouping are closely related. In case a list should be grouped, it must be sorted
56845
57038
  * by the property to group with. Grouping is enabled by setting the `group` property on the sorter object.
56846
57039
  * If it is enabled, you can get the current group of an item using {@link sap.ui.model.ListBinding.prototype.getGroup}.
56847
57040
  * In case multiple sorters are provided, grouping can only be done on the first sorter, nested grouping
@@ -56849,7 +57042,7 @@ declare namespace sap {
56849
57042
  */
56850
57043
  sort(
56851
57044
  /**
56852
- * the Sorter object or an array of sorters which defines the sort order
57045
+ * The Sorter object or an array of sorters which defines the sort order
56853
57046
  */
56854
57047
  aSorters: sap.ui.model.Sorter | any[]
56855
57048
  ): this;
@@ -56939,7 +57132,7 @@ declare namespace sap {
56939
57132
  */
56940
57133
  oData: object,
56941
57134
  /**
56942
- * The function to be called, when the event occurs
57135
+ * The function to be called when the event occurs
56943
57136
  */
56944
57137
  fnFunction: Function,
56945
57138
  /**
@@ -56955,7 +57148,7 @@ declare namespace sap {
56955
57148
  */
56956
57149
  attachParseError(
56957
57150
  /**
56958
- * The function to be called, when the event occurs
57151
+ * The function to be called when the event occurs
56959
57152
  */
56960
57153
  fnFunction: Function,
56961
57154
  /**
@@ -56977,7 +57170,7 @@ declare namespace sap {
56977
57170
  */
56978
57171
  oData: object,
56979
57172
  /**
56980
- * The function to be called, when the event occurs
57173
+ * The function to be called when the event occurs
56981
57174
  */
56982
57175
  fnFunction: Function,
56983
57176
  /**
@@ -56994,7 +57187,7 @@ declare namespace sap {
56994
57187
  */
56995
57188
  attachPropertyChange(
56996
57189
  /**
56997
- * The function to be called, when the event occurs
57190
+ * The function to be called when the event occurs
56998
57191
  */
56999
57192
  fnFunction: Function,
57000
57193
  /**
@@ -57016,7 +57209,7 @@ declare namespace sap {
57016
57209
  */
57017
57210
  oData: object,
57018
57211
  /**
57019
- * The function to be called, when the event occurs
57212
+ * The function to be called when the event occurs
57020
57213
  */
57021
57214
  fnFunction: Function,
57022
57215
  /**
@@ -57033,7 +57226,7 @@ declare namespace sap {
57033
57226
  */
57034
57227
  attachRequestCompleted(
57035
57228
  /**
57036
- * The function to be called, when the event occurs
57229
+ * The function to be called when the event occurs
57037
57230
  */
57038
57231
  fnFunction: Function,
57039
57232
  /**
@@ -57054,7 +57247,7 @@ declare namespace sap {
57054
57247
  */
57055
57248
  oData: object,
57056
57249
  /**
57057
- * The function to be called, when the event occurs
57250
+ * The function to be called when the event occurs
57058
57251
  */
57059
57252
  fnFunction: Function,
57060
57253
  /**
@@ -57070,7 +57263,7 @@ declare namespace sap {
57070
57263
  */
57071
57264
  attachRequestFailed(
57072
57265
  /**
57073
- * The function to be called, when the event occurs
57266
+ * The function to be called when the event occurs
57074
57267
  */
57075
57268
  fnFunction: Function,
57076
57269
  /**
@@ -57091,7 +57284,7 @@ declare namespace sap {
57091
57284
  */
57092
57285
  oData: object,
57093
57286
  /**
57094
- * The function to be called, when the event occurs
57287
+ * The function to be called when the event occurs
57095
57288
  */
57096
57289
  fnFunction: Function,
57097
57290
  /**
@@ -57107,7 +57300,7 @@ declare namespace sap {
57107
57300
  */
57108
57301
  attachRequestSent(
57109
57302
  /**
57110
- * The function to be called, when the event occurs
57303
+ * The function to be called when the event occurs
57111
57304
  */
57112
57305
  fnFunction: Function,
57113
57306
  /**
@@ -57120,111 +57313,103 @@ declare namespace sap {
57120
57313
  */
57121
57314
  bindContext(
57122
57315
  /**
57123
- * the path pointing to the property that should be bound
57316
+ * The path pointing to the property that should be bound
57124
57317
  */
57125
57318
  sPath: string,
57126
57319
  /**
57127
- * the context object for this databinding (optional)
57320
+ * The context object for this databinding
57128
57321
  */
57129
57322
  oContext?: sap.ui.model.Context,
57130
57323
  /**
57131
- * additional model specific parameters (optional)
57324
+ * Additional model-specific parameters
57132
57325
  */
57133
57326
  mParameters?: object,
57134
57327
  /**
57135
- * event handlers can be passed to the binding ({change:myHandler})
57328
+ * Event handlers can be passed to the binding ({change:myHandler})
57136
57329
  */
57137
57330
  oEvents?: object
57138
57331
  ): sap.ui.model.ContextBinding;
57139
- /**
57140
- * Implement in inheriting classes.
57141
- */
57332
+
57142
57333
  bindList(
57143
57334
  /**
57144
- * the path pointing to the list / array that should be bound
57335
+ * The path pointing to the list / array that should be bound
57145
57336
  */
57146
57337
  sPath: string,
57147
57338
  /**
57148
- * the context object for this databinding (optional)
57339
+ * The context object for this databinding
57149
57340
  */
57150
57341
  oContext?: sap.ui.model.Context,
57151
57342
  /**
57152
- * initial sort order (can be either a sorter or an array of sorters) (optional)
57343
+ * Initial sort order (can be either a sorter or an array of sorters)
57153
57344
  */
57154
57345
  aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
57155
57346
  /**
57156
- * predefined filter/s (can be either a filter or an array of filters) (optional)
57347
+ * Predefined filter/s (can be either a filter or an array of filters)
57157
57348
  */
57158
57349
  aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
57159
57350
  /**
57160
- * additional model specific parameters (optional)
57351
+ * Additional model-specific parameters
57161
57352
  */
57162
57353
  mParameters?: object
57163
57354
  ): sap.ui.model.ListBinding;
57164
- /**
57165
- * Implement in inheriting classes.
57166
- */
57355
+
57167
57356
  bindProperty(
57168
57357
  /**
57169
- * the path pointing to the property that should be bound
57358
+ * The path pointing to the property that should be bound
57170
57359
  */
57171
57360
  sPath: string,
57172
57361
  /**
57173
- * the context object for this databinding (optional)
57362
+ * The context object for this databinding
57174
57363
  */
57175
57364
  oContext?: sap.ui.model.Context,
57176
57365
  /**
57177
- * additional model specific parameters (optional)
57366
+ * Additional model-specific parameters
57178
57367
  */
57179
57368
  mParameters?: object
57180
57369
  ): sap.ui.model.PropertyBinding;
57181
- /**
57182
- * Implement in inheriting classes.
57183
- */
57370
+
57184
57371
  bindTree(
57185
57372
  /**
57186
- * the path pointing to the tree / array that should be bound
57373
+ * The path pointing to the tree / array that should be bound
57187
57374
  */
57188
57375
  sPath: string,
57189
57376
  /**
57190
- * the context object for this databinding (optional)
57377
+ * The context object for this databinding
57191
57378
  */
57192
57379
  oContext?: sap.ui.model.Context,
57193
57380
  /**
57194
- * predefined filter/s contained in an array (optional)
57381
+ * Predefined filter/s contained in an array
57195
57382
  */
57196
57383
  aFilters?: sap.ui.model.Filter[],
57197
57384
  /**
57198
- * additional model specific parameters (optional)
57385
+ * Additional model specific parameters
57199
57386
  */
57200
57387
  mParameters?: object,
57201
57388
  /**
57202
- * predefined sap.ui.model.sorter/s contained in an array (optional)
57389
+ * Predefined sap.ui.model.sorter/s contained in an array
57203
57390
  */
57204
57391
  aSorters?: sap.ui.model.Sorter[]
57205
57392
  ): sap.ui.model.TreeBinding;
57206
- /**
57207
- * Implement in inheriting classes.
57208
- */
57393
+
57209
57394
  createBindingContext(
57210
57395
  /**
57211
- * the path to create the new context from
57396
+ * The path to create the new context from
57212
57397
  */
57213
57398
  sPath: string,
57214
57399
  /**
57215
- * the context which should be used to create the new binding context
57400
+ * The context which should be used to create the new binding context
57216
57401
  */
57217
57402
  oContext?: sap.ui.model.Context,
57218
57403
  /**
57219
- * the parameters used to create the new binding context
57404
+ * The parameters used to create the new binding context
57220
57405
  */
57221
57406
  mParameters?: object,
57222
57407
  /**
57223
- * the function which should be called after the binding context has been created
57408
+ * The function which should be called after the binding context has been created
57224
57409
  */
57225
57410
  fnCallBack?: Function,
57226
57411
  /**
57227
- * force reload even if data is already available. For server side models this should refetch the data from
57412
+ * Force reload even if data is already available; for server-side models this should refetch the data from
57228
57413
  * the server
57229
57414
  */
57230
57415
  bReload?: boolean
@@ -57232,18 +57417,16 @@ declare namespace sap {
57232
57417
  /**
57233
57418
  * Destroys the model and clears the model data.
57234
57419
  *
57235
- * A model implementation may override this function and perform model specific cleanup tasks e.g. abort
57420
+ * A model implementation may override this function and perform model-specific cleanup tasks e.g. abort
57236
57421
  * requests, prevent new requests, etc.
57237
57422
  * See:
57238
57423
  * sap.ui.base.Object.prototype.destroy
57239
57424
  */
57240
57425
  destroy(): void;
57241
- /**
57242
- * Implement in inheriting classes.
57243
- */
57426
+
57244
57427
  destroyBindingContext(
57245
57428
  /**
57246
- * to destroy
57429
+ * The context to destroy
57247
57430
  */
57248
57431
  oContext: sap.ui.model.Context
57249
57432
  ): void;
@@ -57254,7 +57437,7 @@ declare namespace sap {
57254
57437
  */
57255
57438
  detachParseError(
57256
57439
  /**
57257
- * The function to be called, when the event occurs
57440
+ * The function to be called when the event occurs
57258
57441
  */
57259
57442
  fnFunction: Function,
57260
57443
  /**
@@ -57270,7 +57453,7 @@ declare namespace sap {
57270
57453
  */
57271
57454
  detachPropertyChange(
57272
57455
  /**
57273
- * The function to be called, when the event occurs
57456
+ * The function to be called when the event occurs
57274
57457
  */
57275
57458
  fnFunction: Function,
57276
57459
  /**
@@ -57302,7 +57485,7 @@ declare namespace sap {
57302
57485
  */
57303
57486
  detachRequestFailed(
57304
57487
  /**
57305
- * The function to be called, when the event occurs
57488
+ * The function to be called when the event occurs
57306
57489
  */
57307
57490
  fnFunction: Function,
57308
57491
  /**
@@ -57365,11 +57548,11 @@ declare namespace sap {
57365
57548
  */
57366
57549
  path?: string;
57367
57550
  /**
57368
- * the context of the property
57551
+ * The context of the property
57369
57552
  */
57370
57553
  context?: object;
57371
57554
  /**
57372
- * the value of the property
57555
+ * The value of the property
57373
57556
  */
57374
57557
  value?: object;
57375
57558
  }
@@ -57383,7 +57566,7 @@ declare namespace sap {
57383
57566
  */
57384
57567
  oParameters?: {
57385
57568
  /**
57386
- * The url which was sent to the backend.
57569
+ * The url which was sent to the back end.
57387
57570
  */
57388
57571
  url?: string;
57389
57572
  /**
@@ -57425,7 +57608,7 @@ declare namespace sap {
57425
57608
  */
57426
57609
  statusText?: string;
57427
57610
  /**
57428
- * Response that has been received for the request ,as a text string
57611
+ * Response that has been received for the request, as a text string
57429
57612
  */
57430
57613
  responseText?: string;
57431
57614
  }
@@ -57439,7 +57622,7 @@ declare namespace sap {
57439
57622
  */
57440
57623
  oParameters?: {
57441
57624
  /**
57442
- * The url which is sent to the backend.
57625
+ * The url which is sent to the back end.
57443
57626
  */
57444
57627
  url?: string;
57445
57628
  /**
@@ -57451,7 +57634,7 @@ declare namespace sap {
57451
57634
  */
57452
57635
  async?: boolean;
57453
57636
  /**
57454
- * additional information for the request (if available) **deprecated**
57637
+ * Additional information for the request (if available) **deprecated**
57455
57638
  */
57456
57639
  info?: string;
57457
57640
  /**
@@ -57496,9 +57679,7 @@ declare namespace sap {
57496
57679
  * Returns the meta model associated with this model if it is available for the concrete model type.
57497
57680
  */
57498
57681
  getMetaModel(): sap.ui.model.MetaModel;
57499
- /**
57500
- * Implement in inheriting classes.
57501
- */
57682
+
57502
57683
  getObject(
57503
57684
  /**
57504
57685
  * Path to where to read the object
@@ -57509,7 +57690,7 @@ declare namespace sap {
57509
57690
  */
57510
57691
  oContext?: sap.ui.model.Context,
57511
57692
  /**
57512
- * Additional model specific parameters
57693
+ * Additional model-specific parameters
57513
57694
  */
57514
57695
  mParameters?: object
57515
57696
  ): any;
@@ -57528,16 +57709,14 @@ declare namespace sap {
57528
57709
  */
57529
57710
  oContext?: sap.ui.model.Context
57530
57711
  ): any;
57531
- /**
57532
- * Implement in inheriting classes.
57533
- */
57712
+
57534
57713
  getProperty(
57535
57714
  /**
57536
- * the path to where to read the attribute value
57715
+ * The path to where to read the attribute value
57537
57716
  */
57538
57717
  sPath: string,
57539
57718
  /**
57540
- * the context with which the path should be resolved
57719
+ * The context with which the path should be resolved
57541
57720
  */
57542
57721
  oContext?: sap.ui.model.Context
57543
57722
  ): any;
@@ -57678,7 +57857,7 @@ declare namespace sap {
57678
57857
  */
57679
57858
  static getMetadata(): sap.ui.base.Metadata;
57680
57859
  /**
57681
- * Returns the binding mode
57860
+ * Returns the binding mode.
57682
57861
  */
57683
57862
  getBindingMode(): sap.ui.model.BindingMode;
57684
57863
  /**
@@ -57686,7 +57865,7 @@ declare namespace sap {
57686
57865
  */
57687
57866
  getExternalValue(): any;
57688
57867
  /**
57689
- * Returns the formatter function
57868
+ * Returns the formatter function.
57690
57869
  */
57691
57870
  getFormatter(): Function;
57692
57871
  /**
@@ -57694,21 +57873,21 @@ declare namespace sap {
57694
57873
  * model format} of this binding's type. If this binding doesn't have a type, the original value which is
57695
57874
  * stored in the model is returned.
57696
57875
  *
57697
- * This method will be used when targetType if set to "internal" or it's included in a {@link sap.ui.model.CompositeBinding
57876
+ * This method will be used when targetType is set to "internal" or when it's included in a {@link sap.ui.model.CompositeBinding
57698
57877
  * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
57699
57878
  * its type or formatter.
57700
57879
  */
57701
57880
  getInternalValue(): any;
57702
57881
  /**
57703
- * Returns the raw model value, as it exists in the model dataset
57882
+ * Returns the raw model value, as it exists in the model dataset.
57704
57883
  *
57705
- * This method will be used when targetType of a binding is set to "raw" or it's included in a {@link sap.ui.model.CompositeBinding
57706
- * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
57707
- * its type or formatter.
57884
+ * This method will be used when targetType of a binding is set to "raw" or when it's include in a {@link
57885
+ * sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related JavaScript
57886
+ * primitive values for its type or formatter.
57708
57887
  */
57709
57888
  getRawValue(): any;
57710
57889
  /**
57711
- * Returns the type if any for the binding.
57890
+ * Returns the type (if any) for the binding.
57712
57891
  */
57713
57892
  getType(): sap.ui.model.Type;
57714
57893
  /**
@@ -57723,22 +57902,22 @@ declare namespace sap {
57723
57902
  */
57724
57903
  resume(): void;
57725
57904
  /**
57726
- * Sets the binding mode
57905
+ * Sets the binding mode.
57727
57906
  */
57728
57907
  setBindingMode(
57729
57908
  /**
57730
- * the binding mode
57909
+ * The binding mode
57731
57910
  */
57732
57911
  sBindingMode: sap.ui.model.BindingMode
57733
57912
  ): void;
57734
57913
  /**
57735
57914
  * Sets the value for this binding. The value is parsed and validated against its type and then set to the
57736
57915
  * binding. A model implementation should check if the current default binding mode permits setting the
57737
- * binding value and if so set the new value also in the model.
57916
+ * binding value, and if so, set the new value in the model, too.
57738
57917
  */
57739
57918
  setExternalValue(
57740
57919
  /**
57741
- * the value to set for this binding
57920
+ * The value to set for this binding
57742
57921
  */
57743
57922
  vValue: any
57744
57923
  ): undefined | Promise<any>;
@@ -57747,7 +57926,7 @@ declare namespace sap {
57747
57926
  */
57748
57927
  setFormatter(
57749
57928
  /**
57750
- * the formatter function for the binding
57929
+ * The formatter function for the binding
57751
57930
  */
57752
57931
  fnFormatter: Function
57753
57932
  ): void;
@@ -57758,20 +57937,20 @@ declare namespace sap {
57758
57937
  */
57759
57938
  setInternalValue(
57760
57939
  /**
57761
- * the value to set for this binding
57940
+ * The value to set for this binding
57762
57941
  */
57763
57942
  vValue: any
57764
- ): void;
57943
+ ): Promise<any> | undefined;
57765
57944
  /**
57766
57945
  * Sets the value for this binding with the raw model value. This setter will perform type validation, in
57767
57946
  * case a type is defined on the binding.
57768
57947
  */
57769
57948
  setRawValue(
57770
57949
  /**
57771
- * the value to set for this binding
57950
+ * The value to set for this binding
57772
57951
  */
57773
57952
  vValue: any
57774
- ): void;
57953
+ ): Promise<any> | undefined;
57775
57954
  /**
57776
57955
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
57777
57956
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -57779,17 +57958,17 @@ declare namespace sap {
57779
57958
  */
57780
57959
  setType(
57781
57960
  /**
57782
- * the type for the binding
57961
+ * The type for the binding
57783
57962
  */
57784
57963
  oType: sap.ui.model.Type,
57785
57964
  /**
57786
- * the internal type of the element property which this binding is bound against.
57965
+ * The internal type of the element property which this binding is bound against.
57787
57966
  */
57788
57967
  sInternalType: string
57789
57968
  ): void;
57790
57969
  /**
57791
57970
  * Sets the value for this binding. A model implementation should check if the current default binding mode
57792
- * permits setting the binding value and if so set the new value also in the model.
57971
+ * permits setting the binding value, and if so, set the new value in the model, too.
57793
57972
  */
57794
57973
  setValue(
57795
57974
  /**
@@ -58499,18 +58678,18 @@ declare namespace sap {
58499
58678
  * @deprecated (since 1.52) - This method is marked as 'protected' which was meant to be overwritten by
58500
58679
  * its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
58501
58680
  *
58502
- * Calculate the request length based on the given information
58681
+ * Calculate the request length based on the given information.
58503
58682
  */
58504
58683
  _calculateRequestLength(
58505
58684
  /**
58506
- * the maximum group size
58685
+ * The maximum group size
58507
58686
  */
58508
- iMaxGroupSize: int,
58687
+ iMaxGroupSize: number,
58509
58688
  /**
58510
- * the information of the current section
58689
+ * The information of the current section
58511
58690
  */
58512
58691
  oSection: object
58513
- ): void;
58692
+ ): number;
58514
58693
  /**
58515
58694
  * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
58516
58695
  * this `sap.ui.model.TreeBindingAdapter`.
@@ -58609,6 +58788,10 @@ declare namespace sap {
58609
58788
  */
58610
58789
  iThreshold?: number
58611
58790
  ): sap.ui.model.Context[];
58791
+ /**
58792
+ * Returns the number of entries in the tree.
58793
+ */
58794
+ getLength(): number;
58612
58795
  /**
58613
58796
  * Gets an array of nodes for the requested part of the tree.
58614
58797
  */
@@ -58627,7 +58810,9 @@ declare namespace sap {
58627
58810
  iThreshold?: number
58628
58811
  ): object[];
58629
58812
  }
58630
-
58813
+ /**
58814
+ * @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
58815
+ */
58631
58816
  class TreeBindingCompatibilityAdapter {
58632
58817
  /**
58633
58818
  * Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
@@ -58635,7 +58820,16 @@ declare namespace sap {
58635
58820
  *
58636
58821
  * This module is only for experimental and internal use!
58637
58822
  */
58638
- constructor();
58823
+ constructor(
58824
+ /**
58825
+ * The binding to add ListBinding functionality to
58826
+ */
58827
+ oBinding: sap.ui.model.TreeBinding,
58828
+ /**
58829
+ * The tree or tree table control using the given binding; the control is used for selection handling
58830
+ */
58831
+ oControl: object
58832
+ );
58639
58833
  }
58640
58834
  /**
58641
58835
  * This is an abstract base class for type objects.
@@ -61540,8 +61734,8 @@ declare namespace sap {
61540
61734
  * ```
61541
61735
  *
61542
61736
  *
61543
- * As of version 1.96 if the flag useLibraryBundle is true the library resource bundle of the control is
61544
- * used to resolve the i18n key
61737
+ * As of version 1.95 if the `useLibraryBundle` flag is set to `true`, the library resource bundle of the
61738
+ * control is used to resolve the i18n key.
61545
61739
  */
61546
61740
  class I18NText extends sap.ui.test.matchers.Matcher {
61547
61741
  /**
@@ -64736,8 +64930,6 @@ declare namespace sap {
64736
64930
 
64737
64931
  "sap/ui/base/ObjectPool": undefined;
64738
64932
 
64739
- "sap/ui/core/_IconRegistry": undefined;
64740
-
64741
64933
  "sap/ui/core/AppCacheBuster": undefined;
64742
64934
 
64743
64935
  "sap/ui/core/BusyIndicator": undefined;
@@ -64812,6 +65004,8 @@ declare namespace sap {
64812
65004
 
64813
65005
  "sap/ui/core/Icon": undefined;
64814
65006
 
65007
+ "sap/ui/core/IconPool": undefined;
65008
+
64815
65009
  "sap/ui/core/IndicationColorSupport": undefined;
64816
65010
 
64817
65011
  "sap/ui/core/IntervalTrigger": undefined;