@sapui5/types 1.113.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/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,975 @@
|
|
|
1
|
+
// For Library Version: 1.111.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/fe/macros/MacroAPI" {
|
|
4
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
5
|
+
|
|
6
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Base API control for building blocks.
|
|
10
|
+
*/
|
|
11
|
+
export default class MacroAPI extends Control {
|
|
12
|
+
constructor();
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export interface $MacroAPISettings extends $ControlSettings {
|
|
16
|
+
/**
|
|
17
|
+
* Defines the path of the context used in the current page or block.
|
|
18
|
+
* This setting is defined by the framework.
|
|
19
|
+
*/
|
|
20
|
+
contextPath?: string | PropertyBindingInfo;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
24
|
+
*/
|
|
25
|
+
metaPath?: string | PropertyBindingInfo;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
declare module "sap/fe/macros/chart/ChartAPI" {
|
|
30
|
+
import {
|
|
31
|
+
default as MacroAPI,
|
|
32
|
+
$MacroAPISettings,
|
|
33
|
+
} from "sap/fe/macros/MacroAPI";
|
|
34
|
+
|
|
35
|
+
import Context from "sap/ui/model/odata/v4/Context";
|
|
36
|
+
|
|
37
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Building block used to create a chart based on the metadata provided by OData V4.
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
* Usually, a contextPath and metaPath is expected.
|
|
44
|
+
* Usage example:
|
|
45
|
+
*
|
|
46
|
+
* ```javascript
|
|
47
|
+
*
|
|
48
|
+
* <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
export default class Chart extends MacroAPI {
|
|
52
|
+
constructor();
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Gets contexts from the chart that have been selected by the user.
|
|
56
|
+
*
|
|
57
|
+
* @returns Contexts of the rows selected by the user
|
|
58
|
+
*/
|
|
59
|
+
getSelectedContexts(): Context[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Definition of a custom action to be used inside the chart toolbar
|
|
63
|
+
*/
|
|
64
|
+
export type Action = {
|
|
65
|
+
/**
|
|
66
|
+
* Reference to the key of another action already displayed in the toolbar to properly place this one
|
|
67
|
+
*/
|
|
68
|
+
anchor: string;
|
|
69
|
+
/**
|
|
70
|
+
* Enables or disables the action
|
|
71
|
+
*/
|
|
72
|
+
enabled: boolean;
|
|
73
|
+
/**
|
|
74
|
+
* Unique identifier of the action
|
|
75
|
+
*/
|
|
76
|
+
key: string;
|
|
77
|
+
/**
|
|
78
|
+
* Defines where this action should be placed relative to the defined anchor
|
|
79
|
+
* Allowed values are `Before` and `After`
|
|
80
|
+
*/
|
|
81
|
+
placement: string;
|
|
82
|
+
/**
|
|
83
|
+
* Event handler to be called when the user chooses the action
|
|
84
|
+
*/
|
|
85
|
+
press: string;
|
|
86
|
+
/**
|
|
87
|
+
* Defines if the action requires a selection.
|
|
88
|
+
*/
|
|
89
|
+
requiresSelection: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* The text that will be displayed for this action
|
|
92
|
+
*/
|
|
93
|
+
text: string;
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Definition of a custom action group to be used inside the chart toolbar
|
|
98
|
+
*/
|
|
99
|
+
export type ActionGroup = {
|
|
100
|
+
/**
|
|
101
|
+
* Defines nested actions
|
|
102
|
+
*/
|
|
103
|
+
actions: undefined[];
|
|
104
|
+
/**
|
|
105
|
+
* Reference to the key of another action or action group already displayed in the toolbar to properly place
|
|
106
|
+
* this one
|
|
107
|
+
*/
|
|
108
|
+
anchor: string;
|
|
109
|
+
/**
|
|
110
|
+
* Unique identifier of the action
|
|
111
|
+
*/
|
|
112
|
+
key: string;
|
|
113
|
+
/**
|
|
114
|
+
* Defines where this action group should be placed relative to the defined anchor
|
|
115
|
+
* Allowed values are `Before` and `After`
|
|
116
|
+
*/
|
|
117
|
+
placement: string;
|
|
118
|
+
/**
|
|
119
|
+
* The text that will be displayed for this action group
|
|
120
|
+
*/
|
|
121
|
+
text: string;
|
|
122
|
+
};
|
|
123
|
+
|
|
124
|
+
export interface $ChartSettings extends $MacroAPISettings {
|
|
125
|
+
/**
|
|
126
|
+
* Metadata path to the entitySet or navigationProperty
|
|
127
|
+
*/
|
|
128
|
+
contextPath?: string | PropertyBindingInfo;
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Id of the FilterBar building block associated with the chart.
|
|
132
|
+
*/
|
|
133
|
+
filterBar?: string | PropertyBindingInfo;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Specifies the header text that is shown in the chart
|
|
137
|
+
*/
|
|
138
|
+
header?: string | PropertyBindingInfo;
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* Controls if the header text should be shown or not
|
|
142
|
+
*/
|
|
143
|
+
headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* ID of the chart
|
|
147
|
+
*/
|
|
148
|
+
id?: string | PropertyBindingInfo;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Metadata path to the presentation context (UI.Chart with or without a qualifier)
|
|
152
|
+
*/
|
|
153
|
+
metaPath?: string | PropertyBindingInfo;
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* Parameter which sets the personalization of the MDC_Chart
|
|
157
|
+
*/
|
|
158
|
+
personalization?: boolean | string | PropertyBindingInfo | `{${string}}`;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Specifies the selection mode
|
|
162
|
+
*/
|
|
163
|
+
selectionMode?: string | PropertyBindingInfo;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* This is the parameter that specifies variant management for chart
|
|
167
|
+
*/
|
|
168
|
+
variantManagement?: string | PropertyBindingInfo;
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* Aggregate actions of the chart.
|
|
172
|
+
*/
|
|
173
|
+
actions?: Action;
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
declare module "sap/fe/macros/field/FieldAPI" {
|
|
178
|
+
import {
|
|
179
|
+
default as MacroAPI,
|
|
180
|
+
$MacroAPISettings,
|
|
181
|
+
} from "sap/fe/macros/MacroAPI";
|
|
182
|
+
|
|
183
|
+
import { MessageType } from "sap/ui/core/library";
|
|
184
|
+
|
|
185
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Building block for creating a field based on the metadata provided by OData V4.
|
|
189
|
+
*
|
|
190
|
+
*
|
|
191
|
+
* Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
|
|
192
|
+
* property from the entity type.
|
|
193
|
+
* Usage example:
|
|
194
|
+
*
|
|
195
|
+
* ```javascript
|
|
196
|
+
*
|
|
197
|
+
* <macro:Field id="MyField" metaPath="MyProperty" />
|
|
198
|
+
* ```
|
|
199
|
+
*/
|
|
200
|
+
export default class Field extends MacroAPI {
|
|
201
|
+
constructor();
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Adds a message to the field.
|
|
205
|
+
*
|
|
206
|
+
* @returns The id of the message
|
|
207
|
+
*/
|
|
208
|
+
addMessage(
|
|
209
|
+
/**
|
|
210
|
+
* undefined
|
|
211
|
+
*/
|
|
212
|
+
parameters: {
|
|
213
|
+
/**
|
|
214
|
+
* Message description
|
|
215
|
+
*/
|
|
216
|
+
description?: string;
|
|
217
|
+
/**
|
|
218
|
+
* Message text
|
|
219
|
+
*/
|
|
220
|
+
message?: string;
|
|
221
|
+
/**
|
|
222
|
+
* True if the message is persistent
|
|
223
|
+
*/
|
|
224
|
+
persistent?: boolean;
|
|
225
|
+
/**
|
|
226
|
+
* Type of the message
|
|
227
|
+
*/
|
|
228
|
+
type?: MessageType | keyof typeof MessageType;
|
|
229
|
+
}
|
|
230
|
+
): string;
|
|
231
|
+
/**
|
|
232
|
+
* Retrieves the current value of the field.
|
|
233
|
+
*
|
|
234
|
+
* @returns The current value of the field
|
|
235
|
+
*/
|
|
236
|
+
getValue(): boolean | string;
|
|
237
|
+
/**
|
|
238
|
+
* Removes a message from the field.
|
|
239
|
+
*/
|
|
240
|
+
removeMessage(
|
|
241
|
+
/**
|
|
242
|
+
* The id of the message
|
|
243
|
+
*/
|
|
244
|
+
id: string
|
|
245
|
+
): void;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* Additional format options for the field.
|
|
249
|
+
*/
|
|
250
|
+
export type FieldFormatOptions = {
|
|
251
|
+
/**
|
|
252
|
+
* Defines how the field value and associated text will be displayed together.
|
|
253
|
+
*
|
|
254
|
+
* Allowed values are "Value", "Description", "DescriptionValue" and "ValueDescription"
|
|
255
|
+
*/
|
|
256
|
+
displayMode: string;
|
|
257
|
+
/**
|
|
258
|
+
* Defines if and how the field measure will be displayed.
|
|
259
|
+
*
|
|
260
|
+
* Allowed values are "Hidden" and "ReadOnly"
|
|
261
|
+
*/
|
|
262
|
+
measureDisplayMode: string;
|
|
263
|
+
/**
|
|
264
|
+
* Defines if the date part of a date time with timezone field should be shown.
|
|
265
|
+
*
|
|
266
|
+
* The dateTimeOffset field must have a timezone annotation.
|
|
267
|
+
*
|
|
268
|
+
* The default value is true.
|
|
269
|
+
*/
|
|
270
|
+
showDate: boolean;
|
|
271
|
+
/**
|
|
272
|
+
* Defines if the time part of a date time with timezone field should be shown.
|
|
273
|
+
*
|
|
274
|
+
* The dateTimeOffset field must have a timezone annotation.
|
|
275
|
+
*
|
|
276
|
+
* The default value is true.
|
|
277
|
+
*/
|
|
278
|
+
showTime: boolean;
|
|
279
|
+
/**
|
|
280
|
+
* Defines if the timezone part of a date time with timezone field should be shown.
|
|
281
|
+
*
|
|
282
|
+
* The dateTimeOffset field must have a timezone annotation.
|
|
283
|
+
*
|
|
284
|
+
* The default value is true.
|
|
285
|
+
*/
|
|
286
|
+
showTimezone: boolean;
|
|
287
|
+
/**
|
|
288
|
+
* Defines how the full text will be displayed.
|
|
289
|
+
*
|
|
290
|
+
* Allowed values are "InPlace" and "Popover"
|
|
291
|
+
*/
|
|
292
|
+
textExpandBehaviorDisplay: string;
|
|
293
|
+
/**
|
|
294
|
+
* Maximum number of lines for multiline texts in edit mode.
|
|
295
|
+
*/
|
|
296
|
+
textLinesEdit: number;
|
|
297
|
+
/**
|
|
298
|
+
* Maximum number of characters from the beginning of the text field that are shown initially.
|
|
299
|
+
*/
|
|
300
|
+
textMaxCharactersDisplay: number;
|
|
301
|
+
/**
|
|
302
|
+
* Defines the maximum number of characters for the multiline text value.
|
|
303
|
+
*
|
|
304
|
+
* If a multiline text exceeds the maximum number of allowed characters, the counter below the input field
|
|
305
|
+
* displays the exact number.
|
|
306
|
+
*/
|
|
307
|
+
textMaxLength: number;
|
|
308
|
+
/**
|
|
309
|
+
* Maximum number of lines that multiline texts in edit mode can grow to.
|
|
310
|
+
*/
|
|
311
|
+
textMaxLines: number;
|
|
312
|
+
};
|
|
313
|
+
|
|
314
|
+
export interface $FieldSettings extends $MacroAPISettings {
|
|
315
|
+
/**
|
|
316
|
+
* Defines the path of the context used in the current page or block.
|
|
317
|
+
* This setting is defined by the framework.
|
|
318
|
+
*/
|
|
319
|
+
contextPath?: string | PropertyBindingInfo;
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* A set of options that can be configured.
|
|
323
|
+
*/
|
|
324
|
+
formatOptions?: FieldFormatOptions | PropertyBindingInfo | `{${string}}`;
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* The identifier of the Field control.
|
|
328
|
+
*/
|
|
329
|
+
id?: string | PropertyBindingInfo;
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
333
|
+
*/
|
|
334
|
+
metaPath?: string | PropertyBindingInfo;
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* An expression that allows you to control the read-only state of the field.
|
|
338
|
+
* If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
|
|
339
|
+
* current state.
|
|
340
|
+
*/
|
|
341
|
+
readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
342
|
+
|
|
343
|
+
/**
|
|
344
|
+
* Option to add semantic objects to a field.
|
|
345
|
+
* Valid options are either a single semantic object, a stringified array of semantic objects
|
|
346
|
+
* or a single binding expression returning either a single semantic object or an array of semantic objects
|
|
347
|
+
*/
|
|
348
|
+
semanticObject?: string | PropertyBindingInfo;
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
declare module "sap/fe/macros/field/TextAreaEx" {
|
|
353
|
+
import { default as TextArea, $TextAreaSettings } from "sap/m/TextArea";
|
|
354
|
+
|
|
355
|
+
/**
|
|
356
|
+
* Extension of the TextArea control to add a check for the maximum length when setting the value.
|
|
357
|
+
*/
|
|
358
|
+
export default class TextAreaEx extends TextArea {
|
|
359
|
+
constructor();
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
export interface $TextAreaExSettings extends $TextAreaSettings {}
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
declare module "sap/fe/macros/filterBar/FilterBarAPI" {
|
|
366
|
+
import {
|
|
367
|
+
default as MacroAPI,
|
|
368
|
+
$MacroAPISettings,
|
|
369
|
+
} from "sap/fe/macros/MacroAPI";
|
|
370
|
+
|
|
371
|
+
import {
|
|
372
|
+
PropertyBindingInfo,
|
|
373
|
+
AggregationBindingInfo,
|
|
374
|
+
} from "sap/ui/base/ManagedObject";
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Building block for creating a FilterBar based on the metadata provided by OData V4.
|
|
378
|
+
*
|
|
379
|
+
*
|
|
380
|
+
* Usually, a SelectionFields annotation is expected.
|
|
381
|
+
* Usage example:
|
|
382
|
+
*
|
|
383
|
+
* ```javascript
|
|
384
|
+
*
|
|
385
|
+
* <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
|
|
386
|
+
* ```
|
|
387
|
+
*/
|
|
388
|
+
export default class FilterBar extends MacroAPI {
|
|
389
|
+
constructor();
|
|
390
|
+
|
|
391
|
+
/**
|
|
392
|
+
* Get the Active Filters Text Summary for the filter bar.
|
|
393
|
+
*
|
|
394
|
+
* @returns Active filters summary as text
|
|
395
|
+
*/
|
|
396
|
+
getActiveFiltersText(): any;
|
|
397
|
+
/**
|
|
398
|
+
* Provides all the filters that are currently active
|
|
399
|
+
* along with the search expression.
|
|
400
|
+
*
|
|
401
|
+
* @returns An array of active filters and the search expression.
|
|
402
|
+
*/
|
|
403
|
+
getFilters(): object;
|
|
404
|
+
/**
|
|
405
|
+
* Set the filter values for the given property in the filter bar.
|
|
406
|
+
* The filter values can be either a single value or an array of values.
|
|
407
|
+
* Each filter value must be represented as a primitive value.
|
|
408
|
+
*
|
|
409
|
+
* @returns A promise for asynchronous handling
|
|
410
|
+
*/
|
|
411
|
+
setFilterValues(
|
|
412
|
+
/**
|
|
413
|
+
* The path to the property as a condition path
|
|
414
|
+
*/
|
|
415
|
+
sConditionPath: string,
|
|
416
|
+
/**
|
|
417
|
+
* undefined
|
|
418
|
+
*/
|
|
419
|
+
sOperator: string | undefined,
|
|
420
|
+
/**
|
|
421
|
+
* The values to be applied
|
|
422
|
+
*/
|
|
423
|
+
vValues?: boolean | boolean[] | number | number[] | string | string[]
|
|
424
|
+
): Promise<void>;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Definition of a custom filter to be used inside the FilterBar.
|
|
428
|
+
* The template for the FilterField has to be provided as the default aggregation
|
|
429
|
+
*/
|
|
430
|
+
export type FilterField = {
|
|
431
|
+
/**
|
|
432
|
+
* Reference to the key of another filter already displayed in the table to properly place this one
|
|
433
|
+
*/
|
|
434
|
+
anchor: string;
|
|
435
|
+
/**
|
|
436
|
+
* The property name of the FilterField
|
|
437
|
+
*/
|
|
438
|
+
key: string;
|
|
439
|
+
/**
|
|
440
|
+
* The text that will be displayed for this FilterField
|
|
441
|
+
*/
|
|
442
|
+
label: string;
|
|
443
|
+
/**
|
|
444
|
+
* Defines where this filter should be placed relative to the defined anchor
|
|
445
|
+
* Allowed values are `Before` and `After`
|
|
446
|
+
*/
|
|
447
|
+
placement: string;
|
|
448
|
+
/**
|
|
449
|
+
* If set, possible errors that occur during the search will be displayed in a message box.
|
|
450
|
+
*/
|
|
451
|
+
showMessages: boolean;
|
|
452
|
+
};
|
|
453
|
+
|
|
454
|
+
export interface $FilterBarSettings extends $MacroAPISettings {
|
|
455
|
+
/**
|
|
456
|
+
* Defines the path of the context used in the current page or block.
|
|
457
|
+
* This setting is defined by the framework.
|
|
458
|
+
*/
|
|
459
|
+
contextPath?: string | PropertyBindingInfo;
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* The identifier of the FilterBar control.
|
|
463
|
+
*/
|
|
464
|
+
id?: string | PropertyBindingInfo;
|
|
465
|
+
|
|
466
|
+
/**
|
|
467
|
+
* If true, the search is triggered automatically when a filter value is changed.
|
|
468
|
+
*/
|
|
469
|
+
liveMode?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
473
|
+
*/
|
|
474
|
+
metaPath?: string | PropertyBindingInfo;
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Handles the visibility of the 'Clear' button on the FilterBar.
|
|
478
|
+
*/
|
|
479
|
+
showClearButton?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Displays possible errors during the search in a message box
|
|
483
|
+
*/
|
|
484
|
+
showMessages?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* Parameter which sets the visibility of the FilterBar building block
|
|
488
|
+
*/
|
|
489
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
490
|
+
|
|
491
|
+
/**
|
|
492
|
+
* Aggregate filter fields of the FilterBar building block
|
|
493
|
+
*/
|
|
494
|
+
filterFields?:
|
|
495
|
+
| FilterField[]
|
|
496
|
+
| FilterField
|
|
497
|
+
| AggregationBindingInfo
|
|
498
|
+
| `{${string}}`;
|
|
499
|
+
}
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
declare module "sap/fe/macros/form/Form.block" {
|
|
503
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
504
|
+
|
|
505
|
+
import Context from "sap/ui/model/Context";
|
|
506
|
+
|
|
507
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Building block for creating a Form based on the metadata provided by OData V4.
|
|
511
|
+
*
|
|
512
|
+
*
|
|
513
|
+
* It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
|
|
514
|
+
* or a CollectionFacet
|
|
515
|
+
* Usage example:
|
|
516
|
+
*
|
|
517
|
+
* ```javascript
|
|
518
|
+
*
|
|
519
|
+
* <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
|
|
520
|
+
* ```
|
|
521
|
+
*/
|
|
522
|
+
export default class Form extends Control {
|
|
523
|
+
constructor();
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
export interface $FormSettings extends $ControlSettings {
|
|
527
|
+
/**
|
|
528
|
+
* Defines the path of the context used in the current page or block.
|
|
529
|
+
* This setting is defined by the framework.
|
|
530
|
+
*/
|
|
531
|
+
contextPath?: Context | PropertyBindingInfo | `{${string}}`;
|
|
532
|
+
|
|
533
|
+
/**
|
|
534
|
+
* The identifier of the form control.
|
|
535
|
+
*/
|
|
536
|
+
id?: string | PropertyBindingInfo;
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
540
|
+
*/
|
|
541
|
+
metaPath?: Context | PropertyBindingInfo | `{${string}}`;
|
|
542
|
+
|
|
543
|
+
/**
|
|
544
|
+
* The title of the form control.
|
|
545
|
+
*/
|
|
546
|
+
title?: string | PropertyBindingInfo;
|
|
547
|
+
}
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
declare module "sap/fe/macros/form/FormElement.block" {
|
|
551
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
552
|
+
|
|
553
|
+
import Context from "sap/ui/model/Context";
|
|
554
|
+
|
|
555
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* @SINCE 1.90.0
|
|
559
|
+
*
|
|
560
|
+
* Building block used to create a form element based on the metadata provided by OData V4.
|
|
561
|
+
*/
|
|
562
|
+
export default class FormElement extends Control {
|
|
563
|
+
constructor();
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
export interface $FormElementSettings extends $ControlSettings {
|
|
567
|
+
/**
|
|
568
|
+
* Defines the path of the context used in the current page or block.
|
|
569
|
+
* This setting is defined by the framework.
|
|
570
|
+
*/
|
|
571
|
+
contextPath?: Context | PropertyBindingInfo | `{${string}}`;
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* The identifier of the FormElement building block.
|
|
575
|
+
*/
|
|
576
|
+
id?: string | PropertyBindingInfo;
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* Label shown for the field. If not set, the label from the annotations will be shown.
|
|
580
|
+
*/
|
|
581
|
+
label?: string | PropertyBindingInfo;
|
|
582
|
+
|
|
583
|
+
/**
|
|
584
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
585
|
+
*/
|
|
586
|
+
metaPath?: Context | PropertyBindingInfo | `{${string}}`;
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* If set to false, the FormElement is not rendered.
|
|
590
|
+
*/
|
|
591
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* Optional aggregation of controls that should be displayed inside the FormElement.
|
|
595
|
+
* If not set, a default Field building block will be rendered
|
|
596
|
+
*/
|
|
597
|
+
fields?: Control;
|
|
598
|
+
}
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
declare module "sap/fe/macros/library" {}
|
|
602
|
+
|
|
603
|
+
declare module "sap/fe/macros/microchart/MicroChart.block" {
|
|
604
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
605
|
+
|
|
606
|
+
/**
|
|
607
|
+
* @SINCE 1.93.0
|
|
608
|
+
*
|
|
609
|
+
* Building block used to create a MicroChart based on the metadata provided by OData V4.
|
|
610
|
+
*/
|
|
611
|
+
export default class MicroChart extends Control {
|
|
612
|
+
constructor();
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
export interface $MicroChartSettings extends $ControlSettings {}
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
declare module "sap/fe/macros/paginator/Paginator.block" {
|
|
619
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
620
|
+
|
|
621
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* @SINCE 1.94.0
|
|
625
|
+
*
|
|
626
|
+
* Building block used to create a paginator control.
|
|
627
|
+
* Usage example:
|
|
628
|
+
*
|
|
629
|
+
* ```javascript
|
|
630
|
+
*
|
|
631
|
+
* <macro:Paginator />
|
|
632
|
+
* ```
|
|
633
|
+
*/
|
|
634
|
+
export default class Paginator extends Control {
|
|
635
|
+
constructor();
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
export interface $PaginatorSettings extends $ControlSettings {
|
|
639
|
+
/**
|
|
640
|
+
* The identifier of the Paginator control.
|
|
641
|
+
*/
|
|
642
|
+
id?: string | PropertyBindingInfo;
|
|
643
|
+
}
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
declare module "sap/fe/macros/table/TableAPI" {
|
|
647
|
+
import {
|
|
648
|
+
default as MacroAPI,
|
|
649
|
+
$MacroAPISettings,
|
|
650
|
+
} from "sap/fe/macros/MacroAPI";
|
|
651
|
+
|
|
652
|
+
import { MessageType } from "sap/ui/core/library";
|
|
653
|
+
|
|
654
|
+
import Context from "sap/ui/model/odata/v4/Context";
|
|
655
|
+
|
|
656
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
657
|
+
|
|
658
|
+
/**
|
|
659
|
+
* Building block used to create a table based on the metadata provided by OData V4.
|
|
660
|
+
*
|
|
661
|
+
*
|
|
662
|
+
* Usually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also
|
|
663
|
+
* be used to display an EntitySet.
|
|
664
|
+
* Usage example:
|
|
665
|
+
*
|
|
666
|
+
* ```javascript
|
|
667
|
+
*
|
|
668
|
+
* <macro:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
|
|
669
|
+
* ```
|
|
670
|
+
*/
|
|
671
|
+
export default class Table extends MacroAPI {
|
|
672
|
+
constructor();
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* Adds a message to the table.
|
|
676
|
+
* The message applies to the whole table and not to an individual table row.
|
|
677
|
+
*
|
|
678
|
+
*
|
|
679
|
+
* @returns The ID of the message
|
|
680
|
+
*/
|
|
681
|
+
addMessage(
|
|
682
|
+
/**
|
|
683
|
+
* undefined
|
|
684
|
+
*/
|
|
685
|
+
parameters: {
|
|
686
|
+
/**
|
|
687
|
+
* Message description
|
|
688
|
+
*/
|
|
689
|
+
description?: string;
|
|
690
|
+
/**
|
|
691
|
+
* Message text
|
|
692
|
+
*/
|
|
693
|
+
message?: string;
|
|
694
|
+
/**
|
|
695
|
+
* True if the message is persistent
|
|
696
|
+
*/
|
|
697
|
+
persistent?: boolean;
|
|
698
|
+
/**
|
|
699
|
+
* Message type
|
|
700
|
+
*/
|
|
701
|
+
type?: MessageType | keyof typeof MessageType;
|
|
702
|
+
}
|
|
703
|
+
): string;
|
|
704
|
+
/**
|
|
705
|
+
* Gets contexts from the table that have been selected by the user.
|
|
706
|
+
*
|
|
707
|
+
* @returns Contexts of the rows selected by the user
|
|
708
|
+
*/
|
|
709
|
+
getSelectedContexts(): Context[];
|
|
710
|
+
/**
|
|
711
|
+
* Removes a message from the table.
|
|
712
|
+
*/
|
|
713
|
+
removeMessage(
|
|
714
|
+
/**
|
|
715
|
+
* The id of the message
|
|
716
|
+
*/
|
|
717
|
+
id: string
|
|
718
|
+
): void;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Definition of a custom action to be used inside the table toolbar
|
|
722
|
+
*/
|
|
723
|
+
export type Action = {
|
|
724
|
+
/**
|
|
725
|
+
* Reference to the key of another action already displayed in the toolbar to properly place this one
|
|
726
|
+
*/
|
|
727
|
+
anchor: string;
|
|
728
|
+
/**
|
|
729
|
+
* Enables or disables the action
|
|
730
|
+
*/
|
|
731
|
+
enabled: boolean;
|
|
732
|
+
/**
|
|
733
|
+
* Unique identifier of the action
|
|
734
|
+
*/
|
|
735
|
+
key: string;
|
|
736
|
+
/**
|
|
737
|
+
* Defines where this action should be placed relative to the defined anchor
|
|
738
|
+
* Allowed values are `Before` and `After`
|
|
739
|
+
*/
|
|
740
|
+
placement: string;
|
|
741
|
+
/**
|
|
742
|
+
* Event handler to be called when the user chooses the action
|
|
743
|
+
*/
|
|
744
|
+
press: string;
|
|
745
|
+
/**
|
|
746
|
+
* Defines if the action requires a selection.
|
|
747
|
+
*/
|
|
748
|
+
requiresSelection: boolean;
|
|
749
|
+
/**
|
|
750
|
+
* The text that will be displayed for this action
|
|
751
|
+
*/
|
|
752
|
+
text: string;
|
|
753
|
+
};
|
|
754
|
+
|
|
755
|
+
/**
|
|
756
|
+
* Definition of a custom ActionGroup to be used inside the table toolbar
|
|
757
|
+
*/
|
|
758
|
+
export type ActionGroup = {
|
|
759
|
+
/**
|
|
760
|
+
* Defines nested actions
|
|
761
|
+
*/
|
|
762
|
+
actions: undefined[];
|
|
763
|
+
/**
|
|
764
|
+
* Reference to the key of another action or action group already displayed in the toolbar to properly place
|
|
765
|
+
* this one
|
|
766
|
+
*/
|
|
767
|
+
anchor: string;
|
|
768
|
+
/**
|
|
769
|
+
* Unique identifier of the ActionGroup
|
|
770
|
+
*/
|
|
771
|
+
key: string;
|
|
772
|
+
/**
|
|
773
|
+
* Defines where this action group should be placed relative to the defined anchor
|
|
774
|
+
* Allowed values are `Before` and `After`
|
|
775
|
+
*/
|
|
776
|
+
placement: string;
|
|
777
|
+
/**
|
|
778
|
+
* The text that will be displayed for this action group
|
|
779
|
+
*/
|
|
780
|
+
text: string;
|
|
781
|
+
};
|
|
782
|
+
|
|
783
|
+
/**
|
|
784
|
+
* Definition of a custom column to be used inside the table.
|
|
785
|
+
* The template for the column has to be provided as the default aggregation
|
|
786
|
+
*/
|
|
787
|
+
export type Column = {
|
|
788
|
+
/**
|
|
789
|
+
* Reference to the key of another column already displayed in the table to properly place this one
|
|
790
|
+
*/
|
|
791
|
+
anchor: string;
|
|
792
|
+
/**
|
|
793
|
+
* The text that will be displayed for this column header
|
|
794
|
+
*/
|
|
795
|
+
header: string;
|
|
796
|
+
/**
|
|
797
|
+
* Aligns the header as well as the content horizontally
|
|
798
|
+
*/
|
|
799
|
+
horizontalAlign: /* was: sap.fe.core.HorizontalAlign */ any;
|
|
800
|
+
/**
|
|
801
|
+
* Defines the column importance.
|
|
802
|
+
* You can define which columns should be automatically moved to the pop-in area based on their importance
|
|
803
|
+
*/
|
|
804
|
+
importance: string;
|
|
805
|
+
/**
|
|
806
|
+
* Unique identifier of the column
|
|
807
|
+
*/
|
|
808
|
+
key: string;
|
|
809
|
+
/**
|
|
810
|
+
* Defines where this column should be placed relative to the defined anchor
|
|
811
|
+
* Allowed values are `Before` and `After`
|
|
812
|
+
*/
|
|
813
|
+
placement: string;
|
|
814
|
+
/**
|
|
815
|
+
* Defines the column's width.
|
|
816
|
+
* Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize}
|
|
817
|
+
*/
|
|
818
|
+
width: string;
|
|
819
|
+
};
|
|
820
|
+
|
|
821
|
+
export interface $TableSettings extends $MacroAPISettings {
|
|
822
|
+
/**
|
|
823
|
+
* An expression that allows you to control the 'busy' state of the table.
|
|
824
|
+
*/
|
|
825
|
+
busy?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* Defines the path of the context used in the current page or block.
|
|
829
|
+
* This setting is defined by the framework.
|
|
830
|
+
*/
|
|
831
|
+
contextPath?: string | PropertyBindingInfo;
|
|
832
|
+
|
|
833
|
+
/**
|
|
834
|
+
* Specifies if the column width is automatically calculated.
|
|
835
|
+
*/
|
|
836
|
+
enableAutoColumnWidth?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
837
|
+
|
|
838
|
+
/**
|
|
839
|
+
* Controls if the export functionality of the table is enabled or not.
|
|
840
|
+
*/
|
|
841
|
+
enableExport?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* Controls whether the table can be opened in fullscreen mode or not.
|
|
845
|
+
*/
|
|
846
|
+
enableFullScreen?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* Controls if the paste functionality of the table is enabled or not.
|
|
850
|
+
*/
|
|
851
|
+
enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* ID of the FilterBar building block associated with the table.
|
|
855
|
+
*/
|
|
856
|
+
filterBar?: string | PropertyBindingInfo;
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* Specifies the header text that is shown in the table.
|
|
860
|
+
*/
|
|
861
|
+
header?: string | PropertyBindingInfo;
|
|
862
|
+
|
|
863
|
+
/**
|
|
864
|
+
* Controls if the header text should be shown or not.
|
|
865
|
+
*/
|
|
866
|
+
headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
867
|
+
|
|
868
|
+
/**
|
|
869
|
+
* The identifier of the table control.
|
|
870
|
+
*/
|
|
871
|
+
id?: string | PropertyBindingInfo;
|
|
872
|
+
|
|
873
|
+
/**
|
|
874
|
+
* Defines whether to display the search action.
|
|
875
|
+
*/
|
|
876
|
+
isSearchable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
877
|
+
|
|
878
|
+
/**
|
|
879
|
+
* Groups menu actions by key.
|
|
880
|
+
*/
|
|
881
|
+
menu?: string | PropertyBindingInfo;
|
|
882
|
+
|
|
883
|
+
/**
|
|
884
|
+
* Defines the relative path of the property in the metamodel, based on the current contextPath.
|
|
885
|
+
*/
|
|
886
|
+
metaPath?: string | PropertyBindingInfo;
|
|
887
|
+
|
|
888
|
+
/**
|
|
889
|
+
* Controls which options should be enabled for the table personalization dialog.
|
|
890
|
+
* If it is set to `true`, all possible options for this kind of table are enabled.
|
|
891
|
+
*
|
|
892
|
+
* If it is set to `false`, personalization is disabled.
|
|
893
|
+
*
|
|
894
|
+
*
|
|
895
|
+
*
|
|
896
|
+
* You can also provide a more granular control for the personalization by providing a comma-separated list
|
|
897
|
+
* with the options you want to be available.
|
|
898
|
+
*
|
|
899
|
+
* Available options are:
|
|
900
|
+
*
|
|
901
|
+
* - Sort
|
|
902
|
+
*
|
|
903
|
+
* - Column
|
|
904
|
+
*
|
|
905
|
+
* - Filter
|
|
906
|
+
*/
|
|
907
|
+
personalization?: boolean | string | PropertyBindingInfo | `{${string}}`;
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* An expression that allows you to control the 'read-only' state of the table.
|
|
911
|
+
* If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
|
|
912
|
+
* current state.
|
|
913
|
+
*/
|
|
914
|
+
readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
915
|
+
|
|
916
|
+
/**
|
|
917
|
+
* Defines the selection mode to be used by the table.
|
|
918
|
+
* Allowed values are `None`, `Single`, `Multi` or `Auto`
|
|
919
|
+
*/
|
|
920
|
+
selectionMode?: string | PropertyBindingInfo;
|
|
921
|
+
|
|
922
|
+
/**
|
|
923
|
+
* Defines the type of table that will be used by the building block to render the data.
|
|
924
|
+
* Allowed values are `GridTable` and `ResponsiveTable`
|
|
925
|
+
*/
|
|
926
|
+
type?: string | PropertyBindingInfo;
|
|
927
|
+
|
|
928
|
+
/**
|
|
929
|
+
* Controls the kind of variant management that should be enabled for the table.
|
|
930
|
+
* Allowed value is `Control`.
|
|
931
|
+
*
|
|
932
|
+
* If set with value `Control`, a variant management control is seen within the table and the table is linked
|
|
933
|
+
* to this.
|
|
934
|
+
*
|
|
935
|
+
* If not set with any value, control level variant management is not available for this table.
|
|
936
|
+
*/
|
|
937
|
+
variantManagement?: string | PropertyBindingInfo;
|
|
938
|
+
|
|
939
|
+
/**
|
|
940
|
+
* Aggregate actions of the table.
|
|
941
|
+
*/
|
|
942
|
+
actions?: Action;
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* Aggregate columns of the table.
|
|
946
|
+
*/
|
|
947
|
+
columns?: Column;
|
|
948
|
+
}
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
declare namespace sap {
|
|
952
|
+
interface IUI5DefineDependencyNames {
|
|
953
|
+
"sap/fe/macros/chart/ChartAPI": undefined;
|
|
954
|
+
|
|
955
|
+
"sap/fe/macros/field/FieldAPI": undefined;
|
|
956
|
+
|
|
957
|
+
"sap/fe/macros/field/TextAreaEx": undefined;
|
|
958
|
+
|
|
959
|
+
"sap/fe/macros/filterBar/FilterBarAPI": undefined;
|
|
960
|
+
|
|
961
|
+
"sap/fe/macros/form/Form.block": undefined;
|
|
962
|
+
|
|
963
|
+
"sap/fe/macros/form/FormElement.block": undefined;
|
|
964
|
+
|
|
965
|
+
"sap/fe/macros/library": undefined;
|
|
966
|
+
|
|
967
|
+
"sap/fe/macros/MacroAPI": undefined;
|
|
968
|
+
|
|
969
|
+
"sap/fe/macros/microchart/MicroChart.block": undefined;
|
|
970
|
+
|
|
971
|
+
"sap/fe/macros/paginator/Paginator.block": undefined;
|
|
972
|
+
|
|
973
|
+
"sap/fe/macros/table/TableAPI": undefined;
|
|
974
|
+
}
|
|
975
|
+
}
|