@sapui5/ts-types 1.151.0 → 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/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 +18 -1
- package/types/sap.f.d.ts +1189 -292
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- 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 +40 -34
- package/types/sap.fe.navigation.d.ts +1 -1
- 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 +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +14 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +114 -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 +915 -3
- 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 +1 -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 +175 -12
- 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 +1 -1
- package/types/sap.ui.integration.d.ts +101 -325
- package/types/sap.ui.joule.frontend.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +33 -7
- package/types/sap.ui.mdc.d.ts +26 -1
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +3 -3
- 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 +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +60 -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 +63 -46
- 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
package/types/sap.f.d.ts
CHANGED
|
@@ -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
|
/**
|
|
@@ -69,25 +69,15 @@ declare namespace sap {
|
|
|
69
69
|
*
|
|
70
70
|
* Will be shown as a relative time like "5 minutes ago".
|
|
71
71
|
*
|
|
72
|
-
* @
|
|
72
|
+
* @since 1.89
|
|
73
73
|
*/
|
|
74
74
|
dataTimestamp?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
75
75
|
|
|
76
|
-
/**
|
|
77
|
-
* Defines the status text visibility.
|
|
78
|
-
*
|
|
79
|
-
* @experimental As of version 1.116.
|
|
80
|
-
*/
|
|
81
|
-
statusVisible?:
|
|
82
|
-
| boolean
|
|
83
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
84
|
-
| `{${string}}`;
|
|
85
|
-
|
|
86
76
|
/**
|
|
87
77
|
* Defines the type of text wrapping to be used inside the header. This applies to title, subtitle and details
|
|
88
78
|
* texts of the header.
|
|
89
79
|
*
|
|
90
|
-
* @
|
|
80
|
+
* @since 1.122
|
|
91
81
|
*/
|
|
92
82
|
wrappingType?:
|
|
93
83
|
| sap.m.WrappingType
|
|
@@ -97,7 +87,7 @@ declare namespace sap {
|
|
|
97
87
|
/**
|
|
98
88
|
* Info sections to be displayed in the header.
|
|
99
89
|
*
|
|
100
|
-
* @
|
|
90
|
+
* @since 1.136
|
|
101
91
|
*/
|
|
102
92
|
infoSection?:
|
|
103
93
|
| sap.ui.core.Control[]
|
|
@@ -106,9 +96,10 @@ declare namespace sap {
|
|
|
106
96
|
| `{${string}}`;
|
|
107
97
|
|
|
108
98
|
/**
|
|
109
|
-
* Defines the toolbar
|
|
99
|
+
* Defines an additional content shown in the header's toolbar area, typically actions such as a close button
|
|
100
|
+
* or a menu.
|
|
110
101
|
*
|
|
111
|
-
* @
|
|
102
|
+
* @since 1.86
|
|
112
103
|
*/
|
|
113
104
|
toolbar?: sap.ui.core.Control;
|
|
114
105
|
|
|
@@ -184,7 +175,7 @@ declare namespace sap {
|
|
|
184
175
|
/**
|
|
185
176
|
* Limits the number of lines for the title.
|
|
186
177
|
*
|
|
187
|
-
* @
|
|
178
|
+
* @since 1.101
|
|
188
179
|
*/
|
|
189
180
|
titleMaxLines?:
|
|
190
181
|
| int
|
|
@@ -199,7 +190,7 @@ declare namespace sap {
|
|
|
199
190
|
/**
|
|
200
191
|
* Limits the number of lines for the subtitle.
|
|
201
192
|
*
|
|
202
|
-
* @
|
|
193
|
+
* @since 1.101
|
|
203
194
|
*/
|
|
204
195
|
subtitleMaxLines?:
|
|
205
196
|
| int
|
|
@@ -235,34 +226,24 @@ declare namespace sap {
|
|
|
235
226
|
/**
|
|
236
227
|
* Defines an alt text for the avatar or icon.
|
|
237
228
|
*
|
|
238
|
-
* @
|
|
229
|
+
* @since 1.81
|
|
239
230
|
*/
|
|
240
231
|
iconAlt?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
241
232
|
|
|
242
233
|
/**
|
|
243
234
|
* Defines a background color for the avatar or icon.
|
|
244
235
|
*
|
|
245
|
-
* @
|
|
236
|
+
* @since 1.83
|
|
246
237
|
*/
|
|
247
238
|
iconBackgroundColor?:
|
|
248
239
|
| sap.m.AvatarColor
|
|
249
240
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
250
241
|
| `{${string}}`;
|
|
251
242
|
|
|
252
|
-
/**
|
|
253
|
-
* Defines whether the card icon is visible.
|
|
254
|
-
*
|
|
255
|
-
* @experimental As of version 1.83.
|
|
256
|
-
*/
|
|
257
|
-
iconVisible?:
|
|
258
|
-
| boolean
|
|
259
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
260
|
-
| `{${string}}`;
|
|
261
|
-
|
|
262
243
|
/**
|
|
263
244
|
* Defines the size of the icon.
|
|
264
245
|
*
|
|
265
|
-
* @
|
|
246
|
+
* @since 1.119
|
|
266
247
|
*/
|
|
267
248
|
iconSize?:
|
|
268
249
|
| sap.m.AvatarSize
|
|
@@ -302,7 +283,7 @@ declare namespace sap {
|
|
|
302
283
|
/**
|
|
303
284
|
* Limits the number of lines for the title.
|
|
304
285
|
*
|
|
305
|
-
* @
|
|
286
|
+
* @since 1.101
|
|
306
287
|
*/
|
|
307
288
|
titleMaxLines?:
|
|
308
289
|
| int
|
|
@@ -317,7 +298,7 @@ declare namespace sap {
|
|
|
317
298
|
/**
|
|
318
299
|
* Limits the number of lines for the subtitle.
|
|
319
300
|
*
|
|
320
|
-
* @
|
|
301
|
+
* @since 1.101
|
|
321
302
|
*/
|
|
322
303
|
subtitleMaxLines?:
|
|
323
304
|
| int
|
|
@@ -329,10 +310,54 @@ declare namespace sap {
|
|
|
329
310
|
*/
|
|
330
311
|
statusText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
331
312
|
|
|
313
|
+
/**
|
|
314
|
+
* Defines the shape of the icon.
|
|
315
|
+
*
|
|
316
|
+
* @since 1.118
|
|
317
|
+
*/
|
|
318
|
+
iconDisplayShape?:
|
|
319
|
+
| sap.m.AvatarShape
|
|
320
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
321
|
+
| `{${string}}`;
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Defines the icon source.
|
|
325
|
+
*
|
|
326
|
+
* @since 1.118
|
|
327
|
+
*/
|
|
328
|
+
iconSrc?:
|
|
329
|
+
| sap.ui.core.URI
|
|
330
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
331
|
+
| `{${string}}`;
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Defines the initials of the icon.
|
|
335
|
+
*
|
|
336
|
+
* @since 1.118
|
|
337
|
+
*/
|
|
338
|
+
iconInitials?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Defines an alt text for the avatar or icon.
|
|
342
|
+
*
|
|
343
|
+
* @since 1.118
|
|
344
|
+
*/
|
|
345
|
+
iconAlt?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Defines a background color for the avatar or icon.
|
|
349
|
+
*
|
|
350
|
+
* @since 1.118
|
|
351
|
+
*/
|
|
352
|
+
iconBackgroundColor?:
|
|
353
|
+
| sap.m.AvatarColor
|
|
354
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
355
|
+
| `{${string}}`;
|
|
356
|
+
|
|
332
357
|
/**
|
|
333
358
|
* Defines the size of the icon.
|
|
334
359
|
*
|
|
335
|
-
* @
|
|
360
|
+
* @since 1.119
|
|
336
361
|
*/
|
|
337
362
|
iconSize?:
|
|
338
363
|
| sap.m.AvatarSize
|
|
@@ -395,7 +420,7 @@ declare namespace sap {
|
|
|
395
420
|
/**
|
|
396
421
|
* The semantic color which represents the state of the main number indicator.
|
|
397
422
|
*
|
|
398
|
-
* @
|
|
423
|
+
* @since 1.64
|
|
399
424
|
*/
|
|
400
425
|
state?:
|
|
401
426
|
| sap.m.ValueColor
|
|
@@ -410,7 +435,7 @@ declare namespace sap {
|
|
|
410
435
|
/**
|
|
411
436
|
* Limits the number of lines for the details.
|
|
412
437
|
*
|
|
413
|
-
* @
|
|
438
|
+
* @since 1.101
|
|
414
439
|
*/
|
|
415
440
|
detailsMaxLines?:
|
|
416
441
|
| int
|
|
@@ -438,7 +463,7 @@ declare namespace sap {
|
|
|
438
463
|
/**
|
|
439
464
|
* Micro Chart
|
|
440
465
|
*
|
|
441
|
-
* @
|
|
466
|
+
* @since 1.124
|
|
442
467
|
*/
|
|
443
468
|
microChart?: sap.ui.core.Control;
|
|
444
469
|
}
|
|
@@ -466,7 +491,7 @@ declare namespace sap {
|
|
|
466
491
|
/**
|
|
467
492
|
* The semantic color which represents the state of the side indicator.
|
|
468
493
|
*
|
|
469
|
-
* @
|
|
494
|
+
* @since 1.95
|
|
470
495
|
*/
|
|
471
496
|
state?:
|
|
472
497
|
| sap.m.ValueColor
|
|
@@ -552,7 +577,7 @@ declare namespace sap {
|
|
|
552
577
|
/**
|
|
553
578
|
* Adds some infoSection to the aggregation {@link #getInfoSection infoSection}.
|
|
554
579
|
*
|
|
555
|
-
* @
|
|
580
|
+
* @since 1.136
|
|
556
581
|
*
|
|
557
582
|
* @returns Reference to `this` in order to allow method chaining
|
|
558
583
|
*/
|
|
@@ -612,7 +637,7 @@ declare namespace sap {
|
|
|
612
637
|
/**
|
|
613
638
|
* Destroys all the infoSection in the aggregation {@link #getInfoSection infoSection}.
|
|
614
639
|
*
|
|
615
|
-
* @
|
|
640
|
+
* @since 1.136
|
|
616
641
|
*
|
|
617
642
|
* @returns Reference to `this` in order to allow method chaining
|
|
618
643
|
*/
|
|
@@ -620,7 +645,7 @@ declare namespace sap {
|
|
|
620
645
|
/**
|
|
621
646
|
* Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
|
|
622
647
|
*
|
|
623
|
-
* @
|
|
648
|
+
* @since 1.86
|
|
624
649
|
*
|
|
625
650
|
* @returns Reference to `this` in order to allow method chaining
|
|
626
651
|
*/
|
|
@@ -668,7 +693,7 @@ declare namespace sap {
|
|
|
668
693
|
*
|
|
669
694
|
* Default value is `empty string`.
|
|
670
695
|
*
|
|
671
|
-
* @
|
|
696
|
+
* @since 1.89
|
|
672
697
|
*
|
|
673
698
|
* @returns Value of property `dataTimestamp`
|
|
674
699
|
*/
|
|
@@ -678,27 +703,16 @@ declare namespace sap {
|
|
|
678
703
|
*
|
|
679
704
|
* Info sections to be displayed in the header.
|
|
680
705
|
*
|
|
681
|
-
* @
|
|
706
|
+
* @since 1.136
|
|
682
707
|
*/
|
|
683
708
|
getInfoSection(): sap.ui.core.Control[];
|
|
684
|
-
/**
|
|
685
|
-
* Gets current value of property {@link #getStatusVisible statusVisible}.
|
|
686
|
-
*
|
|
687
|
-
* Defines the status text visibility.
|
|
688
|
-
*
|
|
689
|
-
* Default value is `true`.
|
|
690
|
-
*
|
|
691
|
-
* @experimental As of version 1.116.
|
|
692
|
-
*
|
|
693
|
-
* @returns Value of property `statusVisible`
|
|
694
|
-
*/
|
|
695
|
-
getStatusVisible(): boolean;
|
|
696
709
|
/**
|
|
697
710
|
* Gets content of aggregation {@link #getToolbar toolbar}.
|
|
698
711
|
*
|
|
699
|
-
* Defines the toolbar
|
|
712
|
+
* Defines an additional content shown in the header's toolbar area, typically actions such as a close button
|
|
713
|
+
* or a menu.
|
|
700
714
|
*
|
|
701
|
-
* @
|
|
715
|
+
* @since 1.86
|
|
702
716
|
*/
|
|
703
717
|
getToolbar(): sap.ui.core.Control;
|
|
704
718
|
/**
|
|
@@ -709,7 +723,7 @@ declare namespace sap {
|
|
|
709
723
|
*
|
|
710
724
|
* Default value is `Normal`.
|
|
711
725
|
*
|
|
712
|
-
* @
|
|
726
|
+
* @since 1.122
|
|
713
727
|
*
|
|
714
728
|
* @returns Value of property `wrappingType`
|
|
715
729
|
*/
|
|
@@ -718,7 +732,7 @@ declare namespace sap {
|
|
|
718
732
|
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getInfoSection infoSection}.
|
|
719
733
|
* and returns its index if found or -1 otherwise.
|
|
720
734
|
*
|
|
721
|
-
* @
|
|
735
|
+
* @since 1.136
|
|
722
736
|
*
|
|
723
737
|
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
724
738
|
*/
|
|
@@ -731,7 +745,7 @@ declare namespace sap {
|
|
|
731
745
|
/**
|
|
732
746
|
* Inserts a infoSection into the aggregation {@link #getInfoSection infoSection}.
|
|
733
747
|
*
|
|
734
|
-
* @
|
|
748
|
+
* @since 1.136
|
|
735
749
|
*
|
|
736
750
|
* @returns Reference to `this` in order to allow method chaining
|
|
737
751
|
*/
|
|
@@ -752,7 +766,7 @@ declare namespace sap {
|
|
|
752
766
|
*
|
|
753
767
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
754
768
|
*
|
|
755
|
-
* @
|
|
769
|
+
* @since 1.136
|
|
756
770
|
*
|
|
757
771
|
* @returns An array of the removed elements (might be empty)
|
|
758
772
|
*/
|
|
@@ -760,7 +774,7 @@ declare namespace sap {
|
|
|
760
774
|
/**
|
|
761
775
|
* Removes a infoSection from the aggregation {@link #getInfoSection infoSection}.
|
|
762
776
|
*
|
|
763
|
-
* @
|
|
777
|
+
* @since 1.136
|
|
764
778
|
*
|
|
765
779
|
* @returns The removed infoSection or `null`
|
|
766
780
|
*/
|
|
@@ -784,7 +798,7 @@ declare namespace sap {
|
|
|
784
798
|
*
|
|
785
799
|
* Default value is `empty string`.
|
|
786
800
|
*
|
|
787
|
-
* @
|
|
801
|
+
* @since 1.89
|
|
788
802
|
*
|
|
789
803
|
* @returns Reference to `this` in order to allow method chaining
|
|
790
804
|
*/
|
|
@@ -794,29 +808,10 @@ declare namespace sap {
|
|
|
794
808
|
*/
|
|
795
809
|
sDataTimestamp?: string
|
|
796
810
|
): this;
|
|
797
|
-
/**
|
|
798
|
-
* Sets a new value for property {@link #getStatusVisible statusVisible}.
|
|
799
|
-
*
|
|
800
|
-
* Defines the status text visibility.
|
|
801
|
-
*
|
|
802
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
803
|
-
*
|
|
804
|
-
* Default value is `true`.
|
|
805
|
-
*
|
|
806
|
-
* @experimental As of version 1.116.
|
|
807
|
-
*
|
|
808
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
809
|
-
*/
|
|
810
|
-
setStatusVisible(
|
|
811
|
-
/**
|
|
812
|
-
* New value for property `statusVisible`
|
|
813
|
-
*/
|
|
814
|
-
bStatusVisible?: boolean
|
|
815
|
-
): this;
|
|
816
811
|
/**
|
|
817
812
|
* Sets the aggregated {@link #getToolbar toolbar}.
|
|
818
813
|
*
|
|
819
|
-
* @
|
|
814
|
+
* @since 1.86
|
|
820
815
|
*
|
|
821
816
|
* @returns Reference to `this` in order to allow method chaining
|
|
822
817
|
*/
|
|
@@ -836,7 +831,7 @@ declare namespace sap {
|
|
|
836
831
|
*
|
|
837
832
|
* Default value is `Normal`.
|
|
838
833
|
*
|
|
839
|
-
* @
|
|
834
|
+
* @since 1.122
|
|
840
835
|
*
|
|
841
836
|
* @returns Reference to `this` in order to allow method chaining
|
|
842
837
|
*/
|
|
@@ -1178,7 +1173,7 @@ declare namespace sap {
|
|
|
1178
1173
|
*
|
|
1179
1174
|
* Default value is `empty string`.
|
|
1180
1175
|
*
|
|
1181
|
-
* @
|
|
1176
|
+
* @since 1.81
|
|
1182
1177
|
*
|
|
1183
1178
|
* @returns Value of property `iconAlt`
|
|
1184
1179
|
*/
|
|
@@ -1190,7 +1185,7 @@ declare namespace sap {
|
|
|
1190
1185
|
*
|
|
1191
1186
|
* Default value is `Transparent`.
|
|
1192
1187
|
*
|
|
1193
|
-
* @
|
|
1188
|
+
* @since 1.83
|
|
1194
1189
|
*
|
|
1195
1190
|
* @returns Value of property `iconBackgroundColor`
|
|
1196
1191
|
*/
|
|
@@ -1236,7 +1231,7 @@ declare namespace sap {
|
|
|
1236
1231
|
*
|
|
1237
1232
|
* Default value is `S`.
|
|
1238
1233
|
*
|
|
1239
|
-
* @
|
|
1234
|
+
* @since 1.119
|
|
1240
1235
|
*
|
|
1241
1236
|
* @returns Value of property `iconSize`
|
|
1242
1237
|
*/
|
|
@@ -1264,18 +1259,6 @@ declare namespace sap {
|
|
|
1264
1259
|
* @returns Value of property `iconState`
|
|
1265
1260
|
*/
|
|
1266
1261
|
getIconState(): sap.ui.core.ValueState;
|
|
1267
|
-
/**
|
|
1268
|
-
* Gets current value of property {@link #getIconVisible iconVisible}.
|
|
1269
|
-
*
|
|
1270
|
-
* Defines whether the card icon is visible.
|
|
1271
|
-
*
|
|
1272
|
-
* Default value is `true`.
|
|
1273
|
-
*
|
|
1274
|
-
* @experimental As of version 1.83.
|
|
1275
|
-
*
|
|
1276
|
-
* @returns Value of property `iconVisible`
|
|
1277
|
-
*/
|
|
1278
|
-
getIconVisible(): boolean;
|
|
1279
1262
|
/**
|
|
1280
1263
|
* Gets current value of property {@link #getStatusText statusText}.
|
|
1281
1264
|
*
|
|
@@ -1305,7 +1288,7 @@ declare namespace sap {
|
|
|
1305
1288
|
*
|
|
1306
1289
|
* Default value is `2`.
|
|
1307
1290
|
*
|
|
1308
|
-
* @
|
|
1291
|
+
* @since 1.101
|
|
1309
1292
|
*
|
|
1310
1293
|
* @returns Value of property `subtitleMaxLines`
|
|
1311
1294
|
*/
|
|
@@ -1328,7 +1311,7 @@ declare namespace sap {
|
|
|
1328
1311
|
*
|
|
1329
1312
|
* Default value is `3`.
|
|
1330
1313
|
*
|
|
1331
|
-
* @
|
|
1314
|
+
* @since 1.101
|
|
1332
1315
|
*
|
|
1333
1316
|
* @returns Value of property `titleMaxLines`
|
|
1334
1317
|
*/
|
|
@@ -1342,7 +1325,7 @@ declare namespace sap {
|
|
|
1342
1325
|
*
|
|
1343
1326
|
* Default value is `empty string`.
|
|
1344
1327
|
*
|
|
1345
|
-
* @
|
|
1328
|
+
* @since 1.81
|
|
1346
1329
|
*
|
|
1347
1330
|
* @returns Reference to `this` in order to allow method chaining
|
|
1348
1331
|
*/
|
|
@@ -1361,7 +1344,7 @@ declare namespace sap {
|
|
|
1361
1344
|
*
|
|
1362
1345
|
* Default value is `Transparent`.
|
|
1363
1346
|
*
|
|
1364
|
-
* @
|
|
1347
|
+
* @since 1.83
|
|
1365
1348
|
*
|
|
1366
1349
|
* @returns Reference to `this` in order to allow method chaining
|
|
1367
1350
|
*/
|
|
@@ -1435,7 +1418,7 @@ declare namespace sap {
|
|
|
1435
1418
|
*
|
|
1436
1419
|
* Default value is `S`.
|
|
1437
1420
|
*
|
|
1438
|
-
* @
|
|
1421
|
+
* @since 1.119
|
|
1439
1422
|
*
|
|
1440
1423
|
* @returns Reference to `this` in order to allow method chaining
|
|
1441
1424
|
*/
|
|
@@ -1482,25 +1465,6 @@ declare namespace sap {
|
|
|
1482
1465
|
*/
|
|
1483
1466
|
sIconState?: sap.ui.core.ValueState
|
|
1484
1467
|
): this;
|
|
1485
|
-
/**
|
|
1486
|
-
* Sets a new value for property {@link #getIconVisible iconVisible}.
|
|
1487
|
-
*
|
|
1488
|
-
* Defines whether the card icon is visible.
|
|
1489
|
-
*
|
|
1490
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1491
|
-
*
|
|
1492
|
-
* Default value is `true`.
|
|
1493
|
-
*
|
|
1494
|
-
* @experimental As of version 1.83.
|
|
1495
|
-
*
|
|
1496
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1497
|
-
*/
|
|
1498
|
-
setIconVisible(
|
|
1499
|
-
/**
|
|
1500
|
-
* New value for property `iconVisible`
|
|
1501
|
-
*/
|
|
1502
|
-
bIconVisible?: boolean
|
|
1503
|
-
): this;
|
|
1504
1468
|
/**
|
|
1505
1469
|
* Sets a new value for property {@link #getStatusText statusText}.
|
|
1506
1470
|
*
|
|
@@ -1546,7 +1510,7 @@ declare namespace sap {
|
|
|
1546
1510
|
*
|
|
1547
1511
|
* Default value is `2`.
|
|
1548
1512
|
*
|
|
1549
|
-
* @
|
|
1513
|
+
* @since 1.101
|
|
1550
1514
|
*
|
|
1551
1515
|
* @returns Reference to `this` in order to allow method chaining
|
|
1552
1516
|
*/
|
|
@@ -1583,7 +1547,7 @@ declare namespace sap {
|
|
|
1583
1547
|
*
|
|
1584
1548
|
* Default value is `3`.
|
|
1585
1549
|
*
|
|
1586
|
-
* @
|
|
1550
|
+
* @since 1.101
|
|
1587
1551
|
*
|
|
1588
1552
|
* @returns Reference to `this` in order to allow method chaining
|
|
1589
1553
|
*/
|
|
@@ -1696,7 +1660,7 @@ declare namespace sap {
|
|
|
1696
1660
|
/**
|
|
1697
1661
|
* Destroys the microChart in the aggregation {@link #getMicroChart microChart}.
|
|
1698
1662
|
*
|
|
1699
|
-
* @
|
|
1663
|
+
* @since 1.124
|
|
1700
1664
|
*
|
|
1701
1665
|
* @returns Reference to `this` in order to allow method chaining
|
|
1702
1666
|
*/
|
|
@@ -1744,11 +1708,47 @@ declare namespace sap {
|
|
|
1744
1708
|
*
|
|
1745
1709
|
* Default value is `1`.
|
|
1746
1710
|
*
|
|
1747
|
-
* @
|
|
1711
|
+
* @since 1.101
|
|
1748
1712
|
*
|
|
1749
1713
|
* @returns Value of property `detailsMaxLines`
|
|
1750
1714
|
*/
|
|
1751
1715
|
getDetailsMaxLines(): int;
|
|
1716
|
+
/**
|
|
1717
|
+
* Gets current value of property {@link #getIconAlt iconAlt}.
|
|
1718
|
+
*
|
|
1719
|
+
* Defines an alt text for the avatar or icon.
|
|
1720
|
+
*
|
|
1721
|
+
* Default value is `empty string`.
|
|
1722
|
+
*
|
|
1723
|
+
* @since 1.118
|
|
1724
|
+
*
|
|
1725
|
+
* @returns Value of property `iconAlt`
|
|
1726
|
+
*/
|
|
1727
|
+
getIconAlt(): string;
|
|
1728
|
+
/**
|
|
1729
|
+
* Gets current value of property {@link #getIconBackgroundColor iconBackgroundColor}.
|
|
1730
|
+
*
|
|
1731
|
+
* Defines a background color for the avatar or icon.
|
|
1732
|
+
*
|
|
1733
|
+
* Default value is `Transparent`.
|
|
1734
|
+
*
|
|
1735
|
+
* @since 1.118
|
|
1736
|
+
*
|
|
1737
|
+
* @returns Value of property `iconBackgroundColor`
|
|
1738
|
+
*/
|
|
1739
|
+
getIconBackgroundColor(): sap.m.AvatarColor;
|
|
1740
|
+
/**
|
|
1741
|
+
* Gets current value of property {@link #getIconDisplayShape iconDisplayShape}.
|
|
1742
|
+
*
|
|
1743
|
+
* Defines the shape of the icon.
|
|
1744
|
+
*
|
|
1745
|
+
* Default value is `Circle`.
|
|
1746
|
+
*
|
|
1747
|
+
* @since 1.118
|
|
1748
|
+
*
|
|
1749
|
+
* @returns Value of property `iconDisplayShape`
|
|
1750
|
+
*/
|
|
1751
|
+
getIconDisplayShape(): sap.m.AvatarShape;
|
|
1752
1752
|
/**
|
|
1753
1753
|
* Gets current value of property {@link #getIconFitType iconFitType}.
|
|
1754
1754
|
*
|
|
@@ -1761,6 +1761,18 @@ declare namespace sap {
|
|
|
1761
1761
|
* @returns Value of property `iconFitType`
|
|
1762
1762
|
*/
|
|
1763
1763
|
getIconFitType(): sap.m.AvatarImageFitType;
|
|
1764
|
+
/**
|
|
1765
|
+
* Gets current value of property {@link #getIconInitials iconInitials}.
|
|
1766
|
+
*
|
|
1767
|
+
* Defines the initials of the icon.
|
|
1768
|
+
*
|
|
1769
|
+
* Default value is `empty string`.
|
|
1770
|
+
*
|
|
1771
|
+
* @since 1.118
|
|
1772
|
+
*
|
|
1773
|
+
* @returns Value of property `iconInitials`
|
|
1774
|
+
*/
|
|
1775
|
+
getIconInitials(): string;
|
|
1764
1776
|
/**
|
|
1765
1777
|
* Gets current value of property {@link #getIconSize iconSize}.
|
|
1766
1778
|
*
|
|
@@ -1768,17 +1780,29 @@ declare namespace sap {
|
|
|
1768
1780
|
*
|
|
1769
1781
|
* Default value is `S`.
|
|
1770
1782
|
*
|
|
1771
|
-
* @
|
|
1783
|
+
* @since 1.119
|
|
1772
1784
|
*
|
|
1773
1785
|
* @returns Value of property `iconSize`
|
|
1774
1786
|
*/
|
|
1775
1787
|
getIconSize(): sap.m.AvatarSize;
|
|
1788
|
+
/**
|
|
1789
|
+
* Gets current value of property {@link #getIconSrc iconSrc}.
|
|
1790
|
+
*
|
|
1791
|
+
* Defines the icon source.
|
|
1792
|
+
*
|
|
1793
|
+
* Default value is `empty string`.
|
|
1794
|
+
*
|
|
1795
|
+
* @since 1.118
|
|
1796
|
+
*
|
|
1797
|
+
* @returns Value of property `iconSrc`
|
|
1798
|
+
*/
|
|
1799
|
+
getIconSrc(): sap.ui.core.URI;
|
|
1776
1800
|
/**
|
|
1777
1801
|
* Gets content of aggregation {@link #getMicroChart microChart}.
|
|
1778
1802
|
*
|
|
1779
1803
|
* Micro Chart
|
|
1780
1804
|
*
|
|
1781
|
-
* @
|
|
1805
|
+
* @since 1.124
|
|
1782
1806
|
*/
|
|
1783
1807
|
getMicroChart(): sap.ui.core.Control;
|
|
1784
1808
|
/**
|
|
@@ -1850,7 +1874,7 @@ declare namespace sap {
|
|
|
1850
1874
|
*
|
|
1851
1875
|
* Default value is `"Neutral"`.
|
|
1852
1876
|
*
|
|
1853
|
-
* @
|
|
1877
|
+
* @since 1.64
|
|
1854
1878
|
*
|
|
1855
1879
|
* @returns Value of property `state`
|
|
1856
1880
|
*/
|
|
@@ -1882,7 +1906,7 @@ declare namespace sap {
|
|
|
1882
1906
|
*
|
|
1883
1907
|
* Default value is `2`.
|
|
1884
1908
|
*
|
|
1885
|
-
* @
|
|
1909
|
+
* @since 1.101
|
|
1886
1910
|
*
|
|
1887
1911
|
* @returns Value of property `subtitleMaxLines`
|
|
1888
1912
|
*/
|
|
@@ -1903,7 +1927,7 @@ declare namespace sap {
|
|
|
1903
1927
|
*
|
|
1904
1928
|
* Default value is `3`.
|
|
1905
1929
|
*
|
|
1906
|
-
* @
|
|
1930
|
+
* @since 1.101
|
|
1907
1931
|
*
|
|
1908
1932
|
* @returns Value of property `titleMaxLines`
|
|
1909
1933
|
*/
|
|
@@ -2005,7 +2029,7 @@ declare namespace sap {
|
|
|
2005
2029
|
*
|
|
2006
2030
|
* Default value is `1`.
|
|
2007
2031
|
*
|
|
2008
|
-
* @
|
|
2032
|
+
* @since 1.101
|
|
2009
2033
|
*
|
|
2010
2034
|
* @returns Reference to `this` in order to allow method chaining
|
|
2011
2035
|
*/
|
|
@@ -2015,6 +2039,63 @@ declare namespace sap {
|
|
|
2015
2039
|
*/
|
|
2016
2040
|
iDetailsMaxLines?: int
|
|
2017
2041
|
): this;
|
|
2042
|
+
/**
|
|
2043
|
+
* Sets a new value for property {@link #getIconAlt iconAlt}.
|
|
2044
|
+
*
|
|
2045
|
+
* Defines an alt text for the avatar or icon.
|
|
2046
|
+
*
|
|
2047
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2048
|
+
*
|
|
2049
|
+
* Default value is `empty string`.
|
|
2050
|
+
*
|
|
2051
|
+
* @since 1.118
|
|
2052
|
+
*
|
|
2053
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2054
|
+
*/
|
|
2055
|
+
setIconAlt(
|
|
2056
|
+
/**
|
|
2057
|
+
* New value for property `iconAlt`
|
|
2058
|
+
*/
|
|
2059
|
+
sIconAlt?: string
|
|
2060
|
+
): this;
|
|
2061
|
+
/**
|
|
2062
|
+
* Sets a new value for property {@link #getIconBackgroundColor iconBackgroundColor}.
|
|
2063
|
+
*
|
|
2064
|
+
* Defines a background color for the avatar or icon.
|
|
2065
|
+
*
|
|
2066
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2067
|
+
*
|
|
2068
|
+
* Default value is `Transparent`.
|
|
2069
|
+
*
|
|
2070
|
+
* @since 1.118
|
|
2071
|
+
*
|
|
2072
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2073
|
+
*/
|
|
2074
|
+
setIconBackgroundColor(
|
|
2075
|
+
/**
|
|
2076
|
+
* New value for property `iconBackgroundColor`
|
|
2077
|
+
*/
|
|
2078
|
+
sIconBackgroundColor?: sap.m.AvatarColor
|
|
2079
|
+
): this;
|
|
2080
|
+
/**
|
|
2081
|
+
* Sets a new value for property {@link #getIconDisplayShape iconDisplayShape}.
|
|
2082
|
+
*
|
|
2083
|
+
* Defines the shape of the icon.
|
|
2084
|
+
*
|
|
2085
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2086
|
+
*
|
|
2087
|
+
* Default value is `Circle`.
|
|
2088
|
+
*
|
|
2089
|
+
* @since 1.118
|
|
2090
|
+
*
|
|
2091
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2092
|
+
*/
|
|
2093
|
+
setIconDisplayShape(
|
|
2094
|
+
/**
|
|
2095
|
+
* New value for property `iconDisplayShape`
|
|
2096
|
+
*/
|
|
2097
|
+
sIconDisplayShape?: sap.m.AvatarShape
|
|
2098
|
+
): this;
|
|
2018
2099
|
/**
|
|
2019
2100
|
* Sets a new value for property {@link #getIconFitType iconFitType}.
|
|
2020
2101
|
*
|
|
@@ -2034,6 +2115,25 @@ declare namespace sap {
|
|
|
2034
2115
|
*/
|
|
2035
2116
|
sIconFitType?: sap.m.AvatarImageFitType
|
|
2036
2117
|
): this;
|
|
2118
|
+
/**
|
|
2119
|
+
* Sets a new value for property {@link #getIconInitials iconInitials}.
|
|
2120
|
+
*
|
|
2121
|
+
* Defines the initials of the icon.
|
|
2122
|
+
*
|
|
2123
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2124
|
+
*
|
|
2125
|
+
* Default value is `empty string`.
|
|
2126
|
+
*
|
|
2127
|
+
* @since 1.118
|
|
2128
|
+
*
|
|
2129
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2130
|
+
*/
|
|
2131
|
+
setIconInitials(
|
|
2132
|
+
/**
|
|
2133
|
+
* New value for property `iconInitials`
|
|
2134
|
+
*/
|
|
2135
|
+
sIconInitials?: string
|
|
2136
|
+
): this;
|
|
2037
2137
|
/**
|
|
2038
2138
|
* Sets a new value for property {@link #getIconSize iconSize}.
|
|
2039
2139
|
*
|
|
@@ -2043,7 +2143,7 @@ declare namespace sap {
|
|
|
2043
2143
|
*
|
|
2044
2144
|
* Default value is `S`.
|
|
2045
2145
|
*
|
|
2046
|
-
* @
|
|
2146
|
+
* @since 1.119
|
|
2047
2147
|
*
|
|
2048
2148
|
* @returns Reference to `this` in order to allow method chaining
|
|
2049
2149
|
*/
|
|
@@ -2053,10 +2153,29 @@ declare namespace sap {
|
|
|
2053
2153
|
*/
|
|
2054
2154
|
sIconSize?: sap.m.AvatarSize
|
|
2055
2155
|
): this;
|
|
2156
|
+
/**
|
|
2157
|
+
* Sets a new value for property {@link #getIconSrc iconSrc}.
|
|
2158
|
+
*
|
|
2159
|
+
* Defines the icon source.
|
|
2160
|
+
*
|
|
2161
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2162
|
+
*
|
|
2163
|
+
* Default value is `empty string`.
|
|
2164
|
+
*
|
|
2165
|
+
* @since 1.118
|
|
2166
|
+
*
|
|
2167
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2168
|
+
*/
|
|
2169
|
+
setIconSrc(
|
|
2170
|
+
/**
|
|
2171
|
+
* New value for property `iconSrc`
|
|
2172
|
+
*/
|
|
2173
|
+
sIconSrc?: sap.ui.core.URI
|
|
2174
|
+
): this;
|
|
2056
2175
|
/**
|
|
2057
2176
|
* Sets the aggregated {@link #getMicroChart microChart}.
|
|
2058
2177
|
*
|
|
2059
|
-
* @
|
|
2178
|
+
* @since 1.124
|
|
2060
2179
|
*
|
|
2061
2180
|
* @returns Reference to `this` in order to allow method chaining
|
|
2062
2181
|
*/
|
|
@@ -2165,7 +2284,7 @@ declare namespace sap {
|
|
|
2165
2284
|
*
|
|
2166
2285
|
* Default value is `"Neutral"`.
|
|
2167
2286
|
*
|
|
2168
|
-
* @
|
|
2287
|
+
* @since 1.64
|
|
2169
2288
|
*
|
|
2170
2289
|
* @returns Reference to `this` in order to allow method chaining
|
|
2171
2290
|
*/
|
|
@@ -2218,7 +2337,7 @@ declare namespace sap {
|
|
|
2218
2337
|
*
|
|
2219
2338
|
* Default value is `2`.
|
|
2220
2339
|
*
|
|
2221
|
-
* @
|
|
2340
|
+
* @since 1.101
|
|
2222
2341
|
*
|
|
2223
2342
|
* @returns Reference to `this` in order to allow method chaining
|
|
2224
2343
|
*/
|
|
@@ -2253,7 +2372,7 @@ declare namespace sap {
|
|
|
2253
2372
|
*
|
|
2254
2373
|
* Default value is `3`.
|
|
2255
2374
|
*
|
|
2256
|
-
* @
|
|
2375
|
+
* @since 1.101
|
|
2257
2376
|
*
|
|
2258
2377
|
* @returns Reference to `this` in order to allow method chaining
|
|
2259
2378
|
*/
|
|
@@ -2388,7 +2507,7 @@ declare namespace sap {
|
|
|
2388
2507
|
*
|
|
2389
2508
|
* Default value is `"None"`.
|
|
2390
2509
|
*
|
|
2391
|
-
* @
|
|
2510
|
+
* @since 1.95
|
|
2392
2511
|
*
|
|
2393
2512
|
* @returns Value of property `state`
|
|
2394
2513
|
*/
|
|
@@ -2432,7 +2551,7 @@ declare namespace sap {
|
|
|
2432
2551
|
*
|
|
2433
2552
|
* Default value is `"None"`.
|
|
2434
2553
|
*
|
|
2435
|
-
* @
|
|
2554
|
+
* @since 1.95
|
|
2436
2555
|
*
|
|
2437
2556
|
* @returns Reference to `this` in order to allow method chaining
|
|
2438
2557
|
*/
|
|
@@ -9385,26 +9504,152 @@ declare namespace sap {
|
|
|
9385
9504
|
}
|
|
9386
9505
|
|
|
9387
9506
|
/**
|
|
9388
|
-
* Describes the settings that can be provided to the
|
|
9389
|
-
*
|
|
9390
|
-
* @deprecated As of version 1.98. Use the {@link sap.m.IllustratedMessage} instead.
|
|
9391
|
-
*/
|
|
9392
|
-
interface $IllustratedMessageSettings
|
|
9393
|
-
extends sap.m.$IllustratedMessageSettings {}
|
|
9394
|
-
|
|
9395
|
-
/**
|
|
9396
|
-
* Describes the settings that can be provided to the Illustration constructor.
|
|
9507
|
+
* Describes the settings that can be provided to the HeroBanner constructor.
|
|
9397
9508
|
*
|
|
9398
|
-
* @
|
|
9509
|
+
* @experimental As of version 1.152.
|
|
9399
9510
|
*/
|
|
9400
|
-
interface $
|
|
9401
|
-
|
|
9402
|
-
/**
|
|
9403
|
-
* Describes the settings that can be provided to the ProductSwitch constructor.
|
|
9404
|
-
*/
|
|
9405
|
-
interface $ProductSwitchSettings extends sap.ui.core.$ControlSettings {
|
|
9511
|
+
interface $HeroBannerSettings
|
|
9512
|
+
extends sap.ui.core.webc.$WebComponentSettings {
|
|
9406
9513
|
/**
|
|
9407
|
-
*
|
|
9514
|
+
* Defines the background image of the hero banner.
|
|
9515
|
+
*
|
|
9516
|
+
* Accepts any valid CSS `background-image` value, e.g. `url("path/to/image.jpg")`.
|
|
9517
|
+
*/
|
|
9518
|
+
backgroundImage?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
9519
|
+
|
|
9520
|
+
/**
|
|
9521
|
+
* Defines the placement of the actions slot within the hero banner header.
|
|
9522
|
+
*
|
|
9523
|
+
* Allowed values:
|
|
9524
|
+
* - `TopEnd` (default) - Actions are displayed to the right of the header text, at the top of the header
|
|
9525
|
+
* row.
|
|
9526
|
+
* - `BottomStart` - Actions are displayed below the header text, left-aligned, regardless of `columnsRatio`
|
|
9527
|
+
* or slot usage.
|
|
9528
|
+
*/
|
|
9529
|
+
actionsPlacement?:
|
|
9530
|
+
| sap.f.HeroBannerActionsPlacement
|
|
9531
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
9532
|
+
| `{${string}}`;
|
|
9533
|
+
|
|
9534
|
+
/**
|
|
9535
|
+
* Defines the ratio between the two content columns inside the hero banner.
|
|
9536
|
+
*
|
|
9537
|
+
* Takes effect only when `endContent` is provided. When no `endContent` is present, the content spans the
|
|
9538
|
+
* full width (single column).
|
|
9539
|
+
*
|
|
9540
|
+
* Allowed values:
|
|
9541
|
+
* - `Equal` - Two equal columns. Both content blocks share the available width equally. On smaller screens,
|
|
9542
|
+
* both slots stack vertically.
|
|
9543
|
+
* - `FirstWider` - Two unequal columns. The start content takes two-thirds of the width, the end content
|
|
9544
|
+
* one-third. On smaller screens, both slots stack vertically.
|
|
9545
|
+
*/
|
|
9546
|
+
columnsRatio?:
|
|
9547
|
+
| sap.f.HeroBannerColumnsRatio
|
|
9548
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
9549
|
+
| `{${string}}`;
|
|
9550
|
+
|
|
9551
|
+
/**
|
|
9552
|
+
* Defines the vertical placement of the header block within the content area.
|
|
9553
|
+
*
|
|
9554
|
+
* Allowed values:
|
|
9555
|
+
* - `Top` (default) - Header block is placed at the top of the content area.
|
|
9556
|
+
* - `Bottom` - Header block is pushed to the bottom of column 1. Only takes effect when `columnsRatio`
|
|
9557
|
+
* is `Equal` or `FirstWider` and only `endContent` is provided. When `actionsPlacement` is also `BottomStart`,
|
|
9558
|
+
* the `endContent` slot spans the full height.
|
|
9559
|
+
*/
|
|
9560
|
+
headerBlockPlacement?:
|
|
9561
|
+
| sap.f.HeroBannerHeaderBlockPlacement
|
|
9562
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
9563
|
+
| `{${string}}`;
|
|
9564
|
+
|
|
9565
|
+
/**
|
|
9566
|
+
* Defines the header text displayed in the hero banner.
|
|
9567
|
+
*
|
|
9568
|
+
* This is the main greeting header, typically a personalized message such as "Hello, John".
|
|
9569
|
+
*/
|
|
9570
|
+
headerText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
9571
|
+
|
|
9572
|
+
/**
|
|
9573
|
+
* Defines text displayed above the heading as an overline.
|
|
9574
|
+
*
|
|
9575
|
+
* Can be used to show the current date, a status message, or any other relevant contextual information.
|
|
9576
|
+
*/
|
|
9577
|
+
overlineText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
9578
|
+
|
|
9579
|
+
/**
|
|
9580
|
+
* Defines the width of the `HeroBanner`.
|
|
9581
|
+
*/
|
|
9582
|
+
width?:
|
|
9583
|
+
| sap.ui.core.CSSSize
|
|
9584
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
9585
|
+
| `{${string}}`;
|
|
9586
|
+
|
|
9587
|
+
/**
|
|
9588
|
+
* Defines the height of the `HeroBanner`.
|
|
9589
|
+
*/
|
|
9590
|
+
height?:
|
|
9591
|
+
| sap.ui.core.CSSSize
|
|
9592
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
9593
|
+
| `{${string}}`;
|
|
9594
|
+
|
|
9595
|
+
/**
|
|
9596
|
+
* Defines action buttons displayed in the header area of the hero banner.
|
|
9597
|
+
*
|
|
9598
|
+
* Can contain buttons, links, or other interactive elements that provide quick access to relevant actions
|
|
9599
|
+
* directly from the hero banner header.
|
|
9600
|
+
*/
|
|
9601
|
+
actions?:
|
|
9602
|
+
| sap.ui.core.Control[]
|
|
9603
|
+
| sap.ui.core.Control
|
|
9604
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
9605
|
+
| `{${string}}`;
|
|
9606
|
+
|
|
9607
|
+
/**
|
|
9608
|
+
* Defines the first (default) content block of the hero banner.
|
|
9609
|
+
*
|
|
9610
|
+
* Content placed directly inside `HeroBanner` without a slot attribute lands here. Can contain KPI cards,
|
|
9611
|
+
* search input fields, text, buttons, and more.
|
|
9612
|
+
*/
|
|
9613
|
+
startContent?:
|
|
9614
|
+
| sap.ui.core.Control[]
|
|
9615
|
+
| sap.ui.core.Control
|
|
9616
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
9617
|
+
| `{${string}}`;
|
|
9618
|
+
|
|
9619
|
+
/**
|
|
9620
|
+
* Defines the second content block of the hero banner.
|
|
9621
|
+
*
|
|
9622
|
+
* Used alongside `startContent` when `columnsRatio` is set to `Equal` or `FirstWider`. Can contain cards,
|
|
9623
|
+
* buttons, and other interactive elements.
|
|
9624
|
+
*/
|
|
9625
|
+
endContent?:
|
|
9626
|
+
| sap.ui.core.Control[]
|
|
9627
|
+
| sap.ui.core.Control
|
|
9628
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
9629
|
+
| `{${string}}`;
|
|
9630
|
+
}
|
|
9631
|
+
|
|
9632
|
+
/**
|
|
9633
|
+
* Describes the settings that can be provided to the IllustratedMessage constructor.
|
|
9634
|
+
*
|
|
9635
|
+
* @deprecated As of version 1.98. Use the {@link sap.m.IllustratedMessage} instead.
|
|
9636
|
+
*/
|
|
9637
|
+
interface $IllustratedMessageSettings
|
|
9638
|
+
extends sap.m.$IllustratedMessageSettings {}
|
|
9639
|
+
|
|
9640
|
+
/**
|
|
9641
|
+
* Describes the settings that can be provided to the Illustration constructor.
|
|
9642
|
+
*
|
|
9643
|
+
* @deprecated As of version 1.98. Use the {@link sap.m.Illustration} instead.
|
|
9644
|
+
*/
|
|
9645
|
+
interface $IllustrationSettings extends sap.m.$IllustrationSettings {}
|
|
9646
|
+
|
|
9647
|
+
/**
|
|
9648
|
+
* Describes the settings that can be provided to the ProductSwitch constructor.
|
|
9649
|
+
*/
|
|
9650
|
+
interface $ProductSwitchSettings extends sap.ui.core.$ControlSettings {
|
|
9651
|
+
/**
|
|
9652
|
+
* `ProductSwitch` content.
|
|
9408
9653
|
*/
|
|
9409
9654
|
items?:
|
|
9410
9655
|
| sap.f.ProductSwitchItem[]
|
|
@@ -18926,62 +19171,51 @@ declare namespace sap {
|
|
|
18926
19171
|
unbindContent(): this;
|
|
18927
19172
|
}
|
|
18928
19173
|
/**
|
|
18929
|
-
* A
|
|
18930
|
-
*
|
|
18931
|
-
* Overview:
|
|
19174
|
+
* A flexible, full-width banner designed for placement at the top of a page.
|
|
18932
19175
|
*
|
|
18933
|
-
*
|
|
18934
|
-
* and conversational tone to better communicate an empty or a success state than just show a message alone.
|
|
18935
|
-
* Empty states are moments in the user experience where there’s no data to display. Success states are
|
|
18936
|
-
* occasions to celebrate and reward a user’s special accomplishment or the completion of an important task.
|
|
19176
|
+
* Overview: The `HeroBanner` provides a personalized greeting and quick access to key information or actions.
|
|
18937
19177
|
*
|
|
18938
|
-
* The `
|
|
18939
|
-
*
|
|
19178
|
+
* Structure: The `HeroBanner` consists of the following building blocks:
|
|
19179
|
+
* - **Overline** (optional) - contextual text at the top, e.g. the current date or a status message.
|
|
18940
19180
|
*
|
|
18941
|
-
*
|
|
19181
|
+
* - **Header** (optional) - the main greeting header below the overline, e.g. "Hello, John".
|
|
19182
|
+
* - **Actions** (optional) - buttons displayed in the header area.
|
|
19183
|
+
* - **Start Content** (optional) - customizable first content column.
|
|
19184
|
+
* - **End Content** (optional) - customizable second content column, shown alongside start content.
|
|
18942
19185
|
*
|
|
18943
|
-
*
|
|
18944
|
-
*
|
|
18945
|
-
* - Illustration
|
|
18946
|
-
* - Title
|
|
18947
|
-
* - Description
|
|
18948
|
-
* - Additional Content
|
|
19186
|
+
* Usage: Place the `HeroBanner` at the top of a page to welcome the user and surface relevant information
|
|
19187
|
+
* or shortcuts at a glance.
|
|
18949
19188
|
*
|
|
18950
|
-
*
|
|
19189
|
+
* The hero banner itself is non-interactive. However, interactive elements such as buttons, cards, or search
|
|
19190
|
+
* fields can be placed inside the content slots.
|
|
18951
19191
|
*
|
|
18952
|
-
* The `
|
|
18953
|
-
*
|
|
18954
|
-
*
|
|
19192
|
+
* Responsive Behavior: The `HeroBanner` adapts to different screen sizes:
|
|
19193
|
+
* - On smaller screens, split layouts collapse to a single stacked column.
|
|
19194
|
+
* - The heading text wraps to multiple lines as needed.
|
|
19195
|
+
* - On screens ≤1024px, the header text is wrapped to a maximum of 3 lines.
|
|
18955
19196
|
*
|
|
18956
|
-
* @
|
|
18957
|
-
* @deprecated As of version 1.98. Use the {@link sap.m.IllustratedMessage} instead.
|
|
19197
|
+
* @experimental As of version 1.152.
|
|
18958
19198
|
*/
|
|
18959
|
-
class
|
|
19199
|
+
class HeroBanner extends sap.ui.core.webc.WebComponent {
|
|
18960
19200
|
/**
|
|
18961
|
-
* Constructor for a new `
|
|
19201
|
+
* Constructor for a new `HeroBanner`.
|
|
18962
19202
|
*
|
|
18963
19203
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
18964
19204
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
18965
19205
|
* of the syntax of the settings object.
|
|
18966
|
-
*
|
|
18967
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor sap.m.IllustratedMessage }
|
|
18968
|
-
* can be used.
|
|
18969
19206
|
*/
|
|
18970
19207
|
constructor(
|
|
18971
19208
|
/**
|
|
18972
19209
|
* Initial settings for the new control
|
|
18973
19210
|
*/
|
|
18974
|
-
mSettings?: sap.f.$
|
|
19211
|
+
mSettings?: sap.f.$HeroBannerSettings
|
|
18975
19212
|
);
|
|
18976
19213
|
/**
|
|
18977
|
-
* Constructor for a new `
|
|
19214
|
+
* Constructor for a new `HeroBanner`.
|
|
18978
19215
|
*
|
|
18979
19216
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
18980
19217
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
18981
19218
|
* of the syntax of the settings object.
|
|
18982
|
-
*
|
|
18983
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor sap.m.IllustratedMessage }
|
|
18984
|
-
* can be used.
|
|
18985
19219
|
*/
|
|
18986
19220
|
constructor(
|
|
18987
19221
|
/**
|
|
@@ -18991,14 +19225,14 @@ declare namespace sap {
|
|
|
18991
19225
|
/**
|
|
18992
19226
|
* Initial settings for the new control
|
|
18993
19227
|
*/
|
|
18994
|
-
mSettings?: sap.f.$
|
|
19228
|
+
mSettings?: sap.f.$HeroBannerSettings
|
|
18995
19229
|
);
|
|
18996
19230
|
|
|
18997
19231
|
/**
|
|
18998
|
-
* Creates a new subclass of class sap.f.
|
|
18999
|
-
*
|
|
19232
|
+
* Creates a new subclass of class sap.f.HeroBanner with name `sClassName` and enriches it with the information
|
|
19233
|
+
* contained in `oClassInfo`.
|
|
19000
19234
|
*
|
|
19001
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
19235
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.webc.WebComponent.extend}.
|
|
19002
19236
|
*
|
|
19003
19237
|
*
|
|
19004
19238
|
* @returns Created class / constructor function
|
|
@@ -19011,7 +19245,7 @@ declare namespace sap {
|
|
|
19011
19245
|
/**
|
|
19012
19246
|
* Object literal with information about the class
|
|
19013
19247
|
*/
|
|
19014
|
-
oClassInfo?: sap.ClassInfo<T, sap.f.
|
|
19248
|
+
oClassInfo?: sap.ClassInfo<T, sap.f.HeroBanner>,
|
|
19015
19249
|
/**
|
|
19016
19250
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
19017
19251
|
* used by this class
|
|
@@ -19019,142 +19253,749 @@ declare namespace sap {
|
|
|
19019
19253
|
FNMetaImpl?: Function
|
|
19020
19254
|
): Function;
|
|
19021
19255
|
/**
|
|
19022
|
-
* Returns a metadata object for class sap.f.
|
|
19256
|
+
* Returns a metadata object for class sap.f.HeroBanner.
|
|
19023
19257
|
*
|
|
19024
19258
|
*
|
|
19025
19259
|
* @returns Metadata object describing this class
|
|
19026
19260
|
*/
|
|
19027
|
-
static getMetadata(): sap.ui.core.
|
|
19028
|
-
}
|
|
19029
|
-
/**
|
|
19030
|
-
* A simple control which uses a Symbol ID to visualize an SVG which has already been loaded in the {@link sap.f.IllustrationPool}.
|
|
19031
|
-
*
|
|
19032
|
-
* To build a Symbol ID, all of the `Illustration` properties must be populated with data.
|
|
19033
|
-
*
|
|
19034
|
-
* @since 1.88
|
|
19035
|
-
* @deprecated As of version 1.98. Use the {@link sap.m.Illustration} instead.
|
|
19036
|
-
*/
|
|
19037
|
-
class Illustration extends sap.m.Illustration {
|
|
19261
|
+
static getMetadata(): sap.ui.core.webc.WebComponentMetadata;
|
|
19038
19262
|
/**
|
|
19039
|
-
*
|
|
19263
|
+
* Adds some action to the aggregation {@link #getActions actions}.
|
|
19040
19264
|
*
|
|
19041
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19042
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19043
|
-
* of the syntax of the settings object.
|
|
19044
19265
|
*
|
|
19045
|
-
*
|
|
19046
|
-
* can be used.
|
|
19266
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19047
19267
|
*/
|
|
19048
|
-
|
|
19268
|
+
addAction(
|
|
19049
19269
|
/**
|
|
19050
|
-
*
|
|
19270
|
+
* The action to add; if empty, nothing is inserted
|
|
19051
19271
|
*/
|
|
19052
|
-
|
|
19053
|
-
);
|
|
19272
|
+
oAction: sap.ui.core.Control
|
|
19273
|
+
): this;
|
|
19054
19274
|
/**
|
|
19055
|
-
*
|
|
19275
|
+
* Adds some endContent to the aggregation {@link #getEndContent endContent}.
|
|
19056
19276
|
*
|
|
19057
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19058
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19059
|
-
* of the syntax of the settings object.
|
|
19060
19277
|
*
|
|
19061
|
-
*
|
|
19062
|
-
* can be used.
|
|
19278
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19063
19279
|
*/
|
|
19064
|
-
|
|
19280
|
+
addEndContent(
|
|
19065
19281
|
/**
|
|
19066
|
-
*
|
|
19282
|
+
* The endContent to add; if empty, nothing is inserted
|
|
19067
19283
|
*/
|
|
19068
|
-
|
|
19284
|
+
oEndContent: sap.ui.core.Control
|
|
19285
|
+
): this;
|
|
19286
|
+
/**
|
|
19287
|
+
* Adds some startContent to the aggregation {@link #getStartContent startContent}.
|
|
19288
|
+
*
|
|
19289
|
+
*
|
|
19290
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19291
|
+
*/
|
|
19292
|
+
addStartContent(
|
|
19069
19293
|
/**
|
|
19070
|
-
*
|
|
19294
|
+
* The startContent to add; if empty, nothing is inserted
|
|
19071
19295
|
*/
|
|
19072
|
-
|
|
19073
|
-
);
|
|
19074
|
-
|
|
19296
|
+
oStartContent: sap.ui.core.Control
|
|
19297
|
+
): this;
|
|
19075
19298
|
/**
|
|
19076
|
-
*
|
|
19077
|
-
* contained in `oClassInfo`.
|
|
19299
|
+
* Destroys all the actions in the aggregation {@link #getActions actions}.
|
|
19078
19300
|
*
|
|
19079
|
-
*
|
|
19301
|
+
*
|
|
19302
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19303
|
+
*/
|
|
19304
|
+
destroyActions(): this;
|
|
19305
|
+
/**
|
|
19306
|
+
* Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
|
|
19080
19307
|
*
|
|
19081
19308
|
*
|
|
19082
|
-
* @returns
|
|
19309
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19083
19310
|
*/
|
|
19084
|
-
|
|
19085
|
-
/**
|
|
19086
|
-
* Name of the class being created
|
|
19087
|
-
*/
|
|
19088
|
-
sClassName: string,
|
|
19089
|
-
/**
|
|
19090
|
-
* Object literal with information about the class
|
|
19091
|
-
*/
|
|
19092
|
-
oClassInfo?: sap.ClassInfo<T, sap.f.Illustration>,
|
|
19093
|
-
/**
|
|
19094
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
19095
|
-
* used by this class
|
|
19096
|
-
*/
|
|
19097
|
-
FNMetaImpl?: Function
|
|
19098
|
-
): Function;
|
|
19311
|
+
destroyEndContent(): this;
|
|
19099
19312
|
/**
|
|
19100
|
-
*
|
|
19313
|
+
* Destroys all the startContent in the aggregation {@link #getStartContent startContent}.
|
|
19101
19314
|
*
|
|
19102
19315
|
*
|
|
19103
|
-
* @returns
|
|
19316
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19104
19317
|
*/
|
|
19105
|
-
|
|
19106
|
-
}
|
|
19107
|
-
/**
|
|
19108
|
-
* A layout control that provides specific configuration about how the items should be displayed.
|
|
19109
|
-
*
|
|
19110
|
-
* @since 1.72
|
|
19111
|
-
*/
|
|
19112
|
-
class ProductSwitch extends sap.ui.core.Control {
|
|
19318
|
+
destroyStartContent(): this;
|
|
19113
19319
|
/**
|
|
19114
|
-
*
|
|
19320
|
+
* Gets content of aggregation {@link #getActions actions}.
|
|
19115
19321
|
*
|
|
19116
|
-
*
|
|
19117
|
-
*
|
|
19118
|
-
*
|
|
19322
|
+
* Defines action buttons displayed in the header area of the hero banner.
|
|
19323
|
+
*
|
|
19324
|
+
* Can contain buttons, links, or other interactive elements that provide quick access to relevant actions
|
|
19325
|
+
* directly from the hero banner header.
|
|
19119
19326
|
*/
|
|
19120
|
-
|
|
19121
|
-
/**
|
|
19122
|
-
* Initial settings for the new control
|
|
19123
|
-
*/
|
|
19124
|
-
mSettings?: sap.f.$ProductSwitchSettings
|
|
19125
|
-
);
|
|
19327
|
+
getActions(): sap.ui.core.Control[];
|
|
19126
19328
|
/**
|
|
19127
|
-
*
|
|
19329
|
+
* Gets current value of property {@link #getActionsPlacement actionsPlacement}.
|
|
19128
19330
|
*
|
|
19129
|
-
*
|
|
19130
|
-
*
|
|
19131
|
-
*
|
|
19331
|
+
* Defines the placement of the actions slot within the hero banner header.
|
|
19332
|
+
*
|
|
19333
|
+
* Allowed values:
|
|
19334
|
+
* - `TopEnd` (default) - Actions are displayed to the right of the header text, at the top of the header
|
|
19335
|
+
* row.
|
|
19336
|
+
* - `BottomStart` - Actions are displayed below the header text, left-aligned, regardless of `columnsRatio`
|
|
19337
|
+
* or slot usage.
|
|
19338
|
+
*
|
|
19339
|
+
* Default value is `"TopEnd"`.
|
|
19340
|
+
*
|
|
19341
|
+
*
|
|
19342
|
+
* @returns Value of property `actionsPlacement`
|
|
19132
19343
|
*/
|
|
19133
|
-
|
|
19134
|
-
/**
|
|
19135
|
-
* ID for the new control, generated automatically if no ID is given
|
|
19136
|
-
*/
|
|
19137
|
-
sId?: string,
|
|
19138
|
-
/**
|
|
19139
|
-
* Initial settings for the new control
|
|
19140
|
-
*/
|
|
19141
|
-
mSettings?: sap.f.$ProductSwitchSettings
|
|
19142
|
-
);
|
|
19143
|
-
|
|
19344
|
+
getActionsPlacement(): sap.f.HeroBannerActionsPlacement;
|
|
19144
19345
|
/**
|
|
19145
|
-
*
|
|
19146
|
-
* contained in `oClassInfo`.
|
|
19346
|
+
* Gets current value of property {@link #getBackgroundImage backgroundImage}.
|
|
19147
19347
|
*
|
|
19148
|
-
*
|
|
19348
|
+
* Defines the background image of the hero banner.
|
|
19149
19349
|
*
|
|
19350
|
+
* Accepts any valid CSS `background-image` value, e.g. `url("path/to/image.jpg")`.
|
|
19150
19351
|
*
|
|
19151
|
-
*
|
|
19352
|
+
*
|
|
19353
|
+
* @returns Value of property `backgroundImage`
|
|
19152
19354
|
*/
|
|
19153
|
-
|
|
19154
|
-
|
|
19155
|
-
|
|
19156
|
-
|
|
19157
|
-
|
|
19355
|
+
getBackgroundImage(): string;
|
|
19356
|
+
/**
|
|
19357
|
+
* Gets current value of property {@link #getColumnsRatio columnsRatio}.
|
|
19358
|
+
*
|
|
19359
|
+
* Defines the ratio between the two content columns inside the hero banner.
|
|
19360
|
+
*
|
|
19361
|
+
* Takes effect only when `endContent` is provided. When no `endContent` is present, the content spans the
|
|
19362
|
+
* full width (single column).
|
|
19363
|
+
*
|
|
19364
|
+
* Allowed values:
|
|
19365
|
+
* - `Equal` - Two equal columns. Both content blocks share the available width equally. On smaller screens,
|
|
19366
|
+
* both slots stack vertically.
|
|
19367
|
+
* - `FirstWider` - Two unequal columns. The start content takes two-thirds of the width, the end content
|
|
19368
|
+
* one-third. On smaller screens, both slots stack vertically.
|
|
19369
|
+
*
|
|
19370
|
+
* Default value is `"FirstWider"`.
|
|
19371
|
+
*
|
|
19372
|
+
*
|
|
19373
|
+
* @returns Value of property `columnsRatio`
|
|
19374
|
+
*/
|
|
19375
|
+
getColumnsRatio(): sap.f.HeroBannerColumnsRatio;
|
|
19376
|
+
/**
|
|
19377
|
+
* Gets content of aggregation {@link #getEndContent endContent}.
|
|
19378
|
+
*
|
|
19379
|
+
* Defines the second content block of the hero banner.
|
|
19380
|
+
*
|
|
19381
|
+
* Used alongside `startContent` when `columnsRatio` is set to `Equal` or `FirstWider`. Can contain cards,
|
|
19382
|
+
* buttons, and other interactive elements.
|
|
19383
|
+
*/
|
|
19384
|
+
getEndContent(): sap.ui.core.Control[];
|
|
19385
|
+
/**
|
|
19386
|
+
* Gets current value of property {@link #getHeaderBlockPlacement headerBlockPlacement}.
|
|
19387
|
+
*
|
|
19388
|
+
* Defines the vertical placement of the header block within the content area.
|
|
19389
|
+
*
|
|
19390
|
+
* Allowed values:
|
|
19391
|
+
* - `Top` (default) - Header block is placed at the top of the content area.
|
|
19392
|
+
* - `Bottom` - Header block is pushed to the bottom of column 1. Only takes effect when `columnsRatio`
|
|
19393
|
+
* is `Equal` or `FirstWider` and only `endContent` is provided. When `actionsPlacement` is also `BottomStart`,
|
|
19394
|
+
* the `endContent` slot spans the full height.
|
|
19395
|
+
*
|
|
19396
|
+
* Default value is `"Top"`.
|
|
19397
|
+
*
|
|
19398
|
+
*
|
|
19399
|
+
* @returns Value of property `headerBlockPlacement`
|
|
19400
|
+
*/
|
|
19401
|
+
getHeaderBlockPlacement(): sap.f.HeroBannerHeaderBlockPlacement;
|
|
19402
|
+
/**
|
|
19403
|
+
* Gets current value of property {@link #getHeaderText headerText}.
|
|
19404
|
+
*
|
|
19405
|
+
* Defines the header text displayed in the hero banner.
|
|
19406
|
+
*
|
|
19407
|
+
* This is the main greeting header, typically a personalized message such as "Hello, John".
|
|
19408
|
+
*
|
|
19409
|
+
*
|
|
19410
|
+
* @returns Value of property `headerText`
|
|
19411
|
+
*/
|
|
19412
|
+
getHeaderText(): string;
|
|
19413
|
+
/**
|
|
19414
|
+
* Gets current value of property {@link #getHeight height}.
|
|
19415
|
+
*
|
|
19416
|
+
* Defines the height of the `HeroBanner`.
|
|
19417
|
+
*
|
|
19418
|
+
*
|
|
19419
|
+
* @returns Value of property `height`
|
|
19420
|
+
*/
|
|
19421
|
+
getHeight(): sap.ui.core.CSSSize;
|
|
19422
|
+
/**
|
|
19423
|
+
* Gets current value of property {@link #getOverlineText overlineText}.
|
|
19424
|
+
*
|
|
19425
|
+
* Defines text displayed above the heading as an overline.
|
|
19426
|
+
*
|
|
19427
|
+
* Can be used to show the current date, a status message, or any other relevant contextual information.
|
|
19428
|
+
*
|
|
19429
|
+
*
|
|
19430
|
+
* @returns Value of property `overlineText`
|
|
19431
|
+
*/
|
|
19432
|
+
getOverlineText(): string;
|
|
19433
|
+
/**
|
|
19434
|
+
* Gets content of aggregation {@link #getStartContent startContent}.
|
|
19435
|
+
*
|
|
19436
|
+
* Defines the first (default) content block of the hero banner.
|
|
19437
|
+
*
|
|
19438
|
+
* Content placed directly inside `HeroBanner` without a slot attribute lands here. Can contain KPI cards,
|
|
19439
|
+
* search input fields, text, buttons, and more.
|
|
19440
|
+
*/
|
|
19441
|
+
getStartContent(): sap.ui.core.Control[];
|
|
19442
|
+
/**
|
|
19443
|
+
* Gets current value of property {@link #getWidth width}.
|
|
19444
|
+
*
|
|
19445
|
+
* Defines the width of the `HeroBanner`.
|
|
19446
|
+
*
|
|
19447
|
+
*
|
|
19448
|
+
* @returns Value of property `width`
|
|
19449
|
+
*/
|
|
19450
|
+
getWidth(): sap.ui.core.CSSSize;
|
|
19451
|
+
/**
|
|
19452
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getActions actions}. and returns
|
|
19453
|
+
* its index if found or -1 otherwise.
|
|
19454
|
+
*
|
|
19455
|
+
*
|
|
19456
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
19457
|
+
*/
|
|
19458
|
+
indexOfAction(
|
|
19459
|
+
/**
|
|
19460
|
+
* The action whose index is looked for
|
|
19461
|
+
*/
|
|
19462
|
+
oAction: sap.ui.core.Control
|
|
19463
|
+
): int;
|
|
19464
|
+
/**
|
|
19465
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
|
|
19466
|
+
* returns its index if found or -1 otherwise.
|
|
19467
|
+
*
|
|
19468
|
+
*
|
|
19469
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
19470
|
+
*/
|
|
19471
|
+
indexOfEndContent(
|
|
19472
|
+
/**
|
|
19473
|
+
* The endContent whose index is looked for
|
|
19474
|
+
*/
|
|
19475
|
+
oEndContent: sap.ui.core.Control
|
|
19476
|
+
): int;
|
|
19477
|
+
/**
|
|
19478
|
+
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getStartContent startContent}.
|
|
19479
|
+
* and returns its index if found or -1 otherwise.
|
|
19480
|
+
*
|
|
19481
|
+
*
|
|
19482
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
19483
|
+
*/
|
|
19484
|
+
indexOfStartContent(
|
|
19485
|
+
/**
|
|
19486
|
+
* The startContent whose index is looked for
|
|
19487
|
+
*/
|
|
19488
|
+
oStartContent: sap.ui.core.Control
|
|
19489
|
+
): int;
|
|
19490
|
+
/**
|
|
19491
|
+
* Inserts a action into the aggregation {@link #getActions actions}.
|
|
19492
|
+
*
|
|
19493
|
+
*
|
|
19494
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19495
|
+
*/
|
|
19496
|
+
insertAction(
|
|
19497
|
+
/**
|
|
19498
|
+
* The action to insert; if empty, nothing is inserted
|
|
19499
|
+
*/
|
|
19500
|
+
oAction: sap.ui.core.Control,
|
|
19501
|
+
/**
|
|
19502
|
+
* The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
|
|
19503
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
|
|
19504
|
+
* at the last position
|
|
19505
|
+
*/
|
|
19506
|
+
iIndex: int
|
|
19507
|
+
): this;
|
|
19508
|
+
/**
|
|
19509
|
+
* Inserts a endContent into the aggregation {@link #getEndContent endContent}.
|
|
19510
|
+
*
|
|
19511
|
+
*
|
|
19512
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19513
|
+
*/
|
|
19514
|
+
insertEndContent(
|
|
19515
|
+
/**
|
|
19516
|
+
* The endContent to insert; if empty, nothing is inserted
|
|
19517
|
+
*/
|
|
19518
|
+
oEndContent: sap.ui.core.Control,
|
|
19519
|
+
/**
|
|
19520
|
+
* The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
|
|
19521
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
|
|
19522
|
+
* is inserted at the last position
|
|
19523
|
+
*/
|
|
19524
|
+
iIndex: int
|
|
19525
|
+
): this;
|
|
19526
|
+
/**
|
|
19527
|
+
* Inserts a startContent into the aggregation {@link #getStartContent startContent}.
|
|
19528
|
+
*
|
|
19529
|
+
*
|
|
19530
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19531
|
+
*/
|
|
19532
|
+
insertStartContent(
|
|
19533
|
+
/**
|
|
19534
|
+
* The startContent to insert; if empty, nothing is inserted
|
|
19535
|
+
*/
|
|
19536
|
+
oStartContent: sap.ui.core.Control,
|
|
19537
|
+
/**
|
|
19538
|
+
* The `0`-based index the startContent should be inserted at; for a negative value of `iIndex`, the startContent
|
|
19539
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the startContent
|
|
19540
|
+
* is inserted at the last position
|
|
19541
|
+
*/
|
|
19542
|
+
iIndex: int
|
|
19543
|
+
): this;
|
|
19544
|
+
/**
|
|
19545
|
+
* Removes a action from the aggregation {@link #getActions actions}.
|
|
19546
|
+
*
|
|
19547
|
+
*
|
|
19548
|
+
* @returns The removed action or `null`
|
|
19549
|
+
*/
|
|
19550
|
+
removeAction(
|
|
19551
|
+
/**
|
|
19552
|
+
* The action to remove or its index or id
|
|
19553
|
+
*/
|
|
19554
|
+
vAction: int | string | sap.ui.core.Control
|
|
19555
|
+
): sap.ui.core.Control | null;
|
|
19556
|
+
/**
|
|
19557
|
+
* Removes all the controls from the aggregation {@link #getActions actions}.
|
|
19558
|
+
*
|
|
19559
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
19560
|
+
*
|
|
19561
|
+
*
|
|
19562
|
+
* @returns An array of the removed elements (might be empty)
|
|
19563
|
+
*/
|
|
19564
|
+
removeAllActions(): sap.ui.core.Control[];
|
|
19565
|
+
/**
|
|
19566
|
+
* Removes all the controls from the aggregation {@link #getEndContent endContent}.
|
|
19567
|
+
*
|
|
19568
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
19569
|
+
*
|
|
19570
|
+
*
|
|
19571
|
+
* @returns An array of the removed elements (might be empty)
|
|
19572
|
+
*/
|
|
19573
|
+
removeAllEndContent(): sap.ui.core.Control[];
|
|
19574
|
+
/**
|
|
19575
|
+
* Removes all the controls from the aggregation {@link #getStartContent startContent}.
|
|
19576
|
+
*
|
|
19577
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
19578
|
+
*
|
|
19579
|
+
*
|
|
19580
|
+
* @returns An array of the removed elements (might be empty)
|
|
19581
|
+
*/
|
|
19582
|
+
removeAllStartContent(): sap.ui.core.Control[];
|
|
19583
|
+
/**
|
|
19584
|
+
* Removes a endContent from the aggregation {@link #getEndContent endContent}.
|
|
19585
|
+
*
|
|
19586
|
+
*
|
|
19587
|
+
* @returns The removed endContent or `null`
|
|
19588
|
+
*/
|
|
19589
|
+
removeEndContent(
|
|
19590
|
+
/**
|
|
19591
|
+
* The endContent to remove or its index or id
|
|
19592
|
+
*/
|
|
19593
|
+
vEndContent: int | string | sap.ui.core.Control
|
|
19594
|
+
): sap.ui.core.Control | null;
|
|
19595
|
+
/**
|
|
19596
|
+
* Removes a startContent from the aggregation {@link #getStartContent startContent}.
|
|
19597
|
+
*
|
|
19598
|
+
*
|
|
19599
|
+
* @returns The removed startContent or `null`
|
|
19600
|
+
*/
|
|
19601
|
+
removeStartContent(
|
|
19602
|
+
/**
|
|
19603
|
+
* The startContent to remove or its index or id
|
|
19604
|
+
*/
|
|
19605
|
+
vStartContent: int | string | sap.ui.core.Control
|
|
19606
|
+
): sap.ui.core.Control | null;
|
|
19607
|
+
/**
|
|
19608
|
+
* Sets a new value for property {@link #getActionsPlacement actionsPlacement}.
|
|
19609
|
+
*
|
|
19610
|
+
* Defines the placement of the actions slot within the hero banner header.
|
|
19611
|
+
*
|
|
19612
|
+
* Allowed values:
|
|
19613
|
+
* - `TopEnd` (default) - Actions are displayed to the right of the header text, at the top of the header
|
|
19614
|
+
* row.
|
|
19615
|
+
* - `BottomStart` - Actions are displayed below the header text, left-aligned, regardless of `columnsRatio`
|
|
19616
|
+
* or slot usage.
|
|
19617
|
+
*
|
|
19618
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19619
|
+
*
|
|
19620
|
+
* Default value is `"TopEnd"`.
|
|
19621
|
+
*
|
|
19622
|
+
*
|
|
19623
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19624
|
+
*/
|
|
19625
|
+
setActionsPlacement(
|
|
19626
|
+
/**
|
|
19627
|
+
* New value for property `actionsPlacement`
|
|
19628
|
+
*/
|
|
19629
|
+
sActionsPlacement?: sap.f.HeroBannerActionsPlacement
|
|
19630
|
+
): this;
|
|
19631
|
+
/**
|
|
19632
|
+
* Sets a new value for property {@link #getBackgroundImage backgroundImage}.
|
|
19633
|
+
*
|
|
19634
|
+
* Defines the background image of the hero banner.
|
|
19635
|
+
*
|
|
19636
|
+
* Accepts any valid CSS `background-image` value, e.g. `url("path/to/image.jpg")`.
|
|
19637
|
+
*
|
|
19638
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19639
|
+
*
|
|
19640
|
+
*
|
|
19641
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19642
|
+
*/
|
|
19643
|
+
setBackgroundImage(
|
|
19644
|
+
/**
|
|
19645
|
+
* New value for property `backgroundImage`
|
|
19646
|
+
*/
|
|
19647
|
+
sBackgroundImage: string
|
|
19648
|
+
): this;
|
|
19649
|
+
/**
|
|
19650
|
+
* Sets a new value for property {@link #getColumnsRatio columnsRatio}.
|
|
19651
|
+
*
|
|
19652
|
+
* Defines the ratio between the two content columns inside the hero banner.
|
|
19653
|
+
*
|
|
19654
|
+
* Takes effect only when `endContent` is provided. When no `endContent` is present, the content spans the
|
|
19655
|
+
* full width (single column).
|
|
19656
|
+
*
|
|
19657
|
+
* Allowed values:
|
|
19658
|
+
* - `Equal` - Two equal columns. Both content blocks share the available width equally. On smaller screens,
|
|
19659
|
+
* both slots stack vertically.
|
|
19660
|
+
* - `FirstWider` - Two unequal columns. The start content takes two-thirds of the width, the end content
|
|
19661
|
+
* one-third. On smaller screens, both slots stack vertically.
|
|
19662
|
+
*
|
|
19663
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19664
|
+
*
|
|
19665
|
+
* Default value is `"FirstWider"`.
|
|
19666
|
+
*
|
|
19667
|
+
*
|
|
19668
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19669
|
+
*/
|
|
19670
|
+
setColumnsRatio(
|
|
19671
|
+
/**
|
|
19672
|
+
* New value for property `columnsRatio`
|
|
19673
|
+
*/
|
|
19674
|
+
sColumnsRatio?: sap.f.HeroBannerColumnsRatio
|
|
19675
|
+
): this;
|
|
19676
|
+
/**
|
|
19677
|
+
* Sets a new value for property {@link #getHeaderBlockPlacement headerBlockPlacement}.
|
|
19678
|
+
*
|
|
19679
|
+
* Defines the vertical placement of the header block within the content area.
|
|
19680
|
+
*
|
|
19681
|
+
* Allowed values:
|
|
19682
|
+
* - `Top` (default) - Header block is placed at the top of the content area.
|
|
19683
|
+
* - `Bottom` - Header block is pushed to the bottom of column 1. Only takes effect when `columnsRatio`
|
|
19684
|
+
* is `Equal` or `FirstWider` and only `endContent` is provided. When `actionsPlacement` is also `BottomStart`,
|
|
19685
|
+
* the `endContent` slot spans the full height.
|
|
19686
|
+
*
|
|
19687
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19688
|
+
*
|
|
19689
|
+
* Default value is `"Top"`.
|
|
19690
|
+
*
|
|
19691
|
+
*
|
|
19692
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19693
|
+
*/
|
|
19694
|
+
setHeaderBlockPlacement(
|
|
19695
|
+
/**
|
|
19696
|
+
* New value for property `headerBlockPlacement`
|
|
19697
|
+
*/
|
|
19698
|
+
sHeaderBlockPlacement?: sap.f.HeroBannerHeaderBlockPlacement
|
|
19699
|
+
): this;
|
|
19700
|
+
/**
|
|
19701
|
+
* Sets a new value for property {@link #getHeaderText headerText}.
|
|
19702
|
+
*
|
|
19703
|
+
* Defines the header text displayed in the hero banner.
|
|
19704
|
+
*
|
|
19705
|
+
* This is the main greeting header, typically a personalized message such as "Hello, John".
|
|
19706
|
+
*
|
|
19707
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19708
|
+
*
|
|
19709
|
+
*
|
|
19710
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19711
|
+
*/
|
|
19712
|
+
setHeaderText(
|
|
19713
|
+
/**
|
|
19714
|
+
* New value for property `headerText`
|
|
19715
|
+
*/
|
|
19716
|
+
sHeaderText: string
|
|
19717
|
+
): this;
|
|
19718
|
+
/**
|
|
19719
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
19720
|
+
*
|
|
19721
|
+
* Defines the height of the `HeroBanner`.
|
|
19722
|
+
*
|
|
19723
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19724
|
+
*
|
|
19725
|
+
*
|
|
19726
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19727
|
+
*/
|
|
19728
|
+
setHeight(
|
|
19729
|
+
/**
|
|
19730
|
+
* New value for property `height`
|
|
19731
|
+
*/
|
|
19732
|
+
sHeight: sap.ui.core.CSSSize
|
|
19733
|
+
): this;
|
|
19734
|
+
/**
|
|
19735
|
+
* Sets a new value for property {@link #getOverlineText overlineText}.
|
|
19736
|
+
*
|
|
19737
|
+
* Defines text displayed above the heading as an overline.
|
|
19738
|
+
*
|
|
19739
|
+
* Can be used to show the current date, a status message, or any other relevant contextual information.
|
|
19740
|
+
*
|
|
19741
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19742
|
+
*
|
|
19743
|
+
*
|
|
19744
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19745
|
+
*/
|
|
19746
|
+
setOverlineText(
|
|
19747
|
+
/**
|
|
19748
|
+
* New value for property `overlineText`
|
|
19749
|
+
*/
|
|
19750
|
+
sOverlineText: string
|
|
19751
|
+
): this;
|
|
19752
|
+
/**
|
|
19753
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
19754
|
+
*
|
|
19755
|
+
* Defines the width of the `HeroBanner`.
|
|
19756
|
+
*
|
|
19757
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
19758
|
+
*
|
|
19759
|
+
*
|
|
19760
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
19761
|
+
*/
|
|
19762
|
+
setWidth(
|
|
19763
|
+
/**
|
|
19764
|
+
* New value for property `width`
|
|
19765
|
+
*/
|
|
19766
|
+
sWidth: sap.ui.core.CSSSize
|
|
19767
|
+
): this;
|
|
19768
|
+
}
|
|
19769
|
+
/**
|
|
19770
|
+
* A combination of message and illustration to represent an empty or a success state.
|
|
19771
|
+
*
|
|
19772
|
+
* Overview:
|
|
19773
|
+
*
|
|
19774
|
+
* An `IllustratedMessage` is a recommended combination of a solution-oriented message, an engaging illustration,
|
|
19775
|
+
* and conversational tone to better communicate an empty or a success state than just show a message alone.
|
|
19776
|
+
* Empty states are moments in the user experience where there’s no data to display. Success states are
|
|
19777
|
+
* occasions to celebrate and reward a user’s special accomplishment or the completion of an important task.
|
|
19778
|
+
*
|
|
19779
|
+
* The `IllustratedMessage` control is meant to be used inside container controls, for example a `Card`,
|
|
19780
|
+
* a `Dialog`, or a `Page`.
|
|
19781
|
+
*
|
|
19782
|
+
* Structure:
|
|
19783
|
+
*
|
|
19784
|
+
* The `IllustratedMessage` consists of the following elements, which are displayed below each other in
|
|
19785
|
+
* the following order:
|
|
19786
|
+
* - Illustration
|
|
19787
|
+
* - Title
|
|
19788
|
+
* - Description
|
|
19789
|
+
* - Additional Content
|
|
19790
|
+
*
|
|
19791
|
+
* Responsive Behavior:
|
|
19792
|
+
*
|
|
19793
|
+
* The `IllustratedMessage` control can adapt depending on the API settings provided by the app developer
|
|
19794
|
+
* and the available space of its parent container. Some of the structural elements are displayed differently
|
|
19795
|
+
* or are omitted in the different breakpoint sizes (XS, S, M, L).
|
|
19796
|
+
*
|
|
19797
|
+
* @since 1.88
|
|
19798
|
+
* @deprecated As of version 1.98. Use the {@link sap.m.IllustratedMessage} instead.
|
|
19799
|
+
*/
|
|
19800
|
+
class IllustratedMessage extends sap.m.IllustratedMessage {
|
|
19801
|
+
/**
|
|
19802
|
+
* Constructor for a new `IllustratedMessage`.
|
|
19803
|
+
*
|
|
19804
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19805
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19806
|
+
* of the syntax of the settings object.
|
|
19807
|
+
*
|
|
19808
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor sap.m.IllustratedMessage }
|
|
19809
|
+
* can be used.
|
|
19810
|
+
*/
|
|
19811
|
+
constructor(
|
|
19812
|
+
/**
|
|
19813
|
+
* Initial settings for the new control
|
|
19814
|
+
*/
|
|
19815
|
+
mSettings?: sap.f.$IllustratedMessageSettings
|
|
19816
|
+
);
|
|
19817
|
+
/**
|
|
19818
|
+
* Constructor for a new `IllustratedMessage`.
|
|
19819
|
+
*
|
|
19820
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19821
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19822
|
+
* of the syntax of the settings object.
|
|
19823
|
+
*
|
|
19824
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.IllustratedMessage#constructor sap.m.IllustratedMessage }
|
|
19825
|
+
* can be used.
|
|
19826
|
+
*/
|
|
19827
|
+
constructor(
|
|
19828
|
+
/**
|
|
19829
|
+
* ID for the new control, generated automatically if no ID is given
|
|
19830
|
+
*/
|
|
19831
|
+
sId?: string,
|
|
19832
|
+
/**
|
|
19833
|
+
* Initial settings for the new control
|
|
19834
|
+
*/
|
|
19835
|
+
mSettings?: sap.f.$IllustratedMessageSettings
|
|
19836
|
+
);
|
|
19837
|
+
|
|
19838
|
+
/**
|
|
19839
|
+
* Creates a new subclass of class sap.f.IllustratedMessage with name `sClassName` and enriches it with
|
|
19840
|
+
* the information contained in `oClassInfo`.
|
|
19841
|
+
*
|
|
19842
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.IllustratedMessage.extend}.
|
|
19843
|
+
*
|
|
19844
|
+
*
|
|
19845
|
+
* @returns Created class / constructor function
|
|
19846
|
+
*/
|
|
19847
|
+
static extend<T extends Record<string, unknown>>(
|
|
19848
|
+
/**
|
|
19849
|
+
* Name of the class being created
|
|
19850
|
+
*/
|
|
19851
|
+
sClassName: string,
|
|
19852
|
+
/**
|
|
19853
|
+
* Object literal with information about the class
|
|
19854
|
+
*/
|
|
19855
|
+
oClassInfo?: sap.ClassInfo<T, sap.f.IllustratedMessage>,
|
|
19856
|
+
/**
|
|
19857
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
19858
|
+
* used by this class
|
|
19859
|
+
*/
|
|
19860
|
+
FNMetaImpl?: Function
|
|
19861
|
+
): Function;
|
|
19862
|
+
/**
|
|
19863
|
+
* Returns a metadata object for class sap.f.IllustratedMessage.
|
|
19864
|
+
*
|
|
19865
|
+
*
|
|
19866
|
+
* @returns Metadata object describing this class
|
|
19867
|
+
*/
|
|
19868
|
+
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
19869
|
+
}
|
|
19870
|
+
/**
|
|
19871
|
+
* A simple control which uses a Symbol ID to visualize an SVG which has already been loaded in the {@link sap.f.IllustrationPool}.
|
|
19872
|
+
*
|
|
19873
|
+
* To build a Symbol ID, all of the `Illustration` properties must be populated with data.
|
|
19874
|
+
*
|
|
19875
|
+
* @since 1.88
|
|
19876
|
+
* @deprecated As of version 1.98. Use the {@link sap.m.Illustration} instead.
|
|
19877
|
+
*/
|
|
19878
|
+
class Illustration extends sap.m.Illustration {
|
|
19879
|
+
/**
|
|
19880
|
+
* Constructor for a new `Illustration`.
|
|
19881
|
+
*
|
|
19882
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19883
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19884
|
+
* of the syntax of the settings object.
|
|
19885
|
+
*
|
|
19886
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor sap.m.Illustration }
|
|
19887
|
+
* can be used.
|
|
19888
|
+
*/
|
|
19889
|
+
constructor(
|
|
19890
|
+
/**
|
|
19891
|
+
* Initial settings for the new control
|
|
19892
|
+
*/
|
|
19893
|
+
mSettings?: sap.f.$IllustrationSettings
|
|
19894
|
+
);
|
|
19895
|
+
/**
|
|
19896
|
+
* Constructor for a new `Illustration`.
|
|
19897
|
+
*
|
|
19898
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19899
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19900
|
+
* of the syntax of the settings object.
|
|
19901
|
+
*
|
|
19902
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Illustration#constructor sap.m.Illustration }
|
|
19903
|
+
* can be used.
|
|
19904
|
+
*/
|
|
19905
|
+
constructor(
|
|
19906
|
+
/**
|
|
19907
|
+
* ID for the new control, generated automatically if no ID is given
|
|
19908
|
+
*/
|
|
19909
|
+
sId?: string,
|
|
19910
|
+
/**
|
|
19911
|
+
* Initial settings for the new control
|
|
19912
|
+
*/
|
|
19913
|
+
mSettings?: sap.f.$IllustrationSettings
|
|
19914
|
+
);
|
|
19915
|
+
|
|
19916
|
+
/**
|
|
19917
|
+
* Creates a new subclass of class sap.f.Illustration with name `sClassName` and enriches it with the information
|
|
19918
|
+
* contained in `oClassInfo`.
|
|
19919
|
+
*
|
|
19920
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Illustration.extend}.
|
|
19921
|
+
*
|
|
19922
|
+
*
|
|
19923
|
+
* @returns Created class / constructor function
|
|
19924
|
+
*/
|
|
19925
|
+
static extend<T extends Record<string, unknown>>(
|
|
19926
|
+
/**
|
|
19927
|
+
* Name of the class being created
|
|
19928
|
+
*/
|
|
19929
|
+
sClassName: string,
|
|
19930
|
+
/**
|
|
19931
|
+
* Object literal with information about the class
|
|
19932
|
+
*/
|
|
19933
|
+
oClassInfo?: sap.ClassInfo<T, sap.f.Illustration>,
|
|
19934
|
+
/**
|
|
19935
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
19936
|
+
* used by this class
|
|
19937
|
+
*/
|
|
19938
|
+
FNMetaImpl?: Function
|
|
19939
|
+
): Function;
|
|
19940
|
+
/**
|
|
19941
|
+
* Returns a metadata object for class sap.f.Illustration.
|
|
19942
|
+
*
|
|
19943
|
+
*
|
|
19944
|
+
* @returns Metadata object describing this class
|
|
19945
|
+
*/
|
|
19946
|
+
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
19947
|
+
}
|
|
19948
|
+
/**
|
|
19949
|
+
* A layout control that provides specific configuration about how the items should be displayed.
|
|
19950
|
+
*
|
|
19951
|
+
* @since 1.72
|
|
19952
|
+
*/
|
|
19953
|
+
class ProductSwitch extends sap.ui.core.Control {
|
|
19954
|
+
/**
|
|
19955
|
+
* Constructor for a new `ProductSwitch`.
|
|
19956
|
+
*
|
|
19957
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19958
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19959
|
+
* of the syntax of the settings object.
|
|
19960
|
+
*/
|
|
19961
|
+
constructor(
|
|
19962
|
+
/**
|
|
19963
|
+
* Initial settings for the new control
|
|
19964
|
+
*/
|
|
19965
|
+
mSettings?: sap.f.$ProductSwitchSettings
|
|
19966
|
+
);
|
|
19967
|
+
/**
|
|
19968
|
+
* Constructor for a new `ProductSwitch`.
|
|
19969
|
+
*
|
|
19970
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
19971
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
19972
|
+
* of the syntax of the settings object.
|
|
19973
|
+
*/
|
|
19974
|
+
constructor(
|
|
19975
|
+
/**
|
|
19976
|
+
* ID for the new control, generated automatically if no ID is given
|
|
19977
|
+
*/
|
|
19978
|
+
sId?: string,
|
|
19979
|
+
/**
|
|
19980
|
+
* Initial settings for the new control
|
|
19981
|
+
*/
|
|
19982
|
+
mSettings?: sap.f.$ProductSwitchSettings
|
|
19983
|
+
);
|
|
19984
|
+
|
|
19985
|
+
/**
|
|
19986
|
+
* Creates a new subclass of class sap.f.ProductSwitch with name `sClassName` and enriches it with the information
|
|
19987
|
+
* contained in `oClassInfo`.
|
|
19988
|
+
*
|
|
19989
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
19990
|
+
*
|
|
19991
|
+
*
|
|
19992
|
+
* @returns Created class / constructor function
|
|
19993
|
+
*/
|
|
19994
|
+
static extend<T extends Record<string, unknown>>(
|
|
19995
|
+
/**
|
|
19996
|
+
* Name of the class being created
|
|
19997
|
+
*/
|
|
19998
|
+
sClassName: string,
|
|
19158
19999
|
/**
|
|
19159
20000
|
* Object literal with information about the class
|
|
19160
20001
|
*/
|
|
@@ -22388,6 +23229,60 @@ declare namespace sap {
|
|
|
22388
23229
|
*/
|
|
22389
23230
|
Middle = "Middle",
|
|
22390
23231
|
}
|
|
23232
|
+
/**
|
|
23233
|
+
* Defines the placement of the actions slot within the {@link sap.f.HeroBanner} header area.
|
|
23234
|
+
*
|
|
23235
|
+
* This enum is part of the 'sap/f/library' module export and must be accessed by the property 'HeroBannerActionsPlacement'.
|
|
23236
|
+
*
|
|
23237
|
+
* @experimental As of version 1.152.
|
|
23238
|
+
*/
|
|
23239
|
+
enum HeroBannerActionsPlacement {
|
|
23240
|
+
/**
|
|
23241
|
+
* Actions are displayed below the header text, left-aligned, regardless of `columnsRatio` or slot usage.
|
|
23242
|
+
*/
|
|
23243
|
+
BottomStart = "BottomStart",
|
|
23244
|
+
/**
|
|
23245
|
+
* Actions are displayed to the right of the header text, at the top of the header row.
|
|
23246
|
+
*/
|
|
23247
|
+
TopEnd = "TopEnd",
|
|
23248
|
+
}
|
|
23249
|
+
/**
|
|
23250
|
+
* Defines the ratio between the two content columns inside the {@link sap.f.HeroBanner}.
|
|
23251
|
+
*
|
|
23252
|
+
* This enum is part of the 'sap/f/library' module export and must be accessed by the property 'HeroBannerColumnsRatio'.
|
|
23253
|
+
*
|
|
23254
|
+
* @experimental As of version 1.152.
|
|
23255
|
+
*/
|
|
23256
|
+
enum HeroBannerColumnsRatio {
|
|
23257
|
+
/**
|
|
23258
|
+
* Two equal columns. Both content blocks share the available width equally. On smaller screens, both slots
|
|
23259
|
+
* stack vertically.
|
|
23260
|
+
*/
|
|
23261
|
+
Equal = "Equal",
|
|
23262
|
+
/**
|
|
23263
|
+
* Two unequal columns. The start content takes two-thirds of the width, the end content one-third. On smaller
|
|
23264
|
+
* screens, both slots stack vertically.
|
|
23265
|
+
*/
|
|
23266
|
+
FirstWider = "FirstWider",
|
|
23267
|
+
}
|
|
23268
|
+
/**
|
|
23269
|
+
* Defines the vertical placement of the header block within the {@link sap.f.HeroBanner} content area.
|
|
23270
|
+
*
|
|
23271
|
+
* This enum is part of the 'sap/f/library' module export and must be accessed by the property 'HeroBannerHeaderBlockPlacement'.
|
|
23272
|
+
*
|
|
23273
|
+
* @experimental As of version 1.152.
|
|
23274
|
+
*/
|
|
23275
|
+
enum HeroBannerHeaderBlockPlacement {
|
|
23276
|
+
/**
|
|
23277
|
+
* Header block is pushed to the bottom of column 1. Only takes effect when `columnsRatio` is `Equal` or
|
|
23278
|
+
* `FirstWider` and only `endContent` is provided.
|
|
23279
|
+
*/
|
|
23280
|
+
Bottom = "Bottom",
|
|
23281
|
+
/**
|
|
23282
|
+
* Header block is placed at the top of the content area.
|
|
23283
|
+
*/
|
|
23284
|
+
Top = "Top",
|
|
23285
|
+
}
|
|
22391
23286
|
/**
|
|
22392
23287
|
* Layouts, representing the number of columns to be displayed and their relative widths for a {@link sap.f.FlexibleColumnLayout }
|
|
22393
23288
|
* control.
|
|
@@ -22952,6 +23847,8 @@ declare namespace sap {
|
|
|
22952
23847
|
|
|
22953
23848
|
"sap/f/GridListItem": undefined;
|
|
22954
23849
|
|
|
23850
|
+
"sap/f/HeroBanner": undefined;
|
|
23851
|
+
|
|
22955
23852
|
"sap/f/IllustratedMessage": undefined;
|
|
22956
23853
|
|
|
22957
23854
|
"sap/f/Illustration": undefined;
|