@sapui5/ts-types-esm 1.139.0 → 1.140.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +0 -1623
  7. package/types/sap.esh.search.ui.d.ts +1 -2297
  8. package/types/sap.f.d.ts +59 -11
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -5
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +15 -8
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +3 -10
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +41 -11
  23. package/types/sap.insights.d.ts +130 -2
  24. package/types/sap.m.d.ts +645 -274
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +99 -1
  31. package/types/sap.suite.ui.commons.d.ts +1 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +5 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +16 -1
  38. package/types/sap.ui.core.d.ts +402 -97
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +1 -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 +13 -13
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.mdc.d.ts +80 -28
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +568 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +1 -1
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +307 -6
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +10 -6
  63. package/types/sap.ushell_abap.d.ts +3 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,2305 +1,9 @@
1
- // For Library Version: 1.139.0
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
- * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
301
- * event of this `sap.esh.search.ui.SearchCompositeControl`.
302
- *
303
- * The passed function and listener object must match the ones used for event registration.
304
- *
305
- * @since 1.124
306
- *
307
- * @returns Reference to `this` in order to allow method chaining
308
- */
309
- detachResultViewTypeChanged(
310
- /**
311
- * The function to be called, when the event occurs
312
- */
313
- fnFunction: (p1: Event) => void,
314
- /**
315
- * Context object on which the given function had to be called
316
- */
317
- oListener?: object
318
- ): this;
319
- /**
320
- * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
321
- * `sap.esh.search.ui.SearchCompositeControl`.
322
- *
323
- * The passed function and listener object must match the ones used for event registration.
324
- *
325
- * @since 1.121
326
- *
327
- * @returns Reference to `this` in order to allow method chaining
328
- */
329
- detachSearchFinished(
330
- /**
331
- * The function to be called, when the event occurs
332
- */
333
- fnFunction: (p1: Event) => void,
334
- /**
335
- * Context object on which the given function had to be called
336
- */
337
- oListener?: object
338
- ): this;
339
- /**
340
- * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
341
- * `sap.esh.search.ui.SearchCompositeControl`.
342
- *
343
- * The passed function and listener object must match the ones used for event registration.
344
- *
345
- * @since 1.121
346
- *
347
- * @returns Reference to `this` in order to allow method chaining
348
- */
349
- detachSearchStarted(
350
- /**
351
- * The function to be called, when the event occurs
352
- */
353
- fnFunction: (p1: Event) => void,
354
- /**
355
- * Context object on which the given function had to be called
356
- */
357
- oListener?: object
358
- ): this;
359
- /**
360
- * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of
361
- * this `sap.esh.search.ui.SearchCompositeControl`.
362
- *
363
- * The passed function and listener object must match the ones used for event registration.
364
- *
365
- * @since 1.121
366
- *
367
- * @returns Reference to `this` in order to allow method chaining
368
- */
369
- detachSelectionChanged(
370
- /**
371
- * The function to be called, when the event occurs
372
- */
373
- fnFunction: (p1: Event) => void,
374
- /**
375
- * Context object on which the given function had to be called
376
- */
377
- oListener?: object
378
- ): this;
379
- /**
380
- * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
381
- *
382
- * @since 1.124
383
- * @ui5-protected Do not call from applications (only from related classes in the framework)
384
- *
385
- * @returns Reference to `this` in order to allow method chaining
386
- */
387
- fireResultViewTypeChanged(
388
- /**
389
- * Parameters to pass along with the event
390
- */
391
- mParameters?: object
392
- ): this;
393
- /**
394
- * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
395
- *
396
- * @since 1.121
397
- * @ui5-protected Do not call from applications (only from related classes in the framework)
398
- *
399
- * @returns Reference to `this` in order to allow method chaining
400
- */
401
- fireSearchFinished(
402
- /**
403
- * Parameters to pass along with the event
404
- */
405
- mParameters?: object
406
- ): this;
407
- /**
408
- * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
409
- *
410
- * @since 1.121
411
- * @ui5-protected Do not call from applications (only from related classes in the framework)
412
- *
413
- * @returns Reference to `this` in order to allow method chaining
414
- */
415
- fireSearchStarted(
416
- /**
417
- * Parameters to pass along with the event
418
- */
419
- mParameters?: object
420
- ): this;
421
- /**
422
- * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
423
- *
424
- * @since 1.121
425
- * @ui5-protected Do not call from applications (only from related classes in the framework)
426
- *
427
- * @returns Reference to `this` in order to allow method chaining
428
- */
429
- fireSelectionChanged(
430
- /**
431
- * Parameters to pass along with the event
432
- */
433
- mParameters?: object
434
- ): this;
435
- /**
436
- * Gets current value of property {@link #getApplicationComponent applicationComponent}.
437
- *
438
- * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
439
- *
440
- * Default value is `"HAN-AS-INA-UI"`.
441
- *
442
- * @since 1.108.0
443
- *
444
- * @returns Value of property `applicationComponent`
445
- */
446
- getApplicationComponent(): string;
447
- /**
448
- * Gets current value of property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
449
- *
450
- * In case folder mode is active: Automatically switch result view type to list in search mode and to table
451
- * in folder mode.
452
- *
453
- * Default value is `false`.
454
- *
455
- * @since 1.106.0
456
- *
457
- * @returns Value of property `autoAdjustResultViewTypeInFolderMode`
458
- */
459
- getAutoAdjustResultViewTypeInFolderMode(): boolean;
460
- /**
461
- * Gets current value of property {@link #getBoSuggestions boSuggestions}.
462
- *
463
- * A boolean for enabling (business) object suggestions.
464
- *
465
- * Default value is `false`.
466
- *
467
- * @since 1.113.0
468
- *
469
- * @returns Value of property `boSuggestions`
470
- */
471
- getBoSuggestions(): boolean;
472
- /**
473
- * Gets current value of property {@link #getCssClass cssClass}.
474
- *
475
- * An additional CSS class to add to this control
476
- *
477
- * @since 1.93.0
478
- *
479
- * @returns Value of property `cssClass`
480
- */
481
- getCssClass(): string;
482
- /**
483
- * Gets current value of property {@link #getDataSource dataSource}.
484
- *
485
- * The id of the data source in which it will search right after initialization.
486
- *
487
- * @since 1.98.0
488
- *
489
- * @returns Value of property `dataSource`
490
- */
491
- getDataSource(): string;
492
- /**
493
- * Gets current value of property {@link #getDefaultDataSource defaultDataSource}.
494
- *
495
- * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
496
- * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
497
- * to 'true', do not set this parameter (will be ignored).
498
- *
499
- * @since 1.93.0
500
- *
501
- * @returns Value of property `defaultDataSource`
502
- */
503
- getDefaultDataSource(): string;
504
- /**
505
- * Gets current value of property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
506
- *
507
- * When set to true the facet panel is displayed also in case there are no search results.
508
- *
509
- * Default value is `false`.
510
- *
511
- * @since 1.113.0
512
- * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
513
- * by the end user.
514
- *
515
- * @returns Value of property `displayFacetPanelInCaseOfNoResults`
516
- */
517
- getDisplayFacetPanelInCaseOfNoResults(): boolean;
518
- /**
519
- * Gets current value of property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
520
- *
521
- * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
522
- * the value is set to 'true'.
523
- *
524
- * Default value is `false`.
525
- *
526
- * @since 1.96.0
527
- *
528
- * @returns Value of property `enableMultiSelectionResultItems`
529
- */
530
- getEnableMultiSelectionResultItems(): boolean;
531
- /**
532
- * Gets current value of property {@link #getEnableQueryLanguage enableQueryLanguage}.
533
- *
534
- * Enables the query language for the hana_odata provider. With query language it is possible for the end
535
- * user to enter complex search queries with logical operators.
536
- *
537
- * Default value is `false`.
538
- *
539
- * @since 1.107.0
540
- *
541
- * @returns Value of property `enableQueryLanguage`
542
- */
543
- getEnableQueryLanguage(): boolean;
544
- /**
545
- * Gets current value of property {@link #getEventConsumers eventConsumers}.
546
- *
547
- * Adds a callback function which is called whenever there is a user or a technical event. A user event
548
- * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
549
- * is an event which is triggered by the internal events or events which can also be triggered by API.
550
- *
551
- * @since 1.120
552
- *
553
- * @returns Value of property `eventConsumers`
554
- */
555
- getEventConsumers(): string;
556
- /**
557
- * Gets current value of property {@link #getExclusiveDataSource exclusiveDataSource}.
558
- *
559
- * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
560
- * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
561
- * panel) - data source name/link on result list (header section of item)
562
- *
563
- * @since 1.121.0
564
- *
565
- * @returns Value of property `exclusiveDataSource`
566
- */
567
- getExclusiveDataSource(): string;
568
- /**
569
- * Gets current value of property {@link #getFacetPanelResizable facetPanelResizable}.
570
- *
571
- * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
572
- *
573
- * Default value is `true`.
574
- *
575
- * @since 1.108.0
576
- *
577
- * @returns Value of property `facetPanelResizable`
578
- */
579
- getFacetPanelResizable(): boolean;
580
- /**
581
- * Gets current value of property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
582
- *
583
- * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
584
- * is true, the width of the facet panel can be changed by the user.
585
- *
586
- * Default value is `25`.
587
- *
588
- * @since 1.108.0
589
- *
590
- * @returns Value of property `facetPanelWidthInPercent`
591
- */
592
- getFacetPanelWidthInPercent(): float;
593
- /**
594
- * Gets current value of property {@link #getFacets facets}.
595
- *
596
- * Controls whether the facet functionality is available or not.
597
- *
598
- * Default value is `true`.
599
- *
600
- * @since 1.132.0
601
- *
602
- * @returns Value of property `facets`
603
- */
604
- getFacets(): boolean;
605
- /**
606
- * Gets current value of property {@link #getFacetVisibility facetVisibility}.
607
- *
608
- * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
609
- * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
610
- * depending on the user's personalization settings.
611
- *
612
- * Default value is `false`.
613
- *
614
- * @since 1.113.0
615
- *
616
- * @returns Value of property `facetVisibility`
617
- */
618
- getFacetVisibility(): boolean;
619
- /**
620
- * Gets current value of property {@link #getFilterDataSources filterDataSources}.
621
- *
622
- * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
623
- * a list of datsources and returns the filtered list of datasources.
624
- *
625
- * @since 1.112.0
626
- *
627
- * @returns Value of property `filterDataSources`
628
- */
629
- getFilterDataSources(): Function;
630
- /**
631
- * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
632
- *
633
- * Defines the filter root condition of a filter tree which shall be applied to the search request. This
634
- * control only allows filter trees which have a the following structure: complex condition (root level)
635
- * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
636
- * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
637
- * for a more in-depth example.
638
- *
639
- * @since 1.98.0
640
- *
641
- * @returns Value of property `filterRootCondition`
642
- */
643
- getFilterRootCondition(): object;
644
- /**
645
- * Gets current value of property {@link #getFolderMode folderMode}.
646
- *
647
- * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
648
- * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
649
- * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
650
- * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
651
- * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
652
- * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
653
- * are set.
654
- *
655
- * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
656
- * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
657
- * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
658
- * children of a folder.
659
- *
660
- * @since 1.106.0
661
- *
662
- * @returns Value of property `folderMode`
663
- */
664
- getFolderMode(): boolean;
665
- /**
666
- * Gets current value of property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}.
667
- *
668
- * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
669
- * is enabled.
670
- *
671
- * Default value is `false`.
672
- *
673
- * @since 1.114.0
674
- *
675
- * @returns Value of property `folderModeForInitialSearch`
676
- */
677
- getFolderModeForInitialSearch(): boolean;
678
- /**
679
- * Gets current value of property {@link #getFormatFilterBarText formatFilterBarText}.
680
- *
681
- * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
682
- *
683
- * @since 1.120
684
- *
685
- * @returns Value of property `formatFilterBarText`
686
- */
687
- getFormatFilterBarText(): Function;
688
- /**
689
- * Gets current value of property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
690
- *
691
- * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
692
- * to be more specific and add some hints, links, buttons or other content.
693
- *
694
- * @since 1.94.0
695
- *
696
- * @returns Value of property `getCustomNoResultScreen`
697
- */
698
- getGetCustomNoResultScreen(): Function;
699
- /**
700
- * Gets current value of property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
701
- *
702
- * A callback which returns customized "label" for placeholder text of search box in case there is no search
703
- * term. The placeholder text (en) will be "Search In: ".
704
- *
705
- *
706
- * @returns Value of property `getSearchInputPlaceholderLabel`
707
- */
708
- getGetSearchInputPlaceholderLabel(): Function;
709
- /**
710
- * Gets current value of property {@link #getInitAsync initAsync}.
711
- *
712
- * An asynchronues callback which is called after the initialization of the search composite control.
713
- *
714
- * @since 1.113.0
715
- *
716
- * @returns Value of property `initAsync`
717
- */
718
- getInitAsync(): Function;
719
- /**
720
- * Get the status of initialization. In unsuccessful case, the corresponding error instance is returned
721
- * either.
722
- *
723
- * @since 1.132.0
724
- *
725
- * @returns Promise<{success: boolean;error?: Error;}> If success is true, the initialization was successful.
726
- * If success is false, the error property contains the error instance for further handling.
727
- */
728
- getInitializationStatus(): object;
729
- /**
730
- * Gets current value of property {@link #getIsFilterBarVisible isFilterBarVisible}.
731
- *
732
- * Callback for checking whether the filter bar is visible.
733
- *
734
- * @since 1.120
735
- *
736
- * @returns Value of property `isFilterBarVisible`
737
- */
738
- getIsFilterBarVisible(): Function;
739
- /**
740
- * Gets current value of property {@link #getIsSearchUrl isSearchUrl}.
741
- *
742
- * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
743
- * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
744
- * of 'updateUrl = true'.
745
- *
746
- * @since 1.113.0
747
- *
748
- * @returns Value of property `isSearchUrl`
749
- */
750
- getIsSearchUrl(): Function;
751
- /**
752
- * Gets current value of property {@link #getLimitAjaxRequests limitAjaxRequests}.
753
- *
754
- * Prevents too many ajax requests in a short time.
755
- *
756
- * Default value is `true`.
757
- *
758
- *
759
- * @returns Value of property `limitAjaxRequests`
760
- */
761
- getLimitAjaxRequests(): boolean;
762
- /**
763
- * Gets current value of property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
764
- *
765
- * The layout is optimized for object selection / value help (narrow view w/o facet panel).
766
- *
767
- * @since 1.111.0
768
- *
769
- * @returns Value of property `optimizeForValueHelp`
770
- */
771
- getOptimizeForValueHelp(): boolean;
772
- /**
773
- * Gets current value of property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
774
- *
775
- * Shall the window title be overwritten by this control? If true, the control will set the current search
776
- * condition as window title. If false, it will not set or update the window title.
777
- *
778
- * @since 1.93.0
779
- *
780
- * @returns Value of property `overwriteBrowserTitle`
781
- */
782
- getOverwriteBrowserTitle(): boolean;
783
- /**
784
- * Gets current value of property {@link #getPageSize pageSize}.
785
- *
786
- * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
787
- * button, another page of result items of the same count (if available) will be displayed.
788
- *
789
- * Default value is `10`.
790
- *
791
- * @since 1.96.0
792
- *
793
- * @returns Value of property `pageSize`
794
- */
795
- getPageSize(): int;
796
- /**
797
- * Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
798
- *
799
- * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
800
- * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
801
- * is not needed.
802
- *
803
- * @since 1.113.0
804
- *
805
- * @returns Value of property `parseSearchUrlParameters`
806
- */
807
- getParseSearchUrlParameters(): Function;
808
- /**
809
- * Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}.
810
- *
811
- * A list of data sources to be displayed in the facet panel in the section "Collection".
812
- *
813
- * @since 1.113.0
814
- *
815
- * @returns Value of property `quickSelectDataSources`
816
- */
817
- getQuickSelectDataSources(): object;
818
- /**
819
- * Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}.
820
- *
821
- * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
822
- * the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
823
- *
824
- * @since 1.113.0
825
- *
826
- * @returns Value of property `renderSearchUrl`
827
- */
828
- getRenderSearchUrl(): Function;
829
- /**
830
- * Gets current value of property {@link #getResultViewSettings resultViewSettings}.
831
- *
832
- * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
833
- * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
834
- * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
835
- * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
836
- * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
837
- * and `resultViewType` must be compatible to each other.
838
- *
839
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
840
- *
841
- * Default value is `...see text or source`.
842
- *
843
- * @since 1.100.0
844
- *
845
- * @returns Value of property `resultViewSettings`
846
- */
847
- getResultViewSettings(): string;
848
- /**
849
- * Gets current value of property {@link #getResultViewType resultViewType}.
850
- *
851
- * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
852
- * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
853
- * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
854
- * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
855
- * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
856
- * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
857
- * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
858
- * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
859
- *
860
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
861
- *
862
- * Default value is `"searchResultList"`.
863
- *
864
- * @since 1.98.0
865
- *
866
- * @returns Value of property `resultViewType`
867
- */
868
- getResultViewType(): string;
869
- /**
870
- * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
871
- *
872
- * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
873
- * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
874
- * not switchable. Case 2: Search in All or other Category: result is switchable between different view
875
- * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
876
- * Search in Business Object: result is switchable between different view types. Possible values for the
877
- * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
878
- * of `resultViewTypes` and `resultViewType` must be compatible to each other.
879
- *
880
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
881
- *
882
- * Default value is `["searchResultList", "searchResultTable"]`.
883
- *
884
- * @since 1.98.0
885
- *
886
- * @returns Value of property `resultViewTypes`
887
- */
888
- getResultViewTypes(): string[];
889
- /**
890
- * Gets current value of property {@link #getSearchOnStart searchOnStart}.
891
- *
892
- * Defines if the search composite control will send a search request directly after loading, using given
893
- * search term, data source and filter root condition settings.
894
- *
895
- * Default value is `true`.
896
- *
897
- * @since 1.93.0
898
- *
899
- * @returns Value of property `searchOnStart`
900
- */
901
- getSearchOnStart(): boolean;
902
- /**
903
- * Gets current value of property {@link #getSearchTerm searchTerm}.
904
- *
905
- * Defines the initial search term for the search input.
906
- *
907
- * Default value is `empty string`.
908
- *
909
- * @since 1.93.0
910
- *
911
- * @returns Value of property `searchTerm`
912
- */
913
- getSearchTerm(): string;
914
- /**
915
- * Gets current value of property {@link #getSearchTermLengthLimit searchTermLengthLimit}.
916
- *
917
- * Limit for length of searchterm.
918
- *
919
- * Default value is `1000`.
920
- *
921
- *
922
- * @returns Value of property `searchTermLengthLimit`
923
- */
924
- getSearchTermLengthLimit(): int;
925
- /**
926
- * Gets current value of property {@link #getSelectionChange selectionChange}.
927
- *
928
- * A callback which is called whenever the selection of result view items changes.
929
- *
930
- * @since 1.113.0
931
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
932
- *
933
- * @returns Value of property `selectionChange`
934
- */
935
- getSelectionChange(): Function;
936
- /**
937
- * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
938
- *
939
- * Configuration for the Enterprise Search Client API.
940
- *
941
- * @since 1.93.0
942
- *
943
- * @returns Value of property `sinaConfiguration`
944
- */
945
- getSinaConfiguration(): object;
946
- /**
947
- * Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}.
948
- *
949
- * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
950
- * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
951
- * in the tabstrips.
952
- *
953
- * @since 1.103.0
954
- *
955
- * @returns Value of property `tabStripsFormatter`
956
- */
957
- getTabStripsFormatter(): Function;
958
- /**
959
- * Gets current value of property {@link #getUpdateUrl updateUrl}.
960
- *
961
- * A boolean indicating that the search state is written to the URL.
962
- *
963
- * Default value is `true`.
964
- *
965
- * @since 1.113.0
966
- *
967
- * @returns Value of property `updateUrl`
968
- */
969
- getUpdateUrl(): boolean;
970
- /**
971
- * Invalidate the search cache. To trigger a search in addition, use function 'retriggerSearch' instead.
972
- *
973
- * @since 1.124.0
974
- */
975
- invalidateSearchResultCache(): Promise<void>;
976
- /**
977
- * Resets the active data source which is selected in the data source drop down list to its default (see
978
- * 'defaultDataSource'/'exclusiveDataSource').
979
- *
980
- * @since 1.124.0
981
- */
982
- resetDataSource(
983
- /**
984
- * If true, fires a search query right away. Set to 'false' for batch updates.
985
- */
986
- fireQuery?: boolean
987
- ): this;
988
- /**
989
- * Resets the UI / search results (reset search query and fire a new search).
990
- *
991
- * @since 1.125.0
992
- */
993
- resetSearch(): Promise<void>;
994
- /**
995
- * Fire a new search (includes invalidation of search cache). To invalidate the search cache w/o triggering
996
- * a new search, use function 'invalidateSearchResultCache' instead.
997
- *
998
- * @since 1.124.0
999
- */
1000
- retriggerSearch(): Promise<void>;
1001
- /**
1002
- * Invalidate the search cache and optionally fire a new search. Also see functions 'retriggerSearch' and
1003
- * 'invalidateSearchResultCache'.
1004
- *
1005
- * @since 1.124.0
1006
- *
1007
- * @returns Returns 'true' if the search query was fired, otherwise 'void'.
1008
- */
1009
- search(
1010
- /**
1011
- * Indicates wether the search query should be resetted. Set to 'true' to reset the query.
1012
- */
1013
- invalidateQuery?: boolean,
1014
- /**
1015
- * Indicates wether the search query should be sent to the search service or not. Set to 'false', to prevent
1016
- * auto-update of search results.
1017
- */
1018
- fireQuery?: boolean
1019
- ): Promise<true | void>;
1020
- /**
1021
- * Sets a new value for property {@link #getApplicationComponent applicationComponent}.
1022
- *
1023
- * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
1024
- *
1025
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1026
- *
1027
- * Default value is `"HAN-AS-INA-UI"`.
1028
- *
1029
- * @since 1.108.0
1030
- *
1031
- * @returns Reference to `this` in order to allow method chaining
1032
- */
1033
- setApplicationComponent(
1034
- /**
1035
- * New value for property `applicationComponent`
1036
- */
1037
- sApplicationComponent?: string
1038
- ): this;
1039
- /**
1040
- * Sets a new value for property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}.
1041
- *
1042
- * In case folder mode is active: Automatically switch result view type to list in search mode and to table
1043
- * in folder mode.
1044
- *
1045
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1046
- *
1047
- * Default value is `false`.
1048
- *
1049
- * @since 1.106.0
1050
- *
1051
- * @returns Reference to `this` in order to allow method chaining
1052
- */
1053
- setAutoAdjustResultViewTypeInFolderMode(
1054
- /**
1055
- * New value for property `autoAdjustResultViewTypeInFolderMode`
1056
- */
1057
- bAutoAdjustResultViewTypeInFolderMode?: boolean
1058
- ): this;
1059
- /**
1060
- * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
1061
- *
1062
- * A boolean for enabling (business) object suggestions.
1063
- *
1064
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1065
- *
1066
- * Default value is `false`.
1067
- *
1068
- * @since 1.113.0
1069
- *
1070
- * @returns Reference to `this` in order to allow method chaining
1071
- */
1072
- setBoSuggestions(
1073
- /**
1074
- * New value for property `boSuggestions`
1075
- */
1076
- bBoSuggestions?: boolean
1077
- ): this;
1078
- /**
1079
- * Sets a new value for property {@link #getCssClass cssClass}.
1080
- *
1081
- * An additional CSS class to add to this control
1082
- *
1083
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1084
- *
1085
- * @since 1.93.0
1086
- *
1087
- * @returns Reference to `this` in order to allow method chaining
1088
- */
1089
- setCssClass(
1090
- /**
1091
- * New value for property `cssClass`
1092
- */
1093
- sCssClass: string
1094
- ): this;
1095
- /**
1096
- * Sets a new value for property {@link #getDataSource dataSource}.
1097
- *
1098
- * The id of the data source in which it will search right after initialization.
1099
- *
1100
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1101
- *
1102
- * @since 1.98.0
1103
- *
1104
- * @returns Reference to `this` in order to allow method chaining
1105
- */
1106
- setDataSource(
1107
- /**
1108
- * New value for property `dataSource`
1109
- */
1110
- sDataSource: string
1111
- ): this;
1112
- /**
1113
- * Sets a new value for property {@link #getDefaultDataSource defaultDataSource}.
1114
- *
1115
- * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
1116
- * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
1117
- * to 'true', do not set this parameter (will be ignored).
1118
- *
1119
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1120
- *
1121
- * @since 1.93.0
1122
- *
1123
- * @returns Reference to `this` in order to allow method chaining
1124
- */
1125
- setDefaultDataSource(
1126
- /**
1127
- * New value for property `defaultDataSource`
1128
- */
1129
- sDefaultDataSource: string
1130
- ): this;
1131
- /**
1132
- * Sets a new value for property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}.
1133
- *
1134
- * When set to true the facet panel is displayed also in case there are no search results.
1135
- *
1136
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1137
- *
1138
- * Default value is `false`.
1139
- *
1140
- * @since 1.113.0
1141
- * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
1142
- * by the end user.
1143
- *
1144
- * @returns Reference to `this` in order to allow method chaining
1145
- */
1146
- setDisplayFacetPanelInCaseOfNoResults(
1147
- /**
1148
- * New value for property `displayFacetPanelInCaseOfNoResults`
1149
- */
1150
- bDisplayFacetPanelInCaseOfNoResults?: boolean
1151
- ): this;
1152
- /**
1153
- * Sets a new value for property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}.
1154
- *
1155
- * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
1156
- * the value is set to 'true'.
1157
- *
1158
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1159
- *
1160
- * Default value is `false`.
1161
- *
1162
- * @since 1.96.0
1163
- *
1164
- * @returns Reference to `this` in order to allow method chaining
1165
- */
1166
- setEnableMultiSelectionResultItems(
1167
- /**
1168
- * New value for property `enableMultiSelectionResultItems`
1169
- */
1170
- bEnableMultiSelectionResultItems?: boolean
1171
- ): this;
1172
- /**
1173
- * Sets a new value for property {@link #getEnableQueryLanguage enableQueryLanguage}.
1174
- *
1175
- * Enables the query language for the hana_odata provider. With query language it is possible for the end
1176
- * user to enter complex search queries with logical operators.
1177
- *
1178
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1179
- *
1180
- * Default value is `false`.
1181
- *
1182
- * @since 1.107.0
1183
- *
1184
- * @returns Reference to `this` in order to allow method chaining
1185
- */
1186
- setEnableQueryLanguage(
1187
- /**
1188
- * New value for property `enableQueryLanguage`
1189
- */
1190
- bEnableQueryLanguage?: boolean
1191
- ): this;
1192
- /**
1193
- * Sets a new value for property {@link #getEventConsumers eventConsumers}.
1194
- *
1195
- * Adds a callback function which is called whenever there is a user or a technical event. A user event
1196
- * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
1197
- * is an event which is triggered by the internal events or events which can also be triggered by API.
1198
- *
1199
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1200
- *
1201
- * @since 1.120
1202
- *
1203
- * @returns Reference to `this` in order to allow method chaining
1204
- */
1205
- setEventConsumers(
1206
- /**
1207
- * New value for property `eventConsumers`
1208
- */
1209
- sEventConsumers: string
1210
- ): this;
1211
- /**
1212
- * Sets a new value for property {@link #getExclusiveDataSource exclusiveDataSource}.
1213
- *
1214
- * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
1215
- * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
1216
- * panel) - data source name/link on result list (header section of item)
1217
- *
1218
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1219
- *
1220
- * @since 1.121.0
1221
- *
1222
- * @returns Reference to `this` in order to allow method chaining
1223
- */
1224
- setExclusiveDataSource(
1225
- /**
1226
- * New value for property `exclusiveDataSource`
1227
- */
1228
- sExclusiveDataSource: string
1229
- ): this;
1230
- /**
1231
- * Sets a new value for property {@link #getFacetPanelResizable facetPanelResizable}.
1232
- *
1233
- * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
1234
- *
1235
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1236
- *
1237
- * Default value is `true`.
1238
- *
1239
- * @since 1.108.0
1240
- *
1241
- * @returns Reference to `this` in order to allow method chaining
1242
- */
1243
- setFacetPanelResizable(
1244
- /**
1245
- * New value for property `facetPanelResizable`
1246
- */
1247
- bFacetPanelResizable?: boolean
1248
- ): this;
1249
- /**
1250
- * Sets a new value for property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}.
1251
- *
1252
- * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
1253
- * is true, the width of the facet panel can be changed by the user.
1254
- *
1255
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1256
- *
1257
- * Default value is `25`.
1258
- *
1259
- * @since 1.108.0
1260
- *
1261
- * @returns Reference to `this` in order to allow method chaining
1262
- */
1263
- setFacetPanelWidthInPercent(
1264
- /**
1265
- * New value for property `facetPanelWidthInPercent`
1266
- */
1267
- fFacetPanelWidthInPercent?: float
1268
- ): this;
1269
- /**
1270
- * Sets a new value for property {@link #getFacets facets}.
1271
- *
1272
- * Controls whether the facet functionality is available or not.
1273
- *
1274
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1275
- *
1276
- * Default value is `true`.
1277
- *
1278
- * @since 1.132.0
1279
- *
1280
- * @returns Reference to `this` in order to allow method chaining
1281
- */
1282
- setFacets(
1283
- /**
1284
- * New value for property `facets`
1285
- */
1286
- bFacets?: boolean
1287
- ): this;
1288
- /**
1289
- * Sets a new value for property {@link #getFacetVisibility facetVisibility}.
1290
- *
1291
- * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
1292
- * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
1293
- * depending on the user's personalization settings.
1294
- *
1295
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1296
- *
1297
- * Default value is `false`.
1298
- *
1299
- * @since 1.113.0
1300
- *
1301
- * @returns Reference to `this` in order to allow method chaining
1302
- */
1303
- setFacetVisibility(
1304
- /**
1305
- * New value for property `facetVisibility`
1306
- */
1307
- bFacetVisibility?: boolean
1308
- ): this;
1309
- /**
1310
- * Sets a new value for property {@link #getFilterDataSources filterDataSources}.
1311
- *
1312
- * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
1313
- * a list of datsources and returns the filtered list of datasources.
1314
- *
1315
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1316
- *
1317
- * @since 1.112.0
1318
- *
1319
- * @returns Reference to `this` in order to allow method chaining
1320
- */
1321
- setFilterDataSources(
1322
- /**
1323
- * New value for property `filterDataSources`
1324
- */
1325
- fnFilterDataSources: Function
1326
- ): this;
1327
- /**
1328
- * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
1329
- *
1330
- * Defines the filter root condition of a filter tree which shall be applied to the search request. This
1331
- * control only allows filter trees which have a the following structure: complex condition (root level)
1332
- * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
1333
- * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
1334
- * for a more in-depth example.
1335
- *
1336
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1337
- *
1338
- * @since 1.98.0
1339
- *
1340
- * @returns Reference to `this` in order to allow method chaining
1341
- */
1342
- setFilterRootCondition(
1343
- /**
1344
- * New value for property `filterRootCondition`
1345
- */
1346
- oFilterRootCondition: object
1347
- ): this;
1348
- /**
1349
- * Sets a new value for property {@link #getFolderMode folderMode}.
1350
- *
1351
- * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
1352
- * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
1353
- * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
1354
- * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
1355
- * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
1356
- * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
1357
- * are set.
1358
- *
1359
- * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
1360
- * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
1361
- * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
1362
- * children of a folder.
1363
- *
1364
- * @since 1.106.0
1365
- *
1366
- * @returns Reference to `this` in order to allow method chaining
1367
- */
1368
- setFolderMode(
1369
- /**
1370
- * New value for property `folderMode`
1371
- */
1372
- bFolderMode?: boolean
1373
- ): this;
1374
- /**
1375
- * Sets a new value for property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}.
1376
- *
1377
- * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
1378
- * is enabled.
1379
- *
1380
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1381
- *
1382
- * Default value is `false`.
1383
- *
1384
- * @since 1.114.0
1385
- *
1386
- * @returns Reference to `this` in order to allow method chaining
1387
- */
1388
- setFolderModeForInitialSearch(
1389
- /**
1390
- * New value for property `folderModeForInitialSearch`
1391
- */
1392
- bFolderModeForInitialSearch?: boolean
1393
- ): this;
1394
- /**
1395
- * Sets a new value for property {@link #getFormatFilterBarText formatFilterBarText}.
1396
- *
1397
- * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
1398
- *
1399
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1400
- *
1401
- * @since 1.120
1402
- *
1403
- * @returns Reference to `this` in order to allow method chaining
1404
- */
1405
- setFormatFilterBarText(
1406
- /**
1407
- * New value for property `formatFilterBarText`
1408
- */
1409
- fnFormatFilterBarText: Function
1410
- ): this;
1411
- /**
1412
- * Sets a new value for property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}.
1413
- *
1414
- * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
1415
- * to be more specific and add some hints, links, buttons or other content.
1416
- *
1417
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1418
- *
1419
- * @since 1.94.0
1420
- *
1421
- * @returns Reference to `this` in order to allow method chaining
1422
- */
1423
- setGetCustomNoResultScreen(
1424
- /**
1425
- * New value for property `getCustomNoResultScreen`
1426
- */
1427
- fnGetCustomNoResultScreen: Function
1428
- ): this;
1429
- /**
1430
- * Sets a new value for property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
1431
- *
1432
- * A callback which returns customized "label" for placeholder text of search box in case there is no search
1433
- * term. The placeholder text (en) will be "Search In: ".
1434
- *
1435
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1436
- *
1437
- *
1438
- * @returns Reference to `this` in order to allow method chaining
1439
- */
1440
- setGetSearchInputPlaceholderLabel(
1441
- /**
1442
- * New value for property `getSearchInputPlaceholderLabel`
1443
- */
1444
- fnGetSearchInputPlaceholderLabel: Function
1445
- ): this;
1446
- /**
1447
- * Sets a new value for property {@link #getInitAsync initAsync}.
1448
- *
1449
- * An asynchronues callback which is called after the initialization of the search composite control.
1450
- *
1451
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1452
- *
1453
- * @since 1.113.0
1454
- *
1455
- * @returns Reference to `this` in order to allow method chaining
1456
- */
1457
- setInitAsync(
1458
- /**
1459
- * New value for property `initAsync`
1460
- */
1461
- fnInitAsync: Function
1462
- ): this;
1463
- /**
1464
- * Sets a new value for property {@link #getIsFilterBarVisible isFilterBarVisible}.
1465
- *
1466
- * Callback for checking whether the filter bar is visible.
1467
- *
1468
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1469
- *
1470
- * @since 1.120
1471
- *
1472
- * @returns Reference to `this` in order to allow method chaining
1473
- */
1474
- setIsFilterBarVisible(
1475
- /**
1476
- * New value for property `isFilterBarVisible`
1477
- */
1478
- fnIsFilterBarVisible: Function
1479
- ): this;
1480
- /**
1481
- * Sets a new value for property {@link #getIsSearchUrl isSearchUrl}.
1482
- *
1483
- * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
1484
- * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
1485
- * of 'updateUrl = true'.
1486
- *
1487
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1488
- *
1489
- * @since 1.113.0
1490
- *
1491
- * @returns Reference to `this` in order to allow method chaining
1492
- */
1493
- setIsSearchUrl(
1494
- /**
1495
- * New value for property `isSearchUrl`
1496
- */
1497
- fnIsSearchUrl: Function
1498
- ): this;
1499
- /**
1500
- * Sets a new value for property {@link #getLimitAjaxRequests limitAjaxRequests}.
1501
- *
1502
- * Prevents too many ajax requests in a short time.
1503
- *
1504
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1505
- *
1506
- * Default value is `true`.
1507
- *
1508
- *
1509
- * @returns Reference to `this` in order to allow method chaining
1510
- */
1511
- setLimitAjaxRequests(
1512
- /**
1513
- * New value for property `limitAjaxRequests`
1514
- */
1515
- bLimitAjaxRequests?: boolean
1516
- ): this;
1517
- /**
1518
- * Sets a new value for property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
1519
- *
1520
- * The layout is optimized for object selection / value help (narrow view w/o facet panel).
1521
- *
1522
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1523
- *
1524
- * @since 1.111.0
1525
- *
1526
- * @returns Reference to `this` in order to allow method chaining
1527
- */
1528
- setOptimizeForValueHelp(
1529
- /**
1530
- * New value for property `optimizeForValueHelp`
1531
- */
1532
- bOptimizeForValueHelp: boolean
1533
- ): this;
1534
- /**
1535
- * Sets a new value for property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}.
1536
- *
1537
- * Shall the window title be overwritten by this control? If true, the control will set the current search
1538
- * condition as window title. If false, it will not set or update the window title.
1539
- *
1540
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1541
- *
1542
- * @since 1.93.0
1543
- *
1544
- * @returns Reference to `this` in order to allow method chaining
1545
- */
1546
- setOverwriteBrowserTitle(
1547
- /**
1548
- * New value for property `overwriteBrowserTitle`
1549
- */
1550
- bOverwriteBrowserTitle: boolean
1551
- ): this;
1552
- /**
1553
- * Sets a new value for property {@link #getPageSize pageSize}.
1554
- *
1555
- * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
1556
- * button, another page of result items of the same count (if available) will be displayed.
1557
- *
1558
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1559
- *
1560
- * Default value is `10`.
1561
- *
1562
- * @since 1.96.0
1563
- *
1564
- * @returns Reference to `this` in order to allow method chaining
1565
- */
1566
- setPageSize(
1567
- /**
1568
- * New value for property `pageSize`
1569
- */
1570
- iPageSize?: int
1571
- ): this;
1572
- /**
1573
- * Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
1574
- *
1575
- * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
1576
- * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
1577
- * is not needed.
1578
- *
1579
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1580
- *
1581
- * @since 1.113.0
1582
- *
1583
- * @returns Reference to `this` in order to allow method chaining
1584
- */
1585
- setParseSearchUrlParameters(
1586
- /**
1587
- * New value for property `parseSearchUrlParameters`
1588
- */
1589
- fnParseSearchUrlParameters: Function
1590
- ): this;
1591
- /**
1592
- * Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}.
1593
- *
1594
- * A list of data sources to be displayed in the facet panel in the section "Collection".
1595
- *
1596
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1597
- *
1598
- * @since 1.113.0
1599
- *
1600
- * @returns Reference to `this` in order to allow method chaining
1601
- */
1602
- setQuickSelectDataSources(
1603
- /**
1604
- * New value for property `quickSelectDataSources`
1605
- */
1606
- oQuickSelectDataSources: object
1607
- ): this;
1608
- /**
1609
- * Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}.
1610
- *
1611
- * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
1612
- * the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
1613
- *
1614
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1615
- *
1616
- * @since 1.113.0
1617
- *
1618
- * @returns Reference to `this` in order to allow method chaining
1619
- */
1620
- setRenderSearchUrl(
1621
- /**
1622
- * New value for property `renderSearchUrl`
1623
- */
1624
- fnRenderSearchUrl: Function
1625
- ): this;
1626
- /**
1627
- * Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
1628
- *
1629
- * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
1630
- * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
1631
- * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
1632
- * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
1633
- * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
1634
- * and `resultViewType` must be compatible to each other.
1635
- *
1636
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1637
- *
1638
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1639
- *
1640
- * Default value is `...see text or source`.
1641
- *
1642
- * @since 1.100.0
1643
- *
1644
- * @returns Reference to `this` in order to allow method chaining
1645
- */
1646
- setResultViewSettings(
1647
- /**
1648
- * New value for property `resultViewSettings`
1649
- */
1650
- sResultViewSettings?: string
1651
- ): this;
1652
- /**
1653
- * Sets a new value for property {@link #getResultViewType resultViewType}.
1654
- *
1655
- * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
1656
- * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
1657
- * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
1658
- * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
1659
- * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
1660
- * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
1661
- * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
1662
- * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
1663
- *
1664
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1665
- *
1666
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1667
- *
1668
- * Default value is `"searchResultList"`.
1669
- *
1670
- * @since 1.98.0
1671
- *
1672
- * @returns Reference to `this` in order to allow method chaining
1673
- */
1674
- setResultViewType(
1675
- /**
1676
- * New value for property `resultViewType`
1677
- */
1678
- sResultViewType?: string
1679
- ): this;
1680
- /**
1681
- * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
1682
- *
1683
- * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
1684
- * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
1685
- * not switchable. Case 2: Search in All or other Category: result is switchable between different view
1686
- * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
1687
- * Search in Business Object: result is switchable between different view types. Possible values for the
1688
- * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
1689
- * of `resultViewTypes` and `resultViewType` must be compatible to each other.
1690
- *
1691
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1692
- *
1693
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1694
- *
1695
- * Default value is `["searchResultList", "searchResultTable"]`.
1696
- *
1697
- * @since 1.98.0
1698
- *
1699
- * @returns Reference to `this` in order to allow method chaining
1700
- */
1701
- setResultViewTypes(
1702
- /**
1703
- * New value for property `resultViewTypes`
1704
- */
1705
- sResultViewTypes?: string[]
1706
- ): this;
1707
- /**
1708
- * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
1709
- *
1710
- * Defines if the search composite control will send a search request directly after loading, using given
1711
- * search term, data source and filter root condition settings.
1712
- *
1713
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1714
- *
1715
- * Default value is `true`.
1716
- *
1717
- * @since 1.93.0
1718
- *
1719
- * @returns Reference to `this` in order to allow method chaining
1720
- */
1721
- setSearchOnStart(
1722
- /**
1723
- * New value for property `searchOnStart`
1724
- */
1725
- bSearchOnStart?: boolean
1726
- ): this;
1727
- /**
1728
- * Sets a new value for property {@link #getSearchTerm searchTerm}.
1729
- *
1730
- * Defines the initial search term for the search input.
1731
- *
1732
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1733
- *
1734
- * Default value is `empty string`.
1735
- *
1736
- * @since 1.93.0
1737
- *
1738
- * @returns Reference to `this` in order to allow method chaining
1739
- */
1740
- setSearchTerm(
1741
- /**
1742
- * New value for property `searchTerm`
1743
- */
1744
- sSearchTerm?: string
1745
- ): this;
1746
- /**
1747
- * Sets a new value for property {@link #getSearchTermLengthLimit searchTermLengthLimit}.
1748
- *
1749
- * Limit for length of searchterm.
1750
- *
1751
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1752
- *
1753
- * Default value is `1000`.
1754
- *
1755
- *
1756
- * @returns Reference to `this` in order to allow method chaining
1757
- */
1758
- setSearchTermLengthLimit(
1759
- /**
1760
- * New value for property `searchTermLengthLimit`
1761
- */
1762
- iSearchTermLengthLimit?: int
1763
- ): this;
1764
- /**
1765
- * Sets a new value for property {@link #getSelectionChange selectionChange}.
1766
- *
1767
- * A callback which is called whenever the selection of result view items changes.
1768
- *
1769
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1770
- *
1771
- * @since 1.113.0
1772
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
1773
- *
1774
- * @returns Reference to `this` in order to allow method chaining
1775
- */
1776
- setSelectionChange(
1777
- /**
1778
- * New value for property `selectionChange`
1779
- */
1780
- fnSelectionChange: Function
1781
- ): this;
1782
- /**
1783
- * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
1784
- *
1785
- * Configuration for the Enterprise Search Client API.
1786
- *
1787
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1788
- *
1789
- * @since 1.93.0
1790
- *
1791
- * @returns Reference to `this` in order to allow method chaining
1792
- */
1793
- setSinaConfiguration(
1794
- /**
1795
- * New value for property `sinaConfiguration`
1796
- */
1797
- oSinaConfiguration: object
1798
- ): this;
1799
- /**
1800
- * Sets a new value for property {@link #getTabStripsFormatter tabStripsFormatter}.
1801
- *
1802
- * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
1803
- * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
1804
- * in the tabstrips.
1805
- *
1806
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1807
- *
1808
- * @since 1.103.0
1809
- *
1810
- * @returns Reference to `this` in order to allow method chaining
1811
- */
1812
- setTabStripsFormatter(
1813
- /**
1814
- * New value for property `tabStripsFormatter`
1815
- */
1816
- fnTabStripsFormatter: Function
1817
- ): this;
1818
- /**
1819
- * Sets a new value for property {@link #getUpdateUrl updateUrl}.
1820
- *
1821
- * A boolean indicating that the search state is written to the URL.
1822
- *
1823
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1824
- *
1825
- * Default value is `true`.
1826
- *
1827
- * @since 1.113.0
1828
- *
1829
- * @returns Reference to `this` in order to allow method chaining
1830
- */
1831
- setUpdateUrl(
1832
- /**
1833
- * New value for property `updateUrl`
1834
- */
1835
- bUpdateUrl?: boolean
1836
- ): this;
1837
- /**
1838
- * Update hierarchy facet Updates the one and only (static) hierarchy facet (tree control on facet panel).
1839
- * If no hierarchy facet exists, nothing will happen.
1840
- *
1841
- * @since 1.126.0
1842
- */
1843
- updateStaticHierarchyFacet(): Promise<void>;
1844
- }
1845
- /**
1846
- * Describes the settings that can be provided to the SearchCompositeControl constructor.
1847
- */
1848
- export interface $SearchCompositeControlSettings extends $ControlSettings {
1849
- /**
1850
- * An additional CSS class to add to this control
1851
- *
1852
- * @since 1.93.0
1853
- */
1854
- cssClass?: string | PropertyBindingInfo;
1855
-
1856
- /**
1857
- * Defines the initial search term for the search input.
1858
- *
1859
- * @since 1.93.0
1860
- */
1861
- searchTerm?: string | PropertyBindingInfo;
1862
-
1863
- /**
1864
- * Defines if the search composite control will send a search request directly after loading, using given
1865
- * search term, data source and filter root condition settings.
1866
- *
1867
- * @since 1.93.0
1868
- */
1869
- searchOnStart?: boolean | PropertyBindingInfo | `{${string}}`;
1870
-
1871
- /**
1872
- * Defines the filter root condition of a filter tree which shall be applied to the search request. This
1873
- * control only allows filter trees which have a the following structure: complex condition (root level)
1874
- * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
1875
- * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
1876
- * for a more in-depth example.
1877
- *
1878
- * @since 1.98.0
1879
- */
1880
- filterRootCondition?: object | PropertyBindingInfo | `{${string}}`;
1881
-
1882
- /**
1883
- * Configuration for the Enterprise Search Client API.
1884
- *
1885
- * @since 1.93.0
1886
- */
1887
- sinaConfiguration?: object | PropertyBindingInfo | `{${string}}`;
1888
-
1889
- /**
1890
- * The id of the data source in which it will search right after initialization.
1891
- *
1892
- * @since 1.98.0
1893
- */
1894
- dataSource?: string | PropertyBindingInfo;
1895
-
1896
- /**
1897
- * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI
1898
- * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet
1899
- * panel) - data source name/link on result list (header section of item)
1900
- *
1901
- * @since 1.121.0
1902
- */
1903
- exclusiveDataSource?: string | PropertyBindingInfo;
1904
-
1905
- /**
1906
- * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
1907
- * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
1908
- * not switchable. Case 2: Search in All or other Category: result is switchable between different view
1909
- * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
1910
- * Search in Business Object: result is switchable between different view types. Possible values for the
1911
- * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
1912
- * of `resultViewTypes` and `resultViewType` must be compatible to each other.
1913
- *
1914
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1915
- *
1916
- * @since 1.98.0
1917
- */
1918
- resultViewTypes?: string[] | PropertyBindingInfo | `{${string}}`;
1919
-
1920
- /**
1921
- * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
1922
- * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
1923
- * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
1924
- * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
1925
- * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
1926
- * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
1927
- * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
1928
- * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
1929
- *
1930
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1931
- *
1932
- * @since 1.98.0
1933
- */
1934
- resultViewType?: string | PropertyBindingInfo;
1935
-
1936
- /**
1937
- * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
1938
- * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
1939
- * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
1940
- * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
1941
- * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
1942
- * and `resultViewType` must be compatible to each other.
1943
- *
1944
- * After the result view type has been changed, the event 'resultViewTypeChanged' is fired.
1945
- *
1946
- * @since 1.100.0
1947
- */
1948
- resultViewSettings?: string | PropertyBindingInfo;
1949
-
1950
- /**
1951
- * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function
1952
- * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed
1953
- * in the tabstrips.
1954
- *
1955
- * @since 1.103.0
1956
- */
1957
- tabStripsFormatter?: Function | PropertyBindingInfo | `{${string}}`;
1958
-
1959
- /**
1960
- * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the
1961
- * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute
1962
- * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the
1963
- * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy.
1964
- * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active
1965
- * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute)
1966
- * are set.
1967
- *
1968
- * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
1969
- * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
1970
- * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
1971
- * children of a folder. * @since 1.106.0
1972
- */
1973
- folderMode?: boolean | PropertyBindingInfo | `{${string}}`;
1974
-
1975
- /**
1976
- * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode
1977
- * is enabled.
1978
- *
1979
- * @since 1.114.0
1980
- */
1981
- folderModeForInitialSearch?: boolean | PropertyBindingInfo | `{${string}}`;
1982
-
1983
- /**
1984
- * In case folder mode is active: Automatically switch result view type to list in search mode and to table
1985
- * in folder mode.
1986
- *
1987
- * @since 1.106.0
1988
- */
1989
- autoAdjustResultViewTypeInFolderMode?:
1990
- | boolean
1991
- | PropertyBindingInfo
1992
- | `{${string}}`;
1993
-
1994
- /**
1995
- * Enables the query language for the hana_odata provider. With query language it is possible for the end
1996
- * user to enter complex search queries with logical operators.
1997
- *
1998
- * @since 1.107.0
1999
- */
2000
- enableQueryLanguage?: boolean | PropertyBindingInfo | `{${string}}`;
2001
-
2002
- /**
2003
- * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents.
2004
- *
2005
- * @since 1.108.0
2006
- */
2007
- applicationComponent?: string | PropertyBindingInfo;
2008
-
2009
- /**
2010
- * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria.
2011
- *
2012
- * @since 1.108.0
2013
- */
2014
- facetPanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
2015
-
2016
- /**
2017
- * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable"
2018
- * is true, the width of the facet panel can be changed by the user.
2019
- *
2020
- * @since 1.108.0
2021
- */
2022
- facetPanelWidthInPercent?: float | PropertyBindingInfo | `{${string}}`;
2023
-
2024
- /**
2025
- * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control
2026
- * to be more specific and add some hints, links, buttons or other content.
2027
- *
2028
- * @since 1.94.0
2029
- */
2030
- getCustomNoResultScreen?: Function | PropertyBindingInfo | `{${string}}`;
2031
-
2032
- /**
2033
- * A callback which returns customized "label" for placeholder text of search box in case there is no search
2034
- * term. The placeholder text (en) will be "Search In: ".
2035
- */
2036
- getSearchInputPlaceholderLabel?:
2037
- | Function
2038
- | PropertyBindingInfo
2039
- | `{${string}}`;
2040
-
2041
- /**
2042
- * Shall the window title be overwritten by this control? If true, the control will set the current search
2043
- * condition as window title. If false, it will not set or update the window title.
2044
- *
2045
- * @since 1.93.0
2046
- */
2047
- overwriteBrowserTitle?: boolean | PropertyBindingInfo | `{${string}}`;
2048
-
2049
- /**
2050
- * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource
2051
- * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource'
2052
- * to 'true', do not set this parameter (will be ignored).
2053
- *
2054
- * @since 1.93.0
2055
- */
2056
- defaultDataSource?: string | PropertyBindingInfo;
2057
-
2058
- /**
2059
- * The layout is optimized for object selection / value help (narrow view w/o facet panel).
2060
- *
2061
- * @since 1.111.0
2062
- */
2063
- optimizeForValueHelp?: boolean | PropertyBindingInfo | `{${string}}`;
2064
-
2065
- /**
2066
- * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets
2067
- * a list of datsources and returns the filtered list of datasources.
2068
- *
2069
- * @since 1.112.0
2070
- */
2071
- filterDataSources?: Function | PropertyBindingInfo | `{${string}}`;
2072
-
2073
- /**
2074
- * Controls whether the facet functionality is available or not.
2075
- *
2076
- * @since 1.132.0
2077
- */
2078
- facets?: boolean | PropertyBindingInfo | `{${string}}`;
2079
-
2080
- /**
2081
- * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
2082
- * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
2083
- * depending on the user's personalization settings.
2084
- *
2085
- * @since 1.113.0
2086
- */
2087
- facetVisibility?: boolean | PropertyBindingInfo | `{${string}}`;
2088
-
2089
- /**
2090
- * A boolean for enabling (business) object suggestions.
2091
- *
2092
- * @since 1.113.0
2093
- */
2094
- boSuggestions?: boolean | PropertyBindingInfo | `{${string}}`;
2095
-
2096
- /**
2097
- * When set to true the facet panel is displayed also in case there are no search results.
2098
- *
2099
- * @since 1.113.0
2100
- * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
2101
- * by the end user.
2102
- */
2103
- displayFacetPanelInCaseOfNoResults?:
2104
- | boolean
2105
- | PropertyBindingInfo
2106
- | `{${string}}`;
2107
-
2108
- /**
2109
- * A boolean indicating that the search state is written to the URL.
2110
- *
2111
- * @since 1.113.0
2112
- */
2113
- updateUrl?: boolean | PropertyBindingInfo | `{${string}}`;
2114
-
2115
- /**
2116
- * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns
2117
- * the URL string. Typically you need to register this callback in case of 'updateUrl = true'.
2118
- *
2119
- * @since 1.113.0
2120
- */
2121
- renderSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
2122
-
2123
- /**
2124
- * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns
2125
- * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case
2126
- * of 'updateUrl = true'.
2127
- *
2128
- * @since 1.113.0
2129
- */
2130
- isSearchUrl?: Function | PropertyBindingInfo | `{${string}}`;
2131
-
2132
- /**
2133
- * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL
2134
- * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback
2135
- * is not needed.
2136
- *
2137
- * @since 1.113.0
2138
- */
2139
- parseSearchUrlParameters?: Function | PropertyBindingInfo | `{${string}}`;
2140
-
2141
- /**
2142
- * A list of data sources to be displayed in the facet panel in the section "Collection".
2143
- *
2144
- * @since 1.113.0
2145
- */
2146
- quickSelectDataSources?: object | PropertyBindingInfo | `{${string}}`;
2147
-
2148
- /**
2149
- * A callback which is called whenever the selection of result view items changes.
2150
- *
2151
- * @since 1.113.0
2152
- * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
2153
- */
2154
- selectionChange?: Function | PropertyBindingInfo | `{${string}}`;
2155
-
2156
- /**
2157
- * An asynchronues callback which is called after the initialization of the search composite control.
2158
- *
2159
- * @since 1.113.0
2160
- */
2161
- initAsync?: Function | PropertyBindingInfo | `{${string}}`;
2162
-
2163
- /**
2164
- * Enables the multiselection mode of search result items. A checkbox is provided for each result item if
2165
- * the value is set to 'true'.
2166
- *
2167
- * @since 1.96.0
2168
- */
2169
- enableMultiSelectionResultItems?:
2170
- | boolean
2171
- | PropertyBindingInfo
2172
- | `{${string}}`;
2173
-
2174
- /**
2175
- * The maximum count of search result items displayed on a page after a search. By clicking 'Show More'
2176
- * button, another page of result items of the same count (if available) will be displayed.
2177
- *
2178
- * @since 1.96.0
2179
- */
2180
- pageSize?: int | PropertyBindingInfo | `{${string}}`;
2181
-
2182
- /**
2183
- * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel).
2184
- *
2185
- * @since 1.120
2186
- */
2187
- formatFilterBarText?: Function | PropertyBindingInfo | `{${string}}`;
2188
-
2189
- /**
2190
- * Callback for checking whether the filter bar is visible.
2191
- *
2192
- * @since 1.120
2193
- */
2194
- isFilterBarVisible?: Function | PropertyBindingInfo | `{${string}}`;
2195
-
2196
- /**
2197
- * Adds a callback function which is called whenever there is a user or a technical event. A user event
2198
- * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
2199
- * is an event which is triggered by the internal events or events which can also be triggered by API.
2200
- *
2201
- * @since 1.120
2202
- */
2203
- eventConsumers?: string | PropertyBindingInfo;
2204
-
2205
- /**
2206
- * Limit for length of searchterm.
2207
- */
2208
- searchTermLengthLimit?: int | PropertyBindingInfo | `{${string}}`;
2209
-
2210
- /**
2211
- * Prevents too many ajax requests in a short time.
2212
- */
2213
- limitAjaxRequests?: boolean | PropertyBindingInfo | `{${string}}`;
2214
-
2215
- /**
2216
- * Event is fired when search is started.
2217
- *
2218
- * @since 1.121
2219
- */
2220
- searchStarted?: (oEvent: Event) => void;
2221
-
2222
- /**
2223
- * Event is fired when search is finished.
2224
- *
2225
- * @since 1.121
2226
- */
2227
- searchFinished?: (oEvent: Event) => void;
2228
-
2229
- /**
2230
- * Event is fired when selection on result view (list, table or grid) has changed.
2231
- *
2232
- * @since 1.121
2233
- */
2234
- selectionChanged?: (oEvent: Event) => void;
2235
-
2236
- /**
2237
- * Event is fired after result view type got changed (list, table or grid).
2238
- *
2239
- * @since 1.124
2240
- */
2241
- resultViewTypeChanged?: (oEvent: Event) => void;
2242
- }
2243
-
2244
- /**
2245
- * Parameters of the SearchCompositeControl#resultViewTypeChanged event.
2246
- */
2247
- export interface SearchCompositeControl$ResultViewTypeChangedEventParameters {}
2248
-
2249
- /**
2250
- * Event object of the SearchCompositeControl#resultViewTypeChanged event.
2251
- */
2252
- export type SearchCompositeControl$ResultViewTypeChangedEvent = Event<
2253
- SearchCompositeControl$ResultViewTypeChangedEventParameters,
2254
- SearchCompositeControl
2255
- >;
2256
-
2257
- /**
2258
- * Parameters of the SearchCompositeControl#searchFinished event.
2259
- */
2260
- export interface SearchCompositeControl$SearchFinishedEventParameters {}
2261
-
2262
- /**
2263
- * Event object of the SearchCompositeControl#searchFinished event.
2264
- */
2265
- export type SearchCompositeControl$SearchFinishedEvent = Event<
2266
- SearchCompositeControl$SearchFinishedEventParameters,
2267
- SearchCompositeControl
2268
- >;
2269
-
2270
- /**
2271
- * Parameters of the SearchCompositeControl#searchStarted event.
2272
- */
2273
- export interface SearchCompositeControl$SearchStartedEventParameters {}
2274
-
2275
- /**
2276
- * Event object of the SearchCompositeControl#searchStarted event.
2277
- */
2278
- export type SearchCompositeControl$SearchStartedEvent = Event<
2279
- SearchCompositeControl$SearchStartedEventParameters,
2280
- SearchCompositeControl
2281
- >;
2282
-
2283
- /**
2284
- * Parameters of the SearchCompositeControl#selectionChanged event.
2285
- */
2286
- export interface SearchCompositeControl$SelectionChangedEventParameters {}
2287
-
2288
- /**
2289
- * Event object of the SearchCompositeControl#selectionChanged event.
2290
- */
2291
- export type SearchCompositeControl$SelectionChangedEvent = Event<
2292
- SearchCompositeControl$SelectionChangedEventParameters,
2293
- SearchCompositeControl
2294
- >;
2295
- }
1
+ // For Library Version: 1.140.1
2296
2
 
2297
3
  declare module "sap/esh/search/ui/library" {}
2298
4
 
2299
5
  declare namespace sap {
2300
6
  interface IUI5DefineDependencyNames {
2301
7
  "sap/esh/search/ui/library": undefined;
2302
-
2303
- "sap/esh/search/ui/SearchCompositeControl": undefined;
2304
8
  }
2305
9
  }