@sapui5/ts-types 1.122.2 → 1.123.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +5 -5
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +404 -3
  5. package/types/sap.chart.d.ts +58 -3
  6. package/types/sap.collaboration.d.ts +52 -3
  7. package/types/sap.esh.search.ui.d.ts +2152 -2
  8. package/types/sap.f.d.ts +432 -46
  9. package/types/sap.fe.core.d.ts +20 -15
  10. package/types/sap.fe.macros.d.ts +1048 -21
  11. package/types/sap.fe.navigation.d.ts +1 -1
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  14. package/types/sap.fe.templates.d.ts +8 -6
  15. package/types/sap.fe.test.d.ts +288 -7
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +1067 -15
  19. package/types/sap.insights.d.ts +4 -1
  20. package/types/{mobile-1.122.0-d.ts → sap.m.d.ts} +3962 -124
  21. package/types/sap.makit.d.ts +115 -2
  22. package/types/sap.me.d.ts +84 -2
  23. package/types/sap.ndc.d.ts +22 -1
  24. package/types/sap.ovp.d.ts +1 -1
  25. package/types/sap.rules.ui.d.ts +44 -8
  26. package/types/sap.sac.df.d.ts +111 -60
  27. package/types/sap.suite.ui.commons.d.ts +1148 -2174
  28. package/types/sap.suite.ui.generic.template.d.ts +10 -1
  29. package/types/sap.suite.ui.microchart.d.ts +190 -2
  30. package/types/sap.tnt.d.ts +46 -2
  31. package/types/sap.ui.codeeditor.d.ts +16 -1
  32. package/types/{commons-1.122.0-d.ts → sap.ui.commons.d.ts} +792 -30
  33. package/types/sap.ui.comp.d.ts +964 -86
  34. package/types/{core-1.122.0-d.ts → sap.ui.core.d.ts} +2194 -1540
  35. package/types/sap.ui.dt.d.ts +3 -0
  36. package/types/sap.ui.export.d.ts +22 -4
  37. package/types/sap.ui.fl.d.ts +40 -1
  38. package/types/sap.ui.generic.app.d.ts +217 -203
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +147 -5
  41. package/types/sap.ui.layout.d.ts +171 -8
  42. package/types/sap.ui.mdc.d.ts +554 -33
  43. package/types/sap.ui.richtexteditor.d.ts +28 -2
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +27 -2
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +278 -57
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +481 -9
  50. package/types/{ux3-1.122.0-d.ts → sap.ui.ux3.d.ts} +527 -5
  51. package/types/sap.ui.vbm.d.ts +544 -2
  52. package/types/sap.ui.vk.d.ts +1580 -39
  53. package/types/sap.ui.vtm.d.ts +373 -2
  54. package/types/sap.ui.webc.common.d.ts +7 -2
  55. package/types/sap.ui.webc.fiori.d.ts +351 -2
  56. package/types/sap.ui.webc.main.d.ts +1035 -2
  57. package/types/sap.uiext.inbox.d.ts +124 -2
  58. package/types/sap.ushell.d.ts +1001 -322
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +123 -6
  61. package/types/sap.viz.d.ts +2619 -5
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +35 -10
  64. package/types/sap.zen.crosstab.d.ts +22 -7
  65. package/types/sap.zen.dsh.d.ts +64 -8
  66. package/types/dt-1.122.0-d.ts +0 -3
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.122.0
1
+ // For Library Version: 1.123.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.122.1
1
+ // For Library Version: 1.123.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -7,6 +7,11 @@ declare namespace sap {
7
7
  */
8
8
  namespace commons {
9
9
  namespace layout {
10
+ /**
11
+ * Describes the settings that can be provided to the AbsoluteLayout constructor.
12
+ *
13
+ * @deprecated (since 1.38) - the concept has been discarded.
14
+ */
10
15
  interface $AbsoluteLayoutSettings extends sap.ui.core.$ControlSettings {
11
16
  /**
12
17
  * The overall width of the control. When not set, 100% is automatically set.
@@ -50,6 +55,11 @@ declare namespace sap {
50
55
  | `{${string}}`;
51
56
  }
52
57
 
58
+ /**
59
+ * Describes the settings that can be provided to the MatrixLayout constructor.
60
+ *
61
+ * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
62
+ */
53
63
  interface $MatrixLayoutSettings extends sap.ui.core.$ControlSettings {
54
64
  /**
55
65
  * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
@@ -105,9 +115,19 @@ declare namespace sap {
105
115
  | `{${string}}`;
106
116
  }
107
117
 
118
+ /**
119
+ * Describes the settings that can be provided to the MatrixLayoutCell constructor.
120
+ *
121
+ * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
122
+ */
108
123
  interface $MatrixLayoutCellSettings
109
124
  extends sap.ui.core.$ElementSettings {}
110
125
 
126
+ /**
127
+ * Describes the settings that can be provided to the MatrixLayoutRow constructor.
128
+ *
129
+ * @deprecated (since 1.38) - replaced by {@link sap.ui.layout.Grid}.
130
+ */
111
131
  interface $MatrixLayoutRowSettings
112
132
  extends sap.ui.core.$ElementSettings {
113
133
  /**
@@ -128,6 +148,11 @@ declare namespace sap {
128
148
  | `{${string}}`;
129
149
  }
130
150
 
151
+ /**
152
+ * Describes the settings that can be provided to the PositionContainer constructor.
153
+ *
154
+ * @deprecated (since 1.89) - the concept has been discarded.
155
+ */
131
156
  interface $PositionContainerSettings
132
157
  extends sap.ui.core.$ElementSettings {
133
158
  /**
@@ -189,7 +214,7 @@ declare namespace sap {
189
214
  /**
190
215
  * The Absolute Layout positions its child controls absolutely
191
216
  *
192
- * @deprecated (since 1.38)
217
+ * @deprecated (since 1.38) - the concept has been discarded.
193
218
  */
194
219
  class AbsoluteLayout extends sap.ui.core.Control {
195
220
  /**
@@ -345,7 +370,7 @@ declare namespace sap {
345
370
  *
346
371
  * The overall width of the control. When not set, 100% is automatically set.
347
372
  *
348
- * Default value is `'100%'`.
373
+ * Default value is `"100%"`.
349
374
  *
350
375
  *
351
376
  * @returns Value of property `width`
@@ -527,7 +552,7 @@ declare namespace sap {
527
552
  *
528
553
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
529
554
  *
530
- * Default value is `'100%'`.
555
+ * Default value is `"100%"`.
531
556
  *
532
557
  *
533
558
  * @returns Reference to `this` in order to allow method chaining
@@ -940,7 +965,7 @@ declare namespace sap {
940
965
  /**
941
966
  * Non-control element used as part of a matrix layout's inner structure.
942
967
  *
943
- * @deprecated (since 1.89.0)
968
+ * @deprecated (since 1.38) - replaced by {@link sap.ui.layout.Grid}.
944
969
  */
945
970
  class MatrixLayoutRow extends sap.ui.core.Element {
946
971
  /**
@@ -1174,7 +1199,7 @@ declare namespace sap {
1174
1199
  /**
1175
1200
  * Is used to specify the position of a control in the AbsoluteLayout
1176
1201
  *
1177
- * @deprecated (since 1.89)
1202
+ * @deprecated (since 1.89) - the concept has been discarded.
1178
1203
  */
1179
1204
  class PositionContainer extends sap.ui.core.Element {
1180
1205
  /**
@@ -1447,7 +1472,7 @@ declare namespace sap {
1447
1472
  * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
1448
1473
  * depend on the current locale's writing direction while others do not.
1449
1474
  *
1450
- * @deprecated (since 1.89.0)
1475
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1451
1476
  */
1452
1477
  enum HAlign {
1453
1478
  /**
@@ -1476,7 +1501,7 @@ declare namespace sap {
1476
1501
  * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
1477
1502
  * the beginning or end of a line, in the current locale's writing direction.
1478
1503
  *
1479
- * @deprecated (since 1.89)
1504
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1480
1505
  * @experimental
1481
1506
  */
1482
1507
  enum Padding {
@@ -1507,7 +1532,7 @@ declare namespace sap {
1507
1532
  * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
1508
1533
  * without a vertical line in its middle.
1509
1534
  *
1510
- * @deprecated (since 1.89.0)
1535
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1511
1536
  */
1512
1537
  enum Separation {
1513
1538
  /**
@@ -1542,7 +1567,7 @@ declare namespace sap {
1542
1567
  /**
1543
1568
  * Vertical alignment, e.g. of a layout cell's content within the cell's borders.
1544
1569
  *
1545
- * @deprecated (since 1.89.0)
1570
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1546
1571
  */
1547
1572
  enum VAlign {
1548
1573
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.122.1
1
+ // For Library Version: 1.123.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -9,6 +9,11 @@ declare namespace sap {
9
9
  * @experimental
10
10
  */
11
11
  namespace crosstab {
12
+ /**
13
+ * Describes the settings that can be provided to the Crosstab constructor.
14
+ *
15
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
16
+ */
12
17
  interface $CrosstabSettings extends sap.ui.core.$ControlSettings {
13
18
  /**
14
19
  * Width of the Crosstab.
@@ -27,6 +32,11 @@ declare namespace sap {
27
32
  | `{${string}}`;
28
33
  }
29
34
 
35
+ /**
36
+ * Describes the settings that can be provided to the DataCell constructor.
37
+ *
38
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
39
+ */
30
40
  interface $DataCellSettings extends sap.ui.core.$ControlSettings {
31
41
  /**
32
42
  * the text of the data cell
@@ -74,6 +84,11 @@ declare namespace sap {
74
84
  | `{${string}}`;
75
85
  }
76
86
 
87
+ /**
88
+ * Describes the settings that can be provided to the HeaderCell constructor.
89
+ *
90
+ * @deprecated (since 1.89.0) - please use the WD Grid control instead.
91
+ */
77
92
  interface $HeaderCellSettings extends sap.ui.core.$ControlSettings {
78
93
  /**
79
94
  * Rowspan of the cell
@@ -189,7 +204,7 @@ declare namespace sap {
189
204
  /**
190
205
  * the IE8 row span
191
206
  *
192
- * @deprecated (since 1.89.0)
207
+ * @deprecated (since 1.89.0) - the concept has been discarded.
193
208
  */
194
209
  htmlIE8RowSpan?:
195
210
  | int
@@ -244,7 +259,7 @@ declare namespace sap {
244
259
  /**
245
260
  * Add your documentation for the new Crosstab
246
261
  *
247
- * @deprecated (since 1.89.0)
262
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
248
263
  */
249
264
  class Crosstab extends sap.ui.core.Control {
250
265
  /**
@@ -363,7 +378,7 @@ declare namespace sap {
363
378
  /**
364
379
  * Add your documentation for the new DataCell
365
380
  *
366
- * @deprecated (since 1.89.0)
381
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
367
382
  */
368
383
  class DataCell extends sap.ui.core.Control {
369
384
  /**
@@ -584,7 +599,7 @@ declare namespace sap {
584
599
  /**
585
600
  * Add your documentation for the new HeaderCell
586
601
  *
587
- * @deprecated (since 1.89.0)
602
+ * @deprecated (since 1.89.0) - please use the WD Grid control instead.
588
603
  */
589
604
  class HeaderCell extends sap.ui.core.Control {
590
605
  /**
@@ -746,7 +761,7 @@ declare namespace sap {
746
761
  *
747
762
  * Default value is `1`.
748
763
  *
749
- * @deprecated (since 1.89.0)
764
+ * @deprecated (since 1.89.0) - the concept has been discarded.
750
765
  *
751
766
  * @returns Value of property `htmlIE8RowSpan`
752
767
  */
@@ -1037,7 +1052,7 @@ declare namespace sap {
1037
1052
  *
1038
1053
  * Default value is `1`.
1039
1054
  *
1040
- * @deprecated (since 1.89.0)
1055
+ * @deprecated (since 1.89.0) - the concept has been discarded.
1041
1056
  *
1042
1057
  * @returns Reference to `this` in order to allow method chaining
1043
1058
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.122.1
1
+ // For Library Version: 1.123.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -10,7 +10,7 @@ declare namespace sap {
10
10
  /**
11
11
  * Model implementation for JSON format
12
12
  *
13
- * @deprecated (since 1.89.0)
13
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
14
14
  */
15
15
  class SDKModel extends sap.ui.model.Model {
16
16
  /**
@@ -56,7 +56,12 @@ declare namespace sap {
56
56
  static getMetadata(): sap.ui.base.Metadata;
57
57
  }
58
58
  }
59
-
59
+ /**
60
+ * Describes the settings that can be provided to the AnalyticGrid constructor.
61
+ *
62
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
63
+ * @experimental (since 1.46) - API is incomplete and may change incompatibly
64
+ */
60
65
  interface $AnalyticGridSettings extends sap.ui.core.$ControlSettings {
61
66
  /**
62
67
  * Desired width of the AnalyticGrid control
@@ -112,6 +117,11 @@ declare namespace sap {
112
117
  selectionChange?: (oEvent: AnalyticGrid$SelectionChangeEvent) => void;
113
118
  }
114
119
 
120
+ /**
121
+ * Describes the settings that can be provided to the Dsh constructor.
122
+ *
123
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
124
+ */
115
125
  interface $DshSettings extends sap.ui.core.$ControlSettings {
116
126
  /**
117
127
  * Name of the Design Studio application to be opened.
@@ -189,6 +199,11 @@ declare namespace sap {
189
199
  systemAlias?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
190
200
  }
191
201
 
202
+ /**
203
+ * Describes the settings that can be provided to the ValueHelpDialog constructor.
204
+ *
205
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
206
+ */
192
207
  interface $ValueHelpDialogSettings extends sap.m.$DialogSettings {
193
208
  /**
194
209
  * Defines the value for the basic search field. The value is set into the basic search field of the filter
@@ -353,6 +368,9 @@ declare namespace sap {
353
368
  ) => void;
354
369
  }
355
370
 
371
+ /**
372
+ * Parameters of the AnalyticGrid#selectionChange event.
373
+ */
356
374
  interface AnalyticGrid$SelectionChangeEventParameters {
357
375
  /**
358
376
  * A SelectionVariant specifying the current selection state of the AnalyticGrid.
@@ -360,6 +378,9 @@ declare namespace sap {
360
378
  selection?: object;
361
379
  }
362
380
 
381
+ /**
382
+ * Parameters of the AnalyticGrid#stateChange event.
383
+ */
363
384
  interface AnalyticGrid$StateChangeEventParameters {
364
385
  /**
365
386
  * Serialized state string.
@@ -367,8 +388,14 @@ declare namespace sap {
367
388
  state?: string;
368
389
  }
369
390
 
391
+ /**
392
+ * Parameters of the ValueHelpDialog#cancel event.
393
+ */
370
394
  interface ValueHelpDialog$CancelEventParameters {}
371
395
 
396
+ /**
397
+ * Parameters of the ValueHelpDialog#ok event.
398
+ */
372
399
  interface ValueHelpDialog$OkEventParameters {
373
400
  /**
374
401
  * The array of tokens created or modified on the ValueHelpDialog.
@@ -376,6 +403,9 @@ declare namespace sap {
376
403
  tokens?: sap.m.Token[];
377
404
  }
378
405
 
406
+ /**
407
+ * Parameters of the ValueHelpDialog#selectionChange event.
408
+ */
379
409
  interface ValueHelpDialog$SelectionChangeEventParameters {
380
410
  /**
381
411
  * The RowSelectionChange event parameter from the hosted table that contains the selected items.
@@ -395,6 +425,9 @@ declare namespace sap {
395
425
  useDefault?: boolean;
396
426
  }
397
427
 
428
+ /**
429
+ * Parameters of the ValueHelpDialog#tokenRemove event.
430
+ */
398
431
  interface ValueHelpDialog$TokenRemoveEventParameters {
399
432
  /**
400
433
  * The array of token keys that has been removed.
@@ -407,6 +440,9 @@ declare namespace sap {
407
440
  useDefault?: boolean;
408
441
  }
409
442
 
443
+ /**
444
+ * Parameters of the ValueHelpDialog#updateSelection event.
445
+ */
410
446
  interface ValueHelpDialog$UpdateSelectionEventParameters {
411
447
  /**
412
448
  * The array of existing token keys for which the selection in the table has to be updated.
@@ -423,7 +459,7 @@ declare namespace sap {
423
459
  * Control for embedding a Design Studio Analytic Grid in an S/4 HANA Fiori application
424
460
  *
425
461
  * @since 1.46
426
- * @deprecated (since 1.89.0)
462
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
427
463
  * @experimental (since 1.46) - API is incomplete and may change incompatibly
428
464
  */
429
465
  class AnalyticGrid extends sap.ui.core.Control {
@@ -811,7 +847,7 @@ declare namespace sap {
811
847
  * Control for embedding a Design Studio application full-screen in an S/4 HANA Fiori application
812
848
  *
813
849
  * @since 1.44
814
- * @deprecated (since 1.89)
850
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
815
851
  */
816
852
  class Dsh extends sap.ui.core.Control {
817
853
  /**
@@ -1254,7 +1290,7 @@ declare namespace sap {
1254
1290
  /**
1255
1291
  * The ValueHelpDialog control can be used to implement a value help for an input field.
1256
1292
  *
1257
- * @deprecated (since 1.89)
1293
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1258
1294
  */
1259
1295
  class ValueHelpDialog extends sap.m.Dialog {
1260
1296
  /**
@@ -2145,7 +2181,7 @@ declare namespace sap {
2145
2181
  /**
2146
2182
  * Sort Type
2147
2183
  *
2148
- * @deprecated (since 1.89)
2184
+ * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
2149
2185
  * @experimental
2150
2186
  */
2151
2187
  enum ValueHelpRangeOperation {
@@ -2186,37 +2222,57 @@ declare namespace sap {
2186
2222
  */
2187
2223
  StartsWith = "StartsWith",
2188
2224
  }
2189
-
2225
+ /**
2226
+ * Event object of the AnalyticGrid#selectionChange event.
2227
+ */
2190
2228
  type AnalyticGrid$SelectionChangeEvent = sap.ui.base.Event<
2191
2229
  AnalyticGrid$SelectionChangeEventParameters,
2192
2230
  AnalyticGrid
2193
2231
  >;
2194
2232
 
2233
+ /**
2234
+ * Event object of the AnalyticGrid#stateChange event.
2235
+ */
2195
2236
  type AnalyticGrid$StateChangeEvent = sap.ui.base.Event<
2196
2237
  AnalyticGrid$StateChangeEventParameters,
2197
2238
  AnalyticGrid
2198
2239
  >;
2199
2240
 
2241
+ /**
2242
+ * Event object of the ValueHelpDialog#cancel event.
2243
+ */
2200
2244
  type ValueHelpDialog$CancelEvent = sap.ui.base.Event<
2201
2245
  ValueHelpDialog$CancelEventParameters,
2202
2246
  ValueHelpDialog
2203
2247
  >;
2204
2248
 
2249
+ /**
2250
+ * Event object of the ValueHelpDialog#ok event.
2251
+ */
2205
2252
  type ValueHelpDialog$OkEvent = sap.ui.base.Event<
2206
2253
  ValueHelpDialog$OkEventParameters,
2207
2254
  ValueHelpDialog
2208
2255
  >;
2209
2256
 
2257
+ /**
2258
+ * Event object of the ValueHelpDialog#selectionChange event.
2259
+ */
2210
2260
  type ValueHelpDialog$SelectionChangeEvent = sap.ui.base.Event<
2211
2261
  ValueHelpDialog$SelectionChangeEventParameters,
2212
2262
  ValueHelpDialog
2213
2263
  >;
2214
2264
 
2265
+ /**
2266
+ * Event object of the ValueHelpDialog#tokenRemove event.
2267
+ */
2215
2268
  type ValueHelpDialog$TokenRemoveEvent = sap.ui.base.Event<
2216
2269
  ValueHelpDialog$TokenRemoveEventParameters,
2217
2270
  ValueHelpDialog
2218
2271
  >;
2219
2272
 
2273
+ /**
2274
+ * Event object of the ValueHelpDialog#updateSelection event.
2275
+ */
2220
2276
  type ValueHelpDialog$UpdateSelectionEvent = sap.ui.base.Event<
2221
2277
  ValueHelpDialog$UpdateSelectionEventParameters,
2222
2278
  ValueHelpDialog
@@ -1,3 +0,0 @@
1
- // For Library Version: 1.122.0
2
-
3
- declare namespace sap {}