@openui5/types 1.121.1 → 1.122.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -280,7 +280,7 @@ declare namespace sap {
280
280
  }
281
281
  }
282
282
 
283
- // For Library Version: 1.121.1
283
+ // For Library Version: 1.122.0
284
284
 
285
285
  declare module "sap/base/assert" {
286
286
  /**
@@ -14717,7 +14717,7 @@ declare module "sap/ui/core/Component" {
14717
14717
  */
14718
14718
  settings?: $ComponentSettings;
14719
14719
  /**
14720
- * Initial data of the component (@see sap.ui.core.Component#getComponentData)
14720
+ * Initial data of the component, see {@link sap.ui.core.Component#getComponentData}
14721
14721
  */
14722
14722
  componentData?: object;
14723
14723
  }
@@ -14731,8 +14731,16 @@ declare module "sap/ui/core/Component" {
14731
14731
  * Subclasses of Component should override this hook to implement any necessary cleanup.
14732
14732
  *
14733
14733
  * @ui5-protected Do not call from applications (only from related classes in the framework)
14734
+ *
14735
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
14736
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
14737
+ * function returning a Promise should be used.
14738
+ *
14739
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
14740
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
14741
+ * and will fail in future major versions of UI5.
14734
14742
  */
14735
- exit(): void;
14743
+ exit(): void | undefined;
14736
14744
  /**
14737
14745
  * Returns the list of active terminologies. See the {@link sap.ui.core.Component.create Component.create }
14738
14746
  * factory API documentation for more detail.
@@ -14891,15 +14899,29 @@ declare module "sap/ui/core/Component" {
14891
14899
  * Subclasses of Component should override this hook to implement any necessary initialization.
14892
14900
  *
14893
14901
  * @ui5-protected Do not call from applications (only from related classes in the framework)
14902
+ *
14903
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
14904
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
14905
+ * function returning a Promise should be used.
14906
+ *
14907
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
14908
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
14909
+ * and will fail in future major versions of UI5.
14894
14910
  */
14895
- init(): void;
14911
+ init(): void | undefined;
14896
14912
  /**
14897
14913
  * This method is called after the component is activated
14898
14914
  *
14899
14915
  * @since 1.88
14900
14916
  * @ui5-protected Do not call from applications (only from related classes in the framework)
14917
+ *
14918
+ * @returns This lifecycle hook must not have a return value.
14919
+ *
14920
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
14921
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
14922
+ * and will fail in future major versions of UI5.
14901
14923
  */
14902
- onActivate(): void;
14924
+ onActivate(): void | undefined;
14903
14925
  /**
14904
14926
  * The hook which gets called when the static configuration of the component has been changed by some configuration
14905
14927
  * extension.
@@ -14917,8 +14939,14 @@ declare module "sap/ui/core/Component" {
14917
14939
  *
14918
14940
  * @since 1.88
14919
14941
  * @ui5-protected Do not call from applications (only from related classes in the framework)
14942
+ *
14943
+ * @returns This lifecycle hook must not have a return value.
14944
+ *
14945
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
14946
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
14947
+ * and will fail in future major versions of UI5.
14920
14948
  */
14921
- onDeactivate(): void;
14949
+ onDeactivate(): void | undefined;
14922
14950
  /**
14923
14951
  * The window before unload hook. Override this method in your Component class implementation, to handle
14924
14952
  * cleanup before the real unload or to prompt a question to the user, if the component should be exited.
@@ -17914,13 +17942,21 @@ declare module "sap/ui/core/Control" {
17914
17942
  * Subclasses of Control should override this hook to implement any necessary actions after the rendering.
17915
17943
  *
17916
17944
  * @ui5-protected Do not call from applications (only from related classes in the framework)
17945
+ *
17946
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
17947
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
17948
+ * function returning a Promise should be used.
17949
+ *
17950
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
17951
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
17952
+ * and will fail in future major versions of UI5.
17917
17953
  */
17918
17954
  onAfterRendering(
17919
17955
  /**
17920
17956
  * onAfterRendering event object
17921
17957
  */
17922
17958
  oEvent: jQuery.Event
17923
- ): void;
17959
+ ): void | undefined;
17924
17960
  /**
17925
17961
  * Function is called before the rendering of the control is started.
17926
17962
  *
@@ -17929,13 +17965,21 @@ declare module "sap/ui/core/Control" {
17929
17965
  * Subclasses of Control should override this hook to implement any necessary actions before the rendering.
17930
17966
  *
17931
17967
  * @ui5-protected Do not call from applications (only from related classes in the framework)
17968
+ *
17969
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
17970
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
17971
+ * function returning a Promise should be used.
17972
+ *
17973
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
17974
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
17975
+ * and will fail in future major versions of UI5.
17932
17976
  */
17933
17977
  onBeforeRendering(
17934
17978
  /**
17935
17979
  * onBeforeRendering event object
17936
17980
  */
17937
17981
  oEvent: jQuery.Event
17938
- ): void;
17982
+ ): void | undefined;
17939
17983
  /**
17940
17984
  * Puts `this` control into the specified container (`oRef`) at the given position (`oPosition`).
17941
17985
  *
@@ -20649,15 +20693,15 @@ declare module "sap/ui/core/delegate/ScrollEnablement" {
20649
20693
  */
20650
20694
  vertical?: boolean;
20651
20695
  /**
20652
- * @deprecated since 1.42, the parameter has no effect
20696
+ * Deprecated since 1.42, the parameter has no effect
20653
20697
  */
20654
20698
  zynga?: boolean;
20655
20699
  /**
20656
- * @deprecated since 1.42, the parameter has no effect
20700
+ * Deprecated since 1.42, the parameter has no effect
20657
20701
  */
20658
20702
  iscroll?: boolean;
20659
20703
  /**
20660
- * @deprecated since 1.42, the parameter has no effect
20704
+ * Deprecated since 1.42, the parameter has no effect
20661
20705
  */
20662
20706
  preventDefault?: boolean;
20663
20707
  /**
@@ -23168,8 +23212,16 @@ declare module "sap/ui/core/Element" {
23168
23212
  * in the documentation.
23169
23213
  *
23170
23214
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23215
+ *
23216
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
23217
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
23218
+ * function returning a Promise should be used.
23219
+ *
23220
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
23221
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
23222
+ * and will fail in future major versions of UI5.
23171
23223
  */
23172
- exit(): void;
23224
+ exit(): void | undefined;
23173
23225
  /**
23174
23226
  * Searches and returns an array of child elements and controls which are referenced within an aggregation
23175
23227
  * or aggregations of child elements/controls. This can be either done recursive or not.
@@ -23397,8 +23449,16 @@ declare module "sap/ui/core/Element" {
23397
23449
  * Subclasses of Element should override this hook to implement any necessary initialization.
23398
23450
  *
23399
23451
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23452
+ *
23453
+ * @returns This hook method must not have a return value. Return value `void` is deprecated since 1.120,
23454
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
23455
+ * function returning a Promise should be used.
23456
+ *
23457
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
23458
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
23459
+ * and will fail in future major versions of UI5.
23400
23460
  */
23401
- init(): void;
23461
+ init(): void | undefined;
23402
23462
  /**
23403
23463
  * Inserts a customData into the aggregation {@link #getCustomData customData}.
23404
23464
  *
@@ -24406,10 +24466,10 @@ declare module "sap/ui/core/format/DateFormat" {
24406
24466
  */
24407
24467
  relative?: boolean;
24408
24468
  /**
24409
- * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to default value
24410
- * 'day', the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next
24411
- * 6 days are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all
24412
- * dates are formatted relatively.
24469
+ * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to value 'day',
24470
+ * the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next 6 days
24471
+ * are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all dates are
24472
+ * formatted relatively.
24413
24473
  */
24414
24474
  relativeRange?: int[];
24415
24475
  /**
@@ -24629,10 +24689,10 @@ declare module "sap/ui/core/format/DateFormat" {
24629
24689
  */
24630
24690
  relative?: boolean;
24631
24691
  /**
24632
- * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to default value
24633
- * 'day', the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next
24634
- * 6 days are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all
24635
- * dates are formatted relatively.
24692
+ * the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to value 'day',
24693
+ * the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next 6 days
24694
+ * are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all dates are
24695
+ * formatted relatively.
24636
24696
  */
24637
24697
  relativeRange?: int[];
24638
24698
  /**
@@ -25039,7 +25099,7 @@ declare module "sap/ui/core/format/NumberFormat" {
25039
25099
  protected constructor();
25040
25100
  /**
25041
25101
  * Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding
25042
- * mode in this object indicates how the least significant returned digits of rounded result is to be calculated.
25102
+ * mode in this object indicates how the least significant returned digits of rounded result are to be calculated.
25043
25103
  *
25044
25104
  * This enum is part of the 'sap/ui/core/format/NumberFormat' module export and must be accessed by the
25045
25105
  * property 'RoundingMode'.
@@ -25925,15 +25985,16 @@ declare module "sap/ui/core/format/NumberFormat" {
25925
25985
  * Format a number according to the given format options.
25926
25986
  *
25927
25987
  *
25928
- * @returns the formatted output value
25988
+ * @returns The formatted value
25929
25989
  */
25930
25990
  format(
25931
25991
  /**
25932
- * the number to format or an array which contains the number to format and the sMeasure parameter
25992
+ * The number to format as a number or a string, such as `1234.45` or `"-1234.45"`, or an array which contains
25993
+ * both the number to format as a number or a string and the `sMeasure` parameter
25933
25994
  */
25934
- vValue: number | any[],
25995
+ vValue: number | string | any[],
25935
25996
  /**
25936
- * an optional unit which has an impact on formatting currencies and units
25997
+ * An optional unit which has an impact on formatting currencies and units
25937
25998
  */
25938
25999
  sMeasure?: string
25939
26000
  ): string;
@@ -25974,46 +26035,56 @@ declare module "sap/ui/core/format/NumberFormat" {
25974
26035
  }
25975
26036
  /**
25976
26037
  * Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding
25977
- * mode in this object indicates how the least significant returned digits of rounded result is to be calculated.
26038
+ * mode in this object indicates how the least significant returned digits of rounded result are to be calculated.
25978
26039
  *
25979
26040
  * This enum is part of the 'sap/ui/core/format/NumberFormat' module export and must be accessed by the
25980
26041
  * property 'RoundingMode'.
25981
26042
  */
25982
26043
  enum RoundingMode {
25983
26044
  /**
25984
- * Rounding mode to round away from zero
26045
+ * Rounding mode to round away from zero; examples of rounding results to one fractional digit: 0.51 is
26046
+ * rounded to 0.6, and -0.51 is rounded to -0.6.
25985
26047
  */
25986
26048
  AWAY_FROM_ZERO = "AWAY_FROM_ZERO",
25987
26049
  /**
25988
- * Rounding mode to round towards positive infinity
26050
+ * Rounding mode to round towards positive infinity; examples of rounding results to one fractional digit:
26051
+ * 0.51 is rounded to 0.6, and -0.51 is rounded to -0.5.
25989
26052
  */
25990
26053
  CEILING = "CEILING",
25991
26054
  /**
25992
- * Rounding mode to round towards negative infinity
26055
+ * Rounding mode to round towards negative infinity; examples of rounding results to one fractional digit:
26056
+ * 0.51 is rounded to 0.5, and -0.51 is rounded to -0.6.
25993
26057
  */
25994
26058
  FLOOR = "FLOOR",
25995
26059
  /**
25996
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
25997
- * round away from zero.
26060
+ * Rounding mode to round towards the nearest neighbor unless, both neighbors are equidistant, in which
26061
+ * case round away from zero; examples of rounding results to one fractional digit: 0.54 or 0.46 are rounded
26062
+ * to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.6, and -0.55 is rounded to -0.6.
25998
26063
  */
25999
26064
  HALF_AWAY_FROM_ZERO = "HALF_AWAY_FROM_ZERO",
26000
26065
  /**
26001
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
26002
- * round towards positive infinity.
26066
+ * Rounding mode to round towards the nearest neighbor, unless both neighbors are equidistant, in which
26067
+ * case round towards positive infinity; examples of rounding results to one fractional digit: 0.54 or 0.46
26068
+ * are rounded to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.6, and -0.55 is rounded
26069
+ * to -0.5.
26003
26070
  */
26004
26071
  HALF_CEILING = "HALF_CEILING",
26005
26072
  /**
26006
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
26007
- * round towards negative infinity.
26073
+ * Rounding mode to round towards the nearest neighbor, unless both neighbors are equidistant, in which
26074
+ * case round towards negative infinity; examples of rounding results to one fractional digit: 0.54 or 0.46
26075
+ * are rounded to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.5, and -0.55 is rounded
26076
+ * to -0.6.
26008
26077
  */
26009
26078
  HALF_FLOOR = "HALF_FLOOR",
26010
26079
  /**
26011
- * Rounding mode to round towards the nearest neighbor unless both neighbors are equidistant, in which case
26012
- * round towards zero.
26080
+ * Rounding mode to round towards the nearest neighbor, unless both neighbors are equidistant, in which
26081
+ * case round towards zero; examples of rounding results to one fractional digit: 0.54 or 0.46 are rounded
26082
+ * to 0.5, -0.54 or -0.46 are rounded to -0.5, 0.55 is rounded to 0.5, and -0.55 is rounded to -0.5.
26013
26083
  */
26014
26084
  HALF_TOWARDS_ZERO = "HALF_TOWARDS_ZERO",
26015
26085
  /**
26016
- * Rounding mode to round towards zero
26086
+ * Rounding mode to round towards zero; examples of rounding results to one fractional digit: 0.59 is rounded
26087
+ * to 0.5, and -0.59 is rounded to -0.5.
26017
26088
  */
26018
26089
  TOWARDS_ZERO = "TOWARDS_ZERO",
26019
26090
  }
@@ -32369,8 +32440,16 @@ declare module "sap/ui/core/mvc/Controller" {
32369
32440
  * sap.ui.core.Control.prototype.onAfterRendering
32370
32441
  *
32371
32442
  * @ui5-protected Do not call from applications (only from related classes in the framework)
32443
+ *
32444
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
32445
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
32446
+ * function returning a Promise should be used.
32447
+ *
32448
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
32449
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
32450
+ * and will fail in future major versions of UI5.
32372
32451
  */
32373
- onAfterRendering(): void;
32452
+ onAfterRendering(): void | undefined;
32374
32453
  /**
32375
32454
  * This method is called every time the View is rendered, before the Renderer is called and the HTML is
32376
32455
  * placed in the DOM-Tree. It can be used to perform clean-up-tasks before re-rendering. (Even though this
@@ -32380,8 +32459,16 @@ declare module "sap/ui/core/mvc/Controller" {
32380
32459
  * sap.ui.core.Control.prototype.onBeforeRendering
32381
32460
  *
32382
32461
  * @ui5-protected Do not call from applications (only from related classes in the framework)
32462
+ *
32463
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
32464
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
32465
+ * function returning a Promise should be used.
32466
+ *
32467
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
32468
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
32469
+ * and will fail in future major versions of UI5.
32383
32470
  */
32384
- onBeforeRendering(): void;
32471
+ onBeforeRendering(): void | undefined;
32385
32472
  /**
32386
32473
  * This method is called upon desctuction of the View. The controller should perform its internal destruction
32387
32474
  * in this hook. It is only called once per View instance, unlike the onBeforeRendering and onAfterRendering
@@ -32389,8 +32476,16 @@ declare module "sap/ui/core/mvc/Controller" {
32389
32476
  * if the method does not exist, it will simply not be called.)
32390
32477
  *
32391
32478
  * @ui5-protected Do not call from applications (only from related classes in the framework)
32479
+ *
32480
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
32481
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
32482
+ * function returning a Promise should be used.
32483
+ *
32484
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
32485
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
32486
+ * and will fail in future major versions of UI5.
32392
32487
  */
32393
- onExit(): void;
32488
+ onExit(): void | undefined;
32394
32489
  /**
32395
32490
  * This method is called upon initialization of the View. The controller can perform its internal setup
32396
32491
  * in this hook. It is only called once per View instance, unlike the onBeforeRendering and onAfterRendering
@@ -32404,8 +32499,16 @@ declare module "sap/ui/core/mvc/Controller" {
32404
32499
  * event. The event is fired when either the context or the model changes for the control.
32405
32500
  *
32406
32501
  * @ui5-protected Do not call from applications (only from related classes in the framework)
32502
+ *
32503
+ * @returns This lifecycle hook must not have a return value. Return value `void` is deprecated since 1.120,
32504
+ * as it does not force functions to **not** return something. This implies that, for instance, no async
32505
+ * function returning a Promise should be used.
32506
+ *
32507
+ * **Note:** While the return type is currently `void|undefined`, any implementation of this hook must not
32508
+ * return anything but undefined. Any other return value will cause an error log in this version of UI5
32509
+ * and will fail in future major versions of UI5.
32407
32510
  */
32408
- onInit(): void;
32511
+ onInit(): void | undefined;
32409
32512
  }
32410
32513
  }
32411
32514
 
@@ -38643,7 +38746,7 @@ declare module "sap/ui/core/routing/Router" {
38643
38746
  */
38644
38747
  addRoute(
38645
38748
  /**
38646
- * Configuration object for the route @see sap.ui.core.routing.Route#constructor
38749
+ * Configuration object for the route, see {@link sap.ui.core.routing.Route#constructor}
38647
38750
  */
38648
38751
  oConfig: $RouteSettings,
38649
38752
  /**
@@ -48718,10 +48821,12 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
48718
48821
 
48719
48822
  import Model from "sap/ui/model/Model";
48720
48823
 
48721
- import TreeAutoExpandMode from "sap/ui/model/TreeAutoExpandMode";
48824
+ import Sorter from "sap/ui/model/Sorter";
48722
48825
 
48723
48826
  import Filter from "sap/ui/model/Filter";
48724
48827
 
48828
+ import TreeAutoExpandMode from "sap/ui/model/TreeAutoExpandMode";
48829
+
48725
48830
  import FilterType from "sap/ui/model/FilterType";
48726
48831
 
48727
48832
  import { QueryResult } from "sap/ui/model/analytics/odata4analytics";
@@ -48730,8 +48835,6 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
48730
48835
 
48731
48836
  import Metadata from "sap/ui/base/Metadata";
48732
48837
 
48733
- import Sorter from "sap/ui/model/Sorter";
48734
-
48735
48838
  /**
48736
48839
  * Tree binding implementation for OData entity sets with aggregate semantics.
48737
48840
  *
@@ -48765,13 +48868,14 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
48765
48868
  */
48766
48869
  oContext?: object,
48767
48870
  /**
48768
- * An array of predefined sorters
48871
+ * The sorters used initially; call {@link #sort} to replace them
48769
48872
  */
48770
- aSorter?: any[],
48873
+ aSorters?: Sorter[] | Sorter,
48771
48874
  /**
48772
- * An array of predefined filters
48875
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
48876
+ * to replace them
48773
48877
  */
48774
- aFilters?: any[],
48878
+ aFilters?: Filter[] | Filter,
48775
48879
  /**
48776
48880
  * A map containing additional binding parameters; for the `AnalyticalBinding` this parameter is mandatory
48777
48881
  */
@@ -48860,9 +48964,11 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
48860
48964
  */
48861
48965
  filter(
48862
48966
  /**
48863
- * an Array of sap.ui.model.Filter objects or a single Filter instance.
48967
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
48968
+ * given in {@link sap.ui.model.odata.v2.ODataModel#bindList}; a falsy value is treated as an empty array
48969
+ * and thus removes all filters of the specified type
48864
48970
  */
48865
- aFilter: Filter[] | Filter,
48971
+ aFilters?: Filter[] | Filter,
48866
48972
  /**
48867
48973
  * Type of the filter which should be adjusted.
48868
48974
  */
@@ -49286,9 +49392,10 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
49286
49392
  */
49287
49393
  sort(
49288
49394
  /**
49289
- * a sorter object or an array of sorter objects which define the sort order.
49395
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.odata.v2.ODataModel#bindList};
49396
+ * a falsy value is treated as an empty array and thus removes all sorters
49290
49397
  */
49291
- aSorter: Sorter | any[]
49398
+ aSorter?: Sorter[] | Sorter
49292
49399
  ): this;
49293
49400
  /**
49294
49401
  * Updates the binding's structure with new analytical information.
@@ -49391,7 +49498,7 @@ declare module "sap/ui/model/analytics/BatchResponseCollector" {
49391
49498
  */
49392
49499
  constructor(
49393
49500
  /**
49394
- * optional Setup-Parameter, @see BatchResponseCollector#setup
49501
+ * optional Setup-Parameter, see {@link #setup}
49395
49502
  */
49396
49503
  mParams?: object
49397
49504
  );
@@ -49469,10 +49576,10 @@ declare module "sap/ui/model/analytics/BatchResponseCollector" {
49469
49576
  }
49470
49577
 
49471
49578
  declare module "sap/ui/model/analytics/odata4analytics" {
49472
- import FilterOperator from "sap/ui/model/FilterOperator";
49473
-
49474
49579
  import Filter from "sap/ui/model/Filter";
49475
49580
 
49581
+ import FilterOperator from "sap/ui/model/FilterOperator";
49582
+
49476
49583
  import Sorter from "sap/ui/model/Sorter";
49477
49584
 
49478
49585
  /**
@@ -50109,21 +50216,21 @@ declare module "sap/ui/model/analytics/odata4analytics" {
50109
50216
  */
50110
50217
  addCondition(
50111
50218
  /**
50112
- * The name of the property bound in the condition
50219
+ * The name of the property or a {@link sap.ui.model.Filter} instance
50113
50220
  */
50114
- sPropertyName: string,
50221
+ vPropertyNameOrFilter: string | Filter,
50115
50222
  /**
50116
- * operator used for the condition
50223
+ * The operator of the condition, only used if `vPropertyNameOrFilter` is a string
50117
50224
  */
50118
- sOperator: FilterOperator | keyof typeof FilterOperator,
50225
+ sOperator?: FilterOperator | keyof typeof FilterOperator,
50119
50226
  /**
50120
- * value to be used for this condition
50227
+ * The value of the condition, only used if `vPropertyNameOrFilter` is a string
50121
50228
  */
50122
- oValue: object,
50229
+ oValue?: object,
50123
50230
  /**
50124
- * (optional) as second value to be used for this condition
50231
+ * The second value of the condition, only used if `vPropertyNameOrFilter` is a string
50125
50232
  */
50126
- oValue2: object
50233
+ oValue2?: object
50127
50234
  ): FilterExpression;
50128
50235
  /**
50129
50236
  * Add a set condition to the filter expression.
@@ -50145,7 +50252,7 @@ declare module "sap/ui/model/analytics/odata4analytics" {
50145
50252
  aValues: any[]
50146
50253
  ): FilterExpression;
50147
50254
  /**
50148
- * Add an array of UI5 filter conditions to the filter expression.
50255
+ * Adds an array of UI5 filter conditions to the filter expression.
50149
50256
  *
50150
50257
  * The UI5 filter condition is combined with the other given conditions using a logical AND. This method
50151
50258
  * is particularly useful for passing forward already created UI5 filter arrays.
@@ -52258,13 +52365,14 @@ declare module "sap/ui/model/ClientListBinding" {
52258
52365
  */
52259
52366
  oContext: Context,
52260
52367
  /**
52261
- * Initial sort order (can be either a sorter or an array of sorters)
52368
+ * The sorters used initially; call {@link #sort} to replace them
52262
52369
  */
52263
- aSorters?: Sorter | Sorter[],
52370
+ aSorters?: Sorter[] | Sorter,
52264
52371
  /**
52265
- * Predefined filter/s (can be either a filter or an array of filters)
52372
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
52373
+ * to replace them
52266
52374
  */
52267
- aFilters?: Filter | Filter[],
52375
+ aFilters?: Filter[] | Filter,
52268
52376
  /**
52269
52377
  * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
52270
52378
  */
@@ -52318,12 +52426,14 @@ declare module "sap/ui/model/ClientListBinding" {
52318
52426
  */
52319
52427
  filter(
52320
52428
  /**
52321
- * Single filter object or an array of filter objects
52429
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
52430
+ * given in {@link sap.ui.model.ClientModel#bindList}; a falsy value is treated as an empty array and thus
52431
+ * removes all filters of the specified type
52322
52432
  */
52323
- aFilters: Filter | Filter[],
52433
+ aFilters?: Filter[] | Filter,
52324
52434
  /**
52325
- * Type of the filter which should be adjusted; if no type is given, then any previously configured application
52326
- * filters are cleared and the given filters are used as control filters
52435
+ * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
52436
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
52327
52437
  */
52328
52438
  sFilterType?: FilterType | keyof typeof FilterType
52329
52439
  ): this;
@@ -52629,18 +52739,19 @@ declare module "sap/ui/model/ClientTreeBinding" {
52629
52739
  */
52630
52740
  oContext?: Context,
52631
52741
  /**
52632
- * Predefined application filter, either a single instance or an array
52742
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
52743
+ * to replace them
52633
52744
  */
52634
- aApplicationFilters?: Filter | Filter[],
52745
+ aApplicationFilters?: Filter[] | Filter,
52635
52746
  /**
52636
52747
  * Additional model specific parameters as defined by subclasses; this class does not introduce any own
52637
52748
  * parameters
52638
52749
  */
52639
52750
  mParameters?: object,
52640
52751
  /**
52641
- * Predefined sorter/s contained in an array (optional)
52752
+ * The sorters used initially; call {@link #sort} to replace them
52642
52753
  */
52643
- aSorters?: Sorter[]
52754
+ aSorters?: Sorter[] | Sorter
52644
52755
  );
52645
52756
 
52646
52757
  /**
@@ -52690,12 +52801,14 @@ declare module "sap/ui/model/ClientTreeBinding" {
52690
52801
  */
52691
52802
  filter(
52692
52803
  /**
52693
- * Single filter object or an array of filter objects
52804
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
52805
+ * given in {@link sap.ui.model.ClientModel#bindTree}; a falsy value is treated as an empty array and thus
52806
+ * removes all filters of the specified type
52694
52807
  */
52695
- aFilters: Filter | Filter[],
52808
+ aFilters?: Filter[] | Filter,
52696
52809
  /**
52697
- * Type of the filter to be adjusted; if no type is given, any previously configured application filters
52698
- * are cleared, and the given filters are used as control filters
52810
+ * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
52811
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
52699
52812
  */
52700
52813
  sFilterType?: FilterType | keyof typeof FilterType
52701
52814
  ): this;
@@ -52768,9 +52881,10 @@ declare module "sap/ui/model/ClientTreeBinding" {
52768
52881
  */
52769
52882
  sort(
52770
52883
  /**
52771
- * An array of Sorter instances which will be applied
52884
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.ClientModel#bindTree}; a falsy
52885
+ * value is treated as an empty array and thus removes all sorters
52772
52886
  */
52773
- aSorters: Sorter[]
52887
+ aSorters?: Sorter[] | Sorter
52774
52888
  ): this;
52775
52889
  }
52776
52890
  }
@@ -53399,9 +53513,9 @@ declare module "sap/ui/model/CompositeType" {
53399
53513
  * @since 1.82.0
53400
53514
  *
53401
53515
  * @returns An array of indices that determine which parts of this type shall not propagate their model
53402
- * messages to the attached control
53516
+ * messages to the attached control; an empty array is returned by default
53403
53517
  */
53404
- getPartsIgnoringMessages(): number[];
53518
+ getPartsIgnoringMessages(): int[];
53405
53519
  /**
53406
53520
  * Returns whether the {@link #formatValue} and {@link #parseValue} methods operate on the internal, related
53407
53521
  * native JavaScript values.
@@ -54413,13 +54527,14 @@ declare module "sap/ui/model/json/JSONListBinding" {
54413
54527
  */
54414
54528
  oContext: Context,
54415
54529
  /**
54416
- * Initial sort order (can be either a sorter or an array of sorters)
54530
+ * The sorters used initially; call {@link #sort} to replace them
54417
54531
  */
54418
- aSorters?: Sorter | Sorter[],
54532
+ aSorters?: Sorter[] | Sorter,
54419
54533
  /**
54420
- * Predefined filter/s (can be either a filter or an array of filters)
54534
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
54535
+ * to replace them
54421
54536
  */
54422
- aFilters?: Filter | Filter[],
54537
+ aFilters?: Filter[] | Filter,
54423
54538
  /**
54424
54539
  * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
54425
54540
  */
@@ -54542,9 +54657,11 @@ declare module "sap/ui/model/json/JSONModel" {
54542
54657
  */
54543
54658
  sURL: string,
54544
54659
  /**
54545
- * A map or string that is sent to the server with the request. Data that is sent to the server is appended
54546
- * to the URL as a query string. If the value of the data parameter is an object (map), it is converted
54547
- * to a string and url-encoded before it is appended to the URL.
54660
+ * A map or string that is sent to the server with the request. If the value of this parameter is a string,
54661
+ * it must already be url-encoded. If the value of this parameter is an object (map), it is converted to
54662
+ * a string and then url-encoded. The resulting string is appended to the URL if the HTTP request method
54663
+ * cannot have a request body, e.g. for a GET request. Otherwise, the resulting string is added to the request
54664
+ * body.
54548
54665
  */
54549
54666
  oParameters?: object | string,
54550
54667
  /**
@@ -54677,6 +54794,8 @@ declare module "sap/ui/model/json/JSONTreeBinding" {
54677
54794
 
54678
54795
  import Filter from "sap/ui/model/Filter";
54679
54796
 
54797
+ import Sorter from "sap/ui/model/Sorter";
54798
+
54680
54799
  /**
54681
54800
  * Tree binding implementation for JSON format.
54682
54801
  *
@@ -54710,9 +54829,10 @@ declare module "sap/ui/model/json/JSONTreeBinding" {
54710
54829
  */
54711
54830
  oContext?: object,
54712
54831
  /**
54713
- * Predefined filters contained in an array
54832
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
54833
+ * to replace them
54714
54834
  */
54715
- aFilters?: Filter | Filter[],
54835
+ aFilters?: Filter[] | Filter,
54716
54836
  /**
54717
54837
  * Additional model-specific parameters
54718
54838
  */
@@ -54724,7 +54844,11 @@ declare module "sap/ui/model/json/JSONTreeBinding" {
54724
54844
  * its child arrays will be ignored as well even if they have been added to `arrayNames`.
54725
54845
  */
54726
54846
  arrayNames?: string[];
54727
- }
54847
+ },
54848
+ /**
54849
+ * The sorters used initially; call {@link #sort} to replace them
54850
+ */
54851
+ aSorters?: Sorter[] | Sorter
54728
54852
  );
54729
54853
  }
54730
54854
  }
@@ -54769,13 +54893,14 @@ declare module "sap/ui/model/ListBinding" {
54769
54893
  */
54770
54894
  oContext: Context,
54771
54895
  /**
54772
- * Initial sort order (can be either a sorter or an array of sorters)
54896
+ * The sorters used initially; call {@link #sort} to replace them
54773
54897
  */
54774
- aSorters?: Sorter | Sorter[],
54898
+ aSorters?: Sorter[] | Sorter,
54775
54899
  /**
54776
- * Predefined filter/s (can be either a filter or an array of filters)
54900
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
54901
+ * to replace them
54777
54902
  */
54778
- aFilters?: Filter | Filter[],
54903
+ aFilters?: Filter[] | Filter,
54779
54904
  /**
54780
54905
  * Additional, implementation-specific parameters that should be used by the new list binding; this base
54781
54906
  * class doesn't define any parameters, check the API reference for the concrete model implementations to
@@ -54961,11 +55086,13 @@ declare module "sap/ui/model/ListBinding" {
54961
55086
  */
54962
55087
  filter(
54963
55088
  /**
54964
- * Single filter object or an array of filter objects
55089
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
55090
+ * given in {@link sap.ui.model.Model#bindList}; a falsy value is treated as an empty array and thus removes
55091
+ * all filters of the specified type
54965
55092
  */
54966
- aFilters: Filter | Filter[],
55093
+ aFilters?: Filter[] | Filter,
54967
55094
  /**
54968
- * Type of the filter which should be adjusted; if no type is given, the behavior depends on the model implementation
55095
+ * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
54969
55096
  */
54970
55097
  sFilterType?: FilterType | keyof typeof FilterType
54971
55098
  ): this;
@@ -55172,9 +55299,10 @@ declare module "sap/ui/model/ListBinding" {
55172
55299
  */
55173
55300
  sort(
55174
55301
  /**
55175
- * The Sorter object or an array of sorters which defines the sort order
55302
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.Model#bindList}; a falsy value
55303
+ * is treated as an empty array and thus removes all sorters
55176
55304
  */
55177
- aSorters: Sorter | Sorter[]
55305
+ aSorters?: Sorter[] | Sorter
55178
55306
  ): this;
55179
55307
  /**
55180
55308
  * Update the list and apply sorting and filtering. Called after creation of the list binding on enabling
@@ -55676,13 +55804,14 @@ declare module "sap/ui/model/Model" {
55676
55804
  */
55677
55805
  oContext?: Context,
55678
55806
  /**
55679
- * Initial sort order (can be either a sorter or an array of sorters)
55807
+ * The sorters used initially; call {@link sap.ui.model.ListBinding#sort} to replace them
55680
55808
  */
55681
- aSorters?: Sorter | Sorter[],
55809
+ aSorters?: Sorter[] | Sorter,
55682
55810
  /**
55683
- * Predefined filter/s (can be either a filter or an array of filters)
55811
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.ListBinding#filter }
55812
+ * to replace them
55684
55813
  */
55685
- aFilters?: Filter | Filter[],
55814
+ aFilters?: Filter[] | Filter,
55686
55815
  /**
55687
55816
  * Additional model-specific parameters
55688
55817
  */
@@ -55720,17 +55849,18 @@ declare module "sap/ui/model/Model" {
55720
55849
  */
55721
55850
  oContext?: Context,
55722
55851
  /**
55723
- * Predefined filter/s contained in an array
55852
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.TreeBinding#filter }
55853
+ * to replace them
55724
55854
  */
55725
- aFilters?: Filter[],
55855
+ aFilters?: Filter[] | Filter,
55726
55856
  /**
55727
55857
  * Additional model specific parameters
55728
55858
  */
55729
55859
  mParameters?: object,
55730
55860
  /**
55731
- * Predefined sap.ui.model.sorter/s contained in an array
55861
+ * The sorters used initially; call {@link sap.ui.model.TreeBinding#sort} to replace them
55732
55862
  */
55733
- aSorters?: Sorter[]
55863
+ aSorters?: Sorter[] | Sorter
55734
55864
  ): TreeBinding;
55735
55865
  /**
55736
55866
  *
@@ -64648,8 +64778,8 @@ declare module "sap/ui/model/odata/v2/ODataAnnotations" {
64648
64778
  */
64649
64779
  export type failedParameters = {
64650
64780
  /**
64651
- * An array of Errors (@see sap.ui.model.v2.ODataAnnotations#error) that occurred while loading a group
64652
- * of annotations
64781
+ * An array of Errors, see {@link sap.ui.model.v2.ODataAnnotations#error} that occurred while loading a
64782
+ * group of annotations
64653
64783
  */
64654
64784
  result: Error[];
64655
64785
  };
@@ -64878,13 +65008,14 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
64878
65008
  */
64879
65009
  oContext?: Context,
64880
65010
  /**
64881
- * Initial sort order, can be either a sorter or an array of sorters.
65011
+ * The sorters used initially; call {@link #sort} to replace them
64882
65012
  */
64883
- aSorters?: Sorter | Sorter[],
65013
+ aSorters?: Sorter[] | Sorter,
64884
65014
  /**
64885
- * Predefined filters, can be either a filter or an array of filters.
65015
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
65016
+ * to replace them
64886
65017
  */
64887
- aFilters?: Filter | Filter[],
65018
+ aFilters?: Filter[] | Filter,
64888
65019
  /**
64889
65020
  * A map which contains additional parameters for the binding.
64890
65021
  */
@@ -65097,11 +65228,13 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
65097
65228
  */
65098
65229
  filter(
65099
65230
  /**
65100
- * Single filter or array of filter objects
65231
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
65232
+ * given in {@link sap.ui.model.odata.v2.ODataModel#bindList}; a falsy value is treated as an empty array
65233
+ * and thus removes all filters of the specified type
65101
65234
  */
65102
- aFilters?: Filter | Filter[],
65235
+ aFilters?: Filter[] | Filter,
65103
65236
  /**
65104
- * Type of the filter which should be adjusted. If it is not given, type `Control` is assumed
65237
+ * The type of the filter to replace
65105
65238
  */
65106
65239
  sFilterType?: FilterType | keyof typeof FilterType,
65107
65240
  /**
@@ -65271,9 +65404,10 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
65271
65404
  */
65272
65405
  sort(
65273
65406
  /**
65274
- * A new sorter or an array of sorters which define the sort order
65407
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.odata.v2.ODataModel#bindList};
65408
+ * a falsy value is treated as an empty array and thus removes all sorters
65275
65409
  */
65276
- aSorters: Sorter | Sorter[],
65410
+ aSorters?: Sorter[] | Sorter,
65277
65411
  /**
65278
65412
  * Whether the success indicator should be returned instead of `this`
65279
65413
  */
@@ -65946,13 +66080,14 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
65946
66080
  */
65947
66081
  oContext?: Context,
65948
66082
  /**
65949
- * Initial sort order, can be either a sorter or an array of sorters.
66083
+ * The sorters used initially; call {@link sap.ui.model.odata.v2.ODataListBinding#sort} to replace them
65950
66084
  */
65951
- aSorters?: Sorter | Sorter[],
66085
+ aSorters?: Sorter[] | Sorter,
65952
66086
  /**
65953
- * Predefined filters, can be either a filter or an array of filters.
66087
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.odata.v2.ODataListBinding#filter }
66088
+ * to replace them
65954
66089
  */
65955
- aFilters?: Filter | Filter[],
66090
+ aFilters?: Filter[] | Filter,
65956
66091
  /**
65957
66092
  * A map which contains additional parameters for the binding.
65958
66093
  */
@@ -66078,7 +66213,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
66078
66213
  *
66079
66214
  * Operation Modes: For a full definition and explanation of all OData binding operation modes, see {@link sap.ui.model.odata.OperationMode}.
66080
66215
  *
66081
- * OperationMode.Server: Filtering on the `ODataTreeBinding` is only supported with {@link sap.ui.model.FilterType.Application application filters}.
66216
+ * OperationMode.Server: Filtering on the `ODataTreeBinding` is only supported with filters of type {@link sap.ui.model.FilterType.Application}.
66082
66217
  * Be aware that this applies only to filters which do not prevent the creation of a hierarchy. So filtering
66083
66218
  * on a property (e.g. a "Customer") is fine, as long as the application ensures that the responses from
66084
66219
  * the back end are sufficient to create a valid hierarchy on the client. Subsequent paging requests for
@@ -66112,8 +66247,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
66112
66247
  */
66113
66248
  oContext?: Context,
66114
66249
  /**
66115
- * The application filters to be used initially; depending on the operation mode, there are restrictions
66116
- * for using filters, see above
66250
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link sap.ui.model.odata.v2.ODataTreeBinding#filter }
66251
+ * to replace them; depending on the operation mode, there are restrictions for using filters; see above
66117
66252
  */
66118
66253
  vFilters?: Filter | Filter[],
66119
66254
  /**
@@ -66231,9 +66366,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
66231
66366
  navigation?: object;
66232
66367
  },
66233
66368
  /**
66234
- * The dynamic sorters to be used initially
66369
+ * The sorters used initially; call {@link sap.ui.model.odata.v2.ODataTreeBinding#sort} to replace them
66235
66370
  */
66236
- vSorters?: Sorter | Sorter[]
66371
+ vSorters?: Sorter[] | Sorter
66237
66372
  ): ODataTreeBinding;
66238
66373
  /**
66239
66374
  * Triggers a request for the given function import.
@@ -68331,13 +68466,15 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
68331
68466
  */
68332
68467
  filter(
68333
68468
  /**
68334
- * Filter or array of filters to apply
68469
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
68470
+ * given in {@link sap.ui.model.odata.v2.ODataModel#bindTree}; a falsy value is treated as an empty array
68471
+ * and thus removes all filters of the specified type
68335
68472
  */
68336
- aFilters: Filter[] | Filter,
68473
+ aFilters?: Filter[] | Filter,
68337
68474
  /**
68338
- * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
68475
+ * The type of the filter to replace
68339
68476
  */
68340
- sFilterType: FilterType | keyof typeof FilterType,
68477
+ sFilterType?: FilterType | keyof typeof FilterType,
68341
68478
  /**
68342
68479
  * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
68343
68480
  */
@@ -68488,9 +68625,10 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
68488
68625
  */
68489
68626
  sort(
68490
68627
  /**
68491
- * The Sorter or an Array of sap.ui.model.Sorter instances
68628
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.odata.v2.ODataModel#bindTree};
68629
+ * a falsy value is treated as an empty array and thus removes all sorters
68492
68630
  */
68493
- aSorters: Sorter[] | Sorter,
68631
+ aSorters?: Sorter[] | Sorter,
68494
68632
  /**
68495
68633
  * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
68496
68634
  */
@@ -69298,7 +69436,8 @@ declare module "sap/ui/model/odata/v4/Context" {
69298
69436
  * Returns `undefined` if the data is not (yet) available; no request is triggered. Use {@link #requestObject }
69299
69437
  * for asynchronous access.
69300
69438
  *
69301
- * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
69439
+ * The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in
69440
+ * an object if `sPath` is "").
69302
69441
  * See:
69303
69442
  * sap.ui.model.Context#getObject
69304
69443
  *
@@ -69316,7 +69455,7 @@ declare module "sap/ui/model/odata/v4/Context" {
69316
69455
  * Returns the parent node (in case of a recursive hierarchy; see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
69317
69456
  * or `undefined` if the parent of this node hasn't been read yet; it can then be requested via {@link #requestParent}.
69318
69457
  *
69319
- * @experimental (since 1.120.0)
69458
+ * @since 1.122.0
69320
69459
  *
69321
69460
  * @returns The parent node, or `null` if this node is a root node and thus has no parent, or `undefined`
69322
69461
  * if the parent node hasn't been read yet
@@ -69438,7 +69577,9 @@ declare module "sap/ui/model/odata/v4/Context" {
69438
69577
  */
69439
69578
  isKeepAlive(): boolean;
69440
69579
  /**
69441
- * Tells whether this context is currently selected, but not {@link #delete deleted} on the client.
69580
+ * Tells whether this context is currently selected, but not {@link #delete deleted} on the client. Since
69581
+ * 1.122.0 the selection state can also be accessed via instance annotation "@$ui5.context.isSelected" at
69582
+ * the entity. Note that the annotation does not take the deletion state into account.
69442
69583
  * See:
69443
69584
  * #setSelected
69444
69585
  *
@@ -69545,7 +69686,8 @@ declare module "sap/ui/model/odata/v4/Context" {
69545
69686
  * to the complete data the context points to (if `sPath` is "") or any part thereof. The data is a JSON
69546
69687
  * structure as described in "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.Context#setProperty}.
69547
69688
  *
69548
- * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
69689
+ * The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in
69690
+ * an object if `sPath` is "").
69549
69691
  *
69550
69692
  * In case of a {@link sap.ui.model.odata.v4.ODataContextBinding#getBoundContext context binding's bound context }
69551
69693
  * that hasn't requested its data yet, this method causes an initial back-end request using the binding's
@@ -69571,12 +69713,10 @@ declare module "sap/ui/model/odata/v4/Context" {
69571
69713
  ): Promise<any>;
69572
69714
  /**
69573
69715
  * Requests the parent node (in case of a recursive hierarchy; see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
69574
- *
69575
- * Note: **DO NOT** call {@link #setKeepAlive} on the resulting context!
69576
69716
  * See:
69577
69717
  * #getParent
69578
69718
  *
69579
- * @experimental (since 1.120.0)
69719
+ * @since 1.122.0
69580
69720
  *
69581
69721
  * @returns A promise which:
69582
69722
  * - Resolves if successful with either the parent node or `null` for a root node that has no parent
@@ -69594,7 +69734,7 @@ declare module "sap/ui/model/odata/v4/Context" {
69594
69734
  * @since 1.39.0
69595
69735
  *
69596
69736
  * @returns A promise on the requested value or values; it is rejected if a value is not primitive or if
69597
- * the context is a header context and a path is not "$count"
69737
+ * the context is a header context and a path is not "$count" or "@$ui5.context.isSelected"
69598
69738
  */
69599
69739
  requestProperty(
69600
69740
  /**
@@ -69762,7 +69902,9 @@ declare module "sap/ui/model/odata/v4/Context" {
69762
69902
  /**
69763
69903
  * Sets a new value for the property identified by the given path. The path is relative to this context
69764
69904
  * and is expected to point to a structural property with primitive type or, since 1.85.0, to an instance
69765
- * annotation.
69905
+ * annotation. Since 1.122.0 the client-side annotation "@$ui5.context.isSelected" can be given as a path.
69906
+ * Note: Writing to a client-side annotation never triggers a PATCH request, even if `sGroupId` is given.
69907
+ * Thus, reverting the value of this annotation cannot be done via {@link #resetChanges}.
69766
69908
  * See:
69767
69909
  * #getProperty
69768
69910
  * sap.ui.model.odata.v4.ODataContextBinding#event:patchSent
@@ -69791,8 +69933,8 @@ declare module "sap/ui/model/odata/v4/Context" {
69791
69933
  vValue: any,
69792
69934
  /**
69793
69935
  * The group ID to be used for the PATCH request; if not specified, the update group ID for the context's
69794
- * binding is used, see {@link #getUpdateGroupId}. Since 1.74.0, you can use `null` to prevent the PATCH
69795
- * request.
69936
+ * binding is used, see {@link #getUpdateGroupId}. When writing to a client-side annotation, `null` is used
69937
+ * automatically. Since 1.74.0, you can use `null` to prevent the PATCH request.
69796
69938
  */
69797
69939
  sGroupId?: string,
69798
69940
  /**
@@ -69812,9 +69954,11 @@ declare module "sap/ui/model/odata/v4/Context" {
69812
69954
  bRetry?: boolean
69813
69955
  ): Promise<void>;
69814
69956
  /**
69815
- * Determines whether this context is currently selected. If the preconditions of {@link #setKeepAlive }
69957
+ * Sets whether this context is currently selected. While a context is currently {@link #delete deleted }
69958
+ * on the client, it does not appear as {@link #isSelected selected}. If the preconditions of {@link #setKeepAlive }
69816
69959
  * hold, a best effort is made to implicitly keep a selected context alive in order to preserve the selection
69817
- * state. While a context is currently {@link #delete deleted} on the client, it does not appear as {@link #isSelected selected}.
69960
+ * state. Once the selection is no longer needed, for example because you perform an operation on this context
69961
+ * which logically removes it from its list, you need to reset the selection.
69818
69962
  *
69819
69963
  * **Note:** It is unsafe to keep a reference to a context instance which is not {@link #isKeepAlive kept alive}.
69820
69964
  * See:
@@ -70236,7 +70380,9 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
70236
70380
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
70237
70381
  * notifies the control that new data is available.
70238
70382
  *
70239
- * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
70383
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context},
70384
+ * as well as (since 1.122.0) for bindings with the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList }
70385
+ * and {@link sap.ui.model.odata.v4.ODataModel#bindContext})
70240
70386
  *
70241
70387
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
70242
70388
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -71017,7 +71163,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
71017
71163
  */
71018
71164
  getGroupId(): string;
71019
71165
  /**
71020
- * Returns the header context which allows binding to `$count`.
71166
+ * Returns the header context which allows binding to `$count` or `@$ui5.context.isSelected`.
71021
71167
  * See:
71022
71168
  * #getCount
71023
71169
  *
@@ -71174,7 +71320,9 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
71174
71320
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
71175
71321
  * notifies the control that new data is available.
71176
71322
  *
71177
- * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
71323
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context},
71324
+ * as well as (since 1.122.0) for bindings with the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList }
71325
+ * and {@link sap.ui.model.odata.v4.ODataModel#bindContext})
71178
71326
  *
71179
71327
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
71180
71328
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -72175,7 +72323,7 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
72175
72323
  * must refer to a function in `mParameters.scope` in case of a relative name starting with a dot, which
72176
72324
  * is stripped before lookup; see the `<template:alias>` instruction for XML Templating. In case of an
72177
72325
  * absolute name, it is searched in `mParameters.scope` first and then in the global namespace. (Using the
72178
- * global namespace is @deprecated as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
72326
+ * global namespace is deprecated as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
72179
72327
  * default to {@link #requestCurrencyCodes} and {@link #requestUnitsOfMeasure} resp. if not present in `mParameters.scope`.
72180
72328
  * This function is called with the current object (or primitive value) and additional details and returns
72181
72329
  * the result of this {@link #requestObject} call. The additional details are given as an object with the
@@ -73041,7 +73189,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
73041
73189
  }
73042
73190
  ): ODataPropertyBinding;
73043
73191
  /**
73044
- * Method not supported
73192
+ * Method not supported, use {@link #bindList} with `mParameters.$$aggregation` instead.
73045
73193
  * See:
73046
73194
  * sap.ui.model.Model#bindTree
73047
73195
  *
@@ -73830,7 +73978,9 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
73830
73978
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
73831
73979
  * notifies the control that new data is available.
73832
73980
  *
73833
- * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
73981
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context},
73982
+ * as well as (since 1.122.0) for bindings with the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList }
73983
+ * and {@link sap.ui.model.odata.v4.ODataModel#bindContext})
73834
73984
  *
73835
73985
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
73836
73986
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -73949,7 +74099,10 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
73949
74099
  * Sets the new current value and updates the cache. If the value cannot be accepted or cannot be updated
73950
74100
  * on the server, an error is logged to the console and added to the message manager as a technical message.
73951
74101
  * Unless preconditions fail synchronously, a {@link sap.ui.model.odata.v4.ODataModel#event:propertyChange 'propertyChange' }
73952
- * event is fired and provides a promise on the outcome of the asynchronous operation.
74102
+ * event is fired and provides a promise on the outcome of the asynchronous operation. Since 1.122.0 this
74103
+ * method allows updates to the client-side annotation "@$ui5.context.isSelected". Note: Changing the value
74104
+ * of a client-side annotation never triggers a PATCH request, no matter which `sGroupId` is given. Thus,
74105
+ * it cannot be reverted via {@link #resetChanges}.
73953
74106
  * See:
73954
74107
  * sap.ui.model.PropertyBinding#setValue
73955
74108
  *
@@ -73964,6 +74117,7 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
73964
74117
  * The group ID to be used for this update call; if not specified, the update group ID for this binding
73965
74118
  * (or its relevant parent binding) is used, see {@link #getUpdateGroupId}. Valid values are `undefined`,
73966
74119
  * '$auto', '$auto.*', '$direct' or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel}.
74120
+ * When writing to a client-side annotation, this parameter is ignored.
73967
74121
  */
73968
74122
  sGroupId?: string
73969
74123
  ): void;
@@ -75415,17 +75569,18 @@ declare module "sap/ui/model/TreeBinding" {
75415
75569
  */
75416
75570
  oContext?: object,
75417
75571
  /**
75418
- * Predefined filter or an array of filters (optional)
75572
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
75573
+ * to replace them
75419
75574
  */
75420
- aFilters?: Filter | Filter[],
75575
+ aFilters?: Filter[] | Filter,
75421
75576
  /**
75422
75577
  * Additional model specific parameters (optional)
75423
75578
  */
75424
75579
  mParameters?: string,
75425
75580
  /**
75426
- * Predefined sorter or an array of sorters (optional)
75581
+ * The sorters used initially; call {@link #sort} to replace them
75427
75582
  */
75428
- aSorters?: Sorter | Sorter[]
75583
+ aSorters?: Sorter[] | Sorter
75429
75584
  );
75430
75585
 
75431
75586
  /**
@@ -75502,13 +75657,15 @@ declare module "sap/ui/model/TreeBinding" {
75502
75657
  */
75503
75658
  filter(
75504
75659
  /**
75505
- * Single sap.ui.model.Filter object or an array of filter objects
75660
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
75661
+ * given in {@link sap.ui.model.Model#bindTree}; a falsy value is treated as an empty array and thus removes
75662
+ * all filters of the specified type
75506
75663
  */
75507
- aFilters: Filter | Filter[],
75664
+ aFilters?: Filter[] | Filter,
75508
75665
  /**
75509
- * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
75666
+ * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
75510
75667
  */
75511
- sFilterType: FilterType | keyof typeof FilterType
75668
+ sFilterType?: FilterType | keyof typeof FilterType
75512
75669
  ): void;
75513
75670
  /**
75514
75671
  * Returns the number of child nodes of a specific context
@@ -75588,9 +75745,10 @@ declare module "sap/ui/model/TreeBinding" {
75588
75745
  */
75589
75746
  sort(
75590
75747
  /**
75591
- * Array of sap.ui.model.Sorter objects
75748
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.Model#bindTree}; a falsy value
75749
+ * is treated as an empty array and thus removes all sorters
75592
75750
  */
75593
- aSorters: Sorter[]
75751
+ aSorters?: Sorter[]
75594
75752
  ): void;
75595
75753
  }
75596
75754
  }
@@ -77359,6 +77517,10 @@ declare module "sap/ui/model/xml/XMLTreeBinding" {
77359
77517
 
77360
77518
  import XMLModel from "sap/ui/model/xml/XMLModel";
77361
77519
 
77520
+ import Filter from "sap/ui/model/Filter";
77521
+
77522
+ import Sorter from "sap/ui/model/Sorter";
77523
+
77362
77524
  import Context from "sap/ui/model/Context";
77363
77525
 
77364
77526
  /**
@@ -77381,13 +77543,18 @@ declare module "sap/ui/model/xml/XMLTreeBinding" {
77381
77543
  */
77382
77544
  oContext?: object,
77383
77545
  /**
77384
- * Predefined filters contained in an array
77546
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
77547
+ * to replace them
77385
77548
  */
77386
- aFilters?: any[],
77549
+ aFilters?: Filter[] | Filter,
77387
77550
  /**
77388
77551
  * Additional model-specific parameters
77389
77552
  */
77390
- mParameters?: object
77553
+ mParameters?: object,
77554
+ /**
77555
+ * The sorters used initially; call {@link #sort} to replace them
77556
+ */
77557
+ aSorters?: Sorter[] | Sorter
77391
77558
  );
77392
77559
  /**
77393
77560
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -77402,13 +77569,18 @@ declare module "sap/ui/model/xml/XMLTreeBinding" {
77402
77569
  */
77403
77570
  oContext?: object,
77404
77571
  /**
77405
- * Predefined filters contained in an array
77572
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
77573
+ * to replace them
77406
77574
  */
77407
- aFilters?: any[],
77575
+ aFilters?: Filter[] | Filter,
77408
77576
  /**
77409
77577
  * Additional model-specific parameters
77410
77578
  */
77411
- mParameters?: object
77579
+ mParameters?: object,
77580
+ /**
77581
+ * The sorters used initially; call {@link #sort} to replace them
77582
+ */
77583
+ aSorters?: Sorter[] | Sorter
77412
77584
  );
77413
77585
 
77414
77586
  /**
@@ -83768,7 +83940,7 @@ declare namespace sap {
83768
83940
  */
83769
83941
  url?: string;
83770
83942
  /**
83771
- * Initial data of the Component (@see sap.ui.core.Component#getComponentData)
83943
+ * Initial data of the Component, see {@link sap.ui.core.Component#getComponentData}
83772
83944
  */
83773
83945
  componentData?: object;
83774
83946
  /**