@sapui5/types 1.122.2 → 1.123.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 (64) 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 +408 -32
  4. package/types/sap.chart.d.ts +58 -6
  5. package/types/sap.collaboration.d.ts +52 -9
  6. package/types/sap.esh.search.ui.d.ts +2066 -2
  7. package/types/sap.f.d.ts +435 -98
  8. package/types/sap.fe.core.d.ts +9 -3
  9. package/types/sap.fe.macros.d.ts +1075 -70
  10. package/types/sap.fe.navigation.d.ts +1 -1
  11. package/types/sap.fe.placeholder.d.ts +1 -1
  12. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +8 -6
  14. package/types/sap.fe.test.d.ts +309 -7
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +1066 -146
  18. package/types/sap.insights.d.ts +4 -2
  19. package/types/sap.m.d.ts +3961 -399
  20. package/types/sap.makit.d.ts +115 -14
  21. package/types/sap.me.d.ts +84 -7
  22. package/types/sap.ndc.d.ts +22 -2
  23. package/types/sap.ovp.d.ts +1 -1
  24. package/types/sap.rules.ui.d.ts +44 -11
  25. package/types/sap.sac.df.d.ts +119 -67
  26. package/types/sap.suite.ui.commons.d.ts +1146 -2474
  27. package/types/sap.suite.ui.generic.template.d.ts +10 -2
  28. package/types/sap.suite.ui.microchart.d.ts +190 -28
  29. package/types/sap.tnt.d.ts +46 -10
  30. package/types/sap.ui.codeeditor.d.ts +16 -2
  31. package/types/sap.ui.commons.d.ts +797 -121
  32. package/types/sap.ui.comp.d.ts +964 -124
  33. package/types/sap.ui.core.d.ts +13204 -12618
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +22 -5
  36. package/types/sap.ui.fl.d.ts +40 -3
  37. package/types/sap.ui.generic.app.d.ts +217 -201
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +147 -9
  40. package/types/sap.ui.layout.d.ts +171 -47
  41. package/types/sap.ui.mdc.d.ts +554 -71
  42. package/types/sap.ui.richtexteditor.d.ts +28 -2
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +27 -3
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +278 -74
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +481 -42
  49. package/types/sap.ui.ux3.d.ts +527 -34
  50. package/types/sap.ui.vbm.d.ts +544 -48
  51. package/types/sap.ui.vk.d.ts +1588 -133
  52. package/types/sap.ui.vtm.d.ts +373 -27
  53. package/types/sap.ui.webc.common.d.ts +7 -1
  54. package/types/sap.ui.webc.fiori.d.ts +351 -29
  55. package/types/sap.ui.webc.main.d.ts +1035 -83
  56. package/types/sap.uiext.inbox.d.ts +124 -13
  57. package/types/sap.ushell.d.ts +1081 -383
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +123 -23
  60. package/types/sap.viz.d.ts +2619 -130
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +35 -15
  63. package/types/sap.zen.crosstab.d.ts +22 -10
  64. package/types/sap.zen.dsh.d.ts +64 -9
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.122.0
1
+ // For Library Version: 1.123.0
2
2
 
3
3
  declare module "sap/ca/ui/library" {
4
4
  export namespace charts {
@@ -977,7 +977,12 @@ declare module "sap/ca/ui/AddPicture" {
977
977
  */
978
978
  unbindPictures(): this;
979
979
  }
980
-
980
+ /**
981
+ * Describes the settings that can be provided to the AddPicture constructor.
982
+ *
983
+ * @deprecated (since 1.26) - As per central UX requirements, this control is replaced by sap.m.UploadCollection.
984
+ * Please use the new control if you start developing an application instead of using this AddPicture control.
985
+ */
981
986
  export interface $AddPictureSettings extends $ControlSettings {
982
987
  /**
983
988
  * The page container type in which the button is embedded : Tab or Form
@@ -1065,6 +1070,9 @@ declare module "sap/ca/ui/AddPicture" {
1065
1070
  fileNotSupported?: (oEvent: AddPicture$FileNotSupportedEvent) => void;
1066
1071
  }
1067
1072
 
1073
+ /**
1074
+ * Parameters of the AddPicture#fileNotSupported event.
1075
+ */
1068
1076
  export interface AddPicture$FileNotSupportedEventParameters {
1069
1077
  /**
1070
1078
  * An array containing the file names that are not supported
@@ -1072,34 +1080,61 @@ declare module "sap/ca/ui/AddPicture" {
1072
1080
  fileNames?: any;
1073
1081
  }
1074
1082
 
1083
+ /**
1084
+ * Event object of the AddPicture#fileNotSupported event.
1085
+ */
1075
1086
  export type AddPicture$FileNotSupportedEvent = Event<
1076
1087
  AddPicture$FileNotSupportedEventParameters,
1077
1088
  AddPicture
1078
1089
  >;
1079
1090
 
1091
+ /**
1092
+ * Parameters of the AddPicture#imageUploadFailed event.
1093
+ */
1080
1094
  export interface AddPicture$ImageUploadFailedEventParameters {}
1081
1095
 
1096
+ /**
1097
+ * Event object of the AddPicture#imageUploadFailed event.
1098
+ */
1082
1099
  export type AddPicture$ImageUploadFailedEvent = Event<
1083
1100
  AddPicture$ImageUploadFailedEventParameters,
1084
1101
  AddPicture
1085
1102
  >;
1086
1103
 
1104
+ /**
1105
+ * Parameters of the AddPicture#maxPictureLimitReached event.
1106
+ */
1087
1107
  export interface AddPicture$MaxPictureLimitReachedEventParameters {}
1088
1108
 
1109
+ /**
1110
+ * Event object of the AddPicture#maxPictureLimitReached event.
1111
+ */
1089
1112
  export type AddPicture$MaxPictureLimitReachedEvent = Event<
1090
1113
  AddPicture$MaxPictureLimitReachedEventParameters,
1091
1114
  AddPicture
1092
1115
  >;
1093
1116
 
1117
+ /**
1118
+ * Parameters of the AddPicture#pictureAdded event.
1119
+ */
1094
1120
  export interface AddPicture$PictureAddedEventParameters {}
1095
1121
 
1122
+ /**
1123
+ * Event object of the AddPicture#pictureAdded event.
1124
+ */
1096
1125
  export type AddPicture$PictureAddedEvent = Event<
1097
1126
  AddPicture$PictureAddedEventParameters,
1098
1127
  AddPicture
1099
1128
  >;
1100
1129
 
1130
+ /**
1131
+ * Parameters of the AddPicture#show event.
1132
+ */
1101
1133
  export interface AddPicture$ShowEventParameters {}
1102
1134
 
1135
+ /**
1136
+ * Event object of the AddPicture#show event.
1137
+ */
1103
1138
  export type AddPicture$ShowEvent = Event<
1104
1139
  AddPicture$ShowEventParameters,
1105
1140
  AddPicture
@@ -1263,7 +1298,14 @@ declare module "sap/ca/ui/charts/BarListItem" {
1263
1298
  sValue?: string
1264
1299
  ): this;
1265
1300
  }
1266
-
1301
+ /**
1302
+ * Describes the settings that can be provided to the BarListItem constructor.
1303
+ *
1304
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
1305
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
1306
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
1307
+ * not be supported anymore from 1.24.
1308
+ */
1267
1309
  export interface $BarListItemSettings extends $ListItemBaseSettings {
1268
1310
  /**
1269
1311
  * List item label
@@ -2084,7 +2126,14 @@ declare module "sap/ca/ui/charts/BubbleChart" {
2084
2126
  sYAxisTitle?: string
2085
2127
  ): this;
2086
2128
  }
2087
-
2129
+ /**
2130
+ * Describes the settings that can be provided to the BubbleChart constructor.
2131
+ *
2132
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
2133
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
2134
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
2135
+ * not be supported anymore from 1.24.
2136
+ */
2088
2137
  export interface $BubbleChartSettings extends $ChartSettings {
2089
2138
  /**
2090
2139
  * Defines the formater string for the dataLabel value to be displayed on the bubble
@@ -3548,7 +3597,14 @@ declare module "sap/ca/ui/charts/Chart" {
3548
3597
  formatter: object
3549
3598
  ): Chart;
3550
3599
  }
3551
-
3600
+ /**
3601
+ * Describes the settings that can be provided to the Chart constructor.
3602
+ *
3603
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
3604
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
3605
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
3606
+ * not be supported anymore from 1.24.
3607
+ */
3552
3608
  export interface $ChartSettings extends $ControlSettings {
3553
3609
  /**
3554
3610
  * Target width for the charting area
@@ -3731,22 +3787,40 @@ declare module "sap/ca/ui/charts/Chart" {
3731
3787
  popoverAfterOpen?: (oEvent: Event) => void;
3732
3788
  }
3733
3789
 
3790
+ /**
3791
+ * Parameters of the Chart#popoverAfterOpen event.
3792
+ */
3734
3793
  export interface Chart$PopoverAfterOpenEventParameters {}
3735
3794
 
3795
+ /**
3796
+ * Event object of the Chart#popoverAfterOpen event.
3797
+ */
3736
3798
  export type Chart$PopoverAfterOpenEvent = Event<
3737
3799
  Chart$PopoverAfterOpenEventParameters,
3738
3800
  Chart
3739
3801
  >;
3740
3802
 
3803
+ /**
3804
+ * Parameters of the Chart#popoverBeforeOpen event.
3805
+ */
3741
3806
  export interface Chart$PopoverBeforeOpenEventParameters {}
3742
3807
 
3808
+ /**
3809
+ * Event object of the Chart#popoverBeforeOpen event.
3810
+ */
3743
3811
  export type Chart$PopoverBeforeOpenEvent = Event<
3744
3812
  Chart$PopoverBeforeOpenEventParameters,
3745
3813
  Chart
3746
3814
  >;
3747
3815
 
3816
+ /**
3817
+ * Parameters of the Chart#selectDataPoint event.
3818
+ */
3748
3819
  export interface Chart$SelectDataPointEventParameters {}
3749
3820
 
3821
+ /**
3822
+ * Event object of the Chart#selectDataPoint event.
3823
+ */
3750
3824
  export type Chart$SelectDataPointEvent = Event<
3751
3825
  Chart$SelectDataPointEventParameters,
3752
3826
  Chart
@@ -4569,7 +4643,14 @@ declare module "sap/ca/ui/charts/ChartToolBar" {
4569
4643
  oToolBar: Bar
4570
4644
  ): this;
4571
4645
  }
4572
-
4646
+ /**
4647
+ * Describes the settings that can be provided to the ChartToolBar constructor.
4648
+ *
4649
+ * @deprecated (since 1.24) - Sap.ca charts and the ChartToolBar have been replaced with sap.viz and vizFrame
4650
+ * in 1.24. The UI5 control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the
4651
+ * new charts. Now that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead!
4652
+ * This control will not be supported anymore from 1.24.
4653
+ */
4573
4654
  export interface $ChartToolBarSettings extends $ControlSettings {
4574
4655
  /**
4575
4656
  * Display or not the personalization icon into the ChartToolBar
@@ -4672,22 +4753,40 @@ declare module "sap/ca/ui/charts/ChartToolBar" {
4672
4753
  secondDimensionKeySelected?: (oEvent: Event) => void;
4673
4754
  }
4674
4755
 
4756
+ /**
4757
+ * Parameters of the ChartToolBar#firstDimensionKeySelected event.
4758
+ */
4675
4759
  export interface ChartToolBar$FirstDimensionKeySelectedEventParameters {}
4676
4760
 
4761
+ /**
4762
+ * Event object of the ChartToolBar#firstDimensionKeySelected event.
4763
+ */
4677
4764
  export type ChartToolBar$FirstDimensionKeySelectedEvent = Event<
4678
4765
  ChartToolBar$FirstDimensionKeySelectedEventParameters,
4679
4766
  ChartToolBar
4680
4767
  >;
4681
4768
 
4769
+ /**
4770
+ * Parameters of the ChartToolBar#personalizationPressed event.
4771
+ */
4682
4772
  export interface ChartToolBar$PersonalizationPressedEventParameters {}
4683
4773
 
4774
+ /**
4775
+ * Event object of the ChartToolBar#personalizationPressed event.
4776
+ */
4684
4777
  export type ChartToolBar$PersonalizationPressedEvent = Event<
4685
4778
  ChartToolBar$PersonalizationPressedEventParameters,
4686
4779
  ChartToolBar
4687
4780
  >;
4688
4781
 
4782
+ /**
4783
+ * Parameters of the ChartToolBar#secondDimensionKeySelected event.
4784
+ */
4689
4785
  export interface ChartToolBar$SecondDimensionKeySelectedEventParameters {}
4690
4786
 
4787
+ /**
4788
+ * Event object of the ChartToolBar#secondDimensionKeySelected event.
4789
+ */
4691
4790
  export type ChartToolBar$SecondDimensionKeySelectedEvent = Event<
4692
4791
  ChartToolBar$SecondDimensionKeySelectedEventParameters,
4693
4792
  ChartToolBar
@@ -4900,7 +4999,14 @@ declare module "sap/ca/ui/charts/ClusterListItem" {
4900
4999
  sTitle?: string
4901
5000
  ): this;
4902
5001
  }
4903
-
5002
+ /**
5003
+ * Describes the settings that can be provided to the ClusterListItem constructor.
5004
+ *
5005
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and VizFrame in 1.24. The UI5
5006
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
5007
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
5008
+ * not be supported anymore from 1.24.
5009
+ */
4904
5010
  export interface $ClusterListItemSettings extends $ListItemBaseSettings {
4905
5011
  /**
4906
5012
  * Title
@@ -5095,7 +5201,14 @@ declare module "sap/ca/ui/charts/CombinedChart" {
5095
5201
  oSecondAxis?: any
5096
5202
  ): this;
5097
5203
  }
5098
-
5204
+ /**
5205
+ * Describes the settings that can be provided to the CombinedChart constructor.
5206
+ *
5207
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
5208
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
5209
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
5210
+ * not be supported anymore from 1.24.
5211
+ */
5099
5212
  export interface $CombinedChartSettings extends $ChartSettings {
5100
5213
  /**
5101
5214
  * Data of the Chart
@@ -5370,7 +5483,14 @@ declare module "sap/ca/ui/charts/HorizontalBarChart" {
5370
5483
  oVerticalArea: VBox
5371
5484
  ): this;
5372
5485
  }
5373
-
5486
+ /**
5487
+ * Describes the settings that can be provided to the HorizontalBarChart constructor.
5488
+ *
5489
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
5490
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
5491
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
5492
+ * not be supported anymore from 1.24.
5493
+ */
5374
5494
  export interface $HorizontalBarChartSettings extends $ChartSettings {
5375
5495
  /**
5376
5496
  * The data to be used by the chart
@@ -6017,7 +6137,14 @@ declare module "sap/ca/ui/charts/LineChart" {
6017
6137
  oVertical: VBox
6018
6138
  ): this;
6019
6139
  }
6020
-
6140
+ /**
6141
+ * Describes the settings that can be provided to the LineChart constructor.
6142
+ *
6143
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
6144
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
6145
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
6146
+ * not be supported anymore from 1.24.
6147
+ */
6021
6148
  export interface $LineChartSettings extends $ChartSettings {
6022
6149
  /**
6023
6150
  * The title to display on the chart
@@ -6140,8 +6267,18 @@ declare module "sap/ca/ui/charts/LineChart" {
6140
6267
  onDetailsSelected?: (oEvent: Event) => void;
6141
6268
  }
6142
6269
 
6270
+ /**
6271
+ * Parameters of the LineChart#onDetailsSelected event.
6272
+ *
6273
+ * @deprecated (since 1.0.0) - Do not use as it will be removed in a future release.
6274
+ */
6143
6275
  export interface LineChart$OnDetailsSelectedEventParameters {}
6144
6276
 
6277
+ /**
6278
+ * Event object of the LineChart#onDetailsSelected event.
6279
+ *
6280
+ * @deprecated (since 1.0.0) - Do not use as it will be removed in a future release.
6281
+ */
6145
6282
  export type LineChart$OnDetailsSelectedEvent = Event<
6146
6283
  LineChart$OnDetailsSelectedEventParameters,
6147
6284
  LineChart
@@ -6420,7 +6557,14 @@ declare module "sap/ca/ui/charts/StackedHorizontalBarChart" {
6420
6557
  sType?: string
6421
6558
  ): this;
6422
6559
  }
6423
-
6560
+ /**
6561
+ * Describes the settings that can be provided to the StackedHorizontalBarChart constructor.
6562
+ *
6563
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
6564
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
6565
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
6566
+ * not be supported anymore from 1.24.
6567
+ */
6424
6568
  export interface $StackedHorizontalBarChartSettings extends $ChartSettings {
6425
6569
  /**
6426
6570
  * Mapped to charType property.
@@ -6728,7 +6872,14 @@ declare module "sap/ca/ui/charts/StackedVerticalColumnChart" {
6728
6872
  sType?: string
6729
6873
  ): this;
6730
6874
  }
6731
-
6875
+ /**
6876
+ * Describes the settings that can be provided to the StackedVerticalColumnChart constructor.
6877
+ *
6878
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
6879
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
6880
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
6881
+ * not be supported anymore from 1.24.
6882
+ */
6732
6883
  export interface $StackedVerticalColumnChartSettings extends $ChartSettings {
6733
6884
  /**
6734
6885
  * Mapped to charType property.
@@ -7108,7 +7259,14 @@ declare module "sap/ca/ui/charts/VerticalBarChart" {
7108
7259
  oVerticalBarChart: Column
7109
7260
  ): this;
7110
7261
  }
7111
-
7262
+ /**
7263
+ * Describes the settings that can be provided to the VerticalBarChart constructor.
7264
+ *
7265
+ * @deprecated (since 1.24) - Sap.ca charts have been replaced with sap.viz and vizFrame in 1.24. The UI5
7266
+ * control "sap.viz.ui5.controls.VizFrame" serves as a single point of entry for all the new charts. Now
7267
+ * that 1.24 is available you are asked to use sap.viz charts and the VizFrame instead! This control will
7268
+ * not be supported anymore from 1.24.
7269
+ */
7112
7270
  export interface $VerticalBarChartSettings extends $ChartSettings {
7113
7271
  /**
7114
7272
  * The data to be used by the chart
@@ -7599,7 +7757,12 @@ declare module "sap/ca/ui/CustomerContext" {
7599
7757
  bShowSalesArea?: boolean
7600
7758
  ): this;
7601
7759
  }
7602
-
7760
+ /**
7761
+ * Describes the settings that can be provided to the CustomerContext constructor.
7762
+ *
7763
+ * @deprecated (since 1.24.3) - This control is not required anymore as per central UX requirements. Please
7764
+ * use Contextual Filter design instead! This control will not be supported anymore.
7765
+ */
7603
7766
  export interface $CustomerContextSettings extends $ControlSettings {
7604
7767
  /**
7605
7768
  * Name of your app that shall be unique.
@@ -7653,8 +7816,14 @@ declare module "sap/ca/ui/CustomerContext" {
7653
7816
  customerSelected?: (oEvent: Event) => void;
7654
7817
  }
7655
7818
 
7819
+ /**
7820
+ * Parameters of the CustomerContext#customerSelected event.
7821
+ */
7656
7822
  export interface CustomerContext$CustomerSelectedEventParameters {}
7657
7823
 
7824
+ /**
7825
+ * Event object of the CustomerContext#customerSelected event.
7826
+ */
7658
7827
  export type CustomerContext$CustomerSelectedEvent = Event<
7659
7828
  CustomerContext$CustomerSelectedEventParameters,
7660
7829
  CustomerContext
@@ -7915,7 +8084,12 @@ declare module "sap/ca/ui/CustomerControlListItem" {
7915
8084
  bShowSalesArea?: boolean
7916
8085
  ): this;
7917
8086
  }
7918
-
8087
+ /**
8088
+ * Describes the settings that can be provided to the CustomerControlListItem constructor.
8089
+ *
8090
+ * @deprecated (since 1.24.3) - This control is not required anymore as per central UX requirements. Please
8091
+ * use Contextual Filter design instead! This control will not be supported anymore.
8092
+ */
7919
8093
  export interface $CustomerControlListItemSettings
7920
8094
  extends $CustomListItemSettings {
7921
8095
  /**
@@ -8088,7 +8262,12 @@ declare module "sap/ca/ui/DatePicker" {
8088
8262
  iFirstDayOffset?: int
8089
8263
  ): this;
8090
8264
  }
8091
-
8265
+ /**
8266
+ * Describes the settings that can be provided to the DatePicker constructor.
8267
+ *
8268
+ * @deprecated (since 1.22) - This control has been made available in sap.m. Please use the sap.m.DatePicker
8269
+ * instead! This control will not be supported anymore.
8270
+ */
8092
8271
  export interface $DatePickerSettings extends $InputBaseSettings {
8093
8272
  /**
8094
8273
  * This property is used to offset the first day of the week (0 = sunday). Returns int, default 0
@@ -8213,7 +8392,12 @@ declare module "sap/ca/ui/ExpansibleFeedListItem" {
8213
8392
  iMaxLines?: int
8214
8393
  ): this;
8215
8394
  }
8216
-
8395
+ /**
8396
+ * Describes the settings that can be provided to the ExpansibleFeedListItem constructor.
8397
+ *
8398
+ * @deprecated (since 1.24) - This control has been made available in sap.m. Please use sap.m.FeedListItem
8399
+ * instead! This control will not be supported anymore.
8400
+ */
8217
8401
  export interface $ExpansibleFeedListItemSettings
8218
8402
  extends $FeedListItemSettings {
8219
8403
  /**
@@ -9353,7 +9537,12 @@ declare module "sap/ca/ui/FileUpload" {
9353
9537
  sXsrfToken?: string
9354
9538
  ): this;
9355
9539
  }
9356
-
9540
+ /**
9541
+ * Describes the settings that can be provided to the FileUpload constructor.
9542
+ *
9543
+ * @deprecated (since 1.26) - This control is available in sap.m in 1.26, as sap.m.UploadCollection. Please
9544
+ * use UploadCollection, as sap.ca.ui.FileUpload will not be supported anymore from 1.26.
9545
+ */
9357
9546
  export interface $FileUploadSettings extends $ControlSettings {
9358
9547
  /**
9359
9548
  * Url of server we wish to upload to
@@ -9552,50 +9741,102 @@ declare module "sap/ca/ui/FileUpload" {
9552
9741
  cancelClicked?: (oEvent: Event) => void;
9553
9742
  }
9554
9743
 
9744
+ /**
9745
+ * Parameters of the FileUpload#beforeUploadFile event.
9746
+ */
9555
9747
  export interface FileUpload$BeforeUploadFileEventParameters {}
9556
9748
 
9749
+ /**
9750
+ * Event object of the FileUpload#beforeUploadFile event.
9751
+ */
9557
9752
  export type FileUpload$BeforeUploadFileEvent = Event<
9558
9753
  FileUpload$BeforeUploadFileEventParameters,
9559
9754
  FileUpload
9560
9755
  >;
9561
9756
 
9757
+ /**
9758
+ * Parameters of the FileUpload#cancelClicked event.
9759
+ *
9760
+ * @deprecated (since 1.21.1) - This method is deprecated now
9761
+ */
9562
9762
  export interface FileUpload$CancelClickedEventParameters {}
9563
9763
 
9764
+ /**
9765
+ * Event object of the FileUpload#cancelClicked event.
9766
+ *
9767
+ * @deprecated (since 1.21.1) - This method is deprecated now
9768
+ */
9564
9769
  export type FileUpload$CancelClickedEvent = Event<
9565
9770
  FileUpload$CancelClickedEventParameters,
9566
9771
  FileUpload
9567
9772
  >;
9568
9773
 
9774
+ /**
9775
+ * Parameters of the FileUpload#deleteFile event.
9776
+ */
9569
9777
  export interface FileUpload$DeleteFileEventParameters {}
9570
9778
 
9779
+ /**
9780
+ * Event object of the FileUpload#deleteFile event.
9781
+ */
9571
9782
  export type FileUpload$DeleteFileEvent = Event<
9572
9783
  FileUpload$DeleteFileEventParameters,
9573
9784
  FileUpload
9574
9785
  >;
9575
9786
 
9787
+ /**
9788
+ * Parameters of the FileUpload#fileUploadFailed event.
9789
+ */
9576
9790
  export interface FileUpload$FileUploadFailedEventParameters {}
9577
9791
 
9792
+ /**
9793
+ * Event object of the FileUpload#fileUploadFailed event.
9794
+ */
9578
9795
  export type FileUpload$FileUploadFailedEvent = Event<
9579
9796
  FileUpload$FileUploadFailedEventParameters,
9580
9797
  FileUpload
9581
9798
  >;
9582
9799
 
9800
+ /**
9801
+ * Parameters of the FileUpload#renameFile event.
9802
+ */
9583
9803
  export interface FileUpload$RenameFileEventParameters {}
9584
9804
 
9805
+ /**
9806
+ * Event object of the FileUpload#renameFile event.
9807
+ */
9585
9808
  export type FileUpload$RenameFileEvent = Event<
9586
9809
  FileUpload$RenameFileEventParameters,
9587
9810
  FileUpload
9588
9811
  >;
9589
9812
 
9813
+ /**
9814
+ * Parameters of the FileUpload#saveClicked event.
9815
+ *
9816
+ * @deprecated (since 1.21.1) - This method is deprecated now. The rename or delete event is enough and
9817
+ * should be use to commit the action immediatly
9818
+ */
9590
9819
  export interface FileUpload$SaveClickedEventParameters {}
9591
9820
 
9821
+ /**
9822
+ * Event object of the FileUpload#saveClicked event.
9823
+ *
9824
+ * @deprecated (since 1.21.1) - This method is deprecated now. The rename or delete event is enough and
9825
+ * should be use to commit the action immediatly
9826
+ */
9592
9827
  export type FileUpload$SaveClickedEvent = Event<
9593
9828
  FileUpload$SaveClickedEventParameters,
9594
9829
  FileUpload
9595
9830
  >;
9596
9831
 
9832
+ /**
9833
+ * Parameters of the FileUpload#uploadFile event.
9834
+ */
9597
9835
  export interface FileUpload$UploadFileEventParameters {}
9598
9836
 
9837
+ /**
9838
+ * Event object of the FileUpload#uploadFile event.
9839
+ */
9599
9840
  export type FileUpload$UploadFileEvent = Event<
9600
9841
  FileUpload$UploadFileEventParameters,
9601
9842
  FileUpload
@@ -9769,7 +10010,12 @@ declare module "sap/ca/ui/GrowingTileContainer" {
9769
10010
  iGrowingThreshold?: int
9770
10011
  ): this;
9771
10012
  }
9772
-
10013
+ /**
10014
+ * Describes the settings that can be provided to the GrowingTileContainer constructor.
10015
+ *
10016
+ * @deprecated (since 1.24.3) - This control is not required anymore as per central UX requirements. This
10017
+ * control will not be supported anymore.
10018
+ */
9773
10019
  export interface $GrowingTileContainerSettings
9774
10020
  extends $ScrollContainerSettings {
9775
10021
  /**
@@ -10090,7 +10336,12 @@ declare module "sap/ca/ui/HierarchicalSelectDialog" {
10090
10336
  vItem: int | string | HierarchicalSelectDialogItem
10091
10337
  ): HierarchicalSelectDialogItem | null;
10092
10338
  }
10093
-
10339
+ /**
10340
+ * Describes the settings that can be provided to the HierarchicalSelectDialog constructor.
10341
+ *
10342
+ * @deprecated (since 1.24.1) - HierarchicalSelectDialog is deprecated as per central UX requirements. This
10343
+ * control will not be supported anymore.
10344
+ */
10094
10345
  export interface $HierarchicalSelectDialogSettings extends $DialogSettings {
10095
10346
  /**
10096
10347
  * Type checker, only HierarchicalSelectDialogItem are allowed. Please do NOT use the "content" aggregation
@@ -10113,15 +10364,27 @@ declare module "sap/ca/ui/HierarchicalSelectDialog" {
10113
10364
  cancel?: (oEvent: Event) => void;
10114
10365
  }
10115
10366
 
10367
+ /**
10368
+ * Parameters of the HierarchicalSelectDialog#cancel event.
10369
+ */
10116
10370
  export interface HierarchicalSelectDialog$CancelEventParameters {}
10117
10371
 
10372
+ /**
10373
+ * Event object of the HierarchicalSelectDialog#cancel event.
10374
+ */
10118
10375
  export type HierarchicalSelectDialog$CancelEvent = Event<
10119
10376
  HierarchicalSelectDialog$CancelEventParameters,
10120
10377
  HierarchicalSelectDialog
10121
10378
  >;
10122
10379
 
10380
+ /**
10381
+ * Parameters of the HierarchicalSelectDialog#select event.
10382
+ */
10123
10383
  export interface HierarchicalSelectDialog$SelectEventParameters {}
10124
10384
 
10385
+ /**
10386
+ * Event object of the HierarchicalSelectDialog#select event.
10387
+ */
10125
10388
  export type HierarchicalSelectDialog$SelectEvent = Event<
10126
10389
  HierarchicalSelectDialog$SelectEventParameters,
10127
10390
  HierarchicalSelectDialog
@@ -10283,7 +10546,12 @@ declare module "sap/ca/ui/HierarchicalSelectDialogItem" {
10283
10546
  sTitle?: string
10284
10547
  ): this;
10285
10548
  }
10286
-
10549
+ /**
10550
+ * Describes the settings that can be provided to the HierarchicalSelectDialogItem constructor.
10551
+ *
10552
+ * @deprecated (since 1.24) - This control is deprecated as per central UX requirements. This control will
10553
+ * not be supported anymore.
10554
+ */
10287
10555
  export interface $HierarchicalSelectDialogItemSettings extends $ItemSettings {
10288
10556
  /**
10289
10557
  * Dialog title for this item
@@ -10514,7 +10782,12 @@ declare module "sap/ca/ui/Hierarchy" {
10514
10782
  */
10515
10783
  unbindItems(): this;
10516
10784
  }
10517
-
10785
+ /**
10786
+ * Describes the settings that can be provided to the Hierarchy constructor.
10787
+ *
10788
+ * @deprecated (since 1.24.3) - This control is not required anymore as per central UX requirements. This
10789
+ * control will not be supported anymore.
10790
+ */
10518
10791
  export interface $HierarchySettings extends $ControlSettings {
10519
10792
  /**
10520
10793
  * Hide the levels marked optional. An expand button will appear
@@ -10876,7 +11149,12 @@ declare module "sap/ca/ui/HierarchyItem" {
10876
11149
  sTitle?: string
10877
11150
  ): this;
10878
11151
  }
10879
-
11152
+ /**
11153
+ * Describes the settings that can be provided to the HierarchyItem constructor.
11154
+ *
11155
+ * @deprecated (since 1.24) - This control is deprecated as per central UX requirements. This control will
11156
+ * not be supported anymore.
11157
+ */
10880
11158
  export interface $HierarchyItemSettings extends $ControlSettings {
10881
11159
  /**
10882
11160
  * Icon for the item
@@ -10919,8 +11197,14 @@ declare module "sap/ca/ui/HierarchyItem" {
10919
11197
  linkPress?: (oEvent: Event) => void;
10920
11198
  }
10921
11199
 
11200
+ /**
11201
+ * Parameters of the HierarchyItem#linkPress event.
11202
+ */
10922
11203
  export interface HierarchyItem$LinkPressEventParameters {}
10923
11204
 
11205
+ /**
11206
+ * Event object of the HierarchyItem#linkPress event.
11207
+ */
10924
11208
  export type HierarchyItem$LinkPressEvent = Event<
10925
11209
  HierarchyItem$LinkPressEventParameters,
10926
11210
  HierarchyItem
@@ -11210,7 +11494,12 @@ declare module "sap/ca/ui/InPlaceEdit" {
11210
11494
  sValueState?: ValueState | keyof typeof ValueState
11211
11495
  ): this;
11212
11496
  }
11213
-
11497
+ /**
11498
+ * Describes the settings that can be provided to the InPlaceEdit constructor.
11499
+ *
11500
+ * @deprecated (since 1.22) - This control is not required anymore as per central UX requirements. Please
11501
+ * use sap.m.Input instead! This control will not be supported anymore.
11502
+ */
11214
11503
  export interface $InPlaceEditSettings extends $ControlSettings {
11215
11504
  /**
11216
11505
  * Visualizes warnings or errors related to the InPlaceEdit. Possible values: Warning, Error, Success. If
@@ -11238,6 +11527,9 @@ declare module "sap/ca/ui/InPlaceEdit" {
11238
11527
  change?: (oEvent: InPlaceEdit$ChangeEvent) => void;
11239
11528
  }
11240
11529
 
11530
+ /**
11531
+ * Parameters of the InPlaceEdit#change event.
11532
+ */
11241
11533
  export interface InPlaceEdit$ChangeEventParameters {
11242
11534
  /**
11243
11535
  * The new / changed value of the InPlaceEdit.
@@ -11245,6 +11537,9 @@ declare module "sap/ca/ui/InPlaceEdit" {
11245
11537
  newValue?: string;
11246
11538
  }
11247
11539
 
11540
+ /**
11541
+ * Event object of the InPlaceEdit#change event.
11542
+ */
11248
11543
  export type InPlaceEdit$ChangeEvent = Event<
11249
11544
  InPlaceEdit$ChangeEventParameters,
11250
11545
  InPlaceEdit
@@ -12316,7 +12611,12 @@ declare module "sap/ca/ui/Notes" {
12316
12611
  iTextMaxLength?: int
12317
12612
  ): this;
12318
12613
  }
12319
-
12614
+ /**
12615
+ * Describes the settings that can be provided to the Notes constructor.
12616
+ *
12617
+ * @deprecated (since 1.22) - This control has been made available in sap.m. Please use sap.m.FeedInput
12618
+ * with sap.m.FeedListItem instead! This control will not be supported anymore.
12619
+ */
12320
12620
  export interface $NotesSettings extends $ListSettings {
12321
12621
  /**
12322
12622
  * If set to true, this control will render an additional control to create new notes.
@@ -12343,8 +12643,14 @@ declare module "sap/ca/ui/Notes" {
12343
12643
  addNote?: (oEvent: Event) => void;
12344
12644
  }
12345
12645
 
12646
+ /**
12647
+ * Parameters of the Notes#addNote event.
12648
+ */
12346
12649
  export interface Notes$AddNoteEventParameters {}
12347
12650
 
12651
+ /**
12652
+ * Event object of the Notes#addNote event.
12653
+ */
12348
12654
  export type Notes$AddNoteEvent = Event<Notes$AddNoteEventParameters, Notes>;
12349
12655
  }
12350
12656
 
@@ -12568,7 +12874,12 @@ declare module "sap/ca/ui/OverflowContainer" {
12568
12874
  sOverflowHeight?: CSSSize
12569
12875
  ): this;
12570
12876
  }
12571
-
12877
+ /**
12878
+ * Describes the settings that can be provided to the OverflowContainer constructor.
12879
+ *
12880
+ * @deprecated (since 1.24.1) - OverflowContainer is deprecated as per central UX requirements. This control
12881
+ * will not be supported anymore.
12882
+ */
12572
12883
  export interface $OverflowContainerSettings extends $ControlSettings {
12573
12884
  /**
12574
12885
  * The height of the container when not expanded. It should be determined by the application. The default
@@ -13084,7 +13395,12 @@ declare module "sap/ca/ui/OverviewTile" {
13084
13395
  sWidth?: CSSSize
13085
13396
  ): this;
13086
13397
  }
13087
-
13398
+ /**
13399
+ * Describes the settings that can be provided to the OverviewTile constructor.
13400
+ *
13401
+ * @deprecated (since 1.24.3) - This control is not required anymore as per central UX requirements. This
13402
+ * control will not be supported anymore.
13403
+ */
13088
13404
  export interface $OverviewTileSettings extends $TileSettings {
13089
13405
  /**
13090
13406
  * This property is used to set the title of the tile
@@ -13152,8 +13468,14 @@ declare module "sap/ca/ui/OverviewTile" {
13152
13468
  contactPress?: (oEvent: Event) => void;
13153
13469
  }
13154
13470
 
13471
+ /**
13472
+ * Parameters of the OverviewTile#contactPress event.
13473
+ */
13155
13474
  export interface OverviewTile$ContactPressEventParameters {}
13156
13475
 
13476
+ /**
13477
+ * Event object of the OverviewTile#contactPress event.
13478
+ */
13157
13479
  export type OverviewTile$ContactPressEvent = Event<
13158
13480
  OverviewTile$ContactPressEventParameters,
13159
13481
  OverviewTile
@@ -13459,7 +13781,12 @@ declare module "sap/ca/ui/PictureItem" {
13459
13781
  sWidth?: CSSSize
13460
13782
  ): this;
13461
13783
  }
13462
-
13784
+ /**
13785
+ * Describes the settings that can be provided to the PictureItem constructor.
13786
+ *
13787
+ * @deprecated (since 1.22) - This control has been made available in sap.m. Please use the sap.m.Carousel
13788
+ * instead! This control will not be supported anymore.
13789
+ */
13463
13790
  export interface $PictureItemSettings extends $ControlSettings {
13464
13791
  /**
13465
13792
  * The status of the picture / photo : Added, Deleted, Read
@@ -13496,8 +13823,14 @@ declare module "sap/ca/ui/PictureItem" {
13496
13823
  loaded?: (oEvent: Event) => void;
13497
13824
  }
13498
13825
 
13826
+ /**
13827
+ * Parameters of the PictureItem#loaded event.
13828
+ */
13499
13829
  export interface PictureItem$LoadedEventParameters {}
13500
13830
 
13831
+ /**
13832
+ * Event object of the PictureItem#loaded event.
13833
+ */
13501
13834
  export type PictureItem$LoadedEvent = Event<
13502
13835
  PictureItem$LoadedEventParameters,
13503
13836
  PictureItem
@@ -13744,7 +14077,14 @@ declare module "sap/ca/ui/PictureTile" {
13744
14077
  sWidth?: CSSSize
13745
14078
  ): this;
13746
14079
  }
13747
-
14080
+ /**
14081
+ * Describes the settings that can be provided to the PictureTile constructor.
14082
+ *
14083
+ * @deprecated (since 1.22) - PictureTile is used in PictureViewer control and is not meant to be consumed
14084
+ * outside of PictureViewer usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting
14085
+ * some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel
14086
+ * instead. This control will not be supported anymore.
14087
+ */
13748
14088
  export interface $PictureTileSettings extends $CustomTileSettings {
13749
14089
  /**
13750
14090
  * height (in pixels) of the picture viewer control.
@@ -13767,8 +14107,14 @@ declare module "sap/ca/ui/PictureTile" {
13767
14107
  pictureDelete?: (oEvent: Event) => void;
13768
14108
  }
13769
14109
 
14110
+ /**
14111
+ * Parameters of the PictureTile#pictureDelete event.
14112
+ */
13770
14113
  export interface PictureTile$PictureDeleteEventParameters {}
13771
14114
 
14115
+ /**
14116
+ * Event object of the PictureTile#pictureDelete event.
14117
+ */
13772
14118
  export type PictureTile$PictureDeleteEvent = Event<
13773
14119
  PictureTile$PictureDeleteEventParameters,
13774
14120
  PictureTile
@@ -14092,7 +14438,13 @@ declare module "sap/ca/ui/PictureViewer" {
14092
14438
  */
14093
14439
  setTileScaling(fTileScale: undefined): void;
14094
14440
  }
14095
-
14441
+ /**
14442
+ * Describes the settings that can be provided to the PictureViewer constructor.
14443
+ *
14444
+ * @deprecated (since 1.22) - PictureViewer was replacing the Carousel as it wasn't supporting some versions
14445
+ * of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead.
14446
+ * This control will not be supported anymore.
14447
+ */
14096
14448
  export interface $PictureViewerSettings extends $TileContainerSettings {
14097
14449
  /**
14098
14450
  * Percentage of the space occupied by the image in the picture viewer control. Please note that if the
@@ -14120,8 +14472,14 @@ declare module "sap/ca/ui/PictureViewer" {
14120
14472
  pictureDeleted?: (oEvent: Event) => void;
14121
14473
  }
14122
14474
 
14475
+ /**
14476
+ * Parameters of the PictureViewer#pictureDeleted event.
14477
+ */
14123
14478
  export interface PictureViewer$PictureDeletedEventParameters {}
14124
14479
 
14480
+ /**
14481
+ * Event object of the PictureViewer#pictureDeleted event.
14482
+ */
14125
14483
  export type PictureViewer$PictureDeletedEvent = Event<
14126
14484
  PictureViewer$PictureDeletedEventParameters,
14127
14485
  PictureViewer
@@ -14257,7 +14615,14 @@ declare module "sap/ca/ui/PictureViewerItem" {
14257
14615
  sSrc: string
14258
14616
  ): PictureViewerItem;
14259
14617
  }
14260
-
14618
+ /**
14619
+ * Describes the settings that can be provided to the PictureViewerItem constructor.
14620
+ *
14621
+ * @deprecated (since 1.22) - PictureViewerItem is used in PictureViewer control and is not meant to be
14622
+ * consumed outside of PictureViewer usage. PictureViewer was replacing the Carousel as it wasn't supporting
14623
+ * some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel
14624
+ * instead. This control will not be supported anymore.
14625
+ */
14261
14626
  export interface $PictureViewerItemSettings extends $ControlSettings {
14262
14627
  /**
14263
14628
  * Image source url.
@@ -14320,6 +14685,10 @@ declare module "sap/ca/ui/utils/busydialog" {
14320
14685
  ): void;
14321
14686
  }
14322
14687
  const busydialog: busydialog;
14688
+ /**
14689
+ * @deprecated (since 1.26) - this control is deprecated as per central UX requirements. Please use {@link sap.m.BusyDialog }
14690
+ * instead.
14691
+ */
14323
14692
  export default busydialog;
14324
14693
  }
14325
14694
 
@@ -14521,7 +14890,14 @@ declare module "sap/ca/ui/ZoomableScrollContainer" {
14521
14890
  bZoomable?: boolean
14522
14891
  ): this;
14523
14892
  }
14524
-
14893
+ /**
14894
+ * Describes the settings that can be provided to the ZoomableScrollContainer constructor.
14895
+ *
14896
+ * @deprecated (since 1.22) - ZoomableScrollContainer is used in PictureViewer control and is not meant
14897
+ * to be consumed outside of PictureViewer usage. PictureViewer was replacing the Carousel as it wasn't
14898
+ * supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please
14899
+ * use sap.m.Carousel instead. This control will not be supported anymore.
14900
+ */
14525
14901
  export interface $ZoomableScrollContainerSettings
14526
14902
  extends $ScrollContainerSettings {
14527
14903
  /**