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