@openui5/ts-types 1.124.2 → 1.126.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.124.2
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.124.2
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1332,6 +1332,8 @@ declare namespace sap {
1332
1332
 
1333
1333
  "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;
1334
1334
 
1335
+ "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetCloudDevAdaptationStatus": undefined;
1336
+
1335
1337
  "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetRegistrationIds": undefined;
1336
1338
 
1337
1339
  "sap/ui/fl/apply/_internal/changes/descriptor/ovp/AddNewCard": undefined;
@@ -1398,6 +1400,8 @@ declare namespace sap {
1398
1400
 
1399
1401
  "sap/ui/fl/apply/_internal/flexState/DataSelector": undefined;
1400
1402
 
1403
+ "sap/ui/fl/apply/_internal/flexState/FlexObjectState": undefined;
1404
+
1401
1405
  "sap/ui/fl/apply/_internal/flexState/FlexState": undefined;
1402
1406
 
1403
1407
  "sap/ui/fl/apply/_internal/flexState/InitialPrepareFunctions": undefined;
@@ -1424,6 +1428,10 @@ declare namespace sap {
1424
1428
 
1425
1429
  "sap/ui/fl/changeHandler/Base": undefined;
1426
1430
 
1431
+ "sap/ui/fl/changeHandler/BaseAddViaDelegate": undefined;
1432
+
1433
+ "sap/ui/fl/changeHandler/BaseRename": undefined;
1434
+
1427
1435
  "sap/ui/fl/ChangePersistenceFactory": undefined;
1428
1436
 
1429
1437
  "sap/ui/fl/descriptorRelated/api/DescriptorChangeFactory": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.124.2
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -936,14 +936,6 @@ declare namespace sap {
936
936
  */
937
937
  manifestReady?: (oEvent: sap.ui.base.Event) => void;
938
938
 
939
- /**
940
- * Fired when card utilities (like `DataProviderFactory`) and the card elements (like header) are created
941
- * and initialized.
942
- *
943
- * Note: The card's content may not be available yet because it may depend on other resources to load.
944
- */
945
- manifestApplied?: (oEvent: sap.ui.base.Event) => void;
946
-
947
939
  /**
948
940
  * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
949
941
  * filter is changed or data is refreshed.
@@ -1256,61 +1248,6 @@ declare namespace sap {
1256
1248
  */
1257
1249
  oListener?: object
1258
1250
  ): this;
1259
- /**
1260
- * Attaches event handler `fnFunction` to the {@link #event:manifestApplied manifestApplied} event of this
1261
- * `sap.ui.integration.widgets.Card`.
1262
- *
1263
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1264
- * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1265
- *
1266
- * Fired when card utilities (like `DataProviderFactory`) and the card elements (like header) are created
1267
- * and initialized.
1268
- *
1269
- * Note: The card's content may not be available yet because it may depend on other resources to load.
1270
- *
1271
- *
1272
- * @returns Reference to `this` in order to allow method chaining
1273
- */
1274
- attachManifestApplied(
1275
- /**
1276
- * An application-specific payload object that will be passed to the event handler along with the event
1277
- * object when firing the event
1278
- */
1279
- oData: object,
1280
- /**
1281
- * The function to be called when the event occurs
1282
- */
1283
- fnFunction: (p1: sap.ui.base.Event) => void,
1284
- /**
1285
- * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
1286
- */
1287
- oListener?: object
1288
- ): this;
1289
- /**
1290
- * Attaches event handler `fnFunction` to the {@link #event:manifestApplied manifestApplied} event of this
1291
- * `sap.ui.integration.widgets.Card`.
1292
- *
1293
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1294
- * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1295
- *
1296
- * Fired when card utilities (like `DataProviderFactory`) and the card elements (like header) are created
1297
- * and initialized.
1298
- *
1299
- * Note: The card's content may not be available yet because it may depend on other resources to load.
1300
- *
1301
- *
1302
- * @returns Reference to `this` in order to allow method chaining
1303
- */
1304
- attachManifestApplied(
1305
- /**
1306
- * The function to be called when the event occurs
1307
- */
1308
- fnFunction: (p1: sap.ui.base.Event) => void,
1309
- /**
1310
- * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
1311
- */
1312
- oListener?: object
1313
- ): this;
1314
1251
  /**
1315
1252
  * Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
1316
1253
  *
@@ -1461,25 +1398,6 @@ declare namespace sap {
1461
1398
  */
1462
1399
  oListener?: object
1463
1400
  ): this;
1464
- /**
1465
- * Detaches event handler `fnFunction` from the {@link #event:manifestApplied manifestApplied} event of
1466
- * this `sap.ui.integration.widgets.Card`.
1467
- *
1468
- * The passed function and listener object must match the ones used for event registration.
1469
- *
1470
- *
1471
- * @returns Reference to `this` in order to allow method chaining
1472
- */
1473
- detachManifestApplied(
1474
- /**
1475
- * The function to be called, when the event occurs
1476
- */
1477
- fnFunction: (p1: sap.ui.base.Event) => void,
1478
- /**
1479
- * Context object on which the given function had to be called
1480
- */
1481
- oListener?: object
1482
- ): this;
1483
1401
  /**
1484
1402
  * Detaches event handler `fnFunction` from the {@link #event:manifestReady manifestReady} event of this
1485
1403
  * `sap.ui.integration.widgets.Card`.
@@ -1551,19 +1469,6 @@ declare namespace sap {
1551
1469
  */
1552
1470
  mParameters?: sap.ui.integration.widgets.Card$ConfigurationChangeEventParameters
1553
1471
  ): this;
1554
- /**
1555
- * Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
1556
- *
1557
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1558
- *
1559
- * @returns Reference to `this` in order to allow method chaining
1560
- */
1561
- fireManifestApplied(
1562
- /**
1563
- * Parameters to pass along with the event
1564
- */
1565
- mParameters?: object
1566
- ): this;
1567
1472
  /**
1568
1473
  * Fires event {@link #event:manifestReady manifestReady} to attached listeners.
1569
1474
  *
@@ -1744,6 +1649,8 @@ declare namespace sap {
1744
1649
  * ```
1745
1650
  *
1746
1651
  *
1652
+ * Default value is `[]`.
1653
+ *
1747
1654
  * @since 1.76
1748
1655
  * @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
1749
1656
  * is implemented.
@@ -2053,26 +1960,6 @@ declare namespace sap {
2053
1960
  */
2054
1961
  sDesign?: sap.ui.integration.CardDesign
2055
1962
  ): this;
2056
- /**
2057
- * Sets a new value for property {@link #getDisplayVariant displayVariant}.
2058
- *
2059
- * Defines the display variant for card rendering and behavior.
2060
- *
2061
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2062
- *
2063
- * Default value is `Standard`.
2064
- *
2065
- * @since 1.118
2066
- * @experimental (since 1.118) - For usage only by Work Zone.
2067
- *
2068
- * @returns Reference to `this` in order to allow method chaining
2069
- */
2070
- setDisplayVariant(
2071
- /**
2072
- * New value for property `displayVariant`
2073
- */
2074
- sDisplayVariant?: sap.ui.integration.CardDisplayVariant
2075
- ): this;
2076
1963
  /**
2077
1964
  * Sets the associated {@link #getHost host}.
2078
1965
  *
@@ -2146,6 +2033,8 @@ declare namespace sap {
2146
2033
  *
2147
2034
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2148
2035
  *
2036
+ * Default value is `[]`.
2037
+ *
2149
2038
  * @since 1.76
2150
2039
  * @experimental (since 1.76) - This API might be removed when a permanent solution for flexibility changes
2151
2040
  * is implemented.
@@ -2156,7 +2045,7 @@ declare namespace sap {
2156
2045
  /**
2157
2046
  * New value for property `manifestChanges`
2158
2047
  */
2159
- sManifestChanges: object[]
2048
+ sManifestChanges?: object[]
2160
2049
  ): this;
2161
2050
  /**
2162
2051
  * Sets a new value for property {@link #getParameters parameters}.
@@ -4237,10 +4126,30 @@ declare namespace sap {
4237
4126
  * @experimental (since 1.118) - For usage only by Work Zone.
4238
4127
  */
4239
4128
  enum CardDisplayVariant {
4129
+ /**
4130
+ * The CompactHeader card variant.
4131
+ */
4132
+ CompactHeader = "CompactHeader",
4133
+ /**
4134
+ * The large card variant.
4135
+ */
4136
+ Large = "Large",
4137
+ /**
4138
+ * The small card variant.
4139
+ */
4140
+ Small = "Small",
4141
+ /**
4142
+ * The SmallHeader card variant.
4143
+ */
4144
+ SmallHeader = "SmallHeader",
4240
4145
  /**
4241
4146
  * The standard card variant.
4242
4147
  */
4243
4148
  Standard = "Standard",
4149
+ /**
4150
+ * The SmallHeader card variant.
4151
+ */
4152
+ StandardHeader = "StandardHeader",
4244
4153
  /**
4245
4154
  * Card renders and behaves like a tile of size 2x1.
4246
4155
  */
@@ -4308,6 +4217,11 @@ declare namespace sap {
4308
4217
  * Description
4309
4218
  */
4310
4219
  description?: string;
4220
+ /**
4221
+ * Path to a custom image to be shown on the place of the regular illustration. Relative to the card base
4222
+ * URL.
4223
+ */
4224
+ imageSrc?: string;
4311
4225
  /**
4312
4226
  * Response object in case of a network error
4313
4227
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.124.2
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -8666,8 +8666,9 @@ declare namespace sap {
8666
8666
 
8667
8667
  /**
8668
8668
  * Optional. A string type that represents the span values of the `Grid` for large, medium and small screens.
8669
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
8670
- * the container has to take, for example, `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
8669
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
8670
+ * of columns from 1 to 12 that the container has to take, for example, `L2 M4 S6`, `M12`, `s10` or `l4
8671
+ * m4`.
8671
8672
  *
8672
8673
  * **Note:** The parameters must be provided in the order .
8673
8674
  */
@@ -8678,9 +8679,9 @@ declare namespace sap {
8678
8679
 
8679
8680
  /**
8680
8681
  * Optional. Defines default for the whole Grid numbers of empty columns before the current span begins.
8681
- * It can be defined for large, medium and small screens. Allowed values are separated by space Letters
8682
- * L, M or S followed by number of columns from 0 to 11 that the container has to take, for example, `L2
8683
- * M4 S6`, `M11`, `s10` or `l4 m4`.
8682
+ * It can be defined for large, medium and small screens. Allowed values are separated by space with case
8683
+ * insensitive Letters XL, L, M or S followed by number of columns from 0 to 11 that the container has to
8684
+ * take, for example, `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
8684
8685
  *
8685
8686
  * **Note:** The parameters must be provided in the order .
8686
8687
  */
@@ -8722,8 +8723,9 @@ declare namespace sap {
8722
8723
  /**
8723
8724
  * A string type that represents the span values of the `Grid` for large, medium and small screens.
8724
8725
  *
8725
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
8726
- * the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
8726
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
8727
+ * of columns from 1 to 12 that the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4
8728
+ * m4`.
8727
8729
  *
8728
8730
  * **Note:** The parameters must be provided in the order .
8729
8731
  */
@@ -8771,8 +8773,9 @@ declare namespace sap {
8771
8773
  /**
8772
8774
  * A string type that represents the indent values of the `Grid` for large, medium and small screens.
8773
8775
  *
8774
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 11 that
8775
- * the container has to take, for example, `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
8776
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
8777
+ * of columns from 1 to 11 that the container has to take, for example, `L2 M4 S6`, `M11`, `s10` or `l4
8778
+ * m4`.
8776
8779
  *
8777
8780
  * **Note:** The parameters must be provided in the order .
8778
8781
  */
@@ -11568,9 +11571,9 @@ declare namespace sap {
11568
11571
  * Gets current value of property {@link #getDefaultIndent defaultIndent}.
11569
11572
  *
11570
11573
  * Optional. Defines default for the whole Grid numbers of empty columns before the current span begins.
11571
- * It can be defined for large, medium and small screens. Allowed values are separated by space Letters
11572
- * L, M or S followed by number of columns from 0 to 11 that the container has to take, for example, `L2
11573
- * M4 S6`, `M11`, `s10` or `l4 m4`.
11574
+ * It can be defined for large, medium and small screens. Allowed values are separated by space with case
11575
+ * insensitive Letters XL, L, M or S followed by number of columns from 0 to 11 that the container has to
11576
+ * take, for example, `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
11574
11577
  *
11575
11578
  * **Note:** The parameters must be provided in the order .
11576
11579
  *
@@ -11584,8 +11587,9 @@ declare namespace sap {
11584
11587
  * Gets current value of property {@link #getDefaultSpan defaultSpan}.
11585
11588
  *
11586
11589
  * Optional. A string type that represents the span values of the `Grid` for large, medium and small screens.
11587
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
11588
- * the container has to take, for example, `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
11590
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
11591
+ * of columns from 1 to 12 that the container has to take, for example, `L2 M4 S6`, `M12`, `s10` or `l4
11592
+ * m4`.
11589
11593
  *
11590
11594
  * **Note:** The parameters must be provided in the order .
11591
11595
  *
@@ -11737,9 +11741,9 @@ declare namespace sap {
11737
11741
  * Sets a new value for property {@link #getDefaultIndent defaultIndent}.
11738
11742
  *
11739
11743
  * Optional. Defines default for the whole Grid numbers of empty columns before the current span begins.
11740
- * It can be defined for large, medium and small screens. Allowed values are separated by space Letters
11741
- * L, M or S followed by number of columns from 0 to 11 that the container has to take, for example, `L2
11742
- * M4 S6`, `M11`, `s10` or `l4 m4`.
11744
+ * It can be defined for large, medium and small screens. Allowed values are separated by space with case
11745
+ * insensitive Letters XL, L, M or S followed by number of columns from 0 to 11 that the container has to
11746
+ * take, for example, `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
11743
11747
  *
11744
11748
  * **Note:** The parameters must be provided in the order .
11745
11749
  *
@@ -11760,8 +11764,9 @@ declare namespace sap {
11760
11764
  * Sets a new value for property {@link #getDefaultSpan defaultSpan}.
11761
11765
  *
11762
11766
  * Optional. A string type that represents the span values of the `Grid` for large, medium and small screens.
11763
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
11764
- * the container has to take, for example, `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
11767
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
11768
+ * of columns from 1 to 12 that the container has to take, for example, `L2 M4 S6`, `M12`, `s10` or `l4
11769
+ * m4`.
11765
11770
  *
11766
11771
  * **Note:** The parameters must be provided in the order .
11767
11772
  *
@@ -11936,8 +11941,9 @@ declare namespace sap {
11936
11941
  *
11937
11942
  * A string type that represents the indent values of the `Grid` for large, medium and small screens.
11938
11943
  *
11939
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 11 that
11940
- * the container has to take, for example, `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
11944
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
11945
+ * of columns from 1 to 11 that the container has to take, for example, `L2 M4 S6`, `M11`, `s10` or `l4
11946
+ * m4`.
11941
11947
  *
11942
11948
  * **Note:** The parameters must be provided in the order .
11943
11949
  *
@@ -12101,8 +12107,9 @@ declare namespace sap {
12101
12107
  *
12102
12108
  * A string type that represents the span values of the `Grid` for large, medium and small screens.
12103
12109
  *
12104
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
12105
- * the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
12110
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
12111
+ * of columns from 1 to 12 that the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4
12112
+ * m4`.
12106
12113
  *
12107
12114
  * **Note:** The parameters must be provided in the order .
12108
12115
  *
@@ -12268,8 +12275,9 @@ declare namespace sap {
12268
12275
  *
12269
12276
  * A string type that represents the indent values of the `Grid` for large, medium and small screens.
12270
12277
  *
12271
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 11 that
12272
- * the container has to take, for example, `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
12278
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
12279
+ * of columns from 1 to 11 that the container has to take, for example, `L2 M4 S6`, `M11`, `s10` or `l4
12280
+ * m4`.
12273
12281
  *
12274
12282
  * **Note:** The parameters must be provided in the order .
12275
12283
  *
@@ -12538,8 +12546,9 @@ declare namespace sap {
12538
12546
  *
12539
12547
  * A string type that represents the span values of the `Grid` for large, medium and small screens.
12540
12548
  *
12541
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
12542
- * the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
12549
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
12550
+ * of columns from 1 to 12 that the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4
12551
+ * m4`.
12543
12552
  *
12544
12553
  * **Note:** The parameters must be provided in the order .
12545
12554
  *
@@ -15125,8 +15134,9 @@ declare namespace sap {
15125
15134
  /**
15126
15135
  * A string type that represents the indent values of the `Grid` for large, medium and small screens.
15127
15136
  *
15128
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 11 that
15129
- * the container has to take, for example: `L2 M4 S6`, `M11`, `s10` or `l4 m4`.
15137
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
15138
+ * of columns from 1 to 11 that the container has to take, for example: `L2 M4 S6`, `M11`, `s10` or `l4
15139
+ * m4`.
15130
15140
  *
15131
15141
  * **Note:** The parameters must be provided in the order .
15132
15142
  */
@@ -15135,8 +15145,9 @@ declare namespace sap {
15135
15145
  /**
15136
15146
  * A string type that represents the span values of the `Grid` for large, medium and small screens.
15137
15147
  *
15138
- * Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that
15139
- * the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4 m4`.
15148
+ * Allowed values are separated by space with case insensitive Letters XL, L, M or S followed by number
15149
+ * of columns from 1 to 12 that the container has to take, for example: `L2 M4 S6`, `M12`, `s10` or `l4
15150
+ * m4`.
15140
15151
  *
15141
15152
  * **Note:** The parameters must be provided in the order .
15142
15153
  */