@sapui5/types 1.125.1 → 1.126.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +75 -89
- package/types/sap.cux.home.d.ts +336 -0
- package/types/sap.esh.search.ui.d.ts +65 -144
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.core.d.ts +13 -3
- package/types/sap.fe.macros.d.ts +156 -126
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +885 -21
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +510 -720
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +25 -8
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +89 -250
- package/types/sap.suite.ui.commons.d.ts +6 -5
- package/types/sap.suite.ui.generic.template.d.ts +4 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +1699 -1226
- package/types/sap.ui.core.d.ts +410 -291
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +2 -2
- package/types/sap.ui.fl.d.ts +7 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +26 -117
- package/types/sap.ui.layout.d.ts +43 -32
- package/types/sap.ui.mdc.d.ts +830 -2992
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +14 -3
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -153
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +16 -271
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +1 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +3 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.126.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
4
4
|
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
@@ -7,24 +7,21 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
7
7
|
|
|
8
8
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
9
9
|
|
|
10
|
-
import {
|
|
11
|
-
PropertyBindingInfo,
|
|
12
|
-
AggregationBindingInfo,
|
|
13
|
-
} from "sap/ui/base/ManagedObject";
|
|
10
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
14
11
|
|
|
15
12
|
/**
|
|
16
13
|
* Adds a callback function which is called whenever there is a user triggered event.
|
|
17
14
|
*
|
|
18
15
|
* @since 1.120.0
|
|
19
16
|
*/
|
|
20
|
-
export type eventConsumer = Function;
|
|
17
|
+
export type eventConsumer = () => Function;
|
|
21
18
|
|
|
22
19
|
/**
|
|
23
20
|
* This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
|
|
24
21
|
* Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
|
|
25
|
-
* a suggestion dropdown, a result
|
|
26
|
-
* facets and more. This control is ready to use with an enterprise search backend service
|
|
27
|
-
* deep
|
|
22
|
+
* a suggestion dropdown, a result view which can have different visualisation, including tiles, list and
|
|
23
|
+
* table, filtering facets and more. This control is ready to use with an enterprise search backend service
|
|
24
|
+
* but also allows deep extension to match requirements of adopting applications.
|
|
28
25
|
*
|
|
29
26
|
* @since 1.93.0
|
|
30
27
|
*/
|
|
@@ -89,18 +86,6 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
89
86
|
* @returns Metadata object describing this class
|
|
90
87
|
*/
|
|
91
88
|
static getMetadata(): ElementMetadata;
|
|
92
|
-
/**
|
|
93
|
-
* Adds some content to the aggregation {@link #getContent content}.
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
97
|
-
*/
|
|
98
|
-
addContent(
|
|
99
|
-
/**
|
|
100
|
-
* The content to add; if empty, nothing is inserted
|
|
101
|
-
*/
|
|
102
|
-
oContent: Control
|
|
103
|
-
): this;
|
|
104
89
|
/**
|
|
105
90
|
* Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
|
|
106
91
|
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
@@ -311,13 +296,6 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
311
296
|
*/
|
|
312
297
|
oListener?: object
|
|
313
298
|
): this;
|
|
314
|
-
/**
|
|
315
|
-
* Destroys all the content in the aggregation {@link #getContent content}.
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
319
|
-
*/
|
|
320
|
-
destroyContent(): this;
|
|
321
299
|
/**
|
|
322
300
|
* Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
|
|
323
301
|
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
@@ -491,12 +469,6 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
491
469
|
* @returns Value of property `boSuggestions`
|
|
492
470
|
*/
|
|
493
471
|
getBoSuggestions(): boolean;
|
|
494
|
-
/**
|
|
495
|
-
* Gets content of aggregation {@link #getContent content}.
|
|
496
|
-
*
|
|
497
|
-
* Control instances which are part of this composite control.
|
|
498
|
-
*/
|
|
499
|
-
getContent(): Control[];
|
|
500
472
|
/**
|
|
501
473
|
* Gets current value of property {@link #getCssClass cssClass}.
|
|
502
474
|
*
|
|
@@ -521,7 +493,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
521
493
|
* Gets current value of property {@link #getDefaultDataSource defaultDataSource}.
|
|
522
494
|
*
|
|
523
495
|
* Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
|
|
524
|
-
* will be used during UI load and this parameter will used only after filter is reset.
|
|
496
|
+
* will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
|
|
497
|
+
* to 'true', do not set this parameter (will be ignored).
|
|
525
498
|
*
|
|
526
499
|
* @since 1.93.0
|
|
527
500
|
*
|
|
@@ -544,7 +517,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
544
517
|
* Gets current value of property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
|
|
545
518
|
*
|
|
546
519
|
* Enables the multiselection mode of search result items. A checkbox is provided for each result item if
|
|
547
|
-
* the value is true.
|
|
520
|
+
* the value is set to 'true'.
|
|
548
521
|
*
|
|
549
522
|
* Default value is `false`.
|
|
550
523
|
*
|
|
@@ -593,7 +566,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
593
566
|
*
|
|
594
567
|
* Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
|
|
595
568
|
*
|
|
596
|
-
* Default value is `
|
|
569
|
+
* Default value is `true`.
|
|
597
570
|
*
|
|
598
571
|
* @since 1.108.0
|
|
599
572
|
*
|
|
@@ -617,8 +590,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
617
590
|
* Gets current value of property {@link #getFacetVisibility facetVisibility}.
|
|
618
591
|
*
|
|
619
592
|
* A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
|
|
620
|
-
* initial state of the facet panel. When not setting facetVisibility the initial state of the facet
|
|
621
|
-
* typically is taken from the user personalization storage.
|
|
593
|
+
* initial state of the facet panel. When not setting 'facetVisibility', the initial state of the facet
|
|
594
|
+
* panel typically is taken from the user personalization storage.
|
|
622
595
|
*
|
|
623
596
|
* @since 1.113.0
|
|
624
597
|
*
|
|
@@ -687,7 +660,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
687
660
|
/**
|
|
688
661
|
* Gets current value of property {@link #getFormatFilterBarText formatFilterBarText}.
|
|
689
662
|
*
|
|
690
|
-
* Callback for formatting the filter string to be displayed
|
|
663
|
+
* Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
|
|
691
664
|
*
|
|
692
665
|
* @since 1.120
|
|
693
666
|
*
|
|
@@ -708,7 +681,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
708
681
|
/**
|
|
709
682
|
* Gets current value of property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
|
|
710
683
|
*
|
|
711
|
-
* A callback which returns customized "label" for placeholder text of search box
|
|
684
|
+
* A callback which returns customized "label" for placeholder text of search box in case there is no search
|
|
712
685
|
* term. The placeholder text (en) will be "Search In: ".
|
|
713
686
|
*
|
|
714
687
|
*
|
|
@@ -718,7 +691,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
718
691
|
/**
|
|
719
692
|
* Gets current value of property {@link #getInitAsync initAsync}.
|
|
720
693
|
*
|
|
721
|
-
*
|
|
694
|
+
* An asynchronues callback which is called after the initialization of the search composite control.
|
|
722
695
|
*
|
|
723
696
|
* @since 1.113.0
|
|
724
697
|
*
|
|
@@ -738,8 +711,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
738
711
|
/**
|
|
739
712
|
* Gets current value of property {@link #getIsSearchUrl isSearchUrl}.
|
|
740
713
|
*
|
|
741
|
-
* A callback for checking whether a URL is a search URL. The callback receives a URL and returns
|
|
742
|
-
* case the URL is a search URL. Typically you need to register this callback in case
|
|
714
|
+
* A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
|
|
715
|
+
* 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
|
|
716
|
+
* of 'updateUrl = true'.
|
|
743
717
|
*
|
|
744
718
|
* @since 1.113.0
|
|
745
719
|
*
|
|
@@ -770,8 +744,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
770
744
|
/**
|
|
771
745
|
* Gets current value of property {@link #getPageSize pageSize}.
|
|
772
746
|
*
|
|
773
|
-
* The
|
|
774
|
-
* another page of result items of the same count (if available) will be displayed.
|
|
747
|
+
* The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
|
|
748
|
+
* button, another page of result items of the same count (if available) will be displayed.
|
|
775
749
|
*
|
|
776
750
|
* Default value is `10`.
|
|
777
751
|
*
|
|
@@ -784,7 +758,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
784
758
|
* Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
|
|
785
759
|
*
|
|
786
760
|
* A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
|
|
787
|
-
* parameters. This is an optional callback.
|
|
761
|
+
* parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
|
|
788
762
|
* is not needed.
|
|
789
763
|
*
|
|
790
764
|
* @since 1.113.0
|
|
@@ -795,7 +769,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
795
769
|
/**
|
|
796
770
|
* Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
|
|
797
771
|
*
|
|
798
|
-
* A list of
|
|
772
|
+
* A list of data sources to be displayed in the facet panel in the section "Collection".
|
|
799
773
|
*
|
|
800
774
|
* @since 1.113.0
|
|
801
775
|
*
|
|
@@ -806,7 +780,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
806
780
|
* Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}.
|
|
807
781
|
*
|
|
808
782
|
* A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
|
|
809
|
-
* the URL string. Typically you need to register this callback in case updateUrl=true.
|
|
783
|
+
* the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
|
|
810
784
|
*
|
|
811
785
|
* @since 1.113.0
|
|
812
786
|
*
|
|
@@ -876,8 +850,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
876
850
|
/**
|
|
877
851
|
* Gets current value of property {@link #getSearchOnStart searchOnStart}.
|
|
878
852
|
*
|
|
879
|
-
* Defines if the search composite control will send a search request after loading
|
|
880
|
-
* data source and filter root condition settings.
|
|
853
|
+
* Defines if the search composite control will send a search request directly after loading, using given
|
|
854
|
+
* search term, data source and filter root condition settings.
|
|
881
855
|
*
|
|
882
856
|
* Default value is `true`.
|
|
883
857
|
*
|
|
@@ -901,7 +875,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
901
875
|
/**
|
|
902
876
|
* Gets current value of property {@link #getSelectionChange selectionChange}.
|
|
903
877
|
*
|
|
904
|
-
* A callback which is called whenever the selection of result
|
|
878
|
+
* A callback which is called whenever the selection of result view items changes.
|
|
905
879
|
*
|
|
906
880
|
* @since 1.113.0
|
|
907
881
|
*
|
|
@@ -942,58 +916,6 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
942
916
|
* @returns Value of property `updateUrl`
|
|
943
917
|
*/
|
|
944
918
|
getUpdateUrl(): boolean;
|
|
945
|
-
/**
|
|
946
|
-
* Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
|
|
947
|
-
* its index if found or -1 otherwise.
|
|
948
|
-
*
|
|
949
|
-
*
|
|
950
|
-
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
951
|
-
*/
|
|
952
|
-
indexOfContent(
|
|
953
|
-
/**
|
|
954
|
-
* The content whose index is looked for
|
|
955
|
-
*/
|
|
956
|
-
oContent: Control
|
|
957
|
-
): int;
|
|
958
|
-
/**
|
|
959
|
-
* Inserts a content into the aggregation {@link #getContent content}.
|
|
960
|
-
*
|
|
961
|
-
*
|
|
962
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
963
|
-
*/
|
|
964
|
-
insertContent(
|
|
965
|
-
/**
|
|
966
|
-
* The content to insert; if empty, nothing is inserted
|
|
967
|
-
*/
|
|
968
|
-
oContent: Control,
|
|
969
|
-
/**
|
|
970
|
-
* The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
|
|
971
|
-
* is inserted at position 0; for a value greater than the current size of the aggregation, the content
|
|
972
|
-
* is inserted at the last position
|
|
973
|
-
*/
|
|
974
|
-
iIndex: int
|
|
975
|
-
): this;
|
|
976
|
-
/**
|
|
977
|
-
* Removes all the controls from the aggregation {@link #getContent content}.
|
|
978
|
-
*
|
|
979
|
-
* Additionally, it unregisters them from the hosting UIArea.
|
|
980
|
-
*
|
|
981
|
-
*
|
|
982
|
-
* @returns An array of the removed elements (might be empty)
|
|
983
|
-
*/
|
|
984
|
-
removeAllContent(): Control[];
|
|
985
|
-
/**
|
|
986
|
-
* Removes a content from the aggregation {@link #getContent content}.
|
|
987
|
-
*
|
|
988
|
-
*
|
|
989
|
-
* @returns The removed content or `null`
|
|
990
|
-
*/
|
|
991
|
-
removeContent(
|
|
992
|
-
/**
|
|
993
|
-
* The content to remove or its index or id
|
|
994
|
-
*/
|
|
995
|
-
vContent: int | string | Control
|
|
996
|
-
): Control | null;
|
|
997
919
|
/**
|
|
998
920
|
* Sets a new value for property {@link #getApplicationComponent applicationComponent}.
|
|
999
921
|
*
|
|
@@ -1090,7 +1012,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1090
1012
|
* Sets a new value for property {@link #getDefaultDataSource defaultDataSource}.
|
|
1091
1013
|
*
|
|
1092
1014
|
* Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
|
|
1093
|
-
* will be used during UI load and this parameter will used only after filter is reset.
|
|
1015
|
+
* will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
|
|
1016
|
+
* to 'true', do not set this parameter (will be ignored).
|
|
1094
1017
|
*
|
|
1095
1018
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1096
1019
|
*
|
|
@@ -1127,7 +1050,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1127
1050
|
* Sets a new value for property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
|
|
1128
1051
|
*
|
|
1129
1052
|
* Enables the multiselection mode of search result items. A checkbox is provided for each result item if
|
|
1130
|
-
* the value is true.
|
|
1053
|
+
* the value is set to 'true'.
|
|
1131
1054
|
*
|
|
1132
1055
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1133
1056
|
*
|
|
@@ -1206,7 +1129,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1206
1129
|
*
|
|
1207
1130
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1208
1131
|
*
|
|
1209
|
-
* Default value is `
|
|
1132
|
+
* Default value is `true`.
|
|
1210
1133
|
*
|
|
1211
1134
|
* @since 1.108.0
|
|
1212
1135
|
*
|
|
@@ -1242,8 +1165,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1242
1165
|
* Sets a new value for property {@link #getFacetVisibility facetVisibility}.
|
|
1243
1166
|
*
|
|
1244
1167
|
* A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
|
|
1245
|
-
* initial state of the facet panel. When not setting facetVisibility the initial state of the facet
|
|
1246
|
-
* typically is taken from the user personalization storage.
|
|
1168
|
+
* initial state of the facet panel. When not setting 'facetVisibility', the initial state of the facet
|
|
1169
|
+
* panel typically is taken from the user personalization storage.
|
|
1247
1170
|
*
|
|
1248
1171
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1249
1172
|
*
|
|
@@ -1345,7 +1268,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1345
1268
|
/**
|
|
1346
1269
|
* Sets a new value for property {@link #getFormatFilterBarText formatFilterBarText}.
|
|
1347
1270
|
*
|
|
1348
|
-
* Callback for formatting the filter string to be displayed
|
|
1271
|
+
* Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
|
|
1349
1272
|
*
|
|
1350
1273
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1351
1274
|
*
|
|
@@ -1380,7 +1303,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1380
1303
|
/**
|
|
1381
1304
|
* Sets a new value for property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
|
|
1382
1305
|
*
|
|
1383
|
-
* A callback which returns customized "label" for placeholder text of search box
|
|
1306
|
+
* A callback which returns customized "label" for placeholder text of search box in case there is no search
|
|
1384
1307
|
* term. The placeholder text (en) will be "Search In: ".
|
|
1385
1308
|
*
|
|
1386
1309
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -1397,7 +1320,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1397
1320
|
/**
|
|
1398
1321
|
* Sets a new value for property {@link #getInitAsync initAsync}.
|
|
1399
1322
|
*
|
|
1400
|
-
*
|
|
1323
|
+
* An asynchronues callback which is called after the initialization of the search composite control.
|
|
1401
1324
|
*
|
|
1402
1325
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1403
1326
|
*
|
|
@@ -1431,8 +1354,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1431
1354
|
/**
|
|
1432
1355
|
* Sets a new value for property {@link #getIsSearchUrl isSearchUrl}.
|
|
1433
1356
|
*
|
|
1434
|
-
* A callback for checking whether a URL is a search URL. The callback receives a URL and returns
|
|
1435
|
-
* case the URL is a search URL. Typically you need to register this callback in case
|
|
1357
|
+
* A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
|
|
1358
|
+
* 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
|
|
1359
|
+
* of 'updateUrl = true'.
|
|
1436
1360
|
*
|
|
1437
1361
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1438
1362
|
*
|
|
@@ -1484,8 +1408,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1484
1408
|
/**
|
|
1485
1409
|
* Sets a new value for property {@link #getPageSize pageSize}.
|
|
1486
1410
|
*
|
|
1487
|
-
* The
|
|
1488
|
-
* another page of result items of the same count (if available) will be displayed.
|
|
1411
|
+
* The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
|
|
1412
|
+
* button, another page of result items of the same count (if available) will be displayed.
|
|
1489
1413
|
*
|
|
1490
1414
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1491
1415
|
*
|
|
@@ -1505,7 +1429,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1505
1429
|
* Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
|
|
1506
1430
|
*
|
|
1507
1431
|
* A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
|
|
1508
|
-
* parameters. This is an optional callback.
|
|
1432
|
+
* parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
|
|
1509
1433
|
* is not needed.
|
|
1510
1434
|
*
|
|
1511
1435
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -1523,7 +1447,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1523
1447
|
/**
|
|
1524
1448
|
* Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}.
|
|
1525
1449
|
*
|
|
1526
|
-
* A list of
|
|
1450
|
+
* A list of data sources to be displayed in the facet panel in the section "Collection".
|
|
1527
1451
|
*
|
|
1528
1452
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1529
1453
|
*
|
|
@@ -1541,7 +1465,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1541
1465
|
* Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}.
|
|
1542
1466
|
*
|
|
1543
1467
|
* A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
|
|
1544
|
-
* the URL string. Typically you need to register this callback in case updateUrl=true.
|
|
1468
|
+
* the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
|
|
1545
1469
|
*
|
|
1546
1470
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1547
1471
|
*
|
|
@@ -1639,8 +1563,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1639
1563
|
/**
|
|
1640
1564
|
* Sets a new value for property {@link #getSearchOnStart searchOnStart}.
|
|
1641
1565
|
*
|
|
1642
|
-
* Defines if the search composite control will send a search request after loading
|
|
1643
|
-
* data source and filter root condition settings.
|
|
1566
|
+
* Defines if the search composite control will send a search request directly after loading, using given
|
|
1567
|
+
* search term, data source and filter root condition settings.
|
|
1644
1568
|
*
|
|
1645
1569
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1646
1570
|
*
|
|
@@ -1678,7 +1602,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1678
1602
|
/**
|
|
1679
1603
|
* Sets a new value for property {@link #getSelectionChange selectionChange}.
|
|
1680
1604
|
*
|
|
1681
|
-
* A callback which is called whenever the selection of result
|
|
1605
|
+
* A callback which is called whenever the selection of result view items changes.
|
|
1682
1606
|
*
|
|
1683
1607
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1684
1608
|
*
|
|
@@ -1767,8 +1691,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1767
1691
|
searchTerm?: string | PropertyBindingInfo;
|
|
1768
1692
|
|
|
1769
1693
|
/**
|
|
1770
|
-
* Defines if the search composite control will send a search request after loading
|
|
1771
|
-
* data source and filter root condition settings.
|
|
1694
|
+
* Defines if the search composite control will send a search request directly after loading, using given
|
|
1695
|
+
* search term, data source and filter root condition settings.
|
|
1772
1696
|
*
|
|
1773
1697
|
* @since 1.93.0
|
|
1774
1698
|
*/
|
|
@@ -1936,7 +1860,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1936
1860
|
getCustomNoResultScreen?: Function | PropertyBindingInfo | `{${string}}`;
|
|
1937
1861
|
|
|
1938
1862
|
/**
|
|
1939
|
-
* A callback which returns customized "label" for placeholder text of search box
|
|
1863
|
+
* A callback which returns customized "label" for placeholder text of search box in case there is no search
|
|
1940
1864
|
* term. The placeholder text (en) will be "Search In: ".
|
|
1941
1865
|
*/
|
|
1942
1866
|
getSearchInputPlaceholderLabel?:
|
|
@@ -1954,7 +1878,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1954
1878
|
|
|
1955
1879
|
/**
|
|
1956
1880
|
* Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
|
|
1957
|
-
* will be used during UI load and this parameter will used only after filter is reset.
|
|
1881
|
+
* will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
|
|
1882
|
+
* to 'true', do not set this parameter (will be ignored).
|
|
1958
1883
|
*
|
|
1959
1884
|
* @since 1.93.0
|
|
1960
1885
|
*/
|
|
@@ -1977,8 +1902,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
1977
1902
|
|
|
1978
1903
|
/**
|
|
1979
1904
|
* A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
|
|
1980
|
-
* initial state of the facet panel. When not setting facetVisibility the initial state of the facet
|
|
1981
|
-
* typically is taken from the user personalization storage.
|
|
1905
|
+
* initial state of the facet panel. When not setting 'facetVisibility', the initial state of the facet
|
|
1906
|
+
* panel typically is taken from the user personalization storage.
|
|
1982
1907
|
*
|
|
1983
1908
|
* @since 1.113.0
|
|
1984
1909
|
*/
|
|
@@ -2010,15 +1935,16 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
2010
1935
|
|
|
2011
1936
|
/**
|
|
2012
1937
|
* A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
|
|
2013
|
-
* the URL string. Typically you need to register this callback in case updateUrl=true.
|
|
1938
|
+
* the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
|
|
2014
1939
|
*
|
|
2015
1940
|
* @since 1.113.0
|
|
2016
1941
|
*/
|
|
2017
1942
|
renderSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
|
|
2018
1943
|
|
|
2019
1944
|
/**
|
|
2020
|
-
* A callback for checking whether a URL is a search URL. The callback receives a URL and returns
|
|
2021
|
-
* case the URL is a search URL. Typically you need to register this callback in case
|
|
1945
|
+
* A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
|
|
1946
|
+
* 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
|
|
1947
|
+
* of 'updateUrl = true'.
|
|
2022
1948
|
*
|
|
2023
1949
|
* @since 1.113.0
|
|
2024
1950
|
*/
|
|
@@ -2026,7 +1952,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
2026
1952
|
|
|
2027
1953
|
/**
|
|
2028
1954
|
* A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
|
|
2029
|
-
* parameters. This is an optional callback.
|
|
1955
|
+
* parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
|
|
2030
1956
|
* is not needed.
|
|
2031
1957
|
*
|
|
2032
1958
|
* @since 1.113.0
|
|
@@ -2034,21 +1960,21 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
2034
1960
|
parseSearchUrlParameters?: Function | PropertyBindingInfo | `{${string}}`;
|
|
2035
1961
|
|
|
2036
1962
|
/**
|
|
2037
|
-
* A list of
|
|
1963
|
+
* A list of data sources to be displayed in the facet panel in the section "Collection".
|
|
2038
1964
|
*
|
|
2039
1965
|
* @since 1.113.0
|
|
2040
1966
|
*/
|
|
2041
1967
|
quickSelectDataSources?: object | PropertyBindingInfo | `{${string}}`;
|
|
2042
1968
|
|
|
2043
1969
|
/**
|
|
2044
|
-
* A callback which is called whenever the selection of result
|
|
1970
|
+
* A callback which is called whenever the selection of result view items changes.
|
|
2045
1971
|
*
|
|
2046
1972
|
* @since 1.113.0
|
|
2047
1973
|
*/
|
|
2048
1974
|
selectionChange?: Function | PropertyBindingInfo | `{${string}}`;
|
|
2049
1975
|
|
|
2050
1976
|
/**
|
|
2051
|
-
*
|
|
1977
|
+
* An asynchronues callback which is called after the initialization of the search composite control.
|
|
2052
1978
|
*
|
|
2053
1979
|
* @since 1.113.0
|
|
2054
1980
|
*/
|
|
@@ -2056,7 +1982,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
2056
1982
|
|
|
2057
1983
|
/**
|
|
2058
1984
|
* Enables the multiselection mode of search result items. A checkbox is provided for each result item if
|
|
2059
|
-
* the value is true.
|
|
1985
|
+
* the value is set to 'true'.
|
|
2060
1986
|
*
|
|
2061
1987
|
* @since 1.96.0
|
|
2062
1988
|
*/
|
|
@@ -2066,15 +1992,15 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
2066
1992
|
| `{${string}}`;
|
|
2067
1993
|
|
|
2068
1994
|
/**
|
|
2069
|
-
* The
|
|
2070
|
-
* another page of result items of the same count (if available) will be displayed.
|
|
1995
|
+
* The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
|
|
1996
|
+
* button, another page of result items of the same count (if available) will be displayed.
|
|
2071
1997
|
*
|
|
2072
1998
|
* @since 1.96.0
|
|
2073
1999
|
*/
|
|
2074
2000
|
pageSize?: int | PropertyBindingInfo | `{${string}}`;
|
|
2075
2001
|
|
|
2076
2002
|
/**
|
|
2077
|
-
* Callback for formatting the filter string to be displayed
|
|
2003
|
+
* Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
|
|
2078
2004
|
*
|
|
2079
2005
|
* @since 1.120
|
|
2080
2006
|
*/
|
|
@@ -2094,11 +2020,6 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
|
|
|
2094
2020
|
*/
|
|
2095
2021
|
eventConsumers?: string | PropertyBindingInfo;
|
|
2096
2022
|
|
|
2097
|
-
/**
|
|
2098
|
-
* Control instances which are part of this composite control.
|
|
2099
|
-
*/
|
|
2100
|
-
content?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
|
|
2101
|
-
|
|
2102
2023
|
/**
|
|
2103
2024
|
* Event is fired when search is started.
|
|
2104
2025
|
*
|
package/types/sap.f.d.ts
CHANGED
package/types/sap.fe.base.d.ts
CHANGED
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.126.1
|
|
2
2
|
|
|
3
3
|
declare module "sap/fe/core/AppComponent" {
|
|
4
4
|
import {
|
|
@@ -1039,7 +1039,17 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
1039
1039
|
/**
|
|
1040
1040
|
* Object containing the context to be navigated to
|
|
1041
1041
|
*/
|
|
1042
|
-
oContext: Context
|
|
1042
|
+
oContext: Context,
|
|
1043
|
+
/**
|
|
1044
|
+
* Object containing the parameters for the navigation
|
|
1045
|
+
*/
|
|
1046
|
+
parameters?: {
|
|
1047
|
+
/**
|
|
1048
|
+
* By default, the internal algorithm decides whether the navigation preserves the previous entry. This
|
|
1049
|
+
* parameter allows you to override this behavior.
|
|
1050
|
+
*/
|
|
1051
|
+
preserveHistory: boolean;
|
|
1052
|
+
}
|
|
1043
1053
|
): void;
|
|
1044
1054
|
/**
|
|
1045
1055
|
* Navigate to another target.
|
|
@@ -1114,7 +1124,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
|
|
|
1114
1124
|
*/
|
|
1115
1125
|
bindingContext: Context;
|
|
1116
1126
|
}
|
|
1117
|
-
): boolean
|
|
1127
|
+
): Promise<boolean>;
|
|
1118
1128
|
}
|
|
1119
1129
|
}
|
|
1120
1130
|
|