@sapui5/ts-types 1.95.0 → 1.96.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 +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 +59 -40
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +73 -2
  11. package/types/sap.fe.macros.d.ts +27 -3
  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 +1 -1
  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 +340 -40
  21. package/types/sap.landvisz.d.ts +1 -1
  22. package/types/sap.m.d.ts +542 -107
  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 +2 -7
  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 +1 -1
  30. package/types/sap.suite.ui.generic.template.d.ts +6 -2
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +1 -1
  33. package/types/sap.ui.codeeditor.d.ts +1 -1
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +142 -11
  36. package/types/sap.ui.core.d.ts +656 -460
  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 +1 -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 +220 -1
  43. package/types/sap.ui.layout.d.ts +19 -1
  44. package/types/sap.ui.mdc.d.ts +39 -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 +1 -1
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +1 -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 +704 -115
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +45 -35
  58. package/types/sap.ushell_abap.d.ts +1 -1
  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.95.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.95.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace uiext {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.95.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -2058,7 +2058,7 @@ declare namespace sap {
2058
2058
  */
2059
2059
  icon?: string;
2060
2060
  /**
2061
- * The information text of the bookmark. This property is not relevant if CDM is used.
2061
+ * The information text of the bookmark.
2062
2062
  */
2063
2063
  info?: string;
2064
2064
  /**
@@ -2074,7 +2074,7 @@ declare namespace sap {
2074
2074
  */
2075
2075
  serviceRefreshInterval?: string;
2076
2076
  /**
2077
- * 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`.
2078
2078
  */
2079
2079
  numberUnit?: string;
2080
2080
  },
@@ -2609,26 +2609,6 @@ declare namespace sap {
2609
2609
  }
2610
2610
  ): void;
2611
2611
  }
2612
- /**
2613
- * @SINCE 1.15.0
2614
- *
2615
- * This is a virtual type for the callback interface passed by {@link sap.ui.Container.getService()} to
2616
- * any newly created service.
2617
- */
2618
- class ContainerInterface {
2619
- /**
2620
- * See:
2621
- * sap.ushell.services.Container#getService
2622
- */
2623
- constructor();
2624
- /**
2625
- * @SINCE 1.15.0
2626
- *
2627
- * For the given remote system, creates a new adapter that corresponds to the service to which this container
2628
- * interface was passed at construction time.
2629
- */
2630
- createAdapter: undefined;
2631
- }
2632
2612
  /**
2633
2613
  * @SINCE 1.15.0
2634
2614
  */
@@ -5090,14 +5070,37 @@ declare namespace sap {
5090
5070
  * the following parts `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html` must match.
5091
5071
  *
5092
5072
  * The actual test is synchronous and *only* tests whether the hash part can be parsed and contains a semantic
5093
- * 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.
5094
5078
  */
5095
5079
  isIntentUrl(
5096
5080
  /**
5097
5081
  * the URL to test. Note: this url must be in internal format.
5098
5082
  */
5099
- sUrl: String
5100
- ): 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>;
5101
5104
  /**
5102
5105
  * @SINCE 1.20.0
5103
5106
  *
@@ -5252,18 +5255,27 @@ declare namespace sap {
5252
5255
  }
5253
5256
  /**
5254
5257
  * @SINCE 1.16.3
5255
- *
5256
- * The Unified Shell's user information service, which allows you to retrieve information about the logged-in
5257
- * user.
5258
5258
  */
5259
5259
  class UserInfo {
5260
5260
  /**
5261
5261
  * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("UserInfo").then(function
5262
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.
5263
5266
  * See:
5264
5267
  * sap.ushell.services.Container#getServiceAsync
5265
5268
  */
5266
- constructor();
5269
+ constructor(
5270
+ /**
5271
+ * Adapter
5272
+ */
5273
+ oAdapter: object,
5274
+ /**
5275
+ * interface
5276
+ */
5277
+ oContainerInterface: object
5278
+ );
5267
5279
 
5268
5280
  /**
5269
5281
  * @SINCE 1.86.0
@@ -9262,7 +9274,7 @@ declare namespace sap {
9262
9274
  *
9263
9275
  * // Component.js (the app root component)
9264
9276
  * ...
9265
- * this.getService("ShellUIService").then( // promise is returned
9277
+ * this.getServiceAsync("ShellUIService").then( // promise is returned
9266
9278
  * function (oService) {
9267
9279
  * oService.setTitle("Application Title");
9268
9280
  * },
@@ -9289,8 +9301,8 @@ declare namespace sap {
9289
9301
  * "lazy": false,
9290
9302
  * "factoryName": "sap.ushell.ui5service.ShellUIService",
9291
9303
  * "settings": {
9292
- * "setHierarchy": "auto", // configuration under discussion currently
9293
- * "setTitle": "auto" // configuration under discussion currently
9304
+ * "setHierarchy": "auto",
9305
+ * "setTitle": "auto"
9294
9306
  * }
9295
9307
  * }
9296
9308
  * }
@@ -9513,8 +9525,6 @@ declare namespace sap {
9513
9525
  }
9514
9526
 
9515
9527
  interface IUI5DefineDependencyNames {
9516
- "sap/ushell/bootstrap/homepage/mockContainer": undefined;
9517
-
9518
9528
  "sap/ushell/components/factsheet/controls/PictureTile": undefined;
9519
9529
 
9520
9530
  "sap/ushell/components/factsheet/controls/PictureViewer": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.95.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.95.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.95.0
1
+ // For Library Version: 1.96.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.95.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.95.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.95.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.95.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
  */