@sapui5/ts-types 1.150.0 → 1.151.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/package.json +1 -1
- package/types/index.d.ts +1 -0
- 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.esh.search.ui.d.ts +410 -157
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +2 -222
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +1 -1
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +209 -80
- package/types/sap.fe.navigation.d.ts +3 -2
- 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 +3 -3
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +125 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +133 -1
- 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 +1 -1
- package/types/sap.suite.ui.commons.d.ts +45 -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 +178 -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 +1 -1
- package/types/sap.ui.core.d.ts +389 -236
- 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 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.geomap.d.ts +10393 -8758
- package/types/sap.ui.integration.d.ts +31 -3
- package/types/sap.ui.joule.frontend.d.ts +710 -0
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +11 -8
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +2 -2
- 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 +2 -2
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +101 -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 +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +22 -2
- package/types/sap.ushell_abap.d.ts +1 -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,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.151.2
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace esh {
|
|
@@ -9,44 +9,16 @@ declare namespace sap {
|
|
|
9
9
|
namespace ui {
|
|
10
10
|
namespace controls {
|
|
11
11
|
namespace basket {
|
|
12
|
-
/**
|
|
13
|
-
* Describes the settings that can be provided to the CustomBasket constructor.
|
|
14
|
-
*/
|
|
15
|
-
interface $CustomBasketSettings
|
|
16
|
-
extends sap.ui.layout.$VerticalLayoutSettings {}
|
|
17
|
-
|
|
18
12
|
/**
|
|
19
13
|
* Describes the settings that can be provided to the SearchBasketAddButton constructor.
|
|
20
14
|
*/
|
|
21
15
|
interface $SearchBasketAddButtonSettings
|
|
22
16
|
extends sap.m.$OverflowToolbarButtonSettings {}
|
|
23
17
|
|
|
24
|
-
/**
|
|
25
|
-
* This is the SAPUI5 sample basket class, making use of the sap.ui.table.Table extension SearchBasketSapUiTable.
|
|
26
|
-
* In addition, adds a custom header, footer (sap.ui.table.Table is used for the basket items). Use in combination
|
|
27
|
-
* with control SearchCompositeControl by the Enterprise Search Team.
|
|
28
|
-
*
|
|
29
|
-
* @since 1.144.0
|
|
30
|
-
*/
|
|
31
|
-
class CustomBasket extends sap.ui.layout.VerticalLayout {
|
|
32
|
-
/**
|
|
33
|
-
* Constructs a new `CustomBasket` to be used as a search basket (extend this class).
|
|
34
|
-
* See:
|
|
35
|
-
* https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html
|
|
36
|
-
* SAP HANA Search Developer Guide
|
|
37
|
-
* https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html
|
|
38
|
-
* Enterprise Search in SAP S/4HANA
|
|
39
|
-
*/
|
|
40
|
-
constructor(
|
|
41
|
-
/**
|
|
42
|
-
* ID for the new control, generated automatically if no ID is given
|
|
43
|
-
*/
|
|
44
|
-
sId?: string
|
|
45
|
-
);
|
|
46
|
-
}
|
|
47
18
|
/**
|
|
48
19
|
* This is the SAPUI5 search basket button control to display a button to add result items to the search
|
|
49
|
-
* basket. Use in combination with
|
|
20
|
+
* basket. Use in combination with {@link sap.esh.search.ui.controls.SearchCompositeControl} by the Enterprise
|
|
21
|
+
* Search Team.
|
|
50
22
|
*
|
|
51
23
|
* @since 1.143.0
|
|
52
24
|
*/
|
|
@@ -65,6 +37,41 @@ declare namespace sap {
|
|
|
65
37
|
*/
|
|
66
38
|
sId?: string
|
|
67
39
|
);
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Creates a new subclass of class sap.esh.search.ui.controls.basket.SearchBasketAddButton with name `sClassName`
|
|
43
|
+
* and enriches it with the information contained in `oClassInfo`.
|
|
44
|
+
*
|
|
45
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* @returns Created class / constructor function
|
|
49
|
+
*/
|
|
50
|
+
static extend<T extends Record<string, unknown>>(
|
|
51
|
+
/**
|
|
52
|
+
* Name of the class being created
|
|
53
|
+
*/
|
|
54
|
+
sClassName: string,
|
|
55
|
+
/**
|
|
56
|
+
* Object literal with information about the class
|
|
57
|
+
*/
|
|
58
|
+
oClassInfo?: sap.ClassInfo<
|
|
59
|
+
T,
|
|
60
|
+
sap.esh.search.ui.controls.basket.SearchBasketAddButton
|
|
61
|
+
>,
|
|
62
|
+
/**
|
|
63
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
64
|
+
* used by this class
|
|
65
|
+
*/
|
|
66
|
+
FNMetaImpl?: Function
|
|
67
|
+
): Function;
|
|
68
|
+
/**
|
|
69
|
+
* Returns a metadata object for class sap.esh.search.ui.controls.basket.SearchBasketAddButton.
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* @returns Metadata object describing this class
|
|
73
|
+
*/
|
|
74
|
+
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
68
75
|
}
|
|
69
76
|
}
|
|
70
77
|
|
|
@@ -73,19 +80,62 @@ declare namespace sap {
|
|
|
73
80
|
* Describes the settings that can be provided to the SearchShowDetailButton constructor.
|
|
74
81
|
*/
|
|
75
82
|
interface $SearchShowDetailButtonSettings
|
|
76
|
-
extends sap.m.$ButtonSettings {
|
|
83
|
+
extends sap.m.$ButtonSettings {
|
|
84
|
+
/**
|
|
85
|
+
* defines the visual style of the button. accepted values: "button" (default), "arrow", "navigation".
|
|
86
|
+
*
|
|
87
|
+
* @since 1.93.0
|
|
88
|
+
*/
|
|
89
|
+
visualisation?:
|
|
90
|
+
| string
|
|
91
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
92
|
+
}
|
|
77
93
|
|
|
78
94
|
/**
|
|
79
95
|
* Describes the settings that can be provided to the SearchText constructor.
|
|
80
96
|
*/
|
|
81
|
-
interface $SearchTextSettings extends sap.m.$TextSettings {
|
|
97
|
+
interface $SearchTextSettings extends sap.m.$TextSettings {
|
|
98
|
+
/**
|
|
99
|
+
* maximum number of text lines to display. if 0, all lines are shown.
|
|
100
|
+
*
|
|
101
|
+
* @since 1.93.0
|
|
102
|
+
*/
|
|
103
|
+
maxLines?:
|
|
104
|
+
| int
|
|
105
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
106
|
+
| `{${string}}`;
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* the text to display.
|
|
110
|
+
*
|
|
111
|
+
* @since 1.93.0
|
|
112
|
+
*/
|
|
113
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* whether the text wraps automatically within the given width.
|
|
117
|
+
*
|
|
118
|
+
* @since 1.93.0
|
|
119
|
+
*/
|
|
120
|
+
wrapping?:
|
|
121
|
+
| boolean
|
|
122
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
123
|
+
| `{${string}}`;
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* optional icon displayed next to the text.
|
|
127
|
+
*
|
|
128
|
+
* @since 1.93.0
|
|
129
|
+
*/
|
|
130
|
+
icon?: sap.ui.core.Icon;
|
|
131
|
+
}
|
|
82
132
|
|
|
83
133
|
/**
|
|
84
134
|
* This is the SAPUI5 search show detail button control to navigate to the detail of a result item. Use
|
|
85
|
-
* in combination with
|
|
86
|
-
* of the result view must be activated (see config property 'resultviewMasterDetailMode').
|
|
87
|
-
* on custom result grid view tiles (see config property 'customGridView'). The press
|
|
88
|
-
* will fire the event 'showResultDetail' (see sap.esh.search.ui.controls.SearchCompositeControl).
|
|
135
|
+
* in combination with {@link sap.esh.search.ui.controls.SearchCompositeControl} by the Enterprise Search
|
|
136
|
+
* Team. The master detail mode of the result view must be activated (see config property 'resultviewMasterDetailMode').
|
|
137
|
+
* Place this button on custom result grid view tiles (see config property 'customGridView'). The press
|
|
138
|
+
* event of this button will fire the event 'showResultDetail' (see {@link sap.esh.search.ui.controls.SearchCompositeControl}).
|
|
89
139
|
*
|
|
90
140
|
* @since 1.141.0
|
|
91
141
|
*/
|
|
@@ -104,11 +154,77 @@ declare namespace sap {
|
|
|
104
154
|
*/
|
|
105
155
|
sId?: string
|
|
106
156
|
);
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* Creates a new subclass of class sap.esh.search.ui.controls.resultview.SearchShowDetailButton with name
|
|
160
|
+
* `sClassName` and enriches it with the information contained in `oClassInfo`.
|
|
161
|
+
*
|
|
162
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
|
|
163
|
+
*
|
|
164
|
+
*
|
|
165
|
+
* @returns Created class / constructor function
|
|
166
|
+
*/
|
|
167
|
+
static extend<T extends Record<string, unknown>>(
|
|
168
|
+
/**
|
|
169
|
+
* Name of the class being created
|
|
170
|
+
*/
|
|
171
|
+
sClassName: string,
|
|
172
|
+
/**
|
|
173
|
+
* Object literal with information about the class
|
|
174
|
+
*/
|
|
175
|
+
oClassInfo?: sap.ClassInfo<
|
|
176
|
+
T,
|
|
177
|
+
sap.esh.search.ui.controls.resultview.SearchShowDetailButton
|
|
178
|
+
>,
|
|
179
|
+
/**
|
|
180
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
181
|
+
* used by this class
|
|
182
|
+
*/
|
|
183
|
+
FNMetaImpl?: Function
|
|
184
|
+
): Function;
|
|
185
|
+
/**
|
|
186
|
+
* Returns a metadata object for class sap.esh.search.ui.controls.resultview.SearchShowDetailButton.
|
|
187
|
+
*
|
|
188
|
+
*
|
|
189
|
+
* @returns Metadata object describing this class
|
|
190
|
+
*/
|
|
191
|
+
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
192
|
+
/**
|
|
193
|
+
* Gets current value of property {@link #getVisualisation visualisation}.
|
|
194
|
+
*
|
|
195
|
+
* defines the visual style of the button. accepted values: "button" (default), "arrow", "navigation".
|
|
196
|
+
*
|
|
197
|
+
* Default value is `"button"`.
|
|
198
|
+
*
|
|
199
|
+
* @since 1.93.0
|
|
200
|
+
*
|
|
201
|
+
* @returns Value of property `visualisation`
|
|
202
|
+
*/
|
|
203
|
+
getVisualisation(): string;
|
|
204
|
+
/**
|
|
205
|
+
* Sets a new value for property {@link #getVisualisation visualisation}.
|
|
206
|
+
*
|
|
207
|
+
* defines the visual style of the button. accepted values: "button" (default), "arrow", "navigation".
|
|
208
|
+
*
|
|
209
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
210
|
+
*
|
|
211
|
+
* Default value is `"button"`.
|
|
212
|
+
*
|
|
213
|
+
* @since 1.93.0
|
|
214
|
+
*
|
|
215
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
216
|
+
*/
|
|
217
|
+
setVisualisation(
|
|
218
|
+
/**
|
|
219
|
+
* New value for property `visualisation`
|
|
220
|
+
*/
|
|
221
|
+
sVisualisation?: string
|
|
222
|
+
): this;
|
|
107
223
|
}
|
|
108
224
|
/**
|
|
109
225
|
* This is the SAPUI5 search text control to display attributes of search results. For attribute with navigation
|
|
110
|
-
* use control sap.esh.search.ui.SearchLink. Use in combination with control SearchCompositeControl
|
|
111
|
-
* Enterprise Search Team.
|
|
226
|
+
* use control sap.esh.search.ui.controls.SearchLink. Use in combination with control SearchCompositeControl
|
|
227
|
+
* by the Enterprise Search Team.
|
|
112
228
|
*
|
|
113
229
|
* @since 1.93.0
|
|
114
230
|
*/
|
|
@@ -140,6 +256,159 @@ declare namespace sap {
|
|
|
140
256
|
*/
|
|
141
257
|
wrapping?: object
|
|
142
258
|
);
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Creates a new subclass of class sap.esh.search.ui.controls.resultview.SearchText with name `sClassName`
|
|
262
|
+
* and enriches it with the information contained in `oClassInfo`.
|
|
263
|
+
*
|
|
264
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Text.extend}.
|
|
265
|
+
*
|
|
266
|
+
*
|
|
267
|
+
* @returns Created class / constructor function
|
|
268
|
+
*/
|
|
269
|
+
static extend<T extends Record<string, unknown>>(
|
|
270
|
+
/**
|
|
271
|
+
* Name of the class being created
|
|
272
|
+
*/
|
|
273
|
+
sClassName: string,
|
|
274
|
+
/**
|
|
275
|
+
* Object literal with information about the class
|
|
276
|
+
*/
|
|
277
|
+
oClassInfo?: sap.ClassInfo<
|
|
278
|
+
T,
|
|
279
|
+
sap.esh.search.ui.controls.resultview.SearchText
|
|
280
|
+
>,
|
|
281
|
+
/**
|
|
282
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
283
|
+
* used by this class
|
|
284
|
+
*/
|
|
285
|
+
FNMetaImpl?: Function
|
|
286
|
+
): Function;
|
|
287
|
+
/**
|
|
288
|
+
* Returns a metadata object for class sap.esh.search.ui.controls.resultview.SearchText.
|
|
289
|
+
*
|
|
290
|
+
*
|
|
291
|
+
* @returns Metadata object describing this class
|
|
292
|
+
*/
|
|
293
|
+
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
294
|
+
/**
|
|
295
|
+
* Destroys the icon in the aggregation {@link #getIcon icon}.
|
|
296
|
+
*
|
|
297
|
+
* @since 1.93.0
|
|
298
|
+
*
|
|
299
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
300
|
+
*/
|
|
301
|
+
destroyIcon(): this;
|
|
302
|
+
/**
|
|
303
|
+
* Gets content of aggregation {@link #getIcon icon}.
|
|
304
|
+
*
|
|
305
|
+
* optional icon displayed next to the text.
|
|
306
|
+
*
|
|
307
|
+
* @since 1.93.0
|
|
308
|
+
*/
|
|
309
|
+
getIcon(): sap.ui.core.Icon;
|
|
310
|
+
/**
|
|
311
|
+
* Gets current value of property {@link #getMaxLines maxLines}.
|
|
312
|
+
*
|
|
313
|
+
* maximum number of text lines to display. if 0, all lines are shown.
|
|
314
|
+
*
|
|
315
|
+
* @since 1.93.0
|
|
316
|
+
*
|
|
317
|
+
* @returns Value of property `maxLines`
|
|
318
|
+
*/
|
|
319
|
+
getMaxLines(): int;
|
|
320
|
+
/**
|
|
321
|
+
* Gets current value of property {@link #getText text}.
|
|
322
|
+
*
|
|
323
|
+
* the text to display.
|
|
324
|
+
*
|
|
325
|
+
* Default value is `empty string`.
|
|
326
|
+
*
|
|
327
|
+
* @since 1.93.0
|
|
328
|
+
*
|
|
329
|
+
* @returns Value of property `text`
|
|
330
|
+
*/
|
|
331
|
+
getText(): string;
|
|
332
|
+
/**
|
|
333
|
+
* Gets current value of property {@link #getWrapping wrapping}.
|
|
334
|
+
*
|
|
335
|
+
* whether the text wraps automatically within the given width.
|
|
336
|
+
*
|
|
337
|
+
* Default value is `true`.
|
|
338
|
+
*
|
|
339
|
+
* @since 1.93.0
|
|
340
|
+
*
|
|
341
|
+
* @returns Value of property `wrapping`
|
|
342
|
+
*/
|
|
343
|
+
getWrapping(): boolean;
|
|
344
|
+
/**
|
|
345
|
+
* Sets the aggregated {@link #getIcon icon}.
|
|
346
|
+
*
|
|
347
|
+
* @since 1.93.0
|
|
348
|
+
*
|
|
349
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
350
|
+
*/
|
|
351
|
+
setIcon(
|
|
352
|
+
/**
|
|
353
|
+
* The icon to set
|
|
354
|
+
*/
|
|
355
|
+
oIcon: sap.ui.core.Icon
|
|
356
|
+
): this;
|
|
357
|
+
/**
|
|
358
|
+
* Sets a new value for property {@link #getMaxLines maxLines}.
|
|
359
|
+
*
|
|
360
|
+
* maximum number of text lines to display. if 0, all lines are shown.
|
|
361
|
+
*
|
|
362
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
363
|
+
*
|
|
364
|
+
* @since 1.93.0
|
|
365
|
+
*
|
|
366
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
367
|
+
*/
|
|
368
|
+
setMaxLines(
|
|
369
|
+
/**
|
|
370
|
+
* New value for property `maxLines`
|
|
371
|
+
*/
|
|
372
|
+
iMaxLines: int
|
|
373
|
+
): this;
|
|
374
|
+
/**
|
|
375
|
+
* Sets a new value for property {@link #getText text}.
|
|
376
|
+
*
|
|
377
|
+
* the text to display.
|
|
378
|
+
*
|
|
379
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
380
|
+
*
|
|
381
|
+
* Default value is `empty string`.
|
|
382
|
+
*
|
|
383
|
+
* @since 1.93.0
|
|
384
|
+
*
|
|
385
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
386
|
+
*/
|
|
387
|
+
setText(
|
|
388
|
+
/**
|
|
389
|
+
* New value for property `text`
|
|
390
|
+
*/
|
|
391
|
+
sText?: string
|
|
392
|
+
): this;
|
|
393
|
+
/**
|
|
394
|
+
* Sets a new value for property {@link #getWrapping wrapping}.
|
|
395
|
+
*
|
|
396
|
+
* whether the text wraps automatically within the given width.
|
|
397
|
+
*
|
|
398
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
399
|
+
*
|
|
400
|
+
* Default value is `true`.
|
|
401
|
+
*
|
|
402
|
+
* @since 1.93.0
|
|
403
|
+
*
|
|
404
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
405
|
+
*/
|
|
406
|
+
setWrapping(
|
|
407
|
+
/**
|
|
408
|
+
* New value for property `wrapping`
|
|
409
|
+
*/
|
|
410
|
+
bWrapping?: boolean
|
|
411
|
+
): this;
|
|
143
412
|
}
|
|
144
413
|
}
|
|
145
414
|
/**
|
|
@@ -179,8 +448,8 @@ declare namespace sap {
|
|
|
179
448
|
|
|
180
449
|
/**
|
|
181
450
|
* This is the SAPUI5 search link control to display attributes of search results. For attribute without
|
|
182
|
-
* navigation use control sap.esh.search.ui.controls.resultview.SearchText. Use in combination with
|
|
183
|
-
* SearchCompositeControl by the Enterprise Search Team.
|
|
451
|
+
* navigation use control {@link sap.esh.search.ui.controls.resultview.SearchText}. Use in combination with
|
|
452
|
+
* {@link sap.esh.search.ui.controls.SearchCompositeControl} by the Enterprise Search Team.
|
|
184
453
|
*
|
|
185
454
|
* @since 1.93.0
|
|
186
455
|
*/
|
|
@@ -733,6 +1002,30 @@ declare namespace sap {
|
|
|
733
1002
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
734
1003
|
| `{${string}}`;
|
|
735
1004
|
|
|
1005
|
+
/**
|
|
1006
|
+
* controls whether the export button is shown in the toolbar. When the basket feature is active, the button
|
|
1007
|
+
* opens a menu ("Export Results" / "Export Basket"). Set to false to hide it. Stakeholders currently hiding
|
|
1008
|
+
* the export button via custom CSS targeting [id$="-dataExportButton"] can use this instead.
|
|
1009
|
+
*
|
|
1010
|
+
* @since 1.151.0
|
|
1011
|
+
*/
|
|
1012
|
+
showExport?:
|
|
1013
|
+
| boolean
|
|
1014
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1015
|
+
| `{${string}}`;
|
|
1016
|
+
|
|
1017
|
+
/**
|
|
1018
|
+
* Controls whether the "Search In" datasource section is shown in the facet panel. When set to false, the
|
|
1019
|
+
* "Search In" section is hidden — use together with quickSelectDataSources to provide datasource navigation
|
|
1020
|
+
* via "Collection" instead.
|
|
1021
|
+
*
|
|
1022
|
+
* @since 1.150.0
|
|
1023
|
+
*/
|
|
1024
|
+
showDataSourceFacet?:
|
|
1025
|
+
| boolean
|
|
1026
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1027
|
+
| `{${string}}`;
|
|
1028
|
+
|
|
736
1029
|
/**
|
|
737
1030
|
* Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin)
|
|
738
1031
|
* or on the right (end) of the search bar. By default the button's location is at the beginning (left),
|
|
@@ -949,8 +1242,8 @@ declare namespace sap {
|
|
|
949
1242
|
| `{${string}}`;
|
|
950
1243
|
|
|
951
1244
|
/**
|
|
952
|
-
* A callback for parsing URL parameters. The callback
|
|
953
|
-
* parameters. This is an optional callback. In case you set 'updateUrl = true'
|
|
1245
|
+
* A callback for parsing URL parameters. The callback receives URL parameters and returns modified URL
|
|
1246
|
+
* parameters. This is an optional callback. In case you set 'updateUrl = true' typically this callback
|
|
954
1247
|
* is not needed.
|
|
955
1248
|
*
|
|
956
1249
|
* @since 1.113.0
|
|
@@ -1114,13 +1407,6 @@ declare namespace sap {
|
|
|
1114
1407
|
*/
|
|
1115
1408
|
searchFinished?: (oEvent: sap.ui.base.Event) => void;
|
|
1116
1409
|
|
|
1117
|
-
/**
|
|
1118
|
-
* Event is fired when selection on result view (list, table or grid) has changed.
|
|
1119
|
-
*
|
|
1120
|
-
* @since 1.143
|
|
1121
|
-
*/
|
|
1122
|
-
resultViewSelectionChanged?: (oEvent: sap.ui.base.Event) => void;
|
|
1123
|
-
|
|
1124
1410
|
/**
|
|
1125
1411
|
* Event is fired when selection on result view (list, table or grid) has changed.
|
|
1126
1412
|
*
|
|
@@ -1158,11 +1444,6 @@ declare namespace sap {
|
|
|
1158
1444
|
*/
|
|
1159
1445
|
interface SearchCompositeControl$BasketChangedEventParameters {}
|
|
1160
1446
|
|
|
1161
|
-
/**
|
|
1162
|
-
* Parameters of the SearchCompositeControl#resultViewSelectionChanged event.
|
|
1163
|
-
*/
|
|
1164
|
-
interface SearchCompositeControl$ResultViewSelectionChangedEventParameters {}
|
|
1165
|
-
|
|
1166
1447
|
/**
|
|
1167
1448
|
* Parameters of the SearchCompositeControl#resultViewTypeChanged event.
|
|
1168
1449
|
*/
|
|
@@ -1330,59 +1611,6 @@ declare namespace sap {
|
|
|
1330
1611
|
*/
|
|
1331
1612
|
oListener?: object
|
|
1332
1613
|
): this;
|
|
1333
|
-
/**
|
|
1334
|
-
* Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
|
|
1335
|
-
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
1336
|
-
*
|
|
1337
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1338
|
-
* otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
|
|
1339
|
-
*
|
|
1340
|
-
* Event is fired when selection on result view (list, table or grid) has changed.
|
|
1341
|
-
*
|
|
1342
|
-
* @since 1.143
|
|
1343
|
-
*
|
|
1344
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1345
|
-
*/
|
|
1346
|
-
attachResultViewSelectionChanged(
|
|
1347
|
-
/**
|
|
1348
|
-
* An application-specific payload object that will be passed to the event handler along with the event
|
|
1349
|
-
* object when firing the event
|
|
1350
|
-
*/
|
|
1351
|
-
oData: object,
|
|
1352
|
-
/**
|
|
1353
|
-
* The function to be called when the event occurs
|
|
1354
|
-
*/
|
|
1355
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
1356
|
-
/**
|
|
1357
|
-
* Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
|
|
1358
|
-
* itself
|
|
1359
|
-
*/
|
|
1360
|
-
oListener?: object
|
|
1361
|
-
): this;
|
|
1362
|
-
/**
|
|
1363
|
-
* Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
|
|
1364
|
-
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
1365
|
-
*
|
|
1366
|
-
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
1367
|
-
* otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself.
|
|
1368
|
-
*
|
|
1369
|
-
* Event is fired when selection on result view (list, table or grid) has changed.
|
|
1370
|
-
*
|
|
1371
|
-
* @since 1.143
|
|
1372
|
-
*
|
|
1373
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1374
|
-
*/
|
|
1375
|
-
attachResultViewSelectionChanged(
|
|
1376
|
-
/**
|
|
1377
|
-
* The function to be called when the event occurs
|
|
1378
|
-
*/
|
|
1379
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
1380
|
-
/**
|
|
1381
|
-
* Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
|
|
1382
|
-
* itself
|
|
1383
|
-
*/
|
|
1384
|
-
oListener?: object
|
|
1385
|
-
): this;
|
|
1386
1614
|
/**
|
|
1387
1615
|
* Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged }
|
|
1388
1616
|
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
@@ -1747,26 +1975,6 @@ declare namespace sap {
|
|
|
1747
1975
|
*/
|
|
1748
1976
|
oListener?: object
|
|
1749
1977
|
): this;
|
|
1750
|
-
/**
|
|
1751
|
-
* Detaches event handler `fnFunction` from the {@link #event:resultViewSelectionChanged resultViewSelectionChanged }
|
|
1752
|
-
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
1753
|
-
*
|
|
1754
|
-
* The passed function and listener object must match the ones used for event registration.
|
|
1755
|
-
*
|
|
1756
|
-
* @since 1.143
|
|
1757
|
-
*
|
|
1758
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1759
|
-
*/
|
|
1760
|
-
detachResultViewSelectionChanged(
|
|
1761
|
-
/**
|
|
1762
|
-
* The function to be called, when the event occurs
|
|
1763
|
-
*/
|
|
1764
|
-
fnFunction: (p1: sap.ui.base.Event) => void,
|
|
1765
|
-
/**
|
|
1766
|
-
* Context object on which the given function had to be called
|
|
1767
|
-
*/
|
|
1768
|
-
oListener?: object
|
|
1769
|
-
): this;
|
|
1770
1978
|
/**
|
|
1771
1979
|
* Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
|
|
1772
1980
|
* event of this `sap.esh.search.ui.SearchCompositeControl`.
|
|
@@ -1881,20 +2089,6 @@ declare namespace sap {
|
|
|
1881
2089
|
*/
|
|
1882
2090
|
mParameters?: object
|
|
1883
2091
|
): this;
|
|
1884
|
-
/**
|
|
1885
|
-
* Fires event {@link #event:resultViewSelectionChanged resultViewSelectionChanged} to attached listeners.
|
|
1886
|
-
*
|
|
1887
|
-
* @since 1.143
|
|
1888
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1889
|
-
*
|
|
1890
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1891
|
-
*/
|
|
1892
|
-
fireResultViewSelectionChanged(
|
|
1893
|
-
/**
|
|
1894
|
-
* Parameters to pass along with the event
|
|
1895
|
-
*/
|
|
1896
|
-
mParameters?: object
|
|
1897
|
-
): this;
|
|
1898
2092
|
/**
|
|
1899
2093
|
* Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
|
|
1900
2094
|
*
|
|
@@ -2612,8 +2806,8 @@ declare namespace sap {
|
|
|
2612
2806
|
/**
|
|
2613
2807
|
* Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
|
|
2614
2808
|
*
|
|
2615
|
-
* A callback for parsing URL parameters. The callback
|
|
2616
|
-
* parameters. This is an optional callback. In case you set 'updateUrl = true'
|
|
2809
|
+
* A callback for parsing URL parameters. The callback receives URL parameters and returns modified URL
|
|
2810
|
+
* parameters. This is an optional callback. In case you set 'updateUrl = true' typically this callback
|
|
2617
2811
|
* is not needed.
|
|
2618
2812
|
*
|
|
2619
2813
|
* @since 1.113.0
|
|
@@ -2783,6 +2977,34 @@ declare namespace sap {
|
|
|
2783
2977
|
* @returns Value of property `searchTermLengthLimit`
|
|
2784
2978
|
*/
|
|
2785
2979
|
getSearchTermLengthLimit(): int;
|
|
2980
|
+
/**
|
|
2981
|
+
* Gets current value of property {@link #getShowDataSourceFacet showDataSourceFacet}.
|
|
2982
|
+
*
|
|
2983
|
+
* Controls whether the "Search In" datasource section is shown in the facet panel. When set to false, the
|
|
2984
|
+
* "Search In" section is hidden — use together with quickSelectDataSources to provide datasource navigation
|
|
2985
|
+
* via "Collection" instead.
|
|
2986
|
+
*
|
|
2987
|
+
* Default value is `true`.
|
|
2988
|
+
*
|
|
2989
|
+
* @since 1.150.0
|
|
2990
|
+
*
|
|
2991
|
+
* @returns Value of property `showDataSourceFacet`
|
|
2992
|
+
*/
|
|
2993
|
+
getShowDataSourceFacet(): boolean;
|
|
2994
|
+
/**
|
|
2995
|
+
* Gets current value of property {@link #getShowExport showExport}.
|
|
2996
|
+
*
|
|
2997
|
+
* controls whether the export button is shown in the toolbar. When the basket feature is active, the button
|
|
2998
|
+
* opens a menu ("Export Results" / "Export Basket"). Set to false to hide it. Stakeholders currently hiding
|
|
2999
|
+
* the export button via custom CSS targeting [id$="-dataExportButton"] can use this instead.
|
|
3000
|
+
*
|
|
3001
|
+
* Default value is `true`.
|
|
3002
|
+
*
|
|
3003
|
+
* @since 1.151.0
|
|
3004
|
+
*
|
|
3005
|
+
* @returns Value of property `showExport`
|
|
3006
|
+
*/
|
|
3007
|
+
getShowExport(): boolean;
|
|
2786
3008
|
/**
|
|
2787
3009
|
* Gets current value of property {@link #getShowSelectionToggleButton showSelectionToggleButton}.
|
|
2788
3010
|
*
|
|
@@ -3897,8 +4119,8 @@ declare namespace sap {
|
|
|
3897
4119
|
/**
|
|
3898
4120
|
* Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}.
|
|
3899
4121
|
*
|
|
3900
|
-
* A callback for parsing URL parameters. The callback
|
|
3901
|
-
* parameters. This is an optional callback. In case you set 'updateUrl = true'
|
|
4122
|
+
* A callback for parsing URL parameters. The callback receives URL parameters and returns modified URL
|
|
4123
|
+
* parameters. This is an optional callback. In case you set 'updateUrl = true' typically this callback
|
|
3902
4124
|
* is not needed.
|
|
3903
4125
|
*
|
|
3904
4126
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -4121,6 +4343,48 @@ declare namespace sap {
|
|
|
4121
4343
|
*/
|
|
4122
4344
|
iSearchTermLengthLimit?: int
|
|
4123
4345
|
): this;
|
|
4346
|
+
/**
|
|
4347
|
+
* Sets a new value for property {@link #getShowDataSourceFacet showDataSourceFacet}.
|
|
4348
|
+
*
|
|
4349
|
+
* Controls whether the "Search In" datasource section is shown in the facet panel. When set to false, the
|
|
4350
|
+
* "Search In" section is hidden — use together with quickSelectDataSources to provide datasource navigation
|
|
4351
|
+
* via "Collection" instead.
|
|
4352
|
+
*
|
|
4353
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4354
|
+
*
|
|
4355
|
+
* Default value is `true`.
|
|
4356
|
+
*
|
|
4357
|
+
* @since 1.150.0
|
|
4358
|
+
*
|
|
4359
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4360
|
+
*/
|
|
4361
|
+
setShowDataSourceFacet(
|
|
4362
|
+
/**
|
|
4363
|
+
* New value for property `showDataSourceFacet`
|
|
4364
|
+
*/
|
|
4365
|
+
bShowDataSourceFacet?: boolean
|
|
4366
|
+
): this;
|
|
4367
|
+
/**
|
|
4368
|
+
* Sets a new value for property {@link #getShowExport showExport}.
|
|
4369
|
+
*
|
|
4370
|
+
* controls whether the export button is shown in the toolbar. When the basket feature is active, the button
|
|
4371
|
+
* opens a menu ("Export Results" / "Export Basket"). Set to false to hide it. Stakeholders currently hiding
|
|
4372
|
+
* the export button via custom CSS targeting [id$="-dataExportButton"] can use this instead.
|
|
4373
|
+
*
|
|
4374
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4375
|
+
*
|
|
4376
|
+
* Default value is `true`.
|
|
4377
|
+
*
|
|
4378
|
+
* @since 1.151.0
|
|
4379
|
+
*
|
|
4380
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4381
|
+
*/
|
|
4382
|
+
setShowExport(
|
|
4383
|
+
/**
|
|
4384
|
+
* New value for property `showExport`
|
|
4385
|
+
*/
|
|
4386
|
+
bShowExport?: boolean
|
|
4387
|
+
): this;
|
|
4124
4388
|
/**
|
|
4125
4389
|
* Sets a new value for property {@link #getShowSelectionToggleButton showSelectionToggleButton}.
|
|
4126
4390
|
*
|
|
@@ -4214,15 +4478,6 @@ declare namespace sap {
|
|
|
4214
4478
|
SearchCompositeControl
|
|
4215
4479
|
>;
|
|
4216
4480
|
|
|
4217
|
-
/**
|
|
4218
|
-
* Event object of the SearchCompositeControl#resultViewSelectionChanged event.
|
|
4219
|
-
*/
|
|
4220
|
-
type SearchCompositeControl$ResultViewSelectionChangedEvent =
|
|
4221
|
-
sap.ui.base.Event<
|
|
4222
|
-
SearchCompositeControl$ResultViewSelectionChangedEventParameters,
|
|
4223
|
-
SearchCompositeControl
|
|
4224
|
-
>;
|
|
4225
|
-
|
|
4226
4481
|
/**
|
|
4227
4482
|
* Event object of the SearchCompositeControl#resultViewTypeChanged event.
|
|
4228
4483
|
*/
|
|
@@ -4268,8 +4523,6 @@ declare namespace sap {
|
|
|
4268
4523
|
}
|
|
4269
4524
|
|
|
4270
4525
|
interface IUI5DefineDependencyNames {
|
|
4271
|
-
"sap/esh/search/ui/controls/basket/CustomBasket": undefined;
|
|
4272
|
-
|
|
4273
4526
|
"sap/esh/search/ui/controls/basket/SearchBasketAddButton": undefined;
|
|
4274
4527
|
|
|
4275
4528
|
"sap/esh/search/ui/controls/resultview/SearchShowDetailButton": undefined;
|