@sapui5/ts-types 1.123.1 → 1.124.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.
Files changed (66) hide show
  1. package/LICENSE.txt +13 -10
  2. package/README.md +1 -1
  3. package/package.json +1 -1
  4. package/types/sap.apf.d.ts +1 -1
  5. package/types/sap.ca.ui.d.ts +1 -1
  6. package/types/sap.chart.d.ts +1 -1
  7. package/types/sap.collaboration.d.ts +5 -3
  8. package/types/sap.esh.search.ui.d.ts +127 -1
  9. package/types/sap.f.d.ts +55 -15
  10. package/types/sap.fe.core.d.ts +12 -6
  11. package/types/sap.fe.macros.d.ts +2041 -186
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +1 -1
  14. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  15. package/types/sap.fe.templates.d.ts +31 -4
  16. package/types/sap.fe.test.d.ts +1 -1
  17. package/types/sap.fe.tools.d.ts +1 -1
  18. package/types/sap.feedback.ui.d.ts +1 -1
  19. package/types/sap.gantt.d.ts +8 -6
  20. package/types/sap.insights.d.ts +1 -1
  21. package/types/sap.m.d.ts +3924 -239
  22. package/types/sap.makit.d.ts +1 -1
  23. package/types/sap.me.d.ts +1 -1
  24. package/types/sap.ndc.d.ts +1 -1
  25. package/types/sap.ovp.d.ts +1 -1
  26. package/types/sap.rules.ui.d.ts +1 -1
  27. package/types/sap.sac.df.d.ts +195 -82
  28. package/types/sap.suite.ui.commons.d.ts +15 -11
  29. package/types/sap.suite.ui.generic.template.d.ts +34 -1
  30. package/types/sap.suite.ui.microchart.d.ts +1 -1
  31. package/types/sap.tnt.d.ts +5 -3
  32. package/types/sap.ui.codeeditor.d.ts +1 -1
  33. package/types/sap.ui.commons.d.ts +33 -17
  34. package/types/sap.ui.comp.d.ts +197 -49
  35. package/types/sap.ui.core.d.ts +496 -558
  36. package/types/sap.ui.dt.d.ts +6 -2
  37. package/types/sap.ui.export.d.ts +1 -1
  38. package/types/sap.ui.fl.d.ts +3 -2
  39. package/types/sap.ui.generic.app.d.ts +1 -1
  40. package/types/sap.ui.generic.template.d.ts +1 -1
  41. package/types/sap.ui.integration.d.ts +1 -1
  42. package/types/sap.ui.layout.d.ts +7 -4
  43. package/types/sap.ui.mdc.d.ts +623 -908
  44. package/types/sap.ui.richtexteditor.d.ts +1 -1
  45. package/types/sap.ui.rta.d.ts +1 -1
  46. package/types/sap.ui.suite.d.ts +1 -1
  47. package/types/sap.ui.support.d.ts +1 -1
  48. package/types/sap.ui.table.d.ts +1 -1
  49. package/types/sap.ui.testrecorder.d.ts +1 -1
  50. package/types/sap.ui.unified.d.ts +6 -4
  51. package/types/sap.ui.ux3.d.ts +7 -4
  52. package/types/sap.ui.vbm.d.ts +3 -2
  53. package/types/sap.ui.vk.d.ts +86 -30
  54. package/types/sap.ui.vtm.d.ts +23 -12
  55. package/types/sap.ui.webc.common.d.ts +1 -1
  56. package/types/sap.ui.webc.fiori.d.ts +31 -16
  57. package/types/sap.ui.webc.main.d.ts +109 -57
  58. package/types/sap.uiext.inbox.d.ts +73 -17
  59. package/types/sap.ushell.d.ts +616 -192
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +16 -10
  62. package/types/sap.viz.d.ts +1 -1
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +1 -1
  65. package/types/sap.zen.crosstab.d.ts +1 -1
  66. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.123.0
1
+ // For Library Version: 1.124.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -92,6 +92,105 @@ declare namespace sap {
92
92
  | `{${string}}`;
93
93
  }
94
94
 
95
+ /**
96
+ * Describes the settings that can be provided to the Chart constructor.
97
+ *
98
+ * @experimental
99
+ */
100
+ interface $ChartSettings
101
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
102
+ /**
103
+ * Metadata path to the entitySet or navigationProperty
104
+ */
105
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
106
+
107
+ /**
108
+ * Id of the FilterBar building block associated with the chart.
109
+ */
110
+ filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
111
+
112
+ /**
113
+ * Specifies the header text that is shown in the chart
114
+ */
115
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
116
+
117
+ /**
118
+ * Controls if the header text should be shown or not
119
+ */
120
+ headerVisible?:
121
+ | boolean
122
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
123
+ | `{${string}}`;
124
+
125
+ /**
126
+ * Metadata path to the presentation context (UI.Chart with or without a qualifier)
127
+ */
128
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
129
+
130
+ /**
131
+ * Controls which options should be enabled for the chart personalization dialog.
132
+ * If it is set to `true`, all possible options for this kind of chart are enabled.
133
+ *
134
+ * If it is set to `false`, personalization is disabled.
135
+ *
136
+ *
137
+ *
138
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
139
+ * with the options you want to be available.
140
+ *
141
+ * Available options are:
142
+ *
143
+ * - Sort
144
+ *
145
+ * - Type
146
+ *
147
+ * - Item
148
+ *
149
+ * - Filter
150
+ */
151
+ personalization?:
152
+ | string
153
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
154
+
155
+ /**
156
+ * Defines the selection mode to be used by the chart.
157
+ * Allowed values are `None`, `Single` or `Multiple`
158
+ */
159
+ selectionMode?:
160
+ | string
161
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
162
+
163
+ /**
164
+ * Controls the kind of variant management that should be enabled for the chart.
165
+ * Allowed value is `Control`.
166
+ *
167
+ * If set with value `Control`, a variant management control is seen within the chart and the chart is linked
168
+ * to this.
169
+ *
170
+ * If not set with any value, variant management control is not available for this chart.
171
+ */
172
+ variantManagement?:
173
+ | string
174
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
175
+
176
+ /**
177
+ * Aggregate actions of the chart.
178
+ */
179
+ actions?:
180
+ | Array<
181
+ sap.fe.macros.chart.ActionGroup | sap.fe.macros.chart.Action
182
+ >
183
+ | sap.fe.macros.chart.ActionGroup
184
+ | sap.fe.macros.chart.Action
185
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
186
+ | `{${string}}`;
187
+ }
188
+
189
+ /**
190
+ * Parameters of the Chart#selectionChange event.
191
+ */
192
+ interface Chart$SelectionChangeEventParameters {}
193
+
95
194
  /**
96
195
  * Definition of a custom action to be used in the chart toolbar
97
196
  */
@@ -102,6 +201,108 @@ declare namespace sap {
102
201
  */
103
202
  class ActionGroup extends sap.fe.macros.controls
104
203
  .BuildingBlockObjectProperty {}
204
+ /**
205
+ * Building block used to create a chart based on the metadata provided by OData V4.
206
+ *
207
+ *
208
+ * Usually, a contextPath and metaPath is expected.
209
+ * Usage example:
210
+ *
211
+ * ```javascript
212
+ *
213
+ * sap.ui.require(["sap/fe/macros/chart/Chart"], function(Chart) {
214
+ * ...
215
+ * new Chart("myChart", {metaPath:"MyChart"})
216
+ * })
217
+ * ```
218
+ *
219
+ * This is currently an experimental API because the structure of the generated content will change to come
220
+ * closer to the Chart that you get out of templates.
221
+ * The public method and property will not change but the internal structure will so be careful on your
222
+ * usage.
223
+ *
224
+ *
225
+ * @experimental
226
+ */
227
+ class Chart extends sap.fe.macros.controls.BuildingBlockWithTemplating {
228
+ /**
229
+ * Gets the key of the current variant in the associated variant management.
230
+ *
231
+ *
232
+ * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
233
+ */
234
+ getCurrentVariantKey(): null | string;
235
+ /**
236
+ * Get the presentation variant that is currently applied on the chart.
237
+ *
238
+ *
239
+ * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
240
+ */
241
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
242
+ /**
243
+ * Gets contexts from the chart that have been selected by the user.
244
+ *
245
+ *
246
+ * @returns Contexts of the rows selected by the user
247
+ */
248
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
249
+ /**
250
+ * Get the selection variant from the chart.
251
+ *
252
+ *
253
+ * @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
254
+ */
255
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
256
+ /**
257
+ * Sets the variant of the provided key in the associated variant management.
258
+ */
259
+ setCurrentVariantKey(
260
+ /**
261
+ * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
262
+ */
263
+ key: string
264
+ ): void;
265
+ /**
266
+ * Set the presentation variant for the mdc chart.
267
+ * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
268
+ * be followed while trying to set the PresentationVariant as needed.
269
+ * The values dimensions, measures and other properties should also be given in the valid format and null
270
+ * or empty values should be avoided.
271
+ * One dimension attribute should have only one role associated with it on a given chart.
272
+ */
273
+ setPresentationVariant(
274
+ /**
275
+ * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
276
+ */
277
+ presentationVariant: sap.fe.navigation.PresentationVariant
278
+ ): Promise<void>;
279
+ /**
280
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
281
+ * filters and then apply the SelectionVariant values.
282
+ *
283
+ *
284
+ * @returns A promise for asynchronous handling
285
+ */
286
+ setSelectionVariant(
287
+ /**
288
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
289
+ */
290
+ selectionVariant: sap.fe.navigation.SelectionVariant,
291
+ /**
292
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
293
+ * to display the filter value descriptions, instead of loading them from the backend
294
+ */
295
+ prefillDescriptions?: boolean
296
+ ): Promise<any>;
297
+ }
298
+
299
+ /**
300
+ * Event object of the Chart#selectionChange event.
301
+ */
302
+ type Chart$SelectionChangeEvent = sap.ui.base.Event<
303
+ Chart$SelectionChangeEventParameters,
304
+ Chart
305
+ >;
105
306
  }
106
307
 
107
308
  namespace controls {
@@ -111,257 +312,1106 @@ declare namespace sap {
111
312
  interface $BuildingBlockObjectPropertySettings
112
313
  extends sap.ui.core.$ElementSettings {}
113
314
 
315
+ /**
316
+ * Describes the settings that can be provided to the BuildingBlockWithTemplating constructor.
317
+ *
318
+ * @experimental
319
+ */
320
+ interface $BuildingBlockWithTemplatingSettings
321
+ extends sap.fe.core.buildingBlocks.$BuildingBlockBaseSettings {}
322
+
114
323
  /**
115
324
  * Base class for building block complex object properties that can be serialized to XML.
116
325
  */
117
326
  class BuildingBlockObjectProperty extends sap.ui.core.Element {}
327
+ /**
328
+ * Using this class you can define a building block that will manage and render a templating based building
329
+ * block.
330
+ * On change of the main properties you will be able to recreate the content.
331
+ *
332
+ * @experimental
333
+ */
334
+ class BuildingBlockWithTemplating extends sap.fe.core.buildingBlocks
335
+ .BuildingBlockBase {}
118
336
  }
119
337
 
120
- namespace filterBar {
338
+ namespace field {
121
339
  /**
122
- * Describes the settings that can be provided to the FilterField constructor.
340
+ * Describes the settings that can be provided to the Field constructor.
341
+ *
342
+ * @experimental
123
343
  */
124
- interface $FilterFieldSettings
125
- extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
126
- /**
127
- * Reference to the key of another filter already displayed in the table to properly place this one
128
- */
129
- anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
130
-
344
+ interface $FieldSettings
345
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
131
346
  /**
132
- * The property name of the FilterField
347
+ * Defines the path of the context used in the current page or block.
348
+ * This setting is defined by the framework.
133
349
  */
134
- key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
350
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
135
351
 
136
352
  /**
137
- * The text that will be displayed for this FilterField
353
+ * A set of options that can be configured.
138
354
  */
139
- label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
355
+ formatOptions?:
356
+ | sap.fe.macros.FieldFormatOptions
357
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
358
+ | `{${string}}`;
140
359
 
141
360
  /**
142
- * Defines where this filter should be placed relative to the defined anchor
143
- * Allowed values are `Before` and `After`
361
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
144
362
  */
145
- placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
363
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
146
364
 
147
365
  /**
148
- * If set, possible errors that occur during the search will be displayed in a message box.
366
+ * An expression that allows you to control the read-only state of the field.
367
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
368
+ * current state.
149
369
  */
150
- showMessages?:
370
+ readOnly?:
151
371
  | boolean
152
372
  | sap.ui.base.ManagedObject.PropertyBindingInfo
153
373
  | `{${string}}`;
374
+
375
+ /**
376
+ * Option to add semantic objects for a field.
377
+ * This parameter overwrites the semantic objects defined through annotations.
378
+ * Valid options are either a single semantic object, a stringified array of semantic objects,
379
+ * a formatter or a single binding expression returning either a single semantic object or an array of semantic
380
+ * objects.
381
+ */
382
+ semanticObject?:
383
+ | string
384
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
154
385
  }
155
386
 
156
387
  /**
157
- * Definition of a custom filter to be used inside the FilterBar.
158
- * The template for the FilterField has to be provided as the default aggregation
388
+ * Parameters of the Field#change event.
159
389
  */
160
- class FilterField extends sap.fe.macros.controls
161
- .BuildingBlockObjectProperty {}
162
- }
390
+ interface Field$ChangeEventParameters {}
163
391
 
164
- namespace richtexteditor {
165
392
  /**
166
- * Describes the settings that can be provided to the ButtonGroup constructor.
393
+ * Parameters of the Field#liveChange event.
167
394
  */
168
- interface $ButtonGroupSettings extends sap.ui.core.$ElementSettings {
169
- /**
170
- * The buttons to be displayed in the group.
171
- */
172
- buttons?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
395
+ interface Field$LiveChangeEventParameters {}
396
+
397
+ /**
398
+ * Building block for creating a field based on the metadata provided by OData V4.
399
+ *
400
+ *
401
+ * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
402
+ * property from the entity type.
403
+ * When creating a Field building block, you must provide an ID to ensure everything works correctly.
404
+ * Usage example:
405
+ *
406
+ * ```javascript
407
+ *
408
+ * sap.ui.require(["sap/fe/macros/field/Field"], function(Field) {
409
+ * ...
410
+ * new Field("MyField", {metaPath:"MyProperty"})
411
+ * })
412
+ * ```
413
+ *
414
+ * This is currently an experimental API because the structure of the generated content will change to come
415
+ * closer to the Field that you get out of templates.
416
+ * The public method and property will not change but the internal structure will so be careful on your
417
+ * usage.
418
+ *
419
+ *
420
+ * @experimental
421
+ */
422
+ class Field
423
+ extends sap.fe.macros.controls.BuildingBlockWithTemplating
424
+ implements sap.ui.core.IFormContent
425
+ {
426
+ __implements__sap_ui_core_IFormContent: boolean;
173
427
 
174
428
  /**
175
- * The priority of the group in the custom toolbar.
429
+ * Adds a message to the field.
430
+ *
431
+ *
432
+ * @returns The id of the message
176
433
  */
177
- customToolbarPriority?:
178
- | string
179
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
180
-
434
+ addMessage(
435
+ /**
436
+ * The parameters to create message
437
+ */
438
+ parameters: {
439
+ /**
440
+ * Message description
441
+ */
442
+ description?: string;
443
+ /**
444
+ * Message text
445
+ */
446
+ message?: string;
447
+ /**
448
+ * True if the message is persistent
449
+ */
450
+ persistent?: boolean;
451
+ /**
452
+ * Type of the message
453
+ */
454
+ type?: sap.ui.core.MessageType;
455
+ }
456
+ ): string;
457
+ /**
458
+ * Gets the current enablement state of the field.
459
+ *
460
+ *
461
+ * @returns Boolean value with the enablement state
462
+ */
463
+ getEnabled(): boolean;
181
464
  /**
182
- * The name of the group.
465
+ * Retrieves the current value of the field.
466
+ *
467
+ *
468
+ * @returns The current value of the field
183
469
  */
184
- name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
185
-
470
+ getValue(): boolean | string;
186
471
  /**
187
- * The priority of the group.
472
+ * Removes a message from the field.
188
473
  */
189
- priority?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
190
-
474
+ removeMessage(
475
+ /**
476
+ * The id of the message
477
+ */
478
+ id: string
479
+ ): void;
191
480
  /**
192
- * Whether the group is visible.
481
+ * Sets the current enablement state of the field.
482
+ *
483
+ *
484
+ * @returns The current field reference
193
485
  */
194
- visible?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
195
- }
196
-
197
- /**
198
- * Describes the settings that can be provided to the Plugin constructor.
199
- */
200
- interface $PluginSettings extends sap.ui.core.$ElementSettings {
486
+ setEnabled(): sap.ui.core.Control;
201
487
  /**
202
- * The plugin name.
488
+ * Sets the current value of the field.
489
+ *
490
+ *
491
+ * @returns The current field reference
203
492
  */
204
- name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
493
+ setValue(): sap.ui.core.Control;
205
494
  }
206
495
 
207
496
  /**
208
- * Button configurations for the RichTextEditor.
209
- */
210
- class ButtonGroup extends sap.ui.core.Element {}
211
- /**
212
- * Represents a TinyMCE plugin.
213
- * Each object has to contain a property "name" which then contains the plugin name/ID.
497
+ * Event object of the Field#change event.
214
498
  */
215
- class Plugin extends sap.ui.core.Element {}
216
- }
499
+ type Field$ChangeEvent = sap.ui.base.Event<
500
+ Field$ChangeEventParameters,
501
+ Field
502
+ >;
217
503
 
218
- namespace share {
219
504
  /**
220
- * Share Options.
505
+ * Event object of the Field#liveChange event.
221
506
  */
222
- type ShareOptions = {};
507
+ type Field$LiveChangeEvent = sap.ui.base.Event<
508
+ Field$LiveChangeEventParameters,
509
+ Field
510
+ >;
223
511
  }
224
512
 
225
- namespace table {
513
+ namespace filterBar {
226
514
  /**
227
- * Describes the settings that can be provided to the Action constructor.
515
+ * Describes the settings that can be provided to the FilterBar constructor.
516
+ *
517
+ * @experimental
228
518
  */
229
- interface $ActionSettings
230
- extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
519
+ interface $FilterBarSettings
520
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
231
521
  /**
232
- * Reference to the key of another action already displayed in the toolbar to properly place this one
522
+ * Defines the path of the context used in the current page or block.
523
+ * This setting is defined by the framework.
233
524
  */
234
- anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
525
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
235
526
 
236
527
  /**
237
- * Enables or disables the action
528
+ * If true, the search is triggered automatically when a filter value is changed.
238
529
  */
239
- enabled?:
530
+ liveMode?:
240
531
  | boolean
241
532
  | sap.ui.base.ManagedObject.PropertyBindingInfo
242
533
  | `{${string}}`;
243
534
 
244
535
  /**
245
- * Unique identifier of the action
536
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
246
537
  */
247
- key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
538
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
248
539
 
249
540
  /**
250
- * Defines where this action should be placed relative to the defined anchor
251
- * Allowed values are `Before` and `After`
541
+ * Handles the visibility of the 'Clear' button on the FilterBar.
252
542
  */
253
- placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
543
+ showClearButton?:
544
+ | boolean
545
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
546
+ | `{${string}}`;
254
547
 
255
548
  /**
256
- * Event handler to be called when the user chooses the action
549
+ * Displays possible errors during the search in a message box
257
550
  */
258
- press?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
551
+ showMessages?:
552
+ | boolean
553
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
554
+ | `{${string}}`;
259
555
 
260
556
  /**
261
- * Defines if the action requires a selection.
557
+ * Parameter which sets the visibility of the FilterBar building block
262
558
  */
263
- requiresSelection?:
559
+ visible?:
264
560
  | boolean
265
561
  | sap.ui.base.ManagedObject.PropertyBindingInfo
266
562
  | `{${string}}`;
267
563
 
268
564
  /**
269
- * The text that will be displayed for this action
565
+ * Aggregate filter fields of the FilterBar building block
270
566
  */
271
- text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
567
+ filterFields?:
568
+ | sap.fe.macros.filterBar.FilterField[]
569
+ | sap.fe.macros.filterBar.FilterField
570
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
571
+ | `{${string}}`;
272
572
  }
273
573
 
274
574
  /**
275
- * Describes the settings that can be provided to the ActionGroup constructor.
575
+ * Describes the settings that can be provided to the FilterField constructor.
276
576
  */
277
- interface $ActionGroupSettings
577
+ interface $FilterFieldSettings
278
578
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
279
579
  /**
280
- * Reference to the key of another action or action group already displayed in the toolbar to properly place
281
- * this one
580
+ * Reference to the key of another filter already displayed in the table to properly place this one
282
581
  */
283
582
  anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
284
583
 
285
584
  /**
286
- * Unique identifier of the ActionGroup
585
+ * The property name of the FilterField
287
586
  */
288
587
  key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
289
588
 
290
589
  /**
291
- * Defines where this action group should be placed relative to the defined anchor
292
- * Allowed values are `Before` and `After`
590
+ * The text that will be displayed for this FilterField
293
591
  */
294
- placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
592
+ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
295
593
 
296
594
  /**
297
- * The text that will be displayed for this action group
595
+ * Defines where this filter should be placed relative to the defined anchor
596
+ * Allowed values are `Before` and `After`
298
597
  */
299
- text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
598
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
300
599
 
301
600
  /**
302
- * Defines nested actions
601
+ * If set, possible errors that occur during the search will be displayed in a message box.
602
+ */
603
+ showMessages?:
604
+ | boolean
605
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
606
+ | `{${string}}`;
607
+ }
608
+
609
+ /**
610
+ * Parameters of the FilterBar#afterClear event.
611
+ */
612
+ interface FilterBar$AfterClearEventParameters {}
613
+
614
+ /**
615
+ * Parameters of the FilterBar#filterChanged event.
616
+ */
617
+ interface FilterBar$FilterChangedEventParameters {}
618
+
619
+ /**
620
+ * Parameters of the FilterBar#search event.
621
+ */
622
+ interface FilterBar$SearchEventParameters {}
623
+
624
+ /**
625
+ * Usage example:
626
+ *
627
+ * ```javascript
628
+ *
629
+ * sap.ui.require(["sap/fe/macros/filterBar/FilterBar"], function(FilterBar) {
630
+ * ...
631
+ * new FilterBar("MyFilterBar", {metaPath:"@com.sap.vocabularies.UI.v1.SelectionFields"})
632
+ * })
633
+ * ```
634
+ *
635
+ * This is currently an experimental API because the structure of the generated content will change to come
636
+ * closer to the FilterBar that you get out of templates.
637
+ * The public method and property will not change but the internal structure will so be careful on your
638
+ * usage.
639
+ *
640
+ *
641
+ * @experimental
642
+ */
643
+ class FilterBar extends sap.fe.macros.controls
644
+ .BuildingBlockWithTemplating {
645
+ /**
646
+ * Get the Active Filters Text Summary for the filter bar.
647
+ *
648
+ *
649
+ * @returns Active filters summary as text
650
+ */
651
+ getActiveFiltersText(): string;
652
+ /**
653
+ * Gets the key of the current variant in the associated variant management.
654
+ *
655
+ *
656
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
657
+ */
658
+ getCurrentVariantKey(): null | string;
659
+ /**
660
+ * Determines whether the field is enabled or disabled.
661
+ *
662
+ *
663
+ * @returns Whether the filterField is enabled or disabled.
664
+ */
665
+ getFilterFieldEnabled(
666
+ /**
667
+ * Name of the field.
668
+ */
669
+ name: string
670
+ ): boolean;
671
+ /**
672
+ * Gets the visibility of a filter field.
673
+ *
674
+ *
675
+ * @returns A {@link Promise } that resolves to check whether the filter field is visible or not.
676
+ */
677
+ getFilterFieldVisible(
678
+ /**
679
+ * The path to the property as a condition path
680
+ */
681
+ conditionPath: string
682
+ ): Promise<boolean>;
683
+ /**
684
+ * Provides all the filters that are currently active
685
+ * along with the search expression.
686
+ *
687
+ *
688
+ * @returns An array of active filters and the search expression.
689
+ */
690
+ getFilters(): object;
691
+ /**
692
+ * Get the selection variant from the filter bar.
693
+ *
694
+ *
695
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
696
+ */
697
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
698
+ /**
699
+ * Sets the new selected variant in the associated variant management.
700
+ */
701
+ setCurrentVariantKey(
702
+ /**
703
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
704
+ * ignored.
705
+ */
706
+ key: string
707
+ ): void;
708
+ /**
709
+ * Sets the enablement of the field.
710
+ */
711
+ setFilterFieldEnabled(
712
+ /**
713
+ * Name of the field that should be enabled or disabled.
714
+ */
715
+ name: string,
716
+ /**
717
+ * Whether the field should be enabled or disabled.
718
+ */
719
+ enabled: boolean
720
+ ): void;
721
+ /**
722
+ * Shows or hides any filter field from the filter bar.
723
+ * The property will not be hidden inside the adaptation dialog and may be re-added.
724
+ *
725
+ *
726
+ * @returns A {@link Promise } resolving once the change in visibility was applied
727
+ */
728
+ setFilterFieldVisible(
729
+ /**
730
+ * The path to the property as a condition path
731
+ */
732
+ conditionPath: string,
733
+ /**
734
+ * Whether it should be shown or hidden
735
+ */
736
+ visible: boolean
737
+ ): Promise<void>;
738
+ /**
739
+ * Set the filter values for the given property in the filter bar.
740
+ * The filter values can be either a single value or an array of values.
741
+ * Each filter value must be represented as a primitive value.
742
+ *
743
+ *
744
+ * @returns A promise for asynchronous handling
745
+ */
746
+ setFilterValues(
747
+ /**
748
+ * The path to the property as a condition path
749
+ */
750
+ sConditionPath: string,
751
+ /**
752
+ * The operator to be used (optional) - if not set, the default operator (EQ) will be used
753
+ */
754
+ sOperator: string | undefined,
755
+ /**
756
+ * The values to be applied
757
+ */
758
+ vValues?:
759
+ | boolean
760
+ | boolean[]
761
+ | number
762
+ | number[]
763
+ | string
764
+ | string[]
765
+ | undefined
766
+ ): Promise<void>;
767
+ /**
768
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
769
+ * existing filters and then apply the SelectionVariant values.
770
+ *
771
+ *
772
+ * @returns A promise for asynchronous handling
773
+ */
774
+ setSelectionVariant(
775
+ /**
776
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
777
+ */
778
+ selectionVariant: sap.fe.navigation.SelectionVariant,
779
+ /**
780
+ * Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
781
+ * to display the filter value descriptions, instead of loading them from the backend
782
+ */
783
+ prefillDescriptions?: boolean
784
+ ): Promise<any>;
785
+ /**
786
+ * Triggers the API search on the filter bar.
787
+ *
788
+ *
789
+ * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
790
+ */
791
+ triggerSearch(): Promise<object | undefined>;
792
+ }
793
+ /**
794
+ * Definition of a custom filter to be used inside the FilterBar.
795
+ * The template for the FilterField has to be provided as the default aggregation
796
+ */
797
+ class FilterField extends sap.fe.macros.controls
798
+ .BuildingBlockObjectProperty {}
799
+
800
+ /**
801
+ * Event object of the FilterBar#afterClear event.
802
+ */
803
+ type FilterBar$AfterClearEvent = sap.ui.base.Event<
804
+ FilterBar$AfterClearEventParameters,
805
+ FilterBar
806
+ >;
807
+
808
+ /**
809
+ * Event object of the FilterBar#filterChanged event.
810
+ */
811
+ type FilterBar$FilterChangedEvent = sap.ui.base.Event<
812
+ FilterBar$FilterChangedEventParameters,
813
+ FilterBar
814
+ >;
815
+
816
+ /**
817
+ * Event object of the FilterBar#search event.
818
+ */
819
+ type FilterBar$SearchEvent = sap.ui.base.Event<
820
+ FilterBar$SearchEventParameters,
821
+ FilterBar
822
+ >;
823
+ }
824
+
825
+ namespace microchart {
826
+ /**
827
+ * Describes the settings that can be provided to the MicroChart constructor.
828
+ *
829
+ * @experimental
830
+ */
831
+ interface $MicroChartSettings
832
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {}
833
+
834
+ /**
835
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
836
+ * Usage example:
837
+ *
838
+ * ```javascript
839
+ *
840
+ * sap.ui.require(["sap/fe/macros/microchart/MicroChart"], function(MicroChart) {
841
+ * ...
842
+ * new MicroChart("microChartID", {metaPath:"MyProperty"})
843
+ * })
844
+ * ```
845
+ *
846
+ * This is currently an experimental API because the structure of the generated content will change to come
847
+ * closer to the MicroChart that you get out of templates.
848
+ * The public method and property will not change but the internal structure will so be careful on your
849
+ * usage.
850
+ *
851
+ *
852
+ * @experimental
853
+ */
854
+ class MicroChart extends sap.fe.macros.controls
855
+ .BuildingBlockWithTemplating {}
856
+ }
857
+
858
+ namespace richtexteditor {
859
+ /**
860
+ * Describes the settings that can be provided to the ButtonGroup constructor.
861
+ */
862
+ interface $ButtonGroupSettings extends sap.ui.core.$ElementSettings {
863
+ /**
864
+ * The buttons to be displayed in the group.
865
+ */
866
+ buttons?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
867
+
868
+ /**
869
+ * The priority of the group in the custom toolbar.
870
+ */
871
+ customToolbarPriority?:
872
+ | string
873
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
874
+
875
+ /**
876
+ * The name of the group.
877
+ */
878
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
879
+
880
+ /**
881
+ * The priority of the group.
882
+ */
883
+ priority?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
884
+
885
+ /**
886
+ * Whether the group is visible.
887
+ */
888
+ visible?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
889
+ }
890
+
891
+ /**
892
+ * Describes the settings that can be provided to the Plugin constructor.
893
+ */
894
+ interface $PluginSettings extends sap.ui.core.$ElementSettings {
895
+ /**
896
+ * The plugin name.
897
+ */
898
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
899
+ }
900
+
901
+ /**
902
+ * Button configurations for the RichTextEditor.
903
+ */
904
+ class ButtonGroup extends sap.ui.core.Element {}
905
+ /**
906
+ * Represents a TinyMCE plugin.
907
+ * Each object has to contain a property "name" which then contains the plugin name/ID.
908
+ */
909
+ class Plugin extends sap.ui.core.Element {}
910
+ }
911
+
912
+ namespace share {
913
+ /**
914
+ * Share Options.
915
+ */
916
+ type ShareOptions = {};
917
+ }
918
+
919
+ namespace table {
920
+ /**
921
+ * Describes the settings that can be provided to the Action constructor.
922
+ */
923
+ interface $ActionSettings
924
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
925
+ /**
926
+ * Reference to the key of another action already displayed in the toolbar to properly place this one
927
+ */
928
+ anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
929
+
930
+ /**
931
+ * Enables or disables the action
932
+ */
933
+ enabled?:
934
+ | boolean
935
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
936
+ | `{${string}}`;
937
+
938
+ /**
939
+ * Unique identifier of the action
940
+ */
941
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
942
+
943
+ /**
944
+ * Defines where this action should be placed relative to the defined anchor
945
+ * Allowed values are `Before` and `After`
946
+ */
947
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
948
+
949
+ /**
950
+ * Event handler to be called when the user chooses the action
951
+ */
952
+ press?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
953
+
954
+ /**
955
+ * Defines if the action requires a selection.
956
+ */
957
+ requiresSelection?:
958
+ | boolean
959
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
960
+ | `{${string}}`;
961
+
962
+ /**
963
+ * The text that will be displayed for this action
964
+ */
965
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
966
+ }
967
+
968
+ /**
969
+ * Describes the settings that can be provided to the ActionGroup constructor.
970
+ */
971
+ interface $ActionGroupSettings
972
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
973
+ /**
974
+ * Reference to the key of another action or action group already displayed in the toolbar to properly place
975
+ * this one
976
+ */
977
+ anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
978
+
979
+ /**
980
+ * Unique identifier of the ActionGroup
981
+ */
982
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
983
+
984
+ /**
985
+ * Defines where this action group should be placed relative to the defined anchor
986
+ * Allowed values are `Before` and `After`
987
+ */
988
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
989
+
990
+ /**
991
+ * The text that will be displayed for this action group
992
+ */
993
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
994
+
995
+ /**
996
+ * Defines nested actions
997
+ */
998
+ actions?:
999
+ | sap.fe.macros.table.Action[]
1000
+ | sap.fe.macros.table.Action
1001
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1002
+ | `{${string}}`;
1003
+ }
1004
+
1005
+ /**
1006
+ * Describes the settings that can be provided to the Column constructor.
1007
+ */
1008
+ interface $ColumnSettings
1009
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1010
+ /**
1011
+ * Reference to the key of another column already displayed in the table to properly place this one
1012
+ */
1013
+ anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1014
+
1015
+ /**
1016
+ * The text that will be displayed for this column header
1017
+ */
1018
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1019
+
1020
+ /**
1021
+ * Aligns the header as well as the content horizontally
1022
+ */
1023
+ horizontalAlign?:
1024
+ | string
1025
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1026
+
1027
+ /**
1028
+ * Defines the column importance.
1029
+ * You can define which columns should be automatically moved to the pop-in area based on their importance
1030
+ */
1031
+ importance?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1032
+
1033
+ /**
1034
+ * Unique identifier of the column
1035
+ */
1036
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1037
+
1038
+ /**
1039
+ * Defines where this column should be placed relative to the defined anchor
1040
+ * Allowed values are `Before` and `After`
1041
+ */
1042
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1043
+
1044
+ /**
1045
+ * Defines the column's width.
1046
+ * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
1047
+ */
1048
+ width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1049
+
1050
+ /**
1051
+ * Indicates if the column header should be a part of the width calculation.
1052
+ */
1053
+ widthIncludingColumnHeader?:
1054
+ | boolean
1055
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1056
+ | `{${string}}`;
1057
+ }
1058
+
1059
+ /**
1060
+ * Describes the settings that can be provided to the Table constructor.
1061
+ *
1062
+ * @experimental (since 1.124.0)
1063
+ */
1064
+ interface $TableSettings
1065
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
1066
+ /**
1067
+ * An expression that allows you to control the 'busy' state of the table.
1068
+ */
1069
+ busy?:
1070
+ | boolean
1071
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1072
+ | `{${string}}`;
1073
+
1074
+ /**
1075
+ * Defines the path of the context used in the current page or block.
1076
+ * This setting is defined by the framework.
1077
+ */
1078
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1079
+
1080
+ /**
1081
+ * A set of options that can be configured.
1082
+ */
1083
+ creationMode?:
1084
+ | sap.fe.macros.table.TableCreationOptions
1085
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1086
+ | `{${string}}`;
1087
+
1088
+ /**
1089
+ * Controls if the copy functionality of the table is disabled or not.
1090
+ */
1091
+ disableCopyToClipboard?:
1092
+ | boolean
1093
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1094
+ | `{${string}}`;
1095
+
1096
+ /**
1097
+ * Specifies if the column width is automatically calculated.
1098
+ */
1099
+ enableAutoColumnWidth?:
1100
+ | boolean
1101
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1102
+ | `{${string}}`;
1103
+
1104
+ /**
1105
+ * Controls if the export functionality of the table is enabled or not.
1106
+ */
1107
+ enableExport?:
1108
+ | boolean
1109
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1110
+ | `{${string}}`;
1111
+
1112
+ /**
1113
+ * Controls whether the table can be opened in fullscreen mode or not.
1114
+ */
1115
+ enableFullScreen?:
1116
+ | boolean
1117
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1118
+ | `{${string}}`;
1119
+
1120
+ /**
1121
+ * Controls if the paste functionality of the table is enabled or not.
1122
+ */
1123
+ enablePaste?:
1124
+ | boolean
1125
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1126
+ | `{${string}}`;
1127
+
1128
+ /**
1129
+ * Maximum allowed number of records to be exported in one request.
1130
+ */
1131
+ exportRequestSize?:
1132
+ | int
1133
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1134
+ | `{${string}}`;
1135
+
1136
+ /**
1137
+ * ID of the FilterBar building block associated with the table.
1138
+ */
1139
+ filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1140
+
1141
+ /**
1142
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
1143
+ * This property is not relevant for responsive tables
1144
+ */
1145
+ frozenColumnCount?:
1146
+ | int
1147
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1148
+ | `{${string}}`;
1149
+
1150
+ /**
1151
+ * Specifies the header text that is shown in the table.
1152
+ */
1153
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1154
+
1155
+ /**
1156
+ * Controls if the header text should be shown or not.
1157
+ */
1158
+ headerVisible?:
1159
+ | boolean
1160
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1161
+ | `{${string}}`;
1162
+
1163
+ /**
1164
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
1165
+ *
1166
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
1167
+ * value of fields that are provided in the ignoredfields.
1168
+ *
1169
+ * Any column referencing an ignored field is to be removed.
1170
+ */
1171
+ ignoredFields?:
1172
+ | string
1173
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1174
+
1175
+ /**
1176
+ * Defines whether to display the search action.
1177
+ */
1178
+ isSearchable?:
1179
+ | boolean
1180
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1181
+ | `{${string}}`;
1182
+
1183
+ /**
1184
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
1185
+ * based on the current contextPath.
1186
+ */
1187
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1188
+
1189
+ /**
1190
+ * Controls which options should be enabled for the table personalization dialog.
1191
+ * If it is set to `true`, all possible options for this kind of table are enabled.
1192
+ *
1193
+ * If it is set to `false`, personalization is disabled.
1194
+ *
1195
+ *
1196
+ *
1197
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
1198
+ * with the options you want to be available.
1199
+ *
1200
+ * Available options are:
1201
+ *
1202
+ * - Sort
1203
+ *
1204
+ * - Column
1205
+ *
1206
+ * - Filter
1207
+ */
1208
+ personalization?:
1209
+ | string
1210
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1211
+
1212
+ /**
1213
+ * An expression that allows you to control the 'read-only' state of the table.
1214
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
1215
+ * current state.
1216
+ */
1217
+ readOnly?:
1218
+ | boolean
1219
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1220
+ | `{${string}}`;
1221
+
1222
+ /**
1223
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
1224
+ */
1225
+ rowCount?:
1226
+ | int
1227
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1228
+ | `{${string}}`;
1229
+
1230
+ /**
1231
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
1232
+ * Allowed values are `Auto`, `Fixed`.
1233
+ *
1234
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
1235
+ *
1236
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
1237
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
1238
+ * less than defined in the `rowCount` property.
1239
+ */
1240
+ rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1241
+
1242
+ /**
1243
+ * Defines the selection mode to be used by the table.
1244
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
1245
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
1246
+ * the consistent selection mode.
1247
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
1248
+ * Fiori guidelines.
1249
+ */
1250
+ selectionMode?:
1251
+ | string
1252
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1253
+
1254
+ /**
1255
+ * Defines the type of table that will be used by the building block to render the data.
1256
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
1257
+ */
1258
+ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1259
+
1260
+ /**
1261
+ * Controls the kind of variant management that should be enabled for the table.
1262
+ * Allowed value is `Control`.
1263
+ *
1264
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
1265
+ * to this.
1266
+ *
1267
+ * If not set with any value, control level variant management is not available for this table.
1268
+ */
1269
+ variantManagement?:
1270
+ | string
1271
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1272
+
1273
+ /**
1274
+ * Indicates if the column header should be a part of the width calculation.
1275
+ */
1276
+ widthIncludingColumnHeader?:
1277
+ | boolean
1278
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1279
+ | `{${string}}`;
1280
+
1281
+ /**
1282
+ * Aggregate actions of the table.
303
1283
  */
304
1284
  actions?:
305
- | sap.fe.macros.table.Action[]
1285
+ | Array<
1286
+ sap.fe.macros.table.ActionGroup | sap.fe.macros.table.Action
1287
+ >
1288
+ | sap.fe.macros.table.ActionGroup
306
1289
  | sap.fe.macros.table.Action
307
1290
  | sap.ui.base.ManagedObject.AggregationBindingInfo
308
1291
  | `{${string}}`;
1292
+
1293
+ /**
1294
+ * Aggregate columns of the table.
1295
+ */
1296
+ columns?:
1297
+ | sap.fe.macros.table.Column[]
1298
+ | sap.fe.macros.table.Column
1299
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1300
+ | `{${string}}`;
309
1301
  }
310
1302
 
311
1303
  /**
312
- * Describes the settings that can be provided to the Column constructor.
1304
+ * Describes the settings that can be provided to the TableCreationOptions constructor.
313
1305
  */
314
- interface $ColumnSettings
1306
+ interface $TableCreationOptionsSettings
315
1307
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
316
1308
  /**
317
- * Reference to the key of another column already displayed in the table to properly place this one
318
- */
319
- anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
320
-
321
- /**
322
- * The text that will be displayed for this column header
1309
+ * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
1310
+ * 'Inline'
1311
+ *
1312
+ * The default value is 'false'
323
1313
  */
324
- header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1314
+ createAtEnd?:
1315
+ | boolean
1316
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1317
+ | `{${string}}`;
325
1318
 
326
1319
  /**
327
- * Aligns the header as well as the content horizontally
1320
+ * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
1321
+ * to responsive tables.
1322
+ *
1323
+ * The default value is 'false'
328
1324
  */
329
- horizontalAlign?:
330
- | string
331
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1325
+ inlineCreationRowsHiddenInEditMode?:
1326
+ | boolean
1327
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1328
+ | `{${string}}`;
332
1329
 
333
1330
  /**
334
- * Defines the column importance.
335
- * You can define which columns should be automatically moved to the pop-in area based on their importance
1331
+ * Defines the creation mode to be used by the table.
1332
+ * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
1333
+ *
1334
+ *
1335
+ *
1336
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
1337
+ * or 'Deferred' is used
1338
+ *
1339
+ * Inline - The creation is done inline
1340
+ *
1341
+ * InlineCreationsRows - The creation is done inline with an empty row
1342
+ *
1343
+ * External - The creation is done in a different application specified via the parameter 'outbound'
1344
+ * If not set with any value:
1345
+ *
1346
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
336
1347
  */
337
- importance?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1348
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
338
1349
 
339
1350
  /**
340
- * Unique identifier of the column
1351
+ * The navigation target where the document is created in case of creationMode 'External'
341
1352
  */
342
- key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1353
+ outbound?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1354
+ }
343
1355
 
1356
+ /**
1357
+ * Describes the settings that can be provided to the TreeTableCreationOptions constructor.
1358
+ */
1359
+ interface $TreeTableCreationOptionsSettings
1360
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
344
1361
  /**
345
- * Defines where this column should be placed relative to the defined anchor
346
- * Allowed values are `Before` and `After`
1362
+ * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
347
1363
  */
348
- placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1364
+ isCreateEnabled?:
1365
+ | string
1366
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
349
1367
 
350
1368
  /**
351
- * Defines the column's width.
352
- * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
1369
+ * Defines the creation mode to be used by the tree table.
1370
+ * Allowed values are `NewPage` or `Inline`.
1371
+ *
1372
+ *
1373
+ *
1374
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
1375
+ * or 'Deferred' is used.
1376
+ *
1377
+ * Inline - the creation is done inline.
1378
+ *
1379
+ * If not set with any value:
1380
+ *
1381
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
353
1382
  */
354
- width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1383
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
355
1384
 
356
1385
  /**
357
- * Indicates if the column header should be a part of the width calculation.
1386
+ * Defines the nodes to be added on the custom create.
1387
+ * This object must have the following properties:
1388
+ * propertyName: the name of the property on the page entity set used to categorize the node type to be
1389
+ * created within the hierarchy
1390
+ *
1391
+ * values: an array of key and label that define a value of the property defined by the propertyName key
1392
+ * and its label
358
1393
  */
359
- widthIncludingColumnHeader?:
360
- | boolean
1394
+ nodeType?:
1395
+ | object
361
1396
  | sap.ui.base.ManagedObject.PropertyBindingInfo
362
1397
  | `{${string}}`;
363
1398
  }
364
1399
 
1400
+ /**
1401
+ * Parameters of the Table#beforeRebindTable event.
1402
+ */
1403
+ interface Table$BeforeRebindTableEventParameters {}
1404
+
1405
+ /**
1406
+ * Parameters of the Table#rowPress event.
1407
+ */
1408
+ interface Table$RowPressEventParameters {}
1409
+
1410
+ /**
1411
+ * Parameters of the Table#selectionChange event.
1412
+ */
1413
+ interface Table$SelectionChangeEventParameters {}
1414
+
365
1415
  /**
366
1416
  * Definition of a custom action to be used inside the table toolbar
367
1417
  */
@@ -378,49 +1428,313 @@ declare namespace sap {
378
1428
  */
379
1429
  class Column extends sap.fe.macros.controls
380
1430
  .BuildingBlockObjectProperty {}
381
-
382
1431
  /**
383
- * Create options for the table.
1432
+ * Building block used to create a table based on the metadata provided by OData V4.
1433
+ *
1434
+ *
1435
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
1436
+ * the Table building block can also be used to display an EntitySet.
1437
+ *
1438
+ *
1439
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
1440
+ *
1441
+ *
1442
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
1443
+ * also has a UI.LineItem as the first property of the Visualizations.
1444
+ * Usage example:
1445
+ *
1446
+ * ```javascript
1447
+ *
1448
+ * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
1449
+ * ...
1450
+ * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
1451
+ * })
1452
+ * ```
1453
+ *
1454
+ * This is currently an experimental API because the structure of the generated content will change to come
1455
+ * closer to the Table that you get out of templates.
1456
+ * The public method and property will not change but the internal structure will so be careful on your
1457
+ * usage.
1458
+ *
1459
+ *
1460
+ * @since 1.124.0
1461
+ * @experimental (since 1.124.0)
384
1462
  */
385
- type TableCreationOptions = {
1463
+ class Table extends sap.fe.macros.controls.BuildingBlockWithTemplating {
386
1464
  /**
387
- * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
388
- * 'Inline'
1465
+ * Adds an action to the table.
389
1466
  *
390
- * The default value is 'false'
1467
+ * @since 1.124.0
1468
+ * @experimental (since 1.124.0)
1469
+ *
1470
+ * @returns Reference to this in order to allow method chaining
391
1471
  */
392
- createAtEnd: boolean;
1472
+ addAction(
1473
+ /**
1474
+ * The action to add
1475
+ */
1476
+ action: sap.fe.macros.table.Action
1477
+ ): this;
393
1478
  /**
394
- * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
395
- * to responsive tables.
1479
+ * Adds a column to the table.
396
1480
  *
397
- * The default value is 'false'
1481
+ * @since 1.124.0
1482
+ * @experimental (since 1.124.0)
1483
+ *
1484
+ * @returns Reference to this in order to allow method chaining
398
1485
  */
399
- inlineCreationRowsHiddenInEditMode: boolean;
1486
+ addColumn(
1487
+ /**
1488
+ * The column to add
1489
+ */
1490
+ column: sap.fe.macros.table.Column
1491
+ ): this;
400
1492
  /**
401
- * Defines the creation mode to be used by the table.
402
- * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
1493
+ * Adds a message to the table.
1494
+ * The message applies to the whole table and not to an individual table row.
403
1495
  *
404
1496
  *
405
1497
  *
406
- * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
407
- * or 'Deferred' is used
1498
+ * @returns The ID of the message
1499
+ */
1500
+ addMessage(
1501
+ /**
1502
+ * The parameters to create the message
1503
+ */
1504
+ parameters: {
1505
+ /**
1506
+ * Message description
1507
+ */
1508
+ description?: string;
1509
+ /**
1510
+ * Message text
1511
+ */
1512
+ message?: string;
1513
+ /**
1514
+ * True if the message is persistent
1515
+ */
1516
+ persistent?: boolean;
1517
+ /**
1518
+ * Message type
1519
+ */
1520
+ type?: sap.ui.core.MessageType;
1521
+ }
1522
+ ): string;
1523
+ /**
1524
+ * Get the variant management applied to the table.
408
1525
  *
409
- * Inline - The creation is done inline
410
1526
  *
411
- * InlineCreationsRows - The creation is done inline with an empty row
1527
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1528
+ */
1529
+ getCurrentVariantKey(): null | string;
1530
+ /**
1531
+ * Get the fields that should be ignored when generating the table.
1532
+ *
1533
+ * @since 1.124.0
1534
+ * @experimental (since 1.124.0)
1535
+ *
1536
+ * @returns The value of the ignoredFields property
1537
+ */
1538
+ getIgnoredFields(): string;
1539
+ /**
1540
+ * Gets the path to the metadata that should be used to generate the table.
1541
+ *
1542
+ * @since 1.124.0
1543
+ * @experimental (since 1.124.0)
1544
+ *
1545
+ * @returns The path to the metadata
1546
+ */
1547
+ getMetaPath(): string;
1548
+ /**
1549
+ * Get the presentation variant that is currently applied on the table.
1550
+ *
1551
+ *
1552
+ * @returns The presentation variant applied to the table
1553
+ */
1554
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
1555
+ /**
1556
+ * Gets contexts from the table that have been selected by the user.
1557
+ *
1558
+ *
1559
+ * @returns Contexts of the rows selected by the user
1560
+ */
1561
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
1562
+ /**
1563
+ * Get the selection variant from the Table.
1564
+ *
1565
+ *
1566
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1567
+ */
1568
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
1569
+ /**
1570
+ * Hide the columns with the given column keys by setting their availability to Default.
1571
+ *
1572
+ * @since 1.124.0
1573
+ * @experimental (since 1.124.0)
1574
+ *
1575
+ * @returns Promise
1576
+ */
1577
+ hideColumns(
1578
+ /**
1579
+ * The keys for the columns to hide
1580
+ */
1581
+ columnKeys: string[]
1582
+ ): Promise<void>;
1583
+ /**
1584
+ * Requests a refresh of the table.
1585
+ */
1586
+ refresh(): void;
1587
+ /**
1588
+ * Removes an action from the table.
1589
+ *
1590
+ * @since 1.124.0
1591
+ * @experimental (since 1.124.0)
1592
+ *
1593
+ * @returns The removed action or null
1594
+ */
1595
+ removeAction(
1596
+ /**
1597
+ * The action to remove, or its index or ID
1598
+ */
1599
+ action: number | sap.fe.macros.table.Action | string
1600
+ ): null | sap.fe.macros.table.Action;
1601
+ /**
1602
+ * Removes a column from the table.
1603
+ *
1604
+ * @since 1.124.0
1605
+ * @experimental (since 1.124.0)
1606
+ *
1607
+ * @returns The removed column or null
1608
+ */
1609
+ removeColumn(
1610
+ /**
1611
+ * The column to remove, or its index or ID
1612
+ */
1613
+ column: number | sap.fe.macros.table.Column | string
1614
+ ): null | sap.fe.macros.table.Column;
1615
+ /**
1616
+ * Removes a message from the table.
1617
+ */
1618
+ removeMessage(
1619
+ /**
1620
+ * The id of the message
1621
+ */
1622
+ id: string
1623
+ ): void;
1624
+ /**
1625
+ * Set a variant management to the table.
1626
+ */
1627
+ setCurrentVariantKey(
1628
+ /**
1629
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
1630
+ * ignored.
1631
+ */
1632
+ key: string
1633
+ ): void;
1634
+ /**
1635
+ * Sets the fields that should be ignored when generating the table.
1636
+ *
1637
+ * @since 1.124.0
1638
+ * @experimental (since 1.124.0)
1639
+ *
1640
+ * @returns Reference to this in order to allow method chaining
1641
+ */
1642
+ setIgnoredFields(
1643
+ /**
1644
+ * The fields to ignore
1645
+ */
1646
+ ignoredFields: string
1647
+ ): this;
1648
+ /**
1649
+ * Sets the path to the metadata that should be used to generate the table.
1650
+ *
1651
+ * @since 1.124.0
1652
+ * @experimental (since 1.124.0)
1653
+ *
1654
+ * @returns Reference to this in order to allow method chaining
1655
+ */
1656
+ setMetaPath(
1657
+ /**
1658
+ * The path to the metadata
1659
+ */
1660
+ metaPath: string
1661
+ ): this;
1662
+ /**
1663
+ * Set a new presentation variant to the table.
1664
+ */
1665
+ setPresentationVariant(
1666
+ /**
1667
+ * The new presentation variant that is to be set on the table.
1668
+ */
1669
+ tablePV: sap.fe.navigation.PresentationVariant
1670
+ ): Promise<void>;
1671
+ /**
1672
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
1673
+ * filters and then apply the SelectionVariant values.
412
1674
  *
413
- * External - The creation is done in a different application specified via the parameter 'outbound'
414
- * If not set with any value:
415
1675
  *
416
- * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1676
+ * @returns A promise for asynchronous handling
417
1677
  */
418
- name: string;
1678
+ setSelectionVariant(
1679
+ /**
1680
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
1681
+ */
1682
+ selectionVariant: sap.fe.navigation.SelectionVariant,
1683
+ /**
1684
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
1685
+ * to display the filter value descriptions, instead of loading them from the backend
1686
+ */
1687
+ prefillDescriptions?: boolean
1688
+ ): Promise<any>;
419
1689
  /**
420
- * The navigation target where the document is created in case of creationMode 'External'
1690
+ * Show the columns with the given column keys by setting their availability to Default.
1691
+ *
1692
+ * @since 1.124.0
1693
+ * @experimental (since 1.124.0)
1694
+ *
1695
+ * @returns Promise
421
1696
  */
422
- outbound: string;
423
- };
1697
+ showColumns(
1698
+ /**
1699
+ * The keys for the columns to show
1700
+ */
1701
+ columnKeys: string[]
1702
+ ): Promise<void>;
1703
+ }
1704
+ /**
1705
+ * Create options for the table.
1706
+ */
1707
+ class TableCreationOptions extends sap.fe.macros.controls
1708
+ .BuildingBlockObjectProperty {}
1709
+ /**
1710
+ * Create options for the tree table.
1711
+ */
1712
+ class TreeTableCreationOptions extends sap.fe.macros.controls
1713
+ .BuildingBlockObjectProperty {}
1714
+
1715
+ /**
1716
+ * Event object of the Table#beforeRebindTable event.
1717
+ */
1718
+ type Table$BeforeRebindTableEvent = sap.ui.base.Event<
1719
+ Table$BeforeRebindTableEventParameters,
1720
+ Table
1721
+ >;
1722
+
1723
+ /**
1724
+ * Event object of the Table#rowPress event.
1725
+ */
1726
+ type Table$RowPressEvent = sap.ui.base.Event<
1727
+ Table$RowPressEventParameters,
1728
+ Table
1729
+ >;
1730
+
1731
+ /**
1732
+ * Event object of the Table#selectionChange event.
1733
+ */
1734
+ type Table$SelectionChangeEvent = sap.ui.base.Event<
1735
+ Table$SelectionChangeEventParameters,
1736
+ Table
1737
+ >;
424
1738
  }
425
1739
  /**
426
1740
  * Describes the settings that can be provided to the MacroAPI constructor.
@@ -552,10 +1866,8 @@ declare namespace sap {
552
1866
  * - Filter
553
1867
  */
554
1868
  personalization?:
555
- | boolean
556
1869
  | string
557
- | sap.ui.base.ManagedObject.PropertyBindingInfo
558
- | `{${string}}`;
1870
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
559
1871
 
560
1872
  /**
561
1873
  * Defines the selection mode to be used by the chart.
@@ -907,39 +2219,274 @@ declare namespace sap {
907
2219
  | `{${string}}`;
908
2220
 
909
2221
  /**
910
- * Use the 'required' attribute, to make sure that the editor is filled with some text.
2222
+ * Use the 'required' attribute, to make sure that the editor is filled with some text.
2223
+ */
2224
+ required?:
2225
+ | boolean
2226
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2227
+ | `{${string}}`;
2228
+ }
2229
+
2230
+ /**
2231
+ * Describes the settings that can be provided to the Share constructor.
2232
+ */
2233
+ interface $ShareSettings extends sap.ui.core.$ControlSettings {
2234
+ /**
2235
+ * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
2236
+ */
2237
+ shareOptions?:
2238
+ | object
2239
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2240
+ | `{${string}}`;
2241
+
2242
+ /**
2243
+ * Whether the share control should be visible on the screen.
2244
+ */
2245
+ visible?:
2246
+ | boolean
2247
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2248
+ | `{${string}}`;
2249
+ }
2250
+
2251
+ /**
2252
+ * Describes the settings that can be provided to the Table constructor.
2253
+ */
2254
+ interface $TableSettings extends sap.fe.macros.$MacroAPISettings {
2255
+ /**
2256
+ * An expression that allows you to control the 'busy' state of the table.
2257
+ */
2258
+ busy?:
2259
+ | boolean
2260
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2261
+ | `{${string}}`;
2262
+
2263
+ /**
2264
+ * Defines the path of the context used in the current page or block.
2265
+ * This setting is defined by the framework.
2266
+ */
2267
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2268
+
2269
+ /**
2270
+ * A set of options that can be configured.
2271
+ */
2272
+ creationMode?:
2273
+ | sap.fe.macros.table.TableCreationOptions
2274
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2275
+ | `{${string}}`;
2276
+
2277
+ /**
2278
+ * Controls if the copy functionality of the table is disabled or not.
2279
+ */
2280
+ disableCopyToClipboard?:
2281
+ | boolean
2282
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2283
+ | `{${string}}`;
2284
+
2285
+ /**
2286
+ * Specifies if the column width is automatically calculated.
2287
+ */
2288
+ enableAutoColumnWidth?:
2289
+ | boolean
2290
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2291
+ | `{${string}}`;
2292
+
2293
+ /**
2294
+ * Controls if the export functionality of the table is enabled or not.
2295
+ */
2296
+ enableExport?:
2297
+ | boolean
2298
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2299
+ | `{${string}}`;
2300
+
2301
+ /**
2302
+ * Controls whether the table can be opened in fullscreen mode or not.
2303
+ */
2304
+ enableFullScreen?:
2305
+ | boolean
2306
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2307
+ | `{${string}}`;
2308
+
2309
+ /**
2310
+ * Controls if the paste functionality of the table is enabled or not.
2311
+ */
2312
+ enablePaste?:
2313
+ | boolean
2314
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2315
+ | `{${string}}`;
2316
+
2317
+ /**
2318
+ * Maximum allowed number of records to be exported in one request.
2319
+ */
2320
+ exportRequestSize?:
2321
+ | int
2322
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2323
+ | `{${string}}`;
2324
+
2325
+ /**
2326
+ * ID of the FilterBar building block associated with the table.
2327
+ */
2328
+ filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2329
+
2330
+ /**
2331
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
2332
+ * This property is not relevant for responsive tables
2333
+ */
2334
+ frozenColumnCount?:
2335
+ | int
2336
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2337
+ | `{${string}}`;
2338
+
2339
+ /**
2340
+ * Specifies the header text that is shown in the table.
2341
+ */
2342
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2343
+
2344
+ /**
2345
+ * Controls if the header text should be shown or not.
2346
+ */
2347
+ headerVisible?:
2348
+ | boolean
2349
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2350
+ | `{${string}}`;
2351
+
2352
+ /**
2353
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
2354
+ *
2355
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
2356
+ * value of fields that are provided in the ignoredfields.
2357
+ *
2358
+ * Any column referencing an ignored field is to be removed.
2359
+ */
2360
+ ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2361
+
2362
+ /**
2363
+ * Defines whether to display the search action.
2364
+ */
2365
+ isSearchable?:
2366
+ | boolean
2367
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2368
+ | `{${string}}`;
2369
+
2370
+ /**
2371
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
2372
+ * based on the current contextPath.
2373
+ */
2374
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2375
+
2376
+ /**
2377
+ * Controls which options should be enabled for the table personalization dialog.
2378
+ * If it is set to `true`, all possible options for this kind of table are enabled.
2379
+ *
2380
+ * If it is set to `false`, personalization is disabled.
2381
+ *
2382
+ *
2383
+ *
2384
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
2385
+ * with the options you want to be available.
2386
+ *
2387
+ * Available options are:
2388
+ *
2389
+ * - Sort
2390
+ *
2391
+ * - Column
2392
+ *
2393
+ * - Filter
2394
+ */
2395
+ personalization?:
2396
+ | string
2397
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2398
+
2399
+ /**
2400
+ * An expression that allows you to control the 'read-only' state of the table.
2401
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
2402
+ * current state.
2403
+ */
2404
+ readOnly?:
2405
+ | boolean
2406
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2407
+ | `{${string}}`;
2408
+
2409
+ /**
2410
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
2411
+ */
2412
+ rowCount?:
2413
+ | int
2414
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2415
+ | `{${string}}`;
2416
+
2417
+ /**
2418
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
2419
+ * Allowed values are `Auto`, `Fixed`.
2420
+ *
2421
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
2422
+ *
2423
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
2424
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
2425
+ * less than defined in the `rowCount` property.
2426
+ */
2427
+ rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2428
+
2429
+ /**
2430
+ * Defines the selection mode to be used by the table.
2431
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
2432
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
2433
+ * the consistent selection mode.
2434
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
2435
+ * Fiori guidelines.
2436
+ */
2437
+ selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2438
+
2439
+ /**
2440
+ * Defines the type of table that will be used by the building block to render the data.
2441
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
2442
+ */
2443
+ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2444
+
2445
+ /**
2446
+ * Controls the kind of variant management that should be enabled for the table.
2447
+ * Allowed value is `Control`.
2448
+ *
2449
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
2450
+ * to this.
2451
+ *
2452
+ * If not set with any value, control level variant management is not available for this table.
2453
+ */
2454
+ variantManagement?:
2455
+ | string
2456
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2457
+
2458
+ /**
2459
+ * Indicates if the column header should be a part of the width calculation.
911
2460
  */
912
- required?:
2461
+ widthIncludingColumnHeader?:
913
2462
  | boolean
914
2463
  | sap.ui.base.ManagedObject.PropertyBindingInfo
915
2464
  | `{${string}}`;
916
- }
917
2465
 
918
- /**
919
- * Describes the settings that can be provided to the Share constructor.
920
- */
921
- interface $ShareSettings extends sap.ui.core.$ControlSettings {
922
2466
  /**
923
- * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
2467
+ * Aggregate actions of the table.
924
2468
  */
925
- shareOptions?:
926
- | object
927
- | sap.ui.base.ManagedObject.PropertyBindingInfo
2469
+ actions?:
2470
+ | Array<sap.fe.macros.table.ActionGroup | sap.fe.macros.table.Action>
2471
+ | sap.fe.macros.table.ActionGroup
2472
+ | sap.fe.macros.table.Action
2473
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
928
2474
  | `{${string}}`;
929
2475
 
930
2476
  /**
931
- * Whether the share control should be visible on the screen.
2477
+ * Aggregate columns of the table.
932
2478
  */
933
- visible?:
934
- | boolean
935
- | sap.ui.base.ManagedObject.PropertyBindingInfo
2479
+ columns?:
2480
+ | sap.fe.macros.table.Column[]
2481
+ | sap.fe.macros.table.Column
2482
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
936
2483
  | `{${string}}`;
937
2484
  }
938
2485
 
939
2486
  /**
940
- * Describes the settings that can be provided to the Table constructor.
2487
+ * Describes the settings that can be provided to the TreeTable constructor.
941
2488
  */
942
- interface $TableSettings extends sap.fe.macros.$MacroAPISettings {
2489
+ interface $TreeTableSettings extends sap.fe.macros.$MacroAPISettings {
943
2490
  /**
944
2491
  * An expression that allows you to control the 'busy' state of the table.
945
2492
  */
@@ -958,7 +2505,7 @@ declare namespace sap {
958
2505
  * A set of options that can be configured.
959
2506
  */
960
2507
  creationMode?:
961
- | sap.fe.macros.table.TableCreationOptions
2508
+ | sap.fe.macros.table.TreeTableCreationOptions
962
2509
  | sap.ui.base.ManagedObject.PropertyBindingInfo
963
2510
  | `{${string}}`;
964
2511
 
@@ -1006,7 +2553,7 @@ declare namespace sap {
1006
2553
  * Maximum allowed number of records to be exported in one request.
1007
2554
  */
1008
2555
  exportRequestSize?:
1009
- | number
2556
+ | int
1010
2557
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1011
2558
  | `{${string}}`;
1012
2559
 
@@ -1020,7 +2567,7 @@ declare namespace sap {
1020
2567
  * This property is not relevant for responsive tables
1021
2568
  */
1022
2569
  frozenColumnCount?:
1023
- | number
2570
+ | int
1024
2571
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1025
2572
  | `{${string}}`;
1026
2573
 
@@ -1037,6 +2584,35 @@ declare namespace sap {
1037
2584
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1038
2585
  | `{${string}}`;
1039
2586
 
2587
+ /**
2588
+ * A set of options that can be configured.
2589
+ */
2590
+ hierarchyQualifier?:
2591
+ | string
2592
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2593
+
2594
+ /**
2595
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
2596
+ *
2597
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
2598
+ * value of fields that are provided in the ignoredfields.
2599
+ *
2600
+ * Any column referencing an ignored field is to be removed.
2601
+ */
2602
+ ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2603
+
2604
+ /**
2605
+ * Defines the extension point to control if a source node can be dropped on a specific parent node.
2606
+ */
2607
+ isMoveToPositionAllowed?:
2608
+ | string
2609
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2610
+
2611
+ /**
2612
+ * Defines the extension point to control if a node can be dragged.
2613
+ */
2614
+ isNodeMovable?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2615
+
1040
2616
  /**
1041
2617
  * Defines whether to display the search action.
1042
2618
  */
@@ -1071,10 +2647,8 @@ declare namespace sap {
1071
2647
  * - Filter
1072
2648
  */
1073
2649
  personalization?:
1074
- | boolean
1075
2650
  | string
1076
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1077
- | `{${string}}`;
2651
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1078
2652
 
1079
2653
  /**
1080
2654
  * An expression that allows you to control the 'read-only' state of the table.
@@ -1090,7 +2664,7 @@ declare namespace sap {
1090
2664
  * Number of rows to be displayed in the table. Does not apply to responsive tables.
1091
2665
  */
1092
2666
  rowCount?:
1093
- | number
2667
+ | int
1094
2668
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1095
2669
  | `{${string}}`;
1096
2670
 
@@ -1117,8 +2691,9 @@ declare namespace sap {
1117
2691
  selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1118
2692
 
1119
2693
  /**
1120
- * Defines the type of table that will be used by the building block to render the data.
1121
- * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
2694
+ * Defines the type of table that will be used by the building block to render the data. This setting is
2695
+ * defined by the framework.
2696
+ * Allowed value is `TreeTable`.
1122
2697
  */
1123
2698
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1124
2699
 
@@ -1213,6 +2788,21 @@ declare namespace sap {
1213
2788
  */
1214
2789
  interface Table$SelectionChangeEventParameters {}
1215
2790
 
2791
+ /**
2792
+ * Parameters of the TreeTable#beforeRebindTable event.
2793
+ */
2794
+ interface TreeTable$BeforeRebindTableEventParameters {}
2795
+
2796
+ /**
2797
+ * Parameters of the TreeTable#rowPress event.
2798
+ */
2799
+ interface TreeTable$RowPressEventParameters {}
2800
+
2801
+ /**
2802
+ * Parameters of the TreeTable#selectionChange event.
2803
+ */
2804
+ interface TreeTable$SelectionChangeEventParameters {}
2805
+
1216
2806
  /**
1217
2807
  * API to add parameters to the collection binding infos.
1218
2808
  */
@@ -1271,7 +2861,8 @@ declare namespace sap {
1271
2861
  */
1272
2862
  class MacroAPI
1273
2863
  extends sap.fe.core.buildingBlocks.BuildingBlockBase
1274
- implements sap.ui.core.IFormContent {
2864
+ implements sap.ui.core.IFormContent
2865
+ {
1275
2866
  __implements__sap_ui_core_IFormContent: boolean;
1276
2867
  }
1277
2868
  /**
@@ -1293,10 +2884,16 @@ declare namespace sap {
1293
2884
  *
1294
2885
  * ```javascript
1295
2886
  *
1296
- * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
2887
+ * <macros:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
1297
2888
  * ```
1298
2889
  */
1299
- class Chart extends sap.fe.macros.MacroAPI {
2890
+ class Chart
2891
+ extends sap.fe.macros.MacroAPI
2892
+ implements
2893
+ /* was: sap.fe.macros.controls.section.ISingleSectionContributor */ Object
2894
+ {
2895
+ __implements__sap_fe_macros_controls_section_ISingleSectionContributor: boolean;
2896
+
1300
2897
  /**
1301
2898
  * Gets the key of the current variant in the associated variant management.
1302
2899
  *
@@ -1374,7 +2971,7 @@ declare namespace sap {
1374
2971
  *
1375
2972
  * ```javascript
1376
2973
  *
1377
- * <macro:FlexibleColumnLayoutActions />
2974
+ * <macros:FlexibleColumnLayoutActions />
1378
2975
  * ```
1379
2976
  *
1380
2977
  *
@@ -1394,7 +2991,7 @@ declare namespace sap {
1394
2991
  *
1395
2992
  * ```javascript
1396
2993
  *
1397
- * <macro:Field id="MyField" metaPath="MyProperty" />
2994
+ * <macros:Field id="MyField" metaPath="MyProperty" />
1398
2995
  * ```
1399
2996
  */
1400
2997
  class Field extends sap.fe.macros.MacroAPI {
@@ -1475,7 +3072,7 @@ declare namespace sap {
1475
3072
  *
1476
3073
  * ```javascript
1477
3074
  *
1478
- * <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
3075
+ * <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
1479
3076
  * ```
1480
3077
  */
1481
3078
  class FilterBar extends sap.fe.macros.MacroAPI {
@@ -1638,7 +3235,7 @@ declare namespace sap {
1638
3235
  *
1639
3236
  * ```javascript
1640
3237
  *
1641
- * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
3238
+ * <macros:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
1642
3239
  * ```
1643
3240
  */
1644
3241
  class Form extends sap.ui.core.Control {}
@@ -1670,7 +3267,7 @@ declare namespace sap {
1670
3267
  *
1671
3268
  * ```javascript
1672
3269
  *
1673
- * <macro:MultiValueField
3270
+ * <macros:MultiValueField
1674
3271
  * id="SomeUniqueIdentifier"
1675
3272
  * contextPath="{entitySet>}"
1676
3273
  * metaPath="{dataField>}"
@@ -1688,7 +3285,7 @@ declare namespace sap {
1688
3285
  *
1689
3286
  * ```javascript
1690
3287
  *
1691
- * <macro:Paginator />
3288
+ * <macros:Paginator />
1692
3289
  * ```
1693
3290
  *
1694
3291
  *
@@ -1719,7 +3316,7 @@ declare namespace sap {
1719
3316
  *
1720
3317
  * ```javascript
1721
3318
  *
1722
- * <macro:Share
3319
+ * <macros:Share
1723
3320
  * id="someID"
1724
3321
  * visible="true"
1725
3322
  * />
@@ -1747,7 +3344,7 @@ declare namespace sap {
1747
3344
  *
1748
3345
  * ```javascript
1749
3346
  *
1750
- * <macro:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
3347
+ * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
1751
3348
  * ```
1752
3349
  */
1753
3350
  class Table extends sap.fe.macros.MacroAPI {
@@ -1789,6 +3386,180 @@ declare namespace sap {
1789
3386
  * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1790
3387
  */
1791
3388
  getCurrentVariantKey(): null | string;
3389
+ /**
3390
+ * Get the fields that should be ignored when generating the table.
3391
+ *
3392
+ * @since 1.124.0
3393
+ * @experimental (since 1.124.0)
3394
+ *
3395
+ * @returns The value of the ignoredFields property
3396
+ */
3397
+ getIgnoredFields(): string;
3398
+ /**
3399
+ * Get the presentation variant that is currently applied on the table.
3400
+ *
3401
+ *
3402
+ * @returns The presentation variant applied to the table
3403
+ */
3404
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
3405
+ /**
3406
+ * Gets contexts from the table that have been selected by the user.
3407
+ *
3408
+ *
3409
+ * @returns Contexts of the rows selected by the user
3410
+ */
3411
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
3412
+ /**
3413
+ * Get the selection variant from the Table.
3414
+ *
3415
+ *
3416
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
3417
+ */
3418
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
3419
+ /**
3420
+ * Hide the columns with the given column keys by setting their availability to Default.
3421
+ *
3422
+ * @since 1.124.0
3423
+ * @experimental (since 1.124.0)
3424
+ *
3425
+ * @returns Promise
3426
+ */
3427
+ hideColumns(
3428
+ /**
3429
+ * The keys for the columns to hide
3430
+ */
3431
+ columnKeys: string[]
3432
+ ): Promise<void>;
3433
+ /**
3434
+ * Requests a refresh of the table.
3435
+ */
3436
+ refresh(): void;
3437
+ /**
3438
+ * Removes a message from the table.
3439
+ */
3440
+ removeMessage(
3441
+ /**
3442
+ * The id of the message
3443
+ */
3444
+ id: string
3445
+ ): void;
3446
+ /**
3447
+ * Set a variant management to the table.
3448
+ */
3449
+ setCurrentVariantKey(
3450
+ /**
3451
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
3452
+ * ignored.
3453
+ */
3454
+ key: string
3455
+ ): void;
3456
+ /**
3457
+ * Sets the fields that should be ignored when generating the table.
3458
+ *
3459
+ * @since 1.124.0
3460
+ * @experimental (since 1.124.0)
3461
+ *
3462
+ * @returns Reference to this in order to allow method chaining
3463
+ */
3464
+ setIgnoredFields(
3465
+ /**
3466
+ * The fields to ignore
3467
+ */
3468
+ ignoredFields: string
3469
+ ): this;
3470
+ /**
3471
+ * Set a new presentation variant to the table.
3472
+ */
3473
+ setPresentationVariant(
3474
+ /**
3475
+ * The new presentation variant that is to be set on the table.
3476
+ */
3477
+ tablePV: sap.fe.navigation.PresentationVariant
3478
+ ): Promise<void>;
3479
+ /**
3480
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
3481
+ * filters and then apply the SelectionVariant values.
3482
+ *
3483
+ *
3484
+ * @returns A promise for asynchronous handling
3485
+ */
3486
+ setSelectionVariant(
3487
+ /**
3488
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
3489
+ */
3490
+ selectionVariant: sap.fe.navigation.SelectionVariant,
3491
+ /**
3492
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
3493
+ * to display the filter value descriptions, instead of loading them from the backend
3494
+ */
3495
+ prefillDescriptions?: boolean
3496
+ ): Promise<any>;
3497
+ /**
3498
+ * Show the columns with the given column keys by setting their availability to Default.
3499
+ *
3500
+ * @since 1.124.0
3501
+ * @experimental (since 1.124.0)
3502
+ *
3503
+ * @returns Promise
3504
+ */
3505
+ showColumns(
3506
+ /**
3507
+ * The keys for the columns to show
3508
+ */
3509
+ columnKeys: string[]
3510
+ ): Promise<void>;
3511
+ }
3512
+ /**
3513
+ * Building block used to create a tree table based on the metadata provided by OData V4.
3514
+ */
3515
+ class TreeTable extends sap.fe.macros.MacroAPI {
3516
+ /**
3517
+ * Adds a message to the table.
3518
+ * The message applies to the whole table and not to an individual table row.
3519
+ *
3520
+ *
3521
+ *
3522
+ * @returns The ID of the message
3523
+ */
3524
+ addMessage(
3525
+ /**
3526
+ * The parameters to create the message
3527
+ */
3528
+ parameters: {
3529
+ /**
3530
+ * Message description
3531
+ */
3532
+ description?: string;
3533
+ /**
3534
+ * Message text
3535
+ */
3536
+ message?: string;
3537
+ /**
3538
+ * True if the message is persistent
3539
+ */
3540
+ persistent?: boolean;
3541
+ /**
3542
+ * Message type
3543
+ */
3544
+ type?: sap.ui.core.MessageType;
3545
+ }
3546
+ ): string;
3547
+ /**
3548
+ * Get the variant management applied to the table.
3549
+ *
3550
+ *
3551
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
3552
+ */
3553
+ getCurrentVariantKey(): null | string;
3554
+ /**
3555
+ * Get the fields that should be ignored when generating the table.
3556
+ *
3557
+ * @since 1.124.0
3558
+ * @experimental (since 1.124.0)
3559
+ *
3560
+ * @returns The value of the ignoredFields property
3561
+ */
3562
+ getIgnoredFields(): string;
1792
3563
  /**
1793
3564
  * Get the presentation variant that is currently applied on the table.
1794
3565
  *
@@ -1810,6 +3581,20 @@ declare namespace sap {
1810
3581
  * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1811
3582
  */
1812
3583
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
3584
+ /**
3585
+ * Hide the columns with the given column keys by setting their availability to Default.
3586
+ *
3587
+ * @since 1.124.0
3588
+ * @experimental (since 1.124.0)
3589
+ *
3590
+ * @returns Promise
3591
+ */
3592
+ hideColumns(
3593
+ /**
3594
+ * The keys for the columns to hide
3595
+ */
3596
+ columnKeys: string[]
3597
+ ): Promise<void>;
1813
3598
  /**
1814
3599
  * Requests a refresh of the table.
1815
3600
  */
@@ -1833,6 +3618,20 @@ declare namespace sap {
1833
3618
  */
1834
3619
  key: string
1835
3620
  ): void;
3621
+ /**
3622
+ * Sets the fields that should be ignored when generating the table.
3623
+ *
3624
+ * @since 1.124.0
3625
+ * @experimental (since 1.124.0)
3626
+ *
3627
+ * @returns Reference to this in order to allow method chaining
3628
+ */
3629
+ setIgnoredFields(
3630
+ /**
3631
+ * The fields to ignore
3632
+ */
3633
+ ignoredFields: string
3634
+ ): this;
1836
3635
  /**
1837
3636
  * Set a new presentation variant to the table.
1838
3637
  */
@@ -1860,6 +3659,20 @@ declare namespace sap {
1860
3659
  */
1861
3660
  prefillDescriptions?: boolean
1862
3661
  ): Promise<any>;
3662
+ /**
3663
+ * Show the columns with the given column keys by setting their availability to Default.
3664
+ *
3665
+ * @since 1.124.0
3666
+ * @experimental (since 1.124.0)
3667
+ *
3668
+ * @returns Promise
3669
+ */
3670
+ showColumns(
3671
+ /**
3672
+ * The keys for the columns to show
3673
+ */
3674
+ columnKeys: string[]
3675
+ ): Promise<void>;
1863
3676
  }
1864
3677
 
1865
3678
  /**
@@ -2015,6 +3828,30 @@ declare namespace sap {
2015
3828
  Table$SelectionChangeEventParameters,
2016
3829
  Table
2017
3830
  >;
3831
+
3832
+ /**
3833
+ * Event object of the TreeTable#beforeRebindTable event.
3834
+ */
3835
+ type TreeTable$BeforeRebindTableEvent = sap.ui.base.Event<
3836
+ TreeTable$BeforeRebindTableEventParameters,
3837
+ TreeTable
3838
+ >;
3839
+
3840
+ /**
3841
+ * Event object of the TreeTable#rowPress event.
3842
+ */
3843
+ type TreeTable$RowPressEvent = sap.ui.base.Event<
3844
+ TreeTable$RowPressEventParameters,
3845
+ TreeTable
3846
+ >;
3847
+
3848
+ /**
3849
+ * Event object of the TreeTable#selectionChange event.
3850
+ */
3851
+ type TreeTable$SelectionChangeEvent = sap.ui.base.Event<
3852
+ TreeTable$SelectionChangeEventParameters,
3853
+ TreeTable
3854
+ >;
2018
3855
  }
2019
3856
  }
2020
3857
 
@@ -2023,16 +3860,24 @@ declare namespace sap {
2023
3860
 
2024
3861
  "sap/fe/macros/chart/ActionGroup": undefined;
2025
3862
 
3863
+ "sap/fe/macros/chart/Chart": undefined;
3864
+
2026
3865
  "sap/fe/macros/chart/ChartAPI": undefined;
2027
3866
 
2028
3867
  "sap/fe/macros/CollectionBindingInfo": undefined;
2029
3868
 
2030
3869
  "sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;
2031
3870
 
3871
+ "sap/fe/macros/controls/BuildingBlockWithTemplating": undefined;
3872
+
2032
3873
  "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block": undefined;
2033
3874
 
3875
+ "sap/fe/macros/field/Field": undefined;
3876
+
2034
3877
  "sap/fe/macros/field/FieldAPI": undefined;
2035
3878
 
3879
+ "sap/fe/macros/filterBar/FilterBar": undefined;
3880
+
2036
3881
  "sap/fe/macros/filterBar/FilterBarAPI": undefined;
2037
3882
 
2038
3883
  "sap/fe/macros/filterBar/FilterField": undefined;
@@ -2047,6 +3892,8 @@ declare namespace sap {
2047
3892
 
2048
3893
  "sap/fe/macros/MacroAPI": undefined;
2049
3894
 
3895
+ "sap/fe/macros/microchart/MicroChart": undefined;
3896
+
2050
3897
  "sap/fe/macros/microchart/MicroChart.block": undefined;
2051
3898
 
2052
3899
  "sap/fe/macros/multiValueField/MultiValueField.block": undefined;
@@ -2069,6 +3916,14 @@ declare namespace sap {
2069
3916
 
2070
3917
  "sap/fe/macros/table/Column": undefined;
2071
3918
 
2072
- "sap/fe/macros/table/TableAPI": undefined;
3919
+ "sap/fe/macros/table/Table": undefined;
3920
+
3921
+ "sap/fe/macros/table/Table.block": undefined;
3922
+
3923
+ "sap/fe/macros/table/TableCreationOptions": undefined;
3924
+
3925
+ "sap/fe/macros/table/TreeTable.block": undefined;
3926
+
3927
+ "sap/fe/macros/table/TreeTableCreationOptions": undefined;
2073
3928
  }
2074
3929
  }