@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
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.115.1
2
2
 
3
3
  declare namespace sap {}
@@ -1,14 +1,14 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.115.1
2
2
 
3
3
  declare module "sap/ui/export/library" {
4
4
  /**
5
- * @SINCE 1.50.0
5
+ * @since 1.50.0
6
6
  *
7
7
  * EDM data types for document export.
8
8
  */
9
9
  export enum EdmType {
10
10
  /**
11
- * @SINCE 1.60
11
+ * @since 1.60
12
12
  *
13
13
  * Property of type BigNumber.
14
14
  */
@@ -30,7 +30,7 @@ declare module "sap/ui/export/library" {
30
30
  */
31
31
  DateTime = "DateTime",
32
32
  /**
33
- * @SINCE 1.58
33
+ * @since 1.58
34
34
  *
35
35
  * Property of type Enumeration.
36
36
  */
@@ -40,7 +40,7 @@ declare module "sap/ui/export/library" {
40
40
  */
41
41
  Number = "Number",
42
42
  /**
43
- * @SINCE 1.87
43
+ * @since 1.87
44
44
  *
45
45
  * Property of type Percentage.
46
46
  */
@@ -55,7 +55,7 @@ declare module "sap/ui/export/library" {
55
55
  Time = "Time",
56
56
  }
57
57
  /**
58
- * @SINCE 1.78
58
+ * @since 1.78
59
59
  *
60
60
  * File types for document export.
61
61
  */
@@ -78,13 +78,15 @@ declare module "sap/ui/export/ExportBase" {
78
78
 
79
79
  import TreeBinding from "sap/ui/model/TreeBinding";
80
80
 
81
+ import Event from "sap/ui/base/Event";
82
+
81
83
  /**
82
- * @SINCE 1.96
84
+ * @since 1.96
83
85
  *
84
86
  * The `sap.ui.export.ExportBase` class allows you to export table data from a UI5 application to certain
85
87
  * formats. This class is an abstract class that requires specific implementations for each file format.
86
88
  */
87
- class ExportBase extends EventProvider {
89
+ export default class ExportBase extends EventProvider {
88
90
  /**
89
91
  * Base class for specific SAPUI5 export implementations. This class contains abstract functions that need
90
92
  * to be implemented.
@@ -148,7 +150,7 @@ declare module "sap/ui/export/ExportBase" {
148
150
  */
149
151
  static getMetadata(): Metadata;
150
152
  /**
151
- * @SINCE 1.96
153
+ * @since 1.96
152
154
  *
153
155
  * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportBase#event:beforeExport} event
154
156
  * of this `sap.ui.export.ExportBase`.
@@ -174,7 +176,7 @@ declare module "sap/ui/export/ExportBase" {
174
176
  oListener?: object
175
177
  ): this;
176
178
  /**
177
- * @SINCE 1.96
179
+ * @since 1.96
178
180
  *
179
181
  * Attaches event handler `fnFunction` to the {@link sap.ui.export.ExportBase#event:beforeExport} event
180
182
  * of this `sap.ui.export.ExportBase`.
@@ -213,7 +215,7 @@ declare module "sap/ui/export/ExportBase" {
213
215
  */
214
216
  destroy(): void;
215
217
  /**
216
- * @SINCE 1.96
218
+ * @since 1.96
217
219
  *
218
220
  * Detaches event handler `fnFunction` from the {@link sap.ui.export.ExportBase#event:beforeExport} event
219
221
  * of this `sap.ui.export.ExportBase`.
@@ -232,7 +234,7 @@ declare module "sap/ui/export/ExportBase" {
232
234
  oListener?: object
233
235
  ): this;
234
236
  /**
235
- * @SINCE 1.112
237
+ * @since 1.112
236
238
  *
237
239
  * Returns the specific MIME type
238
240
  */
@@ -250,9 +252,16 @@ declare module "sap/ui/export/ExportBase" {
250
252
  oDataSource: object | ListBinding | TreeBinding
251
253
  ): object | null;
252
254
  }
253
- export default ExportBase;
254
255
 
255
- export interface $ExportBaseBeforeExportEventParameters {}
256
+ export interface ExportBase$BeforeExportEventParameters {}
257
+
258
+ /**
259
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ExportBase$BeforeExportEventParameters'
260
+ * in 1.115.1 and any later releases.
261
+ */
262
+ export type $ExportBaseBeforeExportEventParameters = ExportBase$BeforeExportEventParameters;
263
+
264
+ export type ExportBase$BeforeExportEvent = Event<ExportBase$BeforeExportEventParameters>;
256
265
  }
257
266
 
258
267
  declare module "sap/ui/export/Spreadsheet" {
@@ -262,13 +271,15 @@ declare module "sap/ui/export/Spreadsheet" {
262
271
 
263
272
  import TreeBinding from "sap/ui/model/TreeBinding";
264
273
 
274
+ import Event from "sap/ui/base/Event";
275
+
265
276
  /**
266
- * @SINCE 1.50
277
+ * @since 1.50
267
278
  *
268
279
  * The `sap.ui.export.Spreadsheet` class allows you to export table data from a UI5 application to a spreadsheet
269
280
  * file.
270
281
  */
271
- class Spreadsheet extends ExportBase {
282
+ export default class Spreadsheet extends ExportBase {
272
283
  /**
273
284
  * Creates a new spreadsheet export object. Use this object to build and download a spreadsheet file in
274
285
  * Office Open XML Spreadsheet format from tabular data. This functionality is normally used together with
@@ -569,7 +580,7 @@ declare module "sap/ui/export/Spreadsheet" {
569
580
  );
570
581
 
571
582
  /**
572
- * @SINCE 1.61
583
+ * @since 1.61
573
584
  *
574
585
  * Attaches event handler `fnFunction` to the {@link sap.ui.export.Spreadsheet#event:beforeSave} event of
575
586
  * this `sap.ui.export.Spreadsheet`.
@@ -595,7 +606,7 @@ declare module "sap/ui/export/Spreadsheet" {
595
606
  oListener?: object
596
607
  ): this;
597
608
  /**
598
- * @SINCE 1.61
609
+ * @since 1.61
599
610
  *
600
611
  * Attaches event handler `fnFunction` to the {@link sap.ui.export.Spreadsheet#event:beforeSave} event of
601
612
  * this `sap.ui.export.Spreadsheet`.
@@ -616,7 +627,7 @@ declare module "sap/ui/export/Spreadsheet" {
616
627
  oListener?: object
617
628
  ): this;
618
629
  /**
619
- * @SINCE 1.52
630
+ * @since 1.52
620
631
  *
621
632
  * Cancels a running export process. This method does nothing if no export is running.
622
633
  *
@@ -624,7 +635,7 @@ declare module "sap/ui/export/Spreadsheet" {
624
635
  */
625
636
  cancel(): this;
626
637
  /**
627
- * @SINCE 1.61
638
+ * @since 1.61
628
639
  *
629
640
  * Detaches event handler `fnFunction` from the {@link sap.ui.export.Spreadsheet beforeSave} event of this
630
641
  * `sap.ui.export.Spreadsheet`.
@@ -643,7 +654,7 @@ declare module "sap/ui/export/Spreadsheet" {
643
654
  oListener?: object
644
655
  ): this;
645
656
  /**
646
- * @SINCE 1.112
657
+ * @since 1.112
647
658
  *
648
659
  * Returns the specific MIME type
649
660
  *
@@ -651,7 +662,7 @@ declare module "sap/ui/export/Spreadsheet" {
651
662
  */
652
663
  getMimeType(): string;
653
664
  /**
654
- * @SINCE 1.73
665
+ * @since 1.73
655
666
  *
656
667
  * Sets the data source configuration that will be used for exporting the data. If the passed parameter
657
668
  * is null, the call will be ignored.
@@ -666,9 +677,16 @@ declare module "sap/ui/export/Spreadsheet" {
666
677
  oDataSource: string | any[] | Object | ListBinding | TreeBinding
667
678
  ): object | null;
668
679
  }
669
- export default Spreadsheet;
670
680
 
671
- export interface $SpreadsheetBeforeSaveEventParameters {}
681
+ export interface Spreadsheet$BeforeSaveEventParameters {}
682
+
683
+ /**
684
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Spreadsheet$BeforeSaveEventParameters'
685
+ * in 1.115.1 and any later releases.
686
+ */
687
+ export type $SpreadsheetBeforeSaveEventParameters = Spreadsheet$BeforeSaveEventParameters;
688
+
689
+ export type Spreadsheet$BeforeSaveEvent = Event<Spreadsheet$BeforeSaveEventParameters>;
672
690
  }
673
691
 
674
692
  declare module "sap/ui/export/util/Filter" {
@@ -679,13 +697,13 @@ declare module "sap/ui/export/util/Filter" {
679
697
  import SimpleType from "sap/ui/model/SimpleType";
680
698
 
681
699
  /**
682
- * @SINCE 1.110
700
+ * @since 1.110
683
701
  *
684
702
  * The `sap.ui.export.util.Filter` class represents filter settings that are used for the export. It provides
685
703
  * the capability to have a visual representation of the filters in the exported document and offers convenience
686
704
  * functions like `sap.ui.export.util.Filter#setType` to improve the result.
687
705
  */
688
- class Filter extends BaseObject {
706
+ export default class Filter extends BaseObject {
689
707
  /**
690
708
  * Representation of filter settings that are used for exporting.
691
709
  */
@@ -762,7 +780,7 @@ declare module "sap/ui/export/util/Filter" {
762
780
  */
763
781
  static getMetadata(): Metadata;
764
782
  /**
765
- * @SINCE 1.110
783
+ * @since 1.110
766
784
  *
767
785
  * Returns the filter label if available. Otherwise the name of the filter property will be returned.
768
786
  *
@@ -770,7 +788,7 @@ declare module "sap/ui/export/util/Filter" {
770
788
  */
771
789
  getLabel(): string;
772
790
  /**
773
- * @SINCE 1.110
791
+ * @since 1.110
774
792
  *
775
793
  * Returns the technical name of the property on which the filter is applied.
776
794
  *
@@ -778,7 +796,7 @@ declare module "sap/ui/export/util/Filter" {
778
796
  */
779
797
  getProperty(): string;
780
798
  /**
781
- * @SINCE 1.110
799
+ * @since 1.110
782
800
  *
783
801
  * Returns the formatted filter value(s) as string. If there are multiple filters for the same property,
784
802
  * which are combined via `OR`, it will return a semicolon-separated list of the filter values including
@@ -788,7 +806,7 @@ declare module "sap/ui/export/util/Filter" {
788
806
  */
789
807
  getValue(): string;
790
808
  /**
791
- * @SINCE 1.110
809
+ * @since 1.110
792
810
  *
793
811
  * Uses the given format function to format all filter values. The function has to accept a single parameter
794
812
  * of type `string` and needs to return a string value. The function will be called for every single raw
@@ -807,7 +825,7 @@ declare module "sap/ui/export/util/Filter" {
807
825
  fnFormat: Function
808
826
  ): void;
809
827
  /**
810
- * @SINCE 1.110
828
+ * @since 1.110
811
829
  *
812
830
  * Takes the given string as label of the filter.
813
831
  */
@@ -818,7 +836,7 @@ declare module "sap/ui/export/util/Filter" {
818
836
  sLabel: string
819
837
  ): void;
820
838
  /**
821
- * @SINCE 1.110
839
+ * @since 1.110
822
840
  *
823
841
  * Uses the given `sap.ui.model.SimpleType` instance to format the filter values accordingly.
824
842
  */
@@ -829,7 +847,6 @@ declare module "sap/ui/export/util/Filter" {
829
847
  oType: SimpleType
830
848
  ): void;
831
849
  }
832
- export default Filter;
833
850
  }
834
851
 
835
852
  declare namespace sap {