@sapui5/types 1.115.0 → 1.115.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 (44) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -0
  3. package/types/sap.chart.d.ts +98 -47
  4. package/types/sap.f.d.ts +860 -754
  5. package/types/sap.fe.core.d.ts +74 -86
  6. package/types/sap.fe.macros.d.ts +84 -34
  7. package/types/sap.fe.navigation.d.ts +9 -13
  8. package/types/sap.fe.placeholder.d.ts +3 -0
  9. package/types/sap.fe.templates.d.ts +11 -9
  10. package/types/sap.fe.test.d.ts +40 -69
  11. package/types/sap.fe.tools.d.ts +3 -0
  12. package/types/sap.m.d.ts +8300 -6415
  13. package/types/sap.makit.d.ts +91 -56
  14. package/types/sap.me.d.ts +119 -73
  15. package/types/sap.ndc.d.ts +43 -32
  16. package/types/sap.suite.ui.generic.template.d.ts +81 -82
  17. package/types/sap.suite.ui.microchart.d.ts +382 -291
  18. package/types/sap.tnt.d.ts +81 -74
  19. package/types/sap.ui.codeeditor.d.ts +40 -25
  20. package/types/sap.ui.commons.d.ts +991 -672
  21. package/types/sap.ui.comp.d.ts +2641 -2090
  22. package/types/sap.ui.core.d.ts +2853 -2263
  23. package/types/sap.ui.dt.d.ts +1 -1
  24. package/types/sap.ui.export.d.ts +50 -33
  25. package/types/sap.ui.fl.d.ts +85 -47
  26. package/types/sap.ui.integration.d.ts +355 -280
  27. package/types/sap.ui.layout.d.ts +399 -416
  28. package/types/sap.ui.mdc.d.ts +1016 -792
  29. package/types/sap.ui.richtexteditor.d.ts +64 -33
  30. package/types/sap.ui.rta.d.ts +7 -7
  31. package/types/sap.ui.suite.d.ts +25 -11
  32. package/types/sap.ui.support.d.ts +12 -13
  33. package/types/sap.ui.table.d.ts +498 -354
  34. package/types/sap.ui.testrecorder.d.ts +1 -1
  35. package/types/sap.ui.unified.d.ts +1228 -894
  36. package/types/sap.ui.ux3.d.ts +1023 -613
  37. package/types/sap.ui.webc.common.d.ts +7 -9
  38. package/types/sap.ui.webc.fiori.d.ts +578 -408
  39. package/types/sap.ui.webc.main.d.ts +1521 -878
  40. package/types/sap.uiext.inbox.d.ts +151 -63
  41. package/types/sap.ushell.d.ts +415 -334
  42. package/types/sap.ushell_abap.d.ts +1 -1
  43. package/types/sap.uxap.d.ts +304 -267
  44. package/types/sap.viz.d.ts +1809 -852
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/types",
3
- "version": "1.115.0",
3
+ "version": "1.115.1",
4
4
  "description": "SAPUI5 TypeScript Definitions",
5
5
  "homepage": "https://sap.github.io/ui5-typescript/",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/index.d.ts CHANGED
@@ -37,8 +37,10 @@
37
37
  /// <reference path="./sap.fe.core.d.ts"/>
38
38
  /// <reference path="./sap.fe.macros.d.ts"/>
39
39
  /// <reference path="./sap.fe.navigation.d.ts"/>
40
+ /// <reference path="./sap.fe.placeholder.d.ts"/>
40
41
  /// <reference path="./sap.fe.templates.d.ts"/>
41
42
  /// <reference path="./sap.fe.test.d.ts"/>
43
+ /// <reference path="./sap.fe.tools.d.ts"/>
42
44
  /// <reference path="./sap.feedback.ui.d.ts"/>
43
45
  /// <reference path="./sap.landvisz.d.ts"/>
44
46
  /// <reference path="./sap.rules.ui.d.ts"/>
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.115.1
2
2
 
3
3
  declare module "sap/chart/library" {
4
4
  import Dimension from "sap/chart/data/Dimension";
@@ -246,11 +246,11 @@ declare module "sap/chart/Chart" {
246
246
  import UI5Element from "sap/ui/core/Element";
247
247
 
248
248
  /**
249
- * @SINCE 1.32.0
249
+ * @since 1.32.0
250
250
  *
251
251
  * UI5 Chart control
252
252
  */
253
- class Chart extends BaseControl {
253
+ export default class Chart extends BaseControl {
254
254
  /**
255
255
  * Constructor for a new Chart.
256
256
  *
@@ -486,7 +486,7 @@ declare module "sap/chart/Chart" {
486
486
  /**
487
487
  * The function to be called when the event occurs
488
488
  */
489
- fnFunction: (p1: Event<$ChartDrilledDownEventParameters>) => void,
489
+ fnFunction: (p1: Chart$DrilledDownEvent) => void,
490
490
  /**
491
491
  * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
492
492
  */
@@ -506,7 +506,7 @@ declare module "sap/chart/Chart" {
506
506
  /**
507
507
  * The function to be called when the event occurs
508
508
  */
509
- fnFunction: (p1: Event<$ChartDrilledDownEventParameters>) => void,
509
+ fnFunction: (p1: Chart$DrilledDownEvent) => void,
510
510
  /**
511
511
  * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
512
512
  */
@@ -531,7 +531,7 @@ declare module "sap/chart/Chart" {
531
531
  /**
532
532
  * The function to be called when the event occurs
533
533
  */
534
- fnFunction: (p1: Event<$ChartDrilledUpEventParameters>) => void,
534
+ fnFunction: (p1: Chart$DrilledUpEvent) => void,
535
535
  /**
536
536
  * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
537
537
  */
@@ -551,7 +551,7 @@ declare module "sap/chart/Chart" {
551
551
  /**
552
552
  * The function to be called when the event occurs
553
553
  */
554
- fnFunction: (p1: Event<$ChartDrilledUpEventParameters>) => void,
554
+ fnFunction: (p1: Chart$DrilledUpEvent) => void,
555
555
  /**
556
556
  * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
557
557
  */
@@ -810,7 +810,7 @@ declare module "sap/chart/Chart" {
810
810
  /**
811
811
  * The function to be called, when the event occurs
812
812
  */
813
- fnFunction: (p1: Event<$ChartDrilledDownEventParameters>) => void,
813
+ fnFunction: (p1: Chart$DrilledDownEvent) => void,
814
814
  /**
815
815
  * Context object on which the given function had to be called
816
816
  */
@@ -827,7 +827,7 @@ declare module "sap/chart/Chart" {
827
827
  /**
828
828
  * The function to be called, when the event occurs
829
829
  */
830
- fnFunction: (p1: Event<$ChartDrilledUpEventParameters>) => void,
830
+ fnFunction: (p1: Chart$DrilledUpEvent) => void,
831
831
  /**
832
832
  * Context object on which the given function had to be called
833
833
  */
@@ -953,7 +953,7 @@ declare module "sap/chart/Chart" {
953
953
  option?: Object
954
954
  ): string;
955
955
  /**
956
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
956
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
957
957
  *
958
958
  * Fires event {@link #event:deselectData deselectData} to attached listeners.
959
959
  *
@@ -966,7 +966,7 @@ declare module "sap/chart/Chart" {
966
966
  mParameters?: object
967
967
  ): this;
968
968
  /**
969
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
969
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
970
970
  *
971
971
  * Fires event {@link #event:drilledDown drilledDown} to attached listeners.
972
972
  *
@@ -976,10 +976,10 @@ declare module "sap/chart/Chart" {
976
976
  /**
977
977
  * Parameters to pass along with the event
978
978
  */
979
- mParameters?: $ChartDrilledDownEventParameters
979
+ mParameters?: Chart$DrilledDownEventParameters
980
980
  ): this;
981
981
  /**
982
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
982
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
983
983
  *
984
984
  * Fires event {@link #event:drilledUp drilledUp} to attached listeners.
985
985
  *
@@ -989,10 +989,10 @@ declare module "sap/chart/Chart" {
989
989
  /**
990
990
  * Parameters to pass along with the event
991
991
  */
992
- mParameters?: $ChartDrilledUpEventParameters
992
+ mParameters?: Chart$DrilledUpEventParameters
993
993
  ): this;
994
994
  /**
995
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
995
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
996
996
  *
997
997
  * Fires event {@link #event:drillStackChanged drillStackChanged} to attached listeners.
998
998
  *
@@ -1005,7 +1005,7 @@ declare module "sap/chart/Chart" {
1005
1005
  mParameters?: object
1006
1006
  ): this;
1007
1007
  /**
1008
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1008
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1009
1009
  *
1010
1010
  * Fires event {@link #event:renderComplete renderComplete} to attached listeners.
1011
1011
  *
@@ -1018,7 +1018,7 @@ declare module "sap/chart/Chart" {
1018
1018
  mParameters?: object
1019
1019
  ): this;
1020
1020
  /**
1021
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1021
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1022
1022
  *
1023
1023
  * Fires event {@link #event:selectData selectData} to attached listeners.
1024
1024
  *
@@ -1031,7 +1031,7 @@ declare module "sap/chart/Chart" {
1031
1031
  mParameters?: object
1032
1032
  ): this;
1033
1033
  /**
1034
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1034
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1035
1035
  *
1036
1036
  * Fires event {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff} to attached listeners.
1037
1037
  *
@@ -1526,7 +1526,7 @@ declare module "sap/chart/Chart" {
1526
1526
  */
1527
1527
  getVizUid(): string;
1528
1528
  /**
1529
- * @SINCE 1.54
1529
+ * @since 1.54
1530
1530
  *
1531
1531
  * Get zoom information.
1532
1532
  *
@@ -2296,7 +2296,6 @@ declare module "sap/chart/Chart" {
2296
2296
  oConfig: object
2297
2297
  ): void;
2298
2298
  }
2299
- export default Chart;
2300
2299
 
2301
2300
  export interface $ChartSettings extends $BaseControlSettings {
2302
2301
  /**
@@ -2562,12 +2561,12 @@ declare module "sap/chart/Chart" {
2562
2561
  /**
2563
2562
  * fired after a drill-down operation
2564
2563
  */
2565
- drilledDown?: (oEvent: Event<$ChartDrilledDownEventParameters>) => void;
2564
+ drilledDown?: (oEvent: Event<Chart$DrilledDownEventParameters>) => void;
2566
2565
 
2567
2566
  /**
2568
2567
  * fired after a drill-up operation
2569
2568
  */
2570
- drilledUp?: (oEvent: Event<$ChartDrilledUpEventParameters>) => void;
2569
+ drilledUp?: (oEvent: Event<Chart$DrilledUpEventParameters>) => void;
2571
2570
 
2572
2571
  /**
2573
2572
  * Event fires when the rendering ends.
@@ -2598,29 +2597,85 @@ declare module "sap/chart/Chart" {
2598
2597
  drillStackChanged?: (oEvent: Event) => void;
2599
2598
  }
2600
2599
 
2601
- export interface $ChartDeselectDataEventParameters {}
2600
+ export interface Chart$DeselectDataEventParameters {}
2602
2601
 
2603
- export interface $ChartDrilledDownEventParameters {
2602
+ /**
2603
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$DeselectDataEventParameters'
2604
+ * in 1.115.1 and any later releases.
2605
+ */
2606
+ export type $ChartDeselectDataEventParameters = Chart$DeselectDataEventParameters;
2607
+
2608
+ export type Chart$DeselectDataEvent = Event<Chart$DeselectDataEventParameters>;
2609
+
2610
+ export interface Chart$DrilledDownEventParameters {
2604
2611
  /**
2605
2612
  * array of strings holding the names of the added dimensions
2606
2613
  */
2607
2614
  dimensions?: string[];
2608
2615
  }
2609
2616
 
2610
- export interface $ChartDrilledUpEventParameters {
2617
+ /**
2618
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$DrilledDownEventParameters'
2619
+ * in 1.115.1 and any later releases.
2620
+ */
2621
+ export type $ChartDrilledDownEventParameters = Chart$DrilledDownEventParameters;
2622
+
2623
+ export type Chart$DrilledDownEvent = Event<Chart$DrilledDownEventParameters>;
2624
+
2625
+ export interface Chart$DrilledUpEventParameters {
2611
2626
  /**
2612
2627
  * array of strings holding the names of the removed dimensions
2613
2628
  */
2614
2629
  dimensions?: string[];
2615
2630
  }
2616
2631
 
2617
- export interface $ChartDrillStackChangedEventParameters {}
2632
+ /**
2633
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$DrilledUpEventParameters'
2634
+ * in 1.115.1 and any later releases.
2635
+ */
2636
+ export type $ChartDrilledUpEventParameters = Chart$DrilledUpEventParameters;
2637
+
2638
+ export type Chart$DrilledUpEvent = Event<Chart$DrilledUpEventParameters>;
2639
+
2640
+ export interface Chart$DrillStackChangedEventParameters {}
2641
+
2642
+ /**
2643
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$DrillStackChangedEventParameters'
2644
+ * in 1.115.1 and any later releases.
2645
+ */
2646
+ export type $ChartDrillStackChangedEventParameters = Chart$DrillStackChangedEventParameters;
2647
+
2648
+ export type Chart$DrillStackChangedEvent = Event<Chart$DrillStackChangedEventParameters>;
2649
+
2650
+ export interface Chart$RenderCompleteEventParameters {}
2651
+
2652
+ /**
2653
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$RenderCompleteEventParameters'
2654
+ * in 1.115.1 and any later releases.
2655
+ */
2656
+ export type $ChartRenderCompleteEventParameters = Chart$RenderCompleteEventParameters;
2657
+
2658
+ export type Chart$RenderCompleteEvent = Event<Chart$RenderCompleteEventParameters>;
2618
2659
 
2619
- export interface $ChartRenderCompleteEventParameters {}
2660
+ export interface Chart$SelectDataEventParameters {}
2620
2661
 
2621
- export interface $ChartSelectDataEventParameters {}
2662
+ /**
2663
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$SelectDataEventParameters'
2664
+ * in 1.115.1 and any later releases.
2665
+ */
2666
+ export type $ChartSelectDataEventParameters = Chart$SelectDataEventParameters;
2667
+
2668
+ export type Chart$SelectDataEvent = Event<Chart$SelectDataEventParameters>;
2669
+
2670
+ export interface Chart$ValueAxisFixedScaleTurnedOffEventParameters {}
2671
+
2672
+ /**
2673
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$ValueAxisFixedScaleTurnedOffEventParameters'
2674
+ * in 1.115.1 and any later releases.
2675
+ */
2676
+ export type $ChartValueAxisFixedScaleTurnedOffEventParameters = Chart$ValueAxisFixedScaleTurnedOffEventParameters;
2622
2677
 
2623
- export interface $ChartValueAxisFixedScaleTurnedOffEventParameters {}
2678
+ export type Chart$ValueAxisFixedScaleTurnedOffEvent = Event<Chart$ValueAxisFixedScaleTurnedOffEventParameters>;
2624
2679
  }
2625
2680
 
2626
2681
  declare module "sap/chart/ChartType" {
@@ -3558,7 +3613,7 @@ declare module "sap/chart/data/Dimension" {
3558
3613
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3559
3614
 
3560
3615
  /**
3561
- * @SINCE 1.32.0
3616
+ * @since 1.32.0
3562
3617
  *
3563
3618
  * Definition of a single dimension in a chart
3564
3619
  *
@@ -3568,7 +3623,7 @@ declare module "sap/chart/data/Dimension" {
3568
3623
  * with role “series” and “category2” are assigned to the feed uid “categoryAxis2”. treemap
3569
3624
  * All dimensions are assigned to the feed uid “categoryAxis” in the default sequence.
3570
3625
  */
3571
- class Dimension extends UI5Element {
3626
+ export default class Dimension extends UI5Element {
3572
3627
  /**
3573
3628
  * Constructor for a new ui5/data/Dimension.
3574
3629
  *
@@ -3828,7 +3883,6 @@ declare module "sap/chart/data/Dimension" {
3828
3883
  sTextProperty: string
3829
3884
  ): this;
3830
3885
  }
3831
- export default Dimension;
3832
3886
 
3833
3887
  export interface $DimensionSettings extends $ElementSettings {
3834
3888
  /**
@@ -3926,11 +3980,11 @@ declare module "sap/chart/data/HierarchyDimension" {
3926
3980
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3927
3981
 
3928
3982
  /**
3929
- * @SINCE 1.54.0
3983
+ * @since 1.54.0
3930
3984
  *
3931
3985
  * Definition of a single hierarchy dimension in a chart
3932
3986
  */
3933
- class HierarchyDimension extends Dimension {
3987
+ export default class HierarchyDimension extends Dimension {
3934
3988
  /**
3935
3989
  * Constructor for a new ui5/data/HierarchyDimension.
3936
3990
  *
@@ -4023,7 +4077,6 @@ declare module "sap/chart/data/HierarchyDimension" {
4023
4077
  iLevel?: int
4024
4078
  ): this;
4025
4079
  }
4026
- export default HierarchyDimension;
4027
4080
 
4028
4081
  export interface $HierarchyDimensionSettings extends $DimensionSettings {
4029
4082
  /**
@@ -4045,7 +4098,7 @@ declare module "sap/chart/data/Measure" {
4045
4098
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
4046
4099
 
4047
4100
  /**
4048
- * @SINCE 1.32.0
4101
+ * @since 1.32.0
4049
4102
  *
4050
4103
  * Definition of a single measure in a chart
4051
4104
  *
@@ -4064,7 +4117,7 @@ declare module "sap/chart/data/Measure" {
4064
4117
  * ..dual.. At least one measure is assigned to each of the feed uids “valueAxis” and “valueAxis2”,
4065
4118
  * according to the general rule.
4066
4119
  */
4067
- class Measure extends UI5Element {
4120
+ export default class Measure extends UI5Element {
4068
4121
  /**
4069
4122
  * Constructor for a new ui5/data/Measure.
4070
4123
  *
@@ -4126,8 +4179,8 @@ declare module "sap/chart/data/Measure" {
4126
4179
  */
4127
4180
  static getMetadata(): ElementMetadata;
4128
4181
  /**
4129
- * @SINCE 1.63
4130
- * @EXPERIMENTAL
4182
+ * @since 1.63
4183
+ * @experimental
4131
4184
  *
4132
4185
  * Gets current value of property {@link #getAnalyticalInfo analyticalInfo}.
4133
4186
  *
@@ -4231,8 +4284,8 @@ declare module "sap/chart/data/Measure" {
4231
4284
  */
4232
4285
  getValueFormat(): string;
4233
4286
  /**
4234
- * @SINCE 1.63
4235
- * @EXPERIMENTAL
4287
+ * @since 1.63
4288
+ * @experimental
4236
4289
  *
4237
4290
  * Sets a new value for property {@link #getAnalyticalInfo analyticalInfo}.
4238
4291
  *
@@ -4392,7 +4445,6 @@ declare module "sap/chart/data/Measure" {
4392
4445
  sValueFormat?: string
4393
4446
  ): this;
4394
4447
  }
4395
- export default Measure;
4396
4448
 
4397
4449
  export interface $MeasureSettings extends $ElementSettings {
4398
4450
  /**
@@ -4465,8 +4517,8 @@ declare module "sap/chart/data/Measure" {
4465
4517
  semanticallyRelatedMeasures?: object | PropertyBindingInfo | `{${string}}`;
4466
4518
 
4467
4519
  /**
4468
- * @SINCE 1.63
4469
- * @EXPERIMENTAL
4520
+ * @since 1.63
4521
+ * @experimental
4470
4522
  *
4471
4523
  * The analytical extra information
4472
4524
  */
@@ -4549,7 +4601,7 @@ declare module "sap/chart/data/TimeDimension" {
4549
4601
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
4550
4602
 
4551
4603
  /**
4552
- * @SINCE 1.38.0
4604
+ * @since 1.38.0
4553
4605
  *
4554
4606
  * Definition of a single time dimension in a chart
4555
4607
  *
@@ -4558,7 +4610,7 @@ declare module "sap/chart/data/TimeDimension" {
4558
4610
  *
4559
4611
  * TimeDmension is assigned to feed uid "timeAxis".
4560
4612
  */
4561
- class TimeDimension extends Dimension {
4613
+ export default class TimeDimension extends Dimension {
4562
4614
  /**
4563
4615
  * Constructor for a new ui5/data/TimeDimension.
4564
4616
  *
@@ -4711,7 +4763,6 @@ declare module "sap/chart/data/TimeDimension" {
4711
4763
  sTimeUnit: TimeUnitType | keyof typeof TimeUnitType
4712
4764
  ): this;
4713
4765
  }
4714
- export default TimeDimension;
4715
4766
 
4716
4767
  export interface $TimeDimensionSettings extends $DimensionSettings {
4717
4768
  /**