@sapui5/ts-types 1.95.0 → 1.96.3

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 +376 -40
  21. package/types/sap.landvisz.d.ts +1 -1
  22. package/types/sap.m.d.ts +563 -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 +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 +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 +31 -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 +681 -487
  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 +49 -34
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.95.0
1
+ // For Library Version: 1.96.3
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -185,6 +185,13 @@ declare namespace sap {
185
185
  */
186
186
  selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
187
187
 
188
+ /**
189
+ * @SINCE 1.96.2
190
+ *
191
+ * Specifies an optional aria-label that can be used by the screen readers.
192
+ */
193
+ ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
194
+
188
195
  /**
189
196
  * Defines the content inside the flexible part.
190
197
  */
@@ -1349,6 +1356,14 @@ declare namespace sap {
1349
1356
  item?: sap.ui.core.Item;
1350
1357
  }
1351
1358
  ): this;
1359
+ /**
1360
+ * @SINCE 1.96.2
1361
+ *
1362
+ * Gets current value of property {@link #getAriaLabel ariaLabel}.
1363
+ *
1364
+ * Specifies an optional aria-label that can be used by the screen readers.
1365
+ */
1366
+ getAriaLabel(): string;
1352
1367
  /**
1353
1368
  * Gets current value of property {@link #getExpanded expanded}.
1354
1369
  *
@@ -1390,6 +1405,21 @@ declare namespace sap {
1390
1405
  * Specifies the currently selected key.
1391
1406
  */
1392
1407
  getSelectedKey(): string;
1408
+ /**
1409
+ * @SINCE 1.96.2
1410
+ *
1411
+ * Sets a new value for property {@link #getAriaLabel ariaLabel}.
1412
+ *
1413
+ * Specifies an optional aria-label that can be used by the screen readers.
1414
+ *
1415
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1416
+ */
1417
+ setAriaLabel(
1418
+ /**
1419
+ * New value for property `ariaLabel`
1420
+ */
1421
+ sAriaLabel?: string
1422
+ ): this;
1393
1423
  /**
1394
1424
  * Sets if the control is in expanded or collapsed mode.
1395
1425
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.95.0
1
+ // For Library Version: 1.96.3
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.3
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.3
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -486,7 +486,7 @@ declare namespace sap {
486
486
  * of the syntax of the settings object.
487
487
  * See:
488
488
  * {@link topic:2ae520a67c44495ab5dbc69668c47a7f Filter Bar}
489
- * [@link fiori:https://experience.sap.com/fiori-design-web/filter-bar/ Filter Bar]
489
+ * {@link fiori:https://experience.sap.com/fiori-design-web/filter-bar/ Filter Bar}
490
490
  */
491
491
  constructor(
492
492
  /**
@@ -502,7 +502,7 @@ declare namespace sap {
502
502
  * of the syntax of the settings object.
503
503
  * See:
504
504
  * {@link topic:2ae520a67c44495ab5dbc69668c47a7f Filter Bar}
505
- * [@link fiori:https://experience.sap.com/fiori-design-web/filter-bar/ Filter Bar]
505
+ * {@link fiori:https://experience.sap.com/fiori-design-web/filter-bar/ Filter Bar}
506
506
  */
507
507
  constructor(
508
508
  /**
@@ -2068,6 +2068,10 @@ declare namespace sap {
2068
2068
  * Default value is `empty string`.
2069
2069
  */
2070
2070
  getHeader(): string;
2071
+ /**
2072
+ * Returns promise which will be resolve when the initialized event is fired.
2073
+ */
2074
+ getInitializedPromise(): Promise<any>;
2071
2075
  /**
2072
2076
  * Gets current value of property {@link #getIsRunningInValueHelpDialog isRunningInValueHelpDialog}.
2073
2077
  *
@@ -3574,7 +3578,13 @@ declare namespace sap {
3574
3578
  *
3575
3579
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
3576
3580
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
3577
- * will be processed.
3581
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
3582
+ *
3583
+ * - {String} text: Text of the navigation intent
3584
+ * - {String} href: HREF of the navigation intent
3585
+ * - {String} originalId: ID of the control that fires the navigation intent
3586
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
3587
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
3578
3588
  */
3579
3589
  beforeNavigationCallback?:
3580
3590
  | Function
@@ -3709,7 +3719,13 @@ declare namespace sap {
3709
3719
  *
3710
3720
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
3711
3721
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
3712
- * will be processed.
3722
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
3723
+ *
3724
+ * - {String} text: Text of the navigation intent
3725
+ * - {String} href: HREF of the navigation intent
3726
+ * - {String} originalId: ID of the control that fires the navigation intent
3727
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
3728
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
3713
3729
  */
3714
3730
  beforeNavigationCallback?:
3715
3731
  | Function
@@ -3878,7 +3894,13 @@ declare namespace sap {
3878
3894
  *
3879
3895
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
3880
3896
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
3881
- * will be processed.
3897
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
3898
+ *
3899
+ * - {String} text: Text of the navigation intent
3900
+ * - {String} href: HREF of the navigation intent
3901
+ * - {String} originalId: ID of the control that fires the navigation intent
3902
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
3903
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
3882
3904
  */
3883
3905
  beforeNavigationCallback?:
3884
3906
  | Function
@@ -5300,7 +5322,13 @@ declare namespace sap {
5300
5322
  *
5301
5323
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
5302
5324
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
5303
- * will be processed.
5325
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
5326
+ *
5327
+ * - {String} text: Text of the navigation intent
5328
+ * - {String} href: HREF of the navigation intent
5329
+ * - {String} originalId: ID of the control that fires the navigation intent
5330
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
5331
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
5304
5332
  */
5305
5333
  getBeforeNavigationCallback(): Function;
5306
5334
  /**
@@ -5416,7 +5444,14 @@ declare namespace sap {
5416
5444
  *
5417
5445
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
5418
5446
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
5419
- * will be processed.
5447
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
5448
+ *
5449
+ * - {String} text: Text of the navigation intent
5450
+ * - {String} href: HREF of the navigation intent
5451
+ * - {String} originalId: ID of the control that fires the navigation intent
5452
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
5453
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
5454
+ *
5420
5455
  *
5421
5456
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5422
5457
  */
@@ -6088,7 +6123,13 @@ declare namespace sap {
6088
6123
  *
6089
6124
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
6090
6125
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
6091
- * will be processed.
6126
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
6127
+ *
6128
+ * - {String} text: Text of the navigation intent
6129
+ * - {String} href: HREF of the navigation intent
6130
+ * - {String} originalId: ID of the control that fires the navigation intent
6131
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
6132
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
6092
6133
  */
6093
6134
  getBeforeNavigationCallback(): Function;
6094
6135
  /**
@@ -6218,7 +6259,14 @@ declare namespace sap {
6218
6259
  *
6219
6260
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
6220
6261
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
6221
- * will be processed.
6262
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
6263
+ *
6264
+ * - {String} text: Text of the navigation intent
6265
+ * - {String} href: HREF of the navigation intent
6266
+ * - {String} originalId: ID of the control that fires the navigation intent
6267
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
6268
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
6269
+ *
6222
6270
  *
6223
6271
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6224
6272
  */
@@ -6843,7 +6891,13 @@ declare namespace sap {
6843
6891
  *
6844
6892
  * Function that is called before the actual navigation happens. This function has to return a promise resolving
6845
6893
  * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation
6846
- * will be processed.
6894
+ * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data:
6895
+ *
6896
+ * - {String} text: Text of the navigation intent
6897
+ * - {String} href: HREF of the navigation intent
6898
+ * - {String} originalId: ID of the control that fires the navigation intent
6899
+ * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent
6900
+ * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent
6847
6901
  */
6848
6902
  getBeforeNavigationCallback(): Function;
6849
6903
  /**
@@ -10259,6 +10313,13 @@ declare namespace sap {
10259
10313
  */
10260
10314
  ariaLabelledBy?: Array<sap.ui.core.Control | string>;
10261
10315
 
10316
+ /**
10317
+ * @SINCE 1.96
10318
+ *
10319
+ * Association to controls / IDs that describe this control (see WAI-ARIA attribute `aria-describedby`).
10320
+ */
10321
+ ariaDescribedBy?: Array<sap.ui.core.Control | string>;
10322
+
10262
10323
  /**
10263
10324
  * The OData entity set is either derived from the control's binding context or from control's entity set
10264
10325
  * property, if a value for it is specified. In both cases this event is fired.
@@ -10905,6 +10966,17 @@ declare namespace sap {
10905
10966
  */
10906
10967
  bNavigationPathsOnly: boolean
10907
10968
  ): any[];
10969
+ /**
10970
+ * @SINCE 1.96
10971
+ *
10972
+ * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
10973
+ */
10974
+ addAriaDescribedBy(
10975
+ /**
10976
+ * The ariaDescribedBy to add; if empty, nothing is inserted
10977
+ */
10978
+ vAriaDescribedBy: sap.ui.core.ID | sap.ui.core.Control
10979
+ ): this;
10908
10980
  /**
10909
10981
  * @SINCE 1.34.2
10910
10982
  *
@@ -11823,6 +11895,13 @@ declare namespace sap {
11823
11895
  visible?: boolean;
11824
11896
  }
11825
11897
  ): this;
11898
+ /**
11899
+ * @SINCE 1.96
11900
+ *
11901
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
11902
+ * ariaDescribedBy}.
11903
+ */
11904
+ getAriaDescribedBy(): sap.ui.core.ID[];
11826
11905
  /**
11827
11906
  * @SINCE 1.34.2
11828
11907
  *
@@ -12440,12 +12519,29 @@ declare namespace sap {
12440
12519
  * Default value is `true`.
12441
12520
  */
12442
12521
  getWrapping(): boolean;
12522
+ /**
12523
+ * @SINCE 1.96
12524
+ *
12525
+ * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
12526
+ */
12527
+ removeAllAriaDescribedBy(): sap.ui.core.ID[];
12443
12528
  /**
12444
12529
  * @SINCE 1.34.2
12445
12530
  *
12446
12531
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
12447
12532
  */
12448
12533
  removeAllAriaLabelledBy(): sap.ui.core.ID[];
12534
+ /**
12535
+ * @SINCE 1.96
12536
+ *
12537
+ * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
12538
+ */
12539
+ removeAriaDescribedBy(
12540
+ /**
12541
+ * The ariaDescribedBy to be removed or its index or ID
12542
+ */
12543
+ vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control
12544
+ ): sap.ui.core.ID;
12449
12545
  /**
12450
12546
  * @SINCE 1.34.2
12451
12547
  *
@@ -15418,6 +15514,11 @@ declare namespace sap {
15418
15514
  | string
15419
15515
  | sap.ui.comp.smartfilterbar.GroupConfiguration
15420
15516
  ): sap.ui.comp.smartfilterbar.GroupConfiguration;
15517
+ /**
15518
+ * Resumes calls to the `search` method. If it was called during the suspension, the search will be triggered
15519
+ * once regardless of how many times it was called during suspension.
15520
+ */
15521
+ resumeSelection(): void;
15421
15522
  /**
15422
15523
  * Overwrites method from base class. Called when user clicks the search button of the FilterBar. The search
15423
15524
  * is executed asynchronously per default, but can be forced to synchronously execution by providing the
@@ -15707,6 +15808,10 @@ declare namespace sap {
15707
15808
  */
15708
15809
  bUseProvidedNavigationProperties?: boolean
15709
15810
  ): this;
15811
+ /**
15812
+ * Suspends calls to the `search` method when not called with the `bSync` parameter.
15813
+ */
15814
+ suspendSelection(): void;
15710
15815
  /**
15711
15816
  * Verify if all mandatory filters or parameters have values.
15712
15817
  */
@@ -23319,6 +23424,13 @@ declare namespace sap {
23319
23424
  | boolean
23320
23425
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
23321
23426
 
23427
+ /**
23428
+ * @SINCE 1.96
23429
+ *
23430
+ * Determines whether the Paste button is enabled.
23431
+ */
23432
+ enablePaste?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
23433
+
23322
23434
  /**
23323
23435
  * @SINCE 1.26.0
23324
23436
  *
@@ -24903,6 +25015,16 @@ declare namespace sap {
24903
25015
  * Default value is `true`.
24904
25016
  */
24905
25017
  getEnableCustomFilter(): boolean;
25018
+ /**
25019
+ * @SINCE 1.96
25020
+ *
25021
+ * Gets current value of property {@link #getEnablePaste enablePaste}.
25022
+ *
25023
+ * Determines whether the Paste button is enabled.
25024
+ *
25025
+ * Default value is `true`.
25026
+ */
25027
+ getEnablePaste(): boolean;
24906
25028
  /**
24907
25029
  * @SINCE 1.26.0
24908
25030
  *
@@ -25571,6 +25693,15 @@ declare namespace sap {
25571
25693
  */
25572
25694
  bEnableCustomFilter?: boolean
25573
25695
  ): this;
25696
+ /**
25697
+ * Sets a new value for the `enablePaste` property.
25698
+ */
25699
+ setEnablePaste(
25700
+ /**
25701
+ * New value for property enablePaste
25702
+ */
25703
+ bValue: boolean
25704
+ ): sap.ui.comp.smarttable.SmartTable;
25574
25705
  /**
25575
25706
  * The entity set name from OData metadata, with which the table should be bound to
25576
25707
  */