@sapui5/types 1.120.9 → 1.121.1

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