@sapui5/types 1.122.2 → 1.123.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 (64) 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 +408 -32
  4. package/types/sap.chart.d.ts +58 -6
  5. package/types/sap.collaboration.d.ts +52 -9
  6. package/types/sap.esh.search.ui.d.ts +2066 -2
  7. package/types/sap.f.d.ts +435 -98
  8. package/types/sap.fe.core.d.ts +9 -3
  9. package/types/sap.fe.macros.d.ts +1075 -70
  10. package/types/sap.fe.navigation.d.ts +1 -1
  11. package/types/sap.fe.placeholder.d.ts +1 -1
  12. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +8 -6
  14. package/types/sap.fe.test.d.ts +309 -7
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +1066 -146
  18. package/types/sap.insights.d.ts +4 -2
  19. package/types/sap.m.d.ts +3961 -399
  20. package/types/sap.makit.d.ts +115 -14
  21. package/types/sap.me.d.ts +84 -7
  22. package/types/sap.ndc.d.ts +22 -2
  23. package/types/sap.ovp.d.ts +1 -1
  24. package/types/sap.rules.ui.d.ts +44 -11
  25. package/types/sap.sac.df.d.ts +119 -67
  26. package/types/sap.suite.ui.commons.d.ts +1146 -2474
  27. package/types/sap.suite.ui.generic.template.d.ts +10 -2
  28. package/types/sap.suite.ui.microchart.d.ts +190 -28
  29. package/types/sap.tnt.d.ts +46 -10
  30. package/types/sap.ui.codeeditor.d.ts +16 -2
  31. package/types/sap.ui.commons.d.ts +797 -121
  32. package/types/sap.ui.comp.d.ts +964 -124
  33. package/types/sap.ui.core.d.ts +13204 -12618
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +22 -5
  36. package/types/sap.ui.fl.d.ts +40 -3
  37. package/types/sap.ui.generic.app.d.ts +217 -201
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +147 -9
  40. package/types/sap.ui.layout.d.ts +171 -47
  41. package/types/sap.ui.mdc.d.ts +554 -71
  42. package/types/sap.ui.richtexteditor.d.ts +28 -2
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +27 -3
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +278 -74
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +481 -42
  49. package/types/sap.ui.ux3.d.ts +527 -34
  50. package/types/sap.ui.vbm.d.ts +544 -48
  51. package/types/sap.ui.vk.d.ts +1588 -133
  52. package/types/sap.ui.vtm.d.ts +373 -27
  53. package/types/sap.ui.webc.common.d.ts +7 -1
  54. package/types/sap.ui.webc.fiori.d.ts +351 -29
  55. package/types/sap.ui.webc.main.d.ts +1035 -83
  56. package/types/sap.uiext.inbox.d.ts +124 -13
  57. package/types/sap.ushell.d.ts +1081 -383
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +123 -23
  60. package/types/sap.viz.d.ts +2619 -130
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +35 -15
  63. package/types/sap.zen.crosstab.d.ts +22 -10
  64. package/types/sap.zen.dsh.d.ts +64 -9
@@ -1,3 +1,2067 @@
1
- // For Library Version: 1.122.0
1
+ // For Library Version: 1.123.0
2
2
 
3
- declare namespace sap {}
3
+ declare module "sap/esh/search/ui/SearchCompositeControl" {
4
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
5
+
6
+ import Event from "sap/ui/base/Event";
7
+
8
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
9
+
10
+ import {
11
+ PropertyBindingInfo,
12
+ AggregationBindingInfo,
13
+ } from "sap/ui/base/ManagedObject";
14
+
15
+ /**
16
+ * Adds a callback function which is called whenever there is a user triggered event.
17
+ *
18
+ * @since 1.120.0
19
+ */
20
+ export type eventConsumer = Function;
21
+
22
+ /**
23
+ * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
24
+ * Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
25
+ * a suggestion dropdown, a result list which can have different styles including tiles and table, result
26
+ * facets and more. This control is ready to use with an enterprise search backend service but also allows
27
+ * deep modifications to match requirements of adopting applications.
28
+ *
29
+ * @since 1.93.0
30
+ */
31
+ export default class SearchCompositeControl extends Control {
32
+ /**
33
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
34
+ * See:
35
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
36
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
37
+ */
38
+ constructor(
39
+ /**
40
+ * Initial settings for the new control
41
+ */
42
+ mSettings?: $SearchCompositeControlSettings
43
+ );
44
+ /**
45
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
46
+ * See:
47
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
48
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
49
+ */
50
+ constructor(
51
+ /**
52
+ * ID for the new control, generated automatically if no ID is given
53
+ */
54
+ sId?: string,
55
+ /**
56
+ * Initial settings for the new control
57
+ */
58
+ mSettings?: $SearchCompositeControlSettings
59
+ );
60
+
61
+ /**
62
+ * Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches
63
+ * it with the information contained in `oClassInfo`.
64
+ *
65
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
66
+ *
67
+ *
68
+ * @returns Created class / constructor function
69
+ */
70
+ static extend<T extends Record<string, unknown>>(
71
+ /**
72
+ * Name of the class being created
73
+ */
74
+ sClassName: string,
75
+ /**
76
+ * Object literal with information about the class
77
+ */
78
+ oClassInfo?: sap.ClassInfo<T, SearchCompositeControl>,
79
+ /**
80
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
81
+ * used by this class
82
+ */
83
+ FNMetaImpl?: Function
84
+ ): Function;
85
+ /**
86
+ * Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl.
87
+ *
88
+ *
89
+ * @returns Metadata object describing this class
90
+ */
91
+ static getMetadata(): ElementMetadata;
92
+ /**
93
+ * Adds some content to the aggregation {@link #getContent content}.
94
+ *
95
+ *
96
+ * @returns Reference to `this` in order to allow method chaining
97
+ */
98
+ addContent(
99
+ /**
100
+ * The content to add; if empty, nothing is inserted
101
+ */
102
+ oContent: Control
103
+ ): this;
104
+ /**
105
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
106
+ * `sap.esh.search.ui.SearchCompositeControl`.
107
+ *
108
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
109
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
110
+ *
111
+ * Event is fired when search is finished.
112
+ *
113
+ * @since 1.121
114
+ *
115
+ * @returns Reference to `this` in order to allow method chaining
116
+ */
117
+ attachSearchFinished(
118
+ /**
119
+ * An application-specific payload object that will be passed to the event handler along with the event
120
+ * object when firing the event
121
+ */
122
+ oData: object,
123
+ /**
124
+ * The function to be called when the event occurs
125
+ */
126
+ fnFunction: (p1: Event) => void,
127
+ /**
128
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
129
+ * itself
130
+ */
131
+ oListener?: object
132
+ ): this;
133
+ /**
134
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
135
+ * `sap.esh.search.ui.SearchCompositeControl`.
136
+ *
137
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
138
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
139
+ *
140
+ * Event is fired when search is finished.
141
+ *
142
+ * @since 1.121
143
+ *
144
+ * @returns Reference to `this` in order to allow method chaining
145
+ */
146
+ attachSearchFinished(
147
+ /**
148
+ * The function to be called when the event occurs
149
+ */
150
+ fnFunction: (p1: Event) => void,
151
+ /**
152
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
153
+ * itself
154
+ */
155
+ oListener?: object
156
+ ): this;
157
+ /**
158
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
159
+ *
160
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
161
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
162
+ *
163
+ * Event is fired when search is started.
164
+ *
165
+ * @since 1.121
166
+ *
167
+ * @returns Reference to `this` in order to allow method chaining
168
+ */
169
+ attachSearchStarted(
170
+ /**
171
+ * An application-specific payload object that will be passed to the event handler along with the event
172
+ * object when firing the event
173
+ */
174
+ oData: object,
175
+ /**
176
+ * The function to be called when the event occurs
177
+ */
178
+ fnFunction: (p1: Event) => void,
179
+ /**
180
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
181
+ * itself
182
+ */
183
+ oListener?: object
184
+ ): this;
185
+ /**
186
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
187
+ *
188
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
189
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
190
+ *
191
+ * Event is fired when search is started.
192
+ *
193
+ * @since 1.121
194
+ *
195
+ * @returns Reference to `this` in order to allow method chaining
196
+ */
197
+ attachSearchStarted(
198
+ /**
199
+ * The function to be called when the event occurs
200
+ */
201
+ fnFunction: (p1: Event) => void,
202
+ /**
203
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
204
+ * itself
205
+ */
206
+ oListener?: object
207
+ ): this;
208
+ /**
209
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
210
+ * this `sap.esh.search.ui.SearchCompositeControl`.
211
+ *
212
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
213
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
214
+ *
215
+ * Event is fired when selection on result view (list, table or grid) has changed.
216
+ *
217
+ * @since 1.121
218
+ *
219
+ * @returns Reference to `this` in order to allow method chaining
220
+ */
221
+ attachSelectionChanged(
222
+ /**
223
+ * An application-specific payload object that will be passed to the event handler along with the event
224
+ * object when firing the event
225
+ */
226
+ oData: object,
227
+ /**
228
+ * The function to be called when the event occurs
229
+ */
230
+ fnFunction: (p1: Event) => void,
231
+ /**
232
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
233
+ * itself
234
+ */
235
+ oListener?: object
236
+ ): this;
237
+ /**
238
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
239
+ * this `sap.esh.search.ui.SearchCompositeControl`.
240
+ *
241
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
242
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
243
+ *
244
+ * Event is fired when selection on result view (list, table or grid) has changed.
245
+ *
246
+ * @since 1.121
247
+ *
248
+ * @returns Reference to `this` in order to allow method chaining
249
+ */
250
+ attachSelectionChanged(
251
+ /**
252
+ * The function to be called when the event occurs
253
+ */
254
+ fnFunction: (p1: Event) => void,
255
+ /**
256
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
257
+ * itself
258
+ */
259
+ oListener?: object
260
+ ): this;
261
+ /**
262
+ * Destroys all the content in the aggregation {@link #getContent content}.
263
+ *
264
+ *
265
+ * @returns Reference to `this` in order to allow method chaining
266
+ */
267
+ destroyContent(): this;
268
+ /**
269
+ * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
270
+ * `sap.esh.search.ui.SearchCompositeControl`.
271
+ *
272
+ * The passed function and listener object must match the ones used for event registration.
273
+ *
274
+ * @since 1.121
275
+ *
276
+ * @returns Reference to `this` in order to allow method chaining
277
+ */
278
+ detachSearchFinished(
279
+ /**
280
+ * The function to be called, when the event occurs
281
+ */
282
+ fnFunction: (p1: Event) => void,
283
+ /**
284
+ * Context object on which the given function had to be called
285
+ */
286
+ oListener?: object
287
+ ): this;
288
+ /**
289
+ * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
290
+ * `sap.esh.search.ui.SearchCompositeControl`.
291
+ *
292
+ * The passed function and listener object must match the ones used for event registration.
293
+ *
294
+ * @since 1.121
295
+ *
296
+ * @returns Reference to `this` in order to allow method chaining
297
+ */
298
+ detachSearchStarted(
299
+ /**
300
+ * The function to be called, when the event occurs
301
+ */
302
+ fnFunction: (p1: Event) => void,
303
+ /**
304
+ * Context object on which the given function had to be called
305
+ */
306
+ oListener?: object
307
+ ): this;
308
+ /**
309
+ * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of
310
+ * this `sap.esh.search.ui.SearchCompositeControl`.
311
+ *
312
+ * The passed function and listener object must match the ones used for event registration.
313
+ *
314
+ * @since 1.121
315
+ *
316
+ * @returns Reference to `this` in order to allow method chaining
317
+ */
318
+ detachSelectionChanged(
319
+ /**
320
+ * The function to be called, when the event occurs
321
+ */
322
+ fnFunction: (p1: Event) => void,
323
+ /**
324
+ * Context object on which the given function had to be called
325
+ */
326
+ oListener?: object
327
+ ): this;
328
+ /**
329
+ * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
330
+ *
331
+ * @since 1.121
332
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
333
+ *
334
+ * @returns Reference to `this` in order to allow method chaining
335
+ */
336
+ fireSearchFinished(
337
+ /**
338
+ * Parameters to pass along with the event
339
+ */
340
+ mParameters?: object
341
+ ): this;
342
+ /**
343
+ * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
344
+ *
345
+ * @since 1.121
346
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
347
+ *
348
+ * @returns Reference to `this` in order to allow method chaining
349
+ */
350
+ fireSearchStarted(
351
+ /**
352
+ * Parameters to pass along with the event
353
+ */
354
+ mParameters?: object
355
+ ): this;
356
+ /**
357
+ * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
358
+ *
359
+ * @since 1.121
360
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
361
+ *
362
+ * @returns Reference to `this` in order to allow method chaining
363
+ */
364
+ fireSelectionChanged(
365
+ /**
366
+ * Parameters to pass along with the event
367
+ */
368
+ mParameters?: object
369
+ ): this;
370
+ /**
371
+ * Gets current value of property {@link #getApplicationComponent applicationComponent}.
372
+ *
373
+ * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
374
+ *
375
+ * Default value is `"HAN-AS-INA-UI"`.
376
+ *
377
+ * @since 1.108.0
378
+ *
379
+ * @returns Value of property `applicationComponent`
380
+ */
381
+ getApplicationComponent(): string;
382
+ /**
383
+ * Gets current value of property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
384
+ *
385
+ * In case folder mode is active: Automatically switch result view type to list in search mode and to table
386
+ * in folder mode.
387
+ *
388
+ * Default value is `false`.
389
+ *
390
+ * @since 1.106.0
391
+ *
392
+ * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
393
+ */
394
+ getAutoAdjustResultViewTypeInFolderMode(): boolean;
395
+ /**
396
+ * Gets current value of property {@link #getBoSuggestions boSuggestions}.
397
+ *
398
+ * A boolean for enabling (business) object suggestions.
399
+ *
400
+ * Default value is `false`.
401
+ *
402
+ * @since 1.113.0
403
+ *
404
+ * @returns Value of property `boSuggestions`
405
+ */
406
+ getBoSuggestions(): boolean;
407
+ /**
408
+ * Gets content of aggregation {@link #getContent content}.
409
+ *
410
+ * Control instances which are part of this composite control.
411
+ */
412
+ getContent(): Control[];
413
+ /**
414
+ * Gets current value of property {@link #getCssClass cssClass}.
415
+ *
416
+ * An additional CSS class to add to this control
417
+ *
418
+ * @since 1.93.0
419
+ *
420
+ * @returns Value of property `cssClass`
421
+ */
422
+ getCssClass(): string;
423
+ /**
424
+ * Gets current value of property {@link #getDataSource dataSource}.
425
+ *
426
+ * The id of the data source in which it will search right after initialization.
427
+ *
428
+ * @since 1.98.0
429
+ *
430
+ * @returns Value of property `dataSource`
431
+ */
432
+ getDataSource(): string;
433
+ /**
434
+ * Gets current value of property {@link #getDefaultDataSource defaultDataSource}.
435
+ *
436
+ * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
437
+ * will be used during UI load and this parameter will used only after filter is reset.
438
+ *
439
+ * @since 1.93.0
440
+ *
441
+ * @returns Value of property `defaultDataSource`
442
+ */
443
+ getDefaultDataSource(): string;
444
+ /**
445
+ * Gets current value of property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
446
+ *
447
+ * When set to true the facet panel is displayed also in case there are no search results.
448
+ *
449
+ * Default value is `false`.
450
+ *
451
+ * @since 1.113.0
452
+ *
453
+ * @returns Value of property `displayFacetPanelInCaseOfNoResults`
454
+ */
455
+ getDisplayFacetPanelInCaseOfNoResults(): boolean;
456
+ /**
457
+ * Gets current value of property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
458
+ *
459
+ * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
460
+ * the value is true.
461
+ *
462
+ * Default value is `false`.
463
+ *
464
+ * @since 1.96.0
465
+ *
466
+ * @returns Value of property `enableMultiSelectionResultItems`
467
+ */
468
+ getEnableMultiSelectionResultItems(): boolean;
469
+ /**
470
+ * Gets current value of property {@link #getEnableQueryLanguage enableQueryLanguage}.
471
+ *
472
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
473
+ * user to enter complex search queries with logical operators.
474
+ *
475
+ * Default value is `false`.
476
+ *
477
+ * @since 1.107.0
478
+ *
479
+ * @returns Value of property `enableQueryLanguage`
480
+ */
481
+ getEnableQueryLanguage(): boolean;
482
+ /**
483
+ * Gets current value of property {@link #getEventConsumers eventConsumers}.
484
+ *
485
+ * Adds a callback function which is called whenever there is a user triggered event.
486
+ *
487
+ * @since 1.120
488
+ *
489
+ * @returns Value of property `eventConsumers`
490
+ */
491
+ getEventConsumers(): string;
492
+ /**
493
+ * Gets current value of property {@link #getExclusiveDataSource exclusiveDataSource}.
494
+ *
495
+ * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
496
+ * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
497
+ * panel) - data source name/link on result list (header section of item)
498
+ *
499
+ * @since 1.121.0
500
+ *
501
+ * @returns Value of property `exclusiveDataSource`
502
+ */
503
+ getExclusiveDataSource(): string;
504
+ /**
505
+ * Gets current value of property {@link #getFacetPanelResizable facetPanelResizable}.
506
+ *
507
+ * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
508
+ *
509
+ * Default value is `false`.
510
+ *
511
+ * @since 1.108.0
512
+ *
513
+ * @returns Value of property `facetPanelResizable`
514
+ */
515
+ getFacetPanelResizable(): boolean;
516
+ /**
517
+ * Gets current value of property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
518
+ *
519
+ * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
520
+ * is true, the width of the facet panel can be changed by the user.
521
+ *
522
+ * Default value is `25`.
523
+ *
524
+ * @since 1.108.0
525
+ *
526
+ * @returns Value of property `facetPanelWidthInPercent`
527
+ */
528
+ getFacetPanelWidthInPercent(): float;
529
+ /**
530
+ * Gets current value of property {@link #getFacetVisibility facetVisibility}.
531
+ *
532
+ * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
533
+ * initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
534
+ * typically is taken from the user personalization storage.
535
+ *
536
+ * @since 1.113.0
537
+ *
538
+ * @returns Value of property `facetVisibility`
539
+ */
540
+ getFacetVisibility(): boolean;
541
+ /**
542
+ * Gets current value of property {@link #getFilterDataSources filterDataSources}.
543
+ *
544
+ * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
545
+ * a list of datsources and returns the filtered list of datasources.
546
+ *
547
+ * @since 1.112.0
548
+ *
549
+ * @returns Value of property `filterDataSources`
550
+ */
551
+ getFilterDataSources(): Function;
552
+ /**
553
+ * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
554
+ *
555
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
556
+ * control only allows filter trees which have a the following structure: complex condition (root level)
557
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
558
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
559
+ * for a more in-depth example.
560
+ *
561
+ * @since 1.98.0
562
+ *
563
+ * @returns Value of property `filterRootCondition`
564
+ */
565
+ getFilterRootCondition(): object;
566
+ /**
567
+ * Gets current value of property {@link #getFolderMode folderMode}.
568
+ *
569
+ * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
570
+ * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
571
+ * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
572
+ * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
573
+ * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
574
+ * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
575
+ * are set.
576
+ *
577
+ * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
578
+ * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
579
+ * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
580
+ * children of a folder.
581
+ *
582
+ * @since 1.106.0
583
+ *
584
+ * @returns Value of property `folderMode`
585
+ */
586
+ getFolderMode(): boolean;
587
+ /**
588
+ * Gets current value of property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}.
589
+ *
590
+ * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
591
+ * is enabled.
592
+ *
593
+ * Default value is `false`.
594
+ *
595
+ * @since 1.114.0
596
+ *
597
+ * @returns Value of property `folderModeForInitialSearch`
598
+ */
599
+ getFolderModeForInitialSearch(): boolean;
600
+ /**
601
+ * Gets current value of property {@link #getFormatFilterBarText formatFilterBarText}.
602
+ *
603
+ * Callback for formatting the filter string to be displayed in the filter bar (for closed facet panel).
604
+ *
605
+ * @since 1.120
606
+ *
607
+ * @returns Value of property `formatFilterBarText`
608
+ */
609
+ getFormatFilterBarText(): Function;
610
+ /**
611
+ * Gets current value of property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
612
+ *
613
+ * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
614
+ * to be more specific and add some hints, links, buttons or other content.
615
+ *
616
+ * @since 1.94.0
617
+ *
618
+ * @returns Value of property `getCustomNoResultScreen`
619
+ */
620
+ getGetCustomNoResultScreen(): Function;
621
+ /**
622
+ * Gets current value of property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
623
+ *
624
+ * A callback which returns customized "label" for placeholder text of search box, in case there is no search
625
+ * term. The placeholder text (en) will be "Search In: ".
626
+ *
627
+ *
628
+ * @returns Value of property `getSearchInputPlaceholderLabel`
629
+ */
630
+ getGetSearchInputPlaceholderLabel(): Function;
631
+ /**
632
+ * Gets current value of property {@link #getInitAsync initAsync}.
633
+ *
634
+ * A callback which is called after the initialization of the search composite control.
635
+ *
636
+ * @since 1.113.0
637
+ *
638
+ * @returns Value of property `initAsync`
639
+ */
640
+ getInitAsync(): Function;
641
+ /**
642
+ * Gets current value of property {@link #getIsFilterBarVisible isFilterBarVisible}.
643
+ *
644
+ * Callback for checking whether the filter bar is visible.
645
+ *
646
+ * @since 1.120
647
+ *
648
+ * @returns Value of property `isFilterBarVisible`
649
+ */
650
+ getIsFilterBarVisible(): Function;
651
+ /**
652
+ * Gets current value of property {@link #getIsSearchUrl isSearchUrl}.
653
+ *
654
+ * A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
655
+ * case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
656
+ *
657
+ * @since 1.113.0
658
+ *
659
+ * @returns Value of property `isSearchUrl`
660
+ */
661
+ getIsSearchUrl(): Function;
662
+ /**
663
+ * Gets current value of property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
664
+ *
665
+ * The layout is optimized for object selection / value help (narrow view w/o facet panel).
666
+ *
667
+ * @since 1.111.0
668
+ *
669
+ * @returns Value of property `optimizeForValueHelp`
670
+ */
671
+ getOptimizeForValueHelp(): boolean;
672
+ /**
673
+ * Gets current value of property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
674
+ *
675
+ * Shall the window title be overwritten by this control? If true, the control will set the current search
676
+ * condition as window title. If false, it will not set or update the window title.
677
+ *
678
+ * @since 1.93.0
679
+ *
680
+ * @returns Value of property `overwriteBrowserTitle`
681
+ */
682
+ getOverwriteBrowserTitle(): boolean;
683
+ /**
684
+ * Gets current value of property {@link #getPageSize pageSize}.
685
+ *
686
+ * The maximal count of search result items displayed on a page after a search. By clicking Show More button,
687
+ * another page of result items of the same count (if available) will be displayed.
688
+ *
689
+ * Default value is `10`.
690
+ *
691
+ * @since 1.96.0
692
+ *
693
+ * @returns Value of property `pageSize`
694
+ */
695
+ getPageSize(): int;
696
+ /**
697
+ * Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
698
+ *
699
+ * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
700
+ * parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
701
+ * is not needed.
702
+ *
703
+ * @since 1.113.0
704
+ *
705
+ * @returns Value of property `parseSearchUrlParameters`
706
+ */
707
+ getParseSearchUrlParameters(): Function;
708
+ /**
709
+ * Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
710
+ *
711
+ * A list of datasources to be displayed in the facet panel in the collection area.
712
+ *
713
+ * @since 1.113.0
714
+ *
715
+ * @returns Value of property `quickSelectDataSources`
716
+ */
717
+ getQuickSelectDataSources(): object;
718
+ /**
719
+ * Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}.
720
+ *
721
+ * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
722
+ * the URL string. Typically you need to register this callback in case updateUrl=true.
723
+ *
724
+ * @since 1.113.0
725
+ *
726
+ * @returns Value of property `renderSearchUrl`
727
+ */
728
+ getRenderSearchUrl(): Function;
729
+ /**
730
+ * Gets current value of property {@link #getResultViewSettings resultViewSettings}.
731
+ *
732
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
733
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
734
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
735
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
736
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
737
+ * and `resultViewType` must be compatible to each other.
738
+ *
739
+ * Default value is `...see text or source`.
740
+ *
741
+ * @since 1.100.0
742
+ *
743
+ * @returns Value of property `resultViewSettings`
744
+ */
745
+ getResultViewSettings(): string;
746
+ /**
747
+ * Gets current value of property {@link #getResultViewType resultViewType}.
748
+ *
749
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
750
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
751
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
752
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
753
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
754
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
755
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
756
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
757
+ *
758
+ * Default value is `"searchResultList"`.
759
+ *
760
+ * @since 1.98.0
761
+ *
762
+ * @returns Value of property `resultViewType`
763
+ */
764
+ getResultViewType(): string;
765
+ /**
766
+ * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
767
+ *
768
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
769
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
770
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
771
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
772
+ * Search in Business Object: result is switchable between different view types. Possible values for the
773
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
774
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
775
+ *
776
+ * Default value is `["searchResultList", "searchResultTable"]`.
777
+ *
778
+ * @since 1.98.0
779
+ *
780
+ * @returns Value of property `resultViewTypes`
781
+ */
782
+ getResultViewTypes(): string[];
783
+ /**
784
+ * Gets current value of property {@link #getSearchOnStart searchOnStart}.
785
+ *
786
+ * Defines if the search composite control will send a search request after loading for the given term,
787
+ * data source and filter root condition settings.
788
+ *
789
+ * Default value is `true`.
790
+ *
791
+ * @since 1.93.0
792
+ *
793
+ * @returns Value of property `searchOnStart`
794
+ */
795
+ getSearchOnStart(): boolean;
796
+ /**
797
+ * Gets current value of property {@link #getSearchTerm searchTerm}.
798
+ *
799
+ * Defines the initial search term for the search input.
800
+ *
801
+ * Default value is `empty string`.
802
+ *
803
+ * @since 1.93.0
804
+ *
805
+ * @returns Value of property `searchTerm`
806
+ */
807
+ getSearchTerm(): string;
808
+ /**
809
+ * Gets current value of property {@link #getSelectionChange selectionChange}.
810
+ *
811
+ * A callback which is called whenever the selection of result list items changes.
812
+ *
813
+ * @since 1.113.0
814
+ *
815
+ * @returns Value of property `selectionChange`
816
+ */
817
+ getSelectionChange(): Function;
818
+ /**
819
+ * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
820
+ *
821
+ * Configuration for the Enterprise Search Client API.
822
+ *
823
+ * @since 1.93.0
824
+ *
825
+ * @returns Value of property `sinaConfiguration`
826
+ */
827
+ getSinaConfiguration(): object;
828
+ /**
829
+ * Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}.
830
+ *
831
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
832
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
833
+ * in the tabstrips.
834
+ *
835
+ * @since 1.103.0
836
+ *
837
+ * @returns Value of property `tabStripsFormatter`
838
+ */
839
+ getTabStripsFormatter(): Function;
840
+ /**
841
+ * Gets current value of property {@link #getUpdateUrl updateUrl}.
842
+ *
843
+ * A boolean indicating that the search state is written to the URL.
844
+ *
845
+ * Default value is `true`.
846
+ *
847
+ * @since 1.113.0
848
+ *
849
+ * @returns Value of property `updateUrl`
850
+ */
851
+ getUpdateUrl(): boolean;
852
+ /**
853
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
854
+ * its index if found or -1 otherwise.
855
+ *
856
+ *
857
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
858
+ */
859
+ indexOfContent(
860
+ /**
861
+ * The content whose index is looked for
862
+ */
863
+ oContent: Control
864
+ ): int;
865
+ /**
866
+ * Inserts a content into the aggregation {@link #getContent content}.
867
+ *
868
+ *
869
+ * @returns Reference to `this` in order to allow method chaining
870
+ */
871
+ insertContent(
872
+ /**
873
+ * The content to insert; if empty, nothing is inserted
874
+ */
875
+ oContent: Control,
876
+ /**
877
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
878
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
879
+ * is inserted at the last position
880
+ */
881
+ iIndex: int
882
+ ): this;
883
+ /**
884
+ * Removes all the controls from the aggregation {@link #getContent content}.
885
+ *
886
+ * Additionally, it unregisters them from the hosting UIArea.
887
+ *
888
+ *
889
+ * @returns An array of the removed elements (might be empty)
890
+ */
891
+ removeAllContent(): Control[];
892
+ /**
893
+ * Removes a content from the aggregation {@link #getContent content}.
894
+ *
895
+ *
896
+ * @returns The removed content or `null`
897
+ */
898
+ removeContent(
899
+ /**
900
+ * The content to remove or its index or id
901
+ */
902
+ vContent: int | string | Control
903
+ ): Control | null;
904
+ /**
905
+ * Sets a new value for property {@link #getApplicationComponent applicationComponent}.
906
+ *
907
+ * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
908
+ *
909
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
910
+ *
911
+ * Default value is `"HAN-AS-INA-UI"`.
912
+ *
913
+ * @since 1.108.0
914
+ *
915
+ * @returns Reference to `this` in order to allow method chaining
916
+ */
917
+ setApplicationComponent(
918
+ /**
919
+ * New value for property `applicationComponent`
920
+ */
921
+ sApplicationComponent?: string
922
+ ): this;
923
+ /**
924
+ * Sets a new value for property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
925
+ *
926
+ * In case folder mode is active: Automatically switch result view type to list in search mode and to table
927
+ * in folder mode.
928
+ *
929
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
930
+ *
931
+ * Default value is `false`.
932
+ *
933
+ * @since 1.106.0
934
+ *
935
+ * @returns Reference to `this` in order to allow method chaining
936
+ */
937
+ setAutoAdjustResultViewTypeInFolderMode(
938
+ /**
939
+ * New value for property `autoAdjustResultViewTypeInFolderMode`
940
+ */
941
+ bAutoAdjustResultViewTypeInFolderMode?: boolean
942
+ ): this;
943
+ /**
944
+ * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
945
+ *
946
+ * A boolean for enabling (business) object suggestions.
947
+ *
948
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
949
+ *
950
+ * Default value is `false`.
951
+ *
952
+ * @since 1.113.0
953
+ *
954
+ * @returns Reference to `this` in order to allow method chaining
955
+ */
956
+ setBoSuggestions(
957
+ /**
958
+ * New value for property `boSuggestions`
959
+ */
960
+ bBoSuggestions?: boolean
961
+ ): this;
962
+ /**
963
+ * Sets a new value for property {@link #getCssClass cssClass}.
964
+ *
965
+ * An additional CSS class to add to this control
966
+ *
967
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
968
+ *
969
+ * @since 1.93.0
970
+ *
971
+ * @returns Reference to `this` in order to allow method chaining
972
+ */
973
+ setCssClass(
974
+ /**
975
+ * New value for property `cssClass`
976
+ */
977
+ sCssClass: string
978
+ ): this;
979
+ /**
980
+ * Sets a new value for property {@link #getDataSource dataSource}.
981
+ *
982
+ * The id of the data source in which it will search right after initialization.
983
+ *
984
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
985
+ *
986
+ * @since 1.98.0
987
+ *
988
+ * @returns Reference to `this` in order to allow method chaining
989
+ */
990
+ setDataSource(
991
+ /**
992
+ * New value for property `dataSource`
993
+ */
994
+ sDataSource: string
995
+ ): this;
996
+ /**
997
+ * Sets a new value for property {@link #getDefaultDataSource defaultDataSource}.
998
+ *
999
+ * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
1000
+ * will be used during UI load and this parameter will used only after filter is reset.
1001
+ *
1002
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1003
+ *
1004
+ * @since 1.93.0
1005
+ *
1006
+ * @returns Reference to `this` in order to allow method chaining
1007
+ */
1008
+ setDefaultDataSource(
1009
+ /**
1010
+ * New value for property `defaultDataSource`
1011
+ */
1012
+ sDefaultDataSource: string
1013
+ ): this;
1014
+ /**
1015
+ * Sets a new value for property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
1016
+ *
1017
+ * When set to true the facet panel is displayed also in case there are no search results.
1018
+ *
1019
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1020
+ *
1021
+ * Default value is `false`.
1022
+ *
1023
+ * @since 1.113.0
1024
+ *
1025
+ * @returns Reference to `this` in order to allow method chaining
1026
+ */
1027
+ setDisplayFacetPanelInCaseOfNoResults(
1028
+ /**
1029
+ * New value for property `displayFacetPanelInCaseOfNoResults`
1030
+ */
1031
+ bDisplayFacetPanelInCaseOfNoResults?: boolean
1032
+ ): this;
1033
+ /**
1034
+ * Sets a new value for property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
1035
+ *
1036
+ * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
1037
+ * the value is true.
1038
+ *
1039
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1040
+ *
1041
+ * Default value is `false`.
1042
+ *
1043
+ * @since 1.96.0
1044
+ *
1045
+ * @returns Reference to `this` in order to allow method chaining
1046
+ */
1047
+ setEnableMultiSelectionResultItems(
1048
+ /**
1049
+ * New value for property `enableMultiSelectionResultItems`
1050
+ */
1051
+ bEnableMultiSelectionResultItems?: boolean
1052
+ ): this;
1053
+ /**
1054
+ * Sets a new value for property {@link #getEnableQueryLanguage enableQueryLanguage}.
1055
+ *
1056
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
1057
+ * user to enter complex search queries with logical operators.
1058
+ *
1059
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1060
+ *
1061
+ * Default value is `false`.
1062
+ *
1063
+ * @since 1.107.0
1064
+ *
1065
+ * @returns Reference to `this` in order to allow method chaining
1066
+ */
1067
+ setEnableQueryLanguage(
1068
+ /**
1069
+ * New value for property `enableQueryLanguage`
1070
+ */
1071
+ bEnableQueryLanguage?: boolean
1072
+ ): this;
1073
+ /**
1074
+ * Sets a new value for property {@link #getEventConsumers eventConsumers}.
1075
+ *
1076
+ * Adds a callback function which is called whenever there is a user triggered event.
1077
+ *
1078
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1079
+ *
1080
+ * @since 1.120
1081
+ *
1082
+ * @returns Reference to `this` in order to allow method chaining
1083
+ */
1084
+ setEventConsumers(
1085
+ /**
1086
+ * New value for property `eventConsumers`
1087
+ */
1088
+ sEventConsumers: string
1089
+ ): this;
1090
+ /**
1091
+ * Sets a new value for property {@link #getExclusiveDataSource exclusiveDataSource}.
1092
+ *
1093
+ * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
1094
+ * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
1095
+ * panel) - data source name/link on result list (header section of item)
1096
+ *
1097
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1098
+ *
1099
+ * @since 1.121.0
1100
+ *
1101
+ * @returns Reference to `this` in order to allow method chaining
1102
+ */
1103
+ setExclusiveDataSource(
1104
+ /**
1105
+ * New value for property `exclusiveDataSource`
1106
+ */
1107
+ sExclusiveDataSource: string
1108
+ ): this;
1109
+ /**
1110
+ * Sets a new value for property {@link #getFacetPanelResizable facetPanelResizable}.
1111
+ *
1112
+ * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
1113
+ *
1114
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1115
+ *
1116
+ * Default value is `false`.
1117
+ *
1118
+ * @since 1.108.0
1119
+ *
1120
+ * @returns Reference to `this` in order to allow method chaining
1121
+ */
1122
+ setFacetPanelResizable(
1123
+ /**
1124
+ * New value for property `facetPanelResizable`
1125
+ */
1126
+ bFacetPanelResizable?: boolean
1127
+ ): this;
1128
+ /**
1129
+ * Sets a new value for property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
1130
+ *
1131
+ * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
1132
+ * is true, the width of the facet panel can be changed by the user.
1133
+ *
1134
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1135
+ *
1136
+ * Default value is `25`.
1137
+ *
1138
+ * @since 1.108.0
1139
+ *
1140
+ * @returns Reference to `this` in order to allow method chaining
1141
+ */
1142
+ setFacetPanelWidthInPercent(
1143
+ /**
1144
+ * New value for property `facetPanelWidthInPercent`
1145
+ */
1146
+ fFacetPanelWidthInPercent?: float
1147
+ ): this;
1148
+ /**
1149
+ * Sets a new value for property {@link #getFacetVisibility facetVisibility}.
1150
+ *
1151
+ * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
1152
+ * initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
1153
+ * typically is taken from the user personalization storage.
1154
+ *
1155
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1156
+ *
1157
+ * @since 1.113.0
1158
+ *
1159
+ * @returns Reference to `this` in order to allow method chaining
1160
+ */
1161
+ setFacetVisibility(
1162
+ /**
1163
+ * New value for property `facetVisibility`
1164
+ */
1165
+ bFacetVisibility: boolean
1166
+ ): this;
1167
+ /**
1168
+ * Sets a new value for property {@link #getFilterDataSources filterDataSources}.
1169
+ *
1170
+ * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
1171
+ * a list of datsources and returns the filtered list of datasources.
1172
+ *
1173
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1174
+ *
1175
+ * @since 1.112.0
1176
+ *
1177
+ * @returns Reference to `this` in order to allow method chaining
1178
+ */
1179
+ setFilterDataSources(
1180
+ /**
1181
+ * New value for property `filterDataSources`
1182
+ */
1183
+ fnFilterDataSources: Function
1184
+ ): this;
1185
+ /**
1186
+ * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
1187
+ *
1188
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
1189
+ * control only allows filter trees which have a the following structure: complex condition (root level)
1190
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
1191
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
1192
+ * for a more in-depth example.
1193
+ *
1194
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1195
+ *
1196
+ * @since 1.98.0
1197
+ *
1198
+ * @returns Reference to `this` in order to allow method chaining
1199
+ */
1200
+ setFilterRootCondition(
1201
+ /**
1202
+ * New value for property `filterRootCondition`
1203
+ */
1204
+ oFilterRootCondition: object
1205
+ ): this;
1206
+ /**
1207
+ * Sets a new value for property {@link #getFolderMode folderMode}.
1208
+ *
1209
+ * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
1210
+ * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
1211
+ * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
1212
+ * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
1213
+ * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
1214
+ * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
1215
+ * are set.
1216
+ *
1217
+ * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
1218
+ * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
1219
+ * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
1220
+ * children of a folder.
1221
+ *
1222
+ * @since 1.106.0
1223
+ *
1224
+ * @returns Reference to `this` in order to allow method chaining
1225
+ */
1226
+ setFolderMode(
1227
+ /**
1228
+ * New value for property `folderMode`
1229
+ */
1230
+ bFolderMode?: boolean
1231
+ ): this;
1232
+ /**
1233
+ * Sets a new value for property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}.
1234
+ *
1235
+ * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
1236
+ * is enabled.
1237
+ *
1238
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1239
+ *
1240
+ * Default value is `false`.
1241
+ *
1242
+ * @since 1.114.0
1243
+ *
1244
+ * @returns Reference to `this` in order to allow method chaining
1245
+ */
1246
+ setFolderModeForInitialSearch(
1247
+ /**
1248
+ * New value for property `folderModeForInitialSearch`
1249
+ */
1250
+ bFolderModeForInitialSearch?: boolean
1251
+ ): this;
1252
+ /**
1253
+ * Sets a new value for property {@link #getFormatFilterBarText formatFilterBarText}.
1254
+ *
1255
+ * Callback for formatting the filter string to be displayed in the filter bar (for closed facet panel).
1256
+ *
1257
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1258
+ *
1259
+ * @since 1.120
1260
+ *
1261
+ * @returns Reference to `this` in order to allow method chaining
1262
+ */
1263
+ setFormatFilterBarText(
1264
+ /**
1265
+ * New value for property `formatFilterBarText`
1266
+ */
1267
+ fnFormatFilterBarText: Function
1268
+ ): this;
1269
+ /**
1270
+ * Sets a new value for property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
1271
+ *
1272
+ * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
1273
+ * to be more specific and add some hints, links, buttons or other content.
1274
+ *
1275
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1276
+ *
1277
+ * @since 1.94.0
1278
+ *
1279
+ * @returns Reference to `this` in order to allow method chaining
1280
+ */
1281
+ setGetCustomNoResultScreen(
1282
+ /**
1283
+ * New value for property `getCustomNoResultScreen`
1284
+ */
1285
+ fnGetCustomNoResultScreen: Function
1286
+ ): this;
1287
+ /**
1288
+ * Sets a new value for property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
1289
+ *
1290
+ * A callback which returns customized "label" for placeholder text of search box, in case there is no search
1291
+ * term. The placeholder text (en) will be "Search In: ".
1292
+ *
1293
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1294
+ *
1295
+ *
1296
+ * @returns Reference to `this` in order to allow method chaining
1297
+ */
1298
+ setGetSearchInputPlaceholderLabel(
1299
+ /**
1300
+ * New value for property `getSearchInputPlaceholderLabel`
1301
+ */
1302
+ fnGetSearchInputPlaceholderLabel: Function
1303
+ ): this;
1304
+ /**
1305
+ * Sets a new value for property {@link #getInitAsync initAsync}.
1306
+ *
1307
+ * A callback which is called after the initialization of the search composite control.
1308
+ *
1309
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1310
+ *
1311
+ * @since 1.113.0
1312
+ *
1313
+ * @returns Reference to `this` in order to allow method chaining
1314
+ */
1315
+ setInitAsync(
1316
+ /**
1317
+ * New value for property `initAsync`
1318
+ */
1319
+ fnInitAsync: Function
1320
+ ): this;
1321
+ /**
1322
+ * Sets a new value for property {@link #getIsFilterBarVisible isFilterBarVisible}.
1323
+ *
1324
+ * Callback for checking whether the filter bar is visible.
1325
+ *
1326
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1327
+ *
1328
+ * @since 1.120
1329
+ *
1330
+ * @returns Reference to `this` in order to allow method chaining
1331
+ */
1332
+ setIsFilterBarVisible(
1333
+ /**
1334
+ * New value for property `isFilterBarVisible`
1335
+ */
1336
+ fnIsFilterBarVisible: Function
1337
+ ): this;
1338
+ /**
1339
+ * Sets a new value for property {@link #getIsSearchUrl isSearchUrl}.
1340
+ *
1341
+ * A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
1342
+ * case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
1343
+ *
1344
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1345
+ *
1346
+ * @since 1.113.0
1347
+ *
1348
+ * @returns Reference to `this` in order to allow method chaining
1349
+ */
1350
+ setIsSearchUrl(
1351
+ /**
1352
+ * New value for property `isSearchUrl`
1353
+ */
1354
+ fnIsSearchUrl: Function
1355
+ ): this;
1356
+ /**
1357
+ * Sets a new value for property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
1358
+ *
1359
+ * The layout is optimized for object selection / value help (narrow view w/o facet panel).
1360
+ *
1361
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1362
+ *
1363
+ * @since 1.111.0
1364
+ *
1365
+ * @returns Reference to `this` in order to allow method chaining
1366
+ */
1367
+ setOptimizeForValueHelp(
1368
+ /**
1369
+ * New value for property `optimizeForValueHelp`
1370
+ */
1371
+ bOptimizeForValueHelp: boolean
1372
+ ): this;
1373
+ /**
1374
+ * Sets a new value for property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
1375
+ *
1376
+ * Shall the window title be overwritten by this control? If true, the control will set the current search
1377
+ * condition as window title. If false, it will not set or update the window title.
1378
+ *
1379
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1380
+ *
1381
+ * @since 1.93.0
1382
+ *
1383
+ * @returns Reference to `this` in order to allow method chaining
1384
+ */
1385
+ setOverwriteBrowserTitle(
1386
+ /**
1387
+ * New value for property `overwriteBrowserTitle`
1388
+ */
1389
+ bOverwriteBrowserTitle: boolean
1390
+ ): this;
1391
+ /**
1392
+ * Sets a new value for property {@link #getPageSize pageSize}.
1393
+ *
1394
+ * The maximal count of search result items displayed on a page after a search. By clicking Show More button,
1395
+ * another page of result items of the same count (if available) will be displayed.
1396
+ *
1397
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1398
+ *
1399
+ * Default value is `10`.
1400
+ *
1401
+ * @since 1.96.0
1402
+ *
1403
+ * @returns Reference to `this` in order to allow method chaining
1404
+ */
1405
+ setPageSize(
1406
+ /**
1407
+ * New value for property `pageSize`
1408
+ */
1409
+ iPageSize?: int
1410
+ ): this;
1411
+ /**
1412
+ * Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
1413
+ *
1414
+ * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
1415
+ * parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
1416
+ * is not needed.
1417
+ *
1418
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1419
+ *
1420
+ * @since 1.113.0
1421
+ *
1422
+ * @returns Reference to `this` in order to allow method chaining
1423
+ */
1424
+ setParseSearchUrlParameters(
1425
+ /**
1426
+ * New value for property `parseSearchUrlParameters`
1427
+ */
1428
+ fnParseSearchUrlParameters: Function
1429
+ ): this;
1430
+ /**
1431
+ * Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}.
1432
+ *
1433
+ * A list of datasources to be displayed in the facet panel in the collection area.
1434
+ *
1435
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1436
+ *
1437
+ * @since 1.113.0
1438
+ *
1439
+ * @returns Reference to `this` in order to allow method chaining
1440
+ */
1441
+ setQuickSelectDataSources(
1442
+ /**
1443
+ * New value for property `quickSelectDataSources`
1444
+ */
1445
+ oQuickSelectDataSources: object
1446
+ ): this;
1447
+ /**
1448
+ * Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}.
1449
+ *
1450
+ * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
1451
+ * the URL string. Typically you need to register this callback in case updateUrl=true.
1452
+ *
1453
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1454
+ *
1455
+ * @since 1.113.0
1456
+ *
1457
+ * @returns Reference to `this` in order to allow method chaining
1458
+ */
1459
+ setRenderSearchUrl(
1460
+ /**
1461
+ * New value for property `renderSearchUrl`
1462
+ */
1463
+ fnRenderSearchUrl: Function
1464
+ ): this;
1465
+ /**
1466
+ * Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
1467
+ *
1468
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
1469
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
1470
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
1471
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
1472
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
1473
+ * and `resultViewType` must be compatible to each other.
1474
+ *
1475
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1476
+ *
1477
+ * Default value is `...see text or source`.
1478
+ *
1479
+ * @since 1.100.0
1480
+ *
1481
+ * @returns Reference to `this` in order to allow method chaining
1482
+ */
1483
+ setResultViewSettings(
1484
+ /**
1485
+ * New value for property `resultViewSettings`
1486
+ */
1487
+ sResultViewSettings?: string
1488
+ ): this;
1489
+ /**
1490
+ * Sets a new value for property {@link #getResultViewType resultViewType}.
1491
+ *
1492
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
1493
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
1494
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
1495
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
1496
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
1497
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
1498
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
1499
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
1500
+ *
1501
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1502
+ *
1503
+ * Default value is `"searchResultList"`.
1504
+ *
1505
+ * @since 1.98.0
1506
+ *
1507
+ * @returns Reference to `this` in order to allow method chaining
1508
+ */
1509
+ setResultViewType(
1510
+ /**
1511
+ * New value for property `resultViewType`
1512
+ */
1513
+ sResultViewType?: string
1514
+ ): this;
1515
+ /**
1516
+ * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
1517
+ *
1518
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
1519
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
1520
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
1521
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
1522
+ * Search in Business Object: result is switchable between different view types. Possible values for the
1523
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
1524
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
1525
+ *
1526
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1527
+ *
1528
+ * Default value is `["searchResultList", "searchResultTable"]`.
1529
+ *
1530
+ * @since 1.98.0
1531
+ *
1532
+ * @returns Reference to `this` in order to allow method chaining
1533
+ */
1534
+ setResultViewTypes(
1535
+ /**
1536
+ * New value for property `resultViewTypes`
1537
+ */
1538
+ sResultViewTypes?: string[]
1539
+ ): this;
1540
+ /**
1541
+ * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
1542
+ *
1543
+ * Defines if the search composite control will send a search request after loading for the given term,
1544
+ * data source and filter root condition settings.
1545
+ *
1546
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1547
+ *
1548
+ * Default value is `true`.
1549
+ *
1550
+ * @since 1.93.0
1551
+ *
1552
+ * @returns Reference to `this` in order to allow method chaining
1553
+ */
1554
+ setSearchOnStart(
1555
+ /**
1556
+ * New value for property `searchOnStart`
1557
+ */
1558
+ bSearchOnStart?: boolean
1559
+ ): this;
1560
+ /**
1561
+ * Sets a new value for property {@link #getSearchTerm searchTerm}.
1562
+ *
1563
+ * Defines the initial search term for the search input.
1564
+ *
1565
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1566
+ *
1567
+ * Default value is `empty string`.
1568
+ *
1569
+ * @since 1.93.0
1570
+ *
1571
+ * @returns Reference to `this` in order to allow method chaining
1572
+ */
1573
+ setSearchTerm(
1574
+ /**
1575
+ * New value for property `searchTerm`
1576
+ */
1577
+ sSearchTerm?: string
1578
+ ): this;
1579
+ /**
1580
+ * Sets a new value for property {@link #getSelectionChange selectionChange}.
1581
+ *
1582
+ * A callback which is called whenever the selection of result list items changes.
1583
+ *
1584
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1585
+ *
1586
+ * @since 1.113.0
1587
+ *
1588
+ * @returns Reference to `this` in order to allow method chaining
1589
+ */
1590
+ setSelectionChange(
1591
+ /**
1592
+ * New value for property `selectionChange`
1593
+ */
1594
+ fnSelectionChange: Function
1595
+ ): this;
1596
+ /**
1597
+ * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
1598
+ *
1599
+ * Configuration for the Enterprise Search Client API.
1600
+ *
1601
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1602
+ *
1603
+ * @since 1.93.0
1604
+ *
1605
+ * @returns Reference to `this` in order to allow method chaining
1606
+ */
1607
+ setSinaConfiguration(
1608
+ /**
1609
+ * New value for property `sinaConfiguration`
1610
+ */
1611
+ oSinaConfiguration: object
1612
+ ): this;
1613
+ /**
1614
+ * Sets a new value for property {@link #getTabStripsFormatter tabStripsFormatter}.
1615
+ *
1616
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
1617
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
1618
+ * in the tabstrips.
1619
+ *
1620
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1621
+ *
1622
+ * @since 1.103.0
1623
+ *
1624
+ * @returns Reference to `this` in order to allow method chaining
1625
+ */
1626
+ setTabStripsFormatter(
1627
+ /**
1628
+ * New value for property `tabStripsFormatter`
1629
+ */
1630
+ fnTabStripsFormatter: Function
1631
+ ): this;
1632
+ /**
1633
+ * Sets a new value for property {@link #getUpdateUrl updateUrl}.
1634
+ *
1635
+ * A boolean indicating that the search state is written to the URL.
1636
+ *
1637
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1638
+ *
1639
+ * Default value is `true`.
1640
+ *
1641
+ * @since 1.113.0
1642
+ *
1643
+ * @returns Reference to `this` in order to allow method chaining
1644
+ */
1645
+ setUpdateUrl(
1646
+ /**
1647
+ * New value for property `updateUrl`
1648
+ */
1649
+ bUpdateUrl?: boolean
1650
+ ): this;
1651
+ }
1652
+ /**
1653
+ * Describes the settings that can be provided to the SearchCompositeControl constructor.
1654
+ */
1655
+ export interface $SearchCompositeControlSettings extends $ControlSettings {
1656
+ /**
1657
+ * An additional CSS class to add to this control
1658
+ *
1659
+ * @since 1.93.0
1660
+ */
1661
+ cssClass?: string | PropertyBindingInfo;
1662
+
1663
+ /**
1664
+ * Defines the initial search term for the search input.
1665
+ *
1666
+ * @since 1.93.0
1667
+ */
1668
+ searchTerm?: string | PropertyBindingInfo;
1669
+
1670
+ /**
1671
+ * Defines if the search composite control will send a search request after loading for the given term,
1672
+ * data source and filter root condition settings.
1673
+ *
1674
+ * @since 1.93.0
1675
+ */
1676
+ searchOnStart?: boolean | PropertyBindingInfo | `{${string}}`;
1677
+
1678
+ /**
1679
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
1680
+ * control only allows filter trees which have a the following structure: complex condition (root level)
1681
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
1682
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
1683
+ * for a more in-depth example.
1684
+ *
1685
+ * @since 1.98.0
1686
+ */
1687
+ filterRootCondition?: object | PropertyBindingInfo | `{${string}}`;
1688
+
1689
+ /**
1690
+ * Configuration for the Enterprise Search Client API.
1691
+ *
1692
+ * @since 1.93.0
1693
+ */
1694
+ sinaConfiguration?: object | PropertyBindingInfo | `{${string}}`;
1695
+
1696
+ /**
1697
+ * The id of the data source in which it will search right after initialization.
1698
+ *
1699
+ * @since 1.98.0
1700
+ */
1701
+ dataSource?: string | PropertyBindingInfo;
1702
+
1703
+ /**
1704
+ * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
1705
+ * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
1706
+ * panel) - data source name/link on result list (header section of item)
1707
+ *
1708
+ * @since 1.121.0
1709
+ */
1710
+ exclusiveDataSource?: string | PropertyBindingInfo;
1711
+
1712
+ /**
1713
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
1714
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
1715
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
1716
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
1717
+ * Search in Business Object: result is switchable between different view types. Possible values for the
1718
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
1719
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
1720
+ *
1721
+ * @since 1.98.0
1722
+ */
1723
+ resultViewTypes?: string[] | PropertyBindingInfo | `{${string}}`;
1724
+
1725
+ /**
1726
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
1727
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
1728
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
1729
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
1730
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
1731
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
1732
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
1733
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
1734
+ *
1735
+ * @since 1.98.0
1736
+ */
1737
+ resultViewType?: string | PropertyBindingInfo;
1738
+
1739
+ /**
1740
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
1741
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
1742
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
1743
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
1744
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
1745
+ * and `resultViewType` must be compatible to each other.
1746
+ *
1747
+ * @since 1.100.0
1748
+ */
1749
+ resultViewSettings?: string | PropertyBindingInfo;
1750
+
1751
+ /**
1752
+ * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
1753
+ * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
1754
+ * in the tabstrips.
1755
+ *
1756
+ * @since 1.103.0
1757
+ */
1758
+ tabStripsFormatter?: Function | PropertyBindingInfo | `{${string}}`;
1759
+
1760
+ /**
1761
+ * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
1762
+ * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
1763
+ * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
1764
+ * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
1765
+ * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
1766
+ * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
1767
+ * are set.
1768
+ *
1769
+ * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
1770
+ * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
1771
+ * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
1772
+ * children of a folder. * @since 1.106.0
1773
+ */
1774
+ folderMode?: boolean | PropertyBindingInfo | `{${string}}`;
1775
+
1776
+ /**
1777
+ * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
1778
+ * is enabled.
1779
+ *
1780
+ * @since 1.114.0
1781
+ */
1782
+ folderModeForInitialSearch?: boolean | PropertyBindingInfo | `{${string}}`;
1783
+
1784
+ /**
1785
+ * In case folder mode is active: Automatically switch result view type to list in search mode and to table
1786
+ * in folder mode.
1787
+ *
1788
+ * @since 1.106.0
1789
+ */
1790
+ autoAdjustResultViewTypeInFolderMode?:
1791
+ | boolean
1792
+ | PropertyBindingInfo
1793
+ | `{${string}}`;
1794
+
1795
+ /**
1796
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
1797
+ * user to enter complex search queries with logical operators.
1798
+ *
1799
+ * @since 1.107.0
1800
+ */
1801
+ enableQueryLanguage?: boolean | PropertyBindingInfo | `{${string}}`;
1802
+
1803
+ /**
1804
+ * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
1805
+ *
1806
+ * @since 1.108.0
1807
+ */
1808
+ applicationComponent?: string | PropertyBindingInfo;
1809
+
1810
+ /**
1811
+ * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
1812
+ *
1813
+ * @since 1.108.0
1814
+ */
1815
+ facetPanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
1816
+
1817
+ /**
1818
+ * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
1819
+ * is true, the width of the facet panel can be changed by the user.
1820
+ *
1821
+ * @since 1.108.0
1822
+ */
1823
+ facetPanelWidthInPercent?: float | PropertyBindingInfo | `{${string}}`;
1824
+
1825
+ /**
1826
+ * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
1827
+ * to be more specific and add some hints, links, buttons or other content.
1828
+ *
1829
+ * @since 1.94.0
1830
+ */
1831
+ getCustomNoResultScreen?: Function | PropertyBindingInfo | `{${string}}`;
1832
+
1833
+ /**
1834
+ * A callback which returns customized "label" for placeholder text of search box, in case there is no search
1835
+ * term. The placeholder text (en) will be "Search In: ".
1836
+ */
1837
+ getSearchInputPlaceholderLabel?:
1838
+ | Function
1839
+ | PropertyBindingInfo
1840
+ | `{${string}}`;
1841
+
1842
+ /**
1843
+ * Shall the window title be overwritten by this control? If true, the control will set the current search
1844
+ * condition as window title. If false, it will not set or update the window title.
1845
+ *
1846
+ * @since 1.93.0
1847
+ */
1848
+ overwriteBrowserTitle?: boolean | PropertyBindingInfo | `{${string}}`;
1849
+
1850
+ /**
1851
+ * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
1852
+ * will be used during UI load and this parameter will used only after filter is reset.
1853
+ *
1854
+ * @since 1.93.0
1855
+ */
1856
+ defaultDataSource?: string | PropertyBindingInfo;
1857
+
1858
+ /**
1859
+ * The layout is optimized for object selection / value help (narrow view w/o facet panel).
1860
+ *
1861
+ * @since 1.111.0
1862
+ */
1863
+ optimizeForValueHelp?: boolean | PropertyBindingInfo | `{${string}}`;
1864
+
1865
+ /**
1866
+ * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
1867
+ * a list of datsources and returns the filtered list of datasources.
1868
+ *
1869
+ * @since 1.112.0
1870
+ */
1871
+ filterDataSources?: Function | PropertyBindingInfo | `{${string}}`;
1872
+
1873
+ /**
1874
+ * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
1875
+ * initial state of the facet panel. When not setting facetVisibility the initial state of the facet panel
1876
+ * typically is taken from the user personalization storage.
1877
+ *
1878
+ * @since 1.113.0
1879
+ */
1880
+ facetVisibility?: boolean | PropertyBindingInfo | `{${string}}`;
1881
+
1882
+ /**
1883
+ * A boolean for enabling (business) object suggestions.
1884
+ *
1885
+ * @since 1.113.0
1886
+ */
1887
+ boSuggestions?: boolean | PropertyBindingInfo | `{${string}}`;
1888
+
1889
+ /**
1890
+ * When set to true the facet panel is displayed also in case there are no search results.
1891
+ *
1892
+ * @since 1.113.0
1893
+ */
1894
+ displayFacetPanelInCaseOfNoResults?:
1895
+ | boolean
1896
+ | PropertyBindingInfo
1897
+ | `{${string}}`;
1898
+
1899
+ /**
1900
+ * A boolean indicating that the search state is written to the URL.
1901
+ *
1902
+ * @since 1.113.0
1903
+ */
1904
+ updateUrl?: boolean | PropertyBindingInfo | `{${string}}`;
1905
+
1906
+ /**
1907
+ * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
1908
+ * the URL string. Typically you need to register this callback in case updateUrl=true.
1909
+ *
1910
+ * @since 1.113.0
1911
+ */
1912
+ renderSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
1913
+
1914
+ /**
1915
+ * A callback for checking whether a URL is a search URL. The callback receives a URL and returns true in
1916
+ * case the URL is a search URL. Typically you need to register this callback in case updateUrl=true.
1917
+ *
1918
+ * @since 1.113.0
1919
+ */
1920
+ isSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
1921
+
1922
+ /**
1923
+ * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
1924
+ * parameters. This is an optional callback. Also in case you set updateUrl=true typcically this callback
1925
+ * is not needed.
1926
+ *
1927
+ * @since 1.113.0
1928
+ */
1929
+ parseSearchUrlParameters?: Function | PropertyBindingInfo | `{${string}}`;
1930
+
1931
+ /**
1932
+ * A list of datasources to be displayed in the facet panel in the collection area.
1933
+ *
1934
+ * @since 1.113.0
1935
+ */
1936
+ quickSelectDataSources?: object | PropertyBindingInfo | `{${string}}`;
1937
+
1938
+ /**
1939
+ * A callback which is called whenever the selection of result list items changes.
1940
+ *
1941
+ * @since 1.113.0
1942
+ */
1943
+ selectionChange?: Function | PropertyBindingInfo | `{${string}}`;
1944
+
1945
+ /**
1946
+ * A callback which is called after the initialization of the search composite control.
1947
+ *
1948
+ * @since 1.113.0
1949
+ */
1950
+ initAsync?: Function | PropertyBindingInfo | `{${string}}`;
1951
+
1952
+ /**
1953
+ * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
1954
+ * the value is true.
1955
+ *
1956
+ * @since 1.96.0
1957
+ */
1958
+ enableMultiSelectionResultItems?:
1959
+ | boolean
1960
+ | PropertyBindingInfo
1961
+ | `{${string}}`;
1962
+
1963
+ /**
1964
+ * The maximal count of search result items displayed on a page after a search. By clicking Show More button,
1965
+ * another page of result items of the same count (if available) will be displayed.
1966
+ *
1967
+ * @since 1.96.0
1968
+ */
1969
+ pageSize?: int | PropertyBindingInfo | `{${string}}`;
1970
+
1971
+ /**
1972
+ * Callback for formatting the filter string to be displayed in the filter bar (for closed facet panel).
1973
+ *
1974
+ * @since 1.120
1975
+ */
1976
+ formatFilterBarText?: Function | PropertyBindingInfo | `{${string}}`;
1977
+
1978
+ /**
1979
+ * Callback for checking whether the filter bar is visible.
1980
+ *
1981
+ * @since 1.120
1982
+ */
1983
+ isFilterBarVisible?: Function | PropertyBindingInfo | `{${string}}`;
1984
+
1985
+ /**
1986
+ * Adds a callback function which is called whenever there is a user triggered event.
1987
+ *
1988
+ * @since 1.120
1989
+ */
1990
+ eventConsumers?: string | PropertyBindingInfo;
1991
+
1992
+ /**
1993
+ * Control instances which are part of this composite control.
1994
+ */
1995
+ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
1996
+
1997
+ /**
1998
+ * Event is fired when search is started.
1999
+ *
2000
+ * @since 1.121
2001
+ */
2002
+ searchStarted?: (oEvent: Event) => void;
2003
+
2004
+ /**
2005
+ * Event is fired when search is finished.
2006
+ *
2007
+ * @since 1.121
2008
+ */
2009
+ searchFinished?: (oEvent: Event) => void;
2010
+
2011
+ /**
2012
+ * Event is fired when selection on result view (list, table or grid) has changed.
2013
+ *
2014
+ * @since 1.121
2015
+ */
2016
+ selectionChanged?: (oEvent: Event) => void;
2017
+ }
2018
+
2019
+ /**
2020
+ * Parameters of the SearchCompositeControl#searchFinished event.
2021
+ */
2022
+ export interface SearchCompositeControl$SearchFinishedEventParameters {}
2023
+
2024
+ /**
2025
+ * Event object of the SearchCompositeControl#searchFinished event.
2026
+ */
2027
+ export type SearchCompositeControl$SearchFinishedEvent = Event<
2028
+ SearchCompositeControl$SearchFinishedEventParameters,
2029
+ SearchCompositeControl
2030
+ >;
2031
+
2032
+ /**
2033
+ * Parameters of the SearchCompositeControl#searchStarted event.
2034
+ */
2035
+ export interface SearchCompositeControl$SearchStartedEventParameters {}
2036
+
2037
+ /**
2038
+ * Event object of the SearchCompositeControl#searchStarted event.
2039
+ */
2040
+ export type SearchCompositeControl$SearchStartedEvent = Event<
2041
+ SearchCompositeControl$SearchStartedEventParameters,
2042
+ SearchCompositeControl
2043
+ >;
2044
+
2045
+ /**
2046
+ * Parameters of the SearchCompositeControl#selectionChanged event.
2047
+ */
2048
+ export interface SearchCompositeControl$SelectionChangedEventParameters {}
2049
+
2050
+ /**
2051
+ * Event object of the SearchCompositeControl#selectionChanged event.
2052
+ */
2053
+ export type SearchCompositeControl$SelectionChangedEvent = Event<
2054
+ SearchCompositeControl$SelectionChangedEventParameters,
2055
+ SearchCompositeControl
2056
+ >;
2057
+ }
2058
+
2059
+ declare module "sap/esh/search/ui/library" {}
2060
+
2061
+ declare namespace sap {
2062
+ interface IUI5DefineDependencyNames {
2063
+ "sap/esh/search/ui/library": undefined;
2064
+
2065
+ "sap/esh/search/ui/SearchCompositeControl": undefined;
2066
+ }
2067
+ }