@sapui5/ts-types 1.140.0 → 1.141.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.
Files changed (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +2792 -1
  7. package/types/sap.f.d.ts +43 -2
  8. package/types/sap.fe.ariba.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +78 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +371 -42
  14. package/types/sap.fe.navigation.d.ts +13 -15
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +7 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +70 -8
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +20 -5
  30. package/types/sap.suite.ui.commons.d.ts +1 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +41 -5
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +1 -1
  37. package/types/sap.ui.core.d.ts +129 -66
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +3 -3
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +1 -1
  44. package/types/sap.ui.layout.d.ts +5102 -5062
  45. package/types/sap.ui.mdc.d.ts +4 -4
  46. package/types/sap.ui.richtexteditor.d.ts +307 -9
  47. package/types/sap.ui.rta.d.ts +1 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +18 -4
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +53 -1
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +141 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +32 -3
  62. package/types/sap.ushell_abap.d.ts +5 -1
  63. package/types/sap.uxap.d.ts +1 -1
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -144,7 +144,7 @@ declare namespace sap {
144
144
  /**
145
145
  * Describes the settings that can be provided to the Chart constructor.
146
146
  *
147
- * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart } instead
147
+ * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart} instead
148
148
  * @experimental
149
149
  */
150
150
  interface $ChartSettings extends sap.ui.core.$ControlSettings {
@@ -270,7 +270,7 @@ declare namespace sap {
270
270
  * usage.
271
271
  *
272
272
  *
273
- * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart } instead
273
+ * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart} instead
274
274
  * @experimental
275
275
  */
276
276
  class Chart extends sap.ui.core.Control {
@@ -285,7 +285,7 @@ declare namespace sap {
285
285
  * Gets the key of the current variant in the associated variant management.
286
286
  *
287
287
  *
288
- * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
288
+ * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement} applied to the chart
289
289
  */
290
290
  getCurrentVariantKey(): null | string;
291
291
  /**
@@ -327,7 +327,7 @@ declare namespace sap {
327
327
  * Get the presentation variant that is currently applied on the chart.
328
328
  *
329
329
  *
330
- * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
330
+ * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant} applied to the chart
331
331
  */
332
332
  getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
333
333
  /**
@@ -349,7 +349,7 @@ declare namespace sap {
349
349
  * at the control level.
350
350
  *
351
351
  *
352
- * @returns A promise that resolves with {@link sap.fe.navigation.SelectionVariant }.
352
+ * @returns A promise that resolves with {@link sap.fe.navigation.SelectionVariant}.
353
353
  */
354
354
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
355
355
  /**
@@ -371,7 +371,7 @@ declare namespace sap {
371
371
  */
372
372
  setCurrentVariantKey(
373
373
  /**
374
- * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
374
+ * The variant key of {@link sap.ui.fl.variants.VariantManagement} to be set
375
375
  */
376
376
  key: string
377
377
  ): void;
@@ -420,7 +420,7 @@ declare namespace sap {
420
420
  */
421
421
  setPresentationVariant(
422
422
  /**
423
- * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
423
+ * the presentation variant {@link sap.fe.navigation.PresentationVariant} to be set
424
424
  */
425
425
  presentationVariant: sap.fe.navigation.PresentationVariant
426
426
  ): Promise<void>;
@@ -440,7 +440,7 @@ declare namespace sap {
440
440
  */
441
441
  setSelectionVariant(
442
442
  /**
443
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
443
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the chart
444
444
  */
445
445
  selectionVariant: sap.fe.navigation.SelectionVariant,
446
446
  /**
@@ -604,7 +604,7 @@ declare namespace sap {
604
604
  /**
605
605
  * Describes the settings that can be provided to the Field constructor.
606
606
  *
607
- * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field } instead
607
+ * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field} instead
608
608
  * @experimental
609
609
  */
610
610
  interface $FieldSettings extends sap.ui.core.$ControlSettings {
@@ -845,7 +845,7 @@ declare namespace sap {
845
845
  * usage.
846
846
  *
847
847
  *
848
- * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field } instead
848
+ * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field} instead
849
849
  * @experimental
850
850
  */
851
851
  class Field extends sap.ui.core.Control {
@@ -1118,7 +1118,7 @@ declare namespace sap {
1118
1118
  * Gets the visibility of a filter field.
1119
1119
  *
1120
1120
  *
1121
- * @returns A {@link Promise } that resolves to check whether the filter field is visible or not.
1121
+ * @returns A {@link Promise} that resolves to check whether the filter field is visible or not.
1122
1122
  */
1123
1123
  getFilterFieldVisible(
1124
1124
  /**
@@ -1141,7 +1141,7 @@ declare namespace sap {
1141
1141
  * that uses a custom operator.
1142
1142
  *
1143
1143
  *
1144
- * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1144
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
1145
1145
  */
1146
1146
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
1147
1147
  /**
@@ -1172,7 +1172,7 @@ declare namespace sap {
1172
1172
  * The property will not be hidden inside the adaptation dialog and may be re-added.
1173
1173
  *
1174
1174
  *
1175
- * @returns A {@link Promise } resolving once the change in visibility was applied
1175
+ * @returns A {@link Promise} resolving once the change in visibility was applied
1176
1176
  */
1177
1177
  setFilterFieldVisible(
1178
1178
  /**
@@ -1224,7 +1224,7 @@ declare namespace sap {
1224
1224
  */
1225
1225
  setSelectionVariant(
1226
1226
  /**
1227
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
1227
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
1228
1228
  */
1229
1229
  selectionVariant: sap.fe.navigation.SelectionVariant,
1230
1230
  /**
@@ -1279,7 +1279,7 @@ declare namespace sap {
1279
1279
  /**
1280
1280
  * Describes the settings that can be provided to the MicroChart constructor.
1281
1281
  *
1282
- * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart } instead
1282
+ * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart} instead
1283
1283
  * @experimental
1284
1284
  */
1285
1285
  interface $MicroChartSettings
@@ -1338,7 +1338,7 @@ declare namespace sap {
1338
1338
  * usage.
1339
1339
  *
1340
1340
  *
1341
- * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart } instead
1341
+ * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart} instead
1342
1342
  * @experimental
1343
1343
  */
1344
1344
  class MicroChart extends sap.fe.macros.MicroChart {
@@ -1762,6 +1762,14 @@ declare namespace sap {
1762
1762
  */
1763
1763
  availability?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1764
1764
 
1765
+ /**
1766
+ * Determines if the column should be excluded from the export.
1767
+ */
1768
+ disableExport?:
1769
+ | boolean
1770
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1771
+ | `{${string}}`;
1772
+
1765
1773
  /**
1766
1774
  * The text that will be displayed for this column header
1767
1775
  */
@@ -1838,6 +1846,16 @@ declare namespace sap {
1838
1846
  */
1839
1847
  interface $ColumnExportSettingsSettings
1840
1848
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1849
+ /**
1850
+ * Determines the text associated to a Boolean type with 'false' as value.
1851
+ */
1852
+ falseValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1853
+
1854
+ /**
1855
+ * Determines the column header text.
1856
+ */
1857
+ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1858
+
1841
1859
  /**
1842
1860
  * Determines the properties of the column.
1843
1861
  */
@@ -1851,11 +1869,41 @@ declare namespace sap {
1851
1869
  */
1852
1870
  template?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1853
1871
 
1872
+ /**
1873
+ * Determines the alignment of the column of the cell contents.
1874
+ * Available options are:
1875
+ *
1876
+ * - Left
1877
+ *
1878
+ * - Right
1879
+ *
1880
+ * - Center
1881
+ *
1882
+ * - Begin
1883
+ *
1884
+ * - End
1885
+ */
1886
+ textAlign?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1887
+
1888
+ /**
1889
+ * Determines the text associated to a Boolean type with 'true' as value.
1890
+ */
1891
+ trueValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1892
+
1854
1893
  /**
1855
1894
  * Determines the data type of the field
1856
1895
  */
1857
1896
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1858
1897
 
1898
+ /**
1899
+ * Determines the mapping object holding the values associated with a specific key.
1900
+ * Enumeration type must be used when valueMap is provided.
1901
+ */
1902
+ valueMap?:
1903
+ | object
1904
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1905
+ | `{${string}}`;
1906
+
1859
1907
  /**
1860
1908
  * Determines the width of the column in characters
1861
1909
  */
@@ -1884,6 +1932,14 @@ declare namespace sap {
1884
1932
  */
1885
1933
  availability?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1886
1934
 
1935
+ /**
1936
+ * Determines if the column should be excluded from the export.
1937
+ */
1938
+ disableExport?:
1939
+ | boolean
1940
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1941
+ | `{${string}}`;
1942
+
1887
1943
  /**
1888
1944
  * Aligns the header as well as the content horizontally
1889
1945
  */
@@ -2082,6 +2138,14 @@ declare namespace sap {
2082
2138
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2083
2139
  | `{${string}}`;
2084
2140
 
2141
+ /**
2142
+ * Configures the file name of exported table.
2143
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
2144
+ */
2145
+ exportFileName?:
2146
+ | string
2147
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2148
+
2085
2149
  /**
2086
2150
  * Maximum allowed number of records to be exported in one request.
2087
2151
  */
@@ -2090,6 +2154,14 @@ declare namespace sap {
2090
2154
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2091
2155
  | `{${string}}`;
2092
2156
 
2157
+ /**
2158
+ * Configures the sheet name of exported table.
2159
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
2160
+ */
2161
+ exportSheetName?:
2162
+ | string
2163
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2164
+
2093
2165
  /**
2094
2166
  * ID of the FilterBar building block associated with the table.
2095
2167
  */
@@ -2513,6 +2585,14 @@ declare namespace sap {
2513
2585
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2514
2586
  | `{${string}}`;
2515
2587
 
2588
+ /**
2589
+ * Configures the file name of exported table.
2590
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
2591
+ */
2592
+ exportFileName?:
2593
+ | string
2594
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2595
+
2516
2596
  /**
2517
2597
  * Maximum allowed number of records to be exported in one request.
2518
2598
  */
@@ -2521,6 +2601,14 @@ declare namespace sap {
2521
2601
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2522
2602
  | `{${string}}`;
2523
2603
 
2604
+ /**
2605
+ * Configures the sheet name of exported table.
2606
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
2607
+ */
2608
+ exportSheetName?:
2609
+ | string
2610
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2611
+
2524
2612
  /**
2525
2613
  * ID of the FilterBar building block associated with the table.
2526
2614
  */
@@ -3108,7 +3196,7 @@ declare namespace sap {
3108
3196
  * at the control level.
3109
3197
  *
3110
3198
  *
3111
- * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant }
3199
+ * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
3112
3200
  */
3113
3201
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
3114
3202
  /**
@@ -3222,7 +3310,7 @@ declare namespace sap {
3222
3310
  */
3223
3311
  setSelectionVariant(
3224
3312
  /**
3225
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
3313
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the table
3226
3314
  */
3227
3315
  selectionVariant: sap.fe.navigation.SelectionVariant,
3228
3316
  /**
@@ -3395,7 +3483,7 @@ declare namespace sap {
3395
3483
  * at the control level.
3396
3484
  *
3397
3485
  *
3398
- * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant }
3486
+ * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
3399
3487
  */
3400
3488
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
3401
3489
  /**
@@ -3509,7 +3597,7 @@ declare namespace sap {
3509
3597
  */
3510
3598
  setSelectionVariant(
3511
3599
  /**
3512
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
3600
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the table
3513
3601
  */
3514
3602
  selectionVariant: sap.fe.navigation.SelectionVariant,
3515
3603
  /**
@@ -3682,6 +3770,80 @@ declare namespace sap {
3682
3770
  | `{${string}}`;
3683
3771
  }
3684
3772
 
3773
+ /**
3774
+ * Describes the settings that can be provided to the CollaborativeDraftHandler constructor.
3775
+ *
3776
+ * @experimental As of version 1.141.0.
3777
+ */
3778
+ interface $CollaborativeDraftHandlerSettings
3779
+ extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
3780
+ /**
3781
+ * Defines the path of the context used in the current page or block.
3782
+ * This setting is defined by the framework, and can be overwritten.
3783
+ *
3784
+ * @experimental As of version 1.141.0.
3785
+ */
3786
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3787
+
3788
+ /**
3789
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
3790
+ *
3791
+ * @experimental As of version 1.141.0.
3792
+ */
3793
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3794
+
3795
+ /**
3796
+ * If set to true, the standard Avatar control is displayed to indicate the lock status.
3797
+ * If set to false, nothing is displayed.
3798
+ *
3799
+ * @experimental As of version 1.141.0.
3800
+ */
3801
+ showAvatar?:
3802
+ | boolean
3803
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3804
+ | `{${string}}`;
3805
+ }
3806
+
3807
+ /**
3808
+ * Describes the settings that can be provided to the ConditionalSwitch constructor.
3809
+ *
3810
+ * @experimental As of version 1.141.0.
3811
+ */
3812
+ interface $ConditionalSwitchSettings
3813
+ extends sap.fe.base.$BuildingBlockBaseSettings {
3814
+ /**
3815
+ * A function that returns the content to be rendered based on the evaluation of the switchProperties.
3816
+ * The function receives an object with the switchProperties as key-value pairs, the binding context, and
3817
+ * the displayed control.
3818
+ * The function should return a single UI5 control.
3819
+ */
3820
+ factory?:
3821
+ | Function
3822
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3823
+ | `{${string}}`;
3824
+ }
3825
+
3826
+ /**
3827
+ * Describes the settings that can be provided to the ConditionalSwitchProperty constructor.
3828
+ *
3829
+ * @experimental As of version 1.141.0.
3830
+ */
3831
+ interface $ConditionalSwitchPropertySettings
3832
+ extends sap.ui.core.$ElementSettings {
3833
+ /**
3834
+ * The key of the property.
3835
+ */
3836
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3837
+
3838
+ /**
3839
+ * The value of the property.
3840
+ */
3841
+ value?:
3842
+ | any
3843
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3844
+ | `{${string}}`;
3845
+ }
3846
+
3685
3847
  /**
3686
3848
  * Describes the settings that can be provided to the Field constructor.
3687
3849
  */
@@ -3891,19 +4053,18 @@ declare namespace sap {
3891
4053
  interface $PageSettings
3892
4054
  extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
3893
4055
  /**
3894
- * Avatar source of the page. It is considered only if the title property is specified.
4056
+ * Source of the avatar image. This property is considered only if the title property is defined.
3895
4057
  */
3896
4058
  avatarSrc?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3897
4059
 
3898
4060
  /**
3899
- * Description of the page. It is considered only if the title property is specified.
4061
+ * Provides additional details of the page. This property is considered only if the title property is defined.
3900
4062
  */
3901
4063
  description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3902
4064
 
3903
4065
  /**
3904
- * Title of the page
3905
- * If title is not given, then we will add a title, avatar and description based on the unqualified HeaderInfo
3906
- * associated to the entity
4066
+ * Title of the page. If no title is provided, the title, avatar, and description are derived from the unqualified
4067
+ * HeaderInfo annotation associated with the entity.
3907
4068
  */
3908
4069
  title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3909
4070
 
@@ -4015,6 +4176,57 @@ declare namespace sap {
4015
4176
  shareOptions?: sap.fe.macros.share.ShareOptions;
4016
4177
  }
4017
4178
 
4179
+ /**
4180
+ * Describes the settings that can be provided to the Status constructor.
4181
+ *
4182
+ * @experimental As of version 1.141.0.
4183
+ */
4184
+ interface $StatusSettings
4185
+ extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
4186
+ /**
4187
+ * Context path for the binding context.
4188
+ */
4189
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4190
+
4191
+ /**
4192
+ * Determines whether the background color reflects the set state of the ObjectStatus instead of the control's
4193
+ * text.
4194
+ */
4195
+ inverted?:
4196
+ | boolean
4197
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4198
+ | `{${string}}`;
4199
+
4200
+ /**
4201
+ * Indicates whether the ObjectStatus should be displayed in large design mode.
4202
+ */
4203
+ largeDesign?:
4204
+ | boolean
4205
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4206
+ | `{${string}}`;
4207
+
4208
+ /**
4209
+ * Metadata path to the DataField annotation or property.
4210
+ */
4211
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4212
+
4213
+ /**
4214
+ * When the Status is clickable, it defines the size of the reactive area of the clickable element:
4215
+ * - ReactiveAreaMode.Inline - The Status is displayed as part of a sentence.
4216
+ * - ReactiveAreaMode.Overlay - The Status is displayed as an overlay on top of other interactive parts
4217
+ * of the page.
4218
+ * Note: It is designed to make the clickable element easier to activate and helps meet the WCAG 2.2 Target
4219
+ * Size requirement. It is applicable only for the SAP Horizon themes. Note: The size of the reactive area
4220
+ * is sufficiently large to help users avoid accidentally selecting (clicking or tapping) unintended UI
4221
+ * elements. UI elements positioned over other parts of the page may need an invisible active touch area.
4222
+ * This ensures that no elements beneath are activated accidentally when the user tries to interact with
4223
+ * the overlay element.
4224
+ */
4225
+ reactiveAreaMode?:
4226
+ | string
4227
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
4228
+ }
4229
+
4018
4230
  /**
4019
4231
  * Describes the settings that can be provided to the VariantManagement constructor.
4020
4232
  */
@@ -4240,6 +4452,12 @@ declare namespace sap {
4240
4452
  | sap.ui.base.ManagedObject.PropertyBindingInfo
4241
4453
  | `{${string}}`;
4242
4454
 
4455
+ /**
4456
+ * Configures the file name of exported table.
4457
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
4458
+ */
4459
+ exportFileName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4460
+
4243
4461
  /**
4244
4462
  * Maximum allowed number of records to be exported in one request.
4245
4463
  */
@@ -4248,6 +4466,14 @@ declare namespace sap {
4248
4466
  | sap.ui.base.ManagedObject.PropertyBindingInfo
4249
4467
  | `{${string}}`;
4250
4468
 
4469
+ /**
4470
+ * Configures the sheet name of exported table.
4471
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
4472
+ */
4473
+ exportSheetName?:
4474
+ | string
4475
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
4476
+
4251
4477
  /**
4252
4478
  * ID of the FilterBar building block associated with the table.
4253
4479
  */
@@ -4596,6 +4822,12 @@ declare namespace sap {
4596
4822
  | sap.ui.base.ManagedObject.PropertyBindingInfo
4597
4823
  | `{${string}}`;
4598
4824
 
4825
+ /**
4826
+ * Configures the file name of exported table.
4827
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
4828
+ */
4829
+ exportFileName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4830
+
4599
4831
  /**
4600
4832
  * Maximum allowed number of records to be exported in one request.
4601
4833
  */
@@ -4604,6 +4836,14 @@ declare namespace sap {
4604
4836
  | sap.ui.base.ManagedObject.PropertyBindingInfo
4605
4837
  | `{${string}}`;
4606
4838
 
4839
+ /**
4840
+ * Configures the sheet name of exported table.
4841
+ * It's limited to 31 characters. If the name is longer, it will be truncated.
4842
+ */
4843
+ exportSheetName?:
4844
+ | string
4845
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
4846
+
4607
4847
  /**
4608
4848
  * ID of the FilterBar building block associated with the table.
4609
4849
  */
@@ -4889,6 +5129,16 @@ declare namespace sap {
4889
5129
  */
4890
5130
  interface Chart$SelectionChangeEventParameters {}
4891
5131
 
5132
+ /**
5133
+ * Parameters of the CollaborativeDraftHandler#lockChange event.
5134
+ */
5135
+ interface CollaborativeDraftHandler$LockChangeEventParameters {}
5136
+
5137
+ /**
5138
+ * Parameters of the ConditionalSwitchProperty#valueChanged event.
5139
+ */
5140
+ interface ConditionalSwitchProperty$ValueChangedEventParameters {}
5141
+
4892
5142
  /**
4893
5143
  * Parameters of the Field#change event.
4894
5144
  */
@@ -4909,6 +5159,11 @@ declare namespace sap {
4909
5159
  */
4910
5160
  interface MessageButton$VisibilityChangeEventParameters {}
4911
5161
 
5162
+ /**
5163
+ * Parameters of the Status#press event.
5164
+ */
5165
+ interface Status$PressEventParameters {}
5166
+
4912
5167
  /**
4913
5168
  * Parameters of the FilterBar#afterClear event.
4914
5169
  */
@@ -4986,7 +5241,7 @@ declare namespace sap {
4986
5241
  * Gets the key of the current variant in the associated variant management.
4987
5242
  *
4988
5243
  *
4989
- * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
5244
+ * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement} applied to the chart
4990
5245
  */
4991
5246
  getCurrentVariantKey(): null | string;
4992
5247
  /**
@@ -5028,7 +5283,7 @@ declare namespace sap {
5028
5283
  * Get the presentation variant that is currently applied on the chart.
5029
5284
  *
5030
5285
  *
5031
- * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
5286
+ * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant} applied to the chart
5032
5287
  */
5033
5288
  getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
5034
5289
  /**
@@ -5050,7 +5305,7 @@ declare namespace sap {
5050
5305
  * at the control level.
5051
5306
  *
5052
5307
  *
5053
- * @returns A promise that resolves with {@link sap.fe.navigation.SelectionVariant }.
5308
+ * @returns A promise that resolves with {@link sap.fe.navigation.SelectionVariant}.
5054
5309
  */
5055
5310
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
5056
5311
  /**
@@ -5072,7 +5327,7 @@ declare namespace sap {
5072
5327
  */
5073
5328
  setCurrentVariantKey(
5074
5329
  /**
5075
- * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
5330
+ * The variant key of {@link sap.ui.fl.variants.VariantManagement} to be set
5076
5331
  */
5077
5332
  key: string
5078
5333
  ): void;
@@ -5121,7 +5376,7 @@ declare namespace sap {
5121
5376
  */
5122
5377
  setPresentationVariant(
5123
5378
  /**
5124
- * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
5379
+ * the presentation variant {@link sap.fe.navigation.PresentationVariant} to be set
5125
5380
  */
5126
5381
  presentationVariant: sap.fe.navigation.PresentationVariant
5127
5382
  ): Promise<void>;
@@ -5141,7 +5396,7 @@ declare namespace sap {
5141
5396
  */
5142
5397
  setSelectionVariant(
5143
5398
  /**
5144
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
5399
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the chart
5145
5400
  */
5146
5401
  selectionVariant: sap.fe.navigation.SelectionVariant,
5147
5402
  /**
@@ -5158,6 +5413,14 @@ declare namespace sap {
5158
5413
  */
5159
5414
  setVariantManagement(): string;
5160
5415
  }
5416
+ /**
5417
+ * A BuildingBlock to watch the lock status of a property and to react on changes.
5418
+ *
5419
+ * @since 1.141.0
5420
+ * @experimental As of version 1.141.0.
5421
+ */
5422
+ class CollaborativeDraftHandler extends sap.fe.core.buildingBlocks
5423
+ .BuildingBlock {}
5161
5424
  /**
5162
5425
  * API to add parameters to the collection binding info.
5163
5426
  */
@@ -5232,6 +5495,28 @@ declare namespace sap {
5232
5495
  */
5233
5496
  getSorters(): sap.ui.model.Sorter[] | undefined;
5234
5497
  }
5498
+ /**
5499
+ * Defines a conditional template that renders content based on the evaluation of a set of switchProperties.
5500
+ * The switchProperties are defined using the {@link sap.fe.macros.ConditionalSwitchProperty } building
5501
+ * block.
5502
+ *
5503
+ * @since 1.141.0
5504
+ * @experimental As of version 1.141.0.
5505
+ */
5506
+ class ConditionalSwitch
5507
+ extends sap.fe.base.BuildingBlockBase
5508
+ implements sap.ui.core.IFormContent
5509
+ {
5510
+ __implements__sap_ui_core_IFormContent: boolean;
5511
+ }
5512
+ /**
5513
+ * Defines a property with a key and a value that can be used in conditional templates.
5514
+ * When the value is changed, a `valueChanged` event is fired.
5515
+ *
5516
+ * @since 1.141.0
5517
+ * @experimental As of version 1.141.0.
5518
+ */
5519
+ class ConditionalSwitchProperty extends sap.ui.core.Element {}
5235
5520
  /**
5236
5521
  * Building block for creating a field based on the metadata provided by OData V4.
5237
5522
  *
@@ -5464,8 +5749,8 @@ declare namespace sap {
5464
5749
  */
5465
5750
  class MultiValueField extends sap.fe.core.buildingBlocks.BuildingBlock {}
5466
5751
  /**
5467
- * Provides a Page building block that can be used to create a page with a title and content
5468
- * By default, the page comes with an ObjectTitle
5752
+ * Building block used to create a custom page with a title and the content. By default, the page includes
5753
+ * a title.
5469
5754
  */
5470
5755
  class Page extends sap.fe.core.buildingBlocks.BuildingBlock {}
5471
5756
  /**
@@ -5525,6 +5810,18 @@ declare namespace sap {
5525
5810
  * @since 1.93.0
5526
5811
  */
5527
5812
  class Share extends sap.fe.core.buildingBlocks.BuildingBlock {}
5813
+ /**
5814
+ * Building block to display a status and criticality.
5815
+ *
5816
+ * @since 1.141.0
5817
+ * @experimental As of version 1.141.0.
5818
+ */
5819
+ class Status
5820
+ extends sap.fe.core.buildingBlocks.BuildingBlock
5821
+ implements sap.ui.core.IFormContent
5822
+ {
5823
+ __implements__sap_ui_core_IFormContent: boolean;
5824
+ }
5528
5825
  /**
5529
5826
  * Building block used to create a Variant Management based on the metadata provided by OData V4.
5530
5827
  * Usage example:
@@ -5601,7 +5898,7 @@ declare namespace sap {
5601
5898
  * Gets the visibility of a filter field.
5602
5899
  *
5603
5900
  *
5604
- * @returns A {@link Promise } that resolves to check whether the filter field is visible or not.
5901
+ * @returns A {@link Promise} that resolves to check whether the filter field is visible or not.
5605
5902
  */
5606
5903
  getFilterFieldVisible(
5607
5904
  /**
@@ -5624,7 +5921,7 @@ declare namespace sap {
5624
5921
  * that uses a custom operator.
5625
5922
  *
5626
5923
  *
5627
- * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
5924
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
5628
5925
  */
5629
5926
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
5630
5927
  /**
@@ -5655,7 +5952,7 @@ declare namespace sap {
5655
5952
  * The property will not be hidden inside the adaptation dialog and may be re-added.
5656
5953
  *
5657
5954
  *
5658
- * @returns A {@link Promise } resolving once the change in visibility was applied
5955
+ * @returns A {@link Promise} resolving once the change in visibility was applied
5659
5956
  */
5660
5957
  setFilterFieldVisible(
5661
5958
  /**
@@ -5707,7 +6004,7 @@ declare namespace sap {
5707
6004
  */
5708
6005
  setSelectionVariant(
5709
6006
  /**
5710
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
6007
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
5711
6008
  */
5712
6009
  selectionVariant: sap.fe.navigation.SelectionVariant,
5713
6010
  /**
@@ -5835,7 +6132,7 @@ declare namespace sap {
5835
6132
  * at the control level.
5836
6133
  *
5837
6134
  *
5838
- * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant }
6135
+ * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
5839
6136
  */
5840
6137
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
5841
6138
  /**
@@ -5907,7 +6204,7 @@ declare namespace sap {
5907
6204
  */
5908
6205
  setSelectionVariant(
5909
6206
  /**
5910
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
6207
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the table
5911
6208
  */
5912
6209
  selectionVariant: sap.fe.navigation.SelectionVariant,
5913
6210
  /**
@@ -6009,7 +6306,7 @@ declare namespace sap {
6009
6306
  * at the control level.
6010
6307
  *
6011
6308
  *
6012
- * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant }
6309
+ * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
6013
6310
  */
6014
6311
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
6015
6312
  /**
@@ -6081,7 +6378,7 @@ declare namespace sap {
6081
6378
  */
6082
6379
  setSelectionVariant(
6083
6380
  /**
6084
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
6381
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the table
6085
6382
  */
6086
6383
  selectionVariant: sap.fe.navigation.SelectionVariant,
6087
6384
  /**
@@ -6114,6 +6411,22 @@ declare namespace sap {
6114
6411
  Chart
6115
6412
  >;
6116
6413
 
6414
+ /**
6415
+ * Event object of the CollaborativeDraftHandler#lockChange event.
6416
+ */
6417
+ type CollaborativeDraftHandler$LockChangeEvent = sap.ui.base.Event<
6418
+ CollaborativeDraftHandler$LockChangeEventParameters,
6419
+ CollaborativeDraftHandler
6420
+ >;
6421
+
6422
+ /**
6423
+ * Event object of the ConditionalSwitchProperty#valueChanged event.
6424
+ */
6425
+ type ConditionalSwitchProperty$ValueChangedEvent = sap.ui.base.Event<
6426
+ ConditionalSwitchProperty$ValueChangedEventParameters,
6427
+ ConditionalSwitchProperty
6428
+ >;
6429
+
6117
6430
  /**
6118
6431
  * Event object of the Field#change event.
6119
6432
  */
@@ -6146,6 +6459,14 @@ declare namespace sap {
6146
6459
  MessageButton
6147
6460
  >;
6148
6461
 
6462
+ /**
6463
+ * Event object of the Status#press event.
6464
+ */
6465
+ type Status$PressEvent = sap.ui.base.Event<
6466
+ Status$PressEventParameters,
6467
+ Status
6468
+ >;
6469
+
6149
6470
  /**
6150
6471
  * Event object of the FilterBar#afterClear event.
6151
6472
  */
@@ -6229,8 +6550,14 @@ declare namespace sap {
6229
6550
 
6230
6551
  "sap/fe/macros/chart/Chart": undefined;
6231
6552
 
6553
+ "sap/fe/macros/CollaborativeDraftHandler": undefined;
6554
+
6232
6555
  "sap/fe/macros/CollectionBindingInfo": undefined;
6233
6556
 
6557
+ "sap/fe/macros/ConditionalSwitch": undefined;
6558
+
6559
+ "sap/fe/macros/ConditionalSwitchProperty": undefined;
6560
+
6234
6561
  "sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;
6235
6562
 
6236
6563
  "sap/fe/macros/controls/BuildingBlockWithTemplating": undefined;
@@ -6285,6 +6612,8 @@ declare namespace sap {
6285
6612
 
6286
6613
  "sap/fe/macros/share/ShareOptions": undefined;
6287
6614
 
6615
+ "sap/fe/macros/Status": undefined;
6616
+
6288
6617
  "sap/fe/macros/table/Action": undefined;
6289
6618
 
6290
6619
  "sap/fe/macros/table/ActionGroup": undefined;