@openui5/types 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.
- package/package.json +1 -1
- package/types/sap.f.d.ts +238 -12
- package/types/sap.m.d.ts +355 -25
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +252 -261
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +142 -2
- package/types/sap.ui.layout.d.ts +18 -21
- package/types/sap.ui.mdc.d.ts +220 -103
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +7 -4
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +263 -9
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -279,7 +279,7 @@ declare namespace sap {
|
|
|
279
279
|
"sap/ui/thirdparty/qunit-2": undefined;
|
|
280
280
|
}
|
|
281
281
|
}
|
|
282
|
-
// For Library Version: 1.
|
|
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
|
-
):
|
|
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
|
|
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
|
|
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
|
|
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
|
|
14047
|
+
* Returns the formatted value of a control used in a {@link sap.ui.layout.form.SemanticFormElement SemanticFormElement}.
|
|
14046
14048
|
*
|
|
14047
|
-
* In the
|
|
14048
|
-
* a text is rendered that concatenates the values of all assigned
|
|
14049
|
-
* does not match the value of the field and needs some formatting.
|
|
14050
|
-
* have a `value` property, so the
|
|
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
|
|
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
|
|
14064
|
-
*
|
|
14065
|
-
*
|
|
14066
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
14092
|
-
* a text is rendered that concatenates the values of all assigned
|
|
14093
|
-
* to be updated if the value of a control changes. If a control
|
|
14094
|
-
*
|
|
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/
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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 |
|
|
31330
|
+
vLocale: Locale | LanguageTag
|
|
31200
31331
|
): LocaleData;
|
|
31201
31332
|
/**
|
|
31202
31333
|
* Returns a metadata object for class sap.ui.core.LocaleData.
|
|
@@ -55848,7 +55979,8 @@ declare module "sap/ui/model/Filter" {
|
|
|
55848
55979
|
*/
|
|
55849
55980
|
constructor(
|
|
55850
55981
|
/**
|
|
55851
|
-
* 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
|
|
55852
55984
|
*/
|
|
55853
55985
|
vFilterInfo:
|
|
55854
55986
|
| {
|
|
@@ -67182,7 +67314,10 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
67182
67314
|
*
|
|
67183
67315
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
67184
67316
|
*
|
|
67185
|
-
* @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.
|
|
67186
67321
|
*/
|
|
67187
67322
|
getContexts(
|
|
67188
67323
|
/**
|
|
@@ -73928,6 +74063,43 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
73928
74063
|
ODataListBinding$SelectionChangedEventParameters,
|
|
73929
74064
|
ODataListBinding
|
|
73930
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
|
+
>;
|
|
73931
74103
|
}
|
|
73932
74104
|
|
|
73933
74105
|
declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
@@ -77518,21 +77690,41 @@ declare module "sap/ui/model/Sorter" {
|
|
|
77518
77690
|
*/
|
|
77519
77691
|
constructor(
|
|
77520
77692
|
/**
|
|
77521
|
-
*
|
|
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
|
|
77522
77695
|
*/
|
|
77523
|
-
|
|
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
|
+
},
|
|
77524
77716
|
/**
|
|
77525
|
-
*
|
|
77717
|
+
* Whether the sort order is descending
|
|
77526
77718
|
*/
|
|
77527
77719
|
bDescending?: boolean,
|
|
77528
77720
|
/**
|
|
77529
|
-
*
|
|
77530
|
-
* value, or a function which calculates the group value out of the context (e.g. oContext.getProperty("date").getYear()
|
|
77531
|
-
* for year grouping). The control needs to implement the grouping behaviour
|
|
77532
|
-
*
|
|
77533
|
-
*
|
|
77534
|
-
*
|
|
77535
|
-
*
|
|
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}.
|
|
77536
77728
|
* **Note:** Grouping via `vGroup=true` is only possible (and only makes sense) for the primary sort property.
|
|
77537
77729
|
* A more complicated grouping is possible by providing a grouping function. The sort order needs to fit
|
|
77538
77730
|
* to the grouping also in this case. See also {@link https://ui5.sap.com/#/topic/ec79a5d5918f4f7f9cbc2150e66778cc Sorting, Grouping, and Filtering for List Binding}.
|
|
@@ -77540,7 +77732,7 @@ declare module "sap/ui/model/Sorter" {
|
|
|
77540
77732
|
vGroup?: boolean | Function,
|
|
77541
77733
|
/**
|
|
77542
77734
|
* A custom comparator function, which is used for client-side sorting instead of the default comparator
|
|
77543
|
-
* method
|
|
77735
|
+
* method; information about parameters and expected return values of such a method can be found in the
|
|
77544
77736
|
* {@link #.defaultComparator default comparator} documentation. **Note:** Custom comparator functions are
|
|
77545
77737
|
* meant to be used on the client. Models that implement sorting in the backend usually don't support custom
|
|
77546
77738
|
* comparator functions. Consult the documentation of the specific model implementation.
|
|
@@ -77625,6 +77817,22 @@ declare module "sap/ui/model/Sorter" {
|
|
|
77625
77817
|
* @returns The group function
|
|
77626
77818
|
*/
|
|
77627
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;
|
|
77628
77836
|
}
|
|
77629
77837
|
}
|
|
77630
77838
|
|
|
@@ -87139,223 +87347,6 @@ declare namespace sap {
|
|
|
87139
87347
|
controller?: import("sap/ui/core/mvc/Controller").default;
|
|
87140
87348
|
}
|
|
87141
87349
|
): import("sap/ui/core/mvc/XMLView").default;
|
|
87142
|
-
/**
|
|
87143
|
-
* Provides access to UI5 loader configuration.
|
|
87144
|
-
*
|
|
87145
|
-
* The configuration is used by {@link sap.ui.require} and {@link sap.ui.define}.
|
|
87146
|
-
*/
|
|
87147
|
-
namespace loader {
|
|
87148
|
-
/**
|
|
87149
|
-
* Sets the configuration for the UI5 loader. The configuration can be updated multiple times. Later changes
|
|
87150
|
-
* do not impact modules that have been loaded before.
|
|
87151
|
-
*
|
|
87152
|
-
* If no parameter is given, a partial copy of UI5 loader configuration in use is returned.
|
|
87153
|
-
*
|
|
87154
|
-
* The configuration options are aligned with the "Common Config" draft of the AMD spec (https://github.com/amdjs/amdjs-api/blob/master/CommonConfig.md).
|
|
87155
|
-
*
|
|
87156
|
-
* The following code shows an example of what a UI5 loader configuration might look like:
|
|
87157
|
-
* ```javascript
|
|
87158
|
-
*
|
|
87159
|
-
*
|
|
87160
|
-
* sap.ui.loader.config({
|
|
87161
|
-
*
|
|
87162
|
-
* // location from where to load all modules by default
|
|
87163
|
-
* baseUrl: '../../resources/',
|
|
87164
|
-
*
|
|
87165
|
-
* paths: {
|
|
87166
|
-
* // load modules whose ID equals to or starts with 'my/module' from example.com
|
|
87167
|
-
* 'my/module': 'https://example.com/resources/my/module'
|
|
87168
|
-
* },
|
|
87169
|
-
*
|
|
87170
|
-
* map: {
|
|
87171
|
-
* // if any module requires 'sinon', load module 'sap/ui/thirdparty/sinon-4'
|
|
87172
|
-
* '*': {
|
|
87173
|
-
* 'sinon': 'sap/ui/thirdparty/sinon-4'
|
|
87174
|
-
* },
|
|
87175
|
-
* // but if a module whose ID equals to or starts with 'app' requires 'sinon'
|
|
87176
|
-
* // then load a legacy version instead
|
|
87177
|
-
* "app": {
|
|
87178
|
-
* 'sinon': 'sap/ui/legacy/sinon'
|
|
87179
|
-
* }
|
|
87180
|
-
* },
|
|
87181
|
-
*
|
|
87182
|
-
* // define two bundles that consists of JS modules only
|
|
87183
|
-
* bundles: {
|
|
87184
|
-
* bundle1: ['module1', 'module2'],
|
|
87185
|
-
* bundle2: ['moduleX', 'moduleY']
|
|
87186
|
-
* },
|
|
87187
|
-
*
|
|
87188
|
-
* // define a bundle that also contains non-JS resources
|
|
87189
|
-
* bundlesUI5: {
|
|
87190
|
-
* 'all.js': ['Component.js', 'manifest.json',
|
|
87191
|
-
* 'App.controller.js', 'App.view.xml']
|
|
87192
|
-
* },
|
|
87193
|
-
*
|
|
87194
|
-
* // activate real async loading and module definitions
|
|
87195
|
-
* async: true,
|
|
87196
|
-
*
|
|
87197
|
-
* // provide dependency and export metadata for non-UI5 modules
|
|
87198
|
-
* shim: {
|
|
87199
|
-
* 'sap/ui/thirdparty/blanket': {
|
|
87200
|
-
* amd: true,
|
|
87201
|
-
* exports: 'blanket'
|
|
87202
|
-
* }
|
|
87203
|
-
* }
|
|
87204
|
-
*
|
|
87205
|
-
* });
|
|
87206
|
-
*
|
|
87207
|
-
* ```
|
|
87208
|
-
*
|
|
87209
|
-
*
|
|
87210
|
-
* @since 1.56.0
|
|
87211
|
-
*
|
|
87212
|
-
* @returns UI5 loader configuration in use.
|
|
87213
|
-
*/
|
|
87214
|
-
function config(
|
|
87215
|
-
/**
|
|
87216
|
-
* The provided configuration gets merged with the UI5 loader configuration in use. If `cfg` is omitted
|
|
87217
|
-
* or `undefined`, a copy of the current configuration gets returned, containing at least the properties
|
|
87218
|
-
* `amd` and `async`.
|
|
87219
|
-
*/
|
|
87220
|
-
cfg?: {
|
|
87221
|
-
/**
|
|
87222
|
-
* Default location to load modules from. If none of the configured `paths` prefixes matches a module ID,
|
|
87223
|
-
* the module will be loaded from the concatenation of the `baseUrl` and the module ID.
|
|
87224
|
-
*
|
|
87225
|
-
* If the `baseUrl` itself is a relative URL, it is evaluated relative to `document.baseURI`.
|
|
87226
|
-
*/
|
|
87227
|
-
baseUrl?: string;
|
|
87228
|
-
/**
|
|
87229
|
-
* A map of resource locations keyed by a corresponding module ID prefix. When a module is to be loaded,
|
|
87230
|
-
* the longest key in `paths` is searched that is a prefix of the module ID. The module will be loaded from
|
|
87231
|
-
* the concatenation of the corresponding value in `paths` and the remainder of the module ID (after the
|
|
87232
|
-
* prefix). If no entry in `paths` matches, then the module will be loaded from the `baseUrl`.
|
|
87233
|
-
*
|
|
87234
|
-
* The prefixes (keys) must not contain relative segments (./ or ../), a trailing slash will be removed,
|
|
87235
|
-
* and only full name segment matches are considered a match (prefix 'sap/m' does not match a module ID
|
|
87236
|
-
* 'sap/main').
|
|
87237
|
-
*
|
|
87238
|
-
* **Note**: In contrast to the "Common Config" of the AMD spec, the paths (values in the map) are interpreted
|
|
87239
|
-
* relative to `document.baseURI`, not relative to `cfg.baseUrl`.
|
|
87240
|
-
*/
|
|
87241
|
-
paths?: Record<string, string>;
|
|
87242
|
-
/**
|
|
87243
|
-
* A map of maps that defines how to map module IDs to other module IDs (inner maps) in the context of a
|
|
87244
|
-
* specific set of modules (keys of outer map).
|
|
87245
|
-
*
|
|
87246
|
-
* Each key of the outer map represents a module ID prefix that describes the context for which its value
|
|
87247
|
-
* (inner map) has to be used. The special key `*` describes the default context which applies for any module.
|
|
87248
|
-
* Only the most specific matching context will be taken into account.
|
|
87249
|
-
*
|
|
87250
|
-
* Each inner map maps a module ID or module ID prefix to another module ID or module ID prefix. Again,
|
|
87251
|
-
* only the most specific match is taken into account and only one mapping is evaluated (the evaluation
|
|
87252
|
-
* of the mappings is not done recursively).
|
|
87253
|
-
*
|
|
87254
|
-
* Matches are always complete matches, a prefix 'a/b/c' does not match the module ID 'a/b/com'.
|
|
87255
|
-
*/
|
|
87256
|
-
map?: Record<string, Record<string, string>>;
|
|
87257
|
-
/**
|
|
87258
|
-
* Defines additional metadata for modules for which the normal behavior of the AMD APIs is not sufficient.
|
|
87259
|
-
*
|
|
87260
|
-
* A typical example are scripts that don't use `define` or `sap.ui.define`, but export to a global name.
|
|
87261
|
-
* With the `exports` property, one or more export names can be specified, and the loader can retrieve the
|
|
87262
|
-
* exported value after executing the corresponding module. If such a module has dependencies, they can
|
|
87263
|
-
* be specified in the `deps` array and are loaded and executed before executing the module.
|
|
87264
|
-
*
|
|
87265
|
-
* The `amd` flag of a shim is a ui5loader-specific extension of the standard AMD shims. If set, the ui5loader
|
|
87266
|
-
* hides a currently active AMD loader before executing the module and restores it afterwards. Otherwise,
|
|
87267
|
-
* it might miss the export of third party modules that check for an AMD loader and register with it instead
|
|
87268
|
-
* of exporting to a global name. A future version of the ui5loader might ignore this flag when it acts
|
|
87269
|
-
* as an AMD loader by itself.
|
|
87270
|
-
*
|
|
87271
|
-
* **Note:** The ui5loader does not support the `init` option described by the "Common Config" section of
|
|
87272
|
-
* the AMD spec.
|
|
87273
|
-
*/
|
|
87274
|
-
shim?: Record<
|
|
87275
|
-
string,
|
|
87276
|
-
{
|
|
87277
|
-
amd: boolean;
|
|
87278
|
-
|
|
87279
|
-
deps: string[];
|
|
87280
|
-
|
|
87281
|
-
exports: string | string[];
|
|
87282
|
-
}
|
|
87283
|
-
>;
|
|
87284
|
-
/**
|
|
87285
|
-
* A map of arrays that each define the modules contained in a bundle.
|
|
87286
|
-
*
|
|
87287
|
-
* Each key of the map represents the module ID of a bundle file. The array value represents the set of
|
|
87288
|
-
* JavaScript modules (their module IDs) that are contained in the bundle.
|
|
87289
|
-
*
|
|
87290
|
-
* When a module is required that has not been loaded yet, and for which a containing bundle is known, that
|
|
87291
|
-
* bundle will be required first. Only then the original module will be required again and usually be taken
|
|
87292
|
-
* from the just loaded bundle.
|
|
87293
|
-
*
|
|
87294
|
-
* A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
|
|
87295
|
-
* for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
|
|
87296
|
-
* loaded synchronously to fulfill API contracts.
|
|
87297
|
-
*
|
|
87298
|
-
* **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
|
|
87299
|
-
* of multiple bundles, only the last one will be taken into account.
|
|
87300
|
-
*
|
|
87301
|
-
* This configuration option is basically provided to be compatible with requireJS or SystemJS configuration.
|
|
87302
|
-
*/
|
|
87303
|
-
bundles?: Record<string, string[]>;
|
|
87304
|
-
/**
|
|
87305
|
-
* A map of arrays that each define the resources contained in a bundle.
|
|
87306
|
-
*
|
|
87307
|
-
* This is similar to `bundles`, but all strings are unified resource names including a file type extension,
|
|
87308
|
-
* not only module IDs. This allows to represent more than just JavaScript modules.
|
|
87309
|
-
*
|
|
87310
|
-
* Each key of the map represents the resource name (in unified resource name syntax) of a bundle file.
|
|
87311
|
-
* The array value represents the set of resources (also in unified resource name syntax) that are contained
|
|
87312
|
-
* in the bundle. The array can contain JavaScript as well as other textual resource types (e.g. *.xml or
|
|
87313
|
-
* *.json resources).
|
|
87314
|
-
*
|
|
87315
|
-
* When a module is required that has not been loaded yet, and for which a containing bundle is known, that
|
|
87316
|
-
* bundle will be required first. Only then the original module will be required again and usually be taken
|
|
87317
|
-
* from the just loaded bundle.
|
|
87318
|
-
*
|
|
87319
|
-
* A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
|
|
87320
|
-
* for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
|
|
87321
|
-
* loaded synchronously to fulfill API contracts.
|
|
87322
|
-
*
|
|
87323
|
-
* **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
|
|
87324
|
-
* of multiple bundles, only the last one will be taken into account.
|
|
87325
|
-
*
|
|
87326
|
-
* **Note:** Although non-JS resources can be declared to be part of a bundle, only requests for JavaScript
|
|
87327
|
-
* modules will currently trigger the loading of a bundle.
|
|
87328
|
-
*/
|
|
87329
|
-
bundlesUI5?: Record<string, string[]>;
|
|
87330
|
-
/**
|
|
87331
|
-
* When set to true, `sap.ui.require` loads modules asynchronously via script tags and `sap.ui.define` executes
|
|
87332
|
-
* asynchronously. To enable this feature, it is recommended to set the attribute `data-sap-ui-async="true"`
|
|
87333
|
-
* on the application bootstrap tag.
|
|
87334
|
-
*
|
|
87335
|
-
* **Note:** Switching back from async to sync is not supported and trying to do so will throw an `Error`
|
|
87336
|
-
*/
|
|
87337
|
-
async?: boolean;
|
|
87338
|
-
/**
|
|
87339
|
-
* When set to true, the ui5loader will overwrite the global properties `define` and `require` with its
|
|
87340
|
-
* own implementations. Any previously active AMD loader will be remembered internally and can be restored
|
|
87341
|
-
* by setting `amd` to false again.
|
|
87342
|
-
*
|
|
87343
|
-
* **Note:** Switching to the `amd` mode, the ui5loader will set `async` to true implicitly for activating
|
|
87344
|
-
* asynchronous loading. Once the loading behaviour has been defined to be asynchronous, it can not be changed
|
|
87345
|
-
* to synchronous behaviour again, also not via setting `amd` to false.
|
|
87346
|
-
*/
|
|
87347
|
-
amd?: boolean;
|
|
87348
|
-
}
|
|
87349
|
-
):
|
|
87350
|
-
| {
|
|
87351
|
-
amd: boolean;
|
|
87352
|
-
|
|
87353
|
-
async: boolean;
|
|
87354
|
-
|
|
87355
|
-
noConflict: boolean;
|
|
87356
|
-
}
|
|
87357
|
-
| undefined;
|
|
87358
|
-
}
|
|
87359
87350
|
/**
|
|
87360
87351
|
* The SAPUI5 Data Binding API.
|
|
87361
87352
|
*
|