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