@openui5/ts-types 1.132.1 → 1.133.1
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 +127 -127
- package/types/sap.m.d.ts +1685 -729
- package/types/sap.tnt.d.ts +221 -8
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +267 -266
- package/types/sap.ui.core.d.ts +621 -588
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +3 -3
- package/types/sap.ui.integration.d.ts +317 -230
- package/types/sap.ui.layout.d.ts +69 -69
- package/types/sap.ui.mdc.d.ts +142 -115
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +14 -14
- package/types/sap.ui.support.d.ts +2 -2
- package/types/sap.ui.table.d.ts +209 -185
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +89 -89
- package/types/sap.ui.ux3.d.ts +102 -102
- package/types/sap.ui.webc.common.d.ts +11 -11
- package/types/sap.ui.webc.fiori.d.ts +145 -145
- package/types/sap.ui.webc.main.d.ts +400 -400
- package/types/sap.uxap.d.ts +14 -14
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.133.1
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -16,7 +16,7 @@ declare namespace sap {
|
|
|
16
16
|
* Validates if the provided value belongs to the icon pool.
|
|
17
17
|
*
|
|
18
18
|
* @since 1.81
|
|
19
|
-
* @experimental
|
|
19
|
+
* @experimental 1.81
|
|
20
20
|
*/
|
|
21
21
|
namespace IsInIconPool {
|
|
22
22
|
/**
|
|
@@ -40,7 +40,7 @@ declare namespace sap {
|
|
|
40
40
|
* Validates if the provided value is a boolean or binding string.
|
|
41
41
|
*
|
|
42
42
|
* @since 1.81
|
|
43
|
-
* @experimental
|
|
43
|
+
* @experimental 1.81
|
|
44
44
|
*/
|
|
45
45
|
interface IsBoolean {
|
|
46
46
|
/**
|
|
@@ -61,7 +61,7 @@ declare namespace sap {
|
|
|
61
61
|
* Validates if the provided value can be parsed to a valid date.
|
|
62
62
|
*
|
|
63
63
|
* @since 1.81
|
|
64
|
-
* @experimental
|
|
64
|
+
* @experimental 1.81
|
|
65
65
|
*/
|
|
66
66
|
interface IsDate {
|
|
67
67
|
/**
|
|
@@ -82,7 +82,7 @@ declare namespace sap {
|
|
|
82
82
|
* Validates if the provided value is an integer or binding string.
|
|
83
83
|
*
|
|
84
84
|
* @since 1.81
|
|
85
|
-
* @experimental
|
|
85
|
+
* @experimental 1.81
|
|
86
86
|
*/
|
|
87
87
|
interface IsInteger {
|
|
88
88
|
/**
|
|
@@ -103,7 +103,7 @@ declare namespace sap {
|
|
|
103
103
|
* Validates if the provided value is a number or binding string.
|
|
104
104
|
*
|
|
105
105
|
* @since 1.81
|
|
106
|
-
* @experimental
|
|
106
|
+
* @experimental 1.81
|
|
107
107
|
*/
|
|
108
108
|
interface IsNumber {
|
|
109
109
|
/**
|
|
@@ -124,7 +124,7 @@ declare namespace sap {
|
|
|
124
124
|
* Validates if the provided value is one of the given keys.
|
|
125
125
|
*
|
|
126
126
|
* @since 1.81
|
|
127
|
-
* @experimental
|
|
127
|
+
* @experimental 1.81
|
|
128
128
|
*/
|
|
129
129
|
interface IsSelectedKey {
|
|
130
130
|
/**
|
|
@@ -154,7 +154,7 @@ declare namespace sap {
|
|
|
154
154
|
* Validates if none of the provided values is an invalid binding.
|
|
155
155
|
*
|
|
156
156
|
* @since 1.81
|
|
157
|
-
* @experimental
|
|
157
|
+
* @experimental 1.81
|
|
158
158
|
*/
|
|
159
159
|
interface IsStringList {
|
|
160
160
|
/**
|
|
@@ -175,7 +175,7 @@ declare namespace sap {
|
|
|
175
175
|
* Validates if the provided key is unique in a list of given keys.
|
|
176
176
|
*
|
|
177
177
|
* @since 1.81
|
|
178
|
-
* @experimental
|
|
178
|
+
* @experimental 1.81
|
|
179
179
|
*/
|
|
180
180
|
interface IsUniqueKey {
|
|
181
181
|
/**
|
|
@@ -209,7 +209,7 @@ declare namespace sap {
|
|
|
209
209
|
* Validates if the provided list contains no duplicates.
|
|
210
210
|
*
|
|
211
211
|
* @since 1.81
|
|
212
|
-
* @experimental
|
|
212
|
+
* @experimental 1.81
|
|
213
213
|
*/
|
|
214
214
|
interface IsUniqueList {
|
|
215
215
|
/**
|
|
@@ -230,7 +230,7 @@ declare namespace sap {
|
|
|
230
230
|
* Validates if the provided value is a valid binding.
|
|
231
231
|
*
|
|
232
232
|
* @since 1.81
|
|
233
|
-
* @experimental
|
|
233
|
+
* @experimental 1.81
|
|
234
234
|
*/
|
|
235
235
|
interface IsValidBinding {
|
|
236
236
|
/**
|
|
@@ -260,7 +260,7 @@ declare namespace sap {
|
|
|
260
260
|
* Validates if the provided value doesn't exceed the maximum length.
|
|
261
261
|
*
|
|
262
262
|
* @since 1.81
|
|
263
|
-
* @experimental
|
|
263
|
+
* @experimental 1.81
|
|
264
264
|
*/
|
|
265
265
|
interface MaxLength {
|
|
266
266
|
/**
|
|
@@ -281,7 +281,7 @@ declare namespace sap {
|
|
|
281
281
|
* Validates if the provided value doesn't contain a binding.
|
|
282
282
|
*
|
|
283
283
|
* @since 1.81
|
|
284
|
-
* @experimental
|
|
284
|
+
* @experimental 1.81
|
|
285
285
|
*/
|
|
286
286
|
interface NotABinding {
|
|
287
287
|
/**
|
|
@@ -305,7 +305,7 @@ declare namespace sap {
|
|
|
305
305
|
/**
|
|
306
306
|
* Facade of the {@link sap.ui.integration.editor.Editor} control.
|
|
307
307
|
*
|
|
308
|
-
* @experimental
|
|
308
|
+
* @experimental As of version 1.94.
|
|
309
309
|
*/
|
|
310
310
|
interface EditorFacade {
|
|
311
311
|
__implements__sap_ui_integration_editor_EditorFacade: boolean;
|
|
@@ -313,7 +313,7 @@ declare namespace sap {
|
|
|
313
313
|
/**
|
|
314
314
|
* Performs an HTTP request using the given configuration.
|
|
315
315
|
*
|
|
316
|
-
* @experimental
|
|
316
|
+
* @experimental As of version 1.94.
|
|
317
317
|
*
|
|
318
318
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
319
319
|
*/
|
|
@@ -411,7 +411,7 @@ declare namespace sap {
|
|
|
411
411
|
/**
|
|
412
412
|
* Facade of the {@link sap.ui.integration.widgets.Card} control.
|
|
413
413
|
*
|
|
414
|
-
* @experimental
|
|
414
|
+
* @experimental As of version 1.79.
|
|
415
415
|
*/
|
|
416
416
|
interface CardFacade {
|
|
417
417
|
__implements__sap_ui_integration_widgets_CardFacade: boolean;
|
|
@@ -420,8 +420,8 @@ declare namespace sap {
|
|
|
420
420
|
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
421
421
|
*
|
|
422
422
|
* @since 1.85
|
|
423
|
-
* @experimental
|
|
424
|
-
* may be done before its official public release. Use at your own discretion.
|
|
423
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
424
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
425
425
|
*
|
|
426
426
|
* @returns Reference to `this` in order to allow method chaining
|
|
427
427
|
*/
|
|
@@ -439,7 +439,7 @@ declare namespace sap {
|
|
|
439
439
|
* If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
|
|
440
440
|
*
|
|
441
441
|
* @since 1.70
|
|
442
|
-
* @experimental
|
|
442
|
+
* @experimental As of version 1.70.
|
|
443
443
|
*
|
|
444
444
|
* @returns Value of property `baseUrl`
|
|
445
445
|
*/
|
|
@@ -447,7 +447,7 @@ declare namespace sap {
|
|
|
447
447
|
/**
|
|
448
448
|
* Get information about the blocking message in the card.
|
|
449
449
|
*
|
|
450
|
-
* @experimental
|
|
450
|
+
* @experimental As of version 1.114.
|
|
451
451
|
*
|
|
452
452
|
* @returns Information about the message or `null`, if such isn't shown.
|
|
453
453
|
*/
|
|
@@ -461,7 +461,7 @@ declare namespace sap {
|
|
|
461
461
|
*
|
|
462
462
|
* - Use when developing a Component card.
|
|
463
463
|
*
|
|
464
|
-
* @experimental
|
|
464
|
+
* @experimental As of version 1.77.
|
|
465
465
|
*
|
|
466
466
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
467
467
|
*/
|
|
@@ -471,7 +471,7 @@ declare namespace sap {
|
|
|
471
471
|
*
|
|
472
472
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
473
473
|
*
|
|
474
|
-
* @experimental
|
|
474
|
+
* @experimental As of version 1.77.
|
|
475
475
|
*
|
|
476
476
|
* @returns The value at the specified path.
|
|
477
477
|
*/
|
|
@@ -487,7 +487,7 @@ declare namespace sap {
|
|
|
487
487
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
488
488
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
489
489
|
*
|
|
490
|
-
* @experimental
|
|
490
|
+
* @experimental As of version 1.65. This property might be changed in future.
|
|
491
491
|
*
|
|
492
492
|
* @returns Value of property `parameters`
|
|
493
493
|
*/
|
|
@@ -497,7 +497,7 @@ declare namespace sap {
|
|
|
497
497
|
*
|
|
498
498
|
* For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
|
|
499
499
|
*
|
|
500
|
-
* @experimental
|
|
500
|
+
* @experimental As of version 1.83. The API might change.
|
|
501
501
|
*
|
|
502
502
|
* @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
|
|
503
503
|
* on `bIgnoreKeyFallback`.
|
|
@@ -523,7 +523,7 @@ declare namespace sap {
|
|
|
523
523
|
/**
|
|
524
524
|
* Hide the blocking message that is shown in the card by `showBlockingMessage` call.
|
|
525
525
|
*
|
|
526
|
-
* @experimental
|
|
526
|
+
* @experimental As of version 1.114.
|
|
527
527
|
*/
|
|
528
528
|
hideBlockingMessage(): void;
|
|
529
529
|
/**
|
|
@@ -539,7 +539,7 @@ declare namespace sap {
|
|
|
539
539
|
/**
|
|
540
540
|
* Hides the message previously shown by showMessage.
|
|
541
541
|
*
|
|
542
|
-
* @experimental
|
|
542
|
+
* @experimental As of version 1.117.
|
|
543
543
|
*/
|
|
544
544
|
hideMessage(): void;
|
|
545
545
|
/**
|
|
@@ -547,8 +547,8 @@ declare namespace sap {
|
|
|
547
547
|
* and returns its index if found or -1 otherwise.
|
|
548
548
|
*
|
|
549
549
|
* @since 1.85
|
|
550
|
-
* @experimental
|
|
551
|
-
* may be done before its official public release. Use at your own discretion.
|
|
550
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
551
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
552
552
|
*
|
|
553
553
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
554
554
|
*/
|
|
@@ -562,8 +562,8 @@ declare namespace sap {
|
|
|
562
562
|
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
563
563
|
*
|
|
564
564
|
* @since 1.85
|
|
565
|
-
* @experimental
|
|
566
|
-
* may be done before its official public release. Use at your own discretion.
|
|
565
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
566
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
567
567
|
*
|
|
568
568
|
* @returns Reference to `this` in order to allow method chaining
|
|
569
569
|
*/
|
|
@@ -582,7 +582,7 @@ declare namespace sap {
|
|
|
582
582
|
/**
|
|
583
583
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
584
584
|
*
|
|
585
|
-
* @experimental
|
|
585
|
+
* @experimental As of version 1.65. The API might change.
|
|
586
586
|
*/
|
|
587
587
|
refresh(): void;
|
|
588
588
|
/**
|
|
@@ -595,8 +595,8 @@ declare namespace sap {
|
|
|
595
595
|
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
596
596
|
*
|
|
597
597
|
* @since 1.85
|
|
598
|
-
* @experimental
|
|
599
|
-
* may be done before its official public release. Use at your own discretion.
|
|
598
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
599
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
600
600
|
*
|
|
601
601
|
* @returns The removed actionDefinition or `null`
|
|
602
602
|
*/
|
|
@@ -612,7 +612,7 @@ declare namespace sap {
|
|
|
612
612
|
/**
|
|
613
613
|
* Performs an HTTP request using the given configuration.
|
|
614
614
|
*
|
|
615
|
-
* @experimental
|
|
615
|
+
* @experimental As of version 1.79.
|
|
616
616
|
*
|
|
617
617
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
618
618
|
*/
|
|
@@ -671,7 +671,7 @@ declare namespace sap {
|
|
|
671
671
|
* Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
|
|
672
672
|
* after the `cardReady` lifecycle hook in Component cards and Extensions.
|
|
673
673
|
*
|
|
674
|
-
* @experimental
|
|
674
|
+
* @experimental As of version 1.114.
|
|
675
675
|
*/
|
|
676
676
|
showBlockingMessage(
|
|
677
677
|
/**
|
|
@@ -695,7 +695,7 @@ declare namespace sap {
|
|
|
695
695
|
* If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
|
|
696
696
|
* fired.
|
|
697
697
|
*
|
|
698
|
-
* @experimental
|
|
698
|
+
* @experimental As of version 1.81.
|
|
699
699
|
*/
|
|
700
700
|
showMessage(
|
|
701
701
|
/**
|
|
@@ -733,7 +733,7 @@ declare namespace sap {
|
|
|
733
733
|
* ```
|
|
734
734
|
*
|
|
735
735
|
*
|
|
736
|
-
* @experimental
|
|
736
|
+
* @experimental As of version 1.84.
|
|
737
737
|
*/
|
|
738
738
|
triggerAction(
|
|
739
739
|
/**
|
|
@@ -782,7 +782,7 @@ declare namespace sap {
|
|
|
782
782
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
783
783
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
784
784
|
*
|
|
785
|
-
* @experimental
|
|
785
|
+
* @experimental As of version 1.65. This property might be changed in future.
|
|
786
786
|
*/
|
|
787
787
|
parameters?:
|
|
788
788
|
| object
|
|
@@ -793,7 +793,7 @@ declare namespace sap {
|
|
|
793
793
|
* Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
|
|
794
794
|
*
|
|
795
795
|
* @since 1.65
|
|
796
|
-
* @experimental
|
|
796
|
+
* @experimental As of version 1.65.
|
|
797
797
|
*/
|
|
798
798
|
dataMode?:
|
|
799
799
|
| sap.ui.integration.CardDataMode
|
|
@@ -806,7 +806,7 @@ declare namespace sap {
|
|
|
806
806
|
* If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
|
|
807
807
|
*
|
|
808
808
|
* @since 1.70
|
|
809
|
-
* @experimental
|
|
809
|
+
* @experimental As of version 1.70.
|
|
810
810
|
*/
|
|
811
811
|
baseUrl?:
|
|
812
812
|
| sap.ui.core.URI
|
|
@@ -852,8 +852,8 @@ declare namespace sap {
|
|
|
852
852
|
*
|
|
853
853
|
*
|
|
854
854
|
* @since 1.76
|
|
855
|
-
* @experimental
|
|
856
|
-
* is implemented.
|
|
855
|
+
* @experimental As of version 1.76. This API might be removed when a permanent solution for flexibility
|
|
856
|
+
* changes is implemented.
|
|
857
857
|
*/
|
|
858
858
|
manifestChanges?:
|
|
859
859
|
| object[]
|
|
@@ -864,7 +864,7 @@ declare namespace sap {
|
|
|
864
864
|
* Defines the design of the `Card`.
|
|
865
865
|
*
|
|
866
866
|
* @since 1.109
|
|
867
|
-
* @experimental
|
|
867
|
+
* @experimental As of version 1.109.
|
|
868
868
|
*/
|
|
869
869
|
design?:
|
|
870
870
|
| sap.ui.integration.CardDesign
|
|
@@ -875,7 +875,7 @@ declare namespace sap {
|
|
|
875
875
|
* Defines the display variant for card rendering and behavior.
|
|
876
876
|
*
|
|
877
877
|
* @since 1.118
|
|
878
|
-
* @experimental
|
|
878
|
+
* @experimental As of version 1.118. For usage only by Work Zone.
|
|
879
879
|
*/
|
|
880
880
|
displayVariant?:
|
|
881
881
|
| sap.ui.integration.CardDisplayVariant
|
|
@@ -891,7 +891,7 @@ declare namespace sap {
|
|
|
891
891
|
* - When set to "Off", the card displays real data.
|
|
892
892
|
*
|
|
893
893
|
* @since 1.112
|
|
894
|
-
* @experimental
|
|
894
|
+
* @experimental As of version 1.112.
|
|
895
895
|
*/
|
|
896
896
|
previewMode?:
|
|
897
897
|
| sap.ui.integration.CardPreviewMode
|
|
@@ -903,20 +903,34 @@ declare namespace sap {
|
|
|
903
903
|
* the feature for cards where it is needed.
|
|
904
904
|
*
|
|
905
905
|
* @since 1.127
|
|
906
|
-
* @experimental
|
|
906
|
+
* @experimental As of version 1.127.
|
|
907
907
|
*/
|
|
908
908
|
useProgressiveDisclosure?:
|
|
909
909
|
| boolean
|
|
910
910
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
911
911
|
| `{${string}}`;
|
|
912
912
|
|
|
913
|
+
/**
|
|
914
|
+
* Allows to control the overflow behaviour of the card.
|
|
915
|
+
*
|
|
916
|
+
* **Note**: If the "Default" option is used, the card must be allowed to grow in height as much as it needs
|
|
917
|
+
* to avoid overflowing. Use a layout which allows this.
|
|
918
|
+
*
|
|
919
|
+
* @since 1.133
|
|
920
|
+
* @experimental As of version 1.133.
|
|
921
|
+
*/
|
|
922
|
+
overflow?:
|
|
923
|
+
| sap.ui.integration.CardOverflow
|
|
924
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
925
|
+
| `{${string}}`;
|
|
926
|
+
|
|
913
927
|
/**
|
|
914
928
|
* Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
|
|
915
929
|
* is destroyed when the property `manifest` changes.
|
|
916
930
|
*
|
|
917
931
|
* @since 1.85
|
|
918
|
-
* @experimental
|
|
919
|
-
* may be done before its official public release. Use at your own discretion.
|
|
932
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
933
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
920
934
|
*/
|
|
921
935
|
actionDefinitions?:
|
|
922
936
|
| sap.ui.integration.ActionDefinition[]
|
|
@@ -936,8 +950,8 @@ declare namespace sap {
|
|
|
936
950
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
937
951
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
938
952
|
*
|
|
939
|
-
* @experimental
|
|
940
|
-
* be done before its official public release. Use at your own discretion.
|
|
953
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
954
|
+
* may be done before its official public release. Use at your own discretion.
|
|
941
955
|
*/
|
|
942
956
|
action?: (oEvent: Card$ActionEvent) => void;
|
|
943
957
|
|
|
@@ -945,14 +959,14 @@ declare namespace sap {
|
|
|
945
959
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
946
960
|
* value is changed.
|
|
947
961
|
*
|
|
948
|
-
* @experimental
|
|
962
|
+
* @experimental As of version 1.96.
|
|
949
963
|
*/
|
|
950
964
|
configurationChange?: (oEvent: Card$ConfigurationChangeEvent) => void;
|
|
951
965
|
|
|
952
966
|
/**
|
|
953
967
|
* Fired when the manifest is loaded.
|
|
954
968
|
*
|
|
955
|
-
* @experimental
|
|
969
|
+
* @experimental As of version 1.72.
|
|
956
970
|
*/
|
|
957
971
|
manifestReady?: (oEvent: sap.ui.base.Event) => void;
|
|
958
972
|
|
|
@@ -960,7 +974,7 @@ declare namespace sap {
|
|
|
960
974
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
961
975
|
* filter is changed or data is refreshed.
|
|
962
976
|
*
|
|
963
|
-
* @experimental
|
|
977
|
+
* @experimental As of version 1.107.
|
|
964
978
|
*/
|
|
965
979
|
stateChanged?: (oEvent: sap.ui.base.Event) => void;
|
|
966
980
|
}
|
|
@@ -968,8 +982,8 @@ declare namespace sap {
|
|
|
968
982
|
/**
|
|
969
983
|
* Parameters of the Card#action event.
|
|
970
984
|
*
|
|
971
|
-
* @experimental
|
|
972
|
-
* be done before its official public release. Use at your own discretion.
|
|
985
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
986
|
+
* may be done before its official public release. Use at your own discretion.
|
|
973
987
|
*/
|
|
974
988
|
interface Card$ActionEventParameters {
|
|
975
989
|
/**
|
|
@@ -1008,7 +1022,7 @@ declare namespace sap {
|
|
|
1008
1022
|
/**
|
|
1009
1023
|
* Parameters of the Card#configurationChange event.
|
|
1010
1024
|
*
|
|
1011
|
-
* @experimental
|
|
1025
|
+
* @experimental As of version 1.96.
|
|
1012
1026
|
*/
|
|
1013
1027
|
interface Card$ConfigurationChangeEventParameters {
|
|
1014
1028
|
/**
|
|
@@ -1034,14 +1048,14 @@ declare namespace sap {
|
|
|
1034
1048
|
/**
|
|
1035
1049
|
* Parameters of the Card#manifestReady event.
|
|
1036
1050
|
*
|
|
1037
|
-
* @experimental
|
|
1051
|
+
* @experimental As of version 1.72.
|
|
1038
1052
|
*/
|
|
1039
1053
|
interface Card$ManifestReadyEventParameters {}
|
|
1040
1054
|
|
|
1041
1055
|
/**
|
|
1042
1056
|
* Parameters of the Card#stateChanged event.
|
|
1043
1057
|
*
|
|
1044
|
-
* @experimental
|
|
1058
|
+
* @experimental As of version 1.107.
|
|
1045
1059
|
*/
|
|
1046
1060
|
interface Card$StateChangedEventParameters {}
|
|
1047
1061
|
|
|
@@ -1098,7 +1112,7 @@ declare namespace sap {
|
|
|
1098
1112
|
*/
|
|
1099
1113
|
constructor(
|
|
1100
1114
|
/**
|
|
1101
|
-
* Initial settings for the new control
|
|
1115
|
+
* Initial settings for the new control.
|
|
1102
1116
|
*/
|
|
1103
1117
|
mSettings?: sap.ui.integration.widgets.$CardSettings
|
|
1104
1118
|
);
|
|
@@ -1113,11 +1127,11 @@ declare namespace sap {
|
|
|
1113
1127
|
*/
|
|
1114
1128
|
constructor(
|
|
1115
1129
|
/**
|
|
1116
|
-
* ID for the new control
|
|
1130
|
+
* ID for the new control. ID generated automatically if no ID is provided.
|
|
1117
1131
|
*/
|
|
1118
1132
|
sId?: string,
|
|
1119
1133
|
/**
|
|
1120
|
-
* Initial settings for the new control
|
|
1134
|
+
* Initial settings for the new control.
|
|
1121
1135
|
*/
|
|
1122
1136
|
mSettings?: sap.ui.integration.widgets.$CardSettings
|
|
1123
1137
|
);
|
|
@@ -1157,8 +1171,8 @@ declare namespace sap {
|
|
|
1157
1171
|
* Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1158
1172
|
*
|
|
1159
1173
|
* @since 1.85
|
|
1160
|
-
* @experimental
|
|
1161
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1174
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1175
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1162
1176
|
*
|
|
1163
1177
|
* @returns Reference to `this` in order to allow method chaining
|
|
1164
1178
|
*/
|
|
@@ -1180,8 +1194,8 @@ declare namespace sap {
|
|
|
1180
1194
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
1181
1195
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
1182
1196
|
*
|
|
1183
|
-
* @experimental
|
|
1184
|
-
* be done before its official public release. Use at your own discretion.
|
|
1197
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
1198
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1185
1199
|
*
|
|
1186
1200
|
* @returns Reference to `this` in order to allow method chaining
|
|
1187
1201
|
*/
|
|
@@ -1212,8 +1226,8 @@ declare namespace sap {
|
|
|
1212
1226
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
1213
1227
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
1214
1228
|
*
|
|
1215
|
-
* @experimental
|
|
1216
|
-
* be done before its official public release. Use at your own discretion.
|
|
1229
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
1230
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1217
1231
|
*
|
|
1218
1232
|
* @returns Reference to `this` in order to allow method chaining
|
|
1219
1233
|
*/
|
|
@@ -1237,7 +1251,7 @@ declare namespace sap {
|
|
|
1237
1251
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
1238
1252
|
* value is changed.
|
|
1239
1253
|
*
|
|
1240
|
-
* @experimental
|
|
1254
|
+
* @experimental As of version 1.96.
|
|
1241
1255
|
*
|
|
1242
1256
|
* @returns Reference to `this` in order to allow method chaining
|
|
1243
1257
|
*/
|
|
@@ -1266,7 +1280,7 @@ declare namespace sap {
|
|
|
1266
1280
|
* Fired when some configuration settings are changed as a result of user interaction. For example - filter
|
|
1267
1281
|
* value is changed.
|
|
1268
1282
|
*
|
|
1269
|
-
* @experimental
|
|
1283
|
+
* @experimental As of version 1.96.
|
|
1270
1284
|
*
|
|
1271
1285
|
* @returns Reference to `this` in order to allow method chaining
|
|
1272
1286
|
*/
|
|
@@ -1288,7 +1302,7 @@ declare namespace sap {
|
|
|
1288
1302
|
*
|
|
1289
1303
|
* Fired when the manifest is loaded.
|
|
1290
1304
|
*
|
|
1291
|
-
* @experimental
|
|
1305
|
+
* @experimental As of version 1.72.
|
|
1292
1306
|
*
|
|
1293
1307
|
* @returns Reference to `this` in order to allow method chaining
|
|
1294
1308
|
*/
|
|
@@ -1315,7 +1329,7 @@ declare namespace sap {
|
|
|
1315
1329
|
*
|
|
1316
1330
|
* Fired when the manifest is loaded.
|
|
1317
1331
|
*
|
|
1318
|
-
* @experimental
|
|
1332
|
+
* @experimental As of version 1.72.
|
|
1319
1333
|
*
|
|
1320
1334
|
* @returns Reference to `this` in order to allow method chaining
|
|
1321
1335
|
*/
|
|
@@ -1338,7 +1352,7 @@ declare namespace sap {
|
|
|
1338
1352
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1339
1353
|
* filter is changed or data is refreshed.
|
|
1340
1354
|
*
|
|
1341
|
-
* @experimental
|
|
1355
|
+
* @experimental As of version 1.107.
|
|
1342
1356
|
*
|
|
1343
1357
|
* @returns Reference to `this` in order to allow method chaining
|
|
1344
1358
|
*/
|
|
@@ -1366,7 +1380,7 @@ declare namespace sap {
|
|
|
1366
1380
|
* Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
|
|
1367
1381
|
* filter is changed or data is refreshed.
|
|
1368
1382
|
*
|
|
1369
|
-
* @experimental
|
|
1383
|
+
* @experimental As of version 1.107.
|
|
1370
1384
|
*
|
|
1371
1385
|
* @returns Reference to `this` in order to allow method chaining
|
|
1372
1386
|
*/
|
|
@@ -1384,8 +1398,8 @@ declare namespace sap {
|
|
|
1384
1398
|
* Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1385
1399
|
*
|
|
1386
1400
|
* @since 1.85
|
|
1387
|
-
* @experimental
|
|
1388
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1401
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1402
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1389
1403
|
*
|
|
1390
1404
|
* @returns Reference to `this` in order to allow method chaining
|
|
1391
1405
|
*/
|
|
@@ -1395,8 +1409,8 @@ declare namespace sap {
|
|
|
1395
1409
|
*
|
|
1396
1410
|
* The passed function and listener object must match the ones used for event registration.
|
|
1397
1411
|
*
|
|
1398
|
-
* @experimental
|
|
1399
|
-
* be done before its official public release. Use at your own discretion.
|
|
1412
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
1413
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1400
1414
|
*
|
|
1401
1415
|
* @returns Reference to `this` in order to allow method chaining
|
|
1402
1416
|
*/
|
|
@@ -1416,7 +1430,7 @@ declare namespace sap {
|
|
|
1416
1430
|
*
|
|
1417
1431
|
* The passed function and listener object must match the ones used for event registration.
|
|
1418
1432
|
*
|
|
1419
|
-
* @experimental
|
|
1433
|
+
* @experimental As of version 1.96.
|
|
1420
1434
|
*
|
|
1421
1435
|
* @returns Reference to `this` in order to allow method chaining
|
|
1422
1436
|
*/
|
|
@@ -1436,7 +1450,7 @@ declare namespace sap {
|
|
|
1436
1450
|
*
|
|
1437
1451
|
* The passed function and listener object must match the ones used for event registration.
|
|
1438
1452
|
*
|
|
1439
|
-
* @experimental
|
|
1453
|
+
* @experimental As of version 1.72.
|
|
1440
1454
|
*
|
|
1441
1455
|
* @returns Reference to `this` in order to allow method chaining
|
|
1442
1456
|
*/
|
|
@@ -1455,7 +1469,7 @@ declare namespace sap {
|
|
|
1455
1469
|
*
|
|
1456
1470
|
* The passed function and listener object must match the ones used for event registration.
|
|
1457
1471
|
*
|
|
1458
|
-
* @experimental
|
|
1472
|
+
* @experimental As of version 1.107.
|
|
1459
1473
|
*
|
|
1460
1474
|
* @returns Reference to `this` in order to allow method chaining
|
|
1461
1475
|
*/
|
|
@@ -1475,8 +1489,8 @@ declare namespace sap {
|
|
|
1475
1489
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
1476
1490
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
1477
1491
|
*
|
|
1478
|
-
* @experimental
|
|
1479
|
-
* be done before its official public release. Use at your own discretion.
|
|
1492
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
1493
|
+
* may be done before its official public release. Use at your own discretion.
|
|
1480
1494
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1481
1495
|
*
|
|
1482
1496
|
* @returns Whether or not to prevent the default action
|
|
@@ -1490,7 +1504,7 @@ declare namespace sap {
|
|
|
1490
1504
|
/**
|
|
1491
1505
|
* Fires event {@link #event:configurationChange configurationChange} to attached listeners.
|
|
1492
1506
|
*
|
|
1493
|
-
* @experimental
|
|
1507
|
+
* @experimental As of version 1.96.
|
|
1494
1508
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1495
1509
|
*
|
|
1496
1510
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -1504,7 +1518,7 @@ declare namespace sap {
|
|
|
1504
1518
|
/**
|
|
1505
1519
|
* Fires event {@link #event:manifestReady manifestReady} to attached listeners.
|
|
1506
1520
|
*
|
|
1507
|
-
* @experimental
|
|
1521
|
+
* @experimental As of version 1.72.
|
|
1508
1522
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1509
1523
|
*
|
|
1510
1524
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -1518,7 +1532,7 @@ declare namespace sap {
|
|
|
1518
1532
|
/**
|
|
1519
1533
|
* Fires event {@link #event:stateChanged stateChanged} to attached listeners.
|
|
1520
1534
|
*
|
|
1521
|
-
* @experimental
|
|
1535
|
+
* @experimental As of version 1.107.
|
|
1522
1536
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1523
1537
|
*
|
|
1524
1538
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -1536,8 +1550,8 @@ declare namespace sap {
|
|
|
1536
1550
|
* is destroyed when the property `manifest` changes.
|
|
1537
1551
|
*
|
|
1538
1552
|
* @since 1.85
|
|
1539
|
-
* @experimental
|
|
1540
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1553
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1554
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1541
1555
|
*/
|
|
1542
1556
|
getActionDefinitions(): sap.ui.integration.ActionDefinition[];
|
|
1543
1557
|
/**
|
|
@@ -1548,7 +1562,7 @@ declare namespace sap {
|
|
|
1548
1562
|
* If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
|
|
1549
1563
|
*
|
|
1550
1564
|
* @since 1.70
|
|
1551
|
-
* @experimental
|
|
1565
|
+
* @experimental As of version 1.70.
|
|
1552
1566
|
*
|
|
1553
1567
|
* @returns Value of property `baseUrl`
|
|
1554
1568
|
*/
|
|
@@ -1556,7 +1570,7 @@ declare namespace sap {
|
|
|
1556
1570
|
/**
|
|
1557
1571
|
* Get information about the blocking message in the card.
|
|
1558
1572
|
*
|
|
1559
|
-
* @experimental
|
|
1573
|
+
* @experimental As of version 1.114.
|
|
1560
1574
|
*
|
|
1561
1575
|
* @returns Information about the message or `null`, if such isn't shown.
|
|
1562
1576
|
*/
|
|
@@ -1570,7 +1584,7 @@ declare namespace sap {
|
|
|
1570
1584
|
*
|
|
1571
1585
|
* - Use when developing a Component card.
|
|
1572
1586
|
*
|
|
1573
|
-
* @experimental
|
|
1587
|
+
* @experimental As of version 1.77.
|
|
1574
1588
|
*
|
|
1575
1589
|
* @returns Object containing parameters in format `{parameterKey: parameterValue}`.
|
|
1576
1590
|
*/
|
|
@@ -1583,7 +1597,7 @@ declare namespace sap {
|
|
|
1583
1597
|
* Default value is `Auto`.
|
|
1584
1598
|
*
|
|
1585
1599
|
* @since 1.65
|
|
1586
|
-
* @experimental
|
|
1600
|
+
* @experimental As of version 1.65.
|
|
1587
1601
|
*
|
|
1588
1602
|
* @returns Value of property `dataMode`
|
|
1589
1603
|
*/
|
|
@@ -1596,7 +1610,7 @@ declare namespace sap {
|
|
|
1596
1610
|
* Default value is `Solid`.
|
|
1597
1611
|
*
|
|
1598
1612
|
* @since 1.109
|
|
1599
|
-
* @experimental
|
|
1613
|
+
* @experimental As of version 1.109.
|
|
1600
1614
|
*
|
|
1601
1615
|
* @returns Value of property `design`
|
|
1602
1616
|
*/
|
|
@@ -1609,7 +1623,7 @@ declare namespace sap {
|
|
|
1609
1623
|
* Default value is `Standard`.
|
|
1610
1624
|
*
|
|
1611
1625
|
* @since 1.118
|
|
1612
|
-
* @experimental
|
|
1626
|
+
* @experimental As of version 1.118. For usage only by Work Zone.
|
|
1613
1627
|
*
|
|
1614
1628
|
* @returns Value of property `displayVariant`
|
|
1615
1629
|
*/
|
|
@@ -1629,7 +1643,7 @@ declare namespace sap {
|
|
|
1629
1643
|
/**
|
|
1630
1644
|
* Gets the instance of the `host` association.
|
|
1631
1645
|
*
|
|
1632
|
-
* @experimental
|
|
1646
|
+
* @experimental As of version 1.77.
|
|
1633
1647
|
*
|
|
1634
1648
|
* @returns The host object associated with this card.
|
|
1635
1649
|
*/
|
|
@@ -1684,8 +1698,8 @@ declare namespace sap {
|
|
|
1684
1698
|
* Default value is `[]`.
|
|
1685
1699
|
*
|
|
1686
1700
|
* @since 1.76
|
|
1687
|
-
* @experimental
|
|
1688
|
-
* is implemented.
|
|
1701
|
+
* @experimental As of version 1.76. This API might be removed when a permanent solution for flexibility
|
|
1702
|
+
* changes is implemented.
|
|
1689
1703
|
*
|
|
1690
1704
|
* @returns Value of property `manifestChanges`
|
|
1691
1705
|
*/
|
|
@@ -1695,7 +1709,7 @@ declare namespace sap {
|
|
|
1695
1709
|
*
|
|
1696
1710
|
* **Note** Use this method when the manifest is ready. Check `manifestReady` event.
|
|
1697
1711
|
*
|
|
1698
|
-
* @experimental
|
|
1712
|
+
* @experimental As of version 1.77.
|
|
1699
1713
|
*
|
|
1700
1714
|
* @returns The value at the specified path.
|
|
1701
1715
|
*/
|
|
@@ -1705,13 +1719,29 @@ declare namespace sap {
|
|
|
1705
1719
|
*/
|
|
1706
1720
|
sPath: string
|
|
1707
1721
|
): any;
|
|
1722
|
+
/**
|
|
1723
|
+
* Gets current value of property {@link #getOverflow overflow}.
|
|
1724
|
+
*
|
|
1725
|
+
* Allows to control the overflow behaviour of the card.
|
|
1726
|
+
*
|
|
1727
|
+
* **Note**: If the "Default" option is used, the card must be allowed to grow in height as much as it needs
|
|
1728
|
+
* to avoid overflowing. Use a layout which allows this.
|
|
1729
|
+
*
|
|
1730
|
+
* Default value is `Default`.
|
|
1731
|
+
*
|
|
1732
|
+
* @since 1.133
|
|
1733
|
+
* @experimental As of version 1.133.
|
|
1734
|
+
*
|
|
1735
|
+
* @returns Value of property `overflow`
|
|
1736
|
+
*/
|
|
1737
|
+
getOverflow(): sap.ui.integration.CardOverflow;
|
|
1708
1738
|
/**
|
|
1709
1739
|
* Gets current value of property {@link #getParameters parameters}.
|
|
1710
1740
|
*
|
|
1711
1741
|
* Overrides the default values of the parameters, which are defined in the manifest. The value is an object
|
|
1712
1742
|
* containing parameters in format `{parameterKey: parameterValue}`.
|
|
1713
1743
|
*
|
|
1714
|
-
* @experimental
|
|
1744
|
+
* @experimental As of version 1.65. This property might be changed in future.
|
|
1715
1745
|
*
|
|
1716
1746
|
* @returns Value of property `parameters`
|
|
1717
1747
|
*/
|
|
@@ -1729,7 +1759,7 @@ declare namespace sap {
|
|
|
1729
1759
|
* Default value is `Off`.
|
|
1730
1760
|
*
|
|
1731
1761
|
* @since 1.112
|
|
1732
|
-
* @experimental
|
|
1762
|
+
* @experimental As of version 1.112.
|
|
1733
1763
|
*
|
|
1734
1764
|
* @returns Value of property `previewMode`
|
|
1735
1765
|
*/
|
|
@@ -1751,7 +1781,7 @@ declare namespace sap {
|
|
|
1751
1781
|
*
|
|
1752
1782
|
* For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
|
|
1753
1783
|
*
|
|
1754
|
-
* @experimental
|
|
1784
|
+
* @experimental As of version 1.83. The API might change.
|
|
1755
1785
|
*
|
|
1756
1786
|
* @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
|
|
1757
1787
|
* on `bIgnoreKeyFallback`.
|
|
@@ -1783,7 +1813,7 @@ declare namespace sap {
|
|
|
1783
1813
|
* Default value is `false`.
|
|
1784
1814
|
*
|
|
1785
1815
|
* @since 1.127
|
|
1786
|
-
* @experimental
|
|
1816
|
+
* @experimental As of version 1.127.
|
|
1787
1817
|
*
|
|
1788
1818
|
* @returns Value of property `useProgressiveDisclosure`
|
|
1789
1819
|
*/
|
|
@@ -1791,7 +1821,7 @@ declare namespace sap {
|
|
|
1791
1821
|
/**
|
|
1792
1822
|
* Hide the blocking message that is shown in the card by `showBlockingMessage` call.
|
|
1793
1823
|
*
|
|
1794
|
-
* @experimental
|
|
1824
|
+
* @experimental As of version 1.114.
|
|
1795
1825
|
*/
|
|
1796
1826
|
hideBlockingMessage(): void;
|
|
1797
1827
|
/**
|
|
@@ -1807,7 +1837,7 @@ declare namespace sap {
|
|
|
1807
1837
|
/**
|
|
1808
1838
|
* Hides the message previously shown by showMessage.
|
|
1809
1839
|
*
|
|
1810
|
-
* @experimental
|
|
1840
|
+
* @experimental As of version 1.117.
|
|
1811
1841
|
*/
|
|
1812
1842
|
hideMessage(): void;
|
|
1813
1843
|
/**
|
|
@@ -1815,8 +1845,8 @@ declare namespace sap {
|
|
|
1815
1845
|
* and returns its index if found or -1 otherwise.
|
|
1816
1846
|
*
|
|
1817
1847
|
* @since 1.85
|
|
1818
|
-
* @experimental
|
|
1819
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1848
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1849
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1820
1850
|
*
|
|
1821
1851
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1822
1852
|
*/
|
|
@@ -1830,8 +1860,8 @@ declare namespace sap {
|
|
|
1830
1860
|
* Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1831
1861
|
*
|
|
1832
1862
|
* @since 1.85
|
|
1833
|
-
* @experimental
|
|
1834
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1863
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1864
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1835
1865
|
*
|
|
1836
1866
|
* @returns Reference to `this` in order to allow method chaining
|
|
1837
1867
|
*/
|
|
@@ -1848,7 +1878,7 @@ declare namespace sap {
|
|
|
1848
1878
|
iIndex: int
|
|
1849
1879
|
): this;
|
|
1850
1880
|
/**
|
|
1851
|
-
* @experimental
|
|
1881
|
+
* @experimental As of version 1.65. The API might change.
|
|
1852
1882
|
*
|
|
1853
1883
|
* @returns If the card is ready or not.
|
|
1854
1884
|
*/
|
|
@@ -1861,7 +1891,7 @@ declare namespace sap {
|
|
|
1861
1891
|
* the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
|
|
1862
1892
|
* error: "Card.designtime not found" }
|
|
1863
1893
|
*
|
|
1864
|
-
* @experimental
|
|
1894
|
+
* @experimental As of version 1.73.
|
|
1865
1895
|
*
|
|
1866
1896
|
* @returns Promise resolves after the designtime configuration is loaded.
|
|
1867
1897
|
*/
|
|
@@ -1869,7 +1899,7 @@ declare namespace sap {
|
|
|
1869
1899
|
/**
|
|
1870
1900
|
* Refreshes the card by re-applying the manifest settings and triggering all data requests.
|
|
1871
1901
|
*
|
|
1872
|
-
* @experimental
|
|
1902
|
+
* @experimental As of version 1.65. The API might change.
|
|
1873
1903
|
*/
|
|
1874
1904
|
refresh(): void;
|
|
1875
1905
|
/**
|
|
@@ -1882,8 +1912,8 @@ declare namespace sap {
|
|
|
1882
1912
|
* Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
|
|
1883
1913
|
*
|
|
1884
1914
|
* @since 1.85
|
|
1885
|
-
* @experimental
|
|
1886
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1915
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1916
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1887
1917
|
*
|
|
1888
1918
|
* @returns The removed actionDefinition or `null`
|
|
1889
1919
|
*/
|
|
@@ -1902,8 +1932,8 @@ declare namespace sap {
|
|
|
1902
1932
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
1903
1933
|
*
|
|
1904
1934
|
* @since 1.85
|
|
1905
|
-
* @experimental
|
|
1906
|
-
* may be done before its official public release. Use at your own discretion.
|
|
1935
|
+
* @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
|
|
1936
|
+
* changes may be done before its official public release. Use at your own discretion.
|
|
1907
1937
|
*
|
|
1908
1938
|
* @returns An array of the removed elements (might be empty)
|
|
1909
1939
|
*/
|
|
@@ -1911,7 +1941,7 @@ declare namespace sap {
|
|
|
1911
1941
|
/**
|
|
1912
1942
|
* Performs an HTTP request using the given configuration.
|
|
1913
1943
|
*
|
|
1914
|
-
* @experimental
|
|
1944
|
+
* @experimental As of version 1.79.
|
|
1915
1945
|
*
|
|
1916
1946
|
* @returns Resolves when the request is successful, rejects otherwise.
|
|
1917
1947
|
*/
|
|
@@ -1976,7 +2006,7 @@ declare namespace sap {
|
|
|
1976
2006
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1977
2007
|
*
|
|
1978
2008
|
* @since 1.70
|
|
1979
|
-
* @experimental
|
|
2009
|
+
* @experimental As of version 1.70.
|
|
1980
2010
|
*
|
|
1981
2011
|
* @returns Reference to `this` in order to allow method chaining
|
|
1982
2012
|
*/
|
|
@@ -1990,7 +2020,7 @@ declare namespace sap {
|
|
|
1990
2020
|
* Sets a new value for the `dataMode` property.
|
|
1991
2021
|
*
|
|
1992
2022
|
* @since 1.65
|
|
1993
|
-
* @experimental
|
|
2023
|
+
* @experimental As of version 1.65. API might change.
|
|
1994
2024
|
*
|
|
1995
2025
|
* @returns Pointer to the control instance to allow method chaining.
|
|
1996
2026
|
*/
|
|
@@ -2010,7 +2040,7 @@ declare namespace sap {
|
|
|
2010
2040
|
* Default value is `Solid`.
|
|
2011
2041
|
*
|
|
2012
2042
|
* @since 1.109
|
|
2013
|
-
* @experimental
|
|
2043
|
+
* @experimental As of version 1.109.
|
|
2014
2044
|
*
|
|
2015
2045
|
* @returns Reference to `this` in order to allow method chaining
|
|
2016
2046
|
*/
|
|
@@ -2096,8 +2126,8 @@ declare namespace sap {
|
|
|
2096
2126
|
* Default value is `[]`.
|
|
2097
2127
|
*
|
|
2098
2128
|
* @since 1.76
|
|
2099
|
-
* @experimental
|
|
2100
|
-
* is implemented.
|
|
2129
|
+
* @experimental As of version 1.76. This API might be removed when a permanent solution for flexibility
|
|
2130
|
+
* changes is implemented.
|
|
2101
2131
|
*
|
|
2102
2132
|
* @returns Reference to `this` in order to allow method chaining
|
|
2103
2133
|
*/
|
|
@@ -2107,6 +2137,29 @@ declare namespace sap {
|
|
|
2107
2137
|
*/
|
|
2108
2138
|
sManifestChanges?: object[]
|
|
2109
2139
|
): this;
|
|
2140
|
+
/**
|
|
2141
|
+
* Sets a new value for property {@link #getOverflow overflow}.
|
|
2142
|
+
*
|
|
2143
|
+
* Allows to control the overflow behaviour of the card.
|
|
2144
|
+
*
|
|
2145
|
+
* **Note**: If the "Default" option is used, the card must be allowed to grow in height as much as it needs
|
|
2146
|
+
* to avoid overflowing. Use a layout which allows this.
|
|
2147
|
+
*
|
|
2148
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2149
|
+
*
|
|
2150
|
+
* Default value is `Default`.
|
|
2151
|
+
*
|
|
2152
|
+
* @since 1.133
|
|
2153
|
+
* @experimental As of version 1.133.
|
|
2154
|
+
*
|
|
2155
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2156
|
+
*/
|
|
2157
|
+
setOverflow(
|
|
2158
|
+
/**
|
|
2159
|
+
* New value for property `overflow`
|
|
2160
|
+
*/
|
|
2161
|
+
sOverflow?: sap.ui.integration.CardOverflow
|
|
2162
|
+
): this;
|
|
2110
2163
|
/**
|
|
2111
2164
|
* Sets a new value for property {@link #getParameters parameters}.
|
|
2112
2165
|
*
|
|
@@ -2115,7 +2168,7 @@ declare namespace sap {
|
|
|
2115
2168
|
*
|
|
2116
2169
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2117
2170
|
*
|
|
2118
|
-
* @experimental
|
|
2171
|
+
* @experimental As of version 1.65. This property might be changed in future.
|
|
2119
2172
|
*
|
|
2120
2173
|
* @returns Reference to `this` in order to allow method chaining
|
|
2121
2174
|
*/
|
|
@@ -2140,7 +2193,7 @@ declare namespace sap {
|
|
|
2140
2193
|
* Default value is `Off`.
|
|
2141
2194
|
*
|
|
2142
2195
|
* @since 1.112
|
|
2143
|
-
* @experimental
|
|
2196
|
+
* @experimental As of version 1.112.
|
|
2144
2197
|
*
|
|
2145
2198
|
* @returns Reference to `this` in order to allow method chaining
|
|
2146
2199
|
*/
|
|
@@ -2180,7 +2233,7 @@ declare namespace sap {
|
|
|
2180
2233
|
* Default value is `false`.
|
|
2181
2234
|
*
|
|
2182
2235
|
* @since 1.127
|
|
2183
|
-
* @experimental
|
|
2236
|
+
* @experimental As of version 1.127.
|
|
2184
2237
|
*
|
|
2185
2238
|
* @returns Reference to `this` in order to allow method chaining
|
|
2186
2239
|
*/
|
|
@@ -2194,7 +2247,7 @@ declare namespace sap {
|
|
|
2194
2247
|
* Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
|
|
2195
2248
|
* after the `cardReady` lifecycle hook in Component cards and Extensions.
|
|
2196
2249
|
*
|
|
2197
|
-
* @experimental
|
|
2250
|
+
* @experimental As of version 1.114.
|
|
2198
2251
|
*/
|
|
2199
2252
|
showBlockingMessage(
|
|
2200
2253
|
/**
|
|
@@ -2218,7 +2271,7 @@ declare namespace sap {
|
|
|
2218
2271
|
* If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
|
|
2219
2272
|
* fired.
|
|
2220
2273
|
*
|
|
2221
|
-
* @experimental
|
|
2274
|
+
* @experimental As of version 1.81.
|
|
2222
2275
|
*/
|
|
2223
2276
|
showMessage(
|
|
2224
2277
|
/**
|
|
@@ -2256,7 +2309,7 @@ declare namespace sap {
|
|
|
2256
2309
|
* ```
|
|
2257
2310
|
*
|
|
2258
2311
|
*
|
|
2259
|
-
* @experimental
|
|
2312
|
+
* @experimental As of version 1.84.
|
|
2260
2313
|
*/
|
|
2261
2314
|
triggerAction(
|
|
2262
2315
|
/**
|
|
@@ -2286,8 +2339,8 @@ declare namespace sap {
|
|
|
2286
2339
|
/**
|
|
2287
2340
|
* Event object of the Card#action event.
|
|
2288
2341
|
*
|
|
2289
|
-
* @experimental
|
|
2290
|
-
* be done before its official public release. Use at your own discretion.
|
|
2342
|
+
* @experimental As of version 1.64. Disclaimer: this event is in a beta state - incompatible API changes
|
|
2343
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2291
2344
|
*/
|
|
2292
2345
|
type Card$ActionEvent = sap.ui.base.Event<
|
|
2293
2346
|
Card$ActionEventParameters,
|
|
@@ -2297,7 +2350,7 @@ declare namespace sap {
|
|
|
2297
2350
|
/**
|
|
2298
2351
|
* Event object of the Card#configurationChange event.
|
|
2299
2352
|
*
|
|
2300
|
-
* @experimental
|
|
2353
|
+
* @experimental As of version 1.96.
|
|
2301
2354
|
*/
|
|
2302
2355
|
type Card$ConfigurationChangeEvent = sap.ui.base.Event<
|
|
2303
2356
|
Card$ConfigurationChangeEventParameters,
|
|
@@ -2315,7 +2368,7 @@ declare namespace sap {
|
|
|
2315
2368
|
/**
|
|
2316
2369
|
* Event object of the Card#manifestReady event.
|
|
2317
2370
|
*
|
|
2318
|
-
* @experimental
|
|
2371
|
+
* @experimental As of version 1.72.
|
|
2319
2372
|
*/
|
|
2320
2373
|
type Card$ManifestReadyEvent = sap.ui.base.Event<
|
|
2321
2374
|
Card$ManifestReadyEventParameters,
|
|
@@ -2325,7 +2378,7 @@ declare namespace sap {
|
|
|
2325
2378
|
/**
|
|
2326
2379
|
* Event object of the Card#stateChanged event.
|
|
2327
2380
|
*
|
|
2328
|
-
* @experimental
|
|
2381
|
+
* @experimental As of version 1.107.
|
|
2329
2382
|
*/
|
|
2330
2383
|
type Card$StateChangedEvent = sap.ui.base.Event<
|
|
2331
2384
|
Card$StateChangedEventParameters,
|
|
@@ -2335,8 +2388,8 @@ declare namespace sap {
|
|
|
2335
2388
|
/**
|
|
2336
2389
|
* Describes the settings that can be provided to the ActionDefinition constructor.
|
|
2337
2390
|
*
|
|
2338
|
-
* @experimental
|
|
2339
|
-
* be done before its official public release. Use at your own discretion.
|
|
2391
|
+
* @experimental As of version 1.85. Disclaimer: this class is in a beta state - incompatible API changes
|
|
2392
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2340
2393
|
*/
|
|
2341
2394
|
interface $ActionDefinitionSettings extends sap.ui.core.$ElementSettings {
|
|
2342
2395
|
/**
|
|
@@ -2363,7 +2416,8 @@ declare namespace sap {
|
|
|
2363
2416
|
/**
|
|
2364
2417
|
* The type of the action button.
|
|
2365
2418
|
*
|
|
2366
|
-
* @deprecated
|
|
2419
|
+
* @deprecated As of version 1.130. All `ActionDefinitions` are now rendered as menu items and don't have
|
|
2420
|
+
* `buttonType`.
|
|
2367
2421
|
*/
|
|
2368
2422
|
buttonType?:
|
|
2369
2423
|
| sap.m.ButtonType
|
|
@@ -2423,7 +2477,7 @@ declare namespace sap {
|
|
|
2423
2477
|
/**
|
|
2424
2478
|
* Describes the settings that can be provided to the Designtime constructor.
|
|
2425
2479
|
*
|
|
2426
|
-
* @experimental
|
|
2480
|
+
* @experimental As of version 1.75.
|
|
2427
2481
|
*/
|
|
2428
2482
|
interface $DesigntimeSettings
|
|
2429
2483
|
extends sap.ui.base.$ManagedObjectSettings {}
|
|
@@ -2435,8 +2489,8 @@ declare namespace sap {
|
|
|
2435
2489
|
/**
|
|
2436
2490
|
* The actions configuration.
|
|
2437
2491
|
*
|
|
2438
|
-
* @deprecated
|
|
2439
|
-
* @experimental
|
|
2492
|
+
* @deprecated As of version 1.85. This property is replaced by the `actions` aggregation of the card;
|
|
2493
|
+
* @experimental As of version 1.75. Disclaimer: this property is in a beta state - incompatible API changes
|
|
2440
2494
|
* may be done before its official public release. Use at your own discretion.
|
|
2441
2495
|
*/
|
|
2442
2496
|
actions?:
|
|
@@ -2447,7 +2501,7 @@ declare namespace sap {
|
|
|
2447
2501
|
/**
|
|
2448
2502
|
* The formatters that can be used in the manifest.
|
|
2449
2503
|
*
|
|
2450
|
-
* @experimental
|
|
2504
|
+
* @experimental As of version 1.79.
|
|
2451
2505
|
*/
|
|
2452
2506
|
formatters?:
|
|
2453
2507
|
| object
|
|
@@ -2461,8 +2515,8 @@ declare namespace sap {
|
|
|
2461
2515
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2462
2516
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2463
2517
|
*
|
|
2464
|
-
* @experimental
|
|
2465
|
-
* be done before its official public release. Use at your own discretion.
|
|
2518
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
2519
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2466
2520
|
*/
|
|
2467
2521
|
action?: (oEvent: Extension$ActionEvent) => void;
|
|
2468
2522
|
}
|
|
@@ -2470,13 +2524,13 @@ declare namespace sap {
|
|
|
2470
2524
|
/**
|
|
2471
2525
|
* Describes the settings that can be provided to the Host constructor.
|
|
2472
2526
|
*
|
|
2473
|
-
* @experimental
|
|
2527
|
+
* @experimental As of version 1.75.
|
|
2474
2528
|
*/
|
|
2475
2529
|
interface $HostSettings extends sap.ui.core.$ElementSettings {
|
|
2476
2530
|
/**
|
|
2477
2531
|
* The actions configuration.
|
|
2478
2532
|
*
|
|
2479
|
-
* @experimental
|
|
2533
|
+
* @experimental As of version 1.75. Disclaimer: this property is in a beta state - incompatible API changes
|
|
2480
2534
|
* may be done before its official public release. Use at your own discretion.
|
|
2481
2535
|
*/
|
|
2482
2536
|
actions?:
|
|
@@ -2507,8 +2561,8 @@ declare namespace sap {
|
|
|
2507
2561
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
2508
2562
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
2509
2563
|
*
|
|
2510
|
-
* @experimental
|
|
2511
|
-
* be done before its official public release. Use at your own discretion.
|
|
2564
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
2565
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2512
2566
|
*/
|
|
2513
2567
|
action?: (oEvent: Host$ActionEvent) => void;
|
|
2514
2568
|
|
|
@@ -2516,7 +2570,7 @@ declare namespace sap {
|
|
|
2516
2570
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
2517
2571
|
* - filter value is changed.
|
|
2518
2572
|
*
|
|
2519
|
-
* @experimental
|
|
2573
|
+
* @experimental As of version 1.96.
|
|
2520
2574
|
*/
|
|
2521
2575
|
cardConfigurationChange?: (
|
|
2522
2576
|
oEvent: Host$CardConfigurationChangeEvent
|
|
@@ -2526,7 +2580,7 @@ declare namespace sap {
|
|
|
2526
2580
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
2527
2581
|
* the card, a filter is changed or data is refreshed.
|
|
2528
2582
|
*
|
|
2529
|
-
* @experimental
|
|
2583
|
+
* @experimental As of version 1.107.
|
|
2530
2584
|
*/
|
|
2531
2585
|
cardStateChanged?: (oEvent: Host$CardStateChangedEvent) => void;
|
|
2532
2586
|
|
|
@@ -2534,14 +2588,14 @@ declare namespace sap {
|
|
|
2534
2588
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
2535
2589
|
* or data changes.
|
|
2536
2590
|
*
|
|
2537
|
-
* @experimental
|
|
2591
|
+
* @experimental As of version 1.116.
|
|
2538
2592
|
*/
|
|
2539
2593
|
cardInitialized?: (oEvent: Host$CardInitializedEvent) => void;
|
|
2540
2594
|
|
|
2541
2595
|
/**
|
|
2542
2596
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
2543
2597
|
*
|
|
2544
|
-
* @experimental
|
|
2598
|
+
* @experimental As of version 1.91.
|
|
2545
2599
|
*/
|
|
2546
2600
|
message?: (oEvent: Host$MessageEvent) => void;
|
|
2547
2601
|
}
|
|
@@ -2554,8 +2608,8 @@ declare namespace sap {
|
|
|
2554
2608
|
/**
|
|
2555
2609
|
* Parameters of the Extension#action event.
|
|
2556
2610
|
*
|
|
2557
|
-
* @experimental
|
|
2558
|
-
* be done before its official public release. Use at your own discretion.
|
|
2611
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
2612
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2559
2613
|
*/
|
|
2560
2614
|
interface Extension$ActionEventParameters {
|
|
2561
2615
|
/**
|
|
@@ -2599,8 +2653,8 @@ declare namespace sap {
|
|
|
2599
2653
|
/**
|
|
2600
2654
|
* Parameters of the Host#action event.
|
|
2601
2655
|
*
|
|
2602
|
-
* @experimental
|
|
2603
|
-
* be done before its official public release. Use at your own discretion.
|
|
2656
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
2657
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2604
2658
|
*/
|
|
2605
2659
|
interface Host$ActionEventParameters {
|
|
2606
2660
|
/**
|
|
@@ -2644,7 +2698,7 @@ declare namespace sap {
|
|
|
2644
2698
|
/**
|
|
2645
2699
|
* Parameters of the Host#cardConfigurationChange event.
|
|
2646
2700
|
*
|
|
2647
|
-
* @experimental
|
|
2701
|
+
* @experimental As of version 1.96.
|
|
2648
2702
|
*/
|
|
2649
2703
|
interface Host$CardConfigurationChangeEventParameters {
|
|
2650
2704
|
/**
|
|
@@ -2670,7 +2724,7 @@ declare namespace sap {
|
|
|
2670
2724
|
/**
|
|
2671
2725
|
* Parameters of the Host#cardInitialized event.
|
|
2672
2726
|
*
|
|
2673
|
-
* @experimental
|
|
2727
|
+
* @experimental As of version 1.116.
|
|
2674
2728
|
*/
|
|
2675
2729
|
interface Host$CardInitializedEventParameters {
|
|
2676
2730
|
/**
|
|
@@ -2682,7 +2736,7 @@ declare namespace sap {
|
|
|
2682
2736
|
/**
|
|
2683
2737
|
* Parameters of the Host#cardStateChanged event.
|
|
2684
2738
|
*
|
|
2685
|
-
* @experimental
|
|
2739
|
+
* @experimental As of version 1.107.
|
|
2686
2740
|
*/
|
|
2687
2741
|
interface Host$CardStateChangedEventParameters {
|
|
2688
2742
|
/**
|
|
@@ -2694,7 +2748,7 @@ declare namespace sap {
|
|
|
2694
2748
|
/**
|
|
2695
2749
|
* Parameters of the Host#message event.
|
|
2696
2750
|
*
|
|
2697
|
-
* @experimental
|
|
2751
|
+
* @experimental As of version 1.91.
|
|
2698
2752
|
*/
|
|
2699
2753
|
interface Host$MessageEventParameters {
|
|
2700
2754
|
data?: object;
|
|
@@ -2705,8 +2759,8 @@ declare namespace sap {
|
|
|
2705
2759
|
* in `Component` card and `Extension`.
|
|
2706
2760
|
*
|
|
2707
2761
|
* @since 1.85
|
|
2708
|
-
* @experimental
|
|
2709
|
-
* be done before its official public release. Use at your own discretion.
|
|
2762
|
+
* @experimental As of version 1.85. Disclaimer: this class is in a beta state - incompatible API changes
|
|
2763
|
+
* may be done before its official public release. Use at your own discretion.
|
|
2710
2764
|
*/
|
|
2711
2765
|
class ActionDefinition extends sap.ui.core.Element {
|
|
2712
2766
|
/**
|
|
@@ -2884,7 +2938,8 @@ declare namespace sap {
|
|
|
2884
2938
|
*
|
|
2885
2939
|
* Default value is `Transparent`.
|
|
2886
2940
|
*
|
|
2887
|
-
* @deprecated
|
|
2941
|
+
* @deprecated As of version 1.130. All `ActionDefinitions` are now rendered as menu items and don't have
|
|
2942
|
+
* `buttonType`.
|
|
2888
2943
|
*
|
|
2889
2944
|
* @returns Value of property `buttonType`
|
|
2890
2945
|
*/
|
|
@@ -3023,7 +3078,8 @@ declare namespace sap {
|
|
|
3023
3078
|
*
|
|
3024
3079
|
* Default value is `Transparent`.
|
|
3025
3080
|
*
|
|
3026
|
-
* @deprecated
|
|
3081
|
+
* @deprecated As of version 1.130. All `ActionDefinitions` are now rendered as menu items and don't have
|
|
3082
|
+
* `buttonType`.
|
|
3027
3083
|
*
|
|
3028
3084
|
* @returns Reference to `this` in order to allow method chaining
|
|
3029
3085
|
*/
|
|
@@ -3161,7 +3217,7 @@ declare namespace sap {
|
|
|
3161
3217
|
* be implemented.
|
|
3162
3218
|
*
|
|
3163
3219
|
* @since 1.75
|
|
3164
|
-
* @experimental
|
|
3220
|
+
* @experimental As of version 1.75.
|
|
3165
3221
|
*/
|
|
3166
3222
|
class Designtime extends sap.ui.base.ManagedObject {
|
|
3167
3223
|
/**
|
|
@@ -3321,8 +3377,8 @@ declare namespace sap {
|
|
|
3321
3377
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3322
3378
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3323
3379
|
*
|
|
3324
|
-
* @experimental
|
|
3325
|
-
* be done before its official public release. Use at your own discretion.
|
|
3380
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3381
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3326
3382
|
*
|
|
3327
3383
|
* @returns Reference to `this` in order to allow method chaining
|
|
3328
3384
|
*/
|
|
@@ -3353,8 +3409,8 @@ declare namespace sap {
|
|
|
3353
3409
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3354
3410
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3355
3411
|
*
|
|
3356
|
-
* @experimental
|
|
3357
|
-
* be done before its official public release. Use at your own discretion.
|
|
3412
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3413
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3358
3414
|
*
|
|
3359
3415
|
* @returns Reference to `this` in order to allow method chaining
|
|
3360
3416
|
*/
|
|
@@ -3373,8 +3429,8 @@ declare namespace sap {
|
|
|
3373
3429
|
*
|
|
3374
3430
|
* The passed function and listener object must match the ones used for event registration.
|
|
3375
3431
|
*
|
|
3376
|
-
* @experimental
|
|
3377
|
-
* be done before its official public release. Use at your own discretion.
|
|
3432
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3433
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3378
3434
|
*
|
|
3379
3435
|
* @returns Reference to `this` in order to allow method chaining
|
|
3380
3436
|
*/
|
|
@@ -3393,7 +3449,7 @@ declare namespace sap {
|
|
|
3393
3449
|
* the response is available. Use this method to override the default behavior when fetching network resources.
|
|
3394
3450
|
* Mimics the browser native Fetch API.
|
|
3395
3451
|
*
|
|
3396
|
-
* @experimental
|
|
3452
|
+
* @experimental As of version 1.113. The API might change.
|
|
3397
3453
|
*
|
|
3398
3454
|
* @returns A `Promise` that resolves to a `Response` object.
|
|
3399
3455
|
*/
|
|
@@ -3418,8 +3474,8 @@ declare namespace sap {
|
|
|
3418
3474
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3419
3475
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3420
3476
|
*
|
|
3421
|
-
* @experimental
|
|
3422
|
-
* be done before its official public release. Use at your own discretion.
|
|
3477
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3478
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3423
3479
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3424
3480
|
*
|
|
3425
3481
|
* @returns Whether or not to prevent the default action
|
|
@@ -3435,8 +3491,8 @@ declare namespace sap {
|
|
|
3435
3491
|
*
|
|
3436
3492
|
* The actions configuration.
|
|
3437
3493
|
*
|
|
3438
|
-
* @deprecated
|
|
3439
|
-
* @experimental
|
|
3494
|
+
* @deprecated As of version 1.85. This property is replaced by the `actions` aggregation of the card;
|
|
3495
|
+
* @experimental As of version 1.75. Disclaimer: this property is in a beta state - incompatible API changes
|
|
3440
3496
|
* may be done before its official public release. Use at your own discretion.
|
|
3441
3497
|
*
|
|
3442
3498
|
* @returns Value of property `actions`
|
|
@@ -3461,7 +3517,7 @@ declare namespace sap {
|
|
|
3461
3517
|
/**
|
|
3462
3518
|
* Override this method to lazy load dependencies for the extension.
|
|
3463
3519
|
*
|
|
3464
|
-
* @experimental
|
|
3520
|
+
* @experimental As of version 1.108.
|
|
3465
3521
|
*
|
|
3466
3522
|
* @returns Returns a promise. The card will wait for this promise to be resolved before continuing with
|
|
3467
3523
|
* the initialization.
|
|
@@ -3478,8 +3534,8 @@ declare namespace sap {
|
|
|
3478
3534
|
*
|
|
3479
3535
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3480
3536
|
*
|
|
3481
|
-
* @deprecated
|
|
3482
|
-
* @experimental
|
|
3537
|
+
* @deprecated As of version 1.85. This property is replaced by the `actions` aggregation of the card;
|
|
3538
|
+
* @experimental As of version 1.75. Disclaimer: this property is in a beta state - incompatible API changes
|
|
3483
3539
|
* may be done before its official public release. Use at your own discretion.
|
|
3484
3540
|
*
|
|
3485
3541
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -3512,7 +3568,7 @@ declare namespace sap {
|
|
|
3512
3568
|
* Examples may include, but are not limited to options like: share a card, remove a card.
|
|
3513
3569
|
*
|
|
3514
3570
|
* @since 1.75
|
|
3515
|
-
* @experimental
|
|
3571
|
+
* @experimental As of version 1.75.
|
|
3516
3572
|
*/
|
|
3517
3573
|
class Host extends sap.ui.core.Element {
|
|
3518
3574
|
/**
|
|
@@ -3589,8 +3645,8 @@ declare namespace sap {
|
|
|
3589
3645
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3590
3646
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3591
3647
|
*
|
|
3592
|
-
* @experimental
|
|
3593
|
-
* be done before its official public release. Use at your own discretion.
|
|
3648
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3649
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3594
3650
|
*
|
|
3595
3651
|
* @returns Reference to `this` in order to allow method chaining
|
|
3596
3652
|
*/
|
|
@@ -3621,8 +3677,8 @@ declare namespace sap {
|
|
|
3621
3677
|
* In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
|
|
3622
3678
|
* one to handle the action by calling `oEvent.preventDefault()`.
|
|
3623
3679
|
*
|
|
3624
|
-
* @experimental
|
|
3625
|
-
* be done before its official public release. Use at your own discretion.
|
|
3680
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3681
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3626
3682
|
*
|
|
3627
3683
|
* @returns Reference to `this` in order to allow method chaining
|
|
3628
3684
|
*/
|
|
@@ -3646,7 +3702,7 @@ declare namespace sap {
|
|
|
3646
3702
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3647
3703
|
* - filter value is changed.
|
|
3648
3704
|
*
|
|
3649
|
-
* @experimental
|
|
3705
|
+
* @experimental As of version 1.96.
|
|
3650
3706
|
*
|
|
3651
3707
|
* @returns Reference to `this` in order to allow method chaining
|
|
3652
3708
|
*/
|
|
@@ -3675,7 +3731,7 @@ declare namespace sap {
|
|
|
3675
3731
|
* Fired when some card configuration settings are changed as a result of user interaction. For example
|
|
3676
3732
|
* - filter value is changed.
|
|
3677
3733
|
*
|
|
3678
|
-
* @experimental
|
|
3734
|
+
* @experimental As of version 1.96.
|
|
3679
3735
|
*
|
|
3680
3736
|
* @returns Reference to `this` in order to allow method chaining
|
|
3681
3737
|
*/
|
|
@@ -3699,7 +3755,7 @@ declare namespace sap {
|
|
|
3699
3755
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3700
3756
|
* or data changes.
|
|
3701
3757
|
*
|
|
3702
|
-
* @experimental
|
|
3758
|
+
* @experimental As of version 1.116.
|
|
3703
3759
|
*
|
|
3704
3760
|
* @returns Reference to `this` in order to allow method chaining
|
|
3705
3761
|
*/
|
|
@@ -3728,7 +3784,7 @@ declare namespace sap {
|
|
|
3728
3784
|
* Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
|
|
3729
3785
|
* or data changes.
|
|
3730
3786
|
*
|
|
3731
|
-
* @experimental
|
|
3787
|
+
* @experimental As of version 1.116.
|
|
3732
3788
|
*
|
|
3733
3789
|
* @returns Reference to `this` in order to allow method chaining
|
|
3734
3790
|
*/
|
|
@@ -3752,7 +3808,7 @@ declare namespace sap {
|
|
|
3752
3808
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3753
3809
|
* the card, a filter is changed or data is refreshed.
|
|
3754
3810
|
*
|
|
3755
|
-
* @experimental
|
|
3811
|
+
* @experimental As of version 1.107.
|
|
3756
3812
|
*
|
|
3757
3813
|
* @returns Reference to `this` in order to allow method chaining
|
|
3758
3814
|
*/
|
|
@@ -3781,7 +3837,7 @@ declare namespace sap {
|
|
|
3781
3837
|
* Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
|
|
3782
3838
|
* the card, a filter is changed or data is refreshed.
|
|
3783
3839
|
*
|
|
3784
|
-
* @experimental
|
|
3840
|
+
* @experimental As of version 1.107.
|
|
3785
3841
|
*
|
|
3786
3842
|
* @returns Reference to `this` in order to allow method chaining
|
|
3787
3843
|
*/
|
|
@@ -3803,7 +3859,7 @@ declare namespace sap {
|
|
|
3803
3859
|
*
|
|
3804
3860
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
3805
3861
|
*
|
|
3806
|
-
* @experimental
|
|
3862
|
+
* @experimental As of version 1.91.
|
|
3807
3863
|
*
|
|
3808
3864
|
* @returns Reference to `this` in order to allow method chaining
|
|
3809
3865
|
*/
|
|
@@ -3830,7 +3886,7 @@ declare namespace sap {
|
|
|
3830
3886
|
*
|
|
3831
3887
|
* Fired when a message from channels like navigator.serviceWorker is received.
|
|
3832
3888
|
*
|
|
3833
|
-
* @experimental
|
|
3889
|
+
* @experimental As of version 1.91.
|
|
3834
3890
|
*
|
|
3835
3891
|
* @returns Reference to `this` in order to allow method chaining
|
|
3836
3892
|
*/
|
|
@@ -3847,8 +3903,8 @@ declare namespace sap {
|
|
|
3847
3903
|
/**
|
|
3848
3904
|
* This function is called when a CSRF token has expired.
|
|
3849
3905
|
*
|
|
3850
|
-
* @deprecated
|
|
3851
|
-
* @experimental
|
|
3906
|
+
* @deprecated As of version 1.120.0. the concept has been discarded.
|
|
3907
|
+
* @experimental As of version 1.97.
|
|
3852
3908
|
*/
|
|
3853
3909
|
csrfTokenExpired(
|
|
3854
3910
|
/**
|
|
@@ -3861,8 +3917,8 @@ declare namespace sap {
|
|
|
3861
3917
|
/**
|
|
3862
3918
|
* This function is called when a CSRF token is fetched.
|
|
3863
3919
|
*
|
|
3864
|
-
* @deprecated
|
|
3865
|
-
* @experimental
|
|
3920
|
+
* @deprecated As of version 1.120.0. the concept has been discarded.
|
|
3921
|
+
* @experimental As of version 1.97.
|
|
3866
3922
|
*/
|
|
3867
3923
|
csrfTokenFetched(
|
|
3868
3924
|
/**
|
|
@@ -3881,8 +3937,8 @@ declare namespace sap {
|
|
|
3881
3937
|
*
|
|
3882
3938
|
* The passed function and listener object must match the ones used for event registration.
|
|
3883
3939
|
*
|
|
3884
|
-
* @experimental
|
|
3885
|
-
* be done before its official public release. Use at your own discretion.
|
|
3940
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
3941
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3886
3942
|
*
|
|
3887
3943
|
* @returns Reference to `this` in order to allow method chaining
|
|
3888
3944
|
*/
|
|
@@ -3902,7 +3958,7 @@ declare namespace sap {
|
|
|
3902
3958
|
*
|
|
3903
3959
|
* The passed function and listener object must match the ones used for event registration.
|
|
3904
3960
|
*
|
|
3905
|
-
* @experimental
|
|
3961
|
+
* @experimental As of version 1.96.
|
|
3906
3962
|
*
|
|
3907
3963
|
* @returns Reference to `this` in order to allow method chaining
|
|
3908
3964
|
*/
|
|
@@ -3922,7 +3978,7 @@ declare namespace sap {
|
|
|
3922
3978
|
*
|
|
3923
3979
|
* The passed function and listener object must match the ones used for event registration.
|
|
3924
3980
|
*
|
|
3925
|
-
* @experimental
|
|
3981
|
+
* @experimental As of version 1.116.
|
|
3926
3982
|
*
|
|
3927
3983
|
* @returns Reference to `this` in order to allow method chaining
|
|
3928
3984
|
*/
|
|
@@ -3942,7 +3998,7 @@ declare namespace sap {
|
|
|
3942
3998
|
*
|
|
3943
3999
|
* The passed function and listener object must match the ones used for event registration.
|
|
3944
4000
|
*
|
|
3945
|
-
* @experimental
|
|
4001
|
+
* @experimental As of version 1.107.
|
|
3946
4002
|
*
|
|
3947
4003
|
* @returns Reference to `this` in order to allow method chaining
|
|
3948
4004
|
*/
|
|
@@ -3961,7 +4017,7 @@ declare namespace sap {
|
|
|
3961
4017
|
*
|
|
3962
4018
|
* The passed function and listener object must match the ones used for event registration.
|
|
3963
4019
|
*
|
|
3964
|
-
* @experimental
|
|
4020
|
+
* @experimental As of version 1.91.
|
|
3965
4021
|
*
|
|
3966
4022
|
* @returns Reference to `this` in order to allow method chaining
|
|
3967
4023
|
*/
|
|
@@ -3981,8 +4037,8 @@ declare namespace sap {
|
|
|
3981
4037
|
* Listeners may prevent the default action of this event by calling the `preventDefault` method on the
|
|
3982
4038
|
* event object. The return value of this method indicates whether the default action should be executed.
|
|
3983
4039
|
*
|
|
3984
|
-
* @experimental
|
|
3985
|
-
* be done before its official public release. Use at your own discretion.
|
|
4040
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
4041
|
+
* may be done before its official public release. Use at your own discretion.
|
|
3986
4042
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3987
4043
|
*
|
|
3988
4044
|
* @returns Whether or not to prevent the default action
|
|
@@ -3996,7 +4052,7 @@ declare namespace sap {
|
|
|
3996
4052
|
/**
|
|
3997
4053
|
* Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
|
|
3998
4054
|
*
|
|
3999
|
-
* @experimental
|
|
4055
|
+
* @experimental As of version 1.96.
|
|
4000
4056
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4001
4057
|
*
|
|
4002
4058
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4010,7 +4066,7 @@ declare namespace sap {
|
|
|
4010
4066
|
/**
|
|
4011
4067
|
* Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
|
|
4012
4068
|
*
|
|
4013
|
-
* @experimental
|
|
4069
|
+
* @experimental As of version 1.116.
|
|
4014
4070
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4015
4071
|
*
|
|
4016
4072
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4024,7 +4080,7 @@ declare namespace sap {
|
|
|
4024
4080
|
/**
|
|
4025
4081
|
* Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
|
|
4026
4082
|
*
|
|
4027
|
-
* @experimental
|
|
4083
|
+
* @experimental As of version 1.107.
|
|
4028
4084
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4029
4085
|
*
|
|
4030
4086
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4038,7 +4094,7 @@ declare namespace sap {
|
|
|
4038
4094
|
/**
|
|
4039
4095
|
* Fires event {@link #event:message message} to attached listeners.
|
|
4040
4096
|
*
|
|
4041
|
-
* @experimental
|
|
4097
|
+
* @experimental As of version 1.91.
|
|
4042
4098
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4043
4099
|
*
|
|
4044
4100
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4054,7 +4110,7 @@ declare namespace sap {
|
|
|
4054
4110
|
*
|
|
4055
4111
|
* The actions configuration.
|
|
4056
4112
|
*
|
|
4057
|
-
* @experimental
|
|
4113
|
+
* @experimental As of version 1.75. Disclaimer: this property is in a beta state - incompatible API changes
|
|
4058
4114
|
* may be done before its official public release. Use at your own discretion.
|
|
4059
4115
|
*
|
|
4060
4116
|
* @returns Value of property `actions`
|
|
@@ -4102,8 +4158,8 @@ declare namespace sap {
|
|
|
4102
4158
|
* Resolves the value of a CSRF token. Subclasses of Host can override this method to take over the default
|
|
4103
4159
|
* CSRF token resolving. Applications must not call this method directly, it is called by the framework.
|
|
4104
4160
|
*
|
|
4105
|
-
* @deprecated
|
|
4106
|
-
* @experimental
|
|
4161
|
+
* @deprecated As of version 1.120.0. the concept has been discarded.
|
|
4162
|
+
* @experimental As of version 1.97.
|
|
4107
4163
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4108
4164
|
*
|
|
4109
4165
|
* @returns A promise which resolves the CSRF token to its value.
|
|
@@ -4170,7 +4226,7 @@ declare namespace sap {
|
|
|
4170
4226
|
*
|
|
4171
4227
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4172
4228
|
*
|
|
4173
|
-
* @experimental
|
|
4229
|
+
* @experimental As of version 1.75. Disclaimer: this property is in a beta state - incompatible API changes
|
|
4174
4230
|
* may be done before its official public release. Use at your own discretion.
|
|
4175
4231
|
*
|
|
4176
4232
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -4229,32 +4285,32 @@ declare namespace sap {
|
|
|
4229
4285
|
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
4230
4286
|
* 'CardActionType'.
|
|
4231
4287
|
*
|
|
4232
|
-
* @experimental
|
|
4288
|
+
* @experimental As of version 1.64. Disclaimer: this property is in a beta state - incompatible API changes
|
|
4233
4289
|
* may be done before its official public release. Use at your own discretion.
|
|
4234
4290
|
*/
|
|
4235
4291
|
enum CardActionType {
|
|
4236
4292
|
/**
|
|
4237
4293
|
* Used for custom actions.
|
|
4238
4294
|
*
|
|
4239
|
-
* @experimental
|
|
4295
|
+
* @experimental As of version 1.76.
|
|
4240
4296
|
*/
|
|
4241
4297
|
Custom = "Custom",
|
|
4242
4298
|
/**
|
|
4243
4299
|
* Date selection. Available only for Calendar cards.
|
|
4244
4300
|
*
|
|
4245
|
-
* @experimental
|
|
4301
|
+
* @experimental As of version 1.87.
|
|
4246
4302
|
*/
|
|
4247
4303
|
DateChange = "DateChange",
|
|
4248
4304
|
/**
|
|
4249
4305
|
* Used for hiding the appeared details about the card.
|
|
4250
4306
|
*
|
|
4251
|
-
* @experimental
|
|
4307
|
+
* @experimental As of version 1.100.
|
|
4252
4308
|
*/
|
|
4253
4309
|
HideCard = "HideCard",
|
|
4254
4310
|
/**
|
|
4255
4311
|
* Month selection. Available only for Calendar cards.
|
|
4256
4312
|
*
|
|
4257
|
-
* @experimental
|
|
4313
|
+
* @experimental As of version 1.87.
|
|
4258
4314
|
*/
|
|
4259
4315
|
MonthChange = "MonthChange",
|
|
4260
4316
|
/**
|
|
@@ -4264,7 +4320,7 @@ declare namespace sap {
|
|
|
4264
4320
|
/**
|
|
4265
4321
|
* Used for showing more details about the card.
|
|
4266
4322
|
*
|
|
4267
|
-
* @experimental
|
|
4323
|
+
* @experimental As of version 1.100.
|
|
4268
4324
|
*/
|
|
4269
4325
|
ShowCard = "ShowCard",
|
|
4270
4326
|
/**
|
|
@@ -4300,7 +4356,7 @@ declare namespace sap {
|
|
|
4300
4356
|
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
4301
4357
|
* 'CardBlockingMessageType'.
|
|
4302
4358
|
*
|
|
4303
|
-
* @experimental
|
|
4359
|
+
* @experimental As of version 1.114.
|
|
4304
4360
|
*/
|
|
4305
4361
|
enum CardBlockingMessageType {
|
|
4306
4362
|
/**
|
|
@@ -4323,7 +4379,7 @@ declare namespace sap {
|
|
|
4323
4379
|
* 'CardDataMode'.
|
|
4324
4380
|
*
|
|
4325
4381
|
* @since 1.65
|
|
4326
|
-
* @experimental
|
|
4382
|
+
* @experimental As of version 1.65.
|
|
4327
4383
|
*/
|
|
4328
4384
|
enum CardDataMode {
|
|
4329
4385
|
/**
|
|
@@ -4346,7 +4402,7 @@ declare namespace sap {
|
|
|
4346
4402
|
* 'CardDesign'.
|
|
4347
4403
|
*
|
|
4348
4404
|
* @since 1.109
|
|
4349
|
-
* @experimental
|
|
4405
|
+
* @experimental As of version 1.109.
|
|
4350
4406
|
*/
|
|
4351
4407
|
enum CardDesign {
|
|
4352
4408
|
/**
|
|
@@ -4365,7 +4421,7 @@ declare namespace sap {
|
|
|
4365
4421
|
* 'CardDisplayVariant'.
|
|
4366
4422
|
*
|
|
4367
4423
|
* @since 1.118
|
|
4368
|
-
* @experimental
|
|
4424
|
+
* @experimental As of version 1.118. For usage only by Work Zone.
|
|
4369
4425
|
*/
|
|
4370
4426
|
enum CardDisplayVariant {
|
|
4371
4427
|
/**
|
|
@@ -4415,7 +4471,7 @@ declare namespace sap {
|
|
|
4415
4471
|
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
4416
4472
|
* 'CardMessageType'.
|
|
4417
4473
|
*
|
|
4418
|
-
* @experimental
|
|
4474
|
+
* @experimental As of version 1.128.
|
|
4419
4475
|
*/
|
|
4420
4476
|
enum CardMessageType {
|
|
4421
4477
|
/**
|
|
@@ -4448,6 +4504,35 @@ declare namespace sap {
|
|
|
4448
4504
|
*/
|
|
4449
4505
|
Warning = "Warning",
|
|
4450
4506
|
}
|
|
4507
|
+
/**
|
|
4508
|
+
* Determines the overflow behaviour of the card.
|
|
4509
|
+
*
|
|
4510
|
+
* This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
|
|
4511
|
+
* 'CardOverflow'.
|
|
4512
|
+
*
|
|
4513
|
+
* @since 1.133
|
|
4514
|
+
* @experimental As of version 1.133.
|
|
4515
|
+
*/
|
|
4516
|
+
enum CardOverflow {
|
|
4517
|
+
/**
|
|
4518
|
+
* The overflowing part of the card is hidden.
|
|
4519
|
+
*
|
|
4520
|
+
* **Note**: If the "Default" option is used, the card must be allowed to grow in height as much as it needs
|
|
4521
|
+
* to avoid overflowing. Use a layout which allows this.
|
|
4522
|
+
*/
|
|
4523
|
+
Default = "Default",
|
|
4524
|
+
/**
|
|
4525
|
+
* The overflowing part of the card is hidden, but a 'Show More' button is displayed in the footer. By pressing
|
|
4526
|
+
* the button, the full content will be displayed.
|
|
4527
|
+
*
|
|
4528
|
+
* **Note**: If this option is used, the "minHeight" setting for cards of type Analytical, AnalyticsCloud
|
|
4529
|
+
* and WebPage will be ignored.
|
|
4530
|
+
*
|
|
4531
|
+
* **Disclaimer**: This feature is not suitable for object cards with forms. It might lead to undesired
|
|
4532
|
+
* user interaction.
|
|
4533
|
+
*/
|
|
4534
|
+
ShowMore = "ShowMore",
|
|
4535
|
+
}
|
|
4451
4536
|
/**
|
|
4452
4537
|
* Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
|
|
4453
4538
|
* choosing or configuring a card.
|
|
@@ -4456,7 +4541,7 @@ declare namespace sap {
|
|
|
4456
4541
|
* 'CardPreviewMode'.
|
|
4457
4542
|
*
|
|
4458
4543
|
* @since 1.112
|
|
4459
|
-
* @experimental
|
|
4544
|
+
* @experimental As of version 1.112.
|
|
4460
4545
|
*/
|
|
4461
4546
|
enum CardPreviewMode {
|
|
4462
4547
|
/**
|
|
@@ -4475,7 +4560,7 @@ declare namespace sap {
|
|
|
4475
4560
|
/**
|
|
4476
4561
|
* Settings for blocking message that ocurred in a {@link sap.ui.integration.widgets.Card}
|
|
4477
4562
|
*
|
|
4478
|
-
* @experimental
|
|
4563
|
+
* @experimental As of version 1.114.
|
|
4479
4564
|
*/
|
|
4480
4565
|
type BlockingMessageSettings = {
|
|
4481
4566
|
/**
|
|
@@ -4516,7 +4601,7 @@ declare namespace sap {
|
|
|
4516
4601
|
/**
|
|
4517
4602
|
* An object type that represents card menu action properties.
|
|
4518
4603
|
*
|
|
4519
|
-
* @experimental
|
|
4604
|
+
* @experimental As of version 1.79.
|
|
4520
4605
|
*/
|
|
4521
4606
|
type CardMenuAction = {
|
|
4522
4607
|
/**
|
|
@@ -4576,8 +4661,8 @@ declare namespace sap {
|
|
|
4576
4661
|
/**
|
|
4577
4662
|
* Event object of the Extension#action event.
|
|
4578
4663
|
*
|
|
4579
|
-
* @experimental
|
|
4580
|
-
* be done before its official public release. Use at your own discretion.
|
|
4664
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
4665
|
+
* may be done before its official public release. Use at your own discretion.
|
|
4581
4666
|
*/
|
|
4582
4667
|
type Extension$ActionEvent = sap.ui.base.Event<
|
|
4583
4668
|
Extension$ActionEventParameters,
|
|
@@ -4587,8 +4672,8 @@ declare namespace sap {
|
|
|
4587
4672
|
/**
|
|
4588
4673
|
* Event object of the Host#action event.
|
|
4589
4674
|
*
|
|
4590
|
-
* @experimental
|
|
4591
|
-
* be done before its official public release. Use at your own discretion.
|
|
4675
|
+
* @experimental As of version 1.75. Disclaimer: this event is in a beta state - incompatible API changes
|
|
4676
|
+
* may be done before its official public release. Use at your own discretion.
|
|
4592
4677
|
*/
|
|
4593
4678
|
type Host$ActionEvent = sap.ui.base.Event<
|
|
4594
4679
|
Host$ActionEventParameters,
|
|
@@ -4598,7 +4683,7 @@ declare namespace sap {
|
|
|
4598
4683
|
/**
|
|
4599
4684
|
* Event object of the Host#cardConfigurationChange event.
|
|
4600
4685
|
*
|
|
4601
|
-
* @experimental
|
|
4686
|
+
* @experimental As of version 1.96.
|
|
4602
4687
|
*/
|
|
4603
4688
|
type Host$CardConfigurationChangeEvent = sap.ui.base.Event<
|
|
4604
4689
|
Host$CardConfigurationChangeEventParameters,
|
|
@@ -4608,7 +4693,7 @@ declare namespace sap {
|
|
|
4608
4693
|
/**
|
|
4609
4694
|
* Event object of the Host#cardInitialized event.
|
|
4610
4695
|
*
|
|
4611
|
-
* @experimental
|
|
4696
|
+
* @experimental As of version 1.116.
|
|
4612
4697
|
*/
|
|
4613
4698
|
type Host$CardInitializedEvent = sap.ui.base.Event<
|
|
4614
4699
|
Host$CardInitializedEventParameters,
|
|
@@ -4618,7 +4703,7 @@ declare namespace sap {
|
|
|
4618
4703
|
/**
|
|
4619
4704
|
* Event object of the Host#cardStateChanged event.
|
|
4620
4705
|
*
|
|
4621
|
-
* @experimental
|
|
4706
|
+
* @experimental As of version 1.107.
|
|
4622
4707
|
*/
|
|
4623
4708
|
type Host$CardStateChangedEvent = sap.ui.base.Event<
|
|
4624
4709
|
Host$CardStateChangedEventParameters,
|
|
@@ -4628,7 +4713,7 @@ declare namespace sap {
|
|
|
4628
4713
|
/**
|
|
4629
4714
|
* Event object of the Host#message event.
|
|
4630
4715
|
*
|
|
4631
|
-
* @experimental
|
|
4716
|
+
* @experimental As of version 1.91.
|
|
4632
4717
|
*/
|
|
4633
4718
|
type Host$MessageEvent = sap.ui.base.Event<
|
|
4634
4719
|
Host$MessageEventParameters,
|
|
@@ -4788,6 +4873,8 @@ declare namespace sap {
|
|
|
4788
4873
|
|
|
4789
4874
|
"sap/ui/integration/util/ManifestResolver": undefined;
|
|
4790
4875
|
|
|
4876
|
+
"sap/ui/integration/util/openCardShowMore": undefined;
|
|
4877
|
+
|
|
4791
4878
|
"sap/ui/integration/util/RequestDataProvider": undefined;
|
|
4792
4879
|
|
|
4793
4880
|
"sap/ui/integration/util/SkeletonCard": undefined;
|