@sapui5/ts-types 1.120.8 → 1.121.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 (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +50 -18
  4. package/types/sap.ca.ui.d.ts +1114 -546
  5. package/types/sap.chart.d.ts +17 -1
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1960
  8. package/types/sap.f.d.ts +124 -45
  9. package/types/sap.fe.core.d.ts +212 -191
  10. package/types/sap.fe.macros.d.ts +371 -531
  11. package/types/sap.fe.navigation.d.ts +59 -26
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +7 -0
  14. package/types/sap.fe.templates.d.ts +16 -11
  15. package/types/sap.fe.test.d.ts +333 -33
  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 +3947 -1754
  19. package/types/sap.insights.d.ts +162 -43
  20. package/types/sap.m.d.ts +2023 -289
  21. package/types/sap.makit.d.ts +11 -1
  22. package/types/sap.me.d.ts +7 -1
  23. package/types/sap.ndc.d.ts +1 -1
  24. package/types/sap.ovp.d.ts +9 -7
  25. package/types/sap.rules.ui.d.ts +134 -75
  26. package/types/sap.sac.df.d.ts +272 -49
  27. package/types/sap.suite.ui.commons.d.ts +4231 -1008
  28. package/types/sap.suite.ui.generic.template.d.ts +38 -48
  29. package/types/sap.suite.ui.microchart.d.ts +66 -1
  30. package/types/sap.tnt.d.ts +601 -116
  31. package/types/sap.ui.codeeditor.d.ts +10 -6
  32. package/types/sap.ui.commons.d.ts +86 -8
  33. package/types/sap.ui.comp.d.ts +259 -110
  34. package/types/sap.ui.core.d.ts +471 -186
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +16 -3
  37. package/types/sap.ui.fl.d.ts +91 -68
  38. package/types/sap.ui.generic.app.d.ts +250 -193
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +51 -4
  41. package/types/sap.ui.layout.d.ts +221 -26
  42. package/types/sap.ui.mdc.d.ts +1516 -787
  43. package/types/sap.ui.richtexteditor.d.ts +4 -1
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +3 -1
  46. package/types/sap.ui.support.d.ts +28 -4
  47. package/types/sap.ui.table.d.ts +65 -11
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +157 -54
  50. package/types/sap.ui.ux3.d.ts +30 -12
  51. package/types/sap.ui.vbm.d.ts +5300 -2517
  52. package/types/sap.ui.vk.d.ts +2742 -836
  53. package/types/sap.ui.vtm.d.ts +685 -215
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +49 -1
  56. package/types/sap.ui.webc.main.d.ts +144 -9
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +977 -535
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +55 -5
  61. package/types/sap.viz.d.ts +86 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +79 -18
  64. package/types/sap.zen.crosstab.d.ts +83 -15
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1741,6 +1741,9 @@ declare namespace sap {
1741
1741
  }
1742
1742
  /**
1743
1743
  * Determines which editor component should be used for editing the text.
1744
+ *
1745
+ * This enum is part of the 'sap/ui/richtexteditor/library' module export and must be accessed by the property
1746
+ * 'EditorType'.
1744
1747
  */
1745
1748
  enum EditorType {
1746
1749
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -678,6 +678,8 @@ declare namespace sap {
678
678
  }
679
679
  /**
680
680
  * Defined color values for the Task Circle Control
681
+ *
682
+ * This enum is part of the 'sap/ui/suite/library' module export and must be accessed by the property 'TaskCircleColor'.
681
683
  */
682
684
  enum TaskCircleColor {
683
685
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -117,7 +117,10 @@ declare namespace sap {
117
117
  * Usage: The CoreFacade is passed as second argument to all rule check functions.
118
118
  */
119
119
  class CoreFacade {
120
- constructor();
120
+ /**
121
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
122
+ */
123
+ protected constructor();
121
124
 
122
125
  /**
123
126
  * Gets the Components from the Core object.
@@ -153,7 +156,10 @@ declare namespace sap {
153
156
  * @since 1.48
154
157
  */
155
158
  class ExecutionScope {
156
- constructor();
159
+ /**
160
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
161
+ */
162
+ protected constructor();
157
163
 
158
164
  /**
159
165
  *
@@ -223,7 +229,10 @@ declare namespace sap {
223
229
  * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
224
230
  */
225
231
  class IssueManagerFacade {
226
- constructor();
232
+ /**
233
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
234
+ */
235
+ protected constructor();
227
236
 
228
237
  /**
229
238
  * Adds issue
@@ -246,6 +255,9 @@ declare namespace sap {
246
255
  /**
247
256
  * Defines the Audiences.
248
257
  *
258
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
259
+ * 'Audiences'.
260
+ *
249
261
  * @since 1.50
250
262
  */
251
263
  enum Audiences {
@@ -265,6 +277,9 @@ declare namespace sap {
265
277
  /**
266
278
  * Issue Categories.
267
279
  *
280
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
281
+ * 'Categories'.
282
+ *
268
283
  * @since 1.50
269
284
  */
270
285
  enum Categories {
@@ -324,6 +339,9 @@ declare namespace sap {
324
339
  /**
325
340
  * Analysis history formats.
326
341
  *
342
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
343
+ * 'HistoryFormats'.
344
+ *
327
345
  * @since 1.58
328
346
  */
329
347
  enum HistoryFormats {
@@ -339,6 +357,9 @@ declare namespace sap {
339
357
  /**
340
358
  * Defines severity types.
341
359
  *
360
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
361
+ * 'Severity'.
362
+ *
342
363
  * @since 1.50
343
364
  */
344
365
  enum Severity {
@@ -358,6 +379,9 @@ declare namespace sap {
358
379
  /**
359
380
  * Contains the available system presets.
360
381
  *
382
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
383
+ * 'SystemPresets'.
384
+ *
361
385
  * @since 1.60
362
386
  */
363
387
  enum SystemPresets {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -2788,7 +2788,8 @@ declare namespace sap {
2788
2788
  cellContextmenu?: (oEvent: Table$CellContextmenuEvent) => void;
2789
2789
 
2790
2790
  /**
2791
- * Fired when the user requests the context menu for a table cell.
2791
+ * Fired when the {@link sap.ui.table.Table#setContextMenu context menu} is opened. When the context menu
2792
+ * is opened, the binding context of the row is set to the context menu.
2792
2793
  *
2793
2794
  * @since 1.54
2794
2795
  */
@@ -4653,7 +4654,7 @@ declare namespace sap {
4653
4654
  *
4654
4655
  * @since 1.110
4655
4656
  */
4656
- getHeaderMenu(): sap.ui.core.ID;
4657
+ getHeaderMenu(): sap.ui.core.ID | null;
4657
4658
  /**
4658
4659
  * Gets current value of property {@link #getHeaderSpan headerSpan}.
4659
4660
  *
@@ -6438,6 +6439,9 @@ declare namespace sap {
6438
6439
  * Adds the given selection interval to the selection. In case of a single selection, only `iIndexTo` is
6439
6440
  * added to the selection.
6440
6441
  *
6442
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
6443
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
6444
+ *
6441
6445
  *
6442
6446
  * @returns Reference to `this` in order to allow method chaining
6443
6447
  */
@@ -6458,7 +6462,8 @@ declare namespace sap {
6458
6462
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6459
6463
  * otherwise it will be bound to this `sap.ui.table.Table` itself.
6460
6464
  *
6461
- * Fired when the user requests the context menu for a table cell.
6465
+ * Fired when the {@link sap.ui.table.Table#setContextMenu context menu} is opened. When the context menu
6466
+ * is opened, the binding context of the row is set to the context menu.
6462
6467
  *
6463
6468
  * @since 1.54
6464
6469
  *
@@ -6486,7 +6491,8 @@ declare namespace sap {
6486
6491
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6487
6492
  * otherwise it will be bound to this `sap.ui.table.Table` itself.
6488
6493
  *
6489
- * Fired when the user requests the context menu for a table cell.
6494
+ * Fired when the {@link sap.ui.table.Table#setContextMenu context menu} is opened. When the context menu
6495
+ * is opened, the binding context of the row is set to the context menu.
6490
6496
  *
6491
6497
  * @since 1.54
6492
6498
  *
@@ -7373,6 +7379,9 @@ declare namespace sap {
7373
7379
  /**
7374
7380
  * Removes complete selection.
7375
7381
  *
7382
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
7383
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
7384
+ *
7376
7385
  *
7377
7386
  * @returns Reference to `this` in order to allow method chaining
7378
7387
  */
@@ -8424,7 +8433,7 @@ declare namespace sap {
8424
8433
  * @deprecated (since 1.110)
8425
8434
  * @experimental (since 1.28) - This feature has a limited functionality.
8426
8435
  */
8427
- getGroupBy(): sap.ui.core.ID;
8436
+ getGroupBy(): sap.ui.core.ID | null;
8428
8437
  /**
8429
8438
  * Gets current value of property {@link #getMinAutoRowCount minAutoRowCount}.
8430
8439
  *
@@ -8444,7 +8453,7 @@ declare namespace sap {
8444
8453
  * This property has been deprecated and must not be used anymore, since `Scrollbar` is the only supported
8445
8454
  * option.
8446
8455
  *
8447
- * Default value is `Scrollbar`.
8456
+ * Default value is `"Scrollbar"`.
8448
8457
  *
8449
8458
  * @deprecated (since 1.38)
8450
8459
  *
@@ -8568,6 +8577,9 @@ declare namespace sap {
8568
8577
  /**
8569
8578
  * Zero-based indices of selected items, wrapped in an array. An empty array means "no selection".
8570
8579
  *
8580
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
8581
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
8582
+ *
8571
8583
  *
8572
8584
  * @returns Selected indices
8573
8585
  */
@@ -8717,7 +8729,7 @@ declare namespace sap {
8717
8729
  * In the `"Interactive"` mode, the table has as many rows as defined in the `visibleRowCount` property
8718
8730
  * after rendering. The user can change the `visibleRowCount` by dragging a resizer.
8719
8731
  *
8720
- * Default value is `Fixed`.
8732
+ * Default value is `"Fixed"`.
8721
8733
  *
8722
8734
  * @since 1.9.2
8723
8735
  * @deprecated (since 1.119) - use the `rowMode` aggregation instead.
@@ -8867,6 +8879,9 @@ declare namespace sap {
8867
8879
  /**
8868
8880
  * Checks whether an index is selected.
8869
8881
  *
8882
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
8883
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
8884
+ *
8870
8885
  *
8871
8886
  * @returns Whether the index is selected
8872
8887
  */
@@ -8987,6 +9002,9 @@ declare namespace sap {
8987
9002
  * Removes the given selection interval from the selection. In case of single selection, only `iIndexTo`
8988
9003
  * is removed from the selection.
8989
9004
  *
9005
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
9006
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
9007
+ *
8990
9008
  *
8991
9009
  * @returns Reference to `this` in order to allow method chaining
8992
9010
  */
@@ -9005,6 +9023,9 @@ declare namespace sap {
9005
9023
  * are considered to be selected might not be available at the client yet. Calling getContextByIndex might
9006
9024
  * not return a result but trigger a roundtrip to request this single entity.
9007
9025
  *
9026
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
9027
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
9028
+ *
9008
9029
  *
9009
9030
  * @returns Reference to `this` in order to allow method chaining
9010
9031
  */
@@ -9394,7 +9415,7 @@ declare namespace sap {
9394
9415
  *
9395
9416
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9396
9417
  *
9397
- * Default value is `Scrollbar`.
9418
+ * Default value is `"Scrollbar"`.
9398
9419
  *
9399
9420
  * @deprecated (since 1.38)
9400
9421
  *
@@ -9507,6 +9528,9 @@ declare namespace sap {
9507
9528
  /**
9508
9529
  * Sets the selected index. The previous selection is removed.
9509
9530
  *
9531
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
9532
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
9533
+ *
9510
9534
  *
9511
9535
  * @returns Reference to `this` in order to allow method chaining
9512
9536
  */
@@ -9540,6 +9564,9 @@ declare namespace sap {
9540
9564
  /**
9541
9565
  * Sets the given selection interval as selection. In case of a single selection, only `iIndexTo` is selected.
9542
9566
  *
9567
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
9568
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
9569
+ *
9543
9570
  *
9544
9571
  * @returns Reference to `this` in order to allow method chaining
9545
9572
  */
@@ -9556,6 +9583,9 @@ declare namespace sap {
9556
9583
  /**
9557
9584
  * Sets the selection mode. The current selection is lost.
9558
9585
  *
9586
+ * **Note:** The built-in selection API has limited functionality, especially when it is combined with paging
9587
+ * (e.g. OData). Therefore, it is recommended to use a selection plugin instead.
9588
+ *
9559
9589
  *
9560
9590
  * @returns Reference to `this` in order to allow method chaining
9561
9591
  */
@@ -9722,7 +9752,7 @@ declare namespace sap {
9722
9752
  *
9723
9753
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9724
9754
  *
9725
- * Default value is `Fixed`.
9755
+ * Default value is `"Fixed"`.
9726
9756
  *
9727
9757
  * @since 1.9.2
9728
9758
  * @deprecated (since 1.119) - use the `rowMode` aggregation instead.
@@ -9925,7 +9955,7 @@ declare namespace sap {
9925
9955
  /**
9926
9956
  * ID of the element which is the current target of the association {@link #getTable table}, or `null`.
9927
9957
  */
9928
- getTable(): sap.ui.core.ID;
9958
+ getTable(): sap.ui.core.ID | null;
9929
9959
  /**
9930
9960
  * Opens the personalization dialog for the Table to modify the visibility and the order of the columns.
9931
9961
  *
@@ -10688,6 +10718,8 @@ declare namespace sap {
10688
10718
  }
10689
10719
  /**
10690
10720
  * Details about the group event to distinguish between different actions associated with grouping
10721
+ *
10722
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'GroupEventType'.
10691
10723
  */
10692
10724
  enum GroupEventType {
10693
10725
  /**
@@ -10721,6 +10753,10 @@ declare namespace sap {
10721
10753
  }
10722
10754
  /**
10723
10755
  * Navigation mode of the table
10756
+ *
10757
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'NavigationMode'.
10758
+ *
10759
+ * @deprecated (since 1.38)
10724
10760
  */
10725
10761
  enum NavigationMode {
10726
10762
  /**
@@ -10740,6 +10776,8 @@ declare namespace sap {
10740
10776
  /**
10741
10777
  * Enumeration of the `ResetAllMode` that can be used in a `TablePersoController`.
10742
10778
  *
10779
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'ResetAllMode'.
10780
+ *
10743
10781
  * @deprecated (since 1.115)
10744
10782
  */
10745
10783
  enum ResetAllMode {
@@ -10758,6 +10796,8 @@ declare namespace sap {
10758
10796
  }
10759
10797
  /**
10760
10798
  * Row Action types.
10799
+ *
10800
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'RowActionType'.
10761
10801
  */
10762
10802
  enum RowActionType {
10763
10803
  /**
@@ -10775,6 +10815,8 @@ declare namespace sap {
10775
10815
  }
10776
10816
  /**
10777
10817
  * Selection behavior of the table
10818
+ *
10819
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'SelectionBehavior'.
10778
10820
  */
10779
10821
  enum SelectionBehavior {
10780
10822
  /**
@@ -10792,6 +10834,8 @@ declare namespace sap {
10792
10834
  }
10793
10835
  /**
10794
10836
  * Selection mode of the table
10837
+ *
10838
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'SelectionMode'.
10795
10839
  */
10796
10840
  enum SelectionMode {
10797
10841
  /**
@@ -10818,6 +10862,8 @@ declare namespace sap {
10818
10862
  *
10819
10863
  * Contains IDs of shared DOM references, which should be accessible to inheriting controls via getDomRef()
10820
10864
  * function.
10865
+ *
10866
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'SharedDomRef'.
10821
10867
  */
10822
10868
  enum SharedDomRef {
10823
10869
  /**
@@ -10832,6 +10878,8 @@ declare namespace sap {
10832
10878
  /**
10833
10879
  * Sort order of a column
10834
10880
  *
10881
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'SortOrder'.
10882
+ *
10835
10883
  * @deprecated (since 1.120) - replaced with `sap.ui.core.SortOrder`
10836
10884
  */
10837
10885
  enum SortOrder {
@@ -10846,6 +10894,10 @@ declare namespace sap {
10846
10894
  }
10847
10895
  /**
10848
10896
  * VisibleRowCountMode of the table
10897
+ *
10898
+ * This enum is part of the 'sap/ui/table/library' module export and must be accessed by the property 'VisibleRowCountMode'.
10899
+ *
10900
+ * @deprecated (since 1.119)
10849
10901
  */
10850
10902
  enum VisibleRowCountMode {
10851
10903
  /**
@@ -10996,6 +11048,8 @@ declare namespace sap {
10996
11048
 
10997
11049
  "sap/ui/table/plugins/SelectionPlugin": undefined;
10998
11050
 
11051
+ "sap/ui/table/plugins/V4Aggregation": undefined;
11052
+
10999
11053
  "sap/ui/table/Row": undefined;
11000
11054
 
11001
11055
  "sap/ui/table/RowAction": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {