@sapui5/ts-types 1.150.1 → 1.152.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/index.d.ts +1 -0
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +427 -157
- package/types/sap.f.d.ts +1189 -292
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +2 -222
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +61 -9
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +220 -85
- package/types/sap.fe.navigation.d.ts +3 -2
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +12 -2
- package/types/sap.fe.test.d.ts +3 -3
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +138 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +246 -3
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +1 -1
- package/types/sap.suite.ui.commons.d.ts +957 -1
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +178 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +4 -2
- package/types/sap.ui.core.d.ts +561 -245
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +7 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.geomap.d.ts +10393 -8758
- package/types/sap.ui.integration.d.ts +130 -326
- package/types/sap.ui.joule.frontend.d.ts +710 -0
- package/types/sap.ui.layout.d.ts +33 -7
- package/types/sap.ui.mdc.d.ts +36 -8
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +4 -4
- 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 +2 -2
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +160 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +84 -47
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.152.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -450,6 +450,7 @@ declare namespace sap {
|
|
|
450
450
|
*
|
|
451
451
|
* - Use when developing a Component card.
|
|
452
452
|
*
|
|
453
|
+
* @deprecated As of version 1.152. Use `getResolvedParameters()` instead.
|
|
453
454
|
* @experimental As of version 1.77.
|
|
454
455
|
*
|
|
455
456
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
@@ -465,7 +466,7 @@ declare namespace sap {
|
|
|
465
466
|
*
|
|
466
467
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
467
468
|
*
|
|
468
|
-
* @
|
|
469
|
+
* @since 1.77
|
|
469
470
|
*
|
|
470
471
|
* @returns The value at the specified path.
|
|
471
472
|
*/
|
|
@@ -485,11 +486,25 @@ declare namespace sap {
|
|
|
485
486
|
* Overrides the default values of the parameters, which are defined in the manifest. The returned value
|
|
486
487
|
* is an object containing parameters in format `{parameterKey: parameterValue}`.
|
|
487
488
|
*
|
|
488
|
-
* @deprecated As of version 1.143. Use `
|
|
489
|
+
* @deprecated As of version 1.143. Use `getResolvedParameters()` instead.
|
|
489
490
|
*
|
|
490
491
|
* @returns Value of property parameters
|
|
491
492
|
*/
|
|
492
493
|
getParameters(): object;
|
|
494
|
+
/**
|
|
495
|
+
* Gets values of manifest parameters combined with the parameters from `parameters` property.
|
|
496
|
+
*
|
|
497
|
+
* **Notes**
|
|
498
|
+
*
|
|
499
|
+
* - Use this method when the manifest is ready. Check `manifestReady` event.
|
|
500
|
+
*
|
|
501
|
+
* - Use when developing a Component card.
|
|
502
|
+
*
|
|
503
|
+
* @since 1.152
|
|
504
|
+
*
|
|
505
|
+
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
506
|
+
*/
|
|
507
|
+
getResolvedParameters(): Record<string, any>;
|
|
493
508
|
/**
|
|
494
509
|
* Gets translated text from the i18n properties files configured for this card.
|
|
495
510
|
*
|
|
@@ -534,7 +549,8 @@ declare namespace sap {
|
|
|
534
549
|
eCardArea?: sap.ui.integration.CardArea
|
|
535
550
|
): void;
|
|
536
551
|
/**
|
|
537
|
-
* Hides the message previously shown by showMessage.
|
|
552
|
+
* Hides the message previously shown by {@link sap.ui.integration.widgets.Card#showMessage showMessage}.
|
|
553
|
+
* Can be used only after the `manifestApplied` event is fired.
|
|
538
554
|
*
|
|
539
555
|
* @experimental As of version 1.117.
|
|
540
556
|
*/
|
|
@@ -575,7 +591,7 @@ declare namespace sap {
|
|
|
575
591
|
/**
|
|
576
592
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
577
593
|
*
|
|
578
|
-
* @
|
|
594
|
+
* @since 1.65
|
|
579
595
|
*/
|
|
580
596
|
refresh(): void;
|
|
581
597
|
/**
|
|
@@ -747,7 +763,7 @@ declare namespace sap {
|
|
|
747
763
|
* ```
|
|
748
764
|
*
|
|
749
765
|
*
|
|
750
|
-
* @
|
|
766
|
+
* @since 1.84
|
|
751
767
|
*/
|
|
752
768
|
triggerAction(
|
|
753
769
|
/**
|
|
@@ -767,7 +783,7 @@ declare namespace sap {
|
|
|
767
783
|
/**
|
|
768
784
|
* Causes all the controls within the Card that support validation to validate their data.
|
|
769
785
|
*
|
|
770
|
-
* @
|
|
786
|
+
* @since 1.106
|
|
771
787
|
*
|
|
772
788
|
* @returns if all the controls validated successfully; otherwise, false
|
|
773
789
|
*/
|
|
@@ -796,7 +812,7 @@ declare namespace sap {
|
|
|
796
812
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
797
813
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
798
814
|
*
|
|
799
|
-
* @
|
|
815
|
+
* @since 1.65
|
|
800
816
|
*/
|
|
801
817
|
parameters?:
|
|
802
818
|
| object
|
|
@@ -868,9 +884,7 @@ declare namespace sap {
|
|
|
868
884
|
* ```
|
|
869
885
|
*
|
|
870
886
|
*
|
|
871
|
-
*
|
|
872
|
-
*
|
|
873
|
-
* @experimental As of version 1.76.
|
|
887
|
+
* @since 1.76
|
|
874
888
|
*/
|
|
875
889
|
manifestChanges?:
|
|
876
890
|
| object[]
|
|
@@ -950,22 +964,14 @@ declare namespace sap {
|
|
|
950
964
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
951
965
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
952
966
|
*
|
|
953
|
-
* @
|
|
967
|
+
* @since 1.64
|
|
954
968
|
*/
|
|
955
969
|
action?: (oEvent: Card$ActionEvent) => void;
|
|
956
970
|
|
|
957
|
-
/**
|
|
958
|
-
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
959
|
-
* value is changed.
|
|
960
|
-
*
|
|
961
|
-
* @experimental As of version 1.96.
|
|
962
|
-
*/
|
|
963
|
-
configurationChange?: (oEvent: Card$ConfigurationChangeEvent) => void;
|
|
964
|
-
|
|
965
971
|
/**
|
|
966
972
|
* Fired when the manifest is loaded.
|
|
967
973
|
*
|
|
968
|
-
* @
|
|
974
|
+
* @since 1.72
|
|
969
975
|
*/
|
|
970
976
|
manifestReady?: (oEvent: sap.ui.base.Event) => void;
|
|
971
977
|
|
|
@@ -973,15 +979,13 @@ declare namespace sap {
|
|
|
973
979
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
974
980
|
* filter is changed or data is refreshed.
|
|
975
981
|
*
|
|
976
|
-
* @
|
|
982
|
+
* @since 1.107
|
|
977
983
|
*/
|
|
978
984
|
stateChanged?: (oEvent: sap.ui.base.Event) => void;
|
|
979
985
|
}
|
|
980
986
|
|
|
981
987
|
/**
|
|
982
988
|
* Parameters of the Card#action event.
|
|
983
|
-
*
|
|
984
|
-
* @experimental As of version 1.64.
|
|
985
989
|
*/
|
|
986
990
|
interface Card$ActionEventParameters {
|
|
987
991
|
/**
|
|
@@ -1019,8 +1023,6 @@ declare namespace sap {
|
|
|
1019
1023
|
|
|
1020
1024
|
/**
|
|
1021
1025
|
* Parameters of the Card#configurationChange event.
|
|
1022
|
-
*
|
|
1023
|
-
* @experimental As of version 1.96.
|
|
1024
1026
|
*/
|
|
1025
1027
|
interface Card$ConfigurationChangeEventParameters {
|
|
1026
1028
|
/**
|
|
@@ -1045,15 +1047,11 @@ declare namespace sap {
|
|
|
1045
1047
|
|
|
1046
1048
|
/**
|
|
1047
1049
|
* Parameters of the Card#manifestReady event.
|
|
1048
|
-
*
|
|
1049
|
-
* @experimental As of version 1.72.
|
|
1050
1050
|
*/
|
|
1051
1051
|
interface Card$ManifestReadyEventParameters {}
|
|
1052
1052
|
|
|
1053
1053
|
/**
|
|
1054
1054
|
* Parameters of the Card#stateChanged event.
|
|
1055
|
-
*
|
|
1056
|
-
* @experimental As of version 1.107.
|
|
1057
1055
|
*/
|
|
1058
1056
|
interface Card$StateChangedEventParameters {}
|
|
1059
1057
|
|
|
@@ -1078,6 +1076,14 @@ declare namespace sap {
|
|
|
1078
1076
|
* - Content
|
|
1079
1077
|
* - Data source
|
|
1080
1078
|
* - Possible actions
|
|
1079
|
+
* - Badge (optional) - Since 1.151
|
|
1080
|
+
*
|
|
1081
|
+
* Manifest Badges vs. Programmatic Badges:: Badges can be set in two ways:
|
|
1082
|
+
* - **Manifest Badges:** Defined in `sap.card/badges` array - ideal for backend-driven scenarios where
|
|
1083
|
+
* badge state is known at card definition time
|
|
1084
|
+
* - **Programmatic Badges:** Added via `customData` aggregation using {@link sap.f.cards.CardBadgeCustomData }
|
|
1085
|
+
* - ideal for runtime dynamic scenarios controlled by the host application Both types can coexist
|
|
1086
|
+
* on the same card, allowing combination of backend-defined and host-controlled badges.
|
|
1081
1087
|
*
|
|
1082
1088
|
* The role of the app developer is to integrate the card into the app and define:
|
|
1083
1089
|
* - The dimensions of the card inside a layout of choice, using the `width` and `height` properties
|
|
@@ -1190,7 +1196,7 @@ declare namespace sap {
|
|
|
1190
1196
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
1191
1197
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
1192
1198
|
*
|
|
1193
|
-
* @
|
|
1199
|
+
* @since 1.64
|
|
1194
1200
|
*
|
|
1195
1201
|
* @returns Reference to `this` in order to allow method chaining
|
|
1196
1202
|
*/
|
|
@@ -1221,7 +1227,7 @@ declare namespace sap {
|
|
|
1221
1227
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
1222
1228
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
1223
1229
|
*
|
|
1224
|
-
* @
|
|
1230
|
+
* @since 1.64
|
|
1225
1231
|
*
|
|
1226
1232
|
* @returns Reference to `this` in order to allow method chaining
|
|
1227
1233
|
*/
|
|
@@ -1235,59 +1241,6 @@ declare namespace sap {
|
|
|
1235
1241
|
*/
|
|
1236
1242
|
oListener?: object
|
|
1237
1243
|
): this;
|
|
1238
|
-
/**
|
|
1239
|
-
* Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
|
|
1240
|
-
* of this `sap.ui.integration.widgets.Card`.
|
|
1241
|
-
*
|
|
1242
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1243
|
-
* otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
|
|
1244
|
-
*
|
|
1245
|
-
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
1246
|
-
* value is changed.
|
|
1247
|
-
*
|
|
1248
|
-
* @experimental As of version 1.96.
|
|
1249
|
-
*
|
|
1250
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1251
|
-
*/
|
|
1252
|
-
attachConfigurationChange(
|
|
1253
|
-
/**
|
|
1254
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1255
|
-
* object when firing the event
|
|
1256
|
-
*/
|
|
1257
|
-
oData: object,
|
|
1258
|
-
/**
|
|
1259
|
-
* The function to be called when the event occurs
|
|
1260
|
-
*/
|
|
1261
|
-
fnFunction: (p1: Card$ConfigurationChangeEvent) => void,
|
|
1262
|
-
/**
|
|
1263
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
|
|
1264
|
-
*/
|
|
1265
|
-
oListener?: object
|
|
1266
|
-
): this;
|
|
1267
|
-
/**
|
|
1268
|
-
* Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
|
|
1269
|
-
* of this `sap.ui.integration.widgets.Card`.
|
|
1270
|
-
*
|
|
1271
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1272
|
-
* otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
|
|
1273
|
-
*
|
|
1274
|
-
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
1275
|
-
* value is changed.
|
|
1276
|
-
*
|
|
1277
|
-
* @experimental As of version 1.96.
|
|
1278
|
-
*
|
|
1279
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1280
|
-
*/
|
|
1281
|
-
attachConfigurationChange(
|
|
1282
|
-
/**
|
|
1283
|
-
* The function to be called when the event occurs
|
|
1284
|
-
*/
|
|
1285
|
-
fnFunction: (p1: Card$ConfigurationChangeEvent) => void,
|
|
1286
|
-
/**
|
|
1287
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
|
|
1288
|
-
*/
|
|
1289
|
-
oListener?: object
|
|
1290
|
-
): this;
|
|
1291
1244
|
/**
|
|
1292
1245
|
* Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
|
|
1293
1246
|
*
|
|
@@ -1296,7 +1249,7 @@ declare namespace sap {
|
|
|
1296
1249
|
*
|
|
1297
1250
|
* Fired when the manifest is loaded.
|
|
1298
1251
|
*
|
|
1299
|
-
* @
|
|
1252
|
+
* @since 1.72
|
|
1300
1253
|
*
|
|
1301
1254
|
* @returns Reference to `this` in order to allow method chaining
|
|
1302
1255
|
*/
|
|
@@ -1323,7 +1276,7 @@ declare namespace sap {
|
|
|
1323
1276
|
*
|
|
1324
1277
|
* Fired when the manifest is loaded.
|
|
1325
1278
|
*
|
|
1326
|
-
* @
|
|
1279
|
+
* @since 1.72
|
|
1327
1280
|
*
|
|
1328
1281
|
* @returns Reference to `this` in order to allow method chaining
|
|
1329
1282
|
*/
|
|
@@ -1346,7 +1299,7 @@ declare namespace sap {
|
|
|
1346
1299
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1347
1300
|
* filter is changed or data is refreshed.
|
|
1348
1301
|
*
|
|
1349
|
-
* @
|
|
1302
|
+
* @since 1.107
|
|
1350
1303
|
*
|
|
1351
1304
|
* @returns Reference to `this` in order to allow method chaining
|
|
1352
1305
|
*/
|
|
@@ -1374,7 +1327,7 @@ declare namespace sap {
|
|
|
1374
1327
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1375
1328
|
* filter is changed or data is refreshed.
|
|
1376
1329
|
*
|
|
1377
|
-
* @
|
|
1330
|
+
* @since 1.107
|
|
1378
1331
|
*
|
|
1379
1332
|
* @returns Reference to `this` in order to allow method chaining
|
|
1380
1333
|
*/
|
|
@@ -1401,7 +1354,7 @@ declare namespace sap {
|
|
|
1401
1354
|
*
|
|
1402
1355
|
* The passed function and listener object must match the ones used for event registration.
|
|
1403
1356
|
*
|
|
1404
|
-
* @
|
|
1357
|
+
* @since 1.64
|
|
1405
1358
|
*
|
|
1406
1359
|
* @returns Reference to `this` in order to allow method chaining
|
|
1407
1360
|
*/
|
|
@@ -1415,33 +1368,13 @@ declare namespace sap {
|
|
|
1415
1368
|
*/
|
|
1416
1369
|
oListener?: object
|
|
1417
1370
|
): this;
|
|
1418
|
-
/**
|
|
1419
|
-
* Detaches event handler `fnFunction` from the {@link #event:configurationChange configurationChange} event
|
|
1420
|
-
* of this `sap.ui.integration.widgets.Card`.
|
|
1421
|
-
*
|
|
1422
|
-
* The passed function and listener object must match the ones used for event registration.
|
|
1423
|
-
*
|
|
1424
|
-
* @experimental As of version 1.96.
|
|
1425
|
-
*
|
|
1426
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1427
|
-
*/
|
|
1428
|
-
detachConfigurationChange(
|
|
1429
|
-
/**
|
|
1430
|
-
* The function to be called, when the event occurs
|
|
1431
|
-
*/
|
|
1432
|
-
fnFunction: (p1: Card$ConfigurationChangeEvent) => void,
|
|
1433
|
-
/**
|
|
1434
|
-
* Context object on which the given function had to be called
|
|
1435
|
-
*/
|
|
1436
|
-
oListener?: object
|
|
1437
|
-
): this;
|
|
1438
1371
|
/**
|
|
1439
1372
|
* Detaches event handler `fnFunction` from the {@link #event:manifestReady manifestReady} event of this
|
|
1440
1373
|
* `sap.ui.integration.widgets.Card`.
|
|
1441
1374
|
*
|
|
1442
1375
|
* The passed function and listener object must match the ones used for event registration.
|
|
1443
1376
|
*
|
|
1444
|
-
* @
|
|
1377
|
+
* @since 1.72
|
|
1445
1378
|
*
|
|
1446
1379
|
* @returns Reference to `this` in order to allow method chaining
|
|
1447
1380
|
*/
|
|
@@ -1460,7 +1393,7 @@ declare namespace sap {
|
|
|
1460
1393
|
*
|
|
1461
1394
|
* The passed function and listener object must match the ones used for event registration.
|
|
1462
1395
|
*
|
|
1463
|
-
* @
|
|
1396
|
+
* @since 1.107
|
|
1464
1397
|
*
|
|
1465
1398
|
* @returns Reference to `this` in order to allow method chaining
|
|
1466
1399
|
*/
|
|
@@ -1480,7 +1413,7 @@ declare namespace sap {
|
|
|
1480
1413
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
1481
1414
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
1482
1415
|
*
|
|
1483
|
-
* @
|
|
1416
|
+
* @since 1.64
|
|
1484
1417
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1485
1418
|
*
|
|
1486
1419
|
* @returns Whether or not to prevent the default action
|
|
@@ -1491,24 +1424,10 @@ declare namespace sap {
|
|
|
1491
1424
|
*/
|
|
1492
1425
|
mParameters?: sap.ui.integration.widgets.Card$ActionEventParameters
|
|
1493
1426
|
): boolean;
|
|
1494
|
-
/**
|
|
1495
|
-
* Fires event {@link #event:configurationChange configurationChange} to attached listeners.
|
|
1496
|
-
*
|
|
1497
|
-
* @experimental As of version 1.96.
|
|
1498
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1499
|
-
*
|
|
1500
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1501
|
-
*/
|
|
1502
|
-
fireConfigurationChange(
|
|
1503
|
-
/**
|
|
1504
|
-
* Parameters to pass along with the event
|
|
1505
|
-
*/
|
|
1506
|
-
mParameters?: sap.ui.integration.widgets.Card$ConfigurationChangeEventParameters
|
|
1507
|
-
): this;
|
|
1508
1427
|
/**
|
|
1509
1428
|
* Fires event {@link #event:manifestReady manifestReady} to attached listeners.
|
|
1510
1429
|
*
|
|
1511
|
-
* @
|
|
1430
|
+
* @since 1.72
|
|
1512
1431
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1513
1432
|
*
|
|
1514
1433
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -1522,7 +1441,7 @@ declare namespace sap {
|
|
|
1522
1441
|
/**
|
|
1523
1442
|
* Fires event {@link #event:stateChanged stateChanged} to attached listeners.
|
|
1524
1443
|
*
|
|
1525
|
-
* @
|
|
1444
|
+
* @since 1.107
|
|
1526
1445
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1527
1446
|
*
|
|
1528
1447
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -1576,11 +1495,30 @@ declare namespace sap {
|
|
|
1576
1495
|
*
|
|
1577
1496
|
* - Use when developing a Component card.
|
|
1578
1497
|
*
|
|
1498
|
+
* @deprecated As of version 1.152. Use `getResolvedParameters()` instead.
|
|
1579
1499
|
* @experimental As of version 1.77.
|
|
1580
1500
|
*
|
|
1581
1501
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
1582
1502
|
*/
|
|
1583
1503
|
getCombinedParameters(): Record<string, any>;
|
|
1504
|
+
/**
|
|
1505
|
+
* Returns the context paths that the card depends on.
|
|
1506
|
+
*
|
|
1507
|
+
* Scans the `sap.card` section of the manifest for context model references and returns a deduplicated
|
|
1508
|
+
* array of the context paths found.
|
|
1509
|
+
*
|
|
1510
|
+
* Must be called after the manifest is ready (for example, in the `manifestReady` event handler).
|
|
1511
|
+
*
|
|
1512
|
+
* **Limitation:** Only context references directly in the manifest are detected. Context referenced from
|
|
1513
|
+
* inside an extension or component will not be returned. If context needs to be used from an extension,
|
|
1514
|
+
* assign it to a parameter first.
|
|
1515
|
+
*
|
|
1516
|
+
* @since 1.151
|
|
1517
|
+
*
|
|
1518
|
+
* @returns An array of context paths found in the manifest (for example, `["/sample/currentUser/id", "/sample/supplier/id/value"]`).
|
|
1519
|
+
* Returns an empty array if no context dependencies are found or if the manifest is not ready.
|
|
1520
|
+
*/
|
|
1521
|
+
getContextDependencies(): string[];
|
|
1584
1522
|
/**
|
|
1585
1523
|
* Gets current value of property {@link #getDataMode dataMode}.
|
|
1586
1524
|
*
|
|
@@ -1620,7 +1558,7 @@ declare namespace sap {
|
|
|
1620
1558
|
/**
|
|
1621
1559
|
* Gets the instance of the `host` association.
|
|
1622
1560
|
*
|
|
1623
|
-
* @
|
|
1561
|
+
* @since 1.77
|
|
1624
1562
|
*
|
|
1625
1563
|
* @returns The host object associated with this card.
|
|
1626
1564
|
*/
|
|
@@ -1672,11 +1610,9 @@ declare namespace sap {
|
|
|
1672
1610
|
* ```
|
|
1673
1611
|
*
|
|
1674
1612
|
*
|
|
1675
|
-
* Disclaimer: this API might be removed when a permanent solution for flexibility changes is implemented.
|
|
1676
|
-
*
|
|
1677
1613
|
* Default value is `[]`.
|
|
1678
1614
|
*
|
|
1679
|
-
* @
|
|
1615
|
+
* @since 1.76
|
|
1680
1616
|
*
|
|
1681
1617
|
* @returns Value of property `manifestChanges`
|
|
1682
1618
|
*/
|
|
@@ -1686,7 +1622,7 @@ declare namespace sap {
|
|
|
1686
1622
|
*
|
|
1687
1623
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
1688
1624
|
*
|
|
1689
|
-
* @
|
|
1625
|
+
* @since 1.77
|
|
1690
1626
|
*
|
|
1691
1627
|
* @returns The value at the specified path.
|
|
1692
1628
|
*/
|
|
@@ -1717,7 +1653,7 @@ declare namespace sap {
|
|
|
1717
1653
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
1718
1654
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
1719
1655
|
*
|
|
1720
|
-
* @
|
|
1656
|
+
* @since 1.65
|
|
1721
1657
|
*
|
|
1722
1658
|
* @returns Value of property `parameters`
|
|
1723
1659
|
*/
|
|
@@ -1751,6 +1687,20 @@ declare namespace sap {
|
|
|
1751
1687
|
* @returns Value of property `referenceId`
|
|
1752
1688
|
*/
|
|
1753
1689
|
getReferenceId(): string;
|
|
1690
|
+
/**
|
|
1691
|
+
* Gets values of manifest parameters combined with the parameters from `parameters` property.
|
|
1692
|
+
*
|
|
1693
|
+
* **Notes**
|
|
1694
|
+
*
|
|
1695
|
+
* - Use this method when the manifest is ready. Check `manifestReady` event.
|
|
1696
|
+
*
|
|
1697
|
+
* - Use when developing a Component card.
|
|
1698
|
+
*
|
|
1699
|
+
* @since 1.152
|
|
1700
|
+
*
|
|
1701
|
+
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
1702
|
+
*/
|
|
1703
|
+
getResolvedParameters(): Record<string, any>;
|
|
1754
1704
|
/**
|
|
1755
1705
|
* Gets translated text from the i18n properties files configured for this card.
|
|
1756
1706
|
*
|
|
@@ -1808,7 +1758,8 @@ declare namespace sap {
|
|
|
1808
1758
|
eCardArea?: sap.ui.integration.CardArea
|
|
1809
1759
|
): void;
|
|
1810
1760
|
/**
|
|
1811
|
-
* Hides the message previously shown by showMessage.
|
|
1761
|
+
* Hides the message previously shown by {@link sap.ui.integration.widgets.Card#showMessage showMessage}.
|
|
1762
|
+
* Can be used only after the `manifestApplied` event is fired.
|
|
1812
1763
|
*
|
|
1813
1764
|
* @experimental As of version 1.117.
|
|
1814
1765
|
*/
|
|
@@ -1847,7 +1798,11 @@ declare namespace sap {
|
|
|
1847
1798
|
iIndex: int
|
|
1848
1799
|
): this;
|
|
1849
1800
|
/**
|
|
1850
|
-
*
|
|
1801
|
+
* Checks if the card is ready.
|
|
1802
|
+
*
|
|
1803
|
+
* The card is ready when all of its content, header, filters and data are loaded and rendered.
|
|
1804
|
+
*
|
|
1805
|
+
* @since 1.65
|
|
1851
1806
|
*
|
|
1852
1807
|
* @returns If the card is ready or not.
|
|
1853
1808
|
*/
|
|
@@ -1860,7 +1815,7 @@ declare namespace sap {
|
|
|
1860
1815
|
* the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
|
|
1861
1816
|
* error: "Card.designtime not found" }
|
|
1862
1817
|
*
|
|
1863
|
-
* @
|
|
1818
|
+
* @since 1.73
|
|
1864
1819
|
*
|
|
1865
1820
|
* @returns Promise resolves after the designtime configuration is loaded.
|
|
1866
1821
|
*/
|
|
@@ -1868,7 +1823,7 @@ declare namespace sap {
|
|
|
1868
1823
|
/**
|
|
1869
1824
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
1870
1825
|
*
|
|
1871
|
-
* @
|
|
1826
|
+
* @since 1.65
|
|
1872
1827
|
*/
|
|
1873
1828
|
refresh(): void;
|
|
1874
1829
|
/**
|
|
@@ -2106,13 +2061,11 @@ declare namespace sap {
|
|
|
2106
2061
|
* ```
|
|
2107
2062
|
*
|
|
2108
2063
|
*
|
|
2109
|
-
* Disclaimer: this API might be removed when a permanent solution for flexibility changes is implemented.
|
|
2110
|
-
*
|
|
2111
2064
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2112
2065
|
*
|
|
2113
2066
|
* Default value is `[]`.
|
|
2114
2067
|
*
|
|
2115
|
-
* @
|
|
2068
|
+
* @since 1.76
|
|
2116
2069
|
*
|
|
2117
2070
|
* @returns Reference to `this` in order to allow method chaining
|
|
2118
2071
|
*/
|
|
@@ -2152,7 +2105,7 @@ declare namespace sap {
|
|
|
2152
2105
|
*
|
|
2153
2106
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2154
2107
|
*
|
|
2155
|
-
* @
|
|
2108
|
+
* @since 1.65
|
|
2156
2109
|
*
|
|
2157
2110
|
* @returns Reference to `this` in order to allow method chaining
|
|
2158
2111
|
*/
|
|
@@ -2291,7 +2244,7 @@ declare namespace sap {
|
|
|
2291
2244
|
* ```
|
|
2292
2245
|
*
|
|
2293
2246
|
*
|
|
2294
|
-
* @
|
|
2247
|
+
* @since 1.84
|
|
2295
2248
|
*/
|
|
2296
2249
|
triggerAction(
|
|
2297
2250
|
/**
|
|
@@ -2311,7 +2264,7 @@ declare namespace sap {
|
|
|
2311
2264
|
/**
|
|
2312
2265
|
* Causes all the controls within the Card that support validation to validate their data.
|
|
2313
2266
|
*
|
|
2314
|
-
* @
|
|
2267
|
+
* @since 1.106
|
|
2315
2268
|
*
|
|
2316
2269
|
* @returns if all the controls validated successfully; otherwise, false
|
|
2317
2270
|
*/
|
|
@@ -2320,8 +2273,6 @@ declare namespace sap {
|
|
|
2320
2273
|
|
|
2321
2274
|
/**
|
|
2322
2275
|
* Event object of the Card#action event.
|
|
2323
|
-
*
|
|
2324
|
-
* @experimental As of version 1.64.
|
|
2325
2276
|
*/
|
|
2326
2277
|
type Card$ActionEvent = sap.ui.base.Event<
|
|
2327
2278
|
Card$ActionEventParameters,
|
|
@@ -2330,8 +2281,6 @@ declare namespace sap {
|
|
|
2330
2281
|
|
|
2331
2282
|
/**
|
|
2332
2283
|
* Event object of the Card#configurationChange event.
|
|
2333
|
-
*
|
|
2334
|
-
* @experimental As of version 1.96.
|
|
2335
2284
|
*/
|
|
2336
2285
|
type Card$ConfigurationChangeEvent = sap.ui.base.Event<
|
|
2337
2286
|
Card$ConfigurationChangeEventParameters,
|
|
@@ -2348,8 +2297,6 @@ declare namespace sap {
|
|
|
2348
2297
|
|
|
2349
2298
|
/**
|
|
2350
2299
|
* Event object of the Card#manifestReady event.
|
|
2351
|
-
*
|
|
2352
|
-
* @experimental As of version 1.72.
|
|
2353
2300
|
*/
|
|
2354
2301
|
type Card$ManifestReadyEvent = sap.ui.base.Event<
|
|
2355
2302
|
Card$ManifestReadyEventParameters,
|
|
@@ -2358,8 +2305,6 @@ declare namespace sap {
|
|
|
2358
2305
|
|
|
2359
2306
|
/**
|
|
2360
2307
|
* Event object of the Card#stateChanged event.
|
|
2361
|
-
*
|
|
2362
|
-
* @experimental As of version 1.107.
|
|
2363
2308
|
*/
|
|
2364
2309
|
type Card$StateChangedEvent = sap.ui.base.Event<
|
|
2365
2310
|
Card$StateChangedEventParameters,
|
|
@@ -2477,7 +2422,7 @@ declare namespace sap {
|
|
|
2477
2422
|
/**
|
|
2478
2423
|
* The formatters that can be used in the manifest.
|
|
2479
2424
|
*
|
|
2480
|
-
* @
|
|
2425
|
+
* @since 1.79
|
|
2481
2426
|
*/
|
|
2482
2427
|
formatters?:
|
|
2483
2428
|
| object
|
|
@@ -2491,7 +2436,7 @@ declare namespace sap {
|
|
|
2491
2436
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2492
2437
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2493
2438
|
*
|
|
2494
|
-
* @
|
|
2439
|
+
* @since 1.75
|
|
2495
2440
|
*/
|
|
2496
2441
|
action?: (oEvent: Extension$ActionEvent) => void;
|
|
2497
2442
|
}
|
|
@@ -2533,25 +2478,15 @@ declare namespace sap {
|
|
|
2533
2478
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2534
2479
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2535
2480
|
*
|
|
2536
|
-
* @
|
|
2481
|
+
* @since 1.75
|
|
2537
2482
|
*/
|
|
2538
2483
|
action?: (oEvent: Host$ActionEvent) => void;
|
|
2539
2484
|
|
|
2540
|
-
/**
|
|
2541
|
-
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
2542
|
-
* - filter value is changed.
|
|
2543
|
-
*
|
|
2544
|
-
* @experimental As of version 1.96.
|
|
2545
|
-
*/
|
|
2546
|
-
cardConfigurationChange?: (
|
|
2547
|
-
oEvent: Host$CardConfigurationChangeEvent
|
|
2548
|
-
) => void;
|
|
2549
|
-
|
|
2550
2485
|
/**
|
|
2551
2486
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
2552
2487
|
* the card, a filter is changed or data is refreshed.
|
|
2553
2488
|
*
|
|
2554
|
-
* @
|
|
2489
|
+
* @since 1.107
|
|
2555
2490
|
*/
|
|
2556
2491
|
cardStateChanged?: (oEvent: Host$CardStateChangedEvent) => void;
|
|
2557
2492
|
|
|
@@ -2559,7 +2494,7 @@ declare namespace sap {
|
|
|
2559
2494
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
2560
2495
|
* or data changes.
|
|
2561
2496
|
*
|
|
2562
|
-
* @
|
|
2497
|
+
* @since 1.116
|
|
2563
2498
|
*/
|
|
2564
2499
|
cardInitialized?: (oEvent: Host$CardInitializedEvent) => void;
|
|
2565
2500
|
|
|
@@ -2578,8 +2513,6 @@ declare namespace sap {
|
|
|
2578
2513
|
|
|
2579
2514
|
/**
|
|
2580
2515
|
* Parameters of the Extension#action event.
|
|
2581
|
-
*
|
|
2582
|
-
* @experimental As of version 1.75.
|
|
2583
2516
|
*/
|
|
2584
2517
|
interface Extension$ActionEventParameters {
|
|
2585
2518
|
/**
|
|
@@ -2622,8 +2555,6 @@ declare namespace sap {
|
|
|
2622
2555
|
|
|
2623
2556
|
/**
|
|
2624
2557
|
* Parameters of the Host#action event.
|
|
2625
|
-
*
|
|
2626
|
-
* @experimental As of version 1.75.
|
|
2627
2558
|
*/
|
|
2628
2559
|
interface Host$ActionEventParameters {
|
|
2629
2560
|
/**
|
|
@@ -2666,8 +2597,6 @@ declare namespace sap {
|
|
|
2666
2597
|
|
|
2667
2598
|
/**
|
|
2668
2599
|
* Parameters of the Host#cardConfigurationChange event.
|
|
2669
|
-
*
|
|
2670
|
-
* @experimental As of version 1.96.
|
|
2671
2600
|
*/
|
|
2672
2601
|
interface Host$CardConfigurationChangeEventParameters {
|
|
2673
2602
|
/**
|
|
@@ -2692,8 +2621,6 @@ declare namespace sap {
|
|
|
2692
2621
|
|
|
2693
2622
|
/**
|
|
2694
2623
|
* Parameters of the Host#cardInitialized event.
|
|
2695
|
-
*
|
|
2696
|
-
* @experimental As of version 1.116.
|
|
2697
2624
|
*/
|
|
2698
2625
|
interface Host$CardInitializedEventParameters {
|
|
2699
2626
|
/**
|
|
@@ -2704,8 +2631,6 @@ declare namespace sap {
|
|
|
2704
2631
|
|
|
2705
2632
|
/**
|
|
2706
2633
|
* Parameters of the Host#cardStateChanged event.
|
|
2707
|
-
*
|
|
2708
|
-
* @experimental As of version 1.107.
|
|
2709
2634
|
*/
|
|
2710
2635
|
interface Host$CardStateChangedEventParameters {
|
|
2711
2636
|
/**
|
|
@@ -3343,7 +3268,7 @@ declare namespace sap {
|
|
|
3343
3268
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3344
3269
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3345
3270
|
*
|
|
3346
|
-
* @
|
|
3271
|
+
* @since 1.75
|
|
3347
3272
|
*
|
|
3348
3273
|
* @returns Reference to `this` in order to allow method chaining
|
|
3349
3274
|
*/
|
|
@@ -3374,7 +3299,7 @@ declare namespace sap {
|
|
|
3374
3299
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3375
3300
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3376
3301
|
*
|
|
3377
|
-
* @
|
|
3302
|
+
* @since 1.75
|
|
3378
3303
|
*
|
|
3379
3304
|
* @returns Reference to `this` in order to allow method chaining
|
|
3380
3305
|
*/
|
|
@@ -3393,7 +3318,7 @@ declare namespace sap {
|
|
|
3393
3318
|
*
|
|
3394
3319
|
* The passed function and listener object must match the ones used for event registration.
|
|
3395
3320
|
*
|
|
3396
|
-
* @
|
|
3321
|
+
* @since 1.75
|
|
3397
3322
|
*
|
|
3398
3323
|
* @returns Reference to `this` in order to allow method chaining
|
|
3399
3324
|
*/
|
|
@@ -3407,37 +3332,13 @@ declare namespace sap {
|
|
|
3407
3332
|
*/
|
|
3408
3333
|
oListener?: object
|
|
3409
3334
|
): this;
|
|
3410
|
-
/**
|
|
3411
|
-
* Starts the process of fetching a resource from the network, returning a promise that is fulfilled once
|
|
3412
|
-
* the response is available. Use this method to override the default behavior when fetching network resources.
|
|
3413
|
-
* Mimics the browser native Fetch API.
|
|
3414
|
-
*
|
|
3415
|
-
* @experimental As of version 1.113.
|
|
3416
|
-
*
|
|
3417
|
-
* @returns A `Promise` that resolves to a `Response` object.
|
|
3418
|
-
*/
|
|
3419
|
-
fetch(
|
|
3420
|
-
/**
|
|
3421
|
-
* This defines the resource that you wish to fetch.
|
|
3422
|
-
*/
|
|
3423
|
-
sResource: string,
|
|
3424
|
-
/**
|
|
3425
|
-
* An object containing any custom settings that you want to apply to the request.
|
|
3426
|
-
*/
|
|
3427
|
-
mOptions: object,
|
|
3428
|
-
/**
|
|
3429
|
-
* The map of request settings defined in the card manifest. Use this only for reading, they can not be
|
|
3430
|
-
* modified.
|
|
3431
|
-
*/
|
|
3432
|
-
mRequestSettings: object
|
|
3433
|
-
): Promise<Response>;
|
|
3434
3335
|
/**
|
|
3435
3336
|
* Fires event {@link #event:action action} to attached listeners.
|
|
3436
3337
|
*
|
|
3437
3338
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3438
3339
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3439
3340
|
*
|
|
3440
|
-
* @
|
|
3341
|
+
* @since 1.75
|
|
3441
3342
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3442
3343
|
*
|
|
3443
3344
|
* @returns Whether or not to prevent the default action
|
|
@@ -3477,10 +3378,14 @@ declare namespace sap {
|
|
|
3477
3378
|
/**
|
|
3478
3379
|
* Override this method to lazy load dependencies for the extension.
|
|
3479
3380
|
*
|
|
3480
|
-
*
|
|
3381
|
+
* The card waits for the returned promise to resolve before it continues with its initialization. If the
|
|
3382
|
+
* promise is rejected, the card initialization fails and an error message is shown.
|
|
3481
3383
|
*
|
|
3482
|
-
*
|
|
3483
|
-
*
|
|
3384
|
+
* The default implementation loads no dependencies and returns an already resolved promise.
|
|
3385
|
+
*
|
|
3386
|
+
* @since 1.108
|
|
3387
|
+
*
|
|
3388
|
+
* @returns A promise which resolves when all dependencies of the extension are loaded.
|
|
3484
3389
|
*/
|
|
3485
3390
|
loadDependencies(): Promise<any>;
|
|
3486
3391
|
/**
|
|
@@ -3602,7 +3507,7 @@ declare namespace sap {
|
|
|
3602
3507
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3603
3508
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3604
3509
|
*
|
|
3605
|
-
* @
|
|
3510
|
+
* @since 1.75
|
|
3606
3511
|
*
|
|
3607
3512
|
* @returns Reference to `this` in order to allow method chaining
|
|
3608
3513
|
*/
|
|
@@ -3633,7 +3538,7 @@ declare namespace sap {
|
|
|
3633
3538
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3634
3539
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3635
3540
|
*
|
|
3636
|
-
* @
|
|
3541
|
+
* @since 1.75
|
|
3637
3542
|
*
|
|
3638
3543
|
* @returns Reference to `this` in order to allow method chaining
|
|
3639
3544
|
*/
|
|
@@ -3647,59 +3552,6 @@ declare namespace sap {
|
|
|
3647
3552
|
*/
|
|
3648
3553
|
oListener?: object
|
|
3649
3554
|
): this;
|
|
3650
|
-
/**
|
|
3651
|
-
* Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3652
|
-
* event of this `sap.ui.integration.Host`.
|
|
3653
|
-
*
|
|
3654
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3655
|
-
* otherwise it will be bound to this `sap.ui.integration.Host` itself.
|
|
3656
|
-
*
|
|
3657
|
-
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3658
|
-
* - filter value is changed.
|
|
3659
|
-
*
|
|
3660
|
-
* @experimental As of version 1.96.
|
|
3661
|
-
*
|
|
3662
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
3663
|
-
*/
|
|
3664
|
-
attachCardConfigurationChange(
|
|
3665
|
-
/**
|
|
3666
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
3667
|
-
* object when firing the event
|
|
3668
|
-
*/
|
|
3669
|
-
oData: object,
|
|
3670
|
-
/**
|
|
3671
|
-
* The function to be called when the event occurs
|
|
3672
|
-
*/
|
|
3673
|
-
fnFunction: (p1: Host$CardConfigurationChangeEvent) => void,
|
|
3674
|
-
/**
|
|
3675
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
|
|
3676
|
-
*/
|
|
3677
|
-
oListener?: object
|
|
3678
|
-
): this;
|
|
3679
|
-
/**
|
|
3680
|
-
* Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3681
|
-
* event of this `sap.ui.integration.Host`.
|
|
3682
|
-
*
|
|
3683
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
3684
|
-
* otherwise it will be bound to this `sap.ui.integration.Host` itself.
|
|
3685
|
-
*
|
|
3686
|
-
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3687
|
-
* - filter value is changed.
|
|
3688
|
-
*
|
|
3689
|
-
* @experimental As of version 1.96.
|
|
3690
|
-
*
|
|
3691
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
3692
|
-
*/
|
|
3693
|
-
attachCardConfigurationChange(
|
|
3694
|
-
/**
|
|
3695
|
-
* The function to be called when the event occurs
|
|
3696
|
-
*/
|
|
3697
|
-
fnFunction: (p1: Host$CardConfigurationChangeEvent) => void,
|
|
3698
|
-
/**
|
|
3699
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
|
|
3700
|
-
*/
|
|
3701
|
-
oListener?: object
|
|
3702
|
-
): this;
|
|
3703
3555
|
/**
|
|
3704
3556
|
* Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
|
|
3705
3557
|
* `sap.ui.integration.Host`.
|
|
@@ -3710,7 +3562,7 @@ declare namespace sap {
|
|
|
3710
3562
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3711
3563
|
* or data changes.
|
|
3712
3564
|
*
|
|
3713
|
-
* @
|
|
3565
|
+
* @since 1.116
|
|
3714
3566
|
*
|
|
3715
3567
|
* @returns Reference to `this` in order to allow method chaining
|
|
3716
3568
|
*/
|
|
@@ -3739,7 +3591,7 @@ declare namespace sap {
|
|
|
3739
3591
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3740
3592
|
* or data changes.
|
|
3741
3593
|
*
|
|
3742
|
-
* @
|
|
3594
|
+
* @since 1.116
|
|
3743
3595
|
*
|
|
3744
3596
|
* @returns Reference to `this` in order to allow method chaining
|
|
3745
3597
|
*/
|
|
@@ -3763,7 +3615,7 @@ declare namespace sap {
|
|
|
3763
3615
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3764
3616
|
* the card, a filter is changed or data is refreshed.
|
|
3765
3617
|
*
|
|
3766
|
-
* @
|
|
3618
|
+
* @since 1.107
|
|
3767
3619
|
*
|
|
3768
3620
|
* @returns Reference to `this` in order to allow method chaining
|
|
3769
3621
|
*/
|
|
@@ -3792,7 +3644,7 @@ declare namespace sap {
|
|
|
3792
3644
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3793
3645
|
* the card, a filter is changed or data is refreshed.
|
|
3794
3646
|
*
|
|
3795
|
-
* @
|
|
3647
|
+
* @since 1.107
|
|
3796
3648
|
*
|
|
3797
3649
|
* @returns Reference to `this` in order to allow method chaining
|
|
3798
3650
|
*/
|
|
@@ -3890,7 +3742,7 @@ declare namespace sap {
|
|
|
3890
3742
|
*
|
|
3891
3743
|
* The passed function and listener object must match the ones used for event registration.
|
|
3892
3744
|
*
|
|
3893
|
-
* @
|
|
3745
|
+
* @since 1.75
|
|
3894
3746
|
*
|
|
3895
3747
|
* @returns Reference to `this` in order to allow method chaining
|
|
3896
3748
|
*/
|
|
@@ -3904,33 +3756,13 @@ declare namespace sap {
|
|
|
3904
3756
|
*/
|
|
3905
3757
|
oListener?: object
|
|
3906
3758
|
): this;
|
|
3907
|
-
/**
|
|
3908
|
-
* Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange }
|
|
3909
|
-
* event of this `sap.ui.integration.Host`.
|
|
3910
|
-
*
|
|
3911
|
-
* The passed function and listener object must match the ones used for event registration.
|
|
3912
|
-
*
|
|
3913
|
-
* @experimental As of version 1.96.
|
|
3914
|
-
*
|
|
3915
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
3916
|
-
*/
|
|
3917
|
-
detachCardConfigurationChange(
|
|
3918
|
-
/**
|
|
3919
|
-
* The function to be called, when the event occurs
|
|
3920
|
-
*/
|
|
3921
|
-
fnFunction: (p1: Host$CardConfigurationChangeEvent) => void,
|
|
3922
|
-
/**
|
|
3923
|
-
* Context object on which the given function had to be called
|
|
3924
|
-
*/
|
|
3925
|
-
oListener?: object
|
|
3926
|
-
): this;
|
|
3927
3759
|
/**
|
|
3928
3760
|
* Detaches event handler `fnFunction` from the {@link #event:cardInitialized cardInitialized} event of
|
|
3929
3761
|
* this `sap.ui.integration.Host`.
|
|
3930
3762
|
*
|
|
3931
3763
|
* The passed function and listener object must match the ones used for event registration.
|
|
3932
3764
|
*
|
|
3933
|
-
* @
|
|
3765
|
+
* @since 1.116
|
|
3934
3766
|
*
|
|
3935
3767
|
* @returns Reference to `this` in order to allow method chaining
|
|
3936
3768
|
*/
|
|
@@ -3950,7 +3782,7 @@ declare namespace sap {
|
|
|
3950
3782
|
*
|
|
3951
3783
|
* The passed function and listener object must match the ones used for event registration.
|
|
3952
3784
|
*
|
|
3953
|
-
* @
|
|
3785
|
+
* @since 1.107
|
|
3954
3786
|
*
|
|
3955
3787
|
* @returns Reference to `this` in order to allow method chaining
|
|
3956
3788
|
*/
|
|
@@ -3989,7 +3821,7 @@ declare namespace sap {
|
|
|
3989
3821
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3990
3822
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3991
3823
|
*
|
|
3992
|
-
* @
|
|
3824
|
+
* @since 1.75
|
|
3993
3825
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3994
3826
|
*
|
|
3995
3827
|
* @returns Whether or not to prevent the default action
|
|
@@ -4000,24 +3832,10 @@ declare namespace sap {
|
|
|
4000
3832
|
*/
|
|
4001
3833
|
mParameters?: sap.ui.integration.Host$ActionEventParameters
|
|
4002
3834
|
): boolean;
|
|
4003
|
-
/**
|
|
4004
|
-
* Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
|
|
4005
|
-
*
|
|
4006
|
-
* @experimental As of version 1.96.
|
|
4007
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4008
|
-
*
|
|
4009
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
4010
|
-
*/
|
|
4011
|
-
fireCardConfigurationChange(
|
|
4012
|
-
/**
|
|
4013
|
-
* Parameters to pass along with the event
|
|
4014
|
-
*/
|
|
4015
|
-
mParameters?: sap.ui.integration.Host$CardConfigurationChangeEventParameters
|
|
4016
|
-
): this;
|
|
4017
3835
|
/**
|
|
4018
3836
|
* Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
|
|
4019
3837
|
*
|
|
4020
|
-
* @
|
|
3838
|
+
* @since 1.116
|
|
4021
3839
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4022
3840
|
*
|
|
4023
3841
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4031,7 +3849,7 @@ declare namespace sap {
|
|
|
4031
3849
|
/**
|
|
4032
3850
|
* Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
|
|
4033
3851
|
*
|
|
4034
|
-
* @
|
|
3852
|
+
* @since 1.107
|
|
4035
3853
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4036
3854
|
*
|
|
4037
3855
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4078,7 +3896,7 @@ declare namespace sap {
|
|
|
4078
3896
|
* The context information and texts should be translated as they appear in the design-time UI of the Card
|
|
4079
3897
|
* Editor.
|
|
4080
3898
|
*
|
|
4081
|
-
* @
|
|
3899
|
+
* @since 1.143
|
|
4082
3900
|
*
|
|
4083
3901
|
* @returns A promise which contains the context structure.
|
|
4084
3902
|
*/
|
|
@@ -4094,7 +3912,7 @@ declare namespace sap {
|
|
|
4094
3912
|
* Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
|
|
4095
3913
|
* userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
|
|
4096
3914
|
*
|
|
4097
|
-
* @
|
|
3915
|
+
* @since 1.143
|
|
4098
3916
|
*
|
|
4099
3917
|
* @returns A promise which resolves with the value of this context.
|
|
4100
3918
|
*/
|
|
@@ -4216,19 +4034,17 @@ declare namespace sap {
|
|
|
4216
4034
|
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
4217
4035
|
* 'CardActionType'.
|
|
4218
4036
|
*
|
|
4219
|
-
* @
|
|
4037
|
+
* @since 1.64
|
|
4220
4038
|
*/
|
|
4221
4039
|
enum CardActionType {
|
|
4222
4040
|
/**
|
|
4223
4041
|
* Used for custom actions.
|
|
4224
4042
|
*
|
|
4225
|
-
* @
|
|
4043
|
+
* @since 1.76
|
|
4226
4044
|
*/
|
|
4227
4045
|
Custom = "Custom",
|
|
4228
4046
|
/**
|
|
4229
4047
|
* Date selection. Available only for Calendar cards.
|
|
4230
|
-
*
|
|
4231
|
-
* @experimental As of version 1.87.
|
|
4232
4048
|
*/
|
|
4233
4049
|
DateChange = "DateChange",
|
|
4234
4050
|
/**
|
|
@@ -4239,8 +4055,6 @@ declare namespace sap {
|
|
|
4239
4055
|
HideCard = "HideCard",
|
|
4240
4056
|
/**
|
|
4241
4057
|
* Month selection. Available only for Calendar cards.
|
|
4242
|
-
*
|
|
4243
|
-
* @experimental As of version 1.87.
|
|
4244
4058
|
*/
|
|
4245
4059
|
MonthChange = "MonthChange",
|
|
4246
4060
|
/**
|
|
@@ -4558,8 +4372,6 @@ declare namespace sap {
|
|
|
4558
4372
|
|
|
4559
4373
|
/**
|
|
4560
4374
|
* Event object of the Extension#action event.
|
|
4561
|
-
*
|
|
4562
|
-
* @experimental As of version 1.75.
|
|
4563
4375
|
*/
|
|
4564
4376
|
type Extension$ActionEvent = sap.ui.base.Event<
|
|
4565
4377
|
Extension$ActionEventParameters,
|
|
@@ -4568,8 +4380,6 @@ declare namespace sap {
|
|
|
4568
4380
|
|
|
4569
4381
|
/**
|
|
4570
4382
|
* Event object of the Host#action event.
|
|
4571
|
-
*
|
|
4572
|
-
* @experimental As of version 1.75.
|
|
4573
4383
|
*/
|
|
4574
4384
|
type Host$ActionEvent = sap.ui.base.Event<
|
|
4575
4385
|
Host$ActionEventParameters,
|
|
@@ -4578,8 +4388,6 @@ declare namespace sap {
|
|
|
4578
4388
|
|
|
4579
4389
|
/**
|
|
4580
4390
|
* Event object of the Host#cardConfigurationChange event.
|
|
4581
|
-
*
|
|
4582
|
-
* @experimental As of version 1.96.
|
|
4583
4391
|
*/
|
|
4584
4392
|
type Host$CardConfigurationChangeEvent = sap.ui.base.Event<
|
|
4585
4393
|
Host$CardConfigurationChangeEventParameters,
|
|
@@ -4588,8 +4396,6 @@ declare namespace sap {
|
|
|
4588
4396
|
|
|
4589
4397
|
/**
|
|
4590
4398
|
* Event object of the Host#cardInitialized event.
|
|
4591
|
-
*
|
|
4592
|
-
* @experimental As of version 1.116.
|
|
4593
4399
|
*/
|
|
4594
4400
|
type Host$CardInitializedEvent = sap.ui.base.Event<
|
|
4595
4401
|
Host$CardInitializedEventParameters,
|
|
@@ -4598,8 +4404,6 @@ declare namespace sap {
|
|
|
4598
4404
|
|
|
4599
4405
|
/**
|
|
4600
4406
|
* Event object of the Host#cardStateChanged event.
|
|
4601
|
-
*
|
|
4602
|
-
* @experimental As of version 1.107.
|
|
4603
4407
|
*/
|
|
4604
4408
|
type Host$CardStateChangedEvent = sap.ui.base.Event<
|
|
4605
4409
|
Host$CardStateChangedEventParameters,
|