@sapui5/ts-types 1.142.1 → 1.143.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 (71) 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.cux.home.d.ts +7 -3
  8. package/types/sap.esh.search.ui.d.ts +670 -13
  9. package/types/sap.f.d.ts +8 -1
  10. package/types/sap.fe.ariba.d.ts +1 -1
  11. package/types/sap.fe.base.d.ts +1 -1
  12. package/types/sap.fe.controls.d.ts +1 -1
  13. package/types/sap.fe.core.d.ts +1 -6
  14. package/types/sap.fe.ina.d.ts +1 -1
  15. package/types/sap.fe.macros.d.ts +35 -95
  16. package/types/sap.fe.navigation.d.ts +1 -1
  17. package/types/sap.fe.placeholder.d.ts +1 -1
  18. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  19. package/types/sap.fe.templates.d.ts +1 -1
  20. package/types/sap.fe.test.d.ts +7 -2
  21. package/types/sap.fe.tools.d.ts +1 -1
  22. package/types/sap.feedback.ui.d.ts +1 -1
  23. package/types/sap.gantt.d.ts +1 -1
  24. package/types/sap.insights.d.ts +1 -1
  25. package/types/sap.m.d.ts +168 -11
  26. package/types/sap.makit.d.ts +1 -1
  27. package/types/sap.me.d.ts +1 -1
  28. package/types/sap.ndc.d.ts +1 -1
  29. package/types/sap.ovp.d.ts +1 -1
  30. package/types/sap.rules.ui.d.ts +1 -1
  31. package/types/sap.sac.df.d.ts +1 -1
  32. package/types/sap.suite.ui.commons.d.ts +216 -11
  33. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  34. package/types/sap.suite.ui.microchart.d.ts +24 -2
  35. package/types/sap.tnt.d.ts +1 -1
  36. package/types/sap.ui.codeeditor.d.ts +1 -1
  37. package/types/sap.ui.commons.d.ts +1 -1
  38. package/types/sap.ui.comp.d.ts +7 -4
  39. package/types/sap.ui.core.d.ts +66 -54
  40. package/types/sap.ui.dt.d.ts +1 -1
  41. package/types/sap.ui.export.d.ts +1 -1
  42. package/types/sap.ui.fl.d.ts +3 -6
  43. package/types/sap.ui.generic.app.d.ts +1 -1
  44. package/types/sap.ui.generic.template.d.ts +1 -1
  45. package/types/sap.ui.geomap.d.ts +27560 -0
  46. package/types/sap.ui.integration.d.ts +45 -9
  47. package/types/sap.ui.layout.d.ts +64 -46
  48. package/types/sap.ui.mdc.d.ts +500 -124
  49. package/types/sap.ui.richtexteditor.d.ts +52 -15
  50. package/types/sap.ui.rta.d.ts +1 -1
  51. package/types/sap.ui.suite.d.ts +1 -1
  52. package/types/sap.ui.support.d.ts +1 -1
  53. package/types/sap.ui.table.d.ts +35 -1
  54. package/types/sap.ui.testrecorder.d.ts +1 -1
  55. package/types/sap.ui.unified.d.ts +1 -1
  56. package/types/sap.ui.ux3.d.ts +1 -1
  57. package/types/sap.ui.vbm.d.ts +1 -1
  58. package/types/sap.ui.vk.d.ts +61 -1
  59. package/types/sap.ui.vtm.d.ts +1 -1
  60. package/types/sap.ui.webc.common.d.ts +1 -1
  61. package/types/sap.ui.webc.fiori.d.ts +1 -1
  62. package/types/sap.ui.webc.main.d.ts +1 -1
  63. package/types/sap.uiext.inbox.d.ts +1 -1
  64. package/types/sap.ushell.d.ts +53 -10
  65. package/types/sap.ushell_abap.d.ts +1 -1
  66. package/types/sap.uxap.d.ts +1 -1
  67. package/types/sap.viz.d.ts +1 -1
  68. package/types/sap.webanalytics.core.d.ts +1 -1
  69. package/types/sap.zen.commons.d.ts +1 -1
  70. package/types/sap.zen.crosstab.d.ts +1 -1
  71. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.142.1
1
+ // For Library Version: 1.143.2
2
2
 
3
3
  declare namespace sap {
4
4
  namespace esh {
@@ -8,6 +8,35 @@ declare namespace sap {
8
8
  */
9
9
  namespace ui {
10
10
  namespace controls {
11
+ namespace basket {
12
+ /**
13
+ * Describes the settings that can be provided to the SearchBasketAddButton constructor.
14
+ */
15
+ interface $SearchBasketAddButtonSettings
16
+ extends sap.m.$OverflowToolbarButtonSettings {}
17
+
18
+ /**
19
+ * This is the SAPUI5 search basket button control to display a button to add result items to the search
20
+ * basket. Use in combination with control SearchCompositeControl by the Enterprise Search Team.
21
+ *
22
+ * @since 1.93.0
23
+ */
24
+ class SearchBasketAddButton extends sap.m.OverflowToolbarButton {
25
+ /**
26
+ * Constructs a new `SearchBasketAddButton` to display a button to add result items to the search basket.
27
+ * See:
28
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
29
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
30
+ */
31
+ constructor(
32
+ /**
33
+ * ID for the new control, generated automatically if no ID is given
34
+ */
35
+ sId?: string
36
+ );
37
+ }
38
+ }
39
+
11
40
  namespace resultview {
12
41
  /**
13
42
  * Describes the settings that can be provided to the SearchText constructor.
@@ -62,6 +91,17 @@ declare namespace sap {
62
91
  | object
63
92
  | sap.ui.base.ManagedObject.PropertyBindingInfo
64
93
  | `{${string}}`;
94
+
95
+ /**
96
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
97
+ * function 'performNavigation' of item's navigationTarget do the job
98
+ *
99
+ * @since 1.143.0
100
+ */
101
+ forceNavigationAnchorElementNotProcessed?:
102
+ | boolean
103
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
104
+ | `{${string}}`;
65
105
  }
66
106
 
67
107
  /**
@@ -123,6 +163,19 @@ declare namespace sap {
123
163
  * @returns Metadata object describing this class
124
164
  */
125
165
  static getMetadata(): sap.ui.core.ElementMetadata;
166
+ /**
167
+ * Gets current value of property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
168
+ *
169
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
170
+ * function 'performNavigation' of item's navigationTarget do the job
171
+ *
172
+ * Default value is `false`.
173
+ *
174
+ * @since 1.143.0
175
+ *
176
+ * @returns Value of property `forceNavigationAnchorElementNotProcessed`
177
+ */
178
+ getForceNavigationAnchorElementNotProcessed(): boolean;
126
179
  /**
127
180
  * Gets current value of property {@link #getNavigationTarget navigationTarget}.
128
181
  *
@@ -133,6 +186,26 @@ declare namespace sap {
133
186
  * @returns Value of property `navigationTarget`
134
187
  */
135
188
  getNavigationTarget(): object;
189
+ /**
190
+ * Sets a new value for property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
191
+ *
192
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
193
+ * function 'performNavigation' of item's navigationTarget do the job
194
+ *
195
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
196
+ *
197
+ * Default value is `false`.
198
+ *
199
+ * @since 1.143.0
200
+ *
201
+ * @returns Reference to `this` in order to allow method chaining
202
+ */
203
+ setForceNavigationAnchorElementNotProcessed(
204
+ /**
205
+ * New value for property `forceNavigationAnchorElementNotProcessed`
206
+ */
207
+ bForceNavigationAnchorElementNotProcessed?: boolean
208
+ ): this;
136
209
  /**
137
210
  * Sets a new value for property {@link #getNavigationTarget navigationTarget}.
138
211
  *
@@ -287,6 +360,17 @@ declare namespace sap {
287
360
  | sap.ui.base.ManagedObject.PropertyBindingInfo
288
361
  | `{${string}}`;
289
362
 
363
+ /**
364
+ * Set default number of visible columns of search result table. This is important when adding custom columns
365
+ * by means of formatters.
366
+ *
367
+ * @since 1.142.0
368
+ */
369
+ searchResultTableMaxNumberOfInitiallyVisibleColumns?:
370
+ | float
371
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
372
+ | `{${string}}`;
373
+
290
374
  /**
291
375
  * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
292
376
  * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
@@ -381,6 +465,27 @@ declare namespace sap {
381
465
  | sap.ui.base.ManagedObject.PropertyBindingInfo
382
466
  | `{${string}}`;
383
467
 
468
+ /**
469
+ * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
470
+ *
471
+ * @since 1.108.0
472
+ */
473
+ basketPanelResizable?:
474
+ | boolean
475
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
476
+ | `{${string}}`;
477
+
478
+ /**
479
+ * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
480
+ * is true, the width of the basket panel can be changed by the user.
481
+ *
482
+ * @since 1.142.0
483
+ */
484
+ basketPanelWidthInPercent?:
485
+ | float
486
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
487
+ | `{${string}}`;
488
+
384
489
  /**
385
490
  * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
386
491
  * to be more specific and add some hints, links, buttons or other content.
@@ -403,10 +508,10 @@ declare namespace sap {
403
508
 
404
509
  /**
405
510
  * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
406
- * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
511
+ * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
407
512
  *
408
513
  * @since 1.140.0
409
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
514
+ * @experimental As of version 1.140.0.
410
515
  */
411
516
  searchInputLocation?:
412
517
  | string
@@ -455,6 +560,13 @@ declare namespace sap {
455
560
  | sap.ui.base.ManagedObject.PropertyBindingInfo
456
561
  | `{${string}}`;
457
562
 
563
+ /**
564
+ * Show a text/title at the start(left) of the search bar.
565
+ */
566
+ searchBarTitle?:
567
+ | string
568
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
569
+
458
570
  /**
459
571
  * Controls whether the facet functionality is available or not.
460
572
  *
@@ -484,12 +596,68 @@ declare namespace sap {
484
596
  * 'facets'.
485
597
  *
486
598
  * @since 1.140.0
487
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
599
+ * @experimental As of version 1.140.0.
488
600
  */
489
601
  facetToggleButtonLocation?:
490
602
  | string
491
603
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
492
604
 
605
+ /**
606
+ * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on
607
+ * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right),
608
+ * values are "Begin", "Middle" and "End".
609
+ *
610
+ * @since 1.143.0
611
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
612
+ */
613
+ basketButtonsLocation?:
614
+ | string
615
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
616
+
617
+ /**
618
+ * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
619
+ * Moreover all items of the basket are automatically selected on result views, if they are visible on the
620
+ * current result view page.
621
+ *
622
+ * @since 1.143.0
623
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
624
+ */
625
+ basketLinkByResultViewItemSelection?:
626
+ | boolean
627
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
628
+ | `{${string}}`;
629
+
630
+ /**
631
+ * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
632
+ *
633
+ * @since 1.143.0
634
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
635
+ */
636
+ basketAddButtonIcon?:
637
+ | string
638
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
639
+
640
+ /**
641
+ * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
642
+ * icon, only.
643
+ *
644
+ * @since 1.143.0
645
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
646
+ */
647
+ basketAddButtonText?:
648
+ | string
649
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
650
+
651
+ /**
652
+ * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
653
+ *
654
+ * @since 1.143.0
655
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
656
+ */
657
+ basketAddButtonTooltip?:
658
+ | string
659
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
660
+
493
661
  /**
494
662
  * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can
495
663
  * be viewed as a pie or bar chart (this cannot be deactivated at runtime).
@@ -582,7 +750,7 @@ declare namespace sap {
582
750
  * A callback which is called whenever the selection of result view items changes.
583
751
  *
584
752
  * @since 1.113.0
585
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
753
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
586
754
  */
587
755
  selectionChange?:
588
756
  | Function
@@ -636,6 +804,30 @@ declare namespace sap {
636
804
  | sap.ui.base.ManagedObject.PropertyBindingInfo
637
805
  | `{${string}}`;
638
806
 
807
+ /**
808
+ * Enables the basket toggle button in the search result list. The button is displayed on the top of search
809
+ * result view and allows to toggle visibility of the basket ('selected' result list items).
810
+ *
811
+ * @since 1.143.0
812
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
813
+ */
814
+ basketShowHideButton?:
815
+ | boolean
816
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
817
+ | `{${string}}`;
818
+
819
+ /**
820
+ * Enables the basket add button in the search result list. The button is displayed on the top of search
821
+ * result view and allows to add result view items to the basket.
822
+ *
823
+ * @since 1.143.0
824
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
825
+ */
826
+ basketAddButton?:
827
+ | boolean
828
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
829
+ | `{${string}}`;
830
+
639
831
  /**
640
832
  * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
641
833
  * button, another page of result items of the same count (if available) will be displayed.
@@ -708,6 +900,13 @@ declare namespace sap {
708
900
  */
709
901
  searchFinished?: (oEvent: sap.ui.base.Event) => void;
710
902
 
903
+ /**
904
+ * Event is fired when selection on result view (list, table or grid) has changed.
905
+ *
906
+ * @since 1.143
907
+ */
908
+ resultViewSelectionChanged?: (oEvent: sap.ui.base.Event) => void;
909
+
711
910
  /**
712
911
  * Event is fired when selection on result view (list, table or grid) has changed.
713
912
  *
@@ -731,6 +930,11 @@ declare namespace sap {
731
930
  showResultDetail?: (oEvent: sap.ui.base.Event) => void;
732
931
  }
733
932
 
933
+ /**
934
+ * Parameters of the SearchCompositeControl#resultViewSelectionChanged event.
935
+ */
936
+ interface SearchCompositeControl$ResultViewSelectionChangedEventParameters {}
937
+
734
938
  /**
735
939
  * Parameters of the SearchCompositeControl#resultViewTypeChanged event.
736
940
  */
@@ -829,6 +1033,59 @@ declare namespace sap {
829
1033
  * @returns Metadata object describing this class
830
1034
  */
831
1035
  static getMetadata(): sap.ui.core.ElementMetadata;
1036
+ /**
1037
+ * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
1038
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
1039
+ *
1040
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1041
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
1042
+ *
1043
+ * Event is fired when selection on result view (list, table or grid) has changed.
1044
+ *
1045
+ * @since 1.143
1046
+ *
1047
+ * @returns Reference to `this` in order to allow method chaining
1048
+ */
1049
+ attachResultViewSelectionChanged(
1050
+ /**
1051
+ * An application-specific payload object that will be passed to the event handler along with the event
1052
+ * object when firing the event
1053
+ */
1054
+ oData: object,
1055
+ /**
1056
+ * The function to be called when the event occurs
1057
+ */
1058
+ fnFunction: (p1: sap.ui.base.Event) => void,
1059
+ /**
1060
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
1061
+ * itself
1062
+ */
1063
+ oListener?: object
1064
+ ): this;
1065
+ /**
1066
+ * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
1067
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
1068
+ *
1069
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1070
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
1071
+ *
1072
+ * Event is fired when selection on result view (list, table or grid) has changed.
1073
+ *
1074
+ * @since 1.143
1075
+ *
1076
+ * @returns Reference to `this` in order to allow method chaining
1077
+ */
1078
+ attachResultViewSelectionChanged(
1079
+ /**
1080
+ * The function to be called when the event occurs
1081
+ */
1082
+ fnFunction: (p1: sap.ui.base.Event) => void,
1083
+ /**
1084
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
1085
+ * itself
1086
+ */
1087
+ oListener?: object
1088
+ ): this;
832
1089
  /**
833
1090
  * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
834
1091
  * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -1094,6 +1351,26 @@ declare namespace sap {
1094
1351
  */
1095
1352
  oListener?: object
1096
1353
  ): this;
1354
+ /**
1355
+ * Detaches event handler `fnFunction` from the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
1356
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
1357
+ *
1358
+ * The passed function and listener object must match the ones used for event registration.
1359
+ *
1360
+ * @since 1.143
1361
+ *
1362
+ * @returns Reference to `this` in order to allow method chaining
1363
+ */
1364
+ detachResultViewSelectionChanged(
1365
+ /**
1366
+ * The function to be called, when the event occurs
1367
+ */
1368
+ fnFunction: (p1: sap.ui.base.Event) => void,
1369
+ /**
1370
+ * Context object on which the given function had to be called
1371
+ */
1372
+ oListener?: object
1373
+ ): this;
1097
1374
  /**
1098
1375
  * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
1099
1376
  * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -1194,6 +1471,20 @@ declare namespace sap {
1194
1471
  */
1195
1472
  oListener?: object
1196
1473
  ): this;
1474
+ /**
1475
+ * Fires event {@link #event:resultViewSelectionChanged resultViewSelectionChanged} to attached listeners.
1476
+ *
1477
+ * @since 1.143
1478
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1479
+ *
1480
+ * @returns Reference to `this` in order to allow method chaining
1481
+ */
1482
+ fireResultViewSelectionChanged(
1483
+ /**
1484
+ * Parameters to pass along with the event
1485
+ */
1486
+ mParameters?: object
1487
+ ): this;
1197
1488
  /**
1198
1489
  * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
1199
1490
  *
@@ -1289,6 +1580,123 @@ declare namespace sap {
1289
1580
  * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
1290
1581
  */
1291
1582
  getAutoAdjustResultViewTypeInFolderMode(): boolean;
1583
+ /**
1584
+ * Gets current value of property {@link #getBasketAddButton basketAddButton}.
1585
+ *
1586
+ * Enables the basket add button in the search result list. The button is displayed on the top of search
1587
+ * result view and allows to add result view items to the basket.
1588
+ *
1589
+ * Default value is `false`.
1590
+ *
1591
+ * @since 1.143.0
1592
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1593
+ *
1594
+ * @returns Value of property `basketAddButton`
1595
+ */
1596
+ getBasketAddButton(): boolean;
1597
+ /**
1598
+ * Gets current value of property {@link #getBasketAddButtonIcon basketAddButtonIcon}.
1599
+ *
1600
+ * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
1601
+ *
1602
+ * @since 1.143.0
1603
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1604
+ *
1605
+ * @returns Value of property `basketAddButtonIcon`
1606
+ */
1607
+ getBasketAddButtonIcon(): string;
1608
+ /**
1609
+ * Gets current value of property {@link #getBasketAddButtonText basketAddButtonText}.
1610
+ *
1611
+ * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
1612
+ * icon, only.
1613
+ *
1614
+ * @since 1.143.0
1615
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1616
+ *
1617
+ * @returns Value of property `basketAddButtonText`
1618
+ */
1619
+ getBasketAddButtonText(): string;
1620
+ /**
1621
+ * Gets current value of property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
1622
+ *
1623
+ * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
1624
+ *
1625
+ * @since 1.143.0
1626
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1627
+ *
1628
+ * @returns Value of property `basketAddButtonTooltip`
1629
+ */
1630
+ getBasketAddButtonTooltip(): string;
1631
+ /**
1632
+ * Gets current value of property {@link #getBasketButtonsLocation basketButtonsLocation}.
1633
+ *
1634
+ * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on
1635
+ * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right),
1636
+ * values are "Begin", "Middle" and "End".
1637
+ *
1638
+ * Default value is `"End"`.
1639
+ *
1640
+ * @since 1.143.0
1641
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1642
+ *
1643
+ * @returns Value of property `basketButtonsLocation`
1644
+ */
1645
+ getBasketButtonsLocation(): string;
1646
+ /**
1647
+ * Gets current value of property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}.
1648
+ *
1649
+ * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
1650
+ * Moreover all items of the basket are automatically selected on result views, if they are visible on the
1651
+ * current result view page.
1652
+ *
1653
+ * Default value is `false`.
1654
+ *
1655
+ * @since 1.143.0
1656
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1657
+ *
1658
+ * @returns Value of property `basketLinkByResultViewItemSelection`
1659
+ */
1660
+ getBasketLinkByResultViewItemSelection(): boolean;
1661
+ /**
1662
+ * Gets current value of property {@link #getBasketPanelResizable basketPanelResizable}.
1663
+ *
1664
+ * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
1665
+ *
1666
+ * Default value is `true`.
1667
+ *
1668
+ * @since 1.108.0
1669
+ *
1670
+ * @returns Value of property `basketPanelResizable`
1671
+ */
1672
+ getBasketPanelResizable(): boolean;
1673
+ /**
1674
+ * Gets current value of property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}.
1675
+ *
1676
+ * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
1677
+ * is true, the width of the basket panel can be changed by the user.
1678
+ *
1679
+ * Default value is `25`.
1680
+ *
1681
+ * @since 1.142.0
1682
+ *
1683
+ * @returns Value of property `basketPanelWidthInPercent`
1684
+ */
1685
+ getBasketPanelWidthInPercent(): float;
1686
+ /**
1687
+ * Gets current value of property {@link #getBasketShowHideButton basketShowHideButton}.
1688
+ *
1689
+ * Enables the basket toggle button in the search result list. The button is displayed on the top of search
1690
+ * result view and allows to toggle visibility of the basket ('selected' result list items).
1691
+ *
1692
+ * Default value is `false`.
1693
+ *
1694
+ * @since 1.143.0
1695
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1696
+ *
1697
+ * @returns Value of property `basketShowHideButton`
1698
+ */
1699
+ getBasketShowHideButton(): boolean;
1292
1700
  /**
1293
1701
  * Gets current value of property {@link #getBoSuggestions boSuggestions}.
1294
1702
  *
@@ -1459,7 +1867,7 @@ declare namespace sap {
1459
1867
  * Default value is `"Begin"`.
1460
1868
  *
1461
1869
  * @since 1.140.0
1462
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
1870
+ * @experimental As of version 1.140.0.
1463
1871
  *
1464
1872
  * @returns Value of property `facetToggleButtonLocation`
1465
1873
  */
@@ -1777,16 +2185,25 @@ declare namespace sap {
1777
2185
  * @returns Value of property `resultViewTypes`
1778
2186
  */
1779
2187
  getResultViewTypes(): string[];
2188
+ /**
2189
+ * Gets current value of property {@link #getSearchBarTitle searchBarTitle}.
2190
+ *
2191
+ * Show a text/title at the start(left) of the search bar.
2192
+ *
2193
+ *
2194
+ * @returns Value of property `searchBarTitle`
2195
+ */
2196
+ getSearchBarTitle(): string;
1780
2197
  /**
1781
2198
  * Gets current value of property {@link #getSearchInputLocation searchInputLocation}.
1782
2199
  *
1783
2200
  * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
1784
- * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
2201
+ * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
1785
2202
  *
1786
2203
  * Default value is `"Top"`.
1787
2204
  *
1788
2205
  * @since 1.140.0
1789
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2206
+ * @experimental As of version 1.140.0.
1790
2207
  *
1791
2208
  * @returns Value of property `searchInputLocation`
1792
2209
  */
@@ -1804,6 +2221,19 @@ declare namespace sap {
1804
2221
  * @returns Value of property `searchOnStart`
1805
2222
  */
1806
2223
  getSearchOnStart(): boolean;
2224
+ /**
2225
+ * Gets current value of property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}.
2226
+ *
2227
+ * Set default number of visible columns of search result table. This is important when adding custom columns
2228
+ * by means of formatters.
2229
+ *
2230
+ * Default value is `6`.
2231
+ *
2232
+ * @since 1.142.0
2233
+ *
2234
+ * @returns Value of property `searchResultTableMaxNumberOfInitiallyVisibleColumns`
2235
+ */
2236
+ getSearchResultTableMaxNumberOfInitiallyVisibleColumns(): float;
1807
2237
  /**
1808
2238
  * Gets current value of property {@link #getSearchTerm searchTerm}.
1809
2239
  *
@@ -1833,7 +2263,7 @@ declare namespace sap {
1833
2263
  * A callback which is called whenever the selection of result view items changes.
1834
2264
  *
1835
2265
  * @since 1.113.0
1836
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
2266
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
1837
2267
  *
1838
2268
  * @returns Value of property `selectionChange`
1839
2269
  */
@@ -1975,6 +2405,186 @@ declare namespace sap {
1975
2405
  */
1976
2406
  bAutoAdjustResultViewTypeInFolderMode?: boolean
1977
2407
  ): this;
2408
+ /**
2409
+ * Sets a new value for property {@link #getBasketAddButton basketAddButton}.
2410
+ *
2411
+ * Enables the basket add button in the search result list. The button is displayed on the top of search
2412
+ * result view and allows to add result view items to the basket.
2413
+ *
2414
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2415
+ *
2416
+ * Default value is `false`.
2417
+ *
2418
+ * @since 1.143.0
2419
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2420
+ *
2421
+ * @returns Reference to `this` in order to allow method chaining
2422
+ */
2423
+ setBasketAddButton(
2424
+ /**
2425
+ * New value for property `basketAddButton`
2426
+ */
2427
+ bBasketAddButton?: boolean
2428
+ ): this;
2429
+ /**
2430
+ * Sets a new value for property {@link #getBasketAddButtonIcon basketAddButtonIcon}.
2431
+ *
2432
+ * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
2433
+ *
2434
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2435
+ *
2436
+ * @since 1.143.0
2437
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2438
+ *
2439
+ * @returns Reference to `this` in order to allow method chaining
2440
+ */
2441
+ setBasketAddButtonIcon(
2442
+ /**
2443
+ * New value for property `basketAddButtonIcon`
2444
+ */
2445
+ sBasketAddButtonIcon: string
2446
+ ): this;
2447
+ /**
2448
+ * Sets a new value for property {@link #getBasketAddButtonText basketAddButtonText}.
2449
+ *
2450
+ * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
2451
+ * icon, only.
2452
+ *
2453
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2454
+ *
2455
+ * @since 1.143.0
2456
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2457
+ *
2458
+ * @returns Reference to `this` in order to allow method chaining
2459
+ */
2460
+ setBasketAddButtonText(
2461
+ /**
2462
+ * New value for property `basketAddButtonText`
2463
+ */
2464
+ sBasketAddButtonText: string
2465
+ ): this;
2466
+ /**
2467
+ * Sets a new value for property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
2468
+ *
2469
+ * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
2470
+ *
2471
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2472
+ *
2473
+ * @since 1.143.0
2474
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2475
+ *
2476
+ * @returns Reference to `this` in order to allow method chaining
2477
+ */
2478
+ setBasketAddButtonTooltip(
2479
+ /**
2480
+ * New value for property `basketAddButtonTooltip`
2481
+ */
2482
+ sBasketAddButtonTooltip: string
2483
+ ): this;
2484
+ /**
2485
+ * Sets a new value for property {@link #getBasketButtonsLocation basketButtonsLocation}.
2486
+ *
2487
+ * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on
2488
+ * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right),
2489
+ * values are "Begin", "Middle" and "End".
2490
+ *
2491
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2492
+ *
2493
+ * Default value is `"End"`.
2494
+ *
2495
+ * @since 1.143.0
2496
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2497
+ *
2498
+ * @returns Reference to `this` in order to allow method chaining
2499
+ */
2500
+ setBasketButtonsLocation(
2501
+ /**
2502
+ * New value for property `basketButtonsLocation`
2503
+ */
2504
+ sBasketButtonsLocation?: string
2505
+ ): this;
2506
+ /**
2507
+ * Sets a new value for property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}.
2508
+ *
2509
+ * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
2510
+ * Moreover all items of the basket are automatically selected on result views, if they are visible on the
2511
+ * current result view page.
2512
+ *
2513
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2514
+ *
2515
+ * Default value is `false`.
2516
+ *
2517
+ * @since 1.143.0
2518
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2519
+ *
2520
+ * @returns Reference to `this` in order to allow method chaining
2521
+ */
2522
+ setBasketLinkByResultViewItemSelection(
2523
+ /**
2524
+ * New value for property `basketLinkByResultViewItemSelection`
2525
+ */
2526
+ bBasketLinkByResultViewItemSelection?: boolean
2527
+ ): this;
2528
+ /**
2529
+ * Sets a new value for property {@link #getBasketPanelResizable basketPanelResizable}.
2530
+ *
2531
+ * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
2532
+ *
2533
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2534
+ *
2535
+ * Default value is `true`.
2536
+ *
2537
+ * @since 1.108.0
2538
+ *
2539
+ * @returns Reference to `this` in order to allow method chaining
2540
+ */
2541
+ setBasketPanelResizable(
2542
+ /**
2543
+ * New value for property `basketPanelResizable`
2544
+ */
2545
+ bBasketPanelResizable?: boolean
2546
+ ): this;
2547
+ /**
2548
+ * Sets a new value for property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}.
2549
+ *
2550
+ * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
2551
+ * is true, the width of the basket panel can be changed by the user.
2552
+ *
2553
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2554
+ *
2555
+ * Default value is `25`.
2556
+ *
2557
+ * @since 1.142.0
2558
+ *
2559
+ * @returns Reference to `this` in order to allow method chaining
2560
+ */
2561
+ setBasketPanelWidthInPercent(
2562
+ /**
2563
+ * New value for property `basketPanelWidthInPercent`
2564
+ */
2565
+ fBasketPanelWidthInPercent?: float
2566
+ ): this;
2567
+ /**
2568
+ * Sets a new value for property {@link #getBasketShowHideButton basketShowHideButton}.
2569
+ *
2570
+ * Enables the basket toggle button in the search result list. The button is displayed on the top of search
2571
+ * result view and allows to toggle visibility of the basket ('selected' result list items).
2572
+ *
2573
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2574
+ *
2575
+ * Default value is `false`.
2576
+ *
2577
+ * @since 1.143.0
2578
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2579
+ *
2580
+ * @returns Reference to `this` in order to allow method chaining
2581
+ */
2582
+ setBasketShowHideButton(
2583
+ /**
2584
+ * New value for property `basketShowHideButton`
2585
+ */
2586
+ bBasketShowHideButton?: boolean
2587
+ ): this;
1978
2588
  /**
1979
2589
  * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
1980
2590
  *
@@ -2238,7 +2848,7 @@ declare namespace sap {
2238
2848
  * Default value is `"Begin"`.
2239
2849
  *
2240
2850
  * @since 1.140.0
2241
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2851
+ * @experimental As of version 1.140.0.
2242
2852
  *
2243
2853
  * @returns Reference to `this` in order to allow method chaining
2244
2854
  */
@@ -2710,18 +3320,34 @@ declare namespace sap {
2710
3320
  */
2711
3321
  sResultViewTypes?: string[]
2712
3322
  ): this;
3323
+ /**
3324
+ * Sets a new value for property {@link #getSearchBarTitle searchBarTitle}.
3325
+ *
3326
+ * Show a text/title at the start(left) of the search bar.
3327
+ *
3328
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3329
+ *
3330
+ *
3331
+ * @returns Reference to `this` in order to allow method chaining
3332
+ */
3333
+ setSearchBarTitle(
3334
+ /**
3335
+ * New value for property `searchBarTitle`
3336
+ */
3337
+ sSearchBarTitle: string
3338
+ ): this;
2713
3339
  /**
2714
3340
  * Sets a new value for property {@link #getSearchInputLocation searchInputLocation}.
2715
3341
  *
2716
3342
  * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
2717
- * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
3343
+ * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
2718
3344
  *
2719
3345
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2720
3346
  *
2721
3347
  * Default value is `"Top"`.
2722
3348
  *
2723
3349
  * @since 1.140.0
2724
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
3350
+ * @experimental As of version 1.140.0.
2725
3351
  *
2726
3352
  * @returns Reference to `this` in order to allow method chaining
2727
3353
  */
@@ -2751,6 +3377,26 @@ declare namespace sap {
2751
3377
  */
2752
3378
  bSearchOnStart?: boolean
2753
3379
  ): this;
3380
+ /**
3381
+ * Sets a new value for property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}.
3382
+ *
3383
+ * Set default number of visible columns of search result table. This is important when adding custom columns
3384
+ * by means of formatters.
3385
+ *
3386
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3387
+ *
3388
+ * Default value is `6`.
3389
+ *
3390
+ * @since 1.142.0
3391
+ *
3392
+ * @returns Reference to `this` in order to allow method chaining
3393
+ */
3394
+ setSearchResultTableMaxNumberOfInitiallyVisibleColumns(
3395
+ /**
3396
+ * New value for property `searchResultTableMaxNumberOfInitiallyVisibleColumns`
3397
+ */
3398
+ fSearchResultTableMaxNumberOfInitiallyVisibleColumns?: float
3399
+ ): this;
2754
3400
  /**
2755
3401
  * Sets a new value for property {@link #getSearchTerm searchTerm}.
2756
3402
  *
@@ -2796,7 +3442,7 @@ declare namespace sap {
2796
3442
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2797
3443
  *
2798
3444
  * @since 1.113.0
2799
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
3445
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
2800
3446
  *
2801
3447
  * @returns Reference to `this` in order to allow method chaining
2802
3448
  */
@@ -2891,6 +3537,15 @@ declare namespace sap {
2891
3537
  updateStaticHierarchyFacet(): Promise<void>;
2892
3538
  }
2893
3539
 
3540
+ /**
3541
+ * Event object of the SearchCompositeControl#resultViewSelectionChanged event.
3542
+ */
3543
+ type SearchCompositeControl$ResultViewSelectionChangedEvent =
3544
+ sap.ui.base.Event<
3545
+ SearchCompositeControl$ResultViewSelectionChangedEventParameters,
3546
+ SearchCompositeControl
3547
+ >;
3548
+
2894
3549
  /**
2895
3550
  * Event object of the SearchCompositeControl#resultViewTypeChanged event.
2896
3551
  */
@@ -2936,6 +3591,8 @@ declare namespace sap {
2936
3591
  }
2937
3592
 
2938
3593
  interface IUI5DefineDependencyNames {
3594
+ "sap/esh/search/ui/controls/basket/SearchBasketAddButton": undefined;
3595
+
2939
3596
  "sap/esh/search/ui/controls/resultview/SearchText": undefined;
2940
3597
 
2941
3598
  "sap/esh/search/ui/controls/SearchLink": undefined;