@sapui5/ts-types 1.115.1 → 1.117.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 (65) hide show
  1. package/README.md +4 -14
  2. package/package.json +1 -1
  3. package/types/index.d.ts +10 -3
  4. package/types/sap.apf.d.ts +38 -30
  5. package/types/sap.ca.ui.d.ts +216 -87
  6. package/types/sap.chart.d.ts +31 -55
  7. package/types/sap.collaboration.d.ts +25 -20
  8. package/types/sap.esh.search.ui.d.ts +117 -107
  9. package/types/sap.f.d.ts +229 -310
  10. package/types/sap.fe.core.d.ts +147 -35
  11. package/types/sap.fe.macros.d.ts +167 -61
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.optimisticBatch.d.ts +3 -0
  14. package/types/sap.fe.test.d.ts +1 -1
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +1255 -2252
  18. package/types/sap.insights.d.ts +251 -11
  19. package/types/sap.landvisz.d.ts +92 -27
  20. package/types/sap.m.d.ts +2631 -3400
  21. package/types/sap.makit.d.ts +22 -42
  22. package/types/sap.me.d.ts +45 -78
  23. package/types/sap.ndc.d.ts +41 -39
  24. package/types/sap.ovp.d.ts +24 -98
  25. package/types/sap.rules.ui.d.ts +41 -37
  26. package/types/sap.sac.df.d.ts +93 -5
  27. package/types/sap.suite.ui.commons.d.ts +1361 -1165
  28. package/types/sap.suite.ui.generic.template.d.ts +5 -8
  29. package/types/sap.suite.ui.microchart.d.ts +88 -138
  30. package/types/sap.tnt.d.ts +63 -27
  31. package/types/sap.ui.codeeditor.d.ts +11 -21
  32. package/types/sap.ui.commons.d.ts +335 -530
  33. package/types/sap.ui.comp.d.ts +919 -1032
  34. package/types/sap.ui.core.d.ts +1176 -1078
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +192 -13
  37. package/types/sap.ui.fl.d.ts +28 -87
  38. package/types/sap.ui.generic.app.d.ts +28 -30
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +207 -114
  41. package/types/sap.ui.layout.d.ts +98 -69
  42. package/types/sap.ui.mdc.d.ts +7003 -6826
  43. package/types/sap.ui.richtexteditor.d.ts +18 -31
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +9 -14
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +169 -229
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +288 -481
  50. package/types/sap.ui.ux3.d.ts +343 -602
  51. package/types/sap.ui.vbm.d.ts +664 -764
  52. package/types/sap.ui.vk.d.ts +1746 -1844
  53. package/types/sap.ui.vtm.d.ts +417 -386
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +894 -369
  56. package/types/sap.ui.webc.main.d.ts +4598 -1356
  57. package/types/sap.uiext.inbox.d.ts +64 -103
  58. package/types/sap.ushell.d.ts +285 -316
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +60 -100
  61. package/types/sap.viz.d.ts +677 -1089
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +2 -2
  64. package/types/sap.zen.crosstab.d.ts +2 -2
  65. package/types/sap.zen.dsh.d.ts +148 -157
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.117.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace rules {
@@ -43,9 +43,9 @@ declare namespace sap {
43
43
  dataChange?: (oEvent: sap.ui.base.Event) => void;
44
44
  }
45
45
 
46
- interface $AstExpressionLanguageDataChangeEventParameters {}
46
+ interface AstExpressionLanguage$DataChangeEventParameters {}
47
47
 
48
- interface $ExpressionLanguageDataChangeEventParameters {}
48
+ interface ExpressionLanguage$DataChangeEventParameters {}
49
49
 
50
50
  /**
51
51
  * Provides the AstExpressionLanguage service functionality, such as expression validations, expression
@@ -151,7 +151,7 @@ declare namespace sap {
151
151
  oListener?: object
152
152
  ): this;
153
153
  /**
154
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
154
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
155
155
  *
156
156
  * Fires event {@link #event:dataChange dataChange} to attached listeners.
157
157
  *
@@ -293,7 +293,7 @@ declare namespace sap {
293
293
  oListener?: object
294
294
  ): this;
295
295
  /**
296
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
296
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
297
297
  *
298
298
  * Fires event {@link #event:dataChange dataChange} to attached listeners.
299
299
  *
@@ -358,6 +358,16 @@ declare namespace sap {
358
358
  oValueHelpCallback: any
359
359
  ): this;
360
360
  }
361
+
362
+ type AstExpressionLanguage$DataChangeEvent = sap.ui.base.Event<
363
+ AstExpressionLanguage$DataChangeEventParameters,
364
+ AstExpressionLanguage
365
+ >;
366
+
367
+ type ExpressionLanguage$DataChangeEvent = sap.ui.base.Event<
368
+ ExpressionLanguage$DataChangeEventParameters,
369
+ ExpressionLanguage
370
+ >;
361
371
  }
362
372
 
363
373
  interface $DecisionTableConfigurationSettings
@@ -423,9 +433,7 @@ declare namespace sap {
423
433
  | sap.ui.base.ManagedObject.PropertyBindingInfo
424
434
  | `{${string}}`;
425
435
 
426
- change?: (
427
- oEvent: sap.ui.base.Event<sap.rules.ui.$DecisionTableConfigurationChangeEventParameters>
428
- ) => void;
436
+ change?: (oEvent: DecisionTableConfiguration$ChangeEvent) => void;
429
437
  }
430
438
 
431
439
  interface $RuleBuilderSettings extends sap.ui.core.$ControlSettings {
@@ -513,25 +521,23 @@ declare namespace sap {
513
521
  | sap.ui.base.ManagedObject.PropertyBindingInfo
514
522
  | `{${string}}`;
515
523
 
516
- change?: (
517
- oEvent: sap.ui.base.Event<sap.rules.ui.$TextRuleConfigurationChangeEventParameters>
518
- ) => void;
524
+ change?: (oEvent: TextRuleConfiguration$ChangeEvent) => void;
519
525
  }
520
526
 
521
- interface $DecisionTableConfigurationChangeEventParameters {
527
+ interface DecisionTableConfiguration$ChangeEventParameters {
522
528
  name?: undefined;
523
529
 
524
530
  value?: undefined;
525
531
  }
526
532
 
527
- interface $TextRuleConfigurationChangeEventParameters {
533
+ interface TextRuleConfiguration$ChangeEventParameters {
528
534
  name?: undefined;
529
535
 
530
536
  value?: undefined;
531
537
  }
532
538
 
533
539
  /**
534
- * @SINCE 1.4
540
+ * @since 1.4
535
541
  *
536
542
  * The `sap.rules.ui.DecisionTableConfiguration` element provides the ability to define specific properties
537
543
  * that will be applied when rendering the `sap.rules.ui.RuleBuilder` in decision table mode.
@@ -617,9 +623,7 @@ declare namespace sap {
617
623
  /**
618
624
  * The function to be called when the event occurs
619
625
  */
620
- fnFunction: (
621
- p1: sap.ui.base.Event<sap.rules.ui.$DecisionTableConfigurationChangeEventParameters>
622
- ) => void,
626
+ fnFunction: (p1: DecisionTableConfiguration$ChangeEvent) => void,
623
627
  /**
624
628
  * Context object to call the event handler with. Defaults to this `sap.rules.ui.DecisionTableConfiguration`
625
629
  * itself
@@ -638,9 +642,7 @@ declare namespace sap {
638
642
  /**
639
643
  * The function to be called when the event occurs
640
644
  */
641
- fnFunction: (
642
- p1: sap.ui.base.Event<sap.rules.ui.$DecisionTableConfigurationChangeEventParameters>
643
- ) => void,
645
+ fnFunction: (p1: DecisionTableConfiguration$ChangeEvent) => void,
644
646
  /**
645
647
  * Context object to call the event handler with. Defaults to this `sap.rules.ui.DecisionTableConfiguration`
646
648
  * itself
@@ -658,16 +660,14 @@ declare namespace sap {
658
660
  /**
659
661
  * The function to be called, when the event occurs
660
662
  */
661
- fnFunction: (
662
- p1: sap.ui.base.Event<sap.rules.ui.$DecisionTableConfigurationChangeEventParameters>
663
- ) => void,
663
+ fnFunction: (p1: DecisionTableConfiguration$ChangeEvent) => void,
664
664
  /**
665
665
  * Context object on which the given function had to be called
666
666
  */
667
667
  oListener?: object
668
668
  ): this;
669
669
  /**
670
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
670
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
671
671
  *
672
672
  * Fires event {@link #event:change change} to attached listeners.
673
673
  *
@@ -677,7 +677,7 @@ declare namespace sap {
677
677
  /**
678
678
  * Parameters to pass along with the event
679
679
  */
680
- mParameters?: sap.rules.ui.$DecisionTableConfigurationChangeEventParameters
680
+ mParameters?: sap.rules.ui.DecisionTableConfiguration$ChangeEventParameters
681
681
  ): this;
682
682
  /**
683
683
  * @deprecated (since 1.52.8) - use the decisionTableFormat property.
@@ -1112,7 +1112,7 @@ declare namespace sap {
1112
1112
  ): this;
1113
1113
  }
1114
1114
  /**
1115
- * @SINCE 1.4
1115
+ * @since 1.4
1116
1116
  *
1117
1117
  * The `sap.rules.ui.TextRuleConfiguration` element provides the ability to define specific properties that
1118
1118
  * will be applied when rendering the `sap.rules.ui.RuleBuilder` in decision table mode.
@@ -1195,9 +1195,7 @@ declare namespace sap {
1195
1195
  /**
1196
1196
  * The function to be called when the event occurs
1197
1197
  */
1198
- fnFunction: (
1199
- p1: sap.ui.base.Event<sap.rules.ui.$TextRuleConfigurationChangeEventParameters>
1200
- ) => void,
1198
+ fnFunction: (p1: TextRuleConfiguration$ChangeEvent) => void,
1201
1199
  /**
1202
1200
  * Context object to call the event handler with. Defaults to this `sap.rules.ui.TextRuleConfiguration`
1203
1201
  * itself
@@ -1216,9 +1214,7 @@ declare namespace sap {
1216
1214
  /**
1217
1215
  * The function to be called when the event occurs
1218
1216
  */
1219
- fnFunction: (
1220
- p1: sap.ui.base.Event<sap.rules.ui.$TextRuleConfigurationChangeEventParameters>
1221
- ) => void,
1217
+ fnFunction: (p1: TextRuleConfiguration$ChangeEvent) => void,
1222
1218
  /**
1223
1219
  * Context object to call the event handler with. Defaults to this `sap.rules.ui.TextRuleConfiguration`
1224
1220
  * itself
@@ -1236,16 +1232,14 @@ declare namespace sap {
1236
1232
  /**
1237
1233
  * The function to be called, when the event occurs
1238
1234
  */
1239
- fnFunction: (
1240
- p1: sap.ui.base.Event<sap.rules.ui.$TextRuleConfigurationChangeEventParameters>
1241
- ) => void,
1235
+ fnFunction: (p1: TextRuleConfiguration$ChangeEvent) => void,
1242
1236
  /**
1243
1237
  * Context object on which the given function had to be called
1244
1238
  */
1245
1239
  oListener?: object
1246
1240
  ): this;
1247
1241
  /**
1248
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1242
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1249
1243
  *
1250
1244
  * Fires event {@link #event:change change} to attached listeners.
1251
1245
  *
@@ -1255,7 +1249,7 @@ declare namespace sap {
1255
1249
  /**
1256
1250
  * Parameters to pass along with the event
1257
1251
  */
1258
- mParameters?: sap.rules.ui.$TextRuleConfigurationChangeEventParameters
1252
+ mParameters?: sap.rules.ui.TextRuleConfiguration$ChangeEventParameters
1259
1253
  ): this;
1260
1254
  /**
1261
1255
  * Gets current value of property {@link #getEnableElse enableElse}.
@@ -1476,6 +1470,16 @@ declare namespace sap {
1476
1470
  */
1477
1471
  TextRule = "TextRule",
1478
1472
  }
1473
+
1474
+ type DecisionTableConfiguration$ChangeEvent = sap.ui.base.Event<
1475
+ DecisionTableConfiguration$ChangeEventParameters,
1476
+ DecisionTableConfiguration
1477
+ >;
1478
+
1479
+ type TextRuleConfiguration$ChangeEvent = sap.ui.base.Event<
1480
+ TextRuleConfiguration$ChangeEventParameters,
1481
+ TextRuleConfiguration
1482
+ >;
1479
1483
  }
1480
1484
  }
1481
1485
 
@@ -1,17 +1,78 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.117.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace sac {
5
5
  /**
6
- * @EXPERIMENTAL
6
+ * @experimental
7
7
  *
8
8
  * Dragonfly Library. Provides models and control to access Multidimensional Data via InA protocol and Firefly
9
9
  * library
10
10
  */
11
11
  namespace df {
12
+ namespace controls {
13
+ interface $MultiDimControlSettings
14
+ extends sap.ui.core.$ControlSettings {}
15
+
16
+ /**
17
+ * @experimental
18
+ *
19
+ * Enables users to view, navigate and change multidimensional data exposed via InA.
20
+ *
21
+ * Overview:
22
+ *
23
+ * The user can view the data in a Table, navigate in the data via a context menu or builder panels The
24
+ * data source that the FlexAnalysis consumes or renders has to be provided as a property value.
25
+ */
26
+ class MultiDimControl extends sap.ui.core.Control {
27
+ /**
28
+ * Constructor for a new `MultiDimControl`.
29
+ *
30
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
31
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
32
+ * of the syntax of the settings object.
33
+ */
34
+ constructor(
35
+ /**
36
+ * ID for the new control, generated automatically if no ID is given
37
+ */
38
+ sId?: string
39
+ );
40
+
41
+ /**
42
+ * Creates a new subclass of class sap.sac.df.controls.MultiDimControl with name `sClassName` and enriches
43
+ * it with the information contained in `oClassInfo`.
44
+ *
45
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
46
+ *
47
+ * @returns Created class / constructor function
48
+ */
49
+ static extend<T extends Record<string, unknown>>(
50
+ /**
51
+ * Name of the class being created
52
+ */
53
+ sClassName: string,
54
+ /**
55
+ * Object literal with information about the class
56
+ */
57
+ oClassInfo?: sap.ClassInfo<T, sap.sac.df.controls.MultiDimControl>,
58
+ /**
59
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
60
+ * used by this class
61
+ */
62
+ FNMetaImpl?: Function
63
+ ): Function;
64
+ /**
65
+ * Returns a metadata object for class sap.sac.df.controls.MultiDimControl.
66
+ *
67
+ * @returns Metadata object describing this class
68
+ */
69
+ static getMetadata(): sap.ui.core.ElementMetadata;
70
+ }
71
+ }
72
+
12
73
  namespace olap {
13
74
  /**
14
- * @EXPERIMENTAL
75
+ * @experimental
15
76
  *
16
77
  * A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
17
78
  * HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
@@ -425,7 +486,7 @@ declare namespace sap {
425
486
  ): this;
426
487
  }
427
488
  /**
428
- * @EXPERIMENTAL
489
+ * @experimental
429
490
  *
430
491
  * Model implementation for InA provider
431
492
  *
@@ -442,6 +503,10 @@ declare namespace sap {
442
503
  * Constructor for a new OlapMode.
443
504
  *
444
505
  * The Olap Model allows to access and change data from servers providing the InA Protocol.
506
+ *
507
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
508
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
509
+ * of the syntax of the settings object.
445
510
  */
446
511
  constructor();
447
512
 
@@ -474,6 +539,25 @@ declare namespace sap {
474
539
  * @returns Metadata object describing this class
475
540
  */
476
541
  static getMetadata(): sap.ui.base.Metadata;
542
+ /**
543
+ * Gets current value of property {@link #getApi api}.
544
+ *
545
+ * @returns Value of property `api`
546
+ */
547
+ getApi(): undefined;
548
+ /**
549
+ * Sets a new value for property {@link #getApi api}.
550
+ *
551
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
552
+ *
553
+ * @returns Reference to `this` in order to allow method chaining
554
+ */
555
+ setApi(
556
+ /**
557
+ * New value for property `api`
558
+ */
559
+ sApi: undefined
560
+ ): this;
477
561
  }
478
562
  }
479
563
 
@@ -733,7 +817,7 @@ declare namespace sap {
733
817
  }
734
818
 
735
819
  /**
736
- * @EXPERIMENTAL
820
+ * @experimental
737
821
  *
738
822
  * Enables users to view, navigate and change multidimensional data exposed via InA.
739
823
  *
@@ -1553,6 +1637,8 @@ declare namespace sap {
1553
1637
  unbindDataProvider(): this;
1554
1638
  }
1555
1639
  /**
1640
+ * @experimental
1641
+ *
1556
1642
  * A panel to be added into FlexAnalysis control
1557
1643
  */
1558
1644
  class FlexAnalysisPanel extends sap.ui.core.Element {
@@ -1713,6 +1799,8 @@ declare namespace sap {
1713
1799
  }
1714
1800
 
1715
1801
  interface IUI5DefineDependencyNames {
1802
+ "sap/sac/df/controls/MultiDimControl": undefined;
1803
+
1716
1804
  "sap/sac/df/FlexAnalysis": undefined;
1717
1805
 
1718
1806
  "sap/sac/df/FlexAnalysisPanel": undefined;