@sapui5/ts-types-esm 1.130.1 → 1.131.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +3 -3
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +47 -9
  8. package/types/sap.f.d.ts +238 -12
  9. package/types/sap.fe.base.d.ts +24 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +10 -7
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +203 -145
  14. package/types/sap.fe.navigation.d.ts +3 -3
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +96 -9
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/{mobile-1.130.0-esm-d.ts → sap.m.d.ts} +355 -25
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +1 -1
  30. package/types/sap.suite.ui.commons.d.ts +1 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +143 -55
  37. package/types/{core-1.130.0-esm-d.ts → sap.ui.core.d.ts} +295 -300
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +6 -6
  40. package/types/sap.ui.fl.d.ts +1 -1
  41. package/types/sap.ui.generic.app.d.ts +2 -2
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +142 -2
  44. package/types/sap.ui.layout.d.ts +18 -21
  45. package/types/{mdc-1.130.0-esm-d.ts → sap.ui.mdc.d.ts} +220 -103
  46. package/types/sap.ui.richtexteditor.d.ts +1 -1
  47. package/types/sap.ui.rta.d.ts +1 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +7 -4
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +263 -9
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +28 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +7 -4
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +1 -1
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.130.0
282
+ // For Library Version: 1.131.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -6689,7 +6689,7 @@ declare module "sap/ui/test/OpaBuilder" {
6689
6689
  * the Opa5 instance to call {@link sap.ui.test.Opa5#waitFor} on
6690
6690
  */
6691
6691
  oOpaInstance?: Opa5
6692
- ): /* was: sap.ui.test.Opa5.Chain */ any;
6692
+ ): Opa5;
6693
6693
  /**
6694
6694
  * Sets the `fragmentId` parameter.
6695
6695
  *
@@ -14028,13 +14028,15 @@ declare module "sap/ui/core/library" {
14028
14028
  }
14029
14029
 
14030
14030
  /**
14031
- * Marker interface for controls that can be used as content of `sap.ui.layout.form.SemanticFormElement`.
14031
+ * Marker interface for controls that can be used as content of {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
14032
14032
  *
14033
14033
  * If the value-holding property of the control is not `valuetext`, the name of the value-holding
14034
- * property must be returned in the `getFormValueProperty` function.
14034
+ * property must be returned in the {@link sap.ui.core.ISemanticFormContent.getFormValueProperty getFormValueProperty }
14035
+ * function.
14035
14036
  *
14036
14037
  * If the value of the control needs some special output formatting (to show a description instead of a
14037
- * key), this formatted text needs to be returned in the `getFormFormattedValue` function.
14038
+ * key), this formatted text needs to be returned in the {@link sap.ui.core.ISemanticFormContent.getFormFormattedValue getFormFormattedValue }
14039
+ * function.
14038
14040
  *
14039
14041
  * @since 1.86.0
14040
14042
  */
@@ -14042,12 +14044,13 @@ declare module "sap/ui/core/library" {
14042
14044
  __implements__sap_ui_core_ISemanticFormContent: boolean;
14043
14045
 
14044
14046
  /**
14045
- * Returns the formatted value of a control used in a `SemanticFormElement`.
14047
+ * Returns the formatted value of a control used in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
14046
14048
  *
14047
- * In the `SemanticFormElement` element, the assigned fields are rendered in edit mode. In display mode,
14048
- * a text is rendered that concatenates the values of all assigned fields. In some cases the displayed text
14049
- * does not match the value of the field and needs some formatting. In other cases the control does not
14050
- * have a `value` property, so the `SemanticFormElement` element cannot determine the value.
14049
+ * In the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} element, the assigned fields
14050
+ * are rendered in edit mode. In display mode, a text is rendered that concatenates the values of all assigned
14051
+ * fields. In some cases the displayed text does not match the value of the field and needs some formatting.
14052
+ * In other cases the control does not have a `value` property, so the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement }
14053
+ * element cannot determine the value.
14051
14054
  *
14052
14055
  * This is an optional method. If not defined, the `value` property or the `text` property is used to determine
14053
14056
  * the value.
@@ -14058,15 +14061,16 @@ declare module "sap/ui/core/library" {
14058
14061
  */
14059
14062
  getFormFormattedValue?(): string | Promise<string>;
14060
14063
  /**
14061
- * Returns the names of the properties of a control that might update the rendering in a `SemanticFormElement`.
14064
+ * Returns the names of the properties of a control that might update the rendering in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
14062
14065
  *
14063
- * In the `SemanticFormElement` element, the assigned fields are rendered in edit mode. In display mode,
14064
- * depending on `getFormRenderAsControl`, either a text is rendered, which concatenates the values of all
14065
- * assigned fields, or the control is rendered. So if a property of the control changes that might lead
14066
- * to a different rendering (some controls have a special rendering in display mode), the `SemanticFormElement`
14066
+ * In the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} element, the assigned fields
14067
+ * are rendered in edit mode. In display mode, depending on {@link sap.ui.core.ISemanticFormContent.getFormRenderAsControl getFormRenderAsControl},
14068
+ * either a text is rendered, which concatenates the values of all assigned fields, or the control is rendered.
14069
+ * So if a property of the control changes that might lead to a different rendering (some controls have
14070
+ * a special rendering in display mode), the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement }
14067
14071
  * needs to check the rendering.
14068
14072
  *
14069
- * This is an optional method. If not defined, no check for updates (only for property defined in `getFormValueProperty`)
14073
+ * This is an optional method. If not defined, no check for updates (only for property defined in {@link sap.ui.core.ISemanticFormContent.getFormValueProperty getFormValueProperty})
14070
14074
  * is done once the control has been assigned.
14071
14075
  *
14072
14076
  * @since 1.117.0
@@ -14075,8 +14079,8 @@ declare module "sap/ui/core/library" {
14075
14079
  */
14076
14080
  getFormObservingProperties?(): string[];
14077
14081
  /**
14078
- * If set to `true`, the `SemanticFormElement` also renders the control in display mode, if the used `FormLayout`
14079
- * supports this.
14082
+ * If set to `true`, the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} also renders
14083
+ * the control in display mode, if the used {@link sap.ui.layout.form.FormLayout FormLayout} supports this.
14080
14084
  *
14081
14085
  * This is an optional method. If not defined, just the text is rendered.
14082
14086
  *
@@ -14086,12 +14090,13 @@ declare module "sap/ui/core/library" {
14086
14090
  */
14087
14091
  getFormRenderAsControl?(): string;
14088
14092
  /**
14089
- * Returns the name of the value-holding property of a control used in a `SemanticFormElement`.
14093
+ * Returns the name of the value-holding property of a control used in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
14090
14094
  *
14091
- * In the `SemanticFormElement` element, the assigned fields are rendered in edit mode. In display mode,
14092
- * a text is rendered that concatenates the values of all assigned fields. So the concatenated text needs
14093
- * to be updated if the value of a control changes. If a control does not have a `value` property, the `SemanticFormElement`
14094
- * element needs to know the propery it has to listen for changes.
14095
+ * In the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement} element, the assigned fields
14096
+ * are rendered in edit mode. In display mode, a text is rendered that concatenates the values of all assigned
14097
+ * fields. So the concatenated text needs to be updated if the value of a control changes. If a control
14098
+ * does not have a `value` property, the {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement }
14099
+ * element needs to know the property it has to listen to for changes.
14095
14100
  *
14096
14101
  * This is an optional method. If not defined, the `value` property or the `text` property is used to determine
14097
14102
  * the value.
@@ -21385,7 +21390,7 @@ declare module "sap/ui/core/date/CalendarWeekNumbering" {
21385
21390
  * - the first week of the year.
21386
21391
  *
21387
21392
  * @since 1.108.0
21388
- * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarWeekNumbering} instead.
21393
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/date/CalendarWeekNumbering} instead.
21389
21394
  */
21390
21395
  enum CalendarWeekNumbering {
21391
21396
  /**
@@ -24123,6 +24128,27 @@ declare module "sap/ui/core/Element" {
24123
24128
  */
24124
24129
  FNMetaImpl?: Function
24125
24130
  ): Function;
24131
+ /**
24132
+ * Fires a "focusfail" event to handle focus redirection when the current element loses focus due to a state
24133
+ * change (e.g., disabled, invisible, or destroyed). The event is propagated to the parent of the current
24134
+ * element to manage the focus shift.
24135
+ *
24136
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
24137
+ */
24138
+ static fireFocusFail(
24139
+ /**
24140
+ * The mode of focus handling, determining whether the focus should be handled sync or async.
24141
+ */
24142
+ sFocusHandlingMode: string,
24143
+ /**
24144
+ * The parent element that will handle the "focusfail" event.
24145
+ */
24146
+ oParent: UI5Element,
24147
+ /**
24148
+ * Optional DOM area to be skipped during focus redirection.
24149
+ */
24150
+ oSkipArea?: HTMLElement
24151
+ ): void;
24126
24152
  /**
24127
24153
  * Returns the element currently in focus.
24128
24154
  *
@@ -24420,6 +24446,25 @@ declare module "sap/ui/core/Element" {
24420
24446
  */
24421
24447
  bSuppressInvalidate?: boolean
24422
24448
  ): void;
24449
+ /**
24450
+ * Destroys all child elements of a specified aggregation and handles focus management for elements that
24451
+ * are currently focused. If the currently focused element belongs to the aggregation being destroyed, a
24452
+ * "focusfail" event is triggered to shift the focus to a relevant element.
24453
+ *
24454
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
24455
+ *
24456
+ * @returns Returns `this` to allow method chaining
24457
+ */
24458
+ destroyAggregation(
24459
+ /**
24460
+ * The name of the aggregation
24461
+ */
24462
+ sAggregationName: string,
24463
+ /**
24464
+ * If true, this ManagedObject is not marked as changed
24465
+ */
24466
+ bSuppressInvalidate?: boolean
24467
+ ): this;
24423
24468
  /**
24424
24469
  * Destroys all the customData in the aggregation {@link #getCustomData customData}.
24425
24470
  *
@@ -24859,8 +24904,8 @@ declare module "sap/ui/core/Element" {
24859
24904
  isFocusable(): boolean;
24860
24905
  /**
24861
24906
  * Handles the 'focusfail' event by attempting to find and focus on a tabbable element. The 'focusfail'
24862
- * event is triggered when the current element, which initially holds the focus, becomes disabled or invisible.
24863
- * The event is received by the parent of the element that failed to retain the focus.
24907
+ * event is triggered when the current element, which initially holds the focus, becomes disabled, invisible,
24908
+ * or destroyed. The event is received by the parent of the element that failed to retain the focus.
24864
24909
  *
24865
24910
  * @ui5-protected Do not call from applications (only from related classes in the framework)
24866
24911
  */
@@ -24890,6 +24935,50 @@ declare module "sap/ui/core/Element" {
24890
24935
  */
24891
24936
  oValue?: any
24892
24937
  ): any | this;
24938
+ /**
24939
+ * Removes an object from the aggregation named `sAggregationName` with cardinality 0..n and manages focus
24940
+ * handling in case the removed object was focused. If the removed object held the focus, a "focusfail"
24941
+ * event is triggered to proper focus redirection.
24942
+ *
24943
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
24944
+ *
24945
+ * @returns the removed object or `null`
24946
+ */
24947
+ removeAggregation(
24948
+ /**
24949
+ * the string identifying the aggregation that the given object should be removed from
24950
+ */
24951
+ sAggregationName: string,
24952
+ /**
24953
+ * the position or ID of the ManagedObject that should be removed or that ManagedObject itself; if `vObject`
24954
+ * is invalid, a negative value or a value greater or equal than the current size of the aggregation, nothing
24955
+ * is removed.
24956
+ */
24957
+ vObject: int | string | ManagedObject,
24958
+ /**
24959
+ * if true, this ManagedObject is not marked as changed
24960
+ */
24961
+ bSuppressInvalidate?: boolean
24962
+ ): ManagedObject | null;
24963
+ /**
24964
+ * Removes all child elements of a specified aggregation and handles focus management for elements that
24965
+ * are currently focused. If the currently focused element belongs to the aggregation being removed, a "focusfail"
24966
+ * event is triggered to shift the focus to a relevant element.
24967
+ *
24968
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
24969
+ *
24970
+ * @returns An array of the removed elements (might be empty)
24971
+ */
24972
+ removeAllAggregation(
24973
+ /**
24974
+ * The name of the aggregation
24975
+ */
24976
+ sAggregationName: string,
24977
+ /**
24978
+ * If true, this ManagedObject is not marked as changed
24979
+ */
24980
+ bSuppressInvalidate?: boolean
24981
+ ): ManagedObject[];
24893
24982
  /**
24894
24983
  * Removes all the controls from the aggregation {@link #getCustomData customData}.
24895
24984
  *
@@ -24988,6 +25077,29 @@ declare module "sap/ui/core/Element" {
24988
25077
  * @ui5-protected Do not call from applications (only from related classes in the framework)
24989
25078
  */
24990
25079
  rerender(): void;
25080
+ /**
25081
+ * Sets a new object in the named 0..1 aggregation of this ManagedObject and marks this ManagedObject as
25082
+ * changed. Manages the focus handling if the current aggregation is removed (i.e., when the object is set
25083
+ * to `null`). If the previous object in the aggregation was focused, a "focusfail" event is triggered.
25084
+ *
25085
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
25086
+ *
25087
+ * @returns Returns `this` to allow method chaining
25088
+ */
25089
+ setAggregation(
25090
+ /**
25091
+ * name of an 0..1 aggregation
25092
+ */
25093
+ sAggregationName: string,
25094
+ /**
25095
+ * the managed object that is set as aggregated object
25096
+ */
25097
+ oObject: ManagedObject,
25098
+ /**
25099
+ * if true, this ManagedObject is not marked as changed
25100
+ */
25101
+ bSuppressInvalidate?: boolean
25102
+ ): this;
24991
25103
  /**
24992
25104
  * Sets the associated {@link #getFieldHelpDisplay fieldHelpDisplay}.
24993
25105
  *
@@ -26811,7 +26923,11 @@ declare module "sap/ui/core/format/NumberFormat" {
26811
26923
  */
26812
26924
  plusSign?: string;
26813
26925
  /**
26814
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
26926
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
26927
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
26928
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
26929
+ * **Example:** With a `precision` of 2, `234.567` is formatted to `235`. **Note:** The formatted output
26930
+ * may differ depending on locale.
26815
26931
  */
26816
26932
  precision?: int;
26817
26933
  /**
@@ -26966,7 +27082,12 @@ declare module "sap/ui/core/format/NumberFormat" {
26966
27082
  */
26967
27083
  plusSign?: string;
26968
27084
  /**
26969
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
27085
+ * **Note:** Only considered if the number format leads to a representation with decimal places, e.g. if
27086
+ * the option `style: "short"` is set. The maximum number of digits in the formatted representation of a
27087
+ * number; if the `precision` is less than the overall length of the number, its fractional part is truncated
27088
+ * through rounding. As the `precision` only affects the rounding of a number, its integer part can retain
27089
+ * more digits than defined by this parameter. **Example:** With a `precision` of 2 and `style: "short"`,
27090
+ * `234567` is formatted to `"235K"`. **Note:** The formatted output may differ depending on locale.
26970
27091
  */
26971
27092
  precision?: int;
26972
27093
  /**
@@ -27119,7 +27240,11 @@ declare module "sap/ui/core/format/NumberFormat" {
27119
27240
  */
27120
27241
  plusSign?: string;
27121
27242
  /**
27122
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
27243
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
27244
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
27245
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
27246
+ * **Example:** With a `precision` of 2, `234.567` is formatted to `"23,457%"`. **Note:** The formatted
27247
+ * output may differ depending on locale.
27123
27248
  */
27124
27249
  precision?: int;
27125
27250
  /**
@@ -27271,7 +27396,11 @@ declare module "sap/ui/core/format/NumberFormat" {
27271
27396
  */
27272
27397
  plusSign?: string;
27273
27398
  /**
27274
- * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
27399
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
27400
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
27401
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
27402
+ * **Example:** With a `precision` of 2, the parameters `"234.567", "mass-kilogram"` are formatted to `"235
27403
+ * kg"`. **Note:** The formatted output may differ depending on locale.
27275
27404
  */
27276
27405
  precision?: int;
27277
27406
  /**
@@ -31149,6 +31278,8 @@ declare module "sap/ui/core/LocaleData" {
31149
31278
 
31150
31279
  import Locale from "sap/ui/core/Locale";
31151
31280
 
31281
+ import LanguageTag from "sap/base/i18n/LanguageTag";
31282
+
31152
31283
  import Metadata from "sap/ui/base/Metadata";
31153
31284
 
31154
31285
  /**
@@ -31196,7 +31327,7 @@ declare module "sap/ui/core/LocaleData" {
31196
31327
  /**
31197
31328
  * The locale or language tag
31198
31329
  */
31199
- vLocale: Locale | /* was: sap.base.i18n.LanguageTag */ any
31330
+ vLocale: Locale | LanguageTag
31200
31331
  ): LocaleData;
31201
31332
  /**
31202
31333
  * Returns a metadata object for class sap.ui.core.LocaleData.
@@ -50887,10 +51018,10 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
50887
51018
  */
50888
51019
  oContext: Context,
50889
51020
  /**
50890
- * Parameters, specifying the aggregation level for which contexts shall be fetched or (legacy signature
50891
- * variant) index of first child entry to return from the parent context (zero-based)
51021
+ * Parameters, specifying the aggregation level for which contexts shall be fetched or the index of the
51022
+ * first child entry to return from the parent contexts
50892
51023
  */
50893
- mParameters:
51024
+ mParameters?:
50894
51025
  | {
50895
51026
  /**
50896
51027
  * Level number for oContext, because it might occur at multiple levels; context with group ID `"/"` has
@@ -51002,7 +51133,7 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
51002
51133
  * value can be set to define the parameter `startIndex` as described in this parameter list. In this case,
51003
51134
  * the function parameters `iLength`, `iNumberOfExpandedLevels` and `iThreshold` become mandatory.
51004
51135
  */
51005
- mParameters:
51136
+ mParameters?:
51006
51137
  | {
51007
51138
  /**
51008
51139
  * Number of entries to return at and after the given start index; defaults to the model's size limit, see
@@ -54602,11 +54733,11 @@ declare module "sap/ui/model/ClientTreeBinding" {
54602
54733
  */
54603
54734
  getCount(): number | undefined;
54604
54735
  /**
54605
- * Return node contexts for the tree
54736
+ * Return node contexts for the tree.
54606
54737
  *
54607
54738
  * @ui5-protected Do not call from applications (only from related classes in the framework)
54608
54739
  *
54609
- * @returns the contexts array
54740
+ * @returns the context's array
54610
54741
  */
54611
54742
  getNodeContexts(
54612
54743
  /**
@@ -54614,42 +54745,44 @@ declare module "sap/ui/model/ClientTreeBinding" {
54614
54745
  */
54615
54746
  oContext: Context,
54616
54747
  /**
54617
- * the startIndex where to start the retrieval of contexts
54748
+ * the index from which to start the retrieval of contexts
54618
54749
  */
54619
- iStartIndex: int,
54750
+ iStartIndex?: int,
54620
54751
  /**
54621
- * determines how many contexts to retrieve beginning from the start index.
54752
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
54753
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
54622
54754
  */
54623
- iLength: int
54755
+ iLength?: int
54624
54756
  ): Context[];
54625
54757
  /**
54626
- * Return root contexts for the tree
54758
+ * Return root contexts for the tree.
54627
54759
  *
54628
54760
  * @ui5-protected Do not call from applications (only from related classes in the framework)
54629
54761
  *
54630
- * @returns the contexts array
54762
+ * @returns the context's array
54631
54763
  */
54632
54764
  getRootContexts(
54633
54765
  /**
54634
- * the startIndex where to start the retrieval of contexts
54766
+ * the index from which to start the retrieval of contexts
54635
54767
  */
54636
- iStartIndex: int,
54768
+ iStartIndex?: int,
54637
54769
  /**
54638
- * determines how many contexts to retrieve beginning from the start index.
54770
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
54771
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
54639
54772
  */
54640
- iLength: int
54641
- ): object[];
54773
+ iLength?: int
54774
+ ): Context[];
54642
54775
  /**
54643
54776
  * Returns if the node has child nodes.
54644
54777
  *
54645
54778
  *
54646
- * @returns true if node has children
54779
+ * @returns `true` if the node has children
54647
54780
  */
54648
54781
  hasChildren(
54649
54782
  /**
54650
54783
  * the context element of the node
54651
54784
  */
54652
- oContext: object
54785
+ oContext: Context
54653
54786
  ): boolean;
54654
54787
  /**
54655
54788
  * Sorts the contexts of this ClientTreeBinding. The tree will be sorted level by level. So the nodes are
@@ -55846,7 +55979,8 @@ declare module "sap/ui/model/Filter" {
55846
55979
  */
55847
55980
  constructor(
55848
55981
  /**
55849
- * Filter info object or a path or an array of filters
55982
+ * Filter info object or a path or an array of filters; if a filter info object is given, the other constructor
55983
+ * parameters are ignored
55850
55984
  */
55851
55985
  vFilterInfo:
55852
55986
  | {
@@ -67180,7 +67314,10 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
67180
67314
  *
67181
67315
  * @ui5-protected Do not call from applications (only from related classes in the framework)
67182
67316
  *
67183
- * @returns The array of already available contexts with the first entry containing the context for `iStartIndex`
67317
+ * @returns The array of already available contexts with the first entry containing the context for `iStartIndex`.
67318
+ * Since 1.131.0, the array has an additional property `bExpectMore`, which is `true` if the response is
67319
+ * not complete, a {@link #event:change 'change'} event will follow, and a busy indicator should be switched
67320
+ * on.
67184
67321
  */
67185
67322
  getContexts(
67186
67323
  /**
@@ -73926,6 +74063,43 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73926
74063
  ODataListBinding$SelectionChangedEventParameters,
73927
74064
  ODataListBinding
73928
74065
  >;
74066
+
74067
+ /**
74068
+ * Parameters of the ODataListBinding#separateReceived event.
74069
+ *
74070
+ * @experimental (since 1.131.0)
74071
+ */
74072
+ export interface ODataListBinding$SeparateReceivedEventParameters {
74073
+ /**
74074
+ * The requested property name
74075
+ */
74076
+ property?: string;
74077
+
74078
+ /**
74079
+ * The start index of the requested range
74080
+ */
74081
+ start?: number;
74082
+
74083
+ /**
74084
+ * The length of the requested range
74085
+ */
74086
+ length?: number;
74087
+
74088
+ /**
74089
+ * A UI5 message of type {@link module:sap/ui/core/message/MessageType MessageType.Error}
74090
+ */
74091
+ errorMessage?: Message;
74092
+ }
74093
+
74094
+ /**
74095
+ * Event object of the ODataListBinding#separateReceived event.
74096
+ *
74097
+ * @experimental (since 1.131.0)
74098
+ */
74099
+ export type ODataListBinding$SeparateReceivedEvent = Event<
74100
+ ODataListBinding$SeparateReceivedEventParameters,
74101
+ ODataListBinding
74102
+ >;
73929
74103
  }
73930
74104
 
73931
74105
  declare module "sap/ui/model/odata/v4/ODataMetaModel" {
@@ -77516,21 +77690,41 @@ declare module "sap/ui/model/Sorter" {
77516
77690
  */
77517
77691
  constructor(
77518
77692
  /**
77519
- * the binding path used for sorting
77693
+ * The binding path used for sorting or the sorter info object; if a sorter info object is given, the other
77694
+ * constructor parameters are ignored
77520
77695
  */
77521
- sPath: string,
77696
+ vSorterInfo:
77697
+ | string
77698
+ | {
77699
+ /**
77700
+ * See `fnComparator` parameter
77701
+ */
77702
+ comparator?: Function;
77703
+ /**
77704
+ * See `bDescending` parameter
77705
+ */
77706
+ descending?: boolean;
77707
+ /**
77708
+ * See `vGroup` parameter
77709
+ */
77710
+ group?: boolean | Function;
77711
+ /**
77712
+ * The binding path for this sorter
77713
+ */
77714
+ path?: string;
77715
+ },
77522
77716
  /**
77523
- * whether the sort order should be descending
77717
+ * Whether the sort order is descending
77524
77718
  */
77525
77719
  bDescending?: boolean,
77526
77720
  /**
77527
- * configure grouping of the content, can either be true to enable grouping based on the raw model property
77528
- * value, or a function which calculates the group value out of the context (e.g. oContext.getProperty("date").getYear()
77529
- * for year grouping). The control needs to implement the grouping behaviour for the aggregation which you
77530
- * want to group. In case a function is provided it must either return a primitive type value as the group
77531
- * key or an object containing a "key" property and additional properties needed for group visualization.
77532
- * This object or the object with the primitive type return value as "key" property is passed to the `groupHeaderFactory`
77533
- * function that has been specified to create the group header for the control aggregation; see {@link sap.ui.base.ManagedObject#bindAggregation}.
77721
+ * Configure grouping of the content, can either be `true` to enable grouping based on the raw model property
77722
+ * value, or a function which calculates the group value out of the context (e.g. `oContext.getProperty("date").getYear()`
77723
+ * for year grouping). The control needs to implement the grouping behaviour. In case a function is provided
77724
+ * it must either return a primitive type value as the group key or an object containing a "key" property
77725
+ * and additional properties needed for group visualization. This object or the object with the primitive
77726
+ * type return value as "key" property is passed to the `groupHeaderFactory` function that has been specified
77727
+ * to create the group header for the control aggregation; see {@link sap.ui.base.ManagedObject#bindAggregation}.
77534
77728
  * **Note:** Grouping via `vGroup=true` is only possible (and only makes sense) for the primary sort property.
77535
77729
  * A more complicated grouping is possible by providing a grouping function. The sort order needs to fit
77536
77730
  * to the grouping also in this case. See also {@link https://ui5.sap.com/#/topic/ec79a5d5918f4f7f9cbc2150e66778cc Sorting, Grouping, and Filtering for List Binding}.
@@ -77538,7 +77732,7 @@ declare module "sap/ui/model/Sorter" {
77538
77732
  vGroup?: boolean | Function,
77539
77733
  /**
77540
77734
  * A custom comparator function, which is used for client-side sorting instead of the default comparator
77541
- * method. Information about parameters and expected return values of such a method can be found in the
77735
+ * method; information about parameters and expected return values of such a method can be found in the
77542
77736
  * {@link #.defaultComparator default comparator} documentation. **Note:** Custom comparator functions are
77543
77737
  * meant to be used on the client. Models that implement sorting in the backend usually don't support custom
77544
77738
  * comparator functions. Consult the documentation of the specific model implementation.
@@ -77623,6 +77817,22 @@ declare module "sap/ui/model/Sorter" {
77623
77817
  * @returns The group function
77624
77818
  */
77625
77819
  getGroupFunction(): Function;
77820
+ /**
77821
+ * Returns the binding path for this sorter; see the path parameter of {@link sap.ui.model.Sorter#constructor}.
77822
+ *
77823
+ * @since 1.131.0
77824
+ *
77825
+ * @returns The binding path
77826
+ */
77827
+ getPath(): string;
77828
+ /**
77829
+ * Whether to sort in descending order; see the descending parameter of {@link sap.ui.model.Sorter#constructor}.
77830
+ *
77831
+ * @since 1.131.0
77832
+ *
77833
+ * @returns Whether to sort in descending order
77834
+ */
77835
+ isDescending(): boolean;
77626
77836
  }
77627
77837
  }
77628
77838
 
@@ -77710,6 +77920,8 @@ declare module "sap/ui/model/TreeBinding" {
77710
77920
 
77711
77921
  import Model from "sap/ui/model/Model";
77712
77922
 
77923
+ import Context from "sap/ui/model/Context";
77924
+
77713
77925
  import Filter from "sap/ui/model/Filter";
77714
77926
 
77715
77927
  import Sorter from "sap/ui/model/Sorter";
@@ -77718,8 +77930,6 @@ declare module "sap/ui/model/TreeBinding" {
77718
77930
 
77719
77931
  import Metadata from "sap/ui/base/Metadata";
77720
77932
 
77721
- import Context from "sap/ui/model/Context";
77722
-
77723
77933
  /**
77724
77934
  * The TreeBinding is a specific binding for trees in the model, which can be used to populate Trees.
77725
77935
  */
@@ -77743,7 +77953,7 @@ declare module "sap/ui/model/TreeBinding" {
77743
77953
  /**
77744
77954
  * Context object for this binding (optional)
77745
77955
  */
77746
- oContext?: object,
77956
+ oContext?: Context,
77747
77957
  /**
77748
77958
  * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
77749
77959
  * to replace them
@@ -77752,7 +77962,7 @@ declare module "sap/ui/model/TreeBinding" {
77752
77962
  /**
77753
77963
  * Additional model specific parameters (optional)
77754
77964
  */
77755
- mParameters?: string,
77965
+ mParameters?: object,
77756
77966
  /**
77757
77967
  * The sorters used initially; call {@link #sort} to replace them
77758
77968
  */
@@ -77844,7 +78054,7 @@ declare module "sap/ui/model/TreeBinding" {
77844
78054
  sFilterType?: FilterType | keyof typeof FilterType
77845
78055
  ): void;
77846
78056
  /**
77847
- * Returns the number of child nodes of a specific context
78057
+ * Returns the number of child nodes of a specific context.
77848
78058
  *
77849
78059
  *
77850
78060
  * @returns the number of children
@@ -77853,7 +78063,7 @@ declare module "sap/ui/model/TreeBinding" {
77853
78063
  /**
77854
78064
  * the context element of the node
77855
78065
  */
77856
- oContext: Object
78066
+ oContext: Context
77857
78067
  ): int;
77858
78068
  /**
77859
78069
  * Returns the count of entries in the tree, or `undefined` if it is unknown. If the tree is filtered, the
@@ -77869,7 +78079,7 @@ declare module "sap/ui/model/TreeBinding" {
77869
78079
  */
77870
78080
  getCount(): number | undefined;
77871
78081
  /**
77872
- * Returns the current value of the bound target
78082
+ * Returns the current value of the bound target.
77873
78083
  *
77874
78084
  *
77875
78085
  * @returns the array of child contexts for the given node
@@ -77880,41 +78090,43 @@ declare module "sap/ui/model/TreeBinding" {
77880
78090
  */
77881
78091
  oContext: Context,
77882
78092
  /**
77883
- * the startIndex where to start the retrieval of contexts
78093
+ * the index from which to start the retrieval of contexts
77884
78094
  */
77885
- iStartIndex: int,
78095
+ iStartIndex?: int,
77886
78096
  /**
77887
- * determines how many contexts to retrieve beginning from the start index.
78097
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
78098
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
77888
78099
  */
77889
- iLength: int
78100
+ iLength?: int
77890
78101
  ): Context[];
77891
78102
  /**
77892
- * Returns the current value of the bound target
78103
+ * Returns the current value of the bound target.
77893
78104
  *
77894
78105
  *
77895
78106
  * @returns the array of child contexts for the root node
77896
78107
  */
77897
78108
  getRootContexts(
77898
78109
  /**
77899
- * the startIndex where to start the retrieval of contexts
78110
+ * the index from which to start the retrieval of contexts
77900
78111
  */
77901
- iStartIndex: int,
78112
+ iStartIndex?: int,
77902
78113
  /**
77903
- * determines how many contexts to retrieve beginning from the start index.
78114
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
78115
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
77904
78116
  */
77905
- iLength: int
77906
- ): any[];
78117
+ iLength?: int
78118
+ ): Context[];
77907
78119
  /**
77908
- * Returns if the node has child nodes
78120
+ * Returns `true` if the node has child nodes.
77909
78121
  *
77910
78122
  *
77911
- * @returns true if node has children
78123
+ * @returns `true` if the node has children
77912
78124
  */
77913
78125
  hasChildren(
77914
78126
  /**
77915
78127
  * the context element of the node
77916
78128
  */
77917
- oContext: Object
78129
+ oContext: Context
77918
78130
  ): boolean;
77919
78131
  /**
77920
78132
  * Sorts the tree according to the sorter definitions.
@@ -87135,223 +87347,6 @@ declare namespace sap {
87135
87347
  controller?: import("sap/ui/core/mvc/Controller").default;
87136
87348
  }
87137
87349
  ): import("sap/ui/core/mvc/XMLView").default;
87138
- /**
87139
- * Provides access to UI5 loader configuration.
87140
- *
87141
- * The configuration is used by {@link sap.ui.require} and {@link sap.ui.define}.
87142
- */
87143
- namespace loader {
87144
- /**
87145
- * Sets the configuration for the UI5 loader. The configuration can be updated multiple times. Later changes
87146
- * do not impact modules that have been loaded before.
87147
- *
87148
- * If no parameter is given, a partial copy of UI5 loader configuration in use is returned.
87149
- *
87150
- * The configuration options are aligned with the "Common Config" draft of the AMD spec (https://github.com/amdjs/amdjs-api/blob/master/CommonConfig.md).
87151
- *
87152
- * The following code shows an example of what a UI5 loader configuration might look like:
87153
- * ```javascript
87154
- *
87155
- *
87156
- * sap.ui.loader.config({
87157
- *
87158
- * // location from where to load all modules by default
87159
- * baseUrl: '../../resources/',
87160
- *
87161
- * paths: {
87162
- * // load modules whose ID equals to or starts with 'my/module' from example.com
87163
- * 'my/module': 'https://example.com/resources/my/module'
87164
- * },
87165
- *
87166
- * map: {
87167
- * // if any module requires 'sinon', load module 'sap/ui/thirdparty/sinon-4'
87168
- * '*': {
87169
- * 'sinon': 'sap/ui/thirdparty/sinon-4'
87170
- * },
87171
- * // but if a module whose ID equals to or starts with 'app' requires 'sinon'
87172
- * // then load a legacy version instead
87173
- * "app": {
87174
- * 'sinon': 'sap/ui/legacy/sinon'
87175
- * }
87176
- * },
87177
- *
87178
- * // define two bundles that consists of JS modules only
87179
- * bundles: {
87180
- * bundle1: ['module1', 'module2'],
87181
- * bundle2: ['moduleX', 'moduleY']
87182
- * },
87183
- *
87184
- * // define a bundle that also contains non-JS resources
87185
- * bundlesUI5: {
87186
- * 'all.js': ['Component.js', 'manifest.json',
87187
- * 'App.controller.js', 'App.view.xml']
87188
- * },
87189
- *
87190
- * // activate real async loading and module definitions
87191
- * async: true,
87192
- *
87193
- * // provide dependency and export metadata for non-UI5 modules
87194
- * shim: {
87195
- * 'sap/ui/thirdparty/blanket': {
87196
- * amd: true,
87197
- * exports: 'blanket'
87198
- * }
87199
- * }
87200
- *
87201
- * });
87202
- *
87203
- * ```
87204
- *
87205
- *
87206
- * @since 1.56.0
87207
- *
87208
- * @returns UI5 loader configuration in use.
87209
- */
87210
- function config(
87211
- /**
87212
- * The provided configuration gets merged with the UI5 loader configuration in use. If `cfg` is omitted
87213
- * or `undefined`, a copy of the current configuration gets returned, containing at least the properties
87214
- * `amd` and `async`.
87215
- */
87216
- cfg?: {
87217
- /**
87218
- * Default location to load modules from. If none of the configured `paths` prefixes matches a module ID,
87219
- * the module will be loaded from the concatenation of the `baseUrl` and the module ID.
87220
- *
87221
- * If the `baseUrl` itself is a relative URL, it is evaluated relative to `document.baseURI`.
87222
- */
87223
- baseUrl?: string;
87224
- /**
87225
- * A map of resource locations keyed by a corresponding module ID prefix. When a module is to be loaded,
87226
- * the longest key in `paths` is searched that is a prefix of the module ID. The module will be loaded from
87227
- * the concatenation of the corresponding value in `paths` and the remainder of the module ID (after the
87228
- * prefix). If no entry in `paths` matches, then the module will be loaded from the `baseUrl`.
87229
- *
87230
- * The prefixes (keys) must not contain relative segments (./ or ../), a trailing slash will be removed,
87231
- * and only full name segment matches are considered a match (prefix 'sap/m' does not match a module ID
87232
- * 'sap/main').
87233
- *
87234
- * **Note**: In contrast to the "Common Config" of the AMD spec, the paths (values in the map) are interpreted
87235
- * relative to `document.baseURI`, not relative to `cfg.baseUrl`.
87236
- */
87237
- paths?: Record<string, string>;
87238
- /**
87239
- * A map of maps that defines how to map module IDs to other module IDs (inner maps) in the context of a
87240
- * specific set of modules (keys of outer map).
87241
- *
87242
- * Each key of the outer map represents a module ID prefix that describes the context for which its value
87243
- * (inner map) has to be used. The special key `*` describes the default context which applies for any module.
87244
- * Only the most specific matching context will be taken into account.
87245
- *
87246
- * Each inner map maps a module ID or module ID prefix to another module ID or module ID prefix. Again,
87247
- * only the most specific match is taken into account and only one mapping is evaluated (the evaluation
87248
- * of the mappings is not done recursively).
87249
- *
87250
- * Matches are always complete matches, a prefix 'a/b/c' does not match the module ID 'a/b/com'.
87251
- */
87252
- map?: Record<string, Record<string, string>>;
87253
- /**
87254
- * Defines additional metadata for modules for which the normal behavior of the AMD APIs is not sufficient.
87255
- *
87256
- * A typical example are scripts that don't use `define` or `sap.ui.define`, but export to a global name.
87257
- * With the `exports` property, one or more export names can be specified, and the loader can retrieve the
87258
- * exported value after executing the corresponding module. If such a module has dependencies, they can
87259
- * be specified in the `deps` array and are loaded and executed before executing the module.
87260
- *
87261
- * The `amd` flag of a shim is a ui5loader-specific extension of the standard AMD shims. If set, the ui5loader
87262
- * hides a currently active AMD loader before executing the module and restores it afterwards. Otherwise,
87263
- * it might miss the export of third party modules that check for an AMD loader and register with it instead
87264
- * of exporting to a global name. A future version of the ui5loader might ignore this flag when it acts
87265
- * as an AMD loader by itself.
87266
- *
87267
- * **Note:** The ui5loader does not support the `init` option described by the "Common Config" section of
87268
- * the AMD spec.
87269
- */
87270
- shim?: Record<
87271
- string,
87272
- {
87273
- amd: boolean;
87274
-
87275
- deps: string[];
87276
-
87277
- exports: string | string[];
87278
- }
87279
- >;
87280
- /**
87281
- * A map of arrays that each define the modules contained in a bundle.
87282
- *
87283
- * Each key of the map represents the module ID of a bundle file. The array value represents the set of
87284
- * JavaScript modules (their module IDs) that are contained in the bundle.
87285
- *
87286
- * When a module is required that has not been loaded yet, and for which a containing bundle is known, that
87287
- * bundle will be required first. Only then the original module will be required again and usually be taken
87288
- * from the just loaded bundle.
87289
- *
87290
- * A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
87291
- * for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
87292
- * loaded synchronously to fulfill API contracts.
87293
- *
87294
- * **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
87295
- * of multiple bundles, only the last one will be taken into account.
87296
- *
87297
- * This configuration option is basically provided to be compatible with requireJS or SystemJS configuration.
87298
- */
87299
- bundles?: Record<string, string[]>;
87300
- /**
87301
- * A map of arrays that each define the resources contained in a bundle.
87302
- *
87303
- * This is similar to `bundles`, but all strings are unified resource names including a file type extension,
87304
- * not only module IDs. This allows to represent more than just JavaScript modules.
87305
- *
87306
- * Each key of the map represents the resource name (in unified resource name syntax) of a bundle file.
87307
- * The array value represents the set of resources (also in unified resource name syntax) that are contained
87308
- * in the bundle. The array can contain JavaScript as well as other textual resource types (e.g. *.xml or
87309
- * *.json resources).
87310
- *
87311
- * When a module is required that has not been loaded yet, and for which a containing bundle is known, that
87312
- * bundle will be required first. Only then the original module will be required again and usually be taken
87313
- * from the just loaded bundle.
87314
- *
87315
- * A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
87316
- * for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
87317
- * loaded synchronously to fulfill API contracts.
87318
- *
87319
- * **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
87320
- * of multiple bundles, only the last one will be taken into account.
87321
- *
87322
- * **Note:** Although non-JS resources can be declared to be part of a bundle, only requests for JavaScript
87323
- * modules will currently trigger the loading of a bundle.
87324
- */
87325
- bundlesUI5?: Record<string, string[]>;
87326
- /**
87327
- * When set to true, `sap.ui.require` loads modules asynchronously via script tags and `sap.ui.define` executes
87328
- * asynchronously. To enable this feature, it is recommended to set the attribute `data-sap-ui-async="true"`
87329
- * on the application bootstrap tag.
87330
- *
87331
- * **Note:** Switching back from async to sync is not supported and trying to do so will throw an `Error`
87332
- */
87333
- async?: boolean;
87334
- /**
87335
- * When set to true, the ui5loader will overwrite the global properties `define` and `require` with its
87336
- * own implementations. Any previously active AMD loader will be remembered internally and can be restored
87337
- * by setting `amd` to false again.
87338
- *
87339
- * **Note:** Switching to the `amd` mode, the ui5loader will set `async` to true implicitly for activating
87340
- * asynchronous loading. Once the loading behaviour has been defined to be asynchronous, it can not be changed
87341
- * to synchronous behaviour again, also not via setting `amd` to false.
87342
- */
87343
- amd?: boolean;
87344
- }
87345
- ):
87346
- | {
87347
- amd: boolean;
87348
-
87349
- async: boolean;
87350
-
87351
- noConflict: boolean;
87352
- }
87353
- | undefined;
87354
- }
87355
87350
  /**
87356
87351
  * The SAPUI5 Data Binding API.
87357
87352
  *