@sapui5/types 1.142.0 → 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 +651 -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 +40 -78
  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 +167 -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 +62 -47
  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 +27255 -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 +529 -125
  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 +55 -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 -8
  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 module "sap/esh/search/ui/SearchCompositeControl" {
4
4
  import {
@@ -89,6 +89,59 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
89
89
  * @returns Metadata object describing this class
90
90
  */
91
91
  static getMetadata(): ElementMetadata;
92
+ /**
93
+ * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
94
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
95
+ *
96
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
97
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
98
+ *
99
+ * Event is fired when selection on result view (list, table or grid) has changed.
100
+ *
101
+ * @since 1.143
102
+ *
103
+ * @returns Reference to `this` in order to allow method chaining
104
+ */
105
+ attachResultViewSelectionChanged(
106
+ /**
107
+ * An application-specific payload object that will be passed to the event handler along with the event
108
+ * object when firing the event
109
+ */
110
+ oData: object,
111
+ /**
112
+ * The function to be called when the event occurs
113
+ */
114
+ fnFunction: (p1: Event) => void,
115
+ /**
116
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
117
+ * itself
118
+ */
119
+ oListener?: object
120
+ ): this;
121
+ /**
122
+ * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
123
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
124
+ *
125
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
126
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
127
+ *
128
+ * Event is fired when selection on result view (list, table or grid) has changed.
129
+ *
130
+ * @since 1.143
131
+ *
132
+ * @returns Reference to `this` in order to allow method chaining
133
+ */
134
+ attachResultViewSelectionChanged(
135
+ /**
136
+ * The function to be called when the event occurs
137
+ */
138
+ fnFunction: (p1: Event) => void,
139
+ /**
140
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
141
+ * itself
142
+ */
143
+ oListener?: object
144
+ ): this;
92
145
  /**
93
146
  * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
94
147
  * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -354,6 +407,26 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
354
407
  */
355
408
  oListener?: object
356
409
  ): this;
410
+ /**
411
+ * Detaches event handler `fnFunction` from the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
412
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
413
+ *
414
+ * The passed function and listener object must match the ones used for event registration.
415
+ *
416
+ * @since 1.143
417
+ *
418
+ * @returns Reference to `this` in order to allow method chaining
419
+ */
420
+ detachResultViewSelectionChanged(
421
+ /**
422
+ * The function to be called, when the event occurs
423
+ */
424
+ fnFunction: (p1: Event) => void,
425
+ /**
426
+ * Context object on which the given function had to be called
427
+ */
428
+ oListener?: object
429
+ ): this;
357
430
  /**
358
431
  * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
359
432
  * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -454,6 +527,20 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
454
527
  */
455
528
  oListener?: object
456
529
  ): this;
530
+ /**
531
+ * Fires event {@link #event:resultViewSelectionChanged resultViewSelectionChanged} to attached listeners.
532
+ *
533
+ * @since 1.143
534
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
535
+ *
536
+ * @returns Reference to `this` in order to allow method chaining
537
+ */
538
+ fireResultViewSelectionChanged(
539
+ /**
540
+ * Parameters to pass along with the event
541
+ */
542
+ mParameters?: object
543
+ ): this;
457
544
  /**
458
545
  * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
459
546
  *
@@ -549,6 +636,123 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
549
636
  * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
550
637
  */
551
638
  getAutoAdjustResultViewTypeInFolderMode(): boolean;
639
+ /**
640
+ * Gets current value of property {@link #getBasketAddButton basketAddButton}.
641
+ *
642
+ * Enables the basket add button in the search result list. The button is displayed on the top of search
643
+ * result view and allows to add result view items to the basket.
644
+ *
645
+ * Default value is `false`.
646
+ *
647
+ * @since 1.143.0
648
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
649
+ *
650
+ * @returns Value of property `basketAddButton`
651
+ */
652
+ getBasketAddButton(): boolean;
653
+ /**
654
+ * Gets current value of property {@link #getBasketAddButtonIcon basketAddButtonIcon}.
655
+ *
656
+ * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
657
+ *
658
+ * @since 1.143.0
659
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
660
+ *
661
+ * @returns Value of property `basketAddButtonIcon`
662
+ */
663
+ getBasketAddButtonIcon(): string;
664
+ /**
665
+ * Gets current value of property {@link #getBasketAddButtonText basketAddButtonText}.
666
+ *
667
+ * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
668
+ * icon, only.
669
+ *
670
+ * @since 1.143.0
671
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
672
+ *
673
+ * @returns Value of property `basketAddButtonText`
674
+ */
675
+ getBasketAddButtonText(): string;
676
+ /**
677
+ * Gets current value of property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
678
+ *
679
+ * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
680
+ *
681
+ * @since 1.143.0
682
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
683
+ *
684
+ * @returns Value of property `basketAddButtonTooltip`
685
+ */
686
+ getBasketAddButtonTooltip(): string;
687
+ /**
688
+ * Gets current value of property {@link #getBasketButtonsLocation basketButtonsLocation}.
689
+ *
690
+ * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on
691
+ * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right),
692
+ * values are "Begin", "Middle" and "End".
693
+ *
694
+ * Default value is `"End"`.
695
+ *
696
+ * @since 1.143.0
697
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
698
+ *
699
+ * @returns Value of property `basketButtonsLocation`
700
+ */
701
+ getBasketButtonsLocation(): string;
702
+ /**
703
+ * Gets current value of property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}.
704
+ *
705
+ * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
706
+ * Moreover all items of the basket are automatically selected on result views, if they are visible on the
707
+ * current result view page.
708
+ *
709
+ * Default value is `false`.
710
+ *
711
+ * @since 1.143.0
712
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
713
+ *
714
+ * @returns Value of property `basketLinkByResultViewItemSelection`
715
+ */
716
+ getBasketLinkByResultViewItemSelection(): boolean;
717
+ /**
718
+ * Gets current value of property {@link #getBasketPanelResizable basketPanelResizable}.
719
+ *
720
+ * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
721
+ *
722
+ * Default value is `true`.
723
+ *
724
+ * @since 1.108.0
725
+ *
726
+ * @returns Value of property `basketPanelResizable`
727
+ */
728
+ getBasketPanelResizable(): boolean;
729
+ /**
730
+ * Gets current value of property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}.
731
+ *
732
+ * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
733
+ * is true, the width of the basket panel can be changed by the user.
734
+ *
735
+ * Default value is `25`.
736
+ *
737
+ * @since 1.142.0
738
+ *
739
+ * @returns Value of property `basketPanelWidthInPercent`
740
+ */
741
+ getBasketPanelWidthInPercent(): float;
742
+ /**
743
+ * Gets current value of property {@link #getBasketShowHideButton basketShowHideButton}.
744
+ *
745
+ * Enables the basket toggle button in the search result list. The button is displayed on the top of search
746
+ * result view and allows to toggle visibility of the basket ('selected' result list items).
747
+ *
748
+ * Default value is `false`.
749
+ *
750
+ * @since 1.143.0
751
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
752
+ *
753
+ * @returns Value of property `basketShowHideButton`
754
+ */
755
+ getBasketShowHideButton(): boolean;
552
756
  /**
553
757
  * Gets current value of property {@link #getBoSuggestions boSuggestions}.
554
758
  *
@@ -719,7 +923,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
719
923
  * Default value is `"Begin"`.
720
924
  *
721
925
  * @since 1.140.0
722
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
926
+ * @experimental As of version 1.140.0.
723
927
  *
724
928
  * @returns Value of property `facetToggleButtonLocation`
725
929
  */
@@ -1037,16 +1241,25 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1037
1241
  * @returns Value of property `resultViewTypes`
1038
1242
  */
1039
1243
  getResultViewTypes(): string[];
1244
+ /**
1245
+ * Gets current value of property {@link #getSearchBarTitle searchBarTitle}.
1246
+ *
1247
+ * Show a text/title at the start(left) of the search bar.
1248
+ *
1249
+ *
1250
+ * @returns Value of property `searchBarTitle`
1251
+ */
1252
+ getSearchBarTitle(): string;
1040
1253
  /**
1041
1254
  * Gets current value of property {@link #getSearchInputLocation searchInputLocation}.
1042
1255
  *
1043
1256
  * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
1044
- * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
1257
+ * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
1045
1258
  *
1046
1259
  * Default value is `"Top"`.
1047
1260
  *
1048
1261
  * @since 1.140.0
1049
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
1262
+ * @experimental As of version 1.140.0.
1050
1263
  *
1051
1264
  * @returns Value of property `searchInputLocation`
1052
1265
  */
@@ -1064,6 +1277,19 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1064
1277
  * @returns Value of property `searchOnStart`
1065
1278
  */
1066
1279
  getSearchOnStart(): boolean;
1280
+ /**
1281
+ * Gets current value of property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}.
1282
+ *
1283
+ * Set default number of visible columns of search result table. This is important when adding custom columns
1284
+ * by means of formatters.
1285
+ *
1286
+ * Default value is `6`.
1287
+ *
1288
+ * @since 1.142.0
1289
+ *
1290
+ * @returns Value of property `searchResultTableMaxNumberOfInitiallyVisibleColumns`
1291
+ */
1292
+ getSearchResultTableMaxNumberOfInitiallyVisibleColumns(): float;
1067
1293
  /**
1068
1294
  * Gets current value of property {@link #getSearchTerm searchTerm}.
1069
1295
  *
@@ -1093,7 +1319,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1093
1319
  * A callback which is called whenever the selection of result view items changes.
1094
1320
  *
1095
1321
  * @since 1.113.0
1096
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
1322
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
1097
1323
  *
1098
1324
  * @returns Value of property `selectionChange`
1099
1325
  */
@@ -1235,6 +1461,186 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1235
1461
  */
1236
1462
  bAutoAdjustResultViewTypeInFolderMode?: boolean
1237
1463
  ): this;
1464
+ /**
1465
+ * Sets a new value for property {@link #getBasketAddButton basketAddButton}.
1466
+ *
1467
+ * Enables the basket add button in the search result list. The button is displayed on the top of search
1468
+ * result view and allows to add result view items to the basket.
1469
+ *
1470
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1471
+ *
1472
+ * Default value is `false`.
1473
+ *
1474
+ * @since 1.143.0
1475
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1476
+ *
1477
+ * @returns Reference to `this` in order to allow method chaining
1478
+ */
1479
+ setBasketAddButton(
1480
+ /**
1481
+ * New value for property `basketAddButton`
1482
+ */
1483
+ bBasketAddButton?: boolean
1484
+ ): this;
1485
+ /**
1486
+ * Sets a new value for property {@link #getBasketAddButtonIcon basketAddButtonIcon}.
1487
+ *
1488
+ * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
1489
+ *
1490
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1491
+ *
1492
+ * @since 1.143.0
1493
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1494
+ *
1495
+ * @returns Reference to `this` in order to allow method chaining
1496
+ */
1497
+ setBasketAddButtonIcon(
1498
+ /**
1499
+ * New value for property `basketAddButtonIcon`
1500
+ */
1501
+ sBasketAddButtonIcon: string
1502
+ ): this;
1503
+ /**
1504
+ * Sets a new value for property {@link #getBasketAddButtonText basketAddButtonText}.
1505
+ *
1506
+ * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
1507
+ * icon, only.
1508
+ *
1509
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1510
+ *
1511
+ * @since 1.143.0
1512
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1513
+ *
1514
+ * @returns Reference to `this` in order to allow method chaining
1515
+ */
1516
+ setBasketAddButtonText(
1517
+ /**
1518
+ * New value for property `basketAddButtonText`
1519
+ */
1520
+ sBasketAddButtonText: string
1521
+ ): this;
1522
+ /**
1523
+ * Sets a new value for property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
1524
+ *
1525
+ * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
1526
+ *
1527
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1528
+ *
1529
+ * @since 1.143.0
1530
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1531
+ *
1532
+ * @returns Reference to `this` in order to allow method chaining
1533
+ */
1534
+ setBasketAddButtonTooltip(
1535
+ /**
1536
+ * New value for property `basketAddButtonTooltip`
1537
+ */
1538
+ sBasketAddButtonTooltip: string
1539
+ ): this;
1540
+ /**
1541
+ * Sets a new value for property {@link #getBasketButtonsLocation basketButtonsLocation}.
1542
+ *
1543
+ * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on
1544
+ * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right),
1545
+ * values are "Begin", "Middle" and "End".
1546
+ *
1547
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1548
+ *
1549
+ * Default value is `"End"`.
1550
+ *
1551
+ * @since 1.143.0
1552
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1553
+ *
1554
+ * @returns Reference to `this` in order to allow method chaining
1555
+ */
1556
+ setBasketButtonsLocation(
1557
+ /**
1558
+ * New value for property `basketButtonsLocation`
1559
+ */
1560
+ sBasketButtonsLocation?: string
1561
+ ): this;
1562
+ /**
1563
+ * Sets a new value for property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}.
1564
+ *
1565
+ * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
1566
+ * Moreover all items of the basket are automatically selected on result views, if they are visible on the
1567
+ * current result view page.
1568
+ *
1569
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1570
+ *
1571
+ * Default value is `false`.
1572
+ *
1573
+ * @since 1.143.0
1574
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1575
+ *
1576
+ * @returns Reference to `this` in order to allow method chaining
1577
+ */
1578
+ setBasketLinkByResultViewItemSelection(
1579
+ /**
1580
+ * New value for property `basketLinkByResultViewItemSelection`
1581
+ */
1582
+ bBasketLinkByResultViewItemSelection?: boolean
1583
+ ): this;
1584
+ /**
1585
+ * Sets a new value for property {@link #getBasketPanelResizable basketPanelResizable}.
1586
+ *
1587
+ * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
1588
+ *
1589
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1590
+ *
1591
+ * Default value is `true`.
1592
+ *
1593
+ * @since 1.108.0
1594
+ *
1595
+ * @returns Reference to `this` in order to allow method chaining
1596
+ */
1597
+ setBasketPanelResizable(
1598
+ /**
1599
+ * New value for property `basketPanelResizable`
1600
+ */
1601
+ bBasketPanelResizable?: boolean
1602
+ ): this;
1603
+ /**
1604
+ * Sets a new value for property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}.
1605
+ *
1606
+ * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
1607
+ * is true, the width of the basket panel can be changed by the user.
1608
+ *
1609
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1610
+ *
1611
+ * Default value is `25`.
1612
+ *
1613
+ * @since 1.142.0
1614
+ *
1615
+ * @returns Reference to `this` in order to allow method chaining
1616
+ */
1617
+ setBasketPanelWidthInPercent(
1618
+ /**
1619
+ * New value for property `basketPanelWidthInPercent`
1620
+ */
1621
+ fBasketPanelWidthInPercent?: float
1622
+ ): this;
1623
+ /**
1624
+ * Sets a new value for property {@link #getBasketShowHideButton basketShowHideButton}.
1625
+ *
1626
+ * Enables the basket toggle button in the search result list. The button is displayed on the top of search
1627
+ * result view and allows to toggle visibility of the basket ('selected' result list items).
1628
+ *
1629
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1630
+ *
1631
+ * Default value is `false`.
1632
+ *
1633
+ * @since 1.143.0
1634
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1635
+ *
1636
+ * @returns Reference to `this` in order to allow method chaining
1637
+ */
1638
+ setBasketShowHideButton(
1639
+ /**
1640
+ * New value for property `basketShowHideButton`
1641
+ */
1642
+ bBasketShowHideButton?: boolean
1643
+ ): this;
1238
1644
  /**
1239
1645
  * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
1240
1646
  *
@@ -1498,7 +1904,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1498
1904
  * Default value is `"Begin"`.
1499
1905
  *
1500
1906
  * @since 1.140.0
1501
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
1907
+ * @experimental As of version 1.140.0.
1502
1908
  *
1503
1909
  * @returns Reference to `this` in order to allow method chaining
1504
1910
  */
@@ -1970,18 +2376,34 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1970
2376
  */
1971
2377
  sResultViewTypes?: string[]
1972
2378
  ): this;
2379
+ /**
2380
+ * Sets a new value for property {@link #getSearchBarTitle searchBarTitle}.
2381
+ *
2382
+ * Show a text/title at the start(left) of the search bar.
2383
+ *
2384
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2385
+ *
2386
+ *
2387
+ * @returns Reference to `this` in order to allow method chaining
2388
+ */
2389
+ setSearchBarTitle(
2390
+ /**
2391
+ * New value for property `searchBarTitle`
2392
+ */
2393
+ sSearchBarTitle: string
2394
+ ): this;
1973
2395
  /**
1974
2396
  * Sets a new value for property {@link #getSearchInputLocation searchInputLocation}.
1975
2397
  *
1976
2398
  * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
1977
- * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
2399
+ * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
1978
2400
  *
1979
2401
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1980
2402
  *
1981
2403
  * Default value is `"Top"`.
1982
2404
  *
1983
2405
  * @since 1.140.0
1984
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2406
+ * @experimental As of version 1.140.0.
1985
2407
  *
1986
2408
  * @returns Reference to `this` in order to allow method chaining
1987
2409
  */
@@ -2011,6 +2433,26 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2011
2433
  */
2012
2434
  bSearchOnStart?: boolean
2013
2435
  ): this;
2436
+ /**
2437
+ * Sets a new value for property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}.
2438
+ *
2439
+ * Set default number of visible columns of search result table. This is important when adding custom columns
2440
+ * by means of formatters.
2441
+ *
2442
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2443
+ *
2444
+ * Default value is `6`.
2445
+ *
2446
+ * @since 1.142.0
2447
+ *
2448
+ * @returns Reference to `this` in order to allow method chaining
2449
+ */
2450
+ setSearchResultTableMaxNumberOfInitiallyVisibleColumns(
2451
+ /**
2452
+ * New value for property `searchResultTableMaxNumberOfInitiallyVisibleColumns`
2453
+ */
2454
+ fSearchResultTableMaxNumberOfInitiallyVisibleColumns?: float
2455
+ ): this;
2014
2456
  /**
2015
2457
  * Sets a new value for property {@link #getSearchTerm searchTerm}.
2016
2458
  *
@@ -2056,7 +2498,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2056
2498
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2057
2499
  *
2058
2500
  * @since 1.113.0
2059
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
2501
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
2060
2502
  *
2061
2503
  * @returns Reference to `this` in order to allow method chaining
2062
2504
  */
@@ -2264,6 +2706,17 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2264
2706
  */
2265
2707
  resultviewMasterDetailMode?: boolean | PropertyBindingInfo | `{${string}}`;
2266
2708
 
2709
+ /**
2710
+ * Set default number of visible columns of search result table. This is important when adding custom columns
2711
+ * by means of formatters.
2712
+ *
2713
+ * @since 1.142.0
2714
+ */
2715
+ searchResultTableMaxNumberOfInitiallyVisibleColumns?:
2716
+ | float
2717
+ | PropertyBindingInfo
2718
+ | `{${string}}`;
2719
+
2267
2720
  /**
2268
2721
  * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
2269
2722
  * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
@@ -2338,6 +2791,21 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2338
2791
  */
2339
2792
  facetPanelWidthInPercent?: float | PropertyBindingInfo | `{${string}}`;
2340
2793
 
2794
+ /**
2795
+ * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
2796
+ *
2797
+ * @since 1.108.0
2798
+ */
2799
+ basketPanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
2800
+
2801
+ /**
2802
+ * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
2803
+ * is true, the width of the basket panel can be changed by the user.
2804
+ *
2805
+ * @since 1.142.0
2806
+ */
2807
+ basketPanelWidthInPercent?: float | PropertyBindingInfo | `{${string}}`;
2808
+
2341
2809
  /**
2342
2810
  * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
2343
2811
  * to be more specific and add some hints, links, buttons or other content.
@@ -2357,10 +2825,10 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2357
2825
 
2358
2826
  /**
2359
2827
  * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
2360
- * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
2828
+ * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
2361
2829
  *
2362
2830
  * @since 1.140.0
2363
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2831
+ * @experimental As of version 1.140.0.
2364
2832
  */
2365
2833
  searchInputLocation?: string | PropertyBindingInfo;
2366
2834
 
@@ -2396,6 +2864,11 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2396
2864
  */
2397
2865
  filterDataSources?: Function | PropertyBindingInfo | `{${string}}`;
2398
2866
 
2867
+ /**
2868
+ * Show a text/title at the start(left) of the search bar.
2869
+ */
2870
+ searchBarTitle?: string | PropertyBindingInfo;
2871
+
2399
2872
  /**
2400
2873
  * Controls whether the facet functionality is available or not.
2401
2874
  *
@@ -2419,10 +2892,58 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2419
2892
  * 'facets'.
2420
2893
  *
2421
2894
  * @since 1.140.0
2422
- * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2895
+ * @experimental As of version 1.140.0.
2423
2896
  */
2424
2897
  facetToggleButtonLocation?: string | PropertyBindingInfo;
2425
2898
 
2899
+ /**
2900
+ * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on
2901
+ * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right),
2902
+ * values are "Begin", "Middle" and "End".
2903
+ *
2904
+ * @since 1.143.0
2905
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2906
+ */
2907
+ basketButtonsLocation?: string | PropertyBindingInfo;
2908
+
2909
+ /**
2910
+ * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
2911
+ * Moreover all items of the basket are automatically selected on result views, if they are visible on the
2912
+ * current result view page.
2913
+ *
2914
+ * @since 1.143.0
2915
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2916
+ */
2917
+ basketLinkByResultViewItemSelection?:
2918
+ | boolean
2919
+ | PropertyBindingInfo
2920
+ | `{${string}}`;
2921
+
2922
+ /**
2923
+ * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
2924
+ *
2925
+ * @since 1.143.0
2926
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2927
+ */
2928
+ basketAddButtonIcon?: string | PropertyBindingInfo;
2929
+
2930
+ /**
2931
+ * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
2932
+ * icon, only.
2933
+ *
2934
+ * @since 1.143.0
2935
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2936
+ */
2937
+ basketAddButtonText?: string | PropertyBindingInfo;
2938
+
2939
+ /**
2940
+ * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
2941
+ *
2942
+ * @since 1.143.0
2943
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2944
+ */
2945
+ basketAddButtonTooltip?: string | PropertyBindingInfo;
2946
+
2426
2947
  /**
2427
2948
  * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can
2428
2949
  * be viewed as a pie or bar chart (this cannot be deactivated at runtime).
@@ -2494,7 +3015,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2494
3015
  * A callback which is called whenever the selection of result view items changes.
2495
3016
  *
2496
3017
  * @since 1.113.0
2497
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
3018
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChanged'.
2498
3019
  */
2499
3020
  selectionChange?: Function | PropertyBindingInfo | `{${string}}`;
2500
3021
 
@@ -2537,6 +3058,24 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2537
3058
  */
2538
3059
  showSelectionToggleButton?: boolean | PropertyBindingInfo | `{${string}}`;
2539
3060
 
3061
+ /**
3062
+ * Enables the basket toggle button in the search result list. The button is displayed on the top of search
3063
+ * result view and allows to toggle visibility of the basket ('selected' result list items).
3064
+ *
3065
+ * @since 1.143.0
3066
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3067
+ */
3068
+ basketShowHideButton?: boolean | PropertyBindingInfo | `{${string}}`;
3069
+
3070
+ /**
3071
+ * Enables the basket add button in the search result list. The button is displayed on the top of search
3072
+ * result view and allows to add result view items to the basket.
3073
+ *
3074
+ * @since 1.143.0
3075
+ * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3076
+ */
3077
+ basketAddButton?: boolean | PropertyBindingInfo | `{${string}}`;
3078
+
2540
3079
  /**
2541
3080
  * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
2542
3081
  * button, another page of result items of the same count (if available) will be displayed.
@@ -2592,6 +3131,13 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2592
3131
  */
2593
3132
  searchFinished?: (oEvent: Event) => void;
2594
3133
 
3134
+ /**
3135
+ * Event is fired when selection on result view (list, table or grid) has changed.
3136
+ *
3137
+ * @since 1.143
3138
+ */
3139
+ resultViewSelectionChanged?: (oEvent: Event) => void;
3140
+
2595
3141
  /**
2596
3142
  * Event is fired when selection on result view (list, table or grid) has changed.
2597
3143
  *
@@ -2615,6 +3161,19 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2615
3161
  showResultDetail?: (oEvent: Event) => void;
2616
3162
  }
2617
3163
 
3164
+ /**
3165
+ * Parameters of the SearchCompositeControl#resultViewSelectionChanged event.
3166
+ */
3167
+ export interface SearchCompositeControl$ResultViewSelectionChangedEventParameters {}
3168
+
3169
+ /**
3170
+ * Event object of the SearchCompositeControl#resultViewSelectionChanged event.
3171
+ */
3172
+ export type SearchCompositeControl$ResultViewSelectionChangedEvent = Event<
3173
+ SearchCompositeControl$ResultViewSelectionChangedEventParameters,
3174
+ SearchCompositeControl
3175
+ >;
3176
+
2618
3177
  /**
2619
3178
  * Parameters of the SearchCompositeControl#resultViewTypeChanged event.
2620
3179
  */
@@ -2683,6 +3242,39 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2683
3242
 
2684
3243
  declare module "sap/esh/search/ui/library" {}
2685
3244
 
3245
+ declare module "sap/esh/search/ui/controls/basket/SearchBasketAddButton" {
3246
+ import {
3247
+ default as OverflowToolbarButton,
3248
+ $OverflowToolbarButtonSettings,
3249
+ } from "sap/m/OverflowToolbarButton";
3250
+
3251
+ /**
3252
+ * This is the SAPUI5 search basket button control to display a button to add result items to the search
3253
+ * basket. Use in combination with control SearchCompositeControl by the Enterprise Search Team.
3254
+ *
3255
+ * @since 1.93.0
3256
+ */
3257
+ export default class SearchBasketAddButton extends OverflowToolbarButton {
3258
+ /**
3259
+ * Constructs a new `SearchBasketAddButton` to display a button to add result items to the search basket.
3260
+ * See:
3261
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
3262
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
3263
+ */
3264
+ constructor(
3265
+ /**
3266
+ * ID for the new control, generated automatically if no ID is given
3267
+ */
3268
+ sId?: string
3269
+ );
3270
+ }
3271
+ /**
3272
+ * Describes the settings that can be provided to the SearchBasketAddButton constructor.
3273
+ */
3274
+ export interface $SearchBasketAddButtonSettings
3275
+ extends $OverflowToolbarButtonSettings {}
3276
+ }
3277
+
2686
3278
  declare module "sap/esh/search/ui/controls/resultview/SearchText" {
2687
3279
  import { default as Text, $TextSettings } from "sap/m/Text";
2688
3280
 
@@ -2789,6 +3381,19 @@ declare module "sap/esh/search/ui/controls/SearchLink" {
2789
3381
  * @returns Metadata object describing this class
2790
3382
  */
2791
3383
  static getMetadata(): ElementMetadata;
3384
+ /**
3385
+ * Gets current value of property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
3386
+ *
3387
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
3388
+ * function 'performNavigation' of item's navigationTarget do the job
3389
+ *
3390
+ * Default value is `false`.
3391
+ *
3392
+ * @since 1.143.0
3393
+ *
3394
+ * @returns Value of property `forceNavigationAnchorElementNotProcessed`
3395
+ */
3396
+ getForceNavigationAnchorElementNotProcessed(): boolean;
2792
3397
  /**
2793
3398
  * Gets current value of property {@link #getNavigationTarget navigationTarget}.
2794
3399
  *
@@ -2799,6 +3404,26 @@ declare module "sap/esh/search/ui/controls/SearchLink" {
2799
3404
  * @returns Value of property `navigationTarget`
2800
3405
  */
2801
3406
  getNavigationTarget(): object;
3407
+ /**
3408
+ * Sets a new value for property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
3409
+ *
3410
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
3411
+ * function 'performNavigation' of item's navigationTarget do the job
3412
+ *
3413
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3414
+ *
3415
+ * Default value is `false`.
3416
+ *
3417
+ * @since 1.143.0
3418
+ *
3419
+ * @returns Reference to `this` in order to allow method chaining
3420
+ */
3421
+ setForceNavigationAnchorElementNotProcessed(
3422
+ /**
3423
+ * New value for property `forceNavigationAnchorElementNotProcessed`
3424
+ */
3425
+ bForceNavigationAnchorElementNotProcessed?: boolean
3426
+ ): this;
2802
3427
  /**
2803
3428
  * Sets a new value for property {@link #getNavigationTarget navigationTarget}.
2804
3429
  *
@@ -2827,11 +3452,24 @@ declare module "sap/esh/search/ui/controls/SearchLink" {
2827
3452
  * @since 1.93.0
2828
3453
  */
2829
3454
  navigationTarget?: object | PropertyBindingInfo | `{${string}}`;
3455
+
3456
+ /**
3457
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
3458
+ * function 'performNavigation' of item's navigationTarget do the job
3459
+ *
3460
+ * @since 1.143.0
3461
+ */
3462
+ forceNavigationAnchorElementNotProcessed?:
3463
+ | boolean
3464
+ | PropertyBindingInfo
3465
+ | `{${string}}`;
2830
3466
  }
2831
3467
  }
2832
3468
 
2833
3469
  declare namespace sap {
2834
3470
  interface IUI5DefineDependencyNames {
3471
+ "sap/esh/search/ui/controls/basket/SearchBasketAddButton": undefined;
3472
+
2835
3473
  "sap/esh/search/ui/controls/resultview/SearchText": undefined;
2836
3474
 
2837
3475
  "sap/esh/search/ui/controls/SearchLink": undefined;