@sapui5/ts-types-esm 1.140.0 → 1.141.1

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