@sapui5/ts-types-esm 1.143.2 → 1.144.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +7 -7
  3. package/types/sap.apf.d.ts +3 -1
  4. package/types/sap.ca.ui.d.ts +8 -1
  5. package/types/sap.chart.d.ts +4 -4
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +846 -285
  8. package/types/sap.f.d.ts +4 -4
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +33 -6
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +3591 -3495
  15. package/types/sap.fe.navigation.d.ts +7 -7
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +18 -12
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +282 -10
  23. package/types/sap.insights.d.ts +1 -47
  24. package/types/{mobile-1.143.0-esm-d.ts → sap.m.d.ts} +298 -68
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +49 -21
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +1 -1
  31. package/types/sap.suite.ui.commons.d.ts +732 -6
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/{tnt-1.143.0-esm-d.ts → sap.tnt.d.ts} +5 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/{commons-1.143.0-esm-d.ts → sap.ui.commons.d.ts} +3469 -306
  37. package/types/sap.ui.comp.d.ts +3 -3
  38. package/types/{core-1.143.0-esm-d.ts → sap.ui.core.d.ts} +621 -166
  39. package/types/{dt-1.143.0-esm-d.ts → sap.ui.dt.d.ts} +1 -1
  40. package/types/sap.ui.export.d.ts +4 -4
  41. package/types/sap.ui.fl.d.ts +5 -5
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.geomap.d.ts +1 -1
  45. package/types/sap.ui.integration.d.ts +1 -1
  46. package/types/sap.ui.layout.d.ts +18 -18
  47. package/types/{mdc-1.143.0-esm-d.ts → sap.ui.mdc.d.ts} +105 -67
  48. package/types/sap.ui.richtexteditor.d.ts +3 -3
  49. package/types/sap.ui.rta.d.ts +1 -1
  50. package/types/sap.ui.suite.d.ts +3 -1
  51. package/types/sap.ui.support.d.ts +1 -1
  52. package/types/sap.ui.table.d.ts +1 -1
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +126 -4
  55. package/types/{ux3-1.143.0-esm-d.ts → sap.ui.ux3.d.ts} +1 -1
  56. package/types/sap.ui.vbm.d.ts +1 -1
  57. package/types/sap.ui.vk.d.ts +139 -4
  58. package/types/sap.ui.vtm.d.ts +100 -1
  59. package/types/sap.ui.webc.common.d.ts +3 -1
  60. package/types/sap.ui.webc.fiori.d.ts +31 -1
  61. package/types/sap.ui.webc.main.d.ts +70 -1
  62. package/types/sap.uiext.inbox.d.ts +1 -1
  63. package/types/sap.ushell.d.ts +15 -1
  64. package/types/sap.ushell_abap.d.ts +1 -1
  65. package/types/sap.uxap.d.ts +1 -1
  66. package/types/sap.viz.d.ts +1 -1
  67. package/types/sap.webanalytics.core.d.ts +1 -1
  68. package/types/sap.zen.commons.d.ts +1 -1
  69. package/types/sap.zen.crosstab.d.ts +1 -1
  70. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,30 +1,394 @@
1
- // For Library Version: 1.143.2
1
+ // For Library Version: 1.144.1
2
2
 
3
- declare module "sap/esh/search/ui/SearchCompositeControl" {
3
+ declare module "sap/esh/search/ui/library" {}
4
+
5
+ declare module "sap/esh/search/ui/controls/basket/CustomBasket" {
4
6
  import {
5
7
  default as VerticalLayout,
6
8
  $VerticalLayoutSettings,
7
9
  } from "sap/ui/layout/VerticalLayout";
8
10
 
9
- import Event from "sap/ui/base/Event";
11
+ /**
12
+ * This is the SAPUI5 sample basket class, extending search basket base class 'SearchBasketBase'. Adds a
13
+ * custom header, footer and sap.m.Table is used for the basket items. Use in combination with control SearchCompositeControl
14
+ * by the Enterprise Search Team.
15
+ *
16
+ * @since 1.144.0
17
+ * @experimental As of version 1.144.0.
18
+ */
19
+ export default class CustomBasket extends VerticalLayout {
20
+ /**
21
+ * Constructs a new `SearchBasketBase` to be used as a search basket (extend this class).
22
+ * See:
23
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
24
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
25
+ */
26
+ constructor(
27
+ /**
28
+ * ID for the new control, generated automatically if no ID is given
29
+ */
30
+ sId?: string
31
+ );
32
+ }
33
+ /**
34
+ * Describes the settings that can be provided to the CustomBasket constructor.
35
+ *
36
+ * @experimental As of version 1.144.0.
37
+ */
38
+ export interface $CustomBasketSettings extends $VerticalLayoutSettings {}
39
+ }
40
+
41
+ declare module "sap/esh/search/ui/controls/basket/SearchBasketAddButton" {
42
+ import {
43
+ default as OverflowToolbarButton,
44
+ $OverflowToolbarButtonSettings,
45
+ } from "sap/m/OverflowToolbarButton";
46
+
47
+ /**
48
+ * This is the SAPUI5 search basket button control to display a button to add result items to the search
49
+ * basket. Use in combination with control SearchCompositeControl by the Enterprise Search Team.
50
+ *
51
+ * @since 1.143.0
52
+ * @experimental As of version 1.143.0.
53
+ */
54
+ export default class SearchBasketAddButton extends OverflowToolbarButton {
55
+ /**
56
+ * Constructs a new `SearchBasketAddButton` to display a button to add result items to the search basket.
57
+ * See:
58
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
59
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
60
+ */
61
+ constructor(
62
+ /**
63
+ * ID for the new control, generated automatically if no ID is given
64
+ */
65
+ sId?: string
66
+ );
67
+ }
68
+ /**
69
+ * Describes the settings that can be provided to the SearchBasketAddButton constructor.
70
+ *
71
+ * @experimental As of version 1.143.0.
72
+ */
73
+ export interface $SearchBasketAddButtonSettings
74
+ extends $OverflowToolbarButtonSettings {}
75
+ }
76
+
77
+ declare module "sap/esh/search/ui/controls/basket/SearchBasketBase" {
78
+ import {
79
+ default as VerticalLayout,
80
+ $VerticalLayoutSettings,
81
+ } from "sap/ui/layout/VerticalLayout";
82
+
83
+ /**
84
+ * This is the SAPUI5 search basket base class to be used to extend it as a custom search basket. Add custom
85
+ * header, footer, buttons, etc. in your extended class. Use in combination with control SearchCompositeControl
86
+ * by the Enterprise Search Team.
87
+ *
88
+ * @since 1.144.0
89
+ * @experimental As of version 1.144.0.
90
+ */
91
+ export default class SearchBasketBase extends VerticalLayout {
92
+ /**
93
+ * Constructs a new `SearchBasketBase` to be used as a search basket (extend this class).
94
+ * See:
95
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
96
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
97
+ */
98
+ constructor(
99
+ /**
100
+ * ID for the new control, generated automatically if no ID is given
101
+ */
102
+ sId?: string
103
+ );
104
+ }
105
+ /**
106
+ * Describes the settings that can be provided to the SearchBasketBase constructor.
107
+ *
108
+ * @experimental As of version 1.144.0.
109
+ */
110
+ export interface $SearchBasketBaseSettings extends $VerticalLayoutSettings {}
111
+ }
112
+
113
+ declare module "sap/esh/search/ui/controls/resultview/SearchShowDetailButton" {
114
+ import { default as Button, $ButtonSettings } from "sap/m/Button";
115
+
116
+ /**
117
+ * This is the SAPUI5 search show detail button control to navigate to the detail of a result item. Use
118
+ * in combination with control SearchCompositeControl by the Enterprise Search Team. The master detail mode
119
+ * of the result view must be activated (see config property 'resultviewMasterDetailMode'). Place this button
120
+ * on custom result grid view tiles (see config property 'customGridView'). The press event of this button
121
+ * will fire the event 'showResultDetail' (see sap.esh.search.ui.controls.SearchCompositeControl).
122
+ *
123
+ * @since 1.141.0
124
+ */
125
+ export default class SearchShowDetailButton extends Button {
126
+ /**
127
+ * Constructs a new `SearchShowDetailButton` to display a button to navigate to the detail of a result item.
128
+ * See:
129
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
130
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
131
+ */
132
+ constructor(
133
+ /**
134
+ * ID for the new control, generated automatically if no ID is given
135
+ */
136
+ sId?: string
137
+ );
138
+ }
139
+ /**
140
+ * Describes the settings that can be provided to the SearchShowDetailButton constructor.
141
+ */
142
+ export interface $SearchShowDetailButtonSettings extends $ButtonSettings {}
143
+ }
144
+
145
+ declare module "sap/esh/search/ui/controls/resultview/SearchText" {
146
+ import { default as Text, $TextSettings } from "sap/m/Text";
147
+
148
+ /**
149
+ * This is the SAPUI5 search text control to display attributes of search results. For attribute with navigation
150
+ * use control sap.esh.search.ui.SearchLink. Use in combination with control SearchCompositeControl by the
151
+ * Enterprise Search Team.
152
+ *
153
+ * @since 1.93.0
154
+ */
155
+ export default class SearchText extends Text {
156
+ /**
157
+ * Constructs a new `SearchText` to display an attribute (text only, no navigation) on custom grid control
158
+ * tiles.
159
+ * See:
160
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
161
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
162
+ */
163
+ constructor(
164
+ /**
165
+ * ID for the new control, generated automatically if no ID is given
166
+ */
167
+ sId?: string,
168
+ /**
169
+ * Text to be displayed
170
+ */
171
+ text?: object,
172
+ /**
173
+ * Maximum number of text lines to be displayed
174
+ */
175
+ maxlines?: object,
176
+ /**
177
+ * Text can wrap automatically within the given width
178
+ */
179
+ wrapping?: object
180
+ );
181
+ }
182
+ /**
183
+ * Describes the settings that can be provided to the SearchText constructor.
184
+ */
185
+ export interface $SearchTextSettings extends $TextSettings {}
186
+ }
187
+
188
+ declare module "sap/esh/search/ui/controls/SearchLink" {
189
+ import { default as Link, $LinkSettings } from "sap/m/Link";
10
190
 
11
191
  import ElementMetadata from "sap/ui/core/ElementMetadata";
12
192
 
13
193
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
14
194
 
15
195
  /**
16
- * Adds a callback function which is called whenever there is a user triggered event.
196
+ * This is the SAPUI5 search link control to display attributes of search results. For attribute without
197
+ * navigation use control sap.esh.search.ui.controls.resultview.SearchText. Use in combination with control
198
+ * SearchCompositeControl by the Enterprise Search Team.
17
199
  *
18
- * @since 1.120.0
200
+ * @since 1.93.0
19
201
  */
20
- export type eventConsumer = () => Function;
202
+ export default class SearchLink extends Link {
203
+ /**
204
+ * Constructs a new `SearchText` to display an attribute (with navigation) on custom grid control tiles.
205
+ * See:
206
+ * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
207
+ * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
208
+ */
209
+ constructor(
210
+ /**
211
+ * ID for the new control, generated automatically if no ID is given
212
+ */
213
+ sId?: string,
214
+ /**
215
+ * Object instance of NavigationTarget which contains all relevant information for navigation
216
+ */
217
+ navigationTarget?: object
218
+ );
219
+
220
+ /**
221
+ * Creates a new subclass of class sap.esh.search.ui.controls.SearchLink with name `sClassName` and enriches
222
+ * it with the information contained in `oClassInfo`.
223
+ *
224
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Link.extend}.
225
+ *
226
+ *
227
+ * @returns Created class / constructor function
228
+ */
229
+ static extend<T extends Record<string, unknown>>(
230
+ /**
231
+ * Name of the class being created
232
+ */
233
+ sClassName: string,
234
+ /**
235
+ * Object literal with information about the class
236
+ */
237
+ oClassInfo?: sap.ClassInfo<T, SearchLink>,
238
+ /**
239
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
240
+ * used by this class
241
+ */
242
+ FNMetaImpl?: Function
243
+ ): Function;
244
+ /**
245
+ * Returns a metadata object for class sap.esh.search.ui.controls.SearchLink.
246
+ *
247
+ *
248
+ * @returns Metadata object describing this class
249
+ */
250
+ static getMetadata(): ElementMetadata;
251
+ /**
252
+ * Gets current value of property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
253
+ *
254
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
255
+ * function 'performNavigation' of item's navigationTarget do the job
256
+ *
257
+ * Default value is `false`.
258
+ *
259
+ * @since 1.143.0
260
+ *
261
+ * @returns Value of property `forceNavigationAnchorElementNotProcessed`
262
+ */
263
+ getForceNavigationAnchorElementNotProcessed(): boolean;
264
+ /**
265
+ * Gets current value of property {@link #getNavigationTarget navigationTarget}.
266
+ *
267
+ * An object containing all data needed to define navigation of a attribute (result item)
268
+ *
269
+ * @since 1.93.0
270
+ *
271
+ * @returns Value of property `navigationTarget`
272
+ */
273
+ getNavigationTarget(): object;
274
+ /**
275
+ * Gets current value of property {@link #getVisualisation visualisation}.
276
+ *
277
+ * Visualisation style of search navigation
278
+ *
279
+ * Default value is `"hyperLink"`.
280
+ *
281
+ * @since 1.144.0
282
+ *
283
+ * @returns Value of property `visualisation`
284
+ */
285
+ getVisualisation(): string;
286
+ /**
287
+ * Sets a new value for property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
288
+ *
289
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
290
+ * function 'performNavigation' of item's navigationTarget do the job
291
+ *
292
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
293
+ *
294
+ * Default value is `false`.
295
+ *
296
+ * @since 1.143.0
297
+ *
298
+ * @returns Reference to `this` in order to allow method chaining
299
+ */
300
+ setForceNavigationAnchorElementNotProcessed(
301
+ /**
302
+ * New value for property `forceNavigationAnchorElementNotProcessed`
303
+ */
304
+ bForceNavigationAnchorElementNotProcessed?: boolean
305
+ ): this;
306
+ /**
307
+ * Sets a new value for property {@link #getNavigationTarget navigationTarget}.
308
+ *
309
+ * An object containing all data needed to define navigation of a attribute (result item)
310
+ *
311
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
312
+ *
313
+ * @since 1.93.0
314
+ *
315
+ * @returns Reference to `this` in order to allow method chaining
316
+ */
317
+ setNavigationTarget(
318
+ /**
319
+ * New value for property `navigationTarget`
320
+ */
321
+ oNavigationTarget: object
322
+ ): this;
323
+ /**
324
+ * Sets a new value for property {@link #getVisualisation visualisation}.
325
+ *
326
+ * Visualisation style of search navigation
327
+ *
328
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
329
+ *
330
+ * Default value is `"hyperLink"`.
331
+ *
332
+ * @since 1.144.0
333
+ *
334
+ * @returns Reference to `this` in order to allow method chaining
335
+ */
336
+ setVisualisation(
337
+ /**
338
+ * New value for property `visualisation`
339
+ */
340
+ sVisualisation?: string
341
+ ): this;
342
+ }
343
+ /**
344
+ * Describes the settings that can be provided to the SearchLink constructor.
345
+ */
346
+ export interface $SearchLinkSettings extends $LinkSettings {
347
+ /**
348
+ * An object containing all data needed to define navigation of a attribute (result item)
349
+ *
350
+ * @since 1.93.0
351
+ */
352
+ navigationTarget?: object | PropertyBindingInfo | `{${string}}`;
353
+
354
+ /**
355
+ * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
356
+ * function 'performNavigation' of item's navigationTarget do the job
357
+ *
358
+ * @since 1.143.0
359
+ */
360
+ forceNavigationAnchorElementNotProcessed?:
361
+ | boolean
362
+ | PropertyBindingInfo
363
+ | `{${string}}`;
364
+
365
+ /**
366
+ * Visualisation style of search navigation
367
+ *
368
+ * @since 1.144.0
369
+ */
370
+ visualisation?: string | PropertyBindingInfo;
371
+ }
372
+ }
373
+
374
+ declare module "sap/esh/search/ui/SearchCompositeControl" {
375
+ import {
376
+ default as VerticalLayout,
377
+ $VerticalLayoutSettings,
378
+ } from "sap/ui/layout/VerticalLayout";
379
+
380
+ import Event from "sap/ui/base/Event";
381
+
382
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
383
+
384
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
21
385
 
22
386
  /**
23
387
  * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the
24
- * Enterprise Search Engine features built into ABAP and HANA. It includes a search input box including
25
- * a suggestion dropdown, a result view which can have different visualisation, including tiles, list and
26
- * table, filtering facets and more. This control is ready to use with an enterprise search backend service
27
- * but also allows deep extension to match requirements of adopting applications.
388
+ * Enterprise Search Engine features built into ABAP and HANA (including natural language processing). It
389
+ * includes a search input box with a suggestion dropdown, a result view which can have different visualisation,
390
+ * including tiles, list and table, filtering facets and more. This control is ready to use with enterprise
391
+ * search backend services but also allows deep extension to match requirements of adopting applications.
28
392
  *
29
393
  * @since 1.93.0
30
394
  */
@@ -89,6 +453,73 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
89
453
  * @returns Metadata object describing this class
90
454
  */
91
455
  static getMetadata(): ElementMetadata;
456
+ /**
457
+ * Adds a callback function which is called whenever there is a user triggered event.
458
+ *
459
+ * @since 1.120.0
460
+ */
461
+ addEventConsumer(
462
+ /**
463
+ * This function will be called when the user triggered an UI event. As arguments this function will receive
464
+ * the UI event along with details of the event.
465
+ */
466
+ eventConsumer: object
467
+ ): void;
468
+ /**
469
+ * Attaches event handler `fnFunction` to the {@link #event:basketChanged basketChanged} event of this `sap.esh.search.ui.SearchCompositeControl`.
470
+ *
471
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
472
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
473
+ *
474
+ * After items are added/removed from basket, this callback is called Parameters of the event: - count:
475
+ * current number of items in basket
476
+ *
477
+ * @since 1.144.0
478
+ * @experimental As of version 1.144.0.
479
+ *
480
+ * @returns Reference to `this` in order to allow method chaining
481
+ */
482
+ attachBasketChanged(
483
+ /**
484
+ * An application-specific payload object that will be passed to the event handler along with the event
485
+ * object when firing the event
486
+ */
487
+ oData: object,
488
+ /**
489
+ * The function to be called when the event occurs
490
+ */
491
+ fnFunction: (p1: Event) => void,
492
+ /**
493
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
494
+ * itself
495
+ */
496
+ oListener?: object
497
+ ): this;
498
+ /**
499
+ * Attaches event handler `fnFunction` to the {@link #event:basketChanged basketChanged} event of this `sap.esh.search.ui.SearchCompositeControl`.
500
+ *
501
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
502
+ * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
503
+ *
504
+ * After items are added/removed from basket, this callback is called Parameters of the event: - count:
505
+ * current number of items in basket
506
+ *
507
+ * @since 1.144.0
508
+ * @experimental As of version 1.144.0.
509
+ *
510
+ * @returns Reference to `this` in order to allow method chaining
511
+ */
512
+ attachBasketChanged(
513
+ /**
514
+ * The function to be called when the event occurs
515
+ */
516
+ fnFunction: (p1: Event) => void,
517
+ /**
518
+ * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
519
+ * itself
520
+ */
521
+ oListener?: object
522
+ ): this;
92
523
  /**
93
524
  * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
94
525
  * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -149,7 +580,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
149
580
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
150
581
  * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
151
582
  *
152
- * Event is fired after result view type got changed (list, table or grid).
583
+ * Event is fired after result view type got changed (list, table or grid). Parameters of the event (since
584
+ * 1.143): - newValue: current result view type - oldValue: previous result view type
153
585
  *
154
586
  * @since 1.124
155
587
  *
@@ -178,7 +610,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
178
610
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
179
611
  * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
180
612
  *
181
- * Event is fired after result view type got changed (list, table or grid).
613
+ * Event is fired after result view type got changed (list, table or grid). Parameters of the event (since
614
+ * 1.143): - newValue: current result view type - oldValue: previous result view type
182
615
  *
183
616
  * @since 1.124
184
617
  *
@@ -407,6 +840,84 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
407
840
  */
408
841
  oListener?: object
409
842
  ): this;
843
+ /**
844
+ * Clears the object selection in the search results list,table or grid. It is useful when you want to clear
845
+ * any user selections and start fresh.
846
+ *
847
+ * @since 1.133.0
848
+ *
849
+ * @returns void
850
+ */
851
+ clearObjectSelection(): undefined;
852
+ /**
853
+ * Create a NavigationTarget instance for filtering/search.
854
+ *
855
+ * Use this method for the creation a NavigationTarget instance with filter and label.
856
+ *
857
+ * @since 1.114.0
858
+ *
859
+ * @returns The NavigationTarget instance. If the configuration parameter updateUrl is true, it contains
860
+ * targetUrl, otherwise it contains targetFunction.
861
+ */
862
+ createSearchNavigationTarget(
863
+ /**
864
+ * A sina filter object storing the searchterm, datasource and the filter conditions.
865
+ */
866
+ filter: object,
867
+ /**
868
+ * The label of the navigation target.
869
+ */
870
+ label: string
871
+ ): object;
872
+ /**
873
+ * Create a NavigationTarget instance for hierarchy.
874
+ *
875
+ * Use this method for the creation a NavigationTarget instance by hierarchical node id value and its label.
876
+ *
877
+ * @since 1.114.0
878
+ *
879
+ * @returns The NavigationTarget instance. If the configuration parameter updateUrl is true, it contains
880
+ * targetUrl, otherwise it contains targetFunction.
881
+ */
882
+ createStaticHierarchySearchNavigationTarget(
883
+ /**
884
+ * The hiearchical node id value of the giving datasource or its helper hierarchical datasource.
885
+ */
886
+ hierarchyNodeId: object,
887
+ /**
888
+ * The label of the hiearchical node id.
889
+ */
890
+ hierarchyNodeLabel: string,
891
+ /**
892
+ * The datasource instance.
893
+ */
894
+ dataSource: object,
895
+ /**
896
+ * The label of the NavigatonTarget instance.
897
+ */
898
+ navigationTargetLabel: string
899
+ ): object;
900
+ /**
901
+ * Detaches event handler `fnFunction` from the {@link #event:basketChanged basketChanged} event of this
902
+ * `sap.esh.search.ui.SearchCompositeControl`.
903
+ *
904
+ * The passed function and listener object must match the ones used for event registration.
905
+ *
906
+ * @since 1.144.0
907
+ * @experimental As of version 1.144.0.
908
+ *
909
+ * @returns Reference to `this` in order to allow method chaining
910
+ */
911
+ detachBasketChanged(
912
+ /**
913
+ * The function to be called, when the event occurs
914
+ */
915
+ fnFunction: (p1: Event) => void,
916
+ /**
917
+ * Context object on which the given function had to be called
918
+ */
919
+ oListener?: object
920
+ ): this;
410
921
  /**
411
922
  * Detaches event handler `fnFunction` from the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
412
923
  * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -527,6 +1038,21 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
527
1038
  */
528
1039
  oListener?: object
529
1040
  ): this;
1041
+ /**
1042
+ * Fires event {@link #event:basketChanged basketChanged} to attached listeners.
1043
+ *
1044
+ * @since 1.144.0
1045
+ * @experimental As of version 1.144.0.
1046
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1047
+ *
1048
+ * @returns Reference to `this` in order to allow method chaining
1049
+ */
1050
+ fireBasketChanged(
1051
+ /**
1052
+ * Parameters to pass along with the event
1053
+ */
1054
+ mParameters?: object
1055
+ ): this;
530
1056
  /**
531
1057
  * Fires event {@link #event:resultViewSelectionChanged resultViewSelectionChanged} to attached listeners.
532
1058
  *
@@ -645,7 +1171,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
645
1171
  * Default value is `false`.
646
1172
  *
647
1173
  * @since 1.143.0
648
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1174
+ * @experimental As of version 1.143.0.
649
1175
  *
650
1176
  * @returns Value of property `basketAddButton`
651
1177
  */
@@ -656,7 +1182,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
656
1182
  * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
657
1183
  *
658
1184
  * @since 1.143.0
659
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1185
+ * @experimental As of version 1.143.0.
660
1186
  *
661
1187
  * @returns Value of property `basketAddButtonIcon`
662
1188
  */
@@ -668,7 +1194,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
668
1194
  * icon, only.
669
1195
  *
670
1196
  * @since 1.143.0
671
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1197
+ * @experimental As of version 1.143.0.
672
1198
  *
673
1199
  * @returns Value of property `basketAddButtonText`
674
1200
  */
@@ -679,11 +1205,23 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
679
1205
  * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
680
1206
  *
681
1207
  * @since 1.143.0
682
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1208
+ * @experimental As of version 1.143.0.
683
1209
  *
684
1210
  * @returns Value of property `basketAddButtonTooltip`
685
1211
  */
686
1212
  getBasketAddButtonTooltip(): string;
1213
+ /**
1214
+ * Gets current value of property {@link #getBasketBeforeAddItem basketBeforeAddItem}.
1215
+ *
1216
+ * Before new item is added to basket, this callback is called with the public item (search result) and
1217
+ * the new basket item You can adjust the model data of the basket item.
1218
+ *
1219
+ * @since 1.144.0
1220
+ * @experimental As of version 1.144.0.
1221
+ *
1222
+ * @returns Value of property `basketBeforeAddItem`
1223
+ */
1224
+ getBasketBeforeAddItem(): Function;
687
1225
  /**
688
1226
  * Gets current value of property {@link #getBasketButtonsLocation basketButtonsLocation}.
689
1227
  *
@@ -694,11 +1232,32 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
694
1232
  * Default value is `"End"`.
695
1233
  *
696
1234
  * @since 1.143.0
697
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1235
+ * @experimental As of version 1.143.0.
698
1236
  *
699
1237
  * @returns Value of property `basketButtonsLocation`
700
1238
  */
701
1239
  getBasketButtonsLocation(): string;
1240
+ /**
1241
+ * Gets current value of property {@link #getBasketInit basketInit}.
1242
+ *
1243
+ * When basket gets initialized, this callback is called with the columns of the (future) basket table.
1244
+ * You can add more columns or adjust the sequence of columns.
1245
+ *
1246
+ * @since 1.144.0
1247
+ * @experimental As of version 1.144.0.
1248
+ *
1249
+ * @returns Value of property `basketInit`
1250
+ */
1251
+ getBasketInit(): Function;
1252
+ /**
1253
+ * Get items of the shopping basket ('selected items', JSON model) The model is read-only.
1254
+ *
1255
+ * @since 1.143.0
1256
+ * @experimental As of version 1.143.0.
1257
+ *
1258
+ * @returns A JSON model containing items of the shopping basket ('selected items')
1259
+ */
1260
+ getBasketItems(): object;
702
1261
  /**
703
1262
  * Gets current value of property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}.
704
1263
  *
@@ -709,7 +1268,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
709
1268
  * Default value is `false`.
710
1269
  *
711
1270
  * @since 1.143.0
712
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1271
+ * @experimental As of version 1.143.0.
713
1272
  *
714
1273
  * @returns Value of property `basketLinkByResultViewItemSelection`
715
1274
  */
@@ -721,7 +1280,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
721
1280
  *
722
1281
  * Default value is `true`.
723
1282
  *
724
- * @since 1.108.0
1283
+ * @since 1.142.0
725
1284
  *
726
1285
  * @returns Value of property `basketPanelResizable`
727
1286
  */
@@ -748,7 +1307,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
748
1307
  * Default value is `false`.
749
1308
  *
750
1309
  * @since 1.143.0
751
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
1310
+ * @experimental As of version 1.143.0.
752
1311
  *
753
1312
  * @returns Value of property `basketShowHideButton`
754
1313
  */
@@ -765,6 +1324,14 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
765
1324
  * @returns Value of property `boSuggestions`
766
1325
  */
767
1326
  getBoSuggestions(): boolean;
1327
+ /**
1328
+ * Gets the settings.
1329
+ *
1330
+ * @since 1.125.0
1331
+ *
1332
+ * @returns The settings (search configuration)
1333
+ */
1334
+ getConfig(): object;
768
1335
  /**
769
1336
  * Gets current value of property {@link #getCssClass cssClass}.
770
1337
  *
@@ -775,6 +1342,26 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
775
1342
  * @returns Value of property `cssClass`
776
1343
  */
777
1344
  getCssClass(): string;
1345
+ /**
1346
+ * Gets current value of property {@link #getCustomBasket customBasket}.
1347
+ *
1348
+ * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
1349
+ *
1350
+ * @since 1.144.0
1351
+ *
1352
+ * @returns Value of property `customBasket`
1353
+ */
1354
+ getCustomBasket(): Function;
1355
+ /**
1356
+ * Gets current value of property {@link #getCustomGridView customGridView}.
1357
+ *
1358
+ * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
1359
+ *
1360
+ * @since 1.93.0
1361
+ *
1362
+ * @returns Value of property `customGridView`
1363
+ */
1364
+ getCustomGridView(): Function;
778
1365
  /**
779
1366
  * Gets current value of property {@link #getDataSource dataSource}.
780
1367
  *
@@ -852,17 +1439,13 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
852
1439
  */
853
1440
  getEnableQueryLanguage(): boolean;
854
1441
  /**
855
- * Gets current value of property {@link #getEventConsumers eventConsumers}.
856
- *
857
- * Adds a callback function which is called whenever there is a user or a technical event. A user event
858
- * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
859
- * is an event which is triggered by the internal events or events which can also be triggered by API.
1442
+ * Returns all event consumers.
860
1443
  *
861
- * @since 1.120
1444
+ * @since 1.120.0
862
1445
  *
863
- * @returns Value of property `eventConsumers`
1446
+ * @returns List containing all event consumers.
864
1447
  */
865
- getEventConsumers(): string;
1448
+ getEventConsumers(): object[];
866
1449
  /**
867
1450
  * Gets current value of property {@link #getExclusiveDataSource exclusiveDataSource}.
868
1451
  *
@@ -942,6 +1525,14 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
942
1525
  * @returns Value of property `facetVisibility`
943
1526
  */
944
1527
  getFacetVisibility(): boolean;
1528
+ /**
1529
+ * Gets the filter containing all attribute filters currently set and functions to manipulate the filter.
1530
+ *
1531
+ * @since 1.124.0
1532
+ *
1533
+ * @returns The filter
1534
+ */
1535
+ getFilter(): object;
945
1536
  /**
946
1537
  * Gets current value of property {@link #getFilterDataSources filterDataSources}.
947
1538
  *
@@ -983,6 +1574,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
983
1574
  * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
984
1575
  * children of a folder.
985
1576
  *
1577
+ * Default value is `false`.
1578
+ *
986
1579
  * @since 1.106.0
987
1580
  *
988
1581
  * @returns Value of property `folderMode`
@@ -1022,6 +1615,16 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1022
1615
  * @returns Value of property `getCustomNoResultScreen`
1023
1616
  */
1024
1617
  getGetCustomNoResultScreen(): Function;
1618
+ /**
1619
+ * Gets current value of property {@link #getGetCustomToolbar getCustomToolbar}.
1620
+ *
1621
+ * Define a custom toolbar.
1622
+ *
1623
+ * @since 1.93.0
1624
+ *
1625
+ * @returns Value of property `getCustomToolbar`
1626
+ */
1627
+ getGetCustomToolbar(): Function;
1025
1628
  /**
1026
1629
  * Gets current value of property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
1027
1630
  *
@@ -1246,6 +1849,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1246
1849
  *
1247
1850
  * Show a text/title at the start(left) of the search bar.
1248
1851
  *
1852
+ * @since 1.143.0
1249
1853
  *
1250
1854
  * @returns Value of property `searchBarTitle`
1251
1855
  */
@@ -1348,6 +1952,19 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1348
1952
  * @returns Value of property `sinaConfiguration`
1349
1953
  */
1350
1954
  getSinaConfiguration(): object;
1955
+ /**
1956
+ * Retrieves a list of filter conditions from the root filter that do not belong to the standard filter-by
1957
+ * conditions. These conditions often represent additional static or hierarchy-based filters that are not
1958
+ * meant to be displayed in the typical “filter-by” UI.
1959
+ *
1960
+ * This method is a convenience wrapper calling an internal engine-level function (`getStaticHierarchyFilterConditions`)
1961
+ * on the underlying `SearchModel`.
1962
+ *
1963
+ * @since 1.133.0
1964
+ *
1965
+ * @returns An array of filter conditions which are considered "static hierarchy facet filter" conditions.
1966
+ */
1967
+ getStaticHierarachyFilters(): object[];
1351
1968
  /**
1352
1969
  * Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}.
1353
1970
  *
@@ -1372,6 +1989,14 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1372
1989
  * @returns Value of property `updateUrl`
1373
1990
  */
1374
1991
  getUpdateUrl(): boolean;
1992
+ /**
1993
+ * This method checks if the filter contains only static hierarchy facet filter conditions.
1994
+ *
1995
+ * @since 1.136.0
1996
+ *
1997
+ * @returns true if the filter contains only static hierarchy facet filter conditions, false otherwise.
1998
+ */
1999
+ hasStaticHierarchyFacetFilterConditionOnly(): boolean;
1375
2000
  /**
1376
2001
  * Invalidate the search cache. To trigger a search in addition, use function 'retriggerSearch' instead.
1377
2002
  *
@@ -1472,7 +2097,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1472
2097
  * Default value is `false`.
1473
2098
  *
1474
2099
  * @since 1.143.0
1475
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2100
+ * @experimental As of version 1.143.0.
1476
2101
  *
1477
2102
  * @returns Reference to `this` in order to allow method chaining
1478
2103
  */
@@ -1490,7 +2115,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1490
2115
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1491
2116
  *
1492
2117
  * @since 1.143.0
1493
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2118
+ * @experimental As of version 1.143.0.
1494
2119
  *
1495
2120
  * @returns Reference to `this` in order to allow method chaining
1496
2121
  */
@@ -1509,7 +2134,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1509
2134
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1510
2135
  *
1511
2136
  * @since 1.143.0
1512
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2137
+ * @experimental As of version 1.143.0.
1513
2138
  *
1514
2139
  * @returns Reference to `this` in order to allow method chaining
1515
2140
  */
@@ -1527,7 +2152,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1527
2152
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1528
2153
  *
1529
2154
  * @since 1.143.0
1530
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2155
+ * @experimental As of version 1.143.0.
1531
2156
  *
1532
2157
  * @returns Reference to `this` in order to allow method chaining
1533
2158
  */
@@ -1537,6 +2162,25 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1537
2162
  */
1538
2163
  sBasketAddButtonTooltip: string
1539
2164
  ): this;
2165
+ /**
2166
+ * Sets a new value for property {@link #getBasketBeforeAddItem basketBeforeAddItem}.
2167
+ *
2168
+ * Before new item is added to basket, this callback is called with the public item (search result) and
2169
+ * the new basket item You can adjust the model data of the basket item.
2170
+ *
2171
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2172
+ *
2173
+ * @since 1.144.0
2174
+ * @experimental As of version 1.144.0.
2175
+ *
2176
+ * @returns Reference to `this` in order to allow method chaining
2177
+ */
2178
+ setBasketBeforeAddItem(
2179
+ /**
2180
+ * New value for property `basketBeforeAddItem`
2181
+ */
2182
+ fnBasketBeforeAddItem: Function
2183
+ ): this;
1540
2184
  /**
1541
2185
  * Sets a new value for property {@link #getBasketButtonsLocation basketButtonsLocation}.
1542
2186
  *
@@ -1549,7 +2193,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1549
2193
  * Default value is `"End"`.
1550
2194
  *
1551
2195
  * @since 1.143.0
1552
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2196
+ * @experimental As of version 1.143.0.
1553
2197
  *
1554
2198
  * @returns Reference to `this` in order to allow method chaining
1555
2199
  */
@@ -1559,6 +2203,25 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1559
2203
  */
1560
2204
  sBasketButtonsLocation?: string
1561
2205
  ): this;
2206
+ /**
2207
+ * Sets a new value for property {@link #getBasketInit basketInit}.
2208
+ *
2209
+ * When basket gets initialized, this callback is called with the columns of the (future) basket table.
2210
+ * You can add more columns or adjust the sequence of columns.
2211
+ *
2212
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2213
+ *
2214
+ * @since 1.144.0
2215
+ * @experimental As of version 1.144.0.
2216
+ *
2217
+ * @returns Reference to `this` in order to allow method chaining
2218
+ */
2219
+ setBasketInit(
2220
+ /**
2221
+ * New value for property `basketInit`
2222
+ */
2223
+ fnBasketInit: Function
2224
+ ): this;
1562
2225
  /**
1563
2226
  * Sets a new value for property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}.
1564
2227
  *
@@ -1571,7 +2234,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1571
2234
  * Default value is `false`.
1572
2235
  *
1573
2236
  * @since 1.143.0
1574
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2237
+ * @experimental As of version 1.143.0.
1575
2238
  *
1576
2239
  * @returns Reference to `this` in order to allow method chaining
1577
2240
  */
@@ -1590,7 +2253,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1590
2253
  *
1591
2254
  * Default value is `true`.
1592
2255
  *
1593
- * @since 1.108.0
2256
+ * @since 1.142.0
1594
2257
  *
1595
2258
  * @returns Reference to `this` in order to allow method chaining
1596
2259
  */
@@ -1631,7 +2294,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1631
2294
  * Default value is `false`.
1632
2295
  *
1633
2296
  * @since 1.143.0
1634
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
2297
+ * @experimental As of version 1.143.0.
1635
2298
  *
1636
2299
  * @returns Reference to `this` in order to allow method chaining
1637
2300
  */
@@ -1677,6 +2340,40 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1677
2340
  */
1678
2341
  sCssClass: string
1679
2342
  ): this;
2343
+ /**
2344
+ * Sets a new value for property {@link #getCustomBasket customBasket}.
2345
+ *
2346
+ * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
2347
+ *
2348
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2349
+ *
2350
+ * @since 1.144.0
2351
+ *
2352
+ * @returns Reference to `this` in order to allow method chaining
2353
+ */
2354
+ setCustomBasket(
2355
+ /**
2356
+ * New value for property `customBasket`
2357
+ */
2358
+ fnCustomBasket: Function
2359
+ ): this;
2360
+ /**
2361
+ * Sets a new value for property {@link #getCustomGridView customGridView}.
2362
+ *
2363
+ * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
2364
+ *
2365
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2366
+ *
2367
+ * @since 1.93.0
2368
+ *
2369
+ * @returns Reference to `this` in order to allow method chaining
2370
+ */
2371
+ setCustomGridView(
2372
+ /**
2373
+ * New value for property `customGridView`
2374
+ */
2375
+ fnCustomGridView: Function
2376
+ ): this;
1680
2377
  /**
1681
2378
  * Sets a new value for property {@link #getDataSource dataSource}.
1682
2379
  *
@@ -1796,24 +2493,16 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1796
2493
  bEnableQueryLanguage?: boolean
1797
2494
  ): this;
1798
2495
  /**
1799
- * Sets a new value for property {@link #getEventConsumers eventConsumers}.
1800
- *
1801
- * Adds a callback function which is called whenever there is a user or a technical event. A user event
1802
- * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
1803
- * is an event which is triggered by the internal events or events which can also be triggered by API.
1804
- *
1805
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1806
- *
1807
- * @since 1.120
2496
+ * Sets a list of event consumers.
1808
2497
  *
1809
- * @returns Reference to `this` in order to allow method chaining
2498
+ * @since 1.120.0
1810
2499
  */
1811
2500
  setEventConsumers(
1812
2501
  /**
1813
- * New value for property `eventConsumers`
2502
+ * List containing all event consumers.
1814
2503
  */
1815
- sEventConsumers: string
1816
- ): this;
2504
+ eventConsumers: object[]
2505
+ ): SearchCompositeControl;
1817
2506
  /**
1818
2507
  * Sets a new value for property {@link #getExclusiveDataSource exclusiveDataSource}.
1819
2508
  *
@@ -1990,6 +2679,10 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1990
2679
  * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
1991
2680
  * children of a folder.
1992
2681
  *
2682
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2683
+ *
2684
+ * Default value is `false`.
2685
+ *
1993
2686
  * @since 1.106.0
1994
2687
  *
1995
2688
  * @returns Reference to `this` in order to allow method chaining
@@ -2055,6 +2748,23 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2055
2748
  */
2056
2749
  fnGetCustomNoResultScreen: Function
2057
2750
  ): this;
2751
+ /**
2752
+ * Sets a new value for property {@link #getGetCustomToolbar getCustomToolbar}.
2753
+ *
2754
+ * Define a custom toolbar.
2755
+ *
2756
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2757
+ *
2758
+ * @since 1.93.0
2759
+ *
2760
+ * @returns Reference to `this` in order to allow method chaining
2761
+ */
2762
+ setGetCustomToolbar(
2763
+ /**
2764
+ * New value for property `getCustomToolbar`
2765
+ */
2766
+ fnGetCustomToolbar: Function
2767
+ ): this;
2058
2768
  /**
2059
2769
  * Sets a new value for property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}.
2060
2770
  *
@@ -2383,6 +3093,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2383
3093
  *
2384
3094
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2385
3095
  *
3096
+ * @since 1.143.0
2386
3097
  *
2387
3098
  * @returns Reference to `this` in order to allow method chaining
2388
3099
  */
@@ -2738,7 +3449,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2738
3449
  * In folder mode and in case a folder filter is set the result view only shows direct children of a folder.
2739
3450
  * In contrast the counts in the facets are calculated by counting direct and not direct children. In case
2740
3451
  * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct
2741
- * children of a folder. * @since 1.106.0
3452
+ * children of a folder.
3453
+ *
3454
+ * @since 1.106.0
2742
3455
  */
2743
3456
  folderMode?: boolean | PropertyBindingInfo | `{${string}}`;
2744
3457
 
@@ -2794,7 +3507,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2794
3507
  /**
2795
3508
  * Display a splitter bar to resize the right hand panel, containing the basket with selected items.
2796
3509
  *
2797
- * @since 1.108.0
3510
+ * @since 1.142.0
2798
3511
  */
2799
3512
  basketPanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
2800
3513
 
@@ -2814,6 +3527,20 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2814
3527
  */
2815
3528
  getCustomNoResultScreen?: Function | PropertyBindingInfo | `{${string}}`;
2816
3529
 
3530
+ /**
3531
+ * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
3532
+ *
3533
+ * @since 1.93.0
3534
+ */
3535
+ customGridView?: Function | PropertyBindingInfo | `{${string}}`;
3536
+
3537
+ /**
3538
+ * Define a custom toolbar.
3539
+ *
3540
+ * @since 1.93.0
3541
+ */
3542
+ getCustomToolbar?: Function | PropertyBindingInfo | `{${string}}`;
3543
+
2817
3544
  /**
2818
3545
  * A callback which returns customized "label" for placeholder text of search box in case there is no search
2819
3546
  * term. The placeholder text (en) will be "Search In: ".
@@ -2866,6 +3593,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2866
3593
 
2867
3594
  /**
2868
3595
  * Show a text/title at the start(left) of the search bar.
3596
+ *
3597
+ * @since 1.143.0
2869
3598
  */
2870
3599
  searchBarTitle?: string | PropertyBindingInfo;
2871
3600
 
@@ -2902,7 +3631,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2902
3631
  * values are "Begin", "Middle" and "End".
2903
3632
  *
2904
3633
  * @since 1.143.0
2905
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3634
+ * @experimental As of version 1.143.0.
2906
3635
  */
2907
3636
  basketButtonsLocation?: string | PropertyBindingInfo;
2908
3637
 
@@ -2912,7 +3641,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2912
3641
  * current result view page.
2913
3642
  *
2914
3643
  * @since 1.143.0
2915
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3644
+ * @experimental As of version 1.143.0.
2916
3645
  */
2917
3646
  basketLinkByResultViewItemSelection?:
2918
3647
  | boolean
@@ -2923,7 +3652,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2923
3652
  * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
2924
3653
  *
2925
3654
  * @since 1.143.0
2926
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3655
+ * @experimental As of version 1.143.0.
2927
3656
  */
2928
3657
  basketAddButtonIcon?: string | PropertyBindingInfo;
2929
3658
 
@@ -2932,7 +3661,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2932
3661
  * icon, only.
2933
3662
  *
2934
3663
  * @since 1.143.0
2935
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3664
+ * @experimental As of version 1.143.0.
2936
3665
  */
2937
3666
  basketAddButtonText?: string | PropertyBindingInfo;
2938
3667
 
@@ -2940,10 +3669,35 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2940
3669
  * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
2941
3670
  *
2942
3671
  * @since 1.143.0
2943
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3672
+ * @experimental As of version 1.143.0.
2944
3673
  */
2945
3674
  basketAddButtonTooltip?: string | PropertyBindingInfo;
2946
3675
 
3676
+ /**
3677
+ * When basket gets initialized, this callback is called with the columns of the (future) basket table.
3678
+ * You can add more columns or adjust the sequence of columns.
3679
+ *
3680
+ * @since 1.144.0
3681
+ * @experimental As of version 1.144.0.
3682
+ */
3683
+ basketInit?: Function | PropertyBindingInfo | `{${string}}`;
3684
+
3685
+ /**
3686
+ * Before new item is added to basket, this callback is called with the public item (search result) and
3687
+ * the new basket item You can adjust the model data of the basket item.
3688
+ *
3689
+ * @since 1.144.0
3690
+ * @experimental As of version 1.144.0.
3691
+ */
3692
+ basketBeforeAddItem?: Function | PropertyBindingInfo | `{${string}}`;
3693
+
3694
+ /**
3695
+ * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile').
3696
+ *
3697
+ * @since 1.144.0
3698
+ */
3699
+ customBasket?: Function | PropertyBindingInfo | `{${string}}`;
3700
+
2947
3701
  /**
2948
3702
  * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can
2949
3703
  * be viewed as a pie or bar chart (this cannot be deactivated at runtime).
@@ -3063,7 +3817,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3063
3817
  * result view and allows to toggle visibility of the basket ('selected' result list items).
3064
3818
  *
3065
3819
  * @since 1.143.0
3066
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3820
+ * @experimental As of version 1.143.0.
3067
3821
  */
3068
3822
  basketShowHideButton?: boolean | PropertyBindingInfo | `{${string}}`;
3069
3823
 
@@ -3072,7 +3826,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3072
3826
  * result view and allows to add result view items to the basket.
3073
3827
  *
3074
3828
  * @since 1.143.0
3075
- * @experimental As of version 1.143.0. this feature is experimental and the API may change.
3829
+ * @experimental As of version 1.143.0.
3076
3830
  */
3077
3831
  basketAddButton?: boolean | PropertyBindingInfo | `{${string}}`;
3078
3832
 
@@ -3146,7 +3900,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3146
3900
  selectionChanged?: (oEvent: Event) => void;
3147
3901
 
3148
3902
  /**
3149
- * Event is fired after result view type got changed (list, table or grid).
3903
+ * Event is fired after result view type got changed (list, table or grid). Parameters of the event (since
3904
+ * 1.143): - newValue: current result view type - oldValue: previous result view type
3150
3905
  *
3151
3906
  * @since 1.124
3152
3907
  */
@@ -3159,8 +3914,34 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3159
3914
  * @since 1.140.0
3160
3915
  */
3161
3916
  showResultDetail?: (oEvent: Event) => void;
3917
+
3918
+ /**
3919
+ * After items are added/removed from basket, this callback is called Parameters of the event: - count:
3920
+ * current number of items in basket
3921
+ *
3922
+ * @since 1.144.0
3923
+ * @experimental As of version 1.144.0.
3924
+ */
3925
+ basketChanged?: (oEvent: Event) => void;
3162
3926
  }
3163
3927
 
3928
+ /**
3929
+ * Parameters of the SearchCompositeControl#basketChanged event.
3930
+ *
3931
+ * @experimental As of version 1.144.0.
3932
+ */
3933
+ export interface SearchCompositeControl$BasketChangedEventParameters {}
3934
+
3935
+ /**
3936
+ * Event object of the SearchCompositeControl#basketChanged event.
3937
+ *
3938
+ * @experimental As of version 1.144.0.
3939
+ */
3940
+ export type SearchCompositeControl$BasketChangedEvent = Event<
3941
+ SearchCompositeControl$BasketChangedEventParameters,
3942
+ SearchCompositeControl
3943
+ >;
3944
+
3164
3945
  /**
3165
3946
  * Parameters of the SearchCompositeControl#resultViewSelectionChanged event.
3166
3947
  */
@@ -3240,236 +4021,16 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3240
4021
  >;
3241
4022
  }
3242
4023
 
3243
- declare module "sap/esh/search/ui/library" {}
3244
-
3245
- declare module "sap/esh/search/ui/controls/basket/SearchBasketAddButton" {
3246
- import {
3247
- default as OverflowToolbarButton,
3248
- $OverflowToolbarButtonSettings,
3249
- } from "sap/m/OverflowToolbarButton";
3250
-
3251
- /**
3252
- * This is the SAPUI5 search basket button control to display a button to add result items to the search
3253
- * basket. Use in combination with control SearchCompositeControl by the Enterprise Search Team.
3254
- *
3255
- * @since 1.93.0
3256
- */
3257
- export default class SearchBasketAddButton extends OverflowToolbarButton {
3258
- /**
3259
- * Constructs a new `SearchBasketAddButton` to display a button to add result items to the search basket.
3260
- * See:
3261
- * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
3262
- * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
3263
- */
3264
- constructor(
3265
- /**
3266
- * ID for the new control, generated automatically if no ID is given
3267
- */
3268
- sId?: string
3269
- );
3270
- }
3271
- /**
3272
- * Describes the settings that can be provided to the SearchBasketAddButton constructor.
3273
- */
3274
- export interface $SearchBasketAddButtonSettings
3275
- extends $OverflowToolbarButtonSettings {}
3276
- }
3277
-
3278
- declare module "sap/esh/search/ui/controls/resultview/SearchText" {
3279
- import { default as Text, $TextSettings } from "sap/m/Text";
3280
-
3281
- /**
3282
- * This is the SAPUI5 search text control to display attributes of search results. For attribute with navigation
3283
- * use control sap.esh.search.ui.SearchLink. Use in combination with control SearchCompositeControl by the
3284
- * Enterprise Search Team.
3285
- *
3286
- * @since 1.93.0
3287
- */
3288
- export default class SearchText extends Text {
3289
- /**
3290
- * Constructs a new `SearchText` to display an attribute (text only, no navigation) on custom grid control
3291
- * tiles.
3292
- * See:
3293
- * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
3294
- * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
3295
- */
3296
- constructor(
3297
- /**
3298
- * ID for the new control, generated automatically if no ID is given
3299
- */
3300
- sId?: string,
3301
- /**
3302
- * Text to be displayed
3303
- */
3304
- text?: object,
3305
- /**
3306
- * Maximum number of text lines to be displayed
3307
- */
3308
- maxlines?: object,
3309
- /**
3310
- * Text can wrap automatically within the given width
3311
- */
3312
- wrapping?: object
3313
- );
3314
- }
3315
- /**
3316
- * Describes the settings that can be provided to the SearchText constructor.
3317
- */
3318
- export interface $SearchTextSettings extends $TextSettings {}
3319
- }
3320
-
3321
- declare module "sap/esh/search/ui/controls/SearchLink" {
3322
- import { default as Link, $LinkSettings } from "sap/m/Link";
3323
-
3324
- import ElementMetadata from "sap/ui/core/ElementMetadata";
3325
-
3326
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3327
-
3328
- /**
3329
- * This is the SAPUI5 search link control to display attributes of search results. For attribute without
3330
- * navigation use control sap.esh.search.ui.controls.resultview.SearchText. Use in combination with control
3331
- * SearchCompositeControl by the Enterprise Search Team.
3332
- *
3333
- * @since 1.93.0
3334
- */
3335
- export default class SearchLink extends Link {
3336
- /**
3337
- * Constructs a new `SearchText` to display an attribute (with navigation) on custom grid control tiles.
3338
- * See:
3339
- * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.05/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
3340
- * https://help.sap.com/viewer/6522d0462aeb4909a79c3462b090ec51/1709%20002/en-US
3341
- */
3342
- constructor(
3343
- /**
3344
- * ID for the new control, generated automatically if no ID is given
3345
- */
3346
- sId?: string,
3347
- /**
3348
- * Object instance of NavigationTarget which contains all relevant information for navigation
3349
- */
3350
- navigationTarget?: object
3351
- );
3352
-
3353
- /**
3354
- * Creates a new subclass of class sap.esh.search.ui.controls.SearchLink with name `sClassName` and enriches
3355
- * it with the information contained in `oClassInfo`.
3356
- *
3357
- * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Link.extend}.
3358
- *
3359
- *
3360
- * @returns Created class / constructor function
3361
- */
3362
- static extend<T extends Record<string, unknown>>(
3363
- /**
3364
- * Name of the class being created
3365
- */
3366
- sClassName: string,
3367
- /**
3368
- * Object literal with information about the class
3369
- */
3370
- oClassInfo?: sap.ClassInfo<T, SearchLink>,
3371
- /**
3372
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3373
- * used by this class
3374
- */
3375
- FNMetaImpl?: Function
3376
- ): Function;
3377
- /**
3378
- * Returns a metadata object for class sap.esh.search.ui.controls.SearchLink.
3379
- *
3380
- *
3381
- * @returns Metadata object describing this class
3382
- */
3383
- static getMetadata(): ElementMetadata;
3384
- /**
3385
- * Gets current value of property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
3386
- *
3387
- * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
3388
- * function 'performNavigation' of item's navigationTarget do the job
3389
- *
3390
- * Default value is `false`.
3391
- *
3392
- * @since 1.143.0
3393
- *
3394
- * @returns Value of property `forceNavigationAnchorElementNotProcessed`
3395
- */
3396
- getForceNavigationAnchorElementNotProcessed(): boolean;
3397
- /**
3398
- * Gets current value of property {@link #getNavigationTarget navigationTarget}.
3399
- *
3400
- * An object containing all data needed to define navigation of a attribute (result item)
3401
- *
3402
- * @since 1.93.0
3403
- *
3404
- * @returns Value of property `navigationTarget`
3405
- */
3406
- getNavigationTarget(): object;
3407
- /**
3408
- * Sets a new value for property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}.
3409
- *
3410
- * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
3411
- * function 'performNavigation' of item's navigationTarget do the job
3412
- *
3413
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3414
- *
3415
- * Default value is `false`.
3416
- *
3417
- * @since 1.143.0
3418
- *
3419
- * @returns Reference to `this` in order to allow method chaining
3420
- */
3421
- setForceNavigationAnchorElementNotProcessed(
3422
- /**
3423
- * New value for property `forceNavigationAnchorElementNotProcessed`
3424
- */
3425
- bForceNavigationAnchorElementNotProcessed?: boolean
3426
- ): this;
3427
- /**
3428
- * Sets a new value for property {@link #getNavigationTarget navigationTarget}.
3429
- *
3430
- * An object containing all data needed to define navigation of a attribute (result item)
3431
- *
3432
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3433
- *
3434
- * @since 1.93.0
3435
- *
3436
- * @returns Reference to `this` in order to allow method chaining
3437
- */
3438
- setNavigationTarget(
3439
- /**
3440
- * New value for property `navigationTarget`
3441
- */
3442
- oNavigationTarget: object
3443
- ): this;
3444
- }
3445
- /**
3446
- * Describes the settings that can be provided to the SearchLink constructor.
3447
- */
3448
- export interface $SearchLinkSettings extends $LinkSettings {
3449
- /**
3450
- * An object containing all data needed to define navigation of a attribute (result item)
3451
- *
3452
- * @since 1.93.0
3453
- */
3454
- navigationTarget?: object | PropertyBindingInfo | `{${string}}`;
3455
-
3456
- /**
3457
- * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the
3458
- * function 'performNavigation' of item's navigationTarget do the job
3459
- *
3460
- * @since 1.143.0
3461
- */
3462
- forceNavigationAnchorElementNotProcessed?:
3463
- | boolean
3464
- | PropertyBindingInfo
3465
- | `{${string}}`;
3466
- }
3467
- }
3468
-
3469
4024
  declare namespace sap {
3470
4025
  interface IUI5DefineDependencyNames {
4026
+ "sap/esh/search/ui/controls/basket/CustomBasket": undefined;
4027
+
3471
4028
  "sap/esh/search/ui/controls/basket/SearchBasketAddButton": undefined;
3472
4029
 
4030
+ "sap/esh/search/ui/controls/basket/SearchBasketBase": undefined;
4031
+
4032
+ "sap/esh/search/ui/controls/resultview/SearchShowDetailButton": undefined;
4033
+
3473
4034
  "sap/esh/search/ui/controls/resultview/SearchText": undefined;
3474
4035
 
3475
4036
  "sap/esh/search/ui/controls/SearchLink": undefined;