@sapui5/types 1.114.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 (62) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +70 -60
  3. package/types/sap.ca.ui.d.ts +207 -105
  4. package/types/sap.chart.d.ts +148 -129
  5. package/types/sap.collaboration.d.ts +98 -87
  6. package/types/sap.esh.search.ui.d.ts +92 -2
  7. package/types/sap.f.d.ts +1378 -1019
  8. package/types/sap.fe.core.d.ts +48 -163
  9. package/types/sap.fe.macros.d.ts +76 -16
  10. package/types/sap.fe.navigation.d.ts +42 -31
  11. package/types/sap.fe.templates.d.ts +15 -293
  12. package/types/sap.fe.test.d.ts +102 -46
  13. package/types/sap.feedback.ui.d.ts +1 -1
  14. package/types/sap.gantt.d.ts +1987 -1251
  15. package/types/sap.insights.d.ts +1 -1
  16. package/types/sap.landvisz.d.ts +75 -29
  17. package/types/sap.m.d.ts +6945 -4884
  18. package/types/sap.makit.d.ts +43 -18
  19. package/types/sap.me.d.ts +112 -69
  20. package/types/sap.ndc.d.ts +101 -39
  21. package/types/sap.ovp.d.ts +3 -3
  22. package/types/sap.rules.ui.d.ts +53 -24
  23. package/types/sap.sac.df.d.ts +11 -8
  24. package/types/sap.suite.ui.commons.d.ts +2090 -1437
  25. package/types/sap.suite.ui.generic.template.d.ts +47 -44
  26. package/types/sap.suite.ui.microchart.d.ts +242 -163
  27. package/types/sap.tnt.d.ts +138 -67
  28. package/types/sap.ui.codeeditor.d.ts +37 -30
  29. package/types/sap.ui.commons.d.ts +936 -708
  30. package/types/sap.ui.comp.d.ts +2336 -1606
  31. package/types/sap.ui.core.d.ts +4625 -2580
  32. package/types/sap.ui.dt.d.ts +1 -1
  33. package/types/sap.ui.export.d.ts +38 -32
  34. package/types/sap.ui.fl.d.ts +102 -80
  35. package/types/sap.ui.generic.app.d.ts +58 -49
  36. package/types/sap.ui.generic.template.d.ts +1 -1
  37. package/types/sap.ui.integration.d.ts +219 -167
  38. package/types/sap.ui.layout.d.ts +378 -398
  39. package/types/sap.ui.mdc.d.ts +21983 -139
  40. package/types/sap.ui.richtexteditor.d.ts +55 -50
  41. package/types/sap.ui.rta.d.ts +1 -1
  42. package/types/sap.ui.suite.d.ts +13 -11
  43. package/types/sap.ui.support.d.ts +7 -7
  44. package/types/sap.ui.table.d.ts +594 -478
  45. package/types/sap.ui.testrecorder.d.ts +1 -1
  46. package/types/sap.ui.unified.d.ts +839 -587
  47. package/types/sap.ui.ux3.d.ts +847 -592
  48. package/types/sap.ui.vbm.d.ts +1018 -760
  49. package/types/sap.ui.vk.d.ts +2858 -1896
  50. package/types/sap.ui.vtm.d.ts +650 -479
  51. package/types/sap.ui.webc.common.d.ts +5 -3
  52. package/types/sap.ui.webc.fiori.d.ts +530 -345
  53. package/types/sap.ui.webc.main.d.ts +1114 -835
  54. package/types/sap.uiext.inbox.d.ts +79 -37
  55. package/types/sap.ushell.d.ts +441 -213
  56. package/types/sap.ushell_abap.d.ts +1 -1
  57. package/types/sap.uxap.d.ts +309 -222
  58. package/types/sap.viz.d.ts +932 -521
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +15 -10
  61. package/types/sap.zen.crosstab.d.ts +7 -4
  62. package/types/sap.zen.dsh.d.ts +143 -87
@@ -1,14 +1,6 @@
1
1
  // For Library Version: 1.111.0
2
2
 
3
3
  declare module "sap/fe/templates/ListReport/ExtensionAPI" {
4
- import Control from "sap/ui/core/Control";
5
-
6
- import Model from "sap/ui/model/Model";
7
-
8
- import Context from "sap/ui/model/Context";
9
-
10
- import UI5Element from "sap/ui/core/Element";
11
-
12
4
  /**
13
5
  * @SINCE 1.79.0
14
6
  *
@@ -17,19 +9,9 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
17
9
  * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
18
10
  * created by the SAP Fiori elements framework.
19
11
  */
20
- export default class ExtensionAPI
21
- /* was: sap.fe.templates.ExtensionAPI */ extends Object {
12
+ class ExtensionAPI /* was: sap.fe.core.ExtensionAPI */ extends Object {
22
13
  constructor();
23
14
 
24
- /**
25
- * Add any control as a dependent control to this SAP Fiori elements page.
26
- */
27
- addDependent(
28
- /**
29
- * Control to be added as a dependent control
30
- */
31
- oControl: Control
32
- ): void;
33
15
  /**
34
16
  * This method converts filter conditions to filters.
35
17
  *
@@ -41,12 +23,6 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
41
23
  */
42
24
  mFilterConditions: any
43
25
  ): object;
44
- /**
45
- * Retrieves the editFlow controller extension for this page.
46
- *
47
- * @returns The editFlow controller extension
48
- */
49
- getEditFlow(): /* was: sap.fe.templates.EditFlow */ any;
50
26
  /**
51
27
  * Provides all the model filters from the filter bar that are currently active
52
28
  * along with the search expression.
@@ -54,96 +30,12 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
54
30
  * @returns An array of active filters and the search expression.
55
31
  */
56
32
  getFilters(): object;
57
- /**
58
- * Retrieves the intentBasedNavigation controller extension for this page.
59
- *
60
- * @returns The intentBasedNavigation controller extension
61
- */
62
- getIntentBasedNavigation(): /* was: sap.fe.templates.IntentBasedNavigation */ any;
63
- /**
64
- * Get access to models managed by SAP Fiori elements.
65
- *
66
- * The following models can be accessed:
67
- *
68
- *
69
- * - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
70
- *
71
- * - i18n / further data models defined in the manifest
72
- * ui: returns a SAPUI5 JSON model containing UI information.
73
- * Only the following properties are public and supported:
74
- *
75
- *
76
- * - isEditable: set to true if the application is in edit mode
77
- *
78
- *
79
- * .
80
- * editMode is deprecated and should not be used anymore. Use isEditable instead.
81
- *
82
- * @returns The required model
83
- */
84
- getModel(
85
- /**
86
- * Name of the model
87
- */
88
- sModelName?: string
89
- ): Model | undefined;
90
- /**
91
- * Retrieves the routing controller extension for this page.
92
- *
93
- * @returns The routing controller extension
94
- */
95
- getRouting(): /* was: sap.fe.templates.Routing */ any;
96
33
  /**
97
34
  * Gets the list entries currently selected for the displayed control.
98
35
  *
99
36
  * @returns Array containing the selected contexts
100
37
  */
101
38
  getSelectedContexts(): any;
102
- /**
103
- * Load a fragment and go through the template preprocessor with the current page context.
104
- *
105
- * @returns The fragment definition
106
- */
107
- loadFragment(
108
- /**
109
- * The settings object
110
- */
111
- mSettings: {
112
- /**
113
- * The contextPath to be used for the templating process
114
- */
115
- contextPath: string;
116
- /**
117
- * The controller to be attached to the fragment
118
- */
119
- controller: object;
120
- /**
121
- * The ID of the fragment itself
122
- */
123
- id: string;
124
- /**
125
- * The initial binding context
126
- */
127
- initialBindingContext: Context;
128
- /**
129
- * The name of the fragment to be loaded
130
- */
131
- name: string;
132
- }
133
- ): Promise<UI5Element | UI5Element[]>;
134
- /**
135
- * Navigate to another target.
136
- */
137
- navigateToTarget(
138
- /**
139
- * Name of the target route
140
- */
141
- sTarget: string,
142
- /**
143
- * undefined
144
- */
145
- oContext: Context
146
- ): void;
147
39
  /**
148
40
  * Refreshes the List Report.
149
41
  * This method currently only supports triggering the search (by clicking on the GO button)
@@ -153,16 +45,7 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
153
45
  *
154
46
  * @returns Resolved once the data is refreshed or rejected if the request failed
155
47
  */
156
- refresh(): any;
157
- /**
158
- * Remove a dependent control from this SAP Fiori elements page.
159
- */
160
- removeDependent(
161
- /**
162
- * Control to be added as a dependent control
163
- */
164
- oControl: Control
165
- ): void;
48
+ refresh(): Promise<void>;
166
49
  /**
167
50
  * Provide an option for showing a custom message in the message strip above the list report table.
168
51
  */
@@ -170,12 +53,14 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
170
53
  /**
171
54
  * Custom message along with the message type to be set on the table.
172
55
  */
173
- message: /* was: sap.fe.templates.LRCustomMessage */ any | undefined,
56
+ message: /* was: sap.fe.templates.ListReport.LRMessageStrip.LRCustomMessage */
57
+ | any
58
+ | undefined,
174
59
  /**
175
60
  * The tabKey identifying the table where the custom message is displayed. If tabKey is empty, the message
176
61
  * is displayed in all tabs . If tabKey = ['1','2'], the message is displayed in tabs 1 and 2 only
177
62
  */
178
- tabKey?: string | string[],
63
+ tabKey?: null | string | string[],
179
64
  /**
180
65
  * A function that is called when the user closes the message bar.
181
66
  */
@@ -202,54 +87,26 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
202
87
  */
203
88
  vValues?: boolean | boolean[] | number | number[] | string | string[]
204
89
  ): Promise<void>;
205
- /**
206
- * Triggers an update of the app state.
207
- * Should be called if the state of a control, or any other state-relevant information, was changed.
208
- *
209
- * @returns A promise that resolves with the new app state object.
210
- */
211
- updateAppState(): Promise<object | void>;
212
90
  }
91
+ export default ExtensionAPI;
213
92
  }
214
93
 
215
94
  declare module "sap/fe/templates/ListReport/ListReportController.controller" {
216
- import Model from "sap/ui/model/Model";
217
-
218
- import View from "sap/ui/core/mvc/View";
95
+ import ExtensionAPI from "sap/fe/templates/ListReport/ExtensionAPI";
219
96
 
220
97
  /**
221
98
  * Controller class for the list report page, used inside an SAP Fiori elements application.
222
99
  */
223
- export default class ListReportController
224
- /* was: sap.fe.templates.PageController */ extends Object {
100
+ class ListReportController
101
+ /* was: sap.fe.core.PageController */ extends Object {
225
102
  constructor();
226
103
 
227
- /**
228
- * @SINCE 1.91.0
229
- *
230
- * Returns the current app component.
231
- *
232
- * @returns The app component or, if not found, null
233
- */
234
- getAppComponent(): /* was: sap.fe.templates.AppComponent */ any;
235
104
  /**
236
105
  * Get the extension API for the current page.
237
106
  *
238
107
  * @returns The extension API.
239
108
  */
240
- getExtensionAPI(): /* was: sap.fe.templates.ListReportExtensionAPI */ any;
241
- /**
242
- * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
243
- * name into each controller.
244
- *
245
- * @returns The model instance
246
- */
247
- getModel(
248
- /**
249
- * The model name
250
- */
251
- sName?: string
252
- ): Model;
109
+ getExtensionAPI(): ExtensionAPI;
253
110
  /**
254
111
  * Method called when the 'Clear' button on the FilterBar is pressed.
255
112
  */
@@ -294,33 +151,13 @@ declare module "sap/fe/templates/ListReport/ListReportController.controller" {
294
151
  */
295
152
  mParameters: any
296
153
  ): void;
297
- /**
298
- * Convenience method for setting the view model in every controller of the application.
299
- *
300
- * @returns The view instance
301
- */
302
- setModel(
303
- /**
304
- * The model instance
305
- */
306
- oModel: Model,
307
- /**
308
- * The model name
309
- */
310
- sName: string
311
- ): View;
312
154
  }
155
+ export default ListReportController;
313
156
  }
314
157
 
315
158
  declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
316
- import Control from "sap/ui/core/Control";
317
-
318
159
  import Context from "sap/ui/model/Context";
319
160
 
320
- import Model from "sap/ui/model/Model";
321
-
322
- import UI5Element from "sap/ui/core/Element";
323
-
324
161
  import Message from "sap/ui/core/message/Message";
325
162
 
326
163
  /**
@@ -331,70 +168,15 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
331
168
  * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
332
169
  * created by the SAP Fiori elements framework.
333
170
  */
334
- export default class ExtensionAPI
335
- /* was: sap.fe.templates.ExtensionAPI */ extends Object {
171
+ class ExtensionAPI /* was: sap.fe.core.ExtensionAPI */ extends Object {
336
172
  constructor();
337
173
 
338
- /**
339
- * Add any control as a dependent control to this SAP Fiori elements page.
340
- */
341
- addDependent(
342
- /**
343
- * Control to be added as a dependent control
344
- */
345
- oControl: Control
346
- ): void;
347
174
  /**
348
175
  * Gets the bound context of the current object page.
349
176
  *
350
177
  * @returns Context bound to the object page
351
178
  */
352
- getBindingContext(): Context | string | undefined;
353
- /**
354
- * Retrieves the editFlow controller extension for this page.
355
- *
356
- * @returns The editFlow controller extension
357
- */
358
- getEditFlow(): /* was: sap.fe.templates.EditFlow */ any;
359
- /**
360
- * Retrieves the intentBasedNavigation controller extension for this page.
361
- *
362
- * @returns The intentBasedNavigation controller extension
363
- */
364
- getIntentBasedNavigation(): /* was: sap.fe.templates.IntentBasedNavigation */ any;
365
- /**
366
- * Get access to models managed by SAP Fiori elements.
367
- *
368
- * The following models can be accessed:
369
- *
370
- *
371
- * - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
372
- *
373
- * - i18n / further data models defined in the manifest
374
- * ui: returns a SAPUI5 JSON model containing UI information.
375
- * Only the following properties are public and supported:
376
- *
377
- *
378
- * - isEditable: set to true if the application is in edit mode
379
- *
380
- *
381
- * .
382
- * editMode is deprecated and should not be used anymore. Use isEditable instead.
383
- *
384
- * @returns The required model
385
- */
386
- getModel(
387
- /**
388
- * Name of the model
389
- */
390
- sModelName?: string
391
- ): Model | undefined;
392
- /**
393
- * Retrieves the routing controller extension for this page.
394
- *
395
- * @returns The routing controller extension
396
- */
397
- getRouting(): /* was: sap.fe.templates.Routing */ any;
179
+ getBindingContext(): null | Context | undefined;
398
180
  /**
399
181
  * Gets the list entries currently selected for the table.
400
182
  *
@@ -410,51 +192,6 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
410
192
  * Hides the message strip below the anchor bar.
411
193
  */
412
194
  hideMessage(): void;
413
- /**
414
- * Load a fragment and go through the template preprocessor with the current page context.
415
- *
416
- * @returns The fragment definition
417
- */
418
- loadFragment(
419
- /**
420
- * The settings object
421
- */
422
- mSettings: {
423
- /**
424
- * The contextPath to be used for the templating process
425
- */
426
- contextPath: string;
427
- /**
428
- * The controller to be attached to the fragment
429
- */
430
- controller: object;
431
- /**
432
- * The ID of the fragment itself
433
- */
434
- id: string;
435
- /**
436
- * The initial binding context
437
- */
438
- initialBindingContext: Context;
439
- /**
440
- * The name of the fragment to be loaded
441
- */
442
- name: string;
443
- }
444
- ): Promise<UI5Element | UI5Element[]>;
445
- /**
446
- * Navigate to another target.
447
- */
448
- navigateToTarget(
449
- /**
450
- * Name of the target route
451
- */
452
- sTarget: string,
453
- /**
454
- * undefined
455
- */
456
- oContext: Context
457
- ): void;
458
195
  /**
459
196
  * Refreshes either the whole object page or only parts of it.
460
197
  *
@@ -466,15 +203,6 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
466
203
  */
467
204
  vPath: string | string[] | undefined
468
205
  ): Promise<void>;
469
- /**
470
- * Remove a dependent control from this SAP Fiori elements page.
471
- */
472
- removeDependent(
473
- /**
474
- * Control to be added as a dependent control
475
- */
476
- oControl: Control
477
- ): void;
478
206
  /**
479
207
  * Displays the message strip between the title and the header of the ObjectPage.
480
208
  */
@@ -497,14 +225,8 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
497
225
  */
498
226
  bShow: boolean | undefined
499
227
  ): void;
500
- /**
501
- * Triggers an update of the app state.
502
- * Should be called if the state of a control, or any other state-relevant information, was changed.
503
- *
504
- * @returns A promise that resolves with the new app state object.
505
- */
506
- updateAppState(): Promise<object | void>;
507
228
  }
229
+ export default ExtensionAPI;
508
230
  }
509
231
 
510
232
  declare module "sap/fe/templates/library" {}