@sapui5/ts-types 1.94.0 → 1.96.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 (64) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +235 -1
  8. package/types/sap.f.d.ts +310 -40
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +102 -1
  11. package/types/sap.fe.macros.d.ts +36 -12
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +1 -1
  14. package/types/sap.fe.plugins.d.ts +1 -1
  15. package/types/sap.fe.semantics.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +2 -2
  17. package/types/sap.fe.test.d.ts +1 -1
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +1070 -44
  21. package/types/sap.landvisz.d.ts +1 -1
  22. package/types/sap.m.d.ts +643 -115
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +21 -29
  26. package/types/sap.ovp.d.ts +1 -1
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.grid.d.ts +635 -0
  29. package/types/sap.suite.ui.commons.d.ts +177 -3
  30. package/types/sap.suite.ui.generic.template.d.ts +49 -6
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +11 -12
  33. package/types/sap.ui.codeeditor.d.ts +29 -31
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +149 -18
  36. package/types/sap.ui.core.d.ts +691 -313
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +119 -69
  39. package/types/sap.ui.fl.d.ts +3 -1
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +232 -1
  43. package/types/sap.ui.layout.d.ts +19 -1
  44. package/types/sap.ui.mdc.d.ts +51 -1
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +6 -6
  49. package/types/sap.ui.table.d.ts +7 -4
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +140 -1
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +793 -130
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.uiext.inbox.d.ts +2 -1
  57. package/types/sap.ushell.d.ts +69 -49
  58. package/types/sap.ushell_abap.d.ts +2 -2
  59. package/types/sap.uxap.d.ts +1 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +53 -34
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  namespace uiext {
@@ -2169,6 +2169,7 @@ declare namespace sap {
2169
2169
  const InboxSecondaryFilterValuesEnum: InboxSecondaryFilterValuesEnum;
2170
2170
 
2171
2171
  /**
2172
+ * @deprecated (since 1.38.0)
2172
2173
  * @EXPERIMENTAL (since 1.5.2)
2173
2174
  *
2174
2175
  * A comprehensive UI design approach with graphical and functional elements for search tasks, filter tasks,
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -82,9 +82,13 @@ declare namespace sap {
82
82
  *
83
83
  * The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell.
84
84
  */
85
- class Renderer extends sap.ui.core.UIComponent {
85
+ class Renderer
86
+ extends sap.ui.core.UIComponent
87
+ implements sap.ui.core.IAsyncContentCreation {
88
+ __implements__sap_ui_core_IAsyncContentCreation: boolean;
86
89
  /**
87
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2")`.
90
+ * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2",
91
+ * true)`.
88
92
  */
89
93
  constructor();
90
94
  /**
@@ -142,8 +146,6 @@ declare namespace sap {
142
146
  * It will continue to work as expected as long as one of the following conditions apply:
143
147
  * 1. The control instance is already created and its ID is included in the input parameter oControlProperties
144
148
  * 2. The control type resource is already loaded
145
- * 3. Synchronous XHR requests are supported by the browser
146
- *
147
149
  * See:
148
150
  * sap.ushell.renderers.fiori2.renderer.LaunchpadState
149
151
  * If no launchpad state is provided, the content is added in all states.
@@ -211,8 +213,6 @@ declare namespace sap {
211
213
  * It will continue to work as expected as long as one of the following conditions apply:
212
214
  * 1. The control instance is already created and its ID is included in the input parameter oControlProperties
213
215
  * 2. The control type resource is already loaded
214
- * 3. Synchronous XHR requests are supported by the browser
215
- *
216
216
  * See:
217
217
  * LaunchpadState
218
218
  * If no launchpad state is provided the content is added in all states.
@@ -483,8 +483,6 @@ declare namespace sap {
483
483
  * It will continue to work as expected as long as one of the following conditions apply:
484
484
  * 1. The control instance is already created and its ID is included in the input parameter oControlProperties
485
485
  * 2. The control type resource is already loaded
486
- * 3. Synchronous XHR requests are supported by the browser
487
- *
488
486
  * See:
489
487
  * LaunchpadState
490
488
  * If no launchpad state is provided the content is added in all states.
@@ -644,8 +642,6 @@ declare namespace sap {
644
642
  * It will continue to work as expected as long as one of the following conditions apply:
645
643
  * 1. The control instance is already created and its ID is included in the input parameter oControlProperties
646
644
  * 2. The control type resource is already loaded
647
- * 3. Synchronous XHR requests are supported by the browser
648
- *
649
645
  * See:
650
646
  * LaunchpadState
651
647
  */
@@ -1084,7 +1080,6 @@ declare namespace sap {
1084
1080
  * It will continue to work as expected as long as one of the following conditions apply:
1085
1081
  * 1. The control instance is already created and its ID is included in the input parameter oControlProperties
1086
1082
  * 2. The control type resource is already loaded
1087
- * 3. Synchronous XHR requests are supported by the browser
1088
1083
  */
1089
1084
  setFooterControl(
1090
1085
  /**
@@ -2063,7 +2058,7 @@ declare namespace sap {
2063
2058
  */
2064
2059
  icon?: string;
2065
2060
  /**
2066
- * The information text of the bookmark. This property is not relevant if CDM is used.
2061
+ * The information text of the bookmark.
2067
2062
  */
2068
2063
  info?: string;
2069
2064
  /**
@@ -2079,7 +2074,7 @@ declare namespace sap {
2079
2074
  */
2080
2075
  serviceRefreshInterval?: string;
2081
2076
  /**
2082
- * The unit for the number retrieved from `serviceUrl`. This property is not relevant in the CDM context.
2077
+ * The unit for the number retrieved from `serviceUrl`.
2083
2078
  */
2084
2079
  numberUnit?: string;
2085
2080
  },
@@ -2297,7 +2292,6 @@ declare namespace sap {
2297
2292
  cancelLogon(): void;
2298
2293
  /**
2299
2294
  * @SINCE 1.15.0
2300
- * @EXPERIMENTAL (since 1.55.0)
2301
2295
  *
2302
2296
  * Creates a new renderer instance for the given renderer name.
2303
2297
  *
@@ -2323,7 +2317,8 @@ declare namespace sap {
2323
2317
  */
2324
2318
  sRendererName?: string,
2325
2319
  /**
2326
- * If true, the renderer is created asynchronously and a Promise is returned.
2320
+ * If true, the renderer is created asynchronously and a Promise is returned. For CSP compliance, applications
2321
+ * must always set bAsync:true.
2327
2322
  */
2328
2323
  bAsync?: boolean
2329
2324
  ): sap.ui.core.Control | Promise<any>;
@@ -2379,6 +2374,18 @@ declare namespace sap {
2379
2374
  * All open UShell browser windows for the same origin are asked about their global dirty state.
2380
2375
  */
2381
2376
  getGlobalDirty(): jQuery.Deferred;
2377
+ /**
2378
+ * @SINCE 1.30.0
2379
+ *
2380
+ * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
2381
+ */
2382
+ getRenderer(
2383
+ /**
2384
+ * The renderer name, such as "standard" or "fiori2"; it is taken from the configuration property `defaultRenderer`
2385
+ * if not given here.
2386
+ */
2387
+ sRendererName?: string
2388
+ ): object;
2382
2389
  /**
2383
2390
  * @SINCE 1.15.0
2384
2391
  * @deprecated (since 1.77) - deprecated. Uses {@link#getServiceAsync} instead.
@@ -2424,7 +2431,10 @@ declare namespace sap {
2424
2431
  * }
2425
2432
  * }
2426
2433
  * }
2427
- * oService = sap.ushell.Container.getService("Foo", "runtimeConfig");
2434
+ * sap.ushell.Container.getServiceAsync("Foo", "runtimeConfig")
2435
+ * .then(function (Foo) {
2436
+ * // Do something with the service
2437
+ * });
2428
2438
  * ```
2429
2439
  * Now `oService` is an instance of `my.own.Foo`. The third parameter of the constructor will be "runtimeConfig",
2430
2440
  * the fourth parameter `{config: {header: "hidden"}}`. Its adapter is an instance of `my.own.FooAdapter`
@@ -2599,26 +2609,6 @@ declare namespace sap {
2599
2609
  }
2600
2610
  ): void;
2601
2611
  }
2602
- /**
2603
- * @SINCE 1.15.0
2604
- *
2605
- * This is a virtual type for the callback interface passed by {@link sap.ui.Container.getService()} to
2606
- * any newly created service.
2607
- */
2608
- class ContainerInterface {
2609
- /**
2610
- * See:
2611
- * sap.ushell.services.Container#getService
2612
- */
2613
- constructor();
2614
- /**
2615
- * @SINCE 1.15.0
2616
- *
2617
- * For the given remote system, creates a new adapter that corresponds to the service to which this container
2618
- * interface was passed at construction time.
2619
- */
2620
- createAdapter: undefined;
2621
- }
2622
2612
  /**
2623
2613
  * @SINCE 1.15.0
2624
2614
  */
@@ -5080,14 +5070,37 @@ declare namespace sap {
5080
5070
  * the following parts `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html` must match.
5081
5071
  *
5082
5072
  * The actual test is synchronous and *only* tests whether the hash part can be parsed and contains a semantic
5083
- * object and action. It does not test whether the intent or it's parameters is valid for a given user
5073
+ * object and action. It does not test whether the intent or its parameters are valid for a given user
5074
+ *
5075
+ * This function does not work properly when used inside the app runtime as it compares the given URL to
5076
+ * the app runtime's URL instead of the outer FLP's URL. It can still be used for synchronous use cases
5077
+ * in the ushell that do not run inside the app runtime.
5084
5078
  */
5085
5079
  isIntentUrl(
5086
5080
  /**
5087
5081
  * the URL to test. Note: this url must be in internal format.
5088
5082
  */
5089
- sUrl: String
5090
- ): Boolean;
5083
+ sUrl: string
5084
+ ): boolean;
5085
+ /**
5086
+ * @SINCE 1.96.0
5087
+ *
5088
+ * Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
5089
+ * part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
5090
+ * must correspond to the running launchpad.
5091
+ *
5092
+ * Given actual url `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html?sap-language=DE#SO-action?P1=value1`,
5093
+ * the following parts `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html` must match.
5094
+ *
5095
+ * This function *only* tests whether the hash part can be parsed and contains a semantic object and action.
5096
+ * It does not test whether the intent or its parameters are valid for a given user
5097
+ */
5098
+ isIntentUrlAsync(
5099
+ /**
5100
+ * the URL to test. Note: this url must be in internal format.
5101
+ */
5102
+ sUrl: string
5103
+ ): Promise<boolean>;
5091
5104
  /**
5092
5105
  * @SINCE 1.20.0
5093
5106
  *
@@ -5242,18 +5255,27 @@ declare namespace sap {
5242
5255
  }
5243
5256
  /**
5244
5257
  * @SINCE 1.16.3
5245
- *
5246
- * The Unified Shell's user information service, which allows you to retrieve information about the logged-in
5247
- * user.
5248
5258
  */
5249
5259
  class UserInfo {
5250
5260
  /**
5251
5261
  * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("UserInfo").then(function
5252
5262
  * (UserInfo) {});`. Constructs a new instance of the user information service.
5263
+ *
5264
+ * The Unified Shell's user information service, which allows you to retrieve information about the logged-in
5265
+ * user.
5253
5266
  * See:
5254
5267
  * sap.ushell.services.Container#getServiceAsync
5255
5268
  */
5256
- constructor();
5269
+ constructor(
5270
+ /**
5271
+ * Adapter
5272
+ */
5273
+ oAdapter: object,
5274
+ /**
5275
+ * interface
5276
+ */
5277
+ oContainerInterface: object
5278
+ );
5257
5279
 
5258
5280
  /**
5259
5281
  * @SINCE 1.86.0
@@ -9252,7 +9274,7 @@ declare namespace sap {
9252
9274
  *
9253
9275
  * // Component.js (the app root component)
9254
9276
  * ...
9255
- * this.getService("ShellUIService").then( // promise is returned
9277
+ * this.getServiceAsync("ShellUIService").then( // promise is returned
9256
9278
  * function (oService) {
9257
9279
  * oService.setTitle("Application Title");
9258
9280
  * },
@@ -9279,8 +9301,8 @@ declare namespace sap {
9279
9301
  * "lazy": false,
9280
9302
  * "factoryName": "sap.ushell.ui5service.ShellUIService",
9281
9303
  * "settings": {
9282
- * "setHierarchy": "auto", // configuration under discussion currently
9283
- * "setTitle": "auto" // configuration under discussion currently
9304
+ * "setHierarchy": "auto",
9305
+ * "setTitle": "auto"
9284
9306
  * }
9285
9307
  * }
9286
9308
  * }
@@ -9503,8 +9525,6 @@ declare namespace sap {
9503
9525
  }
9504
9526
 
9505
9527
  interface IUI5DefineDependencyNames {
9506
- "sap/ushell/bootstrap/homepage/mockContainer": undefined;
9507
-
9508
9528
  "sap/ushell/components/factsheet/controls/PictureTile": undefined;
9509
9529
 
9510
9530
  "sap/ushell/components/factsheet/controls/PictureViewer": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -458,7 +458,7 @@ declare namespace sap {
458
458
  * sticky session header requested. This is to avoid that the feature is disabled if the load balancer returns
459
459
  * another value for the sticky session header for some reason (e.g. the application server goes offline).
460
460
  * NOTE: In line with {@link sap.ui2.srvc.PageBuildingService}, session stickiness is only supported
461
- * in scopes different from PERS. Currently, session stickiness is affected by the following limitations:
461
+ * in scopes different from PERS. Currently, session stickiness is affected by the following restrictions:
462
462
  *
463
463
  * - If the client caches the response headers for certain requests, these cached headers will be used
464
464
  * instead of the headers sent from the server (as in if cache was disabled).
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -246,7 +246,11 @@ declare namespace sap {
246
246
  /**
247
247
  * Update function for the variable collection of the `OlapModel`
248
248
  */
249
- fVar: Function,
249
+ fVariableUpdater: Function,
250
+ /**
251
+ * update function for update state
252
+ */
253
+ fUndoUpdater: Function,
250
254
  /**
251
255
  * the firefly application associated to the `OlapModel`
252
256
  */
@@ -270,21 +274,6 @@ declare namespace sap {
270
274
  */
271
275
  bActive: boolean
272
276
  ): Promise<this>;
273
- /**
274
- * set the list of filters to the dimension
275
- */
276
- applyFilterToDim(
277
- /**
278
- * the external name of the structure on which the new restriction is created
279
- */
280
- sDim: string,
281
- /**
282
- * list of a range with components
283
- * `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
284
- * EQ,LE,..,BT
285
- */
286
- aList: Object[]
287
- ): Promise<this>;
288
277
  /**
289
278
  * Do a drill operation on a dimension member on an Axis
290
279
  */
@@ -328,6 +317,19 @@ declare namespace sap {
328
317
  */
329
318
  sDim2: string
330
319
  ): this;
320
+ /**
321
+ * Gets the scaling factor of a measure or data cell
322
+ */
323
+ getDecimalPlaces(
324
+ /**
325
+ * the Member of the Measure Structure
326
+ */
327
+ sMeasureMember: string,
328
+ /**
329
+ * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
330
+ */
331
+ sNonMeasureMember: string
332
+ ): int;
331
333
  /**
332
334
  * get the list of filters of a dimension
333
335
  */
@@ -355,17 +357,17 @@ declare namespace sap {
355
357
  nColumn: int
356
358
  ): Promise<this>;
357
359
  /**
358
- * get the scaling factor of a measure
360
+ * Gets the scaling factor of a measure
359
361
  */
360
362
  getScalingFactor(
361
363
  /**
362
364
  * the Member of the Measure Structure
363
365
  */
364
- sMember: string,
366
+ sMeasureMember: string,
365
367
  /**
366
- * the Member of the Measure Structure
368
+ * the Member of the Non Measure Structure
367
369
  */
368
- sMember2?: string
370
+ sNonMeasureMember: string
369
371
  ): int;
370
372
  /**
371
373
  * hasVariable Checks whether a Variable is influencing the DataProvider
@@ -483,15 +485,7 @@ declare namespace sap {
483
485
  /**
484
486
  * the external name of the Dimension
485
487
  */
486
- sDim: string,
487
- /**
488
- * indicates that instead of fetching the new resultset, the selection should be resolved
489
- */
490
- bReturnSel: boolean,
491
- /**
492
- * List of data provider that are to be filte (all if not supplied)
493
- */
494
- aDataProviderNames: string[]
488
+ sDimensionName: string
495
489
  ): Promise<any>;
496
490
  /**
497
491
  * Remove the filter of a dimension
@@ -502,6 +496,10 @@ declare namespace sap {
502
496
  */
503
497
  sDim: string
504
498
  ): this;
499
+ /**
500
+ * Resets this data provider to the state after the metadata import
501
+ */
502
+ resetToDefault(): void;
505
503
  /**
506
504
  * Distribute the dimension among the rows and columns
507
505
  */
@@ -526,6 +524,23 @@ declare namespace sap {
526
524
  */
527
525
  bActive: boolean
528
526
  ): Promise<this>;
527
+ /**
528
+ * Sets the number of decimal of a measure/query cell
529
+ */
530
+ setDecimalPlaces(
531
+ /**
532
+ * number of the decimal palaces to be shown after the separator
533
+ */
534
+ nNumberOfDecimalPlaces: int,
535
+ /**
536
+ * the Member of the Measure Structure
537
+ */
538
+ sMeasureMember: string,
539
+ /**
540
+ * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
541
+ */
542
+ the: string
543
+ ): this;
529
544
  /**
530
545
  * Set Display Hierachy
531
546
  */
@@ -597,7 +612,7 @@ declare namespace sap {
597
612
  fValue: float
598
613
  ): void;
599
614
  /**
600
- * set the scaling factor of a measure/query cell
615
+ * Sets the scaling factor of a measure/query cell
601
616
  */
602
617
  setScalingFactor(
603
618
  /**
@@ -607,11 +622,11 @@ declare namespace sap {
607
622
  /**
608
623
  * the Member of the Measure Structure
609
624
  */
610
- sMember: string,
625
+ sMeasureMember: string,
611
626
  /**
612
- * the Member of the Measure Structure
627
+ * the Member of the Non Measure Structure
613
628
  */
614
- sMember2?: string
629
+ sNonMeasureMember: string
615
630
  ): this;
616
631
  /**
617
632
  * Sort the members of a dimension
@@ -985,6 +1000,10 @@ declare namespace sap {
985
1000
  * Reset the data buffer
986
1001
  */
987
1002
  resetBuffer(): Promise<this>;
1003
+ /**
1004
+ * Reset the Olap Model to the default query
1005
+ */
1006
+ resetModel(): void;
988
1007
  /**
989
1008
  * Save the data buffer
990
1009
  */