@sapui5/ts-types 1.100.0 → 1.101.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 (61) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +2 -2
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +674 -2
  8. package/types/sap.f.d.ts +236 -25
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +8 -63
  11. package/types/sap.fe.macros.d.ts +17 -9
  12. package/types/sap.fe.navigation.d.ts +5 -71
  13. package/types/sap.fe.templates.d.ts +97 -190
  14. package/types/sap.fe.test.d.ts +43 -24
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +40 -15
  17. package/types/sap.landvisz.d.ts +1 -1
  18. package/types/sap.m.d.ts +209 -38
  19. package/types/sap.makit.d.ts +1 -1
  20. package/types/sap.me.d.ts +1 -1
  21. package/types/sap.ndc.d.ts +1 -1
  22. package/types/sap.ovp.d.ts +1 -1
  23. package/types/sap.rules.ui.d.ts +40 -5
  24. package/types/sap.sac.df.d.ts +981 -0
  25. package/types/sap.sac.grid.d.ts +25 -1
  26. package/types/sap.suite.ui.commons.d.ts +18 -1
  27. package/types/sap.suite.ui.generic.template.d.ts +115 -8
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +1 -1
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +1 -1
  32. package/types/sap.ui.comp.d.ts +154 -15
  33. package/types/sap.ui.core.d.ts +73 -27
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +3 -3
  36. package/types/sap.ui.fl.d.ts +1 -1
  37. package/types/sap.ui.generic.app.d.ts +10 -10
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +1 -1
  40. package/types/sap.ui.layout.d.ts +1 -1
  41. package/types/sap.ui.mdc.d.ts +9 -1
  42. package/types/sap.ui.richtexteditor.d.ts +1 -1
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +10 -6
  46. package/types/sap.ui.table.d.ts +11 -34
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +1 -1
  49. package/types/sap.ui.ux3.d.ts +1 -1
  50. package/types/sap.ui.vbm.d.ts +1 -1
  51. package/types/sap.ui.vk.d.ts +683 -26
  52. package/types/sap.ui.vtm.d.ts +1 -1
  53. package/types/sap.uiext.inbox.d.ts +1 -1
  54. package/types/sap.ushell.d.ts +549 -113
  55. package/types/sap.ushell_abap.d.ts +1 -1
  56. package/types/sap.uxap.d.ts +2 -2
  57. package/types/sap.viz.d.ts +1 -1
  58. package/types/sap.webanalytics.core.d.ts +1 -1
  59. package/types/sap.zen.commons.d.ts +1 -1585
  60. package/types/sap.zen.crosstab.d.ts +1 -1
  61. package/types/sap.zen.dsh.d.ts +1303 -4047
@@ -1,3 +1,675 @@
1
- // For Library Version: 1.100.0
1
+ // For Library Version: 1.101.0
2
2
 
3
- declare namespace sap {}
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 control will search for the given term right on control instantiation.
30
+ */
31
+ searchOnStart?:
32
+ | boolean
33
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
34
+
35
+ /**
36
+ * @SINCE 1.98.0
37
+ *
38
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
39
+ * control only allows filter trees which have a the following structure: complex condition (root level)
40
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
41
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
42
+ * for a more in-depth example.
43
+ */
44
+ filterRootCondition?:
45
+ | object
46
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
47
+
48
+ /**
49
+ * @SINCE 1.93.0
50
+ *
51
+ * Configuration for the Enterprise Search Client API.
52
+ */
53
+ sinaConfiguration?:
54
+ | object
55
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
56
+
57
+ /**
58
+ * @SINCE 1.98.0
59
+ *
60
+ * The id of the data source in which it will search right after initialization.
61
+ */
62
+ dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
63
+
64
+ /**
65
+ * @SINCE 1.98.0
66
+ *
67
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
68
+ * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
69
+ * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
70
+ * switchable between different view types. Possible values for the array items are `"searchResultList"`
71
+ * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
72
+ * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
73
+ * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
74
+ * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
75
+ * must be compatible to each other.
76
+ */
77
+ resultViewTypes?:
78
+ | string[]
79
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
80
+
81
+ /**
82
+ * @SINCE 1.98.0
83
+ *
84
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
85
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
86
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
87
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
88
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
89
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
90
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
91
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
92
+ */
93
+ resultViewType?:
94
+ | string
95
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
96
+
97
+ /**
98
+ * @SINCE 1.100.0
99
+ *
100
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
101
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
102
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
103
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
104
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
105
+ * and `resultViewType` must be compatible to each other.
106
+ */
107
+ resultViewSettings?:
108
+ | string
109
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
110
+
111
+ /**
112
+ * Control instances which are part of this composite control.
113
+ */
114
+ content?:
115
+ | sap.ui.core.Control[]
116
+ | sap.ui.core.Control
117
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
118
+
119
+ /**
120
+ * Event is fired when search is started.
121
+ */
122
+ searchStarted?: (oEvent: sap.ui.base.Event) => void;
123
+
124
+ /**
125
+ * Event is fired when search is finished.
126
+ */
127
+ searchFinished?: (oEvent: sap.ui.base.Event) => void;
128
+ }
129
+
130
+ /**
131
+ * @SINCE 1.93.0
132
+ *
133
+ * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
134
+ * Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
135
+ * a suggestion dropdown, a result list which can have different styles including tiles and table, result
136
+ * facets and more. This control is ready to use with an enterprise search backend service but also allows
137
+ * deep modifications to match requirements of adopting applications.
138
+ */
139
+ class SearchCompositeControl extends sap.ui.core.Control {
140
+ /**
141
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
142
+ *
143
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
144
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
145
+ * of the syntax of the settings object.
146
+ * See:
147
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
148
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
149
+ */
150
+ constructor(
151
+ /**
152
+ * Initial settings for the new control
153
+ */
154
+ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
155
+ );
156
+ /**
157
+ * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services.
158
+ *
159
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
160
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
161
+ * of the syntax of the settings object.
162
+ * See:
163
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
164
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
165
+ */
166
+ constructor(
167
+ /**
168
+ * ID for the new control, generated automatically if no ID is given
169
+ */
170
+ sId?: string,
171
+ /**
172
+ * Initial settings for the new control
173
+ */
174
+ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
175
+ );
176
+
177
+ /**
178
+ * Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches
179
+ * it with the information contained in `oClassInfo`.
180
+ *
181
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
182
+ */
183
+ static extend<T extends Record<string, unknown>>(
184
+ /**
185
+ * Name of the class being created
186
+ */
187
+ sClassName: string,
188
+ /**
189
+ * Object literal with information about the class
190
+ */
191
+ oClassInfo?: sap.ClassInfo<
192
+ T,
193
+ sap.esh.search.ui.SearchCompositeControl
194
+ >,
195
+ /**
196
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
197
+ * used by this class
198
+ */
199
+ FNMetaImpl?: Function
200
+ ): Function;
201
+ /**
202
+ * Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl.
203
+ */
204
+ static getMetadata(): sap.ui.core.ElementMetadata;
205
+ /**
206
+ * Adds some content to the aggregation {@link #getContent content}.
207
+ */
208
+ addContent(
209
+ /**
210
+ * The content to add; if empty, nothing is inserted
211
+ */
212
+ oContent: sap.ui.core.Control
213
+ ): this;
214
+ /**
215
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
216
+ * `sap.esh.search.ui.SearchCompositeControl`.
217
+ *
218
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
219
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
220
+ *
221
+ * Event is fired when search is finished.
222
+ */
223
+ attachSearchFinished(
224
+ /**
225
+ * An application-specific payload object that will be passed to the event handler along with the event
226
+ * object when firing the event
227
+ */
228
+ oData: object,
229
+ /**
230
+ * The function to be called when the event occurs
231
+ */
232
+ fnFunction: (p1: sap.ui.base.Event) => void,
233
+ /**
234
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
235
+ * itself
236
+ */
237
+ oListener?: object
238
+ ): this;
239
+ /**
240
+ * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this
241
+ * `sap.esh.search.ui.SearchCompositeControl`.
242
+ *
243
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
244
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
245
+ *
246
+ * Event is fired when search is finished.
247
+ */
248
+ attachSearchFinished(
249
+ /**
250
+ * The function to be called when the event occurs
251
+ */
252
+ fnFunction: (p1: sap.ui.base.Event) => void,
253
+ /**
254
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
255
+ * itself
256
+ */
257
+ oListener?: object
258
+ ): this;
259
+ /**
260
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
261
+ *
262
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
263
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
264
+ *
265
+ * Event is fired when search is started.
266
+ */
267
+ attachSearchStarted(
268
+ /**
269
+ * An application-specific payload object that will be passed to the event handler along with the event
270
+ * object when firing the event
271
+ */
272
+ oData: object,
273
+ /**
274
+ * The function to be called when the event occurs
275
+ */
276
+ fnFunction: (p1: sap.ui.base.Event) => void,
277
+ /**
278
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
279
+ * itself
280
+ */
281
+ oListener?: object
282
+ ): this;
283
+ /**
284
+ * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`.
285
+ *
286
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
287
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
288
+ *
289
+ * Event is fired when search is started.
290
+ */
291
+ attachSearchStarted(
292
+ /**
293
+ * The function to be called when the event occurs
294
+ */
295
+ fnFunction: (p1: sap.ui.base.Event) => void,
296
+ /**
297
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
298
+ * itself
299
+ */
300
+ oListener?: object
301
+ ): this;
302
+ /**
303
+ * Destroys all the content in the aggregation {@link #getContent content}.
304
+ */
305
+ destroyContent(): this;
306
+ /**
307
+ * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this
308
+ * `sap.esh.search.ui.SearchCompositeControl`.
309
+ *
310
+ * The passed function and listener object must match the ones used for event registration.
311
+ */
312
+ detachSearchFinished(
313
+ /**
314
+ * The function to be called, when the event occurs
315
+ */
316
+ fnFunction: (p1: sap.ui.base.Event) => void,
317
+ /**
318
+ * Context object on which the given function had to be called
319
+ */
320
+ oListener?: object
321
+ ): this;
322
+ /**
323
+ * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this
324
+ * `sap.esh.search.ui.SearchCompositeControl`.
325
+ *
326
+ * The passed function and listener object must match the ones used for event registration.
327
+ */
328
+ detachSearchStarted(
329
+ /**
330
+ * The function to be called, when the event occurs
331
+ */
332
+ fnFunction: (p1: sap.ui.base.Event) => void,
333
+ /**
334
+ * Context object on which the given function had to be called
335
+ */
336
+ oListener?: object
337
+ ): this;
338
+ /**
339
+ * Fires event {@link #event:searchFinished searchFinished} to attached listeners.
340
+ */
341
+ fireSearchFinished(
342
+ /**
343
+ * Parameters to pass along with the event
344
+ */
345
+ mParameters?: object
346
+ ): this;
347
+ /**
348
+ * Fires event {@link #event:searchStarted searchStarted} to attached listeners.
349
+ */
350
+ fireSearchStarted(
351
+ /**
352
+ * Parameters to pass along with the event
353
+ */
354
+ mParameters?: object
355
+ ): this;
356
+ /**
357
+ * Gets content of aggregation {@link #getContent content}.
358
+ *
359
+ * Control instances which are part of this composite control.
360
+ */
361
+ getContent(): sap.ui.core.Control[];
362
+ /**
363
+ * @SINCE 1.93.0
364
+ *
365
+ * Gets current value of property {@link #getCssClass cssClass}.
366
+ *
367
+ * An additional CSS class to add to this control
368
+ */
369
+ getCssClass(): string;
370
+ /**
371
+ * @SINCE 1.98.0
372
+ *
373
+ * Gets current value of property {@link #getDataSource dataSource}.
374
+ *
375
+ * The id of the data source in which it will search right after initialization.
376
+ */
377
+ getDataSource(): string;
378
+ /**
379
+ * @SINCE 1.98.0
380
+ *
381
+ * Gets current value of property {@link #getFilterRootCondition filterRootCondition}.
382
+ *
383
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
384
+ * control only allows filter trees which have a the following structure: complex condition (root level)
385
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
386
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
387
+ * for a more in-depth example.
388
+ */
389
+ getFilterRootCondition(): object;
390
+ /**
391
+ * @SINCE 1.100.0
392
+ *
393
+ * Gets current value of property {@link #getResultViewSettings resultViewSettings}.
394
+ *
395
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
396
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
397
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
398
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
399
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
400
+ * and `resultViewType` must be compatible to each other.
401
+ */
402
+ getResultViewSettings(): string;
403
+ /**
404
+ * @SINCE 1.98.0
405
+ *
406
+ * Gets current value of property {@link #getResultViewType resultViewType}.
407
+ *
408
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
409
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
410
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
411
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
412
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
413
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
414
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
415
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
416
+ */
417
+ getResultViewType(): string;
418
+ /**
419
+ * @SINCE 1.98.0
420
+ *
421
+ * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
422
+ *
423
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
424
+ * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
425
+ * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
426
+ * switchable between different view types. Possible values for the array items are `"searchResultList"`
427
+ * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
428
+ * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
429
+ * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
430
+ * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
431
+ * must be compatible to each other.
432
+ */
433
+ getResultViewTypes(): string[];
434
+ /**
435
+ * @SINCE 1.93.0
436
+ *
437
+ * Gets current value of property {@link #getSearchOnStart searchOnStart}.
438
+ *
439
+ * Defines if the search control will search for the given term right on control instantiation.
440
+ *
441
+ * Default value is `true`.
442
+ */
443
+ getSearchOnStart(): boolean;
444
+ /**
445
+ * @SINCE 1.93.0
446
+ *
447
+ * Gets current value of property {@link #getSearchTerm searchTerm}.
448
+ *
449
+ * Defines the initial search term for the search input.
450
+ *
451
+ * Default value is `empty string`.
452
+ */
453
+ getSearchTerm(): string;
454
+ /**
455
+ * @SINCE 1.93.0
456
+ *
457
+ * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}.
458
+ *
459
+ * Configuration for the Enterprise Search Client API.
460
+ */
461
+ getSinaConfiguration(): object;
462
+ /**
463
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
464
+ * its index if found or -1 otherwise.
465
+ */
466
+ indexOfContent(
467
+ /**
468
+ * The content whose index is looked for
469
+ */
470
+ oContent: sap.ui.core.Control
471
+ ): int;
472
+ /**
473
+ * Inserts a content into the aggregation {@link #getContent content}.
474
+ */
475
+ insertContent(
476
+ /**
477
+ * The content to insert; if empty, nothing is inserted
478
+ */
479
+ oContent: sap.ui.core.Control,
480
+ /**
481
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
482
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
483
+ * is inserted at the last position
484
+ */
485
+ iIndex: int
486
+ ): this;
487
+ /**
488
+ * Removes all the controls from the aggregation {@link #getContent content}.
489
+ *
490
+ * Additionally, it unregisters them from the hosting UIArea.
491
+ */
492
+ removeAllContent(): sap.ui.core.Control[];
493
+ /**
494
+ * Removes a content from the aggregation {@link #getContent content}.
495
+ */
496
+ removeContent(
497
+ /**
498
+ * The content to remove or its index or id
499
+ */
500
+ vContent: int | string | sap.ui.core.Control
501
+ ): sap.ui.core.Control;
502
+ /**
503
+ * @SINCE 1.93.0
504
+ *
505
+ * Sets a new value for property {@link #getCssClass cssClass}.
506
+ *
507
+ * An additional CSS class to add to this control
508
+ *
509
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
510
+ */
511
+ setCssClass(
512
+ /**
513
+ * New value for property `cssClass`
514
+ */
515
+ sCssClass: string
516
+ ): this;
517
+ /**
518
+ * @SINCE 1.98.0
519
+ *
520
+ * Sets a new value for property {@link #getDataSource dataSource}.
521
+ *
522
+ * The id of the data source in which it will search right after initialization.
523
+ *
524
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
525
+ */
526
+ setDataSource(
527
+ /**
528
+ * New value for property `dataSource`
529
+ */
530
+ sDataSource: string
531
+ ): this;
532
+ /**
533
+ * @SINCE 1.98.0
534
+ *
535
+ * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}.
536
+ *
537
+ * Defines the filter root condition of a filter tree which shall be applied to the search request. This
538
+ * control only allows filter trees which have a the following structure: complex condition (root level)
539
+ * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions
540
+ * which do not follow this structure won't be accepted and an error will be thrown. Please see the below
541
+ * for a more in-depth example.
542
+ *
543
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
544
+ */
545
+ setFilterRootCondition(
546
+ /**
547
+ * New value for property `filterRootCondition`
548
+ */
549
+ oFilterRootCondition: object
550
+ ): this;
551
+ /**
552
+ * @SINCE 1.100.0
553
+ *
554
+ * Sets a new value for property {@link #getResultViewSettings resultViewSettings}.
555
+ *
556
+ * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes`
557
+ * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType:
558
+ * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get
559
+ * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential
560
+ * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes`
561
+ * and `resultViewType` must be compatible to each other.
562
+ *
563
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
564
+ */
565
+ setResultViewSettings(
566
+ /**
567
+ * New value for property `resultViewSettings`
568
+ */
569
+ sResultViewSettings: string
570
+ ): this;
571
+ /**
572
+ * @SINCE 1.98.0
573
+ *
574
+ * Sets a new value for property {@link #getResultViewType resultViewType}.
575
+ *
576
+ * Defines active search result view type. The value can be set/get in attach event "searchFinished", and
577
+ * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view
578
+ * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true):
579
+ * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`.
580
+ * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a
581
+ * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between
582
+ * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`.
583
+ * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other.
584
+ *
585
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
586
+ */
587
+ setResultViewType(
588
+ /**
589
+ * New value for property `resultViewType`
590
+ */
591
+ sResultViewType: string
592
+ ): this;
593
+ /**
594
+ * @SINCE 1.98.0
595
+ *
596
+ * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
597
+ *
598
+ * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
599
+ * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
600
+ * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
601
+ * switchable between different view types. Possible values for the array items are `"searchResultList"`
602
+ * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
603
+ * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
604
+ * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
605
+ * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
606
+ * must be compatible to each other.
607
+ *
608
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
609
+ */
610
+ setResultViewTypes(
611
+ /**
612
+ * New value for property `resultViewTypes`
613
+ */
614
+ sResultViewTypes: string[]
615
+ ): this;
616
+ /**
617
+ * @SINCE 1.93.0
618
+ *
619
+ * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
620
+ *
621
+ * Defines if the search control will search for the given term right on control instantiation.
622
+ *
623
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
624
+ *
625
+ * Default value is `true`.
626
+ */
627
+ setSearchOnStart(
628
+ /**
629
+ * New value for property `searchOnStart`
630
+ */
631
+ bSearchOnStart?: boolean
632
+ ): this;
633
+ /**
634
+ * @SINCE 1.93.0
635
+ *
636
+ * Sets a new value for property {@link #getSearchTerm searchTerm}.
637
+ *
638
+ * Defines the initial search term for the search input.
639
+ *
640
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
641
+ *
642
+ * Default value is `empty string`.
643
+ */
644
+ setSearchTerm(
645
+ /**
646
+ * New value for property `searchTerm`
647
+ */
648
+ sSearchTerm?: string
649
+ ): this;
650
+ /**
651
+ * @SINCE 1.93.0
652
+ *
653
+ * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}.
654
+ *
655
+ * Configuration for the Enterprise Search Client API.
656
+ *
657
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
658
+ */
659
+ setSinaConfiguration(
660
+ /**
661
+ * New value for property `sinaConfiguration`
662
+ */
663
+ oSinaConfiguration: object
664
+ ): this;
665
+ }
666
+ }
667
+ }
668
+ }
669
+
670
+ interface IUI5DefineDependencyNames {
671
+ "sap/esh/search/ui/library": undefined;
672
+
673
+ "sap/esh/search/ui/SearchCompositeControl": undefined;
674
+ }
675
+ }