@sapui5/ts-types 1.120.8 → 1.121.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 +50 -18
- package/types/sap.ca.ui.d.ts +1114 -546
- package/types/sap.chart.d.ts +17 -1
- package/types/sap.collaboration.d.ts +185 -64
- package/types/sap.esh.search.ui.d.ts +2 -1960
- package/types/sap.f.d.ts +124 -45
- package/types/sap.fe.core.d.ts +212 -191
- package/types/sap.fe.macros.d.ts +371 -531
- package/types/sap.fe.navigation.d.ts +59 -26
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +7 -0
- package/types/sap.fe.templates.d.ts +16 -11
- package/types/sap.fe.test.d.ts +333 -33
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +3947 -1754
- package/types/sap.insights.d.ts +162 -43
- package/types/sap.m.d.ts +2023 -289
- package/types/sap.makit.d.ts +11 -1
- package/types/sap.me.d.ts +7 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +9 -7
- package/types/sap.rules.ui.d.ts +134 -75
- package/types/sap.sac.df.d.ts +272 -49
- package/types/sap.suite.ui.commons.d.ts +4231 -1008
- package/types/sap.suite.ui.generic.template.d.ts +38 -48
- package/types/sap.suite.ui.microchart.d.ts +66 -1
- package/types/sap.tnt.d.ts +601 -116
- package/types/sap.ui.codeeditor.d.ts +10 -6
- package/types/sap.ui.commons.d.ts +86 -8
- package/types/sap.ui.comp.d.ts +259 -110
- package/types/sap.ui.core.d.ts +471 -186
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +16 -3
- package/types/sap.ui.fl.d.ts +91 -68
- package/types/sap.ui.generic.app.d.ts +250 -193
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +51 -4
- package/types/sap.ui.layout.d.ts +221 -26
- package/types/sap.ui.mdc.d.ts +1516 -787
- package/types/sap.ui.richtexteditor.d.ts +4 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +3 -1
- package/types/sap.ui.support.d.ts +28 -4
- package/types/sap.ui.table.d.ts +65 -11
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +157 -54
- package/types/sap.ui.ux3.d.ts +30 -12
- package/types/sap.ui.vbm.d.ts +5300 -2517
- package/types/sap.ui.vk.d.ts +2742 -836
- package/types/sap.ui.vtm.d.ts +685 -215
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +49 -1
- package/types/sap.ui.webc.main.d.ts +144 -9
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +977 -535
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +55 -5
- package/types/sap.viz.d.ts +86 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +79 -18
- package/types/sap.zen.crosstab.d.ts +83 -15
- package/types/sap.zen.dsh.d.ts +194 -143
package/types/sap.fe.macros.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.121.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace fe {
|
|
@@ -71,111 +71,154 @@ declare namespace sap {
|
|
|
71
71
|
};
|
|
72
72
|
}
|
|
73
73
|
|
|
74
|
-
namespace
|
|
74
|
+
namespace share {
|
|
75
75
|
/**
|
|
76
|
-
*
|
|
76
|
+
* Share Options.
|
|
77
77
|
*/
|
|
78
|
-
type
|
|
78
|
+
type ShareOptions = {};
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
namespace table {
|
|
82
|
+
interface $ActionSettings extends sap.ui.core.$ElementSettings {
|
|
79
83
|
/**
|
|
80
84
|
* Reference to the key of another action already displayed in the toolbar to properly place this one
|
|
81
85
|
*/
|
|
82
|
-
anchor
|
|
86
|
+
anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
87
|
+
|
|
83
88
|
/**
|
|
84
89
|
* Enables or disables the action
|
|
85
90
|
*/
|
|
86
|
-
enabled
|
|
91
|
+
enabled?:
|
|
92
|
+
| boolean
|
|
93
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
94
|
+
| `{${string}}`;
|
|
95
|
+
|
|
87
96
|
/**
|
|
88
97
|
* Unique identifier of the action
|
|
89
98
|
*/
|
|
90
|
-
key
|
|
99
|
+
key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
100
|
+
|
|
91
101
|
/**
|
|
92
102
|
* Defines where this action should be placed relative to the defined anchor
|
|
93
103
|
* Allowed values are `Before` and `After`
|
|
94
104
|
*/
|
|
95
|
-
placement
|
|
105
|
+
placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
106
|
+
|
|
96
107
|
/**
|
|
97
108
|
* Event handler to be called when the user chooses the action
|
|
98
109
|
*/
|
|
99
|
-
press
|
|
110
|
+
press?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
111
|
+
|
|
100
112
|
/**
|
|
101
113
|
* Defines if the action requires a selection.
|
|
102
114
|
*/
|
|
103
|
-
requiresSelection
|
|
115
|
+
requiresSelection?:
|
|
116
|
+
| boolean
|
|
117
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
118
|
+
| `{${string}}`;
|
|
119
|
+
|
|
104
120
|
/**
|
|
105
121
|
* The text that will be displayed for this action
|
|
106
122
|
*/
|
|
107
|
-
text
|
|
108
|
-
}
|
|
123
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
124
|
+
}
|
|
109
125
|
|
|
110
|
-
|
|
111
|
-
* Definition of a custom ActionGroup to be used inside the table toolbar
|
|
112
|
-
*/
|
|
113
|
-
type ActionGroup = {
|
|
114
|
-
/**
|
|
115
|
-
* Defines nested actions
|
|
116
|
-
*/
|
|
117
|
-
actions: sap.fe.macros.table.Action[];
|
|
126
|
+
interface $ActionGroupSettings extends sap.ui.core.$ElementSettings {
|
|
118
127
|
/**
|
|
119
128
|
* Reference to the key of another action or action group already displayed in the toolbar to properly place
|
|
120
129
|
* this one
|
|
121
130
|
*/
|
|
122
|
-
anchor
|
|
131
|
+
anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
132
|
+
|
|
123
133
|
/**
|
|
124
134
|
* Unique identifier of the ActionGroup
|
|
125
135
|
*/
|
|
126
|
-
key
|
|
136
|
+
key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
137
|
+
|
|
127
138
|
/**
|
|
128
139
|
* Defines where this action group should be placed relative to the defined anchor
|
|
129
140
|
* Allowed values are `Before` and `After`
|
|
130
141
|
*/
|
|
131
|
-
placement
|
|
142
|
+
placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
143
|
+
|
|
132
144
|
/**
|
|
133
145
|
* The text that will be displayed for this action group
|
|
134
146
|
*/
|
|
135
|
-
text
|
|
136
|
-
};
|
|
147
|
+
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
137
148
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
149
|
+
/**
|
|
150
|
+
* Defines nested actions
|
|
151
|
+
*/
|
|
152
|
+
actions?:
|
|
153
|
+
| sap.fe.macros.table.Action[]
|
|
154
|
+
| sap.fe.macros.table.Action
|
|
155
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
156
|
+
| `{${string}}`;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
interface $ColumnSettings extends sap.ui.core.$ElementSettings {
|
|
143
160
|
/**
|
|
144
161
|
* Reference to the key of another column already displayed in the table to properly place this one
|
|
145
162
|
*/
|
|
146
|
-
anchor
|
|
163
|
+
anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
164
|
+
|
|
147
165
|
/**
|
|
148
166
|
* The text that will be displayed for this column header
|
|
149
167
|
*/
|
|
150
|
-
header
|
|
168
|
+
header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
169
|
+
|
|
151
170
|
/**
|
|
152
171
|
* Aligns the header as well as the content horizontally
|
|
153
172
|
*/
|
|
154
|
-
horizontalAlign
|
|
173
|
+
horizontalAlign?:
|
|
174
|
+
| string
|
|
175
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
176
|
+
|
|
155
177
|
/**
|
|
156
178
|
* Defines the column importance.
|
|
157
179
|
* You can define which columns should be automatically moved to the pop-in area based on their importance
|
|
158
180
|
*/
|
|
159
|
-
importance
|
|
181
|
+
importance?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
182
|
+
|
|
160
183
|
/**
|
|
161
184
|
* Unique identifier of the column
|
|
162
185
|
*/
|
|
163
|
-
key
|
|
186
|
+
key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
187
|
+
|
|
164
188
|
/**
|
|
165
189
|
* Defines where this column should be placed relative to the defined anchor
|
|
166
190
|
* Allowed values are `Before` and `After`
|
|
167
191
|
*/
|
|
168
|
-
placement
|
|
192
|
+
placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
193
|
+
|
|
169
194
|
/**
|
|
170
195
|
* Defines the column's width.
|
|
171
196
|
* Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
|
|
172
197
|
*/
|
|
173
|
-
width
|
|
198
|
+
width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
199
|
+
|
|
174
200
|
/**
|
|
175
201
|
* Indicates if the column header should be a part of the width calculation.
|
|
176
202
|
*/
|
|
177
|
-
widthIncludingColumnHeader
|
|
178
|
-
|
|
203
|
+
widthIncludingColumnHeader?:
|
|
204
|
+
| boolean
|
|
205
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
206
|
+
| `{${string}}`;
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* Definition of a custom action to be used inside the table toolbar
|
|
211
|
+
*/
|
|
212
|
+
class Action extends sap.ui.core.Element {}
|
|
213
|
+
/**
|
|
214
|
+
* Definition of a custom ActionGroup to be used inside the table toolbar
|
|
215
|
+
*/
|
|
216
|
+
class ActionGroup extends sap.ui.core.Element {}
|
|
217
|
+
/**
|
|
218
|
+
* Definition of a custom column to be used inside the table.
|
|
219
|
+
* The template for the column has to be provided as the default aggregation
|
|
220
|
+
*/
|
|
221
|
+
class Column extends sap.ui.core.Element {}
|
|
179
222
|
|
|
180
223
|
/**
|
|
181
224
|
* Create options for the table.
|
|
@@ -221,199 +264,9 @@ declare namespace sap {
|
|
|
221
264
|
};
|
|
222
265
|
}
|
|
223
266
|
|
|
224
|
-
interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
|
|
225
|
-
/**
|
|
226
|
-
* Defines the path of the context used in the current page or block.
|
|
227
|
-
* This setting is defined by the framework.
|
|
228
|
-
*/
|
|
229
|
-
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
233
|
-
*/
|
|
234
|
-
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
interface $ChartSettings extends sap.fe.macros.$MacroAPISettings {
|
|
238
|
-
/**
|
|
239
|
-
* Metadata path to the entitySet or navigationProperty
|
|
240
|
-
*/
|
|
241
|
-
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
242
|
-
|
|
243
|
-
/**
|
|
244
|
-
* Id of the FilterBar building block associated with the chart.
|
|
245
|
-
*/
|
|
246
|
-
filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
* Specifies the header text that is shown in the chart
|
|
250
|
-
*/
|
|
251
|
-
header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* Controls if the header text should be shown or not
|
|
255
|
-
*/
|
|
256
|
-
headerVisible?:
|
|
257
|
-
| boolean
|
|
258
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
259
|
-
| `{${string}}`;
|
|
260
|
-
|
|
261
|
-
/**
|
|
262
|
-
* Metadata path to the presentation context (UI.Chart with or without a qualifier)
|
|
263
|
-
*/
|
|
264
|
-
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
265
|
-
|
|
266
|
-
/**
|
|
267
|
-
* Controls which options should be enabled for the chart personalization dialog.
|
|
268
|
-
* If it is set to `true`, all possible options for this kind of chart are enabled.
|
|
269
|
-
*
|
|
270
|
-
* If it is set to `false`, personalization is disabled.
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
* You can also provide a more granular control for the personalization by providing a comma-separated list
|
|
275
|
-
* with the options you want to be available.
|
|
276
|
-
*
|
|
277
|
-
* Available options are:
|
|
278
|
-
*
|
|
279
|
-
* - Sort
|
|
280
|
-
*
|
|
281
|
-
* - Type
|
|
282
|
-
*
|
|
283
|
-
* - Item
|
|
284
|
-
*
|
|
285
|
-
* - Filter
|
|
286
|
-
*/
|
|
287
|
-
personalization?:
|
|
288
|
-
| boolean
|
|
289
|
-
| string
|
|
290
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
291
|
-
| `{${string}}`;
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* Defines the selection mode to be used by the chart.
|
|
295
|
-
* Allowed values are `None`, `Single` or `Multiple`
|
|
296
|
-
*/
|
|
297
|
-
selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* Controls the kind of variant management that should be enabled for the chart.
|
|
301
|
-
* Allowed value is `Control`.
|
|
302
|
-
*
|
|
303
|
-
* If set with value `Control`, a variant management control is seen within the chart and the chart is linked
|
|
304
|
-
* to this.
|
|
305
|
-
*
|
|
306
|
-
* If not set with any value, variant management control is not available for this chart.
|
|
307
|
-
*/
|
|
308
|
-
variantManagement?:
|
|
309
|
-
| string
|
|
310
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
311
|
-
|
|
312
|
-
/**
|
|
313
|
-
* Aggregate actions of the chart.
|
|
314
|
-
*/
|
|
315
|
-
actions?:
|
|
316
|
-
| sap.fe.macros.chart.Action[]
|
|
317
|
-
| sap.fe.macros.chart.Action
|
|
318
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
319
|
-
| `{${string}}`;
|
|
320
|
-
}
|
|
321
|
-
|
|
322
267
|
interface $FlexibleColumnLayoutActionsSettings
|
|
323
268
|
extends sap.ui.core.$ControlSettings {}
|
|
324
269
|
|
|
325
|
-
interface $FieldSettings extends sap.fe.macros.$MacroAPISettings {
|
|
326
|
-
/**
|
|
327
|
-
* Defines the path of the context used in the current page or block.
|
|
328
|
-
* This setting is defined by the framework.
|
|
329
|
-
*/
|
|
330
|
-
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
331
|
-
|
|
332
|
-
/**
|
|
333
|
-
* A set of options that can be configured.
|
|
334
|
-
*/
|
|
335
|
-
formatOptions?:
|
|
336
|
-
| sap.fe.macros.FieldFormatOptions
|
|
337
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
338
|
-
| `{${string}}`;
|
|
339
|
-
|
|
340
|
-
/**
|
|
341
|
-
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
342
|
-
*/
|
|
343
|
-
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
344
|
-
|
|
345
|
-
/**
|
|
346
|
-
* An expression that allows you to control the read-only state of the field.
|
|
347
|
-
* If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
|
|
348
|
-
* current state.
|
|
349
|
-
*/
|
|
350
|
-
readOnly?:
|
|
351
|
-
| boolean
|
|
352
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
353
|
-
| `{${string}}`;
|
|
354
|
-
|
|
355
|
-
/**
|
|
356
|
-
* Option to add semantic objects to a field.
|
|
357
|
-
* Valid options are either a single semantic object, a stringified array of semantic objects
|
|
358
|
-
* or a single binding expression returning either a single semantic object or an array of semantic objects
|
|
359
|
-
*/
|
|
360
|
-
semanticObject?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
interface $FilterBarSettings extends sap.fe.macros.$MacroAPISettings {
|
|
364
|
-
/**
|
|
365
|
-
* Defines the path of the context used in the current page or block.
|
|
366
|
-
* This setting is defined by the framework.
|
|
367
|
-
*/
|
|
368
|
-
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* If true, the search is triggered automatically when a filter value is changed.
|
|
372
|
-
*/
|
|
373
|
-
liveMode?:
|
|
374
|
-
| boolean
|
|
375
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
376
|
-
| `{${string}}`;
|
|
377
|
-
|
|
378
|
-
/**
|
|
379
|
-
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
380
|
-
*/
|
|
381
|
-
metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
382
|
-
|
|
383
|
-
/**
|
|
384
|
-
* Handles the visibility of the 'Clear' button on the FilterBar.
|
|
385
|
-
*/
|
|
386
|
-
showClearButton?:
|
|
387
|
-
| boolean
|
|
388
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
389
|
-
| `{${string}}`;
|
|
390
|
-
|
|
391
|
-
/**
|
|
392
|
-
* Displays possible errors during the search in a message box
|
|
393
|
-
*/
|
|
394
|
-
showMessages?:
|
|
395
|
-
| boolean
|
|
396
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
397
|
-
| `{${string}}`;
|
|
398
|
-
|
|
399
|
-
/**
|
|
400
|
-
* Parameter which sets the visibility of the FilterBar building block
|
|
401
|
-
*/
|
|
402
|
-
visible?:
|
|
403
|
-
| boolean
|
|
404
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
405
|
-
| `{${string}}`;
|
|
406
|
-
|
|
407
|
-
/**
|
|
408
|
-
* Aggregate filter fields of the FilterBar building block
|
|
409
|
-
*/
|
|
410
|
-
filterFields?:
|
|
411
|
-
| sap.fe.macros.FilterField[]
|
|
412
|
-
| sap.fe.macros.FilterField
|
|
413
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
414
|
-
| `{${string}}`;
|
|
415
|
-
}
|
|
416
|
-
|
|
417
270
|
interface $FormSettings extends sap.ui.core.$ControlSettings {
|
|
418
271
|
/**
|
|
419
272
|
* Defines the path of the context used in the current page or block.
|
|
@@ -560,6 +413,23 @@ declare namespace sap {
|
|
|
560
413
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
561
414
|
| `{${string}}`;
|
|
562
415
|
|
|
416
|
+
/**
|
|
417
|
+
* With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default
|
|
418
|
+
* The default plugins are "emoticons" "directionality" "image" "table" "link" "powerpaste".
|
|
419
|
+
*/
|
|
420
|
+
excludeDefaultPlugins?:
|
|
421
|
+
| boolean
|
|
422
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
423
|
+
| `{${string}}`;
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* With the 'plugins' attribute you can customize the plugins that will be loaded by the editor.
|
|
427
|
+
*/
|
|
428
|
+
plugins?:
|
|
429
|
+
| any[]
|
|
430
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
431
|
+
| `{${string}}`;
|
|
432
|
+
|
|
563
433
|
/**
|
|
564
434
|
* Use the readOnly attribute to override the edit flow of the page.
|
|
565
435
|
* By setting 'readOnly' to true, a FormattedText will be displayed instead of the editor.
|
|
@@ -603,272 +473,126 @@ declare namespace sap {
|
|
|
603
473
|
| `{${string}}`;
|
|
604
474
|
|
|
605
475
|
/**
|
|
606
|
-
*
|
|
476
|
+
* With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default
|
|
477
|
+
* The default plugins are "emoticons" "directionality" "image" "table" "link" "powerpaste".
|
|
607
478
|
*/
|
|
608
|
-
|
|
609
|
-
| sap.ui.model.Context
|
|
610
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
611
|
-
| `{${string}}`;
|
|
612
|
-
|
|
613
|
-
/**
|
|
614
|
-
* Use the readOnly attribute to override the edit flow of the page.
|
|
615
|
-
* By setting 'readOnly' to true, a FormattedText is displayed instead of the editor.
|
|
616
|
-
*/
|
|
617
|
-
readOnly?:
|
|
479
|
+
excludeDefaultPlugins?:
|
|
618
480
|
| boolean
|
|
619
481
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
620
482
|
| `{${string}}`;
|
|
621
483
|
|
|
622
484
|
/**
|
|
623
|
-
*
|
|
624
|
-
*/
|
|
625
|
-
required?:
|
|
626
|
-
| boolean
|
|
627
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
628
|
-
| `{${string}}`;
|
|
629
|
-
}
|
|
630
|
-
|
|
631
|
-
interface $ShareSettings extends sap.ui.core.$ControlSettings {
|
|
632
|
-
/**
|
|
633
|
-
* Whether the share control should be visible on the screen.
|
|
634
|
-
*/
|
|
635
|
-
visible?:
|
|
636
|
-
| boolean
|
|
637
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
638
|
-
| `{${string}}`;
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
interface $TableSettings extends sap.fe.macros.$MacroAPISettings {
|
|
642
|
-
/**
|
|
643
|
-
* An expression that allows you to control the 'busy' state of the table.
|
|
485
|
+
* The metaPath of the displayed property
|
|
644
486
|
*/
|
|
645
|
-
|
|
646
|
-
|
|
|
487
|
+
metaPath?:
|
|
488
|
+
| sap.ui.model.Context
|
|
647
489
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
648
490
|
| `{${string}}`;
|
|
649
491
|
|
|
650
492
|
/**
|
|
651
|
-
*
|
|
652
|
-
* This setting is defined by the framework.
|
|
653
|
-
*/
|
|
654
|
-
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
655
|
-
|
|
656
|
-
/**
|
|
657
|
-
* A set of options that can be configured.
|
|
493
|
+
* With the 'plugins' attribute you can customize the plugins that will be loaded by the editor.
|
|
658
494
|
*/
|
|
659
|
-
|
|
660
|
-
|
|
|
495
|
+
plugins?:
|
|
496
|
+
| any[]
|
|
661
497
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
662
498
|
| `{${string}}`;
|
|
663
499
|
|
|
664
500
|
/**
|
|
665
|
-
*
|
|
501
|
+
* Use the readOnly attribute to override the edit flow of the page.
|
|
502
|
+
* By setting 'readOnly' to true, a FormattedText is displayed instead of the editor.
|
|
666
503
|
*/
|
|
667
|
-
|
|
504
|
+
readOnly?:
|
|
668
505
|
| boolean
|
|
669
506
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
670
507
|
| `{${string}}`;
|
|
671
508
|
|
|
672
509
|
/**
|
|
673
|
-
*
|
|
510
|
+
* Use the 'required' attribute, to make sure that the editor is filled with some text.
|
|
674
511
|
*/
|
|
675
|
-
|
|
512
|
+
required?:
|
|
676
513
|
| boolean
|
|
677
514
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
678
515
|
| `{${string}}`;
|
|
516
|
+
}
|
|
679
517
|
|
|
518
|
+
interface $ShareSettings extends sap.ui.core.$ControlSettings {
|
|
680
519
|
/**
|
|
681
|
-
*
|
|
520
|
+
* Supported Share options {@link sap.fe.macros.share.ShareOptions }.
|
|
682
521
|
*/
|
|
683
|
-
|
|
684
|
-
|
|
|
522
|
+
shareOptions?:
|
|
523
|
+
| object
|
|
685
524
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
686
525
|
| `{${string}}`;
|
|
687
526
|
|
|
688
527
|
/**
|
|
689
|
-
*
|
|
528
|
+
* Whether the share control should be visible on the screen.
|
|
690
529
|
*/
|
|
691
|
-
|
|
530
|
+
visible?:
|
|
692
531
|
| boolean
|
|
693
532
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
694
533
|
| `{${string}}`;
|
|
534
|
+
}
|
|
695
535
|
|
|
536
|
+
/**
|
|
537
|
+
* API to add parameters to the collection binding infos.
|
|
538
|
+
*/
|
|
539
|
+
class CollectionBindingInfo {
|
|
696
540
|
/**
|
|
697
|
-
*
|
|
698
|
-
*/
|
|
699
|
-
filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
700
|
-
|
|
701
|
-
/**
|
|
702
|
-
* Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
|
|
703
|
-
* This property is not relevant for responsive tables
|
|
704
|
-
*/
|
|
705
|
-
frozenColumnCount?:
|
|
706
|
-
| number
|
|
707
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
708
|
-
| `{${string}}`;
|
|
709
|
-
|
|
710
|
-
/**
|
|
711
|
-
* Specifies the header text that is shown in the table.
|
|
712
|
-
*/
|
|
713
|
-
header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
714
|
-
|
|
715
|
-
/**
|
|
716
|
-
* Controls if the header text should be shown or not.
|
|
541
|
+
* Adds a filter to the filters already present in the binding info.
|
|
717
542
|
*/
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
543
|
+
addFilter(
|
|
544
|
+
/**
|
|
545
|
+
* The {@link sap.ui.model.Filter "filter"} to add
|
|
546
|
+
*/
|
|
547
|
+
customFilter: sap.ui.model.Filter
|
|
548
|
+
): void;
|
|
723
549
|
/**
|
|
724
|
-
*
|
|
550
|
+
* Adds parameters to the select query.
|
|
725
551
|
*/
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
552
|
+
addSelect(
|
|
553
|
+
/**
|
|
554
|
+
* The list or properties to add to the query
|
|
555
|
+
*/
|
|
556
|
+
parameters: string[]
|
|
557
|
+
): void;
|
|
731
558
|
/**
|
|
732
|
-
*
|
|
559
|
+
* Adds a sorter to the sorter(s) already present, or create one if none exists.
|
|
733
560
|
*/
|
|
734
|
-
|
|
735
|
-
|
|
561
|
+
addSorter(
|
|
562
|
+
/**
|
|
563
|
+
* The {@link sap.ui.model.Sorter "sorter"} to add to the query
|
|
564
|
+
*/
|
|
565
|
+
sorter: sap.ui.model.Sorter
|
|
566
|
+
): void;
|
|
736
567
|
/**
|
|
737
|
-
*
|
|
738
|
-
* If it is set to `true`, all possible options for this kind of table are enabled.
|
|
739
|
-
*
|
|
740
|
-
* If it is set to `false`, personalization is disabled.
|
|
741
|
-
*
|
|
568
|
+
* Retrieve the 'serialized' binding info, useful if you want to create your own binding
|
|
742
569
|
*
|
|
743
570
|
*
|
|
744
|
-
*
|
|
745
|
-
* with the options you want to be available.
|
|
746
|
-
*
|
|
747
|
-
* Available options are:
|
|
748
|
-
*
|
|
749
|
-
* - Sort
|
|
750
|
-
*
|
|
751
|
-
* - Column
|
|
752
|
-
*
|
|
753
|
-
* - Filter
|
|
571
|
+
* @returns The {@link sap.fe.macros.CollectionBindingInfo "CollectionBindingInfo"}
|
|
754
572
|
*/
|
|
755
|
-
|
|
756
|
-
| boolean
|
|
757
|
-
| string
|
|
758
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
759
|
-
| `{${string}}`;
|
|
760
|
-
|
|
573
|
+
getBindingInfo(): /* was: sap.fe.macros.CollectionBindingInfo.CollectionBindingInfo */ any;
|
|
761
574
|
/**
|
|
762
|
-
*
|
|
763
|
-
* If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
|
|
764
|
-
* current state.
|
|
765
|
-
*/
|
|
766
|
-
readOnly?:
|
|
767
|
-
| boolean
|
|
768
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
769
|
-
| `{${string}}`;
|
|
770
|
-
|
|
771
|
-
/**
|
|
772
|
-
* Number of rows to be displayed in the table. Does not apply to responsive tables.
|
|
773
|
-
*/
|
|
774
|
-
rowCount?:
|
|
775
|
-
| number
|
|
776
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
777
|
-
| `{${string}}`;
|
|
778
|
-
|
|
779
|
-
/**
|
|
780
|
-
* Defines how the table handles the visible rows. Does not apply to Responsive tables.
|
|
781
|
-
* Allowed values are `Auto`, `Fixed`.
|
|
575
|
+
* Returns the current filters applied to the Table.
|
|
782
576
|
*
|
|
783
|
-
* - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
|
|
784
577
|
*
|
|
785
|
-
*
|
|
786
|
-
* row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
|
|
787
|
-
* less than defined in the `rowCount` property.
|
|
788
|
-
*/
|
|
789
|
-
rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
790
|
-
|
|
791
|
-
/**
|
|
792
|
-
* Defines the selection mode to be used by the table.
|
|
793
|
-
* Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
|
|
794
|
-
* If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
|
|
795
|
-
* the consistent selection mode.
|
|
796
|
-
* If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
|
|
797
|
-
* Fiori guidelines.
|
|
798
|
-
*/
|
|
799
|
-
selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
800
|
-
|
|
801
|
-
/**
|
|
802
|
-
* Defines the type of table that will be used by the building block to render the data.
|
|
803
|
-
* Allowed values are `GridTable` and `ResponsiveTable`
|
|
578
|
+
* @returns The {@link sap.ui.model.Filter "filters"} on the table
|
|
804
579
|
*/
|
|
805
|
-
|
|
806
|
-
|
|
580
|
+
getFilters(): sap.ui.model.Filter | undefined;
|
|
807
581
|
/**
|
|
808
|
-
*
|
|
809
|
-
* Allowed value is `Control`.
|
|
582
|
+
* Returns the current sorters of the Table.
|
|
810
583
|
*
|
|
811
|
-
* If set with value `Control`, a variant management control is seen within the table and the table is linked
|
|
812
|
-
* to this.
|
|
813
584
|
*
|
|
814
|
-
*
|
|
815
|
-
*/
|
|
816
|
-
variantManagement?:
|
|
817
|
-
| string
|
|
818
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
819
|
-
|
|
820
|
-
/**
|
|
821
|
-
* Indicates if the column header should be a part of the width calculation.
|
|
585
|
+
* @returns The {@link sap.ui.model.Sorter "sorters"} on the table
|
|
822
586
|
*/
|
|
823
|
-
|
|
824
|
-
| boolean
|
|
825
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
826
|
-
| `{${string}}`;
|
|
827
|
-
|
|
828
|
-
/**
|
|
829
|
-
* Aggregate actions of the table.
|
|
830
|
-
*/
|
|
831
|
-
actions?:
|
|
832
|
-
| sap.fe.macros.table.Action[]
|
|
833
|
-
| sap.fe.macros.table.Action
|
|
834
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
835
|
-
| `{${string}}`;
|
|
836
|
-
|
|
837
|
-
/**
|
|
838
|
-
* Aggregate columns of the table.
|
|
839
|
-
*/
|
|
840
|
-
columns?:
|
|
841
|
-
| sap.fe.macros.table.Column[]
|
|
842
|
-
| sap.fe.macros.table.Column
|
|
843
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
844
|
-
| `{${string}}`;
|
|
587
|
+
getSorters(): sap.ui.model.Sorter[] | undefined;
|
|
845
588
|
}
|
|
846
|
-
|
|
847
|
-
interface Chart$SelectionChangeEventParameters {}
|
|
848
|
-
|
|
849
|
-
interface Field$ChangeEventParameters {}
|
|
850
|
-
|
|
851
|
-
interface Field$LiveChangeEventParameters {}
|
|
852
|
-
|
|
853
|
-
interface FilterBar$AfterClearEventParameters {}
|
|
854
|
-
|
|
855
|
-
interface FilterBar$FilterChangedEventParameters {}
|
|
856
|
-
|
|
857
|
-
interface FilterBar$SearchEventParameters {}
|
|
858
|
-
|
|
859
|
-
interface Table$RowPressEventParameters {}
|
|
860
|
-
|
|
861
|
-
interface Table$SelectionChangeEventParameters {}
|
|
862
|
-
|
|
863
589
|
/**
|
|
864
590
|
* Base API control for building blocks.
|
|
865
591
|
*/
|
|
866
592
|
class MacroAPI
|
|
867
|
-
|
|
593
|
+
/* was: sap.fe.core.buildingBlocks.BuildingBlockBase */ extends Object
|
|
868
594
|
implements sap.ui.core.IFormContent {
|
|
869
595
|
__implements__sap_ui_core_IFormContent: boolean;
|
|
870
|
-
|
|
871
|
-
constructor();
|
|
872
596
|
}
|
|
873
597
|
/**
|
|
874
598
|
* Building block used to create a chart based on the metadata provided by OData V4.
|
|
@@ -884,18 +608,52 @@ declare namespace sap {
|
|
|
884
608
|
* ```
|
|
885
609
|
*/
|
|
886
610
|
class Chart extends sap.fe.macros.MacroAPI {
|
|
887
|
-
|
|
888
|
-
|
|
611
|
+
/**
|
|
612
|
+
* Gets the key of the current variant in the associated variant management.
|
|
613
|
+
*
|
|
614
|
+
*
|
|
615
|
+
* @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
|
|
616
|
+
*/
|
|
617
|
+
getCurrentVariantKey(): null | string;
|
|
618
|
+
/**
|
|
619
|
+
* Get the presentation variant that is currently applied on the chart.
|
|
620
|
+
*
|
|
621
|
+
*
|
|
622
|
+
* @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
|
|
623
|
+
*/
|
|
624
|
+
getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
|
|
889
625
|
/**
|
|
890
626
|
* Gets contexts from the chart that have been selected by the user.
|
|
891
627
|
*
|
|
628
|
+
*
|
|
892
629
|
* @returns Contexts of the rows selected by the user
|
|
893
630
|
*/
|
|
894
631
|
getSelectedContexts(): sap.ui.model.odata.v4.Context[];
|
|
632
|
+
/**
|
|
633
|
+
* Sets the variant of the provided key in the associated variant management.
|
|
634
|
+
*/
|
|
635
|
+
setCurrentVariantKey(
|
|
636
|
+
/**
|
|
637
|
+
* The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
|
|
638
|
+
*/
|
|
639
|
+
key: string
|
|
640
|
+
): void;
|
|
641
|
+
/**
|
|
642
|
+
* Set the presentation variant for the mdc chart.
|
|
643
|
+
* The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
|
|
644
|
+
* be followed while trying to set the PresentationVariant as needed.
|
|
645
|
+
* The values dimensions, measures and other properties should also be given in the valid format and null
|
|
646
|
+
* or empty values should be avoided.
|
|
647
|
+
* One dimension attribute should have only one role associated with it on a given chart.
|
|
648
|
+
*/
|
|
649
|
+
setPresentationVariant(
|
|
650
|
+
/**
|
|
651
|
+
* the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
|
|
652
|
+
*/
|
|
653
|
+
presentationVariant: sap.fe.navigation.PresentationVariant
|
|
654
|
+
): Promise<void>;
|
|
895
655
|
}
|
|
896
656
|
/**
|
|
897
|
-
* @since 1.93.0
|
|
898
|
-
*
|
|
899
657
|
* Building block for adding overflow toolbar buttons to integrate into the flexible column layout support
|
|
900
658
|
* from Fiori elements.
|
|
901
659
|
* Usage example:
|
|
@@ -904,10 +662,12 @@ declare namespace sap {
|
|
|
904
662
|
*
|
|
905
663
|
* <macro:FlexibleColumnLayoutActions />
|
|
906
664
|
* ```
|
|
665
|
+
*
|
|
666
|
+
*
|
|
667
|
+
*
|
|
668
|
+
* @since 1.93.0
|
|
907
669
|
*/
|
|
908
|
-
class FlexibleColumnLayoutActions extends sap.ui.core.Control {
|
|
909
|
-
constructor();
|
|
910
|
-
}
|
|
670
|
+
class FlexibleColumnLayoutActions extends sap.ui.core.Control {}
|
|
911
671
|
/**
|
|
912
672
|
* Building block for creating a field based on the metadata provided by OData V4.
|
|
913
673
|
*
|
|
@@ -923,11 +683,10 @@ declare namespace sap {
|
|
|
923
683
|
* ```
|
|
924
684
|
*/
|
|
925
685
|
class Field extends sap.fe.macros.MacroAPI {
|
|
926
|
-
constructor();
|
|
927
|
-
|
|
928
686
|
/**
|
|
929
687
|
* Adds a message to the field.
|
|
930
688
|
*
|
|
689
|
+
*
|
|
931
690
|
* @returns The id of the message
|
|
932
691
|
*/
|
|
933
692
|
addMessage(
|
|
@@ -953,9 +712,17 @@ declare namespace sap {
|
|
|
953
712
|
type?: sap.ui.core.MessageType;
|
|
954
713
|
}
|
|
955
714
|
): string;
|
|
715
|
+
/**
|
|
716
|
+
* Gets the current enablement state of the field.
|
|
717
|
+
*
|
|
718
|
+
*
|
|
719
|
+
* @returns Boolean value with the enablement state
|
|
720
|
+
*/
|
|
721
|
+
getEnabled(): boolean;
|
|
956
722
|
/**
|
|
957
723
|
* Retrieves the current value of the field.
|
|
958
724
|
*
|
|
725
|
+
*
|
|
959
726
|
* @returns The current value of the field
|
|
960
727
|
*/
|
|
961
728
|
getValue(): boolean | string;
|
|
@@ -968,6 +735,20 @@ declare namespace sap {
|
|
|
968
735
|
*/
|
|
969
736
|
id: string
|
|
970
737
|
): void;
|
|
738
|
+
/**
|
|
739
|
+
* Sets the current enablement state of the field.
|
|
740
|
+
*
|
|
741
|
+
*
|
|
742
|
+
* @returns The current field reference
|
|
743
|
+
*/
|
|
744
|
+
setEnabled(): sap.ui.core.Control;
|
|
745
|
+
/**
|
|
746
|
+
* Sets the current value of the field.
|
|
747
|
+
*
|
|
748
|
+
*
|
|
749
|
+
* @returns The current field reference
|
|
750
|
+
*/
|
|
751
|
+
setValue(): sap.ui.core.Control;
|
|
971
752
|
}
|
|
972
753
|
/**
|
|
973
754
|
* Building block for creating a FilterBar based on the metadata provided by OData V4.
|
|
@@ -983,32 +764,105 @@ declare namespace sap {
|
|
|
983
764
|
* ```
|
|
984
765
|
*/
|
|
985
766
|
class FilterBar extends sap.fe.macros.MacroAPI {
|
|
986
|
-
constructor();
|
|
987
|
-
|
|
988
767
|
/**
|
|
989
768
|
* Get the Active Filters Text Summary for the filter bar.
|
|
990
769
|
*
|
|
770
|
+
*
|
|
991
771
|
* @returns Active filters summary as text
|
|
992
772
|
*/
|
|
993
773
|
getActiveFiltersText(): string;
|
|
774
|
+
/**
|
|
775
|
+
* Gets the key of the current variant in the associated variant management.
|
|
776
|
+
*
|
|
777
|
+
*
|
|
778
|
+
* @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
|
|
779
|
+
*/
|
|
780
|
+
getCurrentVariantKey(): null | string;
|
|
781
|
+
/**
|
|
782
|
+
* Determines whether the field is enabled or disabled.
|
|
783
|
+
*
|
|
784
|
+
*
|
|
785
|
+
* @returns Whether the filterField is enabled or disabled.
|
|
786
|
+
*/
|
|
787
|
+
getFilterFieldEnabled(
|
|
788
|
+
/**
|
|
789
|
+
* Name of the field.
|
|
790
|
+
*/
|
|
791
|
+
name: string
|
|
792
|
+
): boolean;
|
|
793
|
+
/**
|
|
794
|
+
* Gets the visibility of a filter field.
|
|
795
|
+
*
|
|
796
|
+
*
|
|
797
|
+
* @returns A {@link Promise } that resolves to check whether the filter field is visible or not.
|
|
798
|
+
*/
|
|
799
|
+
getFilterFieldVisible(
|
|
800
|
+
/**
|
|
801
|
+
* The path to the property as a condition path
|
|
802
|
+
*/
|
|
803
|
+
conditionPath: string
|
|
804
|
+
): Promise<boolean>;
|
|
994
805
|
/**
|
|
995
806
|
* Provides all the filters that are currently active
|
|
996
807
|
* along with the search expression.
|
|
997
808
|
*
|
|
809
|
+
*
|
|
998
810
|
* @returns An array of active filters and the search expression.
|
|
999
811
|
*/
|
|
1000
812
|
getFilters(): object;
|
|
1001
813
|
/**
|
|
1002
814
|
* Get the selection variant from the filter bar.
|
|
1003
815
|
*
|
|
816
|
+
*
|
|
1004
817
|
* @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
|
|
1005
818
|
*/
|
|
1006
819
|
getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
|
|
820
|
+
/**
|
|
821
|
+
* Sets the new selected variant in the associated variant management.
|
|
822
|
+
*/
|
|
823
|
+
setCurrentVariantKey(
|
|
824
|
+
/**
|
|
825
|
+
* Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
|
|
826
|
+
* ignored.
|
|
827
|
+
*/
|
|
828
|
+
key: string
|
|
829
|
+
): void;
|
|
830
|
+
/**
|
|
831
|
+
* Sets the enablement of the field.
|
|
832
|
+
*/
|
|
833
|
+
setFilterFieldEnabled(
|
|
834
|
+
/**
|
|
835
|
+
* Name of the field that should be enabled or disabled.
|
|
836
|
+
*/
|
|
837
|
+
name: string,
|
|
838
|
+
/**
|
|
839
|
+
* Whether the field should be enabled or disabled.
|
|
840
|
+
*/
|
|
841
|
+
enabled: boolean
|
|
842
|
+
): void;
|
|
843
|
+
/**
|
|
844
|
+
* Shows or hides any filter field from the filter bar.
|
|
845
|
+
* The property will not be hidden inside the adaptation dialog and may be re-added.
|
|
846
|
+
*
|
|
847
|
+
*
|
|
848
|
+
* @returns A {@link Promise } resolving once the change in visibility was applied
|
|
849
|
+
*/
|
|
850
|
+
setFilterFieldVisible(
|
|
851
|
+
/**
|
|
852
|
+
* The path to the property as a condition path
|
|
853
|
+
*/
|
|
854
|
+
conditionPath: string,
|
|
855
|
+
/**
|
|
856
|
+
* Whether it should be shown or hidden
|
|
857
|
+
*/
|
|
858
|
+
visible: boolean
|
|
859
|
+
): Promise<void>;
|
|
1007
860
|
/**
|
|
1008
861
|
* Set the filter values for the given property in the filter bar.
|
|
1009
862
|
* The filter values can be either a single value or an array of values.
|
|
1010
863
|
* Each filter value must be represented as a primitive value.
|
|
1011
864
|
*
|
|
865
|
+
*
|
|
1012
866
|
* @returns A promise for asynchronous handling
|
|
1013
867
|
*/
|
|
1014
868
|
setFilterValues(
|
|
@@ -1036,17 +890,24 @@ declare namespace sap {
|
|
|
1036
890
|
* Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
|
|
1037
891
|
* existing filters and then apply the SelectionVariant values.
|
|
1038
892
|
*
|
|
893
|
+
*
|
|
1039
894
|
* @returns A promise for asynchronous handling
|
|
1040
895
|
*/
|
|
1041
896
|
setSelectionVariant(
|
|
1042
897
|
/**
|
|
1043
898
|
* The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
|
|
1044
899
|
*/
|
|
1045
|
-
selectionVariant: sap.fe.navigation.SelectionVariant
|
|
1046
|
-
|
|
900
|
+
selectionVariant: sap.fe.navigation.SelectionVariant,
|
|
901
|
+
/**
|
|
902
|
+
* Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
|
|
903
|
+
* to display the filter value descriptions, instead of loading them from the backend
|
|
904
|
+
*/
|
|
905
|
+
prefillDescriptions?: boolean
|
|
906
|
+
): Promise<any>;
|
|
1047
907
|
/**
|
|
1048
908
|
* Triggers the API search on the filter bar.
|
|
1049
909
|
*
|
|
910
|
+
*
|
|
1050
911
|
* @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
|
|
1051
912
|
*/
|
|
1052
913
|
triggerSearch(): Promise<object | undefined>;
|
|
@@ -1065,35 +926,24 @@ declare namespace sap {
|
|
|
1065
926
|
* <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
|
|
1066
927
|
* ```
|
|
1067
928
|
*/
|
|
1068
|
-
class Form extends sap.ui.core.Control {
|
|
1069
|
-
constructor();
|
|
1070
|
-
}
|
|
929
|
+
class Form extends sap.ui.core.Control {}
|
|
1071
930
|
/**
|
|
1072
|
-
* @since 1.90.0
|
|
1073
|
-
*
|
|
1074
931
|
* Building block used to create a form element based on the metadata provided by OData V4.
|
|
932
|
+
*
|
|
933
|
+
* @since 1.90.0
|
|
1075
934
|
*/
|
|
1076
|
-
class FormElement extends sap.ui.core.Control {
|
|
1077
|
-
constructor();
|
|
1078
|
-
}
|
|
935
|
+
class FormElement extends sap.ui.core.Control {}
|
|
1079
936
|
/**
|
|
1080
937
|
* Building block used to create a KPI tag.
|
|
1081
938
|
*/
|
|
1082
|
-
class KPITag extends sap.ui.core.Control {
|
|
1083
|
-
constructor();
|
|
1084
|
-
}
|
|
939
|
+
class KPITag extends sap.ui.core.Control {}
|
|
1085
940
|
/**
|
|
1086
|
-
* @since 1.93.0
|
|
1087
|
-
*
|
|
1088
941
|
* Building block used to create a MicroChart based on the metadata provided by OData V4.
|
|
942
|
+
*
|
|
943
|
+
* @since 1.93.0
|
|
1089
944
|
*/
|
|
1090
|
-
class MicroChart extends sap.ui.core.Control {
|
|
1091
|
-
constructor();
|
|
1092
|
-
}
|
|
945
|
+
class MicroChart extends sap.ui.core.Control {}
|
|
1093
946
|
/**
|
|
1094
|
-
* @since 1.118.0
|
|
1095
|
-
* @experimental (since 1.118.0)
|
|
1096
|
-
*
|
|
1097
947
|
* Building block for creating a MultiValueField based on the metadata provided by OData V4.
|
|
1098
948
|
*
|
|
1099
949
|
*
|
|
@@ -1111,13 +961,13 @@ declare namespace sap {
|
|
|
1111
961
|
* metaPath="{dataField>}"
|
|
1112
962
|
* />
|
|
1113
963
|
* ```
|
|
964
|
+
*
|
|
965
|
+
*
|
|
966
|
+
* @since 1.118.0
|
|
967
|
+
* @experimental (since 1.118.0)
|
|
1114
968
|
*/
|
|
1115
|
-
class MultiValueField extends sap.ui.core.Control {
|
|
1116
|
-
constructor();
|
|
1117
|
-
}
|
|
969
|
+
class MultiValueField extends sap.ui.core.Control {}
|
|
1118
970
|
/**
|
|
1119
|
-
* @since 1.94.0
|
|
1120
|
-
*
|
|
1121
971
|
* Building block used to create a paginator control.
|
|
1122
972
|
* Usage example:
|
|
1123
973
|
*
|
|
@@ -1125,31 +975,29 @@ declare namespace sap {
|
|
|
1125
975
|
*
|
|
1126
976
|
* <macro:Paginator />
|
|
1127
977
|
* ```
|
|
978
|
+
*
|
|
979
|
+
*
|
|
980
|
+
*
|
|
981
|
+
* @since 1.94.0
|
|
1128
982
|
*/
|
|
1129
|
-
class Paginator extends sap.ui.core.Control {
|
|
1130
|
-
constructor();
|
|
1131
|
-
}
|
|
983
|
+
class Paginator extends sap.ui.core.Control {}
|
|
1132
984
|
/**
|
|
1133
|
-
* @since 1.117.0
|
|
1134
|
-
*
|
|
1135
985
|
* Building block that exposes the RichTextEditor UI5 control.
|
|
1136
986
|
* It's used to enter formatted text, and uses the third-party component called TinyMCE.
|
|
987
|
+
*
|
|
988
|
+
*
|
|
989
|
+
* @since 1.117.0
|
|
1137
990
|
*/
|
|
1138
|
-
class RichTextEditor extends sap.ui.core.Control {
|
|
1139
|
-
constructor();
|
|
1140
|
-
}
|
|
991
|
+
class RichTextEditor extends sap.ui.core.Control {}
|
|
1141
992
|
/**
|
|
1142
|
-
* @since 1.117.0
|
|
1143
|
-
*
|
|
1144
993
|
* Metadata-driven building block that exposes the RichTextEditor UI5 control.
|
|
1145
994
|
* It's used to enter formatted text and uses the third-party component called TinyMCE.
|
|
995
|
+
*
|
|
996
|
+
*
|
|
997
|
+
* @since 1.117.0
|
|
1146
998
|
*/
|
|
1147
|
-
class RichTextEditorWithMetadata extends sap.ui.core.Control {
|
|
1148
|
-
constructor();
|
|
1149
|
-
}
|
|
999
|
+
class RichTextEditorWithMetadata extends sap.ui.core.Control {}
|
|
1150
1000
|
/**
|
|
1151
|
-
* @since 1.93.0
|
|
1152
|
-
*
|
|
1153
1001
|
* Building block used to create the ‘Share’ functionality.
|
|
1154
1002
|
*
|
|
1155
1003
|
*
|
|
@@ -1169,17 +1017,25 @@ declare namespace sap {
|
|
|
1169
1017
|
* visible="true"
|
|
1170
1018
|
* />
|
|
1171
1019
|
* ```
|
|
1020
|
+
*
|
|
1021
|
+
*
|
|
1022
|
+
*
|
|
1023
|
+
* @since 1.93.0
|
|
1172
1024
|
*/
|
|
1173
|
-
class Share extends sap.ui.core.Control {
|
|
1174
|
-
constructor();
|
|
1175
|
-
}
|
|
1025
|
+
class Share extends sap.ui.core.Control {}
|
|
1176
1026
|
/**
|
|
1177
1027
|
* Building block used to create a table based on the metadata provided by OData V4.
|
|
1178
1028
|
*
|
|
1179
1029
|
*
|
|
1180
|
-
* Usually, a LineItem or
|
|
1181
|
-
* be used to display an EntitySet.
|
|
1030
|
+
* Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
|
|
1031
|
+
* the Table building block can also be used to display an EntitySet.
|
|
1032
|
+
*
|
|
1033
|
+
*
|
|
1034
|
+
* If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
|
|
1182
1035
|
*
|
|
1036
|
+
*
|
|
1037
|
+
* If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
|
|
1038
|
+
* also has a UI.LineItem as the first property of the Visualizations.
|
|
1183
1039
|
* Usage example:
|
|
1184
1040
|
*
|
|
1185
1041
|
* ```javascript
|
|
@@ -1188,13 +1044,12 @@ declare namespace sap {
|
|
|
1188
1044
|
* ```
|
|
1189
1045
|
*/
|
|
1190
1046
|
class Table extends sap.fe.macros.MacroAPI {
|
|
1191
|
-
constructor();
|
|
1192
|
-
|
|
1193
1047
|
/**
|
|
1194
1048
|
* Adds a message to the table.
|
|
1195
1049
|
* The message applies to the whole table and not to an individual table row.
|
|
1196
1050
|
*
|
|
1197
1051
|
*
|
|
1052
|
+
*
|
|
1198
1053
|
* @returns The ID of the message
|
|
1199
1054
|
*/
|
|
1200
1055
|
addMessage(
|
|
@@ -1220,9 +1075,17 @@ declare namespace sap {
|
|
|
1220
1075
|
type?: sap.ui.core.MessageType;
|
|
1221
1076
|
}
|
|
1222
1077
|
): string;
|
|
1078
|
+
/**
|
|
1079
|
+
* Get the presentation variant that is currently applied on the table.
|
|
1080
|
+
*
|
|
1081
|
+
*
|
|
1082
|
+
* @returns The presentation variant applied to the table
|
|
1083
|
+
*/
|
|
1084
|
+
getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
|
|
1223
1085
|
/**
|
|
1224
1086
|
* Gets contexts from the table that have been selected by the user.
|
|
1225
1087
|
*
|
|
1088
|
+
*
|
|
1226
1089
|
* @returns Contexts of the rows selected by the user
|
|
1227
1090
|
*/
|
|
1228
1091
|
getSelectedContexts(): sap.ui.model.odata.v4.Context[];
|
|
@@ -1239,6 +1102,15 @@ declare namespace sap {
|
|
|
1239
1102
|
*/
|
|
1240
1103
|
id: string
|
|
1241
1104
|
): void;
|
|
1105
|
+
/**
|
|
1106
|
+
* Set a new presentation variant to the table.
|
|
1107
|
+
*/
|
|
1108
|
+
setPresentationVariant(
|
|
1109
|
+
/**
|
|
1110
|
+
* The new presentation variant that is to be set on the table.
|
|
1111
|
+
*/
|
|
1112
|
+
tablePV: sap.fe.navigation.PresentationVariant
|
|
1113
|
+
): Promise<void>;
|
|
1242
1114
|
}
|
|
1243
1115
|
|
|
1244
1116
|
/**
|
|
@@ -1332,52 +1204,14 @@ declare namespace sap {
|
|
|
1332
1204
|
*/
|
|
1333
1205
|
showMessages: boolean;
|
|
1334
1206
|
};
|
|
1335
|
-
|
|
1336
|
-
type Chart$SelectionChangeEvent = sap.ui.base.Event<
|
|
1337
|
-
Chart$SelectionChangeEventParameters,
|
|
1338
|
-
Chart
|
|
1339
|
-
>;
|
|
1340
|
-
|
|
1341
|
-
type Field$ChangeEvent = sap.ui.base.Event<
|
|
1342
|
-
Field$ChangeEventParameters,
|
|
1343
|
-
Field
|
|
1344
|
-
>;
|
|
1345
|
-
|
|
1346
|
-
type Field$LiveChangeEvent = sap.ui.base.Event<
|
|
1347
|
-
Field$LiveChangeEventParameters,
|
|
1348
|
-
Field
|
|
1349
|
-
>;
|
|
1350
|
-
|
|
1351
|
-
type FilterBar$AfterClearEvent = sap.ui.base.Event<
|
|
1352
|
-
FilterBar$AfterClearEventParameters,
|
|
1353
|
-
FilterBar
|
|
1354
|
-
>;
|
|
1355
|
-
|
|
1356
|
-
type FilterBar$FilterChangedEvent = sap.ui.base.Event<
|
|
1357
|
-
FilterBar$FilterChangedEventParameters,
|
|
1358
|
-
FilterBar
|
|
1359
|
-
>;
|
|
1360
|
-
|
|
1361
|
-
type FilterBar$SearchEvent = sap.ui.base.Event<
|
|
1362
|
-
FilterBar$SearchEventParameters,
|
|
1363
|
-
FilterBar
|
|
1364
|
-
>;
|
|
1365
|
-
|
|
1366
|
-
type Table$RowPressEvent = sap.ui.base.Event<
|
|
1367
|
-
Table$RowPressEventParameters,
|
|
1368
|
-
Table
|
|
1369
|
-
>;
|
|
1370
|
-
|
|
1371
|
-
type Table$SelectionChangeEvent = sap.ui.base.Event<
|
|
1372
|
-
Table$SelectionChangeEventParameters,
|
|
1373
|
-
Table
|
|
1374
|
-
>;
|
|
1375
1207
|
}
|
|
1376
1208
|
}
|
|
1377
1209
|
|
|
1378
1210
|
interface IUI5DefineDependencyNames {
|
|
1379
1211
|
"sap/fe/macros/chart/ChartAPI": undefined;
|
|
1380
1212
|
|
|
1213
|
+
"sap/fe/macros/CollectionBindingInfo": undefined;
|
|
1214
|
+
|
|
1381
1215
|
"sap/fe/macros/fcl/FlexibleColumnLayoutActions.block": undefined;
|
|
1382
1216
|
|
|
1383
1217
|
"sap/fe/macros/field/FieldAPI": undefined;
|
|
@@ -1406,6 +1240,12 @@ declare namespace sap {
|
|
|
1406
1240
|
|
|
1407
1241
|
"sap/fe/macros/share/Share.block": undefined;
|
|
1408
1242
|
|
|
1243
|
+
"sap/fe/macros/table/Action": undefined;
|
|
1244
|
+
|
|
1245
|
+
"sap/fe/macros/table/ActionGroup": undefined;
|
|
1246
|
+
|
|
1247
|
+
"sap/fe/macros/table/Column": undefined;
|
|
1248
|
+
|
|
1409
1249
|
"sap/fe/macros/table/TableAPI": undefined;
|
|
1410
1250
|
}
|
|
1411
1251
|
}
|