@sapui5/ts-types 1.140.0 → 1.141.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +2792 -1
  7. package/types/sap.f.d.ts +43 -2
  8. package/types/sap.fe.ariba.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +78 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +371 -42
  14. package/types/sap.fe.navigation.d.ts +13 -15
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +7 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +70 -8
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +20 -5
  30. package/types/sap.suite.ui.commons.d.ts +1 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +41 -5
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +1 -1
  37. package/types/sap.ui.core.d.ts +129 -66
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +3 -3
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +1 -1
  44. package/types/sap.ui.layout.d.ts +5102 -5062
  45. package/types/sap.ui.mdc.d.ts +4 -4
  46. package/types/sap.ui.richtexteditor.d.ts +307 -9
  47. package/types/sap.ui.rta.d.ts +1 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +18 -4
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +53 -1
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +141 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +32 -3
  62. package/types/sap.ushell_abap.d.ts +5 -1
  63. package/types/sap.uxap.d.ts +1 -1
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,7 +1,2798 @@
1
- // For Library Version: 1.140.1
1
+ // For Library Version: 1.141.1
2
2
 
3
3
  declare namespace sap {
4
+ namespace esh {
5
+ namespace search {
6
+ /**
7
+ * UI5 library: sap.esh.search.ui.
8
+ */
9
+ namespace ui {
10
+ /**
11
+ * Describes the settings that can be provided to the SearchCompositeControl constructor.
12
+ */
13
+ interface $SearchCompositeControlSettings
14
+ extends sap.ui.core.$ControlSettings {
15
+ /**
16
+ * An additional CSS class to add to this control
17
+ *
18
+ * @since 1.93.0
19
+ */
20
+ cssClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
21
+
22
+ /**
23
+ * Defines the initial search term for the search input.
24
+ *
25
+ * @since 1.93.0
26
+ */
27
+ searchTerm?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
28
+
29
+ /**
30
+ * Defines if the search composite control will send a search request directly after loading, using given
31
+ * search term, data source and filter root condition settings.
32
+ *
33
+ * @since 1.93.0
34
+ */
35
+ searchOnStart?:
36
+ | boolean
37
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
38
+ | `{${string}}`;
39
+
40
+ /**
41
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
42
+ * control only allows filter trees which have a the following structure: complex condition (root level)
43
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
44
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
45
+ * for a more in-depth example.
46
+ *
47
+ * @since 1.98.0
48
+ */
49
+ filterRootCondition?:
50
+ | object
51
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
52
+ | `{${string}}`;
53
+
54
+ /**
55
+ * Configuration for the Enterprise Search Client API.
56
+ *
57
+ * @since 1.93.0
58
+ */
59
+ sinaConfiguration?:
60
+ | object
61
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
62
+ | `{${string}}`;
63
+
64
+ /**
65
+ * The id of the data source in which it will search right after initialization.
66
+ *
67
+ * @since 1.98.0
68
+ */
69
+ dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
70
+
71
+ /**
72
+ * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
73
+ * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
74
+ * panel) - data source name/link on result list (header section of item)
75
+ *
76
+ * @since 1.121.0
77
+ */
78
+ exclusiveDataSource?:
79
+ | string
80
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
81
+
82
+ /**
83
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
84
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
85
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
86
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
87
+ * Search in Business Object: result is switchable between different view types. Possible values for the
88
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
89
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
90
+ *
91
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
92
+ *
93
+ * @since 1.98.0
94
+ */
95
+ resultViewTypes?:
96
+ | string[]
97
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
98
+ | `{${string}}`;
99
+
100
+ /**
101
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
102
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
103
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
104
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
105
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
106
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
107
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
108
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
109
+ *
110
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
111
+ *
112
+ * @since 1.98.0
113
+ */
114
+ resultViewType?:
115
+ | string
116
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
117
+
118
+ /**
119
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
120
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
121
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
122
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
123
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
124
+ * and `resultViewType` must be compatible to each other.
125
+ *
126
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
127
+ *
128
+ * @since 1.100.0
129
+ */
130
+ resultViewSettings?:
131
+ | string
132
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
133
+
134
+ /**
135
+ * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever
136
+ * the detail button/indicator is clicked.
137
+ *
138
+ * @since 1.140.0
139
+ */
140
+ resultviewMasterDetailMode?:
141
+ | boolean
142
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
143
+ | `{${string}}`;
144
+
145
+ /**
146
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
147
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
148
+ * in the tabstrips.
149
+ *
150
+ * @since 1.103.0
151
+ */
152
+ tabStripsFormatter?:
153
+ | Function
154
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
155
+ | `{${string}}`;
156
+
157
+ /**
158
+ * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
159
+ * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
160
+ * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
161
+ * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
162
+ * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
163
+ * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
164
+ * are set.
165
+ *
166
+ * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
167
+ * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
168
+ * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
169
+ * children of a folder. * @since 1.106.0
170
+ */
171
+ folderMode?:
172
+ | boolean
173
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
174
+ | `{${string}}`;
175
+
176
+ /**
177
+ * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
178
+ * is enabled.
179
+ *
180
+ * @since 1.114.0
181
+ */
182
+ folderModeForInitialSearch?:
183
+ | boolean
184
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
185
+ | `{${string}}`;
186
+
187
+ /**
188
+ * In case folder mode is active: Automatically switch result view type to list in search mode and to table
189
+ * in folder mode.
190
+ *
191
+ * @since 1.106.0
192
+ */
193
+ autoAdjustResultViewTypeInFolderMode?:
194
+ | boolean
195
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
196
+ | `{${string}}`;
197
+
198
+ /**
199
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
200
+ * user to enter complex search queries with logical operators.
201
+ *
202
+ * @since 1.107.0
203
+ */
204
+ enableQueryLanguage?:
205
+ | boolean
206
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
207
+ | `{${string}}`;
208
+
209
+ /**
210
+ * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
211
+ *
212
+ * @since 1.108.0
213
+ */
214
+ applicationComponent?:
215
+ | string
216
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
217
+
218
+ /**
219
+ * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
220
+ *
221
+ * @since 1.108.0
222
+ */
223
+ facetPanelResizable?:
224
+ | boolean
225
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
226
+ | `{${string}}`;
227
+
228
+ /**
229
+ * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
230
+ * is true, the width of the facet panel can be changed by the user.
231
+ *
232
+ * @since 1.108.0
233
+ */
234
+ facetPanelWidthInPercent?:
235
+ | float
236
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
237
+ | `{${string}}`;
238
+
239
+ /**
240
+ * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
241
+ * to be more specific and add some hints, links, buttons or other content.
242
+ *
243
+ * @since 1.94.0
244
+ */
245
+ getCustomNoResultScreen?:
246
+ | Function
247
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
248
+ | `{${string}}`;
249
+
250
+ /**
251
+ * A callback which returns customized "label" for placeholder text of search box in case there is no search
252
+ * term. The placeholder text (en) will be "Search In: ".
253
+ */
254
+ getSearchInputPlaceholderLabel?:
255
+ | Function
256
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
257
+ | `{${string}}`;
258
+
259
+ /**
260
+ * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
261
+ * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
262
+ *
263
+ * @since 1.140.0
264
+ * @experimental As of version 1.140.0. this feature is experimental and the API may change.
265
+ */
266
+ searchInputLocation?:
267
+ | string
268
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
269
+
270
+ /**
271
+ * Shall the window title be overwritten by this control? If true, the control will set the current search
272
+ * condition as window title. If false, it will not set or update the window title.
273
+ *
274
+ * @since 1.93.0
275
+ */
276
+ overwriteBrowserTitle?:
277
+ | boolean
278
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
279
+ | `{${string}}`;
280
+
281
+ /**
282
+ * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
283
+ * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
284
+ * to 'true', do not set this parameter (will be ignored).
285
+ *
286
+ * @since 1.93.0
287
+ */
288
+ defaultDataSource?:
289
+ | string
290
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
291
+
292
+ /**
293
+ * The layout is optimized for object selection / value help (narrow view w/o facet panel).
294
+ *
295
+ * @since 1.111.0
296
+ */
297
+ optimizeForValueHelp?:
298
+ | boolean
299
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
300
+ | `{${string}}`;
301
+
302
+ /**
303
+ * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
304
+ * a list of datsources and returns the filtered list of datasources.
305
+ *
306
+ * @since 1.112.0
307
+ */
308
+ filterDataSources?:
309
+ | Function
310
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
311
+ | `{${string}}`;
312
+
313
+ /**
314
+ * Controls whether the facet functionality is available or not.
315
+ *
316
+ * @since 1.132.0
317
+ */
318
+ facets?:
319
+ | boolean
320
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
321
+ | `{${string}}`;
322
+
323
+ /**
324
+ * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
325
+ * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
326
+ * depending on the user's personalization settings.
327
+ *
328
+ * @since 1.113.0
329
+ */
330
+ facetVisibility?:
331
+ | boolean
332
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
333
+ | `{${string}}`;
334
+
335
+ /**
336
+ * Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin)
337
+ * or on the right (end) of the search bar. By default the button's location is at the beginning (left),
338
+ * values are "Begin" and "End". The property is not evaluated if facet panel is disabled, see property
339
+ * 'facets'.
340
+ *
341
+ * @since 1.140.0
342
+ * @experimental As of version 1.140.0. this feature is experimental and the API may change.
343
+ */
344
+ facetToggleButtonLocation?:
345
+ | string
346
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
347
+
348
+ /**
349
+ * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can
350
+ * be viewed as a pie or bar chart (this cannot be deactivated at runtime).
351
+ *
352
+ * @since 1.140.0
353
+ */
354
+ enableCharts?:
355
+ | boolean
356
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
357
+ | `{${string}}`;
358
+
359
+ /**
360
+ * A boolean for enabling (business) object suggestions.
361
+ *
362
+ * @since 1.113.0
363
+ */
364
+ boSuggestions?:
365
+ | boolean
366
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
367
+ | `{${string}}`;
368
+
369
+ /**
370
+ * When set to true the facet panel is displayed also in case there are no search results.
371
+ *
372
+ * @since 1.113.0
373
+ * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
374
+ * by the end user.
375
+ */
376
+ displayFacetPanelInCaseOfNoResults?:
377
+ | boolean
378
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
379
+ | `{${string}}`;
380
+
381
+ /**
382
+ * A boolean indicating that the search state is written to the URL.
383
+ *
384
+ * @since 1.113.0
385
+ */
386
+ updateUrl?:
387
+ | boolean
388
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
389
+ | `{${string}}`;
390
+
391
+ /**
392
+ * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
393
+ * the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
394
+ *
395
+ * @since 1.113.0
396
+ */
397
+ renderSearchUrl?:
398
+ | Function
399
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
400
+ | `{${string}}`;
401
+
402
+ /**
403
+ * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
404
+ * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
405
+ * of 'updateUrl = true'.
406
+ *
407
+ * @since 1.113.0
408
+ */
409
+ isSearchUrl?:
410
+ | Function
411
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
412
+ | `{${string}}`;
413
+
414
+ /**
415
+ * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
416
+ * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
417
+ * is not needed.
418
+ *
419
+ * @since 1.113.0
420
+ */
421
+ parseSearchUrlParameters?:
422
+ | Function
423
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
424
+ | `{${string}}`;
425
+
426
+ /**
427
+ * A list of data sources to be displayed in the facet panel in the section "Collection".
428
+ *
429
+ * @since 1.113.0
430
+ */
431
+ quickSelectDataSources?:
432
+ | object
433
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
434
+ | `{${string}}`;
435
+
436
+ /**
437
+ * A callback which is called whenever the selection of result view items changes.
438
+ *
439
+ * @since 1.113.0
440
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
441
+ */
442
+ selectionChange?:
443
+ | Function
444
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
445
+ | `{${string}}`;
446
+
447
+ /**
448
+ * An asynchronues callback which is called after the initialization of the search composite control.
449
+ *
450
+ * @since 1.113.0
451
+ */
452
+ initAsync?:
453
+ | Function
454
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
455
+ | `{${string}}`;
456
+
457
+ /**
458
+ * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
459
+ * the value is set to 'true'.
460
+ *
461
+ * @since 1.96.0
462
+ * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead.
463
+ */
464
+ enableMultiSelectionResultItems?:
465
+ | boolean
466
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
467
+ | `{${string}}`;
468
+
469
+ /**
470
+ * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems')
471
+ * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None',
472
+ * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'.
473
+ * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode`
474
+ * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked.
475
+ *
476
+ * @since 1.141.0
477
+ */
478
+ resultviewSelectionMode?:
479
+ | string
480
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
481
+
482
+ /**
483
+ * Enables the selection toggle button in the search result list. The button is displayed on the top of
484
+ * search result view and allows to toggle the selection of all result items. The button is only displayed
485
+ * if the property 'resultviewSelectionMode' is not set to 'None'.
486
+ *
487
+ * @since 1.140.0
488
+ */
489
+ showSelectionToggleButton?:
490
+ | boolean
491
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
492
+ | `{${string}}`;
493
+
494
+ /**
495
+ * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
496
+ * button, another page of result items of the same count (if available) will be displayed.
497
+ *
498
+ * @since 1.96.0
499
+ */
500
+ pageSize?:
501
+ | int
502
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
503
+ | `{${string}}`;
504
+
505
+ /**
506
+ * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
507
+ *
508
+ * @since 1.120
509
+ */
510
+ formatFilterBarText?:
511
+ | Function
512
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
513
+ | `{${string}}`;
514
+
515
+ /**
516
+ * Callback for checking whether the filter bar is visible.
517
+ *
518
+ * @since 1.120
519
+ */
520
+ isFilterBarVisible?:
521
+ | Function
522
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
523
+ | `{${string}}`;
524
+
525
+ /**
526
+ * Adds a callback function which is called whenever there is a user or a technical event. A user event
527
+ * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
528
+ * is an event which is triggered by the internal events or events which can also be triggered by API.
529
+ *
530
+ * @since 1.120
531
+ */
532
+ eventConsumers?:
533
+ | string
534
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
535
+
536
+ /**
537
+ * Limit for length of searchterm.
538
+ */
539
+ searchTermLengthLimit?:
540
+ | int
541
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
542
+ | `{${string}}`;
543
+
544
+ /**
545
+ * Prevents too many ajax requests in a short time.
546
+ */
547
+ limitAjaxRequests?:
548
+ | boolean
549
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
550
+ | `{${string}}`;
551
+
552
+ /**
553
+ * Event is fired when search is started.
554
+ *
555
+ * @since 1.121
556
+ */
557
+ searchStarted?: (oEvent: sap.ui.base.Event) => void;
558
+
559
+ /**
560
+ * Event is fired when search is finished.
561
+ *
562
+ * @since 1.121
563
+ */
564
+ searchFinished?: (oEvent: sap.ui.base.Event) => void;
565
+
566
+ /**
567
+ * Event is fired when selection on result view (list, table or grid) has changed.
568
+ *
569
+ * @since 1.121
570
+ */
571
+ selectionChanged?: (oEvent: sap.ui.base.Event) => void;
572
+
573
+ /**
574
+ * Event is fired after result view type got changed (list, table or grid).
575
+ *
576
+ * @since 1.124
577
+ */
578
+ resultViewTypeChanged?: (oEvent: sap.ui.base.Event) => void;
579
+
580
+ /**
581
+ * Event is fired after result view detail button is pressed (list, table or grid). To use this event, set
582
+ * the property 'resultviewMasterDetailMode' to 'true'.
583
+ *
584
+ * @since 1.140.0
585
+ */
586
+ showResultDetail?: (oEvent: sap.ui.base.Event) => void;
587
+ }
588
+
589
+ /**
590
+ * Parameters of the SearchCompositeControl#resultViewTypeChanged event.
591
+ */
592
+ interface SearchCompositeControl$ResultViewTypeChangedEventParameters {}
593
+
594
+ /**
595
+ * Parameters of the SearchCompositeControl#searchFinished event.
596
+ */
597
+ interface SearchCompositeControl$SearchFinishedEventParameters {}
598
+
599
+ /**
600
+ * Parameters of the SearchCompositeControl#searchStarted event.
601
+ */
602
+ interface SearchCompositeControl$SearchStartedEventParameters {}
603
+
604
+ /**
605
+ * Parameters of the SearchCompositeControl#selectionChanged event.
606
+ */
607
+ interface SearchCompositeControl$SelectionChangedEventParameters {}
608
+
609
+ /**
610
+ * Parameters of the SearchCompositeControl#showResultDetail event.
611
+ */
612
+ interface SearchCompositeControl$ShowResultDetailEventParameters {}
613
+
614
+ /**
615
+ * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
616
+ * Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
617
+ * a suggestion dropdown, a result view which can have different visualisation, including tiles, list and
618
+ * table, filtering facets and more. This control is ready to use with an enterprise search backend service
619
+ * but also allows deep extension to match requirements of adopting applications.
620
+ *
621
+ * @since 1.93.0
622
+ */
623
+ class SearchCompositeControl extends sap.ui.core.Control {
624
+ /**
625
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
626
+ * See:
627
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
628
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
629
+ */
630
+ constructor(
631
+ /**
632
+ * Initial settings for the new control
633
+ */
634
+ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
635
+ );
636
+ /**
637
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
638
+ * See:
639
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
640
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
641
+ */
642
+ constructor(
643
+ /**
644
+ * ID for the new control, generated automatically if no ID is given
645
+ */
646
+ sId?: string,
647
+ /**
648
+ * Initial settings for the new control
649
+ */
650
+ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
651
+ );
652
+
653
+ /**
654
+ * Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches
655
+ * it with the information contained in `oClassInfo`.
656
+ *
657
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.VerticalLayout.extend}.
658
+ *
659
+ *
660
+ * @returns Created class / constructor function
661
+ */
662
+ static extend<T extends Record<string, unknown>>(
663
+ /**
664
+ * Name of the class being created
665
+ */
666
+ sClassName: string,
667
+ /**
668
+ * Object literal with information about the class
669
+ */
670
+ oClassInfo?: sap.ClassInfo<
671
+ T,
672
+ sap.esh.search.ui.SearchCompositeControl
673
+ >,
674
+ /**
675
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
676
+ * used by this class
677
+ */
678
+ FNMetaImpl?: Function
679
+ ): Function;
680
+ /**
681
+ * Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl.
682
+ *
683
+ *
684
+ * @returns Metadata object describing this class
685
+ */
686
+ static getMetadata(): sap.ui.core.ElementMetadata;
687
+ /**
688
+ * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
689
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
690
+ *
691
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
692
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
693
+ *
694
+ * Event is fired after result view type got changed (list, table or grid).
695
+ *
696
+ * @since 1.124
697
+ *
698
+ * @returns Reference to `this` in order to allow method chaining
699
+ */
700
+ attachResultViewTypeChanged(
701
+ /**
702
+ * An application-specific payload object that will be passed to the event handler along with the event
703
+ * object when firing the event
704
+ */
705
+ oData: object,
706
+ /**
707
+ * The function to be called when the event occurs
708
+ */
709
+ fnFunction: (p1: sap.ui.base.Event) => void,
710
+ /**
711
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
712
+ * itself
713
+ */
714
+ oListener?: object
715
+ ): this;
716
+ /**
717
+ * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
718
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
719
+ *
720
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
721
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
722
+ *
723
+ * Event is fired after result view type got changed (list, table or grid).
724
+ *
725
+ * @since 1.124
726
+ *
727
+ * @returns Reference to `this` in order to allow method chaining
728
+ */
729
+ attachResultViewTypeChanged(
730
+ /**
731
+ * The function to be called when the event occurs
732
+ */
733
+ fnFunction: (p1: sap.ui.base.Event) => void,
734
+ /**
735
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
736
+ * itself
737
+ */
738
+ oListener?: object
739
+ ): this;
740
+ /**
741
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
742
+ * `sap.esh.search.ui.SearchCompositeControl`.
743
+ *
744
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
745
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
746
+ *
747
+ * Event is fired when search is finished.
748
+ *
749
+ * @since 1.121
750
+ *
751
+ * @returns Reference to `this` in order to allow method chaining
752
+ */
753
+ attachSearchFinished(
754
+ /**
755
+ * An application-specific payload object that will be passed to the event handler along with the event
756
+ * object when firing the event
757
+ */
758
+ oData: object,
759
+ /**
760
+ * The function to be called when the event occurs
761
+ */
762
+ fnFunction: (p1: sap.ui.base.Event) => void,
763
+ /**
764
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
765
+ * itself
766
+ */
767
+ oListener?: object
768
+ ): this;
769
+ /**
770
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
771
+ * `sap.esh.search.ui.SearchCompositeControl`.
772
+ *
773
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
774
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
775
+ *
776
+ * Event is fired when search is finished.
777
+ *
778
+ * @since 1.121
779
+ *
780
+ * @returns Reference to `this` in order to allow method chaining
781
+ */
782
+ attachSearchFinished(
783
+ /**
784
+ * The function to be called when the event occurs
785
+ */
786
+ fnFunction: (p1: sap.ui.base.Event) => void,
787
+ /**
788
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
789
+ * itself
790
+ */
791
+ oListener?: object
792
+ ): this;
793
+ /**
794
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
795
+ *
796
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
797
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
798
+ *
799
+ * Event is fired when search is started.
800
+ *
801
+ * @since 1.121
802
+ *
803
+ * @returns Reference to `this` in order to allow method chaining
804
+ */
805
+ attachSearchStarted(
806
+ /**
807
+ * An application-specific payload object that will be passed to the event handler along with the event
808
+ * object when firing the event
809
+ */
810
+ oData: object,
811
+ /**
812
+ * The function to be called when the event occurs
813
+ */
814
+ fnFunction: (p1: sap.ui.base.Event) => void,
815
+ /**
816
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
817
+ * itself
818
+ */
819
+ oListener?: object
820
+ ): this;
821
+ /**
822
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
823
+ *
824
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
825
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
826
+ *
827
+ * Event is fired when search is started.
828
+ *
829
+ * @since 1.121
830
+ *
831
+ * @returns Reference to `this` in order to allow method chaining
832
+ */
833
+ attachSearchStarted(
834
+ /**
835
+ * The function to be called when the event occurs
836
+ */
837
+ fnFunction: (p1: sap.ui.base.Event) => void,
838
+ /**
839
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
840
+ * itself
841
+ */
842
+ oListener?: object
843
+ ): this;
844
+ /**
845
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
846
+ * this `sap.esh.search.ui.SearchCompositeControl`.
847
+ *
848
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
849
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
850
+ *
851
+ * Event is fired when selection on result view (list, table or grid) has changed.
852
+ *
853
+ * @since 1.121
854
+ *
855
+ * @returns Reference to `this` in order to allow method chaining
856
+ */
857
+ attachSelectionChanged(
858
+ /**
859
+ * An application-specific payload object that will be passed to the event handler along with the event
860
+ * object when firing the event
861
+ */
862
+ oData: object,
863
+ /**
864
+ * The function to be called when the event occurs
865
+ */
866
+ fnFunction: (p1: sap.ui.base.Event) => void,
867
+ /**
868
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
869
+ * itself
870
+ */
871
+ oListener?: object
872
+ ): this;
873
+ /**
874
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
875
+ * this `sap.esh.search.ui.SearchCompositeControl`.
876
+ *
877
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
878
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
879
+ *
880
+ * Event is fired when selection on result view (list, table or grid) has changed.
881
+ *
882
+ * @since 1.121
883
+ *
884
+ * @returns Reference to `this` in order to allow method chaining
885
+ */
886
+ attachSelectionChanged(
887
+ /**
888
+ * The function to be called when the event occurs
889
+ */
890
+ fnFunction: (p1: sap.ui.base.Event) => void,
891
+ /**
892
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
893
+ * itself
894
+ */
895
+ oListener?: object
896
+ ): this;
897
+ /**
898
+ * Attaches event handler `fnFunction` to the {@link #event:showResultDetail showResultDetail} event of
899
+ * this `sap.esh.search.ui.SearchCompositeControl`.
900
+ *
901
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
902
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
903
+ *
904
+ * Event is fired after result view detail button is pressed (list, table or grid). To use this event, set
905
+ * the property 'resultviewMasterDetailMode' to 'true'.
906
+ *
907
+ * @since 1.140.0
908
+ *
909
+ * @returns Reference to `this` in order to allow method chaining
910
+ */
911
+ attachShowResultDetail(
912
+ /**
913
+ * An application-specific payload object that will be passed to the event handler along with the event
914
+ * object when firing the event
915
+ */
916
+ oData: object,
917
+ /**
918
+ * The function to be called when the event occurs
919
+ */
920
+ fnFunction: (p1: sap.ui.base.Event) => void,
921
+ /**
922
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
923
+ * itself
924
+ */
925
+ oListener?: object
926
+ ): this;
927
+ /**
928
+ * Attaches event handler `fnFunction` to the {@link #event:showResultDetail showResultDetail} event of
929
+ * this `sap.esh.search.ui.SearchCompositeControl`.
930
+ *
931
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
932
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
933
+ *
934
+ * Event is fired after result view detail button is pressed (list, table or grid). To use this event, set
935
+ * the property 'resultviewMasterDetailMode' to 'true'.
936
+ *
937
+ * @since 1.140.0
938
+ *
939
+ * @returns Reference to `this` in order to allow method chaining
940
+ */
941
+ attachShowResultDetail(
942
+ /**
943
+ * The function to be called when the event occurs
944
+ */
945
+ fnFunction: (p1: sap.ui.base.Event) => void,
946
+ /**
947
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
948
+ * itself
949
+ */
950
+ oListener?: object
951
+ ): this;
952
+ /**
953
+ * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
954
+ * event of this `sap.esh.search.ui.SearchCompositeControl`.
955
+ *
956
+ * The passed function and listener object must match the ones used for event registration.
957
+ *
958
+ * @since 1.124
959
+ *
960
+ * @returns Reference to `this` in order to allow method chaining
961
+ */
962
+ detachResultViewTypeChanged(
963
+ /**
964
+ * The function to be called, when the event occurs
965
+ */
966
+ fnFunction: (p1: sap.ui.base.Event) => void,
967
+ /**
968
+ * Context object on which the given function had to be called
969
+ */
970
+ oListener?: object
971
+ ): this;
972
+ /**
973
+ * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
974
+ * `sap.esh.search.ui.SearchCompositeControl`.
975
+ *
976
+ * The passed function and listener object must match the ones used for event registration.
977
+ *
978
+ * @since 1.121
979
+ *
980
+ * @returns Reference to `this` in order to allow method chaining
981
+ */
982
+ detachSearchFinished(
983
+ /**
984
+ * The function to be called, when the event occurs
985
+ */
986
+ fnFunction: (p1: sap.ui.base.Event) => void,
987
+ /**
988
+ * Context object on which the given function had to be called
989
+ */
990
+ oListener?: object
991
+ ): this;
992
+ /**
993
+ * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
994
+ * `sap.esh.search.ui.SearchCompositeControl`.
995
+ *
996
+ * The passed function and listener object must match the ones used for event registration.
997
+ *
998
+ * @since 1.121
999
+ *
1000
+ * @returns Reference to `this` in order to allow method chaining
1001
+ */
1002
+ detachSearchStarted(
1003
+ /**
1004
+ * The function to be called, when the event occurs
1005
+ */
1006
+ fnFunction: (p1: sap.ui.base.Event) => void,
1007
+ /**
1008
+ * Context object on which the given function had to be called
1009
+ */
1010
+ oListener?: object
1011
+ ): this;
1012
+ /**
1013
+ * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of
1014
+ * this `sap.esh.search.ui.SearchCompositeControl`.
1015
+ *
1016
+ * The passed function and listener object must match the ones used for event registration.
1017
+ *
1018
+ * @since 1.121
1019
+ *
1020
+ * @returns Reference to `this` in order to allow method chaining
1021
+ */
1022
+ detachSelectionChanged(
1023
+ /**
1024
+ * The function to be called, when the event occurs
1025
+ */
1026
+ fnFunction: (p1: sap.ui.base.Event) => void,
1027
+ /**
1028
+ * Context object on which the given function had to be called
1029
+ */
1030
+ oListener?: object
1031
+ ): this;
1032
+ /**
1033
+ * Detaches event handler `fnFunction` from the {@link #event:showResultDetail showResultDetail} event of
1034
+ * this `sap.esh.search.ui.SearchCompositeControl`.
1035
+ *
1036
+ * The passed function and listener object must match the ones used for event registration.
1037
+ *
1038
+ * @since 1.140.0
1039
+ *
1040
+ * @returns Reference to `this` in order to allow method chaining
1041
+ */
1042
+ detachShowResultDetail(
1043
+ /**
1044
+ * The function to be called, when the event occurs
1045
+ */
1046
+ fnFunction: (p1: sap.ui.base.Event) => void,
1047
+ /**
1048
+ * Context object on which the given function had to be called
1049
+ */
1050
+ oListener?: object
1051
+ ): this;
1052
+ /**
1053
+ * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
1054
+ *
1055
+ * @since 1.124
1056
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1057
+ *
1058
+ * @returns Reference to `this` in order to allow method chaining
1059
+ */
1060
+ fireResultViewTypeChanged(
1061
+ /**
1062
+ * Parameters to pass along with the event
1063
+ */
1064
+ mParameters?: object
1065
+ ): this;
1066
+ /**
1067
+ * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
1068
+ *
1069
+ * @since 1.121
1070
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1071
+ *
1072
+ * @returns Reference to `this` in order to allow method chaining
1073
+ */
1074
+ fireSearchFinished(
1075
+ /**
1076
+ * Parameters to pass along with the event
1077
+ */
1078
+ mParameters?: object
1079
+ ): this;
1080
+ /**
1081
+ * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
1082
+ *
1083
+ * @since 1.121
1084
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1085
+ *
1086
+ * @returns Reference to `this` in order to allow method chaining
1087
+ */
1088
+ fireSearchStarted(
1089
+ /**
1090
+ * Parameters to pass along with the event
1091
+ */
1092
+ mParameters?: object
1093
+ ): this;
1094
+ /**
1095
+ * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
1096
+ *
1097
+ * @since 1.121
1098
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1099
+ *
1100
+ * @returns Reference to `this` in order to allow method chaining
1101
+ */
1102
+ fireSelectionChanged(
1103
+ /**
1104
+ * Parameters to pass along with the event
1105
+ */
1106
+ mParameters?: object
1107
+ ): this;
1108
+ /**
1109
+ * Fires event {@link #event:showResultDetail showResultDetail} to attached listeners.
1110
+ *
1111
+ * @since 1.140.0
1112
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1113
+ *
1114
+ * @returns Reference to `this` in order to allow method chaining
1115
+ */
1116
+ fireShowResultDetail(
1117
+ /**
1118
+ * Parameters to pass along with the event
1119
+ */
1120
+ mParameters?: object
1121
+ ): this;
1122
+ /**
1123
+ * Gets current value of property {@link #getApplicationComponent applicationComponent}.
1124
+ *
1125
+ * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
1126
+ *
1127
+ * Default value is `"HAN-AS-INA-UI"`.
1128
+ *
1129
+ * @since 1.108.0
1130
+ *
1131
+ * @returns Value of property `applicationComponent`
1132
+ */
1133
+ getApplicationComponent(): string;
1134
+ /**
1135
+ * Gets current value of property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
1136
+ *
1137
+ * In case folder mode is active: Automatically switch result view type to list in search mode and to table
1138
+ * in folder mode.
1139
+ *
1140
+ * Default value is `false`.
1141
+ *
1142
+ * @since 1.106.0
1143
+ *
1144
+ * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
1145
+ */
1146
+ getAutoAdjustResultViewTypeInFolderMode(): boolean;
1147
+ /**
1148
+ * Gets current value of property {@link #getBoSuggestions boSuggestions}.
1149
+ *
1150
+ * A boolean for enabling (business) object suggestions.
1151
+ *
1152
+ * Default value is `false`.
1153
+ *
1154
+ * @since 1.113.0
1155
+ *
1156
+ * @returns Value of property `boSuggestions`
1157
+ */
1158
+ getBoSuggestions(): boolean;
1159
+ /**
1160
+ * Gets current value of property {@link #getCssClass cssClass}.
1161
+ *
1162
+ * An additional CSS class to add to this control
1163
+ *
1164
+ * @since 1.93.0
1165
+ *
1166
+ * @returns Value of property `cssClass`
1167
+ */
1168
+ getCssClass(): string;
1169
+ /**
1170
+ * Gets current value of property {@link #getDataSource dataSource}.
1171
+ *
1172
+ * The id of the data source in which it will search right after initialization.
1173
+ *
1174
+ * @since 1.98.0
1175
+ *
1176
+ * @returns Value of property `dataSource`
1177
+ */
1178
+ getDataSource(): string;
1179
+ /**
1180
+ * Gets current value of property {@link #getDefaultDataSource defaultDataSource}.
1181
+ *
1182
+ * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
1183
+ * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
1184
+ * to 'true', do not set this parameter (will be ignored).
1185
+ *
1186
+ * @since 1.93.0
1187
+ *
1188
+ * @returns Value of property `defaultDataSource`
1189
+ */
1190
+ getDefaultDataSource(): string;
1191
+ /**
1192
+ * Gets current value of property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
1193
+ *
1194
+ * When set to true the facet panel is displayed also in case there are no search results.
1195
+ *
1196
+ * Default value is `false`.
1197
+ *
1198
+ * @since 1.113.0
1199
+ * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
1200
+ * by the end user.
1201
+ *
1202
+ * @returns Value of property `displayFacetPanelInCaseOfNoResults`
1203
+ */
1204
+ getDisplayFacetPanelInCaseOfNoResults(): boolean;
1205
+ /**
1206
+ * Gets current value of property {@link #getEnableCharts enableCharts}.
1207
+ *
1208
+ * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can
1209
+ * be viewed as a pie or bar chart (this cannot be deactivated at runtime).
1210
+ *
1211
+ * Default value is `false`.
1212
+ *
1213
+ * @since 1.140.0
1214
+ *
1215
+ * @returns Value of property `enableCharts`
1216
+ */
1217
+ getEnableCharts(): boolean;
1218
+ /**
1219
+ * Gets current value of property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
1220
+ *
1221
+ * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
1222
+ * the value is set to 'true'.
1223
+ *
1224
+ * Default value is `false`.
1225
+ *
1226
+ * @since 1.96.0
1227
+ * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead.
1228
+ *
1229
+ * @returns Value of property `enableMultiSelectionResultItems`
1230
+ */
1231
+ getEnableMultiSelectionResultItems(): boolean;
1232
+ /**
1233
+ * Gets current value of property {@link #getEnableQueryLanguage enableQueryLanguage}.
1234
+ *
1235
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
1236
+ * user to enter complex search queries with logical operators.
1237
+ *
1238
+ * Default value is `false`.
1239
+ *
1240
+ * @since 1.107.0
1241
+ *
1242
+ * @returns Value of property `enableQueryLanguage`
1243
+ */
1244
+ getEnableQueryLanguage(): boolean;
1245
+ /**
1246
+ * Gets current value of property {@link #getEventConsumers eventConsumers}.
1247
+ *
1248
+ * Adds a callback function which is called whenever there is a user or a technical event. A user event
1249
+ * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
1250
+ * is an event which is triggered by the internal events or events which can also be triggered by API.
1251
+ *
1252
+ * @since 1.120
1253
+ *
1254
+ * @returns Value of property `eventConsumers`
1255
+ */
1256
+ getEventConsumers(): string;
1257
+ /**
1258
+ * Gets current value of property {@link #getExclusiveDataSource exclusiveDataSource}.
1259
+ *
1260
+ * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
1261
+ * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
1262
+ * panel) - data source name/link on result list (header section of item)
1263
+ *
1264
+ * @since 1.121.0
1265
+ *
1266
+ * @returns Value of property `exclusiveDataSource`
1267
+ */
1268
+ getExclusiveDataSource(): string;
1269
+ /**
1270
+ * Gets current value of property {@link #getFacetPanelResizable facetPanelResizable}.
1271
+ *
1272
+ * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
1273
+ *
1274
+ * Default value is `true`.
1275
+ *
1276
+ * @since 1.108.0
1277
+ *
1278
+ * @returns Value of property `facetPanelResizable`
1279
+ */
1280
+ getFacetPanelResizable(): boolean;
1281
+ /**
1282
+ * Gets current value of property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
1283
+ *
1284
+ * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
1285
+ * is true, the width of the facet panel can be changed by the user.
1286
+ *
1287
+ * Default value is `25`.
1288
+ *
1289
+ * @since 1.108.0
1290
+ *
1291
+ * @returns Value of property `facetPanelWidthInPercent`
1292
+ */
1293
+ getFacetPanelWidthInPercent(): float;
1294
+ /**
1295
+ * Gets current value of property {@link #getFacets facets}.
1296
+ *
1297
+ * Controls whether the facet functionality is available or not.
1298
+ *
1299
+ * Default value is `true`.
1300
+ *
1301
+ * @since 1.132.0
1302
+ *
1303
+ * @returns Value of property `facets`
1304
+ */
1305
+ getFacets(): boolean;
1306
+ /**
1307
+ * Gets current value of property {@link #getFacetToggleButtonLocation facetToggleButtonLocation}.
1308
+ *
1309
+ * Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin)
1310
+ * or on the right (end) of the search bar. By default the button's location is at the beginning (left),
1311
+ * values are "Begin" and "End". The property is not evaluated if facet panel is disabled, see property
1312
+ * 'facets'.
1313
+ *
1314
+ * Default value is `"Begin"`.
1315
+ *
1316
+ * @since 1.140.0
1317
+ * @experimental As of version 1.140.0. this feature is experimental and the API may change.
1318
+ *
1319
+ * @returns Value of property `facetToggleButtonLocation`
1320
+ */
1321
+ getFacetToggleButtonLocation(): string;
1322
+ /**
1323
+ * Gets current value of property {@link #getFacetVisibility facetVisibility}.
1324
+ *
1325
+ * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
1326
+ * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
1327
+ * depending on the user's personalization settings.
1328
+ *
1329
+ * Default value is `false`.
1330
+ *
1331
+ * @since 1.113.0
1332
+ *
1333
+ * @returns Value of property `facetVisibility`
1334
+ */
1335
+ getFacetVisibility(): boolean;
1336
+ /**
1337
+ * Gets current value of property {@link #getFilterDataSources filterDataSources}.
1338
+ *
1339
+ * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
1340
+ * a list of datsources and returns the filtered list of datasources.
1341
+ *
1342
+ * @since 1.112.0
1343
+ *
1344
+ * @returns Value of property `filterDataSources`
1345
+ */
1346
+ getFilterDataSources(): Function;
1347
+ /**
1348
+ * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
1349
+ *
1350
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
1351
+ * control only allows filter trees which have a the following structure: complex condition (root level)
1352
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
1353
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
1354
+ * for a more in-depth example.
1355
+ *
1356
+ * @since 1.98.0
1357
+ *
1358
+ * @returns Value of property `filterRootCondition`
1359
+ */
1360
+ getFilterRootCondition(): object;
1361
+ /**
1362
+ * Gets current value of property {@link #getFolderMode folderMode}.
1363
+ *
1364
+ * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
1365
+ * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
1366
+ * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
1367
+ * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
1368
+ * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
1369
+ * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
1370
+ * are set.
1371
+ *
1372
+ * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
1373
+ * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
1374
+ * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
1375
+ * children of a folder.
1376
+ *
1377
+ * @since 1.106.0
1378
+ *
1379
+ * @returns Value of property `folderMode`
1380
+ */
1381
+ getFolderMode(): boolean;
1382
+ /**
1383
+ * Gets current value of property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}.
1384
+ *
1385
+ * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
1386
+ * is enabled.
1387
+ *
1388
+ * Default value is `false`.
1389
+ *
1390
+ * @since 1.114.0
1391
+ *
1392
+ * @returns Value of property `folderModeForInitialSearch`
1393
+ */
1394
+ getFolderModeForInitialSearch(): boolean;
1395
+ /**
1396
+ * Gets current value of property {@link #getFormatFilterBarText formatFilterBarText}.
1397
+ *
1398
+ * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
1399
+ *
1400
+ * @since 1.120
1401
+ *
1402
+ * @returns Value of property `formatFilterBarText`
1403
+ */
1404
+ getFormatFilterBarText(): Function;
1405
+ /**
1406
+ * Gets current value of property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
1407
+ *
1408
+ * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
1409
+ * to be more specific and add some hints, links, buttons or other content.
1410
+ *
1411
+ * @since 1.94.0
1412
+ *
1413
+ * @returns Value of property `getCustomNoResultScreen`
1414
+ */
1415
+ getGetCustomNoResultScreen(): Function;
1416
+ /**
1417
+ * Gets current value of property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
1418
+ *
1419
+ * A callback which returns customized "label" for placeholder text of search box in case there is no search
1420
+ * term. The placeholder text (en) will be "Search In: ".
1421
+ *
1422
+ *
1423
+ * @returns Value of property `getSearchInputPlaceholderLabel`
1424
+ */
1425
+ getGetSearchInputPlaceholderLabel(): Function;
1426
+ /**
1427
+ * Gets current value of property {@link #getInitAsync initAsync}.
1428
+ *
1429
+ * An asynchronues callback which is called after the initialization of the search composite control.
1430
+ *
1431
+ * @since 1.113.0
1432
+ *
1433
+ * @returns Value of property `initAsync`
1434
+ */
1435
+ getInitAsync(): Function;
1436
+ /**
1437
+ * Get the status of initialization. In unsuccessful case, the corresponding error instance is returned
1438
+ * either.
1439
+ *
1440
+ * @since 1.132.0
1441
+ *
1442
+ * @returns Promise<{success: boolean;error?: Error;}> If success is true, the initialization was successful.
1443
+ * If success is false, the error property contains the error instance for further handling.
1444
+ */
1445
+ getInitializationStatus(): object;
1446
+ /**
1447
+ * Gets current value of property {@link #getIsFilterBarVisible isFilterBarVisible}.
1448
+ *
1449
+ * Callback for checking whether the filter bar is visible.
1450
+ *
1451
+ * @since 1.120
1452
+ *
1453
+ * @returns Value of property `isFilterBarVisible`
1454
+ */
1455
+ getIsFilterBarVisible(): Function;
1456
+ /**
1457
+ * Gets current value of property {@link #getIsSearchUrl isSearchUrl}.
1458
+ *
1459
+ * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
1460
+ * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
1461
+ * of 'updateUrl = true'.
1462
+ *
1463
+ * @since 1.113.0
1464
+ *
1465
+ * @returns Value of property `isSearchUrl`
1466
+ */
1467
+ getIsSearchUrl(): Function;
1468
+ /**
1469
+ * Gets current value of property {@link #getLimitAjaxRequests limitAjaxRequests}.
1470
+ *
1471
+ * Prevents too many ajax requests in a short time.
1472
+ *
1473
+ * Default value is `true`.
1474
+ *
1475
+ *
1476
+ * @returns Value of property `limitAjaxRequests`
1477
+ */
1478
+ getLimitAjaxRequests(): boolean;
1479
+ /**
1480
+ * Gets current value of property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
1481
+ *
1482
+ * The layout is optimized for object selection / value help (narrow view w/o facet panel).
1483
+ *
1484
+ * @since 1.111.0
1485
+ *
1486
+ * @returns Value of property `optimizeForValueHelp`
1487
+ */
1488
+ getOptimizeForValueHelp(): boolean;
1489
+ /**
1490
+ * Gets current value of property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
1491
+ *
1492
+ * Shall the window title be overwritten by this control? If true, the control will set the current search
1493
+ * condition as window title. If false, it will not set or update the window title.
1494
+ *
1495
+ * @since 1.93.0
1496
+ *
1497
+ * @returns Value of property `overwriteBrowserTitle`
1498
+ */
1499
+ getOverwriteBrowserTitle(): boolean;
1500
+ /**
1501
+ * Gets current value of property {@link #getPageSize pageSize}.
1502
+ *
1503
+ * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
1504
+ * button, another page of result items of the same count (if available) will be displayed.
1505
+ *
1506
+ * Default value is `10`.
1507
+ *
1508
+ * @since 1.96.0
1509
+ *
1510
+ * @returns Value of property `pageSize`
1511
+ */
1512
+ getPageSize(): int;
1513
+ /**
1514
+ * Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
1515
+ *
1516
+ * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
1517
+ * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
1518
+ * is not needed.
1519
+ *
1520
+ * @since 1.113.0
1521
+ *
1522
+ * @returns Value of property `parseSearchUrlParameters`
1523
+ */
1524
+ getParseSearchUrlParameters(): Function;
1525
+ /**
1526
+ * Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
1527
+ *
1528
+ * A list of data sources to be displayed in the facet panel in the section "Collection".
1529
+ *
1530
+ * @since 1.113.0
1531
+ *
1532
+ * @returns Value of property `quickSelectDataSources`
1533
+ */
1534
+ getQuickSelectDataSources(): object;
1535
+ /**
1536
+ * Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}.
1537
+ *
1538
+ * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
1539
+ * the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
1540
+ *
1541
+ * @since 1.113.0
1542
+ *
1543
+ * @returns Value of property `renderSearchUrl`
1544
+ */
1545
+ getRenderSearchUrl(): Function;
1546
+ /**
1547
+ * Gets current value of property {@link #getResultviewMasterDetailMode resultviewMasterDetailMode}.
1548
+ *
1549
+ * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever
1550
+ * the detail button/indicator is clicked.
1551
+ *
1552
+ * Default value is `false`.
1553
+ *
1554
+ * @since 1.140.0
1555
+ *
1556
+ * @returns Value of property `resultviewMasterDetailMode`
1557
+ */
1558
+ getResultviewMasterDetailMode(): boolean;
1559
+ /**
1560
+ * Gets current value of property {@link #getResultviewSelectionMode resultviewSelectionMode}.
1561
+ *
1562
+ * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems')
1563
+ * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None',
1564
+ * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'.
1565
+ * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode`
1566
+ * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked.
1567
+ *
1568
+ * Default value is `"None"`.
1569
+ *
1570
+ * @since 1.141.0
1571
+ *
1572
+ * @returns Value of property `resultviewSelectionMode`
1573
+ */
1574
+ getResultviewSelectionMode(): string;
1575
+ /**
1576
+ * Gets current value of property {@link #getResultViewSettings resultViewSettings}.
1577
+ *
1578
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
1579
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
1580
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
1581
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
1582
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
1583
+ * and `resultViewType` must be compatible to each other.
1584
+ *
1585
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1586
+ *
1587
+ * Default value is `...see text or source`.
1588
+ *
1589
+ * @since 1.100.0
1590
+ *
1591
+ * @returns Value of property `resultViewSettings`
1592
+ */
1593
+ getResultViewSettings(): string;
1594
+ /**
1595
+ * Gets current value of property {@link #getResultViewType resultViewType}.
1596
+ *
1597
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
1598
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
1599
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
1600
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
1601
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
1602
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
1603
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
1604
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
1605
+ *
1606
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1607
+ *
1608
+ * Default value is `"searchResultList"`.
1609
+ *
1610
+ * @since 1.98.0
1611
+ *
1612
+ * @returns Value of property `resultViewType`
1613
+ */
1614
+ getResultViewType(): string;
1615
+ /**
1616
+ * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
1617
+ *
1618
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
1619
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
1620
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
1621
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
1622
+ * Search in Business Object: result is switchable between different view types. Possible values for the
1623
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
1624
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
1625
+ *
1626
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1627
+ *
1628
+ * Default value is `["searchResultList", "searchResultTable"]`.
1629
+ *
1630
+ * @since 1.98.0
1631
+ *
1632
+ * @returns Value of property `resultViewTypes`
1633
+ */
1634
+ getResultViewTypes(): string[];
1635
+ /**
1636
+ * Gets current value of property {@link #getSearchInputLocation searchInputLocation}.
1637
+ *
1638
+ * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
1639
+ * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
1640
+ *
1641
+ * Default value is `"Top"`.
1642
+ *
1643
+ * @since 1.140.0
1644
+ * @experimental As of version 1.140.0. this feature is experimental and the API may change.
1645
+ *
1646
+ * @returns Value of property `searchInputLocation`
1647
+ */
1648
+ getSearchInputLocation(): string;
1649
+ /**
1650
+ * Gets current value of property {@link #getSearchOnStart searchOnStart}.
1651
+ *
1652
+ * Defines if the search composite control will send a search request directly after loading, using given
1653
+ * search term, data source and filter root condition settings.
1654
+ *
1655
+ * Default value is `true`.
1656
+ *
1657
+ * @since 1.93.0
1658
+ *
1659
+ * @returns Value of property `searchOnStart`
1660
+ */
1661
+ getSearchOnStart(): boolean;
1662
+ /**
1663
+ * Gets current value of property {@link #getSearchTerm searchTerm}.
1664
+ *
1665
+ * Defines the initial search term for the search input.
1666
+ *
1667
+ * Default value is `empty string`.
1668
+ *
1669
+ * @since 1.93.0
1670
+ *
1671
+ * @returns Value of property `searchTerm`
1672
+ */
1673
+ getSearchTerm(): string;
1674
+ /**
1675
+ * Gets current value of property {@link #getSearchTermLengthLimit searchTermLengthLimit}.
1676
+ *
1677
+ * Limit for length of searchterm.
1678
+ *
1679
+ * Default value is `1000`.
1680
+ *
1681
+ *
1682
+ * @returns Value of property `searchTermLengthLimit`
1683
+ */
1684
+ getSearchTermLengthLimit(): int;
1685
+ /**
1686
+ * Gets current value of property {@link #getSelectionChange selectionChange}.
1687
+ *
1688
+ * A callback which is called whenever the selection of result view items changes.
1689
+ *
1690
+ * @since 1.113.0
1691
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
1692
+ *
1693
+ * @returns Value of property `selectionChange`
1694
+ */
1695
+ getSelectionChange(): Function;
1696
+ /**
1697
+ * Gets current value of property {@link #getShowSelectionToggleButton showSelectionToggleButton}.
1698
+ *
1699
+ * Enables the selection toggle button in the search result list. The button is displayed on the top of
1700
+ * search result view and allows to toggle the selection of all result items. The button is only displayed
1701
+ * if the property 'resultviewSelectionMode' is not set to 'None'.
1702
+ *
1703
+ * Default value is `false`.
1704
+ *
1705
+ * @since 1.140.0
1706
+ *
1707
+ * @returns Value of property `showSelectionToggleButton`
1708
+ */
1709
+ getShowSelectionToggleButton(): boolean;
1710
+ /**
1711
+ * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
1712
+ *
1713
+ * Configuration for the Enterprise Search Client API.
1714
+ *
1715
+ * @since 1.93.0
1716
+ *
1717
+ * @returns Value of property `sinaConfiguration`
1718
+ */
1719
+ getSinaConfiguration(): object;
1720
+ /**
1721
+ * Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}.
1722
+ *
1723
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
1724
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
1725
+ * in the tabstrips.
1726
+ *
1727
+ * @since 1.103.0
1728
+ *
1729
+ * @returns Value of property `tabStripsFormatter`
1730
+ */
1731
+ getTabStripsFormatter(): Function;
1732
+ /**
1733
+ * Gets current value of property {@link #getUpdateUrl updateUrl}.
1734
+ *
1735
+ * A boolean indicating that the search state is written to the URL.
1736
+ *
1737
+ * Default value is `true`.
1738
+ *
1739
+ * @since 1.113.0
1740
+ *
1741
+ * @returns Value of property `updateUrl`
1742
+ */
1743
+ getUpdateUrl(): boolean;
1744
+ /**
1745
+ * Invalidate the search cache. To trigger a search in addition, use function 'retriggerSearch' instead.
1746
+ *
1747
+ * @since 1.124.0
1748
+ */
1749
+ invalidateSearchResultCache(): Promise<void>;
1750
+ /**
1751
+ * Resets the active data source which is selected in the data source drop down list to its default (see
1752
+ * 'defaultDataSource'/'exclusiveDataSource').
1753
+ *
1754
+ * @since 1.124.0
1755
+ */
1756
+ resetDataSource(
1757
+ /**
1758
+ * If true, fires a search query right away. Set to 'false' for batch updates.
1759
+ */
1760
+ fireQuery?: boolean
1761
+ ): this;
1762
+ /**
1763
+ * Resets the UI / search results (reset search query and fire a new search).
1764
+ *
1765
+ * @since 1.125.0
1766
+ */
1767
+ resetSearch(): Promise<void>;
1768
+ /**
1769
+ * Fire a new search (includes invalidation of search cache). To invalidate the search cache w/o triggering
1770
+ * a new search, use function 'invalidateSearchResultCache' instead.
1771
+ *
1772
+ * @since 1.124.0
1773
+ */
1774
+ retriggerSearch(): Promise<void>;
1775
+ /**
1776
+ * Invalidate the search cache and optionally fire a new search. Also see functions 'retriggerSearch' and
1777
+ * 'invalidateSearchResultCache'.
1778
+ *
1779
+ * @since 1.124.0
1780
+ *
1781
+ * @returns Returns 'true' if the search query was fired, otherwise 'void'.
1782
+ */
1783
+ search(
1784
+ /**
1785
+ * Indicates wether the search query should be resetted. Set to 'true' to reset the query.
1786
+ */
1787
+ invalidateQuery?: boolean,
1788
+ /**
1789
+ * Indicates wether the search query should be sent to the search service or not. Set to 'false', to prevent
1790
+ * auto-update of search results.
1791
+ */
1792
+ fireQuery?: boolean
1793
+ ): Promise<true | void>;
1794
+ /**
1795
+ * Sets a new value for property {@link #getApplicationComponent applicationComponent}.
1796
+ *
1797
+ * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
1798
+ *
1799
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1800
+ *
1801
+ * Default value is `"HAN-AS-INA-UI"`.
1802
+ *
1803
+ * @since 1.108.0
1804
+ *
1805
+ * @returns Reference to `this` in order to allow method chaining
1806
+ */
1807
+ setApplicationComponent(
1808
+ /**
1809
+ * New value for property `applicationComponent`
1810
+ */
1811
+ sApplicationComponent?: string
1812
+ ): this;
1813
+ /**
1814
+ * Sets a new value for property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
1815
+ *
1816
+ * In case folder mode is active: Automatically switch result view type to list in search mode and to table
1817
+ * in folder mode.
1818
+ *
1819
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1820
+ *
1821
+ * Default value is `false`.
1822
+ *
1823
+ * @since 1.106.0
1824
+ *
1825
+ * @returns Reference to `this` in order to allow method chaining
1826
+ */
1827
+ setAutoAdjustResultViewTypeInFolderMode(
1828
+ /**
1829
+ * New value for property `autoAdjustResultViewTypeInFolderMode`
1830
+ */
1831
+ bAutoAdjustResultViewTypeInFolderMode?: boolean
1832
+ ): this;
1833
+ /**
1834
+ * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
1835
+ *
1836
+ * A boolean for enabling (business) object suggestions.
1837
+ *
1838
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1839
+ *
1840
+ * Default value is `false`.
1841
+ *
1842
+ * @since 1.113.0
1843
+ *
1844
+ * @returns Reference to `this` in order to allow method chaining
1845
+ */
1846
+ setBoSuggestions(
1847
+ /**
1848
+ * New value for property `boSuggestions`
1849
+ */
1850
+ bBoSuggestions?: boolean
1851
+ ): this;
1852
+ /**
1853
+ * Sets a new value for property {@link #getCssClass cssClass}.
1854
+ *
1855
+ * An additional CSS class to add to this control
1856
+ *
1857
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1858
+ *
1859
+ * @since 1.93.0
1860
+ *
1861
+ * @returns Reference to `this` in order to allow method chaining
1862
+ */
1863
+ setCssClass(
1864
+ /**
1865
+ * New value for property `cssClass`
1866
+ */
1867
+ sCssClass: string
1868
+ ): this;
1869
+ /**
1870
+ * Sets a new value for property {@link #getDataSource dataSource}.
1871
+ *
1872
+ * The id of the data source in which it will search right after initialization.
1873
+ *
1874
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1875
+ *
1876
+ * @since 1.98.0
1877
+ *
1878
+ * @returns Reference to `this` in order to allow method chaining
1879
+ */
1880
+ setDataSource(
1881
+ /**
1882
+ * New value for property `dataSource`
1883
+ */
1884
+ sDataSource: string
1885
+ ): this;
1886
+ /**
1887
+ * Sets a new value for property {@link #getDefaultDataSource defaultDataSource}.
1888
+ *
1889
+ * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
1890
+ * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
1891
+ * to 'true', do not set this parameter (will be ignored).
1892
+ *
1893
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1894
+ *
1895
+ * @since 1.93.0
1896
+ *
1897
+ * @returns Reference to `this` in order to allow method chaining
1898
+ */
1899
+ setDefaultDataSource(
1900
+ /**
1901
+ * New value for property `defaultDataSource`
1902
+ */
1903
+ sDefaultDataSource: string
1904
+ ): this;
1905
+ /**
1906
+ * Sets a new value for property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
1907
+ *
1908
+ * When set to true the facet panel is displayed also in case there are no search results.
1909
+ *
1910
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1911
+ *
1912
+ * Default value is `false`.
1913
+ *
1914
+ * @since 1.113.0
1915
+ * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
1916
+ * by the end user.
1917
+ *
1918
+ * @returns Reference to `this` in order to allow method chaining
1919
+ */
1920
+ setDisplayFacetPanelInCaseOfNoResults(
1921
+ /**
1922
+ * New value for property `displayFacetPanelInCaseOfNoResults`
1923
+ */
1924
+ bDisplayFacetPanelInCaseOfNoResults?: boolean
1925
+ ): this;
1926
+ /**
1927
+ * Sets a new value for property {@link #getEnableCharts enableCharts}.
1928
+ *
1929
+ * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can
1930
+ * be viewed as a pie or bar chart (this cannot be deactivated at runtime).
1931
+ *
1932
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1933
+ *
1934
+ * Default value is `false`.
1935
+ *
1936
+ * @since 1.140.0
1937
+ *
1938
+ * @returns Reference to `this` in order to allow method chaining
1939
+ */
1940
+ setEnableCharts(
1941
+ /**
1942
+ * New value for property `enableCharts`
1943
+ */
1944
+ bEnableCharts?: boolean
1945
+ ): this;
1946
+ /**
1947
+ * Sets a new value for property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
1948
+ *
1949
+ * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
1950
+ * the value is set to 'true'.
1951
+ *
1952
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1953
+ *
1954
+ * Default value is `false`.
1955
+ *
1956
+ * @since 1.96.0
1957
+ * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead.
1958
+ *
1959
+ * @returns Reference to `this` in order to allow method chaining
1960
+ */
1961
+ setEnableMultiSelectionResultItems(
1962
+ /**
1963
+ * New value for property `enableMultiSelectionResultItems`
1964
+ */
1965
+ bEnableMultiSelectionResultItems?: boolean
1966
+ ): this;
1967
+ /**
1968
+ * Sets a new value for property {@link #getEnableQueryLanguage enableQueryLanguage}.
1969
+ *
1970
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
1971
+ * user to enter complex search queries with logical operators.
1972
+ *
1973
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1974
+ *
1975
+ * Default value is `false`.
1976
+ *
1977
+ * @since 1.107.0
1978
+ *
1979
+ * @returns Reference to `this` in order to allow method chaining
1980
+ */
1981
+ setEnableQueryLanguage(
1982
+ /**
1983
+ * New value for property `enableQueryLanguage`
1984
+ */
1985
+ bEnableQueryLanguage?: boolean
1986
+ ): this;
1987
+ /**
1988
+ * Sets a new value for property {@link #getEventConsumers eventConsumers}.
1989
+ *
1990
+ * Adds a callback function which is called whenever there is a user or a technical event. A user event
1991
+ * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
1992
+ * is an event which is triggered by the internal events or events which can also be triggered by API.
1993
+ *
1994
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1995
+ *
1996
+ * @since 1.120
1997
+ *
1998
+ * @returns Reference to `this` in order to allow method chaining
1999
+ */
2000
+ setEventConsumers(
2001
+ /**
2002
+ * New value for property `eventConsumers`
2003
+ */
2004
+ sEventConsumers: string
2005
+ ): this;
2006
+ /**
2007
+ * Sets a new value for property {@link #getExclusiveDataSource exclusiveDataSource}.
2008
+ *
2009
+ * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
2010
+ * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
2011
+ * panel) - data source name/link on result list (header section of item)
2012
+ *
2013
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2014
+ *
2015
+ * @since 1.121.0
2016
+ *
2017
+ * @returns Reference to `this` in order to allow method chaining
2018
+ */
2019
+ setExclusiveDataSource(
2020
+ /**
2021
+ * New value for property `exclusiveDataSource`
2022
+ */
2023
+ sExclusiveDataSource: string
2024
+ ): this;
2025
+ /**
2026
+ * Sets a new value for property {@link #getFacetPanelResizable facetPanelResizable}.
2027
+ *
2028
+ * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
2029
+ *
2030
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2031
+ *
2032
+ * Default value is `true`.
2033
+ *
2034
+ * @since 1.108.0
2035
+ *
2036
+ * @returns Reference to `this` in order to allow method chaining
2037
+ */
2038
+ setFacetPanelResizable(
2039
+ /**
2040
+ * New value for property `facetPanelResizable`
2041
+ */
2042
+ bFacetPanelResizable?: boolean
2043
+ ): this;
2044
+ /**
2045
+ * Sets a new value for property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
2046
+ *
2047
+ * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
2048
+ * is true, the width of the facet panel can be changed by the user.
2049
+ *
2050
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2051
+ *
2052
+ * Default value is `25`.
2053
+ *
2054
+ * @since 1.108.0
2055
+ *
2056
+ * @returns Reference to `this` in order to allow method chaining
2057
+ */
2058
+ setFacetPanelWidthInPercent(
2059
+ /**
2060
+ * New value for property `facetPanelWidthInPercent`
2061
+ */
2062
+ fFacetPanelWidthInPercent?: float
2063
+ ): this;
2064
+ /**
2065
+ * Sets a new value for property {@link #getFacets facets}.
2066
+ *
2067
+ * Controls whether the facet functionality is available or not.
2068
+ *
2069
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2070
+ *
2071
+ * Default value is `true`.
2072
+ *
2073
+ * @since 1.132.0
2074
+ *
2075
+ * @returns Reference to `this` in order to allow method chaining
2076
+ */
2077
+ setFacets(
2078
+ /**
2079
+ * New value for property `facets`
2080
+ */
2081
+ bFacets?: boolean
2082
+ ): this;
2083
+ /**
2084
+ * Sets a new value for property {@link #getFacetToggleButtonLocation facetToggleButtonLocation}.
2085
+ *
2086
+ * Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin)
2087
+ * or on the right (end) of the search bar. By default the button's location is at the beginning (left),
2088
+ * values are "Begin" and "End". The property is not evaluated if facet panel is disabled, see property
2089
+ * 'facets'.
2090
+ *
2091
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2092
+ *
2093
+ * Default value is `"Begin"`.
2094
+ *
2095
+ * @since 1.140.0
2096
+ * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2097
+ *
2098
+ * @returns Reference to `this` in order to allow method chaining
2099
+ */
2100
+ setFacetToggleButtonLocation(
2101
+ /**
2102
+ * New value for property `facetToggleButtonLocation`
2103
+ */
2104
+ sFacetToggleButtonLocation?: string
2105
+ ): this;
2106
+ /**
2107
+ * Sets a new value for property {@link #getFacetVisibility facetVisibility}.
2108
+ *
2109
+ * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
2110
+ * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
2111
+ * depending on the user's personalization settings.
2112
+ *
2113
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2114
+ *
2115
+ * Default value is `false`.
2116
+ *
2117
+ * @since 1.113.0
2118
+ *
2119
+ * @returns Reference to `this` in order to allow method chaining
2120
+ */
2121
+ setFacetVisibility(
2122
+ /**
2123
+ * New value for property `facetVisibility`
2124
+ */
2125
+ bFacetVisibility?: boolean
2126
+ ): this;
2127
+ /**
2128
+ * Sets a new value for property {@link #getFilterDataSources filterDataSources}.
2129
+ *
2130
+ * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
2131
+ * a list of datsources and returns the filtered list of datasources.
2132
+ *
2133
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2134
+ *
2135
+ * @since 1.112.0
2136
+ *
2137
+ * @returns Reference to `this` in order to allow method chaining
2138
+ */
2139
+ setFilterDataSources(
2140
+ /**
2141
+ * New value for property `filterDataSources`
2142
+ */
2143
+ fnFilterDataSources: Function
2144
+ ): this;
2145
+ /**
2146
+ * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
2147
+ *
2148
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
2149
+ * control only allows filter trees which have a the following structure: complex condition (root level)
2150
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
2151
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
2152
+ * for a more in-depth example.
2153
+ *
2154
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2155
+ *
2156
+ * @since 1.98.0
2157
+ *
2158
+ * @returns Reference to `this` in order to allow method chaining
2159
+ */
2160
+ setFilterRootCondition(
2161
+ /**
2162
+ * New value for property `filterRootCondition`
2163
+ */
2164
+ oFilterRootCondition: object
2165
+ ): this;
2166
+ /**
2167
+ * Sets a new value for property {@link #getFolderMode folderMode}.
2168
+ *
2169
+ * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
2170
+ * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
2171
+ * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
2172
+ * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
2173
+ * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
2174
+ * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
2175
+ * are set.
2176
+ *
2177
+ * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
2178
+ * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
2179
+ * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
2180
+ * children of a folder.
2181
+ *
2182
+ * @since 1.106.0
2183
+ *
2184
+ * @returns Reference to `this` in order to allow method chaining
2185
+ */
2186
+ setFolderMode(
2187
+ /**
2188
+ * New value for property `folderMode`
2189
+ */
2190
+ bFolderMode?: boolean
2191
+ ): this;
2192
+ /**
2193
+ * Sets a new value for property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}.
2194
+ *
2195
+ * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
2196
+ * is enabled.
2197
+ *
2198
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2199
+ *
2200
+ * Default value is `false`.
2201
+ *
2202
+ * @since 1.114.0
2203
+ *
2204
+ * @returns Reference to `this` in order to allow method chaining
2205
+ */
2206
+ setFolderModeForInitialSearch(
2207
+ /**
2208
+ * New value for property `folderModeForInitialSearch`
2209
+ */
2210
+ bFolderModeForInitialSearch?: boolean
2211
+ ): this;
2212
+ /**
2213
+ * Sets a new value for property {@link #getFormatFilterBarText formatFilterBarText}.
2214
+ *
2215
+ * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
2216
+ *
2217
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2218
+ *
2219
+ * @since 1.120
2220
+ *
2221
+ * @returns Reference to `this` in order to allow method chaining
2222
+ */
2223
+ setFormatFilterBarText(
2224
+ /**
2225
+ * New value for property `formatFilterBarText`
2226
+ */
2227
+ fnFormatFilterBarText: Function
2228
+ ): this;
2229
+ /**
2230
+ * Sets a new value for property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
2231
+ *
2232
+ * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
2233
+ * to be more specific and add some hints, links, buttons or other content.
2234
+ *
2235
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2236
+ *
2237
+ * @since 1.94.0
2238
+ *
2239
+ * @returns Reference to `this` in order to allow method chaining
2240
+ */
2241
+ setGetCustomNoResultScreen(
2242
+ /**
2243
+ * New value for property `getCustomNoResultScreen`
2244
+ */
2245
+ fnGetCustomNoResultScreen: Function
2246
+ ): this;
2247
+ /**
2248
+ * Sets a new value for property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
2249
+ *
2250
+ * A callback which returns customized "label" for placeholder text of search box in case there is no search
2251
+ * term. The placeholder text (en) will be "Search In: ".
2252
+ *
2253
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2254
+ *
2255
+ *
2256
+ * @returns Reference to `this` in order to allow method chaining
2257
+ */
2258
+ setGetSearchInputPlaceholderLabel(
2259
+ /**
2260
+ * New value for property `getSearchInputPlaceholderLabel`
2261
+ */
2262
+ fnGetSearchInputPlaceholderLabel: Function
2263
+ ): this;
2264
+ /**
2265
+ * Sets a new value for property {@link #getInitAsync initAsync}.
2266
+ *
2267
+ * An asynchronues callback which is called after the initialization of the search composite control.
2268
+ *
2269
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2270
+ *
2271
+ * @since 1.113.0
2272
+ *
2273
+ * @returns Reference to `this` in order to allow method chaining
2274
+ */
2275
+ setInitAsync(
2276
+ /**
2277
+ * New value for property `initAsync`
2278
+ */
2279
+ fnInitAsync: Function
2280
+ ): this;
2281
+ /**
2282
+ * Sets a new value for property {@link #getIsFilterBarVisible isFilterBarVisible}.
2283
+ *
2284
+ * Callback for checking whether the filter bar is visible.
2285
+ *
2286
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2287
+ *
2288
+ * @since 1.120
2289
+ *
2290
+ * @returns Reference to `this` in order to allow method chaining
2291
+ */
2292
+ setIsFilterBarVisible(
2293
+ /**
2294
+ * New value for property `isFilterBarVisible`
2295
+ */
2296
+ fnIsFilterBarVisible: Function
2297
+ ): this;
2298
+ /**
2299
+ * Sets a new value for property {@link #getIsSearchUrl isSearchUrl}.
2300
+ *
2301
+ * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
2302
+ * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
2303
+ * of 'updateUrl = true'.
2304
+ *
2305
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2306
+ *
2307
+ * @since 1.113.0
2308
+ *
2309
+ * @returns Reference to `this` in order to allow method chaining
2310
+ */
2311
+ setIsSearchUrl(
2312
+ /**
2313
+ * New value for property `isSearchUrl`
2314
+ */
2315
+ fnIsSearchUrl: Function
2316
+ ): this;
2317
+ /**
2318
+ * Sets a new value for property {@link #getLimitAjaxRequests limitAjaxRequests}.
2319
+ *
2320
+ * Prevents too many ajax requests in a short time.
2321
+ *
2322
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2323
+ *
2324
+ * Default value is `true`.
2325
+ *
2326
+ *
2327
+ * @returns Reference to `this` in order to allow method chaining
2328
+ */
2329
+ setLimitAjaxRequests(
2330
+ /**
2331
+ * New value for property `limitAjaxRequests`
2332
+ */
2333
+ bLimitAjaxRequests?: boolean
2334
+ ): this;
2335
+ /**
2336
+ * Sets a new value for property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
2337
+ *
2338
+ * The layout is optimized for object selection / value help (narrow view w/o facet panel).
2339
+ *
2340
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2341
+ *
2342
+ * @since 1.111.0
2343
+ *
2344
+ * @returns Reference to `this` in order to allow method chaining
2345
+ */
2346
+ setOptimizeForValueHelp(
2347
+ /**
2348
+ * New value for property `optimizeForValueHelp`
2349
+ */
2350
+ bOptimizeForValueHelp: boolean
2351
+ ): this;
2352
+ /**
2353
+ * Sets a new value for property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
2354
+ *
2355
+ * Shall the window title be overwritten by this control? If true, the control will set the current search
2356
+ * condition as window title. If false, it will not set or update the window title.
2357
+ *
2358
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2359
+ *
2360
+ * @since 1.93.0
2361
+ *
2362
+ * @returns Reference to `this` in order to allow method chaining
2363
+ */
2364
+ setOverwriteBrowserTitle(
2365
+ /**
2366
+ * New value for property `overwriteBrowserTitle`
2367
+ */
2368
+ bOverwriteBrowserTitle: boolean
2369
+ ): this;
2370
+ /**
2371
+ * Sets a new value for property {@link #getPageSize pageSize}.
2372
+ *
2373
+ * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
2374
+ * button, another page of result items of the same count (if available) will be displayed.
2375
+ *
2376
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2377
+ *
2378
+ * Default value is `10`.
2379
+ *
2380
+ * @since 1.96.0
2381
+ *
2382
+ * @returns Reference to `this` in order to allow method chaining
2383
+ */
2384
+ setPageSize(
2385
+ /**
2386
+ * New value for property `pageSize`
2387
+ */
2388
+ iPageSize?: int
2389
+ ): this;
2390
+ /**
2391
+ * Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
2392
+ *
2393
+ * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
2394
+ * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
2395
+ * is not needed.
2396
+ *
2397
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2398
+ *
2399
+ * @since 1.113.0
2400
+ *
2401
+ * @returns Reference to `this` in order to allow method chaining
2402
+ */
2403
+ setParseSearchUrlParameters(
2404
+ /**
2405
+ * New value for property `parseSearchUrlParameters`
2406
+ */
2407
+ fnParseSearchUrlParameters: Function
2408
+ ): this;
2409
+ /**
2410
+ * Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}.
2411
+ *
2412
+ * A list of data sources to be displayed in the facet panel in the section "Collection".
2413
+ *
2414
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2415
+ *
2416
+ * @since 1.113.0
2417
+ *
2418
+ * @returns Reference to `this` in order to allow method chaining
2419
+ */
2420
+ setQuickSelectDataSources(
2421
+ /**
2422
+ * New value for property `quickSelectDataSources`
2423
+ */
2424
+ oQuickSelectDataSources: object
2425
+ ): this;
2426
+ /**
2427
+ * Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}.
2428
+ *
2429
+ * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
2430
+ * the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
2431
+ *
2432
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2433
+ *
2434
+ * @since 1.113.0
2435
+ *
2436
+ * @returns Reference to `this` in order to allow method chaining
2437
+ */
2438
+ setRenderSearchUrl(
2439
+ /**
2440
+ * New value for property `renderSearchUrl`
2441
+ */
2442
+ fnRenderSearchUrl: Function
2443
+ ): this;
2444
+ /**
2445
+ * Sets a new value for property {@link #getResultviewMasterDetailMode resultviewMasterDetailMode}.
2446
+ *
2447
+ * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever
2448
+ * the detail button/indicator is clicked.
2449
+ *
2450
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2451
+ *
2452
+ * Default value is `false`.
2453
+ *
2454
+ * @since 1.140.0
2455
+ *
2456
+ * @returns Reference to `this` in order to allow method chaining
2457
+ */
2458
+ setResultviewMasterDetailMode(
2459
+ /**
2460
+ * New value for property `resultviewMasterDetailMode`
2461
+ */
2462
+ bResultviewMasterDetailMode?: boolean
2463
+ ): this;
2464
+ /**
2465
+ * Sets a new value for property {@link #getResultviewSelectionMode resultviewSelectionMode}.
2466
+ *
2467
+ * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems')
2468
+ * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None',
2469
+ * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'.
2470
+ * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode`
2471
+ * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked.
2472
+ *
2473
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2474
+ *
2475
+ * Default value is `"None"`.
2476
+ *
2477
+ * @since 1.141.0
2478
+ *
2479
+ * @returns Reference to `this` in order to allow method chaining
2480
+ */
2481
+ setResultviewSelectionMode(
2482
+ /**
2483
+ * New value for property `resultviewSelectionMode`
2484
+ */
2485
+ sResultviewSelectionMode?: string
2486
+ ): this;
2487
+ /**
2488
+ * Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
2489
+ *
2490
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
2491
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
2492
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
2493
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
2494
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
2495
+ * and `resultViewType` must be compatible to each other.
2496
+ *
2497
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
2498
+ *
2499
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2500
+ *
2501
+ * Default value is `...see text or source`.
2502
+ *
2503
+ * @since 1.100.0
2504
+ *
2505
+ * @returns Reference to `this` in order to allow method chaining
2506
+ */
2507
+ setResultViewSettings(
2508
+ /**
2509
+ * New value for property `resultViewSettings`
2510
+ */
2511
+ sResultViewSettings?: string
2512
+ ): this;
2513
+ /**
2514
+ * Sets a new value for property {@link #getResultViewType resultViewType}.
2515
+ *
2516
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
2517
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
2518
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
2519
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
2520
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
2521
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
2522
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
2523
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
2524
+ *
2525
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
2526
+ *
2527
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2528
+ *
2529
+ * Default value is `"searchResultList"`.
2530
+ *
2531
+ * @since 1.98.0
2532
+ *
2533
+ * @returns Reference to `this` in order to allow method chaining
2534
+ */
2535
+ setResultViewType(
2536
+ /**
2537
+ * New value for property `resultViewType`
2538
+ */
2539
+ sResultViewType?: string
2540
+ ): this;
2541
+ /**
2542
+ * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
2543
+ *
2544
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
2545
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
2546
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
2547
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
2548
+ * Search in Business Object: result is switchable between different view types. Possible values for the
2549
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
2550
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
2551
+ *
2552
+ * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
2553
+ *
2554
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2555
+ *
2556
+ * Default value is `["searchResultList", "searchResultTable"]`.
2557
+ *
2558
+ * @since 1.98.0
2559
+ *
2560
+ * @returns Reference to `this` in order to allow method chaining
2561
+ */
2562
+ setResultViewTypes(
2563
+ /**
2564
+ * New value for property `resultViewTypes`
2565
+ */
2566
+ sResultViewTypes?: string[]
2567
+ ): this;
2568
+ /**
2569
+ * Sets a new value for property {@link #getSearchInputLocation searchInputLocation}.
2570
+ *
2571
+ * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl)
2572
+ * or as part of the search bar By default the location is at the top, values are "Top" and "Searchbar".
2573
+ *
2574
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2575
+ *
2576
+ * Default value is `"Top"`.
2577
+ *
2578
+ * @since 1.140.0
2579
+ * @experimental As of version 1.140.0. this feature is experimental and the API may change.
2580
+ *
2581
+ * @returns Reference to `this` in order to allow method chaining
2582
+ */
2583
+ setSearchInputLocation(
2584
+ /**
2585
+ * New value for property `searchInputLocation`
2586
+ */
2587
+ sSearchInputLocation?: string
2588
+ ): this;
2589
+ /**
2590
+ * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
2591
+ *
2592
+ * Defines if the search composite control will send a search request directly after loading, using given
2593
+ * search term, data source and filter root condition settings.
2594
+ *
2595
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2596
+ *
2597
+ * Default value is `true`.
2598
+ *
2599
+ * @since 1.93.0
2600
+ *
2601
+ * @returns Reference to `this` in order to allow method chaining
2602
+ */
2603
+ setSearchOnStart(
2604
+ /**
2605
+ * New value for property `searchOnStart`
2606
+ */
2607
+ bSearchOnStart?: boolean
2608
+ ): this;
2609
+ /**
2610
+ * Sets a new value for property {@link #getSearchTerm searchTerm}.
2611
+ *
2612
+ * Defines the initial search term for the search input.
2613
+ *
2614
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2615
+ *
2616
+ * Default value is `empty string`.
2617
+ *
2618
+ * @since 1.93.0
2619
+ *
2620
+ * @returns Reference to `this` in order to allow method chaining
2621
+ */
2622
+ setSearchTerm(
2623
+ /**
2624
+ * New value for property `searchTerm`
2625
+ */
2626
+ sSearchTerm?: string
2627
+ ): this;
2628
+ /**
2629
+ * Sets a new value for property {@link #getSearchTermLengthLimit searchTermLengthLimit}.
2630
+ *
2631
+ * Limit for length of searchterm.
2632
+ *
2633
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2634
+ *
2635
+ * Default value is `1000`.
2636
+ *
2637
+ *
2638
+ * @returns Reference to `this` in order to allow method chaining
2639
+ */
2640
+ setSearchTermLengthLimit(
2641
+ /**
2642
+ * New value for property `searchTermLengthLimit`
2643
+ */
2644
+ iSearchTermLengthLimit?: int
2645
+ ): this;
2646
+ /**
2647
+ * Sets a new value for property {@link #getSelectionChange selectionChange}.
2648
+ *
2649
+ * A callback which is called whenever the selection of result view items changes.
2650
+ *
2651
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2652
+ *
2653
+ * @since 1.113.0
2654
+ * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
2655
+ *
2656
+ * @returns Reference to `this` in order to allow method chaining
2657
+ */
2658
+ setSelectionChange(
2659
+ /**
2660
+ * New value for property `selectionChange`
2661
+ */
2662
+ fnSelectionChange: Function
2663
+ ): this;
2664
+ /**
2665
+ * Sets a new value for property {@link #getShowSelectionToggleButton showSelectionToggleButton}.
2666
+ *
2667
+ * Enables the selection toggle button in the search result list. The button is displayed on the top of
2668
+ * search result view and allows to toggle the selection of all result items. The button is only displayed
2669
+ * if the property 'resultviewSelectionMode' is not set to 'None'.
2670
+ *
2671
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2672
+ *
2673
+ * Default value is `false`.
2674
+ *
2675
+ * @since 1.140.0
2676
+ *
2677
+ * @returns Reference to `this` in order to allow method chaining
2678
+ */
2679
+ setShowSelectionToggleButton(
2680
+ /**
2681
+ * New value for property `showSelectionToggleButton`
2682
+ */
2683
+ bShowSelectionToggleButton?: boolean
2684
+ ): this;
2685
+ /**
2686
+ * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
2687
+ *
2688
+ * Configuration for the Enterprise Search Client API.
2689
+ *
2690
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2691
+ *
2692
+ * @since 1.93.0
2693
+ *
2694
+ * @returns Reference to `this` in order to allow method chaining
2695
+ */
2696
+ setSinaConfiguration(
2697
+ /**
2698
+ * New value for property `sinaConfiguration`
2699
+ */
2700
+ oSinaConfiguration: object
2701
+ ): this;
2702
+ /**
2703
+ * Sets a new value for property {@link #getTabStripsFormatter tabStripsFormatter}.
2704
+ *
2705
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
2706
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
2707
+ * in the tabstrips.
2708
+ *
2709
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2710
+ *
2711
+ * @since 1.103.0
2712
+ *
2713
+ * @returns Reference to `this` in order to allow method chaining
2714
+ */
2715
+ setTabStripsFormatter(
2716
+ /**
2717
+ * New value for property `tabStripsFormatter`
2718
+ */
2719
+ fnTabStripsFormatter: Function
2720
+ ): this;
2721
+ /**
2722
+ * Sets a new value for property {@link #getUpdateUrl updateUrl}.
2723
+ *
2724
+ * A boolean indicating that the search state is written to the URL.
2725
+ *
2726
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2727
+ *
2728
+ * Default value is `true`.
2729
+ *
2730
+ * @since 1.113.0
2731
+ *
2732
+ * @returns Reference to `this` in order to allow method chaining
2733
+ */
2734
+ setUpdateUrl(
2735
+ /**
2736
+ * New value for property `updateUrl`
2737
+ */
2738
+ bUpdateUrl?: boolean
2739
+ ): this;
2740
+ /**
2741
+ * Update hierarchy facet Updates the one and only (static) hierarchy facet (tree control on facet panel).
2742
+ * If no hierarchy facet exists, nothing will happen.
2743
+ *
2744
+ * @since 1.126.0
2745
+ */
2746
+ updateStaticHierarchyFacet(): Promise<void>;
2747
+ }
2748
+
2749
+ /**
2750
+ * Event object of the SearchCompositeControl#resultViewTypeChanged event.
2751
+ */
2752
+ type SearchCompositeControl$ResultViewTypeChangedEvent =
2753
+ sap.ui.base.Event<
2754
+ SearchCompositeControl$ResultViewTypeChangedEventParameters,
2755
+ SearchCompositeControl
2756
+ >;
2757
+
2758
+ /**
2759
+ * Event object of the SearchCompositeControl#searchFinished event.
2760
+ */
2761
+ type SearchCompositeControl$SearchFinishedEvent = sap.ui.base.Event<
2762
+ SearchCompositeControl$SearchFinishedEventParameters,
2763
+ SearchCompositeControl
2764
+ >;
2765
+
2766
+ /**
2767
+ * Event object of the SearchCompositeControl#searchStarted event.
2768
+ */
2769
+ type SearchCompositeControl$SearchStartedEvent = sap.ui.base.Event<
2770
+ SearchCompositeControl$SearchStartedEventParameters,
2771
+ SearchCompositeControl
2772
+ >;
2773
+
2774
+ /**
2775
+ * Event object of the SearchCompositeControl#selectionChanged event.
2776
+ */
2777
+ type SearchCompositeControl$SelectionChangedEvent = sap.ui.base.Event<
2778
+ SearchCompositeControl$SelectionChangedEventParameters,
2779
+ SearchCompositeControl
2780
+ >;
2781
+
2782
+ /**
2783
+ * Event object of the SearchCompositeControl#showResultDetail event.
2784
+ */
2785
+ type SearchCompositeControl$ShowResultDetailEvent = sap.ui.base.Event<
2786
+ SearchCompositeControl$ShowResultDetailEventParameters,
2787
+ SearchCompositeControl
2788
+ >;
2789
+ }
2790
+ }
2791
+ }
2792
+
4
2793
  interface IUI5DefineDependencyNames {
5
2794
  "sap/esh/search/ui/library": undefined;
2795
+
2796
+ "sap/esh/search/ui/SearchCompositeControl": undefined;
6
2797
  }
7
2798
  }