@sap/ux-specification 1.102.30 → 1.102.32

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.
@@ -12,26 +12,74 @@
12
12
  },
13
13
  "additionalProperties": false,
14
14
  "definitions": {
15
- "sap.fe.macros.MacroAPI": {
16
- "description": "Base API control for building blocks.",
15
+ "sap.fe.macros.FlexibleColumnLayoutActions": {
16
+ "description": "Building block used specifically in an app using the flexible column layout to add the ‘expand’, ‘reduce’, and ‘close’ action buttons.Usage example: \n<f:DynamicPageTitle id=\"incidentProcessFlowDynamicPageTitle\">\n\t <f:navigationActions>\n\t <macros:FlexibleColumnLayoutActions />\n\t </f:navigationActions>\n</f:DynamicPageTitle>\n<macro:FlexibleColumnLayoutActions />\n",
17
+ "isViewNode": true,
18
+ "type": "object",
19
+ "properties": {},
20
+ "additionalProperties": false,
21
+ "metadata": {
22
+ "path": [],
23
+ "type": "Control"
24
+ }
25
+ },
26
+ "sap.fe.macros.FormElement": {
27
+ "description": "Building block used to create a form element containing a label and a field.",
17
28
  "isViewNode": true,
18
29
  "type": "object",
19
30
  "properties": {
20
31
  "contextPath": {
32
+ "$ref": "#/definitions/sap.ui.model.Context",
33
+ "description": "contextPath",
34
+ "artifactType": "XMLProperty",
35
+ "isViewNode": true,
36
+ "metadata": {
37
+ "type": "Property"
38
+ }
39
+ },
40
+ "id": {
21
41
  "type": "string",
22
- "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
42
+ "description": "The identifier of the table control.",
23
43
  "artifactType": "XMLProperty",
24
44
  "metadata": {
25
45
  "type": "Property"
26
46
  }
27
47
  },
28
- "metaPath": {
48
+ "label": {
29
49
  "type": "string",
30
- "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
50
+ "description": "Label shown for the field. If not set, the label from the annotations will be shown.",
51
+ "artifactType": "XMLProperty",
52
+ "metadata": {
53
+ "type": "Property"
54
+ }
55
+ },
56
+ "metaPath": {
57
+ "$ref": "#/definitions/sap.ui.model.Context",
58
+ "description": "metaPath",
59
+ "artifactType": "XMLProperty",
60
+ "isViewNode": true,
61
+ "metadata": {
62
+ "type": "Property"
63
+ }
64
+ },
65
+ "visible": {
66
+ "type": "boolean",
67
+ "description": "If set to false, the FormElement is not rendered.",
31
68
  "artifactType": "XMLProperty",
32
69
  "metadata": {
33
70
  "type": "Property"
34
71
  }
72
+ },
73
+ "fields": {
74
+ "type": "object",
75
+ "additionalProperties": {
76
+ "$ref": "#/definitions/sap.ui.core.Control"
77
+ },
78
+ "isViewNode": true,
79
+ "metadata": {
80
+ "path": [],
81
+ "type": "Aggregation"
82
+ }
35
83
  }
36
84
  },
37
85
  "additionalProperties": false,
@@ -40,38 +88,39 @@
40
88
  "type": "Control"
41
89
  }
42
90
  },
43
- "sap.fe.macros.Chart": {
44
- "description": "Building block used to create a chart based on the metadata provided by OData V4.\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\n<macro:Chart id=\"Mychart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n",
91
+ "sap.fe.macros.MicroChart": {
92
+ "description": "Building block used to create a MicroChart based on the metadata provided by OData V4.",
45
93
  "isViewNode": true,
46
94
  "type": "object",
47
95
  "properties": {
48
- "contextPath": {
96
+ "batchGroupId": {
49
97
  "type": "string",
50
- "description": "Metadata path to the entitySet or navigationProperty",
98
+ "description": "Batch group ID along with which this call should be grouped.",
51
99
  "artifactType": "XMLProperty",
52
100
  "metadata": {
53
101
  "type": "Property"
54
102
  }
55
103
  },
56
- "filterBar": {
57
- "type": "string",
58
- "description": "Id of the FilterBar building block associated with the chart.",
104
+ "contextPath": {
105
+ "$ref": "#/definitions/sap.ui.model.Context",
106
+ "description": "contextPath",
59
107
  "artifactType": "XMLProperty",
108
+ "isViewNode": true,
60
109
  "metadata": {
61
110
  "type": "Property"
62
111
  }
63
112
  },
64
- "header": {
113
+ "description": {
65
114
  "type": "string",
66
- "description": "Specifies the header text that is shown in the chart",
115
+ "description": "Description for the MicroChart. If no description is provided, the description from the Chart annotation is used.",
67
116
  "artifactType": "XMLProperty",
68
117
  "metadata": {
69
118
  "type": "Property"
70
119
  }
71
120
  },
72
- "headerVisible": {
121
+ "hideOnNoData": {
73
122
  "type": "boolean",
74
- "description": "Controls if the header text should be shown or not",
123
+ "description": "Show blank space in case there is no data in the chart",
75
124
  "artifactType": "XMLProperty",
76
125
  "metadata": {
77
126
  "type": "Property"
@@ -79,69 +128,68 @@
79
128
  },
80
129
  "id": {
81
130
  "type": "string",
82
- "description": "ID of the chart",
131
+ "description": "ID of the MicroChart.",
132
+ "artifactType": "XMLProperty",
133
+ "metadata": {
134
+ "type": "Property"
135
+ }
136
+ },
137
+ "isAnalytics": {
138
+ "type": "boolean",
139
+ "description": "Defines whether the MicroChart is part of an analytical table",
83
140
  "artifactType": "XMLProperty",
84
141
  "metadata": {
85
142
  "type": "Property"
86
143
  }
87
144
  },
88
145
  "metaPath": {
89
- "type": "string",
90
- "description": "Metadata path to the presentation context (UI.Chart with or without a qualifier)",
146
+ "$ref": "#/definitions/sap.ui.model.Context",
147
+ "description": "metaPath",
91
148
  "artifactType": "XMLProperty",
149
+ "isViewNode": true,
92
150
  "metadata": {
93
151
  "type": "Property"
94
152
  }
95
153
  },
96
- "personalization": {
97
- "anyOf": [
98
- {
99
- "$ref": "#/definitions/boolean "
100
- },
101
- {
102
- "$ref": "#/definitions/ string"
103
- }
104
- ],
105
- "description": "personalization",
154
+ "navigationType": {
155
+ "$ref": "#/definitions/sap.fe.macros.NavigationType",
156
+ "description": "navigationType",
106
157
  "artifactType": "XMLProperty",
107
158
  "isViewNode": true,
108
159
  "metadata": {
109
160
  "type": "Property"
110
161
  }
111
162
  },
112
- "selectionMode": {
163
+ "onTitlePressed": {
113
164
  "type": "string",
114
- "description": "Defines the selection mode to be used by the chart.\nAllowed values are `None`, `Single` or `Multiple`\n",
165
+ "description": "Event handler for onTitlePressed event",
115
166
  "artifactType": "XMLProperty",
116
167
  "metadata": {
117
168
  "type": "Property"
118
169
  }
119
170
  },
120
- "variantManagement": {
121
- "type": "string",
122
- "description": "Controls the kind of variant management that should be enabled for the chart.\nAllowed value is `Control`.\n\nIf set with value `Control`, a variant management control is seen within the chart and the chart is linked to this.\n\nIf not set with any value, variant management control is not available for this chart.\n",
171
+ "showOnlyChart": {
172
+ "type": "boolean",
173
+ "description": "To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do not see the inner labels of the MicroChart as well.",
123
174
  "artifactType": "XMLProperty",
124
175
  "metadata": {
125
176
  "type": "Property"
126
177
  }
127
178
  },
128
- "actions": {
129
- "type": "object",
130
- "additionalProperties": {
131
- "$ref": "#/definitions/sap.fe.macros.chart.Action"
132
- },
133
- "isViewNode": true,
179
+ "size": {
180
+ "type": "string",
181
+ "description": "Size of the MicroChart",
182
+ "artifactType": "XMLProperty",
134
183
  "metadata": {
135
- "path": [],
136
- "type": "Aggregation"
184
+ "type": "Property"
137
185
  }
138
186
  },
139
- "selectionChange": {
187
+ "title": {
140
188
  "type": "string",
141
- "description": "An event triggered when chart selections are changed. The event contains information about the data selected/deselected and the Boolean flag that indicates whether data is selected or deselected.",
189
+ "description": "Title for the MicroChart. If no title is provided, the title from the Chart annotation is used.",
142
190
  "artifactType": "XMLProperty",
143
191
  "metadata": {
144
- "type": "Event"
192
+ "type": "Property"
145
193
  }
146
194
  }
147
195
  },
@@ -151,31 +199,78 @@
151
199
  "type": "Control"
152
200
  }
153
201
  },
154
- "sap.fe.macros.Field": {
155
- "description": "Building block for creating a field based on the metadata provided by OData V4.\n\nUsually, a DataField or DataPoint annotation is expected, but the field can also be used to display a property from the entity type.\nUsage example:\n\n<macro:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\n",
202
+ "sap.fe.macros.Paginator": {
203
+ "description": "Building block used to create a paginator control.Usage example: \n<macro:Paginator />\n",
204
+ "isViewNode": true,
205
+ "type": "object",
206
+ "properties": {
207
+ "id": {
208
+ "type": "string",
209
+ "description": "The identifier of the Paginator control.",
210
+ "artifactType": "XMLProperty",
211
+ "metadata": {
212
+ "type": "Property"
213
+ }
214
+ }
215
+ },
216
+ "additionalProperties": false,
217
+ "metadata": {
218
+ "path": [],
219
+ "type": "Control"
220
+ }
221
+ },
222
+ "sap.fe.macros.Share": {
223
+ "description": "Building block used to create the ‘Share’ functionality. Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with SAP Jam. If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then the 'Save as Tile' option is not visible.Usage example: \n<macro:Share\n\tid=\"someID\"\n\tvisible=\"true\"\n/>\n",
224
+ "isViewNode": true,
225
+ "type": "object",
226
+ "properties": {
227
+ "id": {
228
+ "type": "string",
229
+ "description": "The identifier of the share control.",
230
+ "artifactType": "XMLProperty",
231
+ "metadata": {
232
+ "type": "Property"
233
+ }
234
+ },
235
+ "visible": {
236
+ "type": "boolean",
237
+ "description": "Whether the share macro is visible or not.",
238
+ "artifactType": "XMLProperty",
239
+ "metadata": {
240
+ "type": "Property"
241
+ }
242
+ }
243
+ },
244
+ "additionalProperties": false,
245
+ "metadata": {
246
+ "path": [],
247
+ "type": "Control"
248
+ }
249
+ },
250
+ "sap.fe.macros.Chart": {
251
+ "description": "Building block used to create a chart based on the metadata provided by OData V4.\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\n<macro:Chart id=\"Mychart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n",
156
252
  "isViewNode": true,
157
253
  "type": "object",
158
254
  "properties": {
159
255
  "contextPath": {
160
256
  "type": "string",
161
- "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
257
+ "description": "Metadata path to the entitySet or navigationProperty",
162
258
  "artifactType": "XMLProperty",
163
259
  "metadata": {
164
260
  "type": "Property"
165
261
  }
166
262
  },
167
- "formatOptions": {
168
- "$ref": "#/definitions/sap.fe.macros.FieldFormatOptions",
169
- "description": "formatOptions",
263
+ "filterBar": {
264
+ "type": "string",
265
+ "description": "Id of the FilterBar building block associated with the chart.",
170
266
  "artifactType": "XMLProperty",
171
- "isViewNode": true,
172
267
  "metadata": {
173
268
  "type": "Property"
174
269
  }
175
270
  },
176
271
  "id": {
177
272
  "type": "string",
178
- "description": "The identifier of the Field control.",
273
+ "description": "ID of the chart",
179
274
  "artifactType": "XMLProperty",
180
275
  "metadata": {
181
276
  "type": "Property"
@@ -183,31 +278,38 @@
183
278
  },
184
279
  "metaPath": {
185
280
  "type": "string",
186
- "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
281
+ "description": "Metadata path to the presentation (UI.Chart w or w/o qualifier)",
187
282
  "artifactType": "XMLProperty",
188
283
  "metadata": {
189
284
  "type": "Property"
190
285
  }
191
286
  },
192
- "readOnly": {
193
- "type": "boolean",
194
- "description": "An expression that allows you to control the read-only state of the field.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
287
+ "personalization": {
288
+ "anyOf": [
289
+ {
290
+ "type": "boolean"
291
+ },
292
+ {
293
+ "type": "string"
294
+ }
295
+ ],
296
+ "description": "Parameter which sets the personalization of the MDC chart",
195
297
  "artifactType": "XMLProperty",
196
298
  "metadata": {
197
299
  "type": "Property"
198
300
  }
199
301
  },
200
- "semanticObject": {
302
+ "selectionMode": {
201
303
  "type": "string",
202
- "description": "Option to add semantic objects to a field.\nValid options are either a single semantic object, a stringified array of semantic objects\nor a single binding expression returning either a single semantic object or an array of semantic objects",
304
+ "description": "Specifies the selection mode",
203
305
  "artifactType": "XMLProperty",
204
306
  "metadata": {
205
307
  "type": "Property"
206
308
  }
207
309
  },
208
- "change": {
310
+ "selectionChange": {
209
311
  "type": "string",
210
- "description": "An event containing details is triggered when the value of the field is changed.",
312
+ "description": "An event triggered when chart selections are changed. The event contains information about the data selected/deselected and the Boolean flag that indicates whether data is selected or deselected.",
211
313
  "artifactType": "XMLProperty",
212
314
  "metadata": {
213
315
  "type": "Event"
@@ -220,19 +322,8 @@
220
322
  "type": "Control"
221
323
  }
222
324
  },
223
- "sap.fe.macros.field.TextAreaEx": {
224
- "description": "Extension of the TextArea control to add a check for the maximum length when setting the value.",
225
- "isViewNode": true,
226
- "type": "object",
227
- "properties": {},
228
- "additionalProperties": false,
229
- "metadata": {
230
- "path": [],
231
- "type": "Control"
232
- }
233
- },
234
- "sap.fe.macros.FilterBar": {
235
- "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macro:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
325
+ "sap.fe.macros.Field": {
326
+ "description": "Building block for creating a field based on the metadata provided by OData V4.\n\nUsually, a DataField or DataPoint annotation is expected, but the field can also be used to display a property from the entity type.\nUsage example:\n\n<macro:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\n",
236
327
  "isViewNode": true,
237
328
  "type": "object",
238
329
  "properties": {
@@ -244,17 +335,18 @@
244
335
  "type": "Property"
245
336
  }
246
337
  },
247
- "id": {
248
- "type": "string",
249
- "description": "The identifier of the FilterBar control.",
338
+ "formatOptions": {
339
+ "$ref": "#/definitions/sap.fe.macros.FieldFormatOptions",
340
+ "description": "formatOptions",
250
341
  "artifactType": "XMLProperty",
342
+ "isViewNode": true,
251
343
  "metadata": {
252
344
  "type": "Property"
253
345
  }
254
346
  },
255
- "liveMode": {
256
- "type": "boolean",
257
- "description": "If true, the search is triggered automatically when a filter value is changed.",
347
+ "id": {
348
+ "type": "string",
349
+ "description": "The identifier of the Field control.",
258
350
  "artifactType": "XMLProperty",
259
351
  "metadata": {
260
352
  "type": "Property"
@@ -268,60 +360,25 @@
268
360
  "type": "Property"
269
361
  }
270
362
  },
271
- "showClearButton": {
272
- "type": "boolean",
273
- "description": "Handles the visibility of the 'Clear' button on the FilterBar.",
274
- "artifactType": "XMLProperty",
275
- "metadata": {
276
- "type": "Property"
277
- }
278
- },
279
- "showMessages": {
280
- "type": "boolean",
281
- "description": "Displays possible errors during the search in a message box",
282
- "artifactType": "XMLProperty",
283
- "metadata": {
284
- "type": "Property"
285
- }
286
- },
287
- "visible": {
363
+ "readOnly": {
288
364
  "type": "boolean",
289
- "description": "Parameter which sets the visibility of the FilterBar building block",
365
+ "description": "An expression that allows you to control the read-only state of the field.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
290
366
  "artifactType": "XMLProperty",
291
367
  "metadata": {
292
368
  "type": "Property"
293
369
  }
294
370
  },
295
- "filterFields": {
296
- "type": "object",
297
- "additionalProperties": {
298
- "$ref": "#/definitions/sap.fe.macros.FilterField"
299
- },
300
- "isViewNode": true,
301
- "metadata": {
302
- "path": [],
303
- "type": "Aggregation"
304
- }
305
- },
306
- "afterClear": {
307
- "type": "string",
308
- "description": "This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button is enabled.",
309
- "artifactType": "XMLProperty",
310
- "metadata": {
311
- "type": "Event"
312
- }
313
- },
314
- "filterChanged": {
371
+ "semanticObject": {
315
372
  "type": "string",
316
- "description": "This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that will be used as filters.",
373
+ "description": "Option to add semantic objects to a field.\nValid options are either a single semantic object, a stringified array of semantic objects\nor a single binding expression returning either a single semantic object or an array of semantic objects",
317
374
  "artifactType": "XMLProperty",
318
375
  "metadata": {
319
- "type": "Event"
376
+ "type": "Property"
320
377
  }
321
378
  },
322
- "search": {
379
+ "change": {
323
380
  "type": "string",
324
- "description": "This event is fired when the 'Go' button is pressed or after a condition change.",
381
+ "description": "An event containing details is triggered when the value of the field is changed.",
325
382
  "artifactType": "XMLProperty",
326
383
  "metadata": {
327
384
  "type": "Event"
@@ -334,43 +391,60 @@
334
391
  "type": "Control"
335
392
  }
336
393
  },
337
- "sap.fe.macros.Form": {
338
- "description": "Building block for creating a Form based on the metadata provided by OData V4.\n\nIt is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet or a CollectionFacet\nUsage example:\n\n<macro:Form id=\"MyForm\" metaPath=\"@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation\" />\n\n",
394
+ "sap.fe.macros.FilterBar": {
395
+ "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macro:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
339
396
  "isViewNode": true,
340
397
  "type": "object",
341
398
  "properties": {
342
399
  "contextPath": {
343
- "$ref": "#/definitions/sap.ui.model.Context",
344
- "description": "contextPath",
400
+ "type": "string",
401
+ "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
345
402
  "artifactType": "XMLProperty",
346
- "isViewNode": true,
347
403
  "metadata": {
348
404
  "type": "Property"
349
405
  }
350
406
  },
351
407
  "id": {
352
408
  "type": "string",
353
- "description": "The identifier of the form control.",
409
+ "description": "The identifier of the filterbar control.",
354
410
  "artifactType": "XMLProperty",
355
411
  "metadata": {
356
412
  "type": "Property"
357
413
  }
358
414
  },
359
415
  "metaPath": {
360
- "$ref": "#/definitions/sap.ui.model.Context",
361
- "description": "metaPath",
416
+ "type": "string",
417
+ "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
362
418
  "artifactType": "XMLProperty",
363
- "isViewNode": true,
364
419
  "metadata": {
365
420
  "type": "Property"
366
421
  }
367
422
  },
368
- "title": {
423
+ "filterFields": {
424
+ "type": "object",
425
+ "additionalProperties": {
426
+ "$ref": "#/definitions/sap.fe.macros.FilterField"
427
+ },
428
+ "isViewNode": true,
429
+ "metadata": {
430
+ "path": [],
431
+ "type": "Aggregation"
432
+ }
433
+ },
434
+ "filterChanged": {
369
435
  "type": "string",
370
- "description": "The title of the form control.",
436
+ "description": "This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that will be used as filters.",
371
437
  "artifactType": "XMLProperty",
372
438
  "metadata": {
373
- "type": "Property"
439
+ "type": "Event"
440
+ }
441
+ },
442
+ "search": {
443
+ "type": "string",
444
+ "description": "This event is fired when the Go button is pressed or after a condition change.",
445
+ "artifactType": "XMLProperty",
446
+ "metadata": {
447
+ "type": "Event"
374
448
  }
375
449
  }
376
450
  },
@@ -380,63 +454,42 @@
380
454
  "type": "Control"
381
455
  }
382
456
  },
383
- "sap.fe.macros.FormElement": {
384
- "description": "Building block used to create a form element based on the metadata provided by OData V4.",
457
+ "sap.fe.macros.Form": {
458
+ "description": "Building block for creating a Form based on the metadata provided by OData V4.\n\nIt is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet or a CollectionFacet\nUsage example:\n\n<macro:Form id=\"MyForm\" metaPath=\"@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation\" />\n\n",
385
459
  "isViewNode": true,
386
460
  "type": "object",
387
461
  "properties": {
388
462
  "contextPath": {
389
- "$ref": "#/definitions/sap.ui.model.Context",
390
- "description": "contextPath",
391
- "artifactType": "XMLProperty",
392
- "isViewNode": true,
393
- "metadata": {
394
- "type": "Property"
395
- }
396
- },
397
- "id": {
398
463
  "type": "string",
399
- "description": "The identifier of the FormElement building block.",
464
+ "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
400
465
  "artifactType": "XMLProperty",
401
466
  "metadata": {
402
467
  "type": "Property"
403
468
  }
404
469
  },
405
- "label": {
470
+ "id": {
406
471
  "type": "string",
407
- "description": "Label shown for the field. If not set, the label from the annotations will be shown.",
472
+ "description": "The identifier of the form control.",
408
473
  "artifactType": "XMLProperty",
409
474
  "metadata": {
410
475
  "type": "Property"
411
476
  }
412
477
  },
413
478
  "metaPath": {
414
- "$ref": "#/definitions/sap.ui.model.Context",
415
- "description": "metaPath",
479
+ "type": "string",
480
+ "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
416
481
  "artifactType": "XMLProperty",
417
- "isViewNode": true,
418
482
  "metadata": {
419
483
  "type": "Property"
420
484
  }
421
485
  },
422
- "visible": {
423
- "type": "boolean",
424
- "description": "If set to false, the FormElement is not rendered.",
486
+ "title": {
487
+ "type": "string",
488
+ "description": "The title of the form control.",
425
489
  "artifactType": "XMLProperty",
426
490
  "metadata": {
427
491
  "type": "Property"
428
492
  }
429
- },
430
- "fields": {
431
- "type": "object",
432
- "additionalProperties": {
433
- "$ref": "#/definitions/sap.ui.core.Control"
434
- },
435
- "isViewNode": true,
436
- "metadata": {
437
- "path": [],
438
- "type": "Aggregation"
439
- }
440
493
  }
441
494
  },
442
495
  "additionalProperties": false,
@@ -445,25 +498,22 @@
445
498
  "type": "Control"
446
499
  }
447
500
  },
448
- "sap.fe.macros.MicroChart": {
449
- "description": "Building block used to create a MicroChart based on the metadata provided by OData V4.",
450
- "isViewNode": true,
451
- "type": "object",
452
- "properties": {},
453
- "additionalProperties": false,
454
- "metadata": {
455
- "path": [],
456
- "type": "Control"
457
- }
458
- },
459
- "sap.fe.macros.Paginator": {
460
- "description": "Building block used to create a paginator control.\nUsage example:\n\n<macro:Paginator />\n\n",
501
+ "sap.fe.macros.MacroAPI": {
502
+ "description": "Base API control for macros.",
461
503
  "isViewNode": true,
462
504
  "type": "object",
463
505
  "properties": {
464
- "id": {
506
+ "contextPath": {
465
507
  "type": "string",
466
- "description": "The identifier of the Paginator control.",
508
+ "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
509
+ "artifactType": "XMLProperty",
510
+ "metadata": {
511
+ "type": "Property"
512
+ }
513
+ },
514
+ "metaPath": {
515
+ "type": "string",
516
+ "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
467
517
  "artifactType": "XMLProperty",
468
518
  "metadata": {
469
519
  "type": "Property"
@@ -499,7 +549,7 @@
499
549
  },
500
550
  "enableAutoColumnWidth": {
501
551
  "type": "boolean",
502
- "description": "Specifies if the column width is automatically calculated.",
552
+ "description": "Specifies the header text that is shown in the table.",
503
553
  "artifactType": "XMLProperty",
504
554
  "metadata": {
505
555
  "type": "Property"
@@ -537,14 +587,6 @@
537
587
  "type": "Property"
538
588
  }
539
589
  },
540
- "frozenColumnCount": {
541
- "type": "number",
542
- "description": "Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.\nThis property is not relevant for Responsive tables\n",
543
- "artifactType": "XMLProperty",
544
- "metadata": {
545
- "type": "Property"
546
- }
547
- },
548
590
  "header": {
549
591
  "type": "string",
550
592
  "description": "Specifies the header text that is shown in the table.",
@@ -596,15 +638,14 @@
596
638
  "personalization": {
597
639
  "anyOf": [
598
640
  {
599
- "$ref": "#/definitions/boolean "
641
+ "type": "boolean"
600
642
  },
601
643
  {
602
- "$ref": "#/definitions/ string"
644
+ "type": "string"
603
645
  }
604
646
  ],
605
- "description": "personalization",
647
+ "description": "Controls which options should be enabled for the table personalization dialog.\nIf it is set to `true`, all possible options for this kind of table are enabled.\n\nIf it is set to `false`, personalization is disabled.\n\n\n\nYou can also provide a more granular control for the personalization by providing a comma-separated list with the options you want to be available.\n\nAvailable options are:\n\n - Sort\n\n - Column\n\n - Filter\n\n",
606
648
  "artifactType": "XMLProperty",
607
- "isViewNode": true,
608
649
  "metadata": {
609
650
  "type": "Property"
610
651
  }
@@ -619,7 +660,7 @@
619
660
  },
620
661
  "selectionMode": {
621
662
  "type": "string",
622
- "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `Multi` or `Auto`. If not set to 'None', SAP Fiori elements hooks into the standard lifecycle to determine the consistent selection mode.\n",
663
+ "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `Multi` or `Auto`\n",
623
664
  "artifactType": "XMLProperty",
624
665
  "metadata": {
625
666
  "type": "Property"
@@ -635,7 +676,7 @@
635
676
  },
636
677
  "variantManagement": {
637
678
  "type": "string",
638
- "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed value is `Control`.\n\nIf set with value `Control`, a variant management control is seen within the table and the table is linked to this.\n\nIf not set with any value, control level variant management is not available for this table.\n",
679
+ "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed values are `Page`, `Control` and `None`.\n\nIf the table is used within a SAP Fiori elements template, the default value will be taken from the current page variant management.\n\nOtherwise it's `None`.\n",
639
680
  "artifactType": "XMLProperty",
640
681
  "metadata": {
641
682
  "type": "Property"
@@ -673,7 +714,7 @@
673
714
  },
674
715
  "rowPress": {
675
716
  "type": "string",
676
- "description": "An event is triggered when the user chooses a row; the event contains information about which row is chosen.\nYou can set this in order to handle the navigation manually.\n",
717
+ "description": "An event triggered when the user chooses a row; the event contains information about which row was chosen.\nYou can set this in order to handle the navigation manually.\n",
677
718
  "artifactType": "XMLProperty",
678
719
  "metadata": {
679
720
  "type": "Event"
@@ -741,127 +782,6 @@
741
782
  "type": "Control"
742
783
  }
743
784
  },
744
- "sap.fe.macros.chart.Action": {
745
- "description": "Definition of a custom action to be used inside the chart toolbar",
746
- "isViewNode": true,
747
- "type": "object",
748
- "properties": {
749
- "anchor": {
750
- "type": "string",
751
- "description": "Reference to the key of another action already displayed in the toolbar to properly place this one",
752
- "artifactType": "XMLProperty",
753
- "metadata": {
754
- "type": "Property"
755
- }
756
- },
757
- "enabled": {
758
- "type": "boolean",
759
- "description": "Enables or disables the action",
760
- "artifactType": "XMLProperty",
761
- "metadata": {
762
- "type": "Property"
763
- }
764
- },
765
- "key": {
766
- "type": "string",
767
- "description": "Unique identifier of the action",
768
- "artifactType": "XMLProperty",
769
- "metadata": {
770
- "type": "Property"
771
- }
772
- },
773
- "placement": {
774
- "type": "string",
775
- "description": "Defines where this action should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
776
- "artifactType": "XMLProperty",
777
- "metadata": {
778
- "type": "Property"
779
- }
780
- },
781
- "press": {
782
- "type": "string",
783
- "description": "Event handler to be called when the user chooses the action",
784
- "artifactType": "XMLProperty",
785
- "metadata": {
786
- "type": "Property"
787
- }
788
- },
789
- "requiresSelection": {
790
- "type": "boolean",
791
- "description": "Defines if the action requires a selection.",
792
- "artifactType": "XMLProperty",
793
- "metadata": {
794
- "type": "Property"
795
- }
796
- },
797
- "text": {
798
- "type": "string",
799
- "description": "The text that will be displayed for this action",
800
- "artifactType": "XMLProperty",
801
- "metadata": {
802
- "type": "Property"
803
- }
804
- }
805
- },
806
- "additionalProperties": false,
807
- "metadata": {
808
- "path": [],
809
- "type": "Control"
810
- }
811
- },
812
- "sap.fe.macros.chart.ActionGroup": {
813
- "description": "Definition of a custom action group to be used inside the chart toolbar",
814
- "isViewNode": true,
815
- "type": "object",
816
- "properties": {
817
- "actions": {
818
- "$ref": "#/definitions/undefined[]",
819
- "description": "actions",
820
- "artifactType": "XMLProperty",
821
- "isViewNode": true,
822
- "metadata": {
823
- "type": "Property"
824
- }
825
- },
826
- "anchor": {
827
- "type": "string",
828
- "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one",
829
- "artifactType": "XMLProperty",
830
- "metadata": {
831
- "type": "Property"
832
- }
833
- },
834
- "key": {
835
- "type": "string",
836
- "description": "Unique identifier of the action",
837
- "artifactType": "XMLProperty",
838
- "metadata": {
839
- "type": "Property"
840
- }
841
- },
842
- "placement": {
843
- "type": "string",
844
- "description": "Defines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
845
- "artifactType": "XMLProperty",
846
- "metadata": {
847
- "type": "Property"
848
- }
849
- },
850
- "text": {
851
- "type": "string",
852
- "description": "The text that will be displayed for this action group",
853
- "artifactType": "XMLProperty",
854
- "metadata": {
855
- "type": "Property"
856
- }
857
- }
858
- },
859
- "additionalProperties": false,
860
- "metadata": {
861
- "path": [],
862
- "type": "Control"
863
- }
864
- },
865
785
  "sap.fe.macros.FieldFormatOptions": {
866
786
  "description": "Additional format options for the field.",
867
787
  "isViewNode": true,
@@ -869,7 +789,7 @@
869
789
  "properties": {
870
790
  "displayMode": {
871
791
  "type": "string",
872
- "description": " Defines how the field value and associated text will be displayed together.\n\n Allowed values are \"Value\", \"Description\", \"DescriptionValue\" and \"ValueDescription\"\n",
792
+ "description": " Defines how the field value and associated text will be displayed together.\n\n Allowed values are \"Value\", \"Description\", \"ValueDescription\" and \"DescriptionValue\"\n",
873
793
  "artifactType": "XMLProperty",
874
794
  "metadata": {
875
795
  "type": "Property"
@@ -883,30 +803,6 @@
883
803
  "type": "Property"
884
804
  }
885
805
  },
886
- "showDate": {
887
- "type": "boolean",
888
- "description": "Defines if the date part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.The default value is true.\n",
889
- "artifactType": "XMLProperty",
890
- "metadata": {
891
- "type": "Property"
892
- }
893
- },
894
- "showTime": {
895
- "type": "boolean",
896
- "description": "Defines if the time part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.The default value is true.\n",
897
- "artifactType": "XMLProperty",
898
- "metadata": {
899
- "type": "Property"
900
- }
901
- },
902
- "showTimezone": {
903
- "type": "boolean",
904
- "description": "Defines if the timezone part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.The default value is true.\n",
905
- "artifactType": "XMLProperty",
906
- "metadata": {
907
- "type": "Property"
908
- }
909
- },
910
806
  "textExpandBehaviorDisplay": {
911
807
  "type": "string",
912
808
  "description": "Defines how the full text will be displayed.\n\nAllowed values are \"InPlace\" and \"Popover\"\n",
@@ -931,14 +827,6 @@
931
827
  "type": "Property"
932
828
  }
933
829
  },
934
- "textMaxLength": {
935
- "type": "number",
936
- "description": "Defines the maximum number of characters for the multiline text value.\n\nIf a multiline text exceeds the maximum number of allowed characters, the counter below the input field displays the exact number.\n",
937
- "artifactType": "XMLProperty",
938
- "metadata": {
939
- "type": "Property"
940
- }
941
- },
942
830
  "textMaxLines": {
943
831
  "type": "number",
944
832
  "description": "Maximum number of lines that multiline texts in edit mode can grow to.\n",
@@ -983,6 +871,14 @@
983
871
  "type": "Property"
984
872
  }
985
873
  },
874
+ "liveMode": {
875
+ "type": "boolean",
876
+ "description": "If set the search will be automatically triggered, when a filter value was changed.",
877
+ "artifactType": "XMLProperty",
878
+ "metadata": {
879
+ "type": "Property"
880
+ }
881
+ },
986
882
  "placement": {
987
883
  "type": "string",
988
884
  "description": "Defines where this filter should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
@@ -995,9 +891,9 @@
995
891
  "Before"
996
892
  ]
997
893
  },
998
- "showMessages": {
894
+ "visible": {
999
895
  "type": "boolean",
1000
- "description": "If set, possible errors that occur during the search will be displayed in a message box.",
896
+ "description": "Parameter which sets the visibility of the FilterBar building block",
1001
897
  "artifactType": "XMLProperty",
1002
898
  "metadata": {
1003
899
  "type": "Property"
@@ -1082,59 +978,6 @@
1082
978
  "type": "Control"
1083
979
  }
1084
980
  },
1085
- "sap.fe.macros.table.ActionGroup": {
1086
- "description": "Definition of a custom ActionGroup to be used inside the table toolbar",
1087
- "isViewNode": true,
1088
- "type": "object",
1089
- "properties": {
1090
- "actions": {
1091
- "$ref": "#/definitions/undefined[]",
1092
- "description": "actions",
1093
- "artifactType": "XMLProperty",
1094
- "isViewNode": true,
1095
- "metadata": {
1096
- "type": "Property"
1097
- }
1098
- },
1099
- "anchor": {
1100
- "type": "string",
1101
- "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one",
1102
- "artifactType": "XMLProperty",
1103
- "metadata": {
1104
- "type": "Property"
1105
- }
1106
- },
1107
- "key": {
1108
- "type": "string",
1109
- "description": "Unique identifier of the ActionGroup",
1110
- "artifactType": "XMLProperty",
1111
- "metadata": {
1112
- "type": "Property"
1113
- }
1114
- },
1115
- "placement": {
1116
- "type": "string",
1117
- "description": "Defines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
1118
- "artifactType": "XMLProperty",
1119
- "metadata": {
1120
- "type": "Property"
1121
- }
1122
- },
1123
- "text": {
1124
- "type": "string",
1125
- "description": "The text that will be displayed for this action group",
1126
- "artifactType": "XMLProperty",
1127
- "metadata": {
1128
- "type": "Property"
1129
- }
1130
- }
1131
- },
1132
- "additionalProperties": false,
1133
- "metadata": {
1134
- "path": [],
1135
- "type": "Control"
1136
- }
1137
- },
1138
981
  "sap.fe.macros.table.Column": {
1139
982
  "description": "Definition of a custom column to be used inside the table.\nThe template for the column has to be provided as the default aggregation\n",
1140
983
  "isViewNode": true,
@@ -1156,18 +999,9 @@
1156
999
  "type": "Property"
1157
1000
  }
1158
1001
  },
1159
- "horizontalAlign": {
1160
- "$ref": "#/definitions/sap.fe.core.converters.ManifestSettings.HorizontalAlign",
1161
- "description": "horizontalAlign",
1162
- "artifactType": "XMLProperty",
1163
- "isViewNode": true,
1164
- "metadata": {
1165
- "type": "Property"
1166
- }
1167
- },
1168
1002
  "importance": {
1169
1003
  "type": "string",
1170
- "description": "Defines the column importance.\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n",
1004
+ "description": "Defines the column importance\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n",
1171
1005
  "artifactType": "XMLProperty",
1172
1006
  "metadata": {
1173
1007
  "type": "Property"
@@ -1192,14 +1026,6 @@
1192
1026
  "After",
1193
1027
  "Before"
1194
1028
  ]
1195
- },
1196
- "width": {
1197
- "type": "string",
1198
- "description": "Defines the column's width.\nAllowed values are `auto`, `value` and `inherit` according to sap.ui.core.CSSSize\n",
1199
- "artifactType": "XMLProperty",
1200
- "metadata": {
1201
- "type": "Property"
1202
- }
1203
1029
  }
1204
1030
  },
1205
1031
  "additionalProperties": false,