@sapui5/ts-types 1.113.0 → 1.115.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/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +2 -2
  4. package/types/sap.ca.ui.d.ts +135 -67
  5. package/types/sap.chart.d.ts +154 -125
  6. package/types/sap.collaboration.d.ts +80 -78
  7. package/types/sap.esh.search.ui.d.ts +137 -1
  8. package/types/sap.f.d.ts +1357 -926
  9. package/types/sap.fe.core.d.ts +45 -155
  10. package/types/sap.fe.macros.d.ts +80 -9
  11. package/types/sap.fe.navigation.d.ts +34 -27
  12. package/types/sap.fe.templates.d.ts +8 -275
  13. package/types/sap.fe.test.d.ts +4 -10
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +1716 -1087
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +35 -9
  18. package/types/sap.m.d.ts +7689 -5451
  19. package/types/sap.makit.d.ts +17 -5
  20. package/types/sap.me.d.ts +122 -63
  21. package/types/sap.ndc.d.ts +99 -39
  22. package/types/sap.ovp.d.ts +1 -2
  23. package/types/sap.rules.ui.d.ts +43 -19
  24. package/types/sap.sac.df.d.ts +31 -579
  25. package/types/sap.suite.ui.commons.d.ts +2060 -1282
  26. package/types/sap.suite.ui.generic.template.d.ts +29 -40
  27. package/types/sap.suite.ui.microchart.d.ts +188 -136
  28. package/types/sap.tnt.d.ts +134 -54
  29. package/types/sap.ui.codeeditor.d.ts +51 -29
  30. package/types/sap.ui.commons.d.ts +1017 -599
  31. package/types/sap.ui.comp.d.ts +2755 -1772
  32. package/types/sap.ui.core.d.ts +5398 -3172
  33. package/types/sap.ui.dt.d.ts +1 -1
  34. package/types/sap.ui.export.d.ts +32 -29
  35. package/types/sap.ui.fl.d.ts +123 -82
  36. package/types/sap.ui.generic.app.d.ts +41 -40
  37. package/types/sap.ui.generic.template.d.ts +1 -1
  38. package/types/sap.ui.integration.d.ts +344 -163
  39. package/types/sap.ui.layout.d.ts +312 -355
  40. package/types/sap.ui.mdc.d.ts +21839 -8
  41. package/types/sap.ui.richtexteditor.d.ts +61 -49
  42. package/types/sap.ui.rta.d.ts +1 -2
  43. package/types/sap.ui.suite.d.ts +9 -9
  44. package/types/sap.ui.support.d.ts +5 -7
  45. package/types/sap.ui.table.d.ts +713 -452
  46. package/types/sap.ui.testrecorder.d.ts +1 -1
  47. package/types/sap.ui.unified.d.ts +1077 -727
  48. package/types/sap.ui.ux3.d.ts +1038 -549
  49. package/types/sap.ui.vbm.d.ts +1262 -710
  50. package/types/sap.ui.vk.d.ts +3020 -1751
  51. package/types/sap.ui.vtm.d.ts +704 -457
  52. package/types/sap.ui.webc.common.d.ts +1 -1
  53. package/types/sap.ui.webc.fiori.d.ts +532 -301
  54. package/types/sap.ui.webc.main.d.ts +1222 -720
  55. package/types/sap.uiext.inbox.d.ts +47 -24
  56. package/types/sap.ushell.d.ts +360 -174
  57. package/types/sap.ushell_abap.d.ts +1 -1
  58. package/types/sap.uxap.d.ts +287 -199
  59. package/types/sap.viz.d.ts +678 -391
  60. package/types/sap.webanalytics.core.d.ts +1 -1
  61. package/types/sap.zen.commons.d.ts +5 -5
  62. package/types/sap.zen.crosstab.d.ts +1 -1
  63. package/types/sap.zen.dsh.d.ts +147 -81
  64. package/types/sap.sac.grid.d.ts +0 -760
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.113.0
1
+ // For Library Version: 1.115.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace suite {
@@ -105,7 +105,7 @@ declare namespace sap {
105
105
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
106
106
  * are fulfilled.
107
107
  * See:
108
- * {@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
108
+ * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
109
109
  *
110
110
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
111
111
  * returned by fnFunction.
@@ -320,7 +320,7 @@ declare namespace sap {
320
320
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
321
321
  * can override this method to add/remove the filters in the exported file.
322
322
  *
323
- * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
323
+ * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
324
324
  * and add it to "oExportParams.filterSettings"
325
325
  */
326
326
  onBeforeExportTableExtension(
@@ -521,8 +521,7 @@ declare namespace sap {
521
521
  *
522
522
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
523
523
  * developers can override this method and perform conditional (internal or external) navigation from different
524
- * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
525
- * NavigationController}.
524
+ * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
526
525
  *
527
526
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
528
527
  * code has taken over navigation)
@@ -576,7 +575,6 @@ declare namespace sap {
576
575
  oCustomData: object
577
576
  ): void;
578
577
  }
579
- const controllerFrameworkExtensions: controllerFrameworkExtensions;
580
578
  }
581
579
 
582
580
  namespace Canvas {
@@ -774,7 +772,7 @@ declare namespace sap {
774
772
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
775
773
  * are fulfilled.
776
774
  * See:
777
- * {@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
775
+ * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
778
776
  *
779
777
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
780
778
  * returned by fnFunction.
@@ -898,7 +896,6 @@ declare namespace sap {
898
896
  mEntitySetToImplementation: undefined
899
897
  ): void;
900
898
  }
901
- const extensionAPI: extensionAPI;
902
899
 
903
900
  /**
904
901
  * Static access to a function that allows a regular UIComponent to be used as a Reuse Component within
@@ -911,11 +908,11 @@ declare namespace sap {
911
908
  * By using the mixInto method the existing component is checked if it implements the following functions:
912
909
  *
913
910
  * - `stStart(oModel, oBindingContext, oExtensionAPI)` - is called when the model and the context is set
914
- * for the first time above the compoenent
911
+ * for the first time above the compoenent
915
912
  * - `stRefresh(oModel, oBindingContext, oExtensionAPI)` - is called everytime a new context is set above
916
- * the component or the page context is forced to be refreshed Note that both functions can be called
917
- * with `oBindingContext` being empty. This happens in case the page the component is positioned on is opened
918
- * for creating a new object in a non-draft scenario.
913
+ * the component or the page context is forced to be refreshed Note that both functions can be called
914
+ * with `oBindingContext` being empty. This happens in case the page the component is positioned on is opened
915
+ * for creating a new object in a non-draft scenario.
919
916
  */
920
917
  mixInto(
921
918
  /**
@@ -943,12 +940,11 @@ declare namespace sap {
943
940
  bTwoWaySync?: boolean
944
941
  ): void;
945
942
  }
946
- const ReuseComponentSupport: ReuseComponentSupport;
947
943
 
948
944
  class NavigationController extends sap.ui.base.Object {
949
945
  /**
950
946
  * API to be used for navigation in extensions of Smart Template Applications. Breakout coding can access
951
- * an instance of this class via {@link sap.suite.ui.generic.template.ListReport.extensionAPI.ExtensionAPI}
947
+ * an instance of this class via {@link sap.suite.ui.generic.template.ListReport.extensionAPI.ExtensionAPI }
952
948
  * or {@link sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI}. Do not instantiate yourself.
953
949
  */
954
950
  constructor();
@@ -1055,7 +1051,7 @@ declare namespace sap {
1055
1051
  * only needs to be called in the exceptional case that the SmartLink control has been added in a custom
1056
1052
  * fragment or a reuse component, since framework takes care for all other cases.
1057
1053
  * See:
1058
- * {@link topic:3c65f2cc630c472da8328a6f3c193683 Refresh Entity Sets in keep alive mode}
1054
+ * {@link https://ui5.sap.com/#/topic/3c65f2cc630c472da8328a6f3c193683 Refresh Entity Sets in keep alive mode}
1059
1055
  */
1060
1056
  setRefreshBehaviour(
1061
1057
  /**
@@ -1138,6 +1134,8 @@ declare namespace sap {
1138
1134
  pageDataLoaded?: (oEvent: sap.ui.base.Event) => void;
1139
1135
  }
1140
1136
 
1137
+ interface $AppComponentPageDataLoadedEventParameters {}
1138
+
1141
1139
  /**
1142
1140
  * Smart Templates Application Component
1143
1141
  */
@@ -1716,7 +1714,7 @@ declare namespace sap {
1716
1714
  ): void;
1717
1715
  /**
1718
1716
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
1719
- * are fulfilled. For more information, see {@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}.
1717
+ * are fulfilled. For more information, see {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}.
1720
1718
  *
1721
1719
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
1722
1720
  * returned by fnFunction.
@@ -1866,7 +1864,7 @@ declare namespace sap {
1866
1864
  /**
1867
1865
  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
1868
1866
  *
1869
- * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal}
1867
+ * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal }
1870
1868
  * in order to visit the corresponding object page.
1871
1869
  */
1872
1870
  createEntry(
@@ -2060,8 +2058,7 @@ declare namespace sap {
2060
2058
  * data available (to allow the target app to select the part it is interested in), and thus the structure
2061
2059
  * contained looks quite similar to the iAppState.)
2062
2060
  *
2063
- * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
2064
- * Bar}.
2061
+ * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2065
2062
  */
2066
2063
  getCustomAppStateDataExtension(
2067
2064
  /**
@@ -2130,7 +2127,7 @@ declare namespace sap {
2130
2127
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
2131
2128
  * can override this method to add/remove the filters in the exported file.
2132
2129
  *
2133
- * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
2130
+ * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
2134
2131
  * and add it to "oExportParams.filterSettings"
2135
2132
  */
2136
2133
  onBeforeExportTableExtension(
@@ -2156,8 +2153,7 @@ declare namespace sap {
2156
2153
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
2157
2154
  * data.
2158
2155
  *
2159
- * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
2160
- * Bar}.
2156
+ * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2161
2157
  *
2162
2158
  * **Note: **This method is called only when a chart is rebound, and not when it is refreshed.
2163
2159
  */
@@ -2174,8 +2170,7 @@ declare namespace sap {
2174
2170
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
2175
2171
  * data.
2176
2172
  *
2177
- * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
2178
- * Bar}.
2173
+ * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2179
2174
  *
2180
2175
  * **Note: **This method is called only when a table is rebound, and not when it is refreshed.
2181
2176
  */
@@ -2236,8 +2231,7 @@ declare namespace sap {
2236
2231
  * Use this method to provide initial values for your extension filters if they deviate from the initial
2237
2232
  * value according to the data type and cannot be provided in the view fragment.
2238
2233
  *
2239
- * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
2240
- * Bar}.
2234
+ * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2241
2235
  */
2242
2236
  onInitSmartFilterBarExtension(
2243
2237
  /**
@@ -2268,8 +2262,7 @@ declare namespace sap {
2268
2262
  *
2269
2263
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
2270
2264
  * developers can override this method and perform conditional (internal or external) navigation from different
2271
- * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
2272
- * NavigationController}.
2265
+ * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
2273
2266
  *
2274
2267
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
2275
2268
  * code has taken over navigation)
@@ -2323,8 +2316,7 @@ declare namespace sap {
2323
2316
  * work). This usage is not recommended! Recommended: When called with an empty object, just return without
2324
2317
  * doing anything.
2325
2318
  *
2326
- * For more information, see {@link topic:5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter
2327
- * Bar}.
2319
+ * For more information, see {@link https://ui5.sap.com/#/topic/5fb9f57fcf12401bbe39a635e9a32a4e Adding Custom Fields to the Filter Bar}.
2328
2320
  */
2329
2321
  restoreCustomAppStateDataExtension(
2330
2322
  /**
@@ -2333,7 +2325,6 @@ declare namespace sap {
2333
2325
  oCustomData: object
2334
2326
  ): void;
2335
2327
  }
2336
- const controllerFrameworkExtensions: controllerFrameworkExtensions;
2337
2328
  }
2338
2329
 
2339
2330
  namespace ObjectPage {
@@ -2669,7 +2660,7 @@ declare namespace sap {
2669
2660
  * methods `provideCustomStateExtension` and `applyCustomStateExtension` have been overridden, such that
2670
2661
  * the corresponding state can be stored and restored.
2671
2662
  * See:
2672
- * {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
2663
+ * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
2673
2664
  *
2674
2665
  * @returns A `Promise` that is resolved when the changed state is transferred to the URL and the corresponding
2675
2666
  * busy session is ended.
@@ -2719,7 +2710,7 @@ declare namespace sap {
2719
2710
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
2720
2711
  * are fulfilled.
2721
2712
  * See:
2722
- * {@link topic:6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
2713
+ * {@link https://ui5.sap.com/#/topic/6a39150ad3e548a8b5304d32d560790a Using the SecuredExecutionMethod}
2723
2714
  *
2724
2715
  * @returns A `Promise` that is rejected, if execution is prohibited, and settled equivalent to the one
2725
2716
  * returned by fnFunction.
@@ -2928,7 +2919,7 @@ declare namespace sap {
2928
2919
  /**
2929
2920
  * This method can be called when a new entry with predefined values should be created (e.g. in a copy scenario).
2930
2921
  *
2931
- * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal}
2922
+ * @returns a context representing the object to be created. It can be passed to {@link sap.suite.ui.generic.template.extensionAPI.NavigationController#navigateInternal }
2932
2923
  * in order to visit the corresponding object page.
2933
2924
  */
2934
2925
  createEntry(
@@ -3027,7 +3018,7 @@ declare namespace sap {
3027
3018
  * use this custom state for restoring the state of the custom control. To make a complete functionality,
3028
3019
  * this method should be overridden with `provideCustomStateExtension`.
3029
3020
  * See:
3030
- * {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3021
+ * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3031
3022
  */
3032
3023
  applyCustomStateExtension(
3033
3024
  /**
@@ -3124,7 +3115,7 @@ declare namespace sap {
3124
3115
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
3125
3116
  * can override this method to add/remove the filters in the exported file.
3126
3117
  *
3127
- * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
3118
+ * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter }
3128
3119
  * and add it to "oExportParams.filterSettings"
3129
3120
  */
3130
3121
  onBeforeExportTableExtension(
@@ -3221,8 +3212,7 @@ declare namespace sap {
3221
3212
  *
3222
3213
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
3223
3214
  * developers can override this method and perform conditional (internal or external) navigation from different
3224
- * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
3225
- * NavigationController}.
3215
+ * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController NavigationController}.
3226
3216
  *
3227
3217
  * @returns Method should return `true` if framework navigation should be suppressed (that means: extension
3228
3218
  * code has taken over navigation)
@@ -3284,7 +3274,7 @@ declare namespace sap {
3284
3274
  * be stored in the oState object passed as a parameter to this method. To make a complete functionality,
3285
3275
  * this method should be overridden with `applyCustomStateExtension`.
3286
3276
  * See:
3287
- * {@link topic:89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3277
+ * {@link https://ui5.sap.com/#/topic/89fa878945294931b15a581a99043005 Custom State Handling for Extended Apps}
3288
3278
  */
3289
3279
  provideCustomStateExtension(
3290
3280
  /**
@@ -3293,7 +3283,6 @@ declare namespace sap {
3293
3283
  oState: object
3294
3284
  ): void;
3295
3285
  }
3296
- const controllerFrameworkExtensions: controllerFrameworkExtensions;
3297
3286
  }
3298
3287
 
3299
3288
  /**