@sapui5/ts-types 1.134.1 → 1.136.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +80 -0
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +106 -3
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +34 -6
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +1706 -820
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +6 -4
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +152 -21
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +767 -72
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +355 -1389
  30. package/types/sap.suite.ui.commons.d.ts +86 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +13 -3
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +215 -15
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +3859 -690
  37. package/types/sap.ui.core.d.ts +274 -147
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +10 -2
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +2 -2
  44. package/types/sap.ui.layout.d.ts +11 -10
  45. package/types/sap.ui.mdc.d.ts +152 -13
  46. package/types/sap.ui.richtexteditor.d.ts +39 -1
  47. package/types/sap.ui.rta.d.ts +31 -5
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +22 -16
  50. package/types/sap.ui.table.d.ts +16 -18
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +42 -31
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +305 -97
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +62 -49
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +11 -21
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.134.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -553,10 +553,10 @@ declare namespace sap {
553
553
  /**
554
554
  * Describes the settings that can be provided to the Field constructor.
555
555
  *
556
+ * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field } instead
556
557
  * @experimental
557
558
  */
558
- interface $FieldSettings
559
- extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
559
+ interface $FieldSettings extends sap.ui.core.$ControlSettings {
560
560
  /**
561
561
  * Defines the path of the context used in the current page or block.
562
562
  * This setting is defined by the framework.
@@ -777,14 +777,10 @@ declare namespace sap {
777
777
  * usage.
778
778
  *
779
779
  *
780
+ * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field } instead
780
781
  * @experimental
781
782
  */
782
- class Field
783
- extends sap.fe.macros.controls.BuildingBlockWithTemplating
784
- implements sap.ui.core.IFormContent
785
- {
786
- __implements__sap_ui_core_IFormContent: boolean;
787
-
783
+ class Field extends sap.ui.core.Control {
788
784
  /**
789
785
  * Adds a message to the field.
790
786
  *
@@ -977,7 +973,8 @@ declare namespace sap {
977
973
  | `{${string}}`;
978
974
 
979
975
  /**
980
- * If set, possible errors that occur during the search will be displayed in a message box.
976
+ * This property is not required at filter field level. To achieve the desired behavior, specify the showMessages
977
+ * property in the FilterBar building block.
981
978
  */
982
979
  showMessages?:
983
980
  | boolean
@@ -1207,22 +1204,37 @@ declare namespace sap {
1207
1204
  /**
1208
1205
  * Describes the settings that can be provided to the MicroChart constructor.
1209
1206
  *
1207
+ * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart } instead
1210
1208
  * @experimental
1211
1209
  */
1212
1210
  interface $MicroChartSettings
1213
- extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
1211
+ extends sap.fe.macros.$MicroChartSettings {
1212
+ /**
1213
+ * context path to the MicroChart.
1214
+ */
1215
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1216
+
1214
1217
  /**
1215
1218
  * Show blank space in case there is no data in the chart
1216
1219
  */
1217
- hideOnNoData?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1220
+ hideOnNoData?:
1221
+ | boolean
1222
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1223
+ | `{${string}}`;
1224
+
1225
+ /**
1226
+ * Metadata path to the MicroChart.
1227
+ */
1228
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1218
1229
 
1219
1230
  /**
1220
1231
  * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do
1221
1232
  * not see the inner labels of the MicroChart as well.
1222
1233
  */
1223
1234
  showOnlyChart?:
1224
- | string
1225
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1235
+ | boolean
1236
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1237
+ | `{${string}}`;
1226
1238
 
1227
1239
  /**
1228
1240
  * Size of the MicroChart
@@ -1232,6 +1244,9 @@ declare namespace sap {
1232
1244
 
1233
1245
  /**
1234
1246
  * Building block used to create a MicroChart based on the metadata provided by OData V4.
1247
+ *
1248
+ *
1249
+ * Usually, a contextPath and metaPath is expected.
1235
1250
  * Usage example:
1236
1251
  *
1237
1252
  * ```javascript
@@ -1248,10 +1263,81 @@ declare namespace sap {
1248
1263
  * usage.
1249
1264
  *
1250
1265
  *
1266
+ * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart } instead
1251
1267
  * @experimental
1252
1268
  */
1253
- class MicroChart extends sap.fe.macros.controls
1254
- .BuildingBlockWithTemplating {}
1269
+ class MicroChart extends sap.fe.macros.MicroChart {
1270
+ /**
1271
+ * Gets current value of property contextPath.
1272
+ *
1273
+ *
1274
+ * @returns Value of property `contextPath`
1275
+ */
1276
+ getContextPath(): string;
1277
+ /**
1278
+ * Gets current value of property hideOnNoData.
1279
+ *
1280
+ *
1281
+ * @returns Value of property `hideOnNoData`
1282
+ */
1283
+ getHideOnNoData(): boolean;
1284
+ /**
1285
+ * Gets current value of property metaPath.
1286
+ *
1287
+ *
1288
+ * @returns Value of property `metaPath`
1289
+ */
1290
+ getMetaPath(): string;
1291
+ /**
1292
+ * Gets current value of property showOnlyChart.
1293
+ *
1294
+ *
1295
+ * @returns Value of property `showOnlyChart`
1296
+ */
1297
+ getShowOnlyChart(): boolean;
1298
+ /**
1299
+ * Gets current value of property size.
1300
+ *
1301
+ *
1302
+ * @returns Value of property `size`
1303
+ */
1304
+ getSize(): string;
1305
+ /**
1306
+ * Gets current value of property contextPath.
1307
+ *
1308
+ *
1309
+ * @returns Value of property `contextPath`
1310
+ */
1311
+ setContextPath(): string;
1312
+ /**
1313
+ * Gets current value of property hideOnNoData.
1314
+ *
1315
+ *
1316
+ * @returns Value of property `hideOnNoData`
1317
+ */
1318
+ setHideOnNoData(): boolean;
1319
+ /**
1320
+ * Gets current value of property metaPath.
1321
+ *
1322
+ *
1323
+ * @returns Value of property `metaPath`
1324
+ */
1325
+ setMetaPath(): string;
1326
+ /**
1327
+ * Gets current value of property showOnlyChart.
1328
+ *
1329
+ *
1330
+ * @returns Value of property `showOnlyChart`
1331
+ */
1332
+ setShowOnlyChart(): boolean;
1333
+ /**
1334
+ * Gets current value of property size.
1335
+ *
1336
+ *
1337
+ * @returns Value of property `size`
1338
+ */
1339
+ setSize(): string;
1340
+ }
1255
1341
  }
1256
1342
 
1257
1343
  namespace richtexteditor {
@@ -1345,6 +1431,11 @@ declare namespace sap {
1345
1431
  */
1346
1432
  anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1347
1433
 
1434
+ /**
1435
+ * Determines the shortcut combination to trigger the action
1436
+ */
1437
+ command?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1438
+
1348
1439
  /**
1349
1440
  * Enables or disables the action
1350
1441
  */
@@ -1353,6 +1444,14 @@ declare namespace sap {
1353
1444
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1354
1445
  | `{${string}}`;
1355
1446
 
1447
+ /**
1448
+ * Determines whether the action requires selecting one item or multiple items.
1449
+ * Allowed values are `single` and `multi`
1450
+ */
1451
+ enableOnSelect?:
1452
+ | string
1453
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1454
+
1356
1455
  /**
1357
1456
  * Unique identifier of the action
1358
1457
  */
@@ -1364,11 +1463,6 @@ declare namespace sap {
1364
1463
  */
1365
1464
  placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1366
1465
 
1367
- /**
1368
- * Event handler to be called when the user chooses the action
1369
- */
1370
- press?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1371
-
1372
1466
  /**
1373
1467
  * Defines if the action requires a selection.
1374
1468
  */
@@ -1381,6 +1475,14 @@ declare namespace sap {
1381
1475
  * The text that will be displayed for this action
1382
1476
  */
1383
1477
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1478
+
1479
+ /**
1480
+ * Determines whether the action is visible.
1481
+ */
1482
+ visible?:
1483
+ | boolean
1484
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1485
+ | `{${string}}`;
1384
1486
  }
1385
1487
 
1386
1488
  /**
@@ -1394,13 +1496,20 @@ declare namespace sap {
1394
1496
  */
1395
1497
  anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1396
1498
 
1499
+ /**
1500
+ * Determines the default action to be executed on the action group.
1501
+ */
1502
+ defaultAction?:
1503
+ | string
1504
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1505
+
1397
1506
  /**
1398
1507
  * Unique identifier of the ActionGroup
1399
1508
  */
1400
1509
  key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1401
1510
 
1402
1511
  /**
1403
- * Defines where this action group should be placed relative to the defined anchor
1512
+ * Determines where this action group should be placed relative to the defined anchor
1404
1513
  * Allowed values are `Before` and `After`
1405
1514
  */
1406
1515
  placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -1411,312 +1520,277 @@ declare namespace sap {
1411
1520
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1412
1521
 
1413
1522
  /**
1414
- * Defines nested actions
1523
+ * Determines the nested actions
1415
1524
  */
1416
1525
  actions?:
1417
- | sap.fe.macros.table.Action[]
1526
+ | Array<
1527
+ sap.fe.macros.table.ActionOverride | sap.fe.macros.table.Action
1528
+ >
1529
+ | sap.fe.macros.table.ActionOverride
1418
1530
  | sap.fe.macros.table.Action
1419
1531
  | sap.ui.base.ManagedObject.AggregationBindingInfo
1420
1532
  | `{${string}}`;
1421
1533
  }
1422
1534
 
1423
1535
  /**
1424
- * Describes the settings that can be provided to the Column constructor.
1536
+ * Describes the settings that can be provided to the ActionGroupOverride constructor.
1425
1537
  */
1426
- interface $ColumnSettings
1538
+ interface $ActionGroupOverrideSettings
1427
1539
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1428
1540
  /**
1429
- * Reference to the key of another column already displayed in the table to properly place this one
1541
+ * Reference to the key of another action or action group already displayed in the toolbar to properly place
1542
+ * this one
1430
1543
  */
1431
1544
  anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1432
1545
 
1433
1546
  /**
1434
- * The text that will be displayed for this column header
1435
- */
1436
- header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1437
-
1438
- /**
1439
- * Aligns the header as well as the content horizontally
1547
+ * Unique identifier of the ActionGroup to overridden.
1440
1548
  */
1441
- horizontalAlign?:
1442
- | string
1443
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1549
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1444
1550
 
1445
1551
  /**
1446
- * Defines the column importance.
1447
- * You can define which columns should be automatically moved to the pop-in area based on their importance
1552
+ * Determines where this action group should be placed relative to the defined anchor
1553
+ * Allowed values are `Before` and `After`
1448
1554
  */
1449
- importance?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1555
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1450
1556
 
1451
1557
  /**
1452
- * Unique identifier of the column
1558
+ * Determines the nested actions
1453
1559
  */
1454
- key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1560
+ actions?:
1561
+ | Array<
1562
+ sap.fe.macros.table.ActionOverride | sap.fe.macros.table.Action
1563
+ >
1564
+ | sap.fe.macros.table.ActionOverride
1565
+ | sap.fe.macros.table.Action
1566
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1567
+ | `{${string}}`;
1568
+ }
1455
1569
 
1570
+ /**
1571
+ * Describes the settings that can be provided to the ActionOverride constructor.
1572
+ */
1573
+ interface $ActionOverrideSettings
1574
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1456
1575
  /**
1457
- * Defines where this column should be placed relative to the defined anchor
1458
- * Allowed values are `Before` and `After`
1576
+ * Reference to the key of another action already displayed in the toolbar to properly place this one
1459
1577
  */
1460
- placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1578
+ anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1461
1579
 
1462
1580
  /**
1463
- * Defines the properties displayed in the column
1464
- * The properties allow to export, sort, group, copy, and paste in the column
1581
+ * Determines the shortcut combination to trigger the action
1465
1582
  */
1466
- properties?:
1467
- | string[]
1468
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1469
- | `{${string}}`;
1583
+ command?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1470
1584
 
1471
1585
  /**
1472
- * Defines the column's width.
1473
- * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
1586
+ * Determines the function to get the default values of the action.
1474
1587
  */
1475
- width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1588
+ defaultValuesFunction?:
1589
+ | string
1590
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1476
1591
 
1477
1592
  /**
1478
- * Indicates if the column header should be a part of the width calculation.
1593
+ * Determines if the auto scroll is enabled after executing the action.
1479
1594
  */
1480
- widthIncludingColumnHeader?:
1595
+ enableAutoScroll?:
1481
1596
  | boolean
1482
1597
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1483
1598
  | `{${string}}`;
1484
- }
1485
1599
 
1486
- /**
1487
- * Describes the settings that can be provided to the Table constructor.
1488
- *
1489
- * @experimental As of version 1.124.0.
1490
- */
1491
- interface $TableSettings
1492
- extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
1493
1600
  /**
1494
- * An expression that allows you to control the 'busy' state of the table.
1601
+ * Enables or disables the action
1495
1602
  */
1496
- busy?:
1603
+ enabled?:
1497
1604
  | boolean
1498
1605
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1499
1606
  | `{${string}}`;
1500
1607
 
1501
1608
  /**
1502
- * Defines the path of the context used in the current page or block.
1503
- * This setting is defined by the framework.
1609
+ * Determines whether the action requires selecting one item or multiple items.
1610
+ * Allowed values are `single` and `multi`
1504
1611
  */
1505
- contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1612
+ enableOnSelect?:
1613
+ | string
1614
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1506
1615
 
1507
1616
  /**
1508
- * A set of options that can be configured.
1617
+ * Unique identifier of the action to overridden.
1509
1618
  */
1510
- creationMode?:
1511
- | sap.fe.macros.table.TableCreationOptions
1512
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1513
- | `{${string}}`;
1619
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1514
1620
 
1515
1621
  /**
1516
- * Controls if the copy functionality of the table is disabled or not.
1622
+ * Determines whether there is a navigation after executing the action.
1517
1623
  */
1518
- disableCopyToClipboard?:
1624
+ navigateToInstance?:
1519
1625
  | boolean
1520
1626
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1521
1627
  | `{${string}}`;
1522
1628
 
1523
1629
  /**
1524
- * Specifies if the column width is automatically calculated.
1630
+ * Defines where this action should be placed relative to the defined anchor
1631
+ * Allowed values are `Before` and `After`
1525
1632
  */
1526
- enableAutoColumnWidth?:
1527
- | boolean
1528
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1529
- | `{${string}}`;
1633
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1530
1634
 
1531
1635
  /**
1532
- * Controls if the export functionality of the table is enabled or not.
1636
+ * Determines whether the action is visible.
1533
1637
  */
1534
- enableExport?:
1638
+ visible?:
1535
1639
  | boolean
1536
1640
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1537
1641
  | `{${string}}`;
1642
+ }
1538
1643
 
1644
+ /**
1645
+ * Describes the settings that can be provided to the AnalyticalConfiguration constructor.
1646
+ */
1647
+ interface $AnalyticalConfigurationSettings
1648
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1539
1649
  /**
1540
- * Controls whether the table can be opened in fullscreen mode or not.
1650
+ * True if leaf level rows shall display aggregated data
1541
1651
  */
1542
- enableFullScreen?:
1652
+ aggregationOnLeafLevel?:
1543
1653
  | boolean
1544
1654
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1545
1655
  | `{${string}}`;
1656
+ }
1546
1657
 
1658
+ /**
1659
+ * Describes the settings that can be provided to the Column constructor.
1660
+ */
1661
+ interface $ColumnSettings
1662
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1547
1663
  /**
1548
- * Controls if the paste functionality of the table is enabled or not.
1664
+ * Reference to the key of another column already displayed in the table to properly place this one
1549
1665
  */
1550
- enablePaste?:
1551
- | boolean
1552
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1553
- | `{${string}}`;
1666
+ anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1554
1667
 
1555
1668
  /**
1556
- * Maximum allowed number of records to be exported in one request.
1669
+ * The text that will be displayed for this column header
1557
1670
  */
1558
- exportRequestSize?:
1559
- | int
1560
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1561
- | `{${string}}`;
1671
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1562
1672
 
1563
1673
  /**
1564
- * ID of the FilterBar building block associated with the table.
1674
+ * Aligns the header as well as the content horizontally
1565
1675
  */
1566
- filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1676
+ horizontalAlign?:
1677
+ | string
1678
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1567
1679
 
1568
1680
  /**
1569
- * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
1570
- * This property is not relevant for responsive tables
1681
+ * Defines the column importance.
1682
+ * You can define which columns should be automatically moved to the pop-in area based on their importance
1571
1683
  */
1572
- frozenColumnCount?:
1573
- | int
1574
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1575
- | `{${string}}`;
1684
+ importance?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1576
1685
 
1577
1686
  /**
1578
- * Specifies the header text that is shown in the table.
1687
+ * Unique identifier of the column
1579
1688
  */
1580
- header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1689
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1581
1690
 
1582
1691
  /**
1583
- * Controls if the header text should be shown or not.
1692
+ * Determines where this column should be placed relative to the defined anchor
1693
+ * Allowed values are `Before` and `After`
1584
1694
  */
1585
- headerVisible?:
1586
- | boolean
1695
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1696
+
1697
+ /**
1698
+ * Determines the properties displayed in the column
1699
+ * The properties allow to export, sort, group, copy, and paste in the column
1700
+ */
1701
+ properties?:
1702
+ | string[]
1587
1703
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1588
1704
  | `{${string}}`;
1589
1705
 
1590
1706
  /**
1591
- * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
1592
- *
1593
- * The table building block is not going to create built-in columns or offer table personalization for comma-separated
1594
- * value of fields that are provided in the ignoredfields.
1595
- *
1596
- * Any column referencing an ignored field is to be removed.
1707
+ * Determines the column's width.
1708
+ * Allowed values are 'auto', 'value', and 'inherit', according to {@link sap.ui.core.CSSSize }
1597
1709
  */
1598
- ignoredFields?:
1599
- | string
1600
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1710
+ width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1601
1711
 
1602
1712
  /**
1603
- * Defines whether to display the search action.
1713
+ * Indicates if the column header should be a part of the width calculation.
1604
1714
  */
1605
- isSearchable?:
1715
+ widthIncludingColumnHeader?:
1606
1716
  | boolean
1607
1717
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1608
1718
  | `{${string}}`;
1609
1719
 
1610
1720
  /**
1611
- * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
1612
- * based on the current contextPath.
1721
+ * Determines the export settings for the column.
1613
1722
  */
1614
- metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1723
+ exportSettings?: sap.fe.macros.table.ColumnExportSettings;
1724
+ }
1615
1725
 
1726
+ /**
1727
+ * Describes the settings that can be provided to the ColumnExportSettings constructor.
1728
+ */
1729
+ interface $ColumnExportSettingsSettings
1730
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1616
1731
  /**
1617
- * Changes the size of the IllustratedMessage in the table, or removes it completely.
1618
- * Allowed values are `illustratedMessage-Auto`, `illustratedMessage-Base`, `illustratedMessage-Dialog`,
1619
- * `illustratedMessage-Dot`, `illustratedMessage-Scene`, `illustratedMessage-Spot` or `text`.
1732
+ * Determines the properties of the column.
1620
1733
  */
1621
- modeForNoDataMessage?:
1622
- | string
1623
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1734
+ property?:
1735
+ | string[]
1736
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1737
+ | `{${string}}`;
1624
1738
 
1625
1739
  /**
1626
- * Controls which options should be enabled for the table personalization dialog.
1627
- * If it is set to `true`, all possible options for this kind of table are enabled.
1628
- *
1629
- * If it is set to `false`, personalization is disabled.
1630
- *
1631
- *
1632
- *
1633
- * You can also provide a more granular control for the personalization by providing a comma-separated list
1634
- * with the options you want to be available.
1635
- *
1636
- * Available options are:
1637
- *
1638
- * - Sort
1639
- *
1640
- * - Column
1641
- *
1642
- * - Filter
1740
+ * Determines a formatting template that supports indexed placeholders within curly brackets.
1643
1741
  */
1644
- personalization?:
1645
- | string
1646
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1742
+ template?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1647
1743
 
1648
1744
  /**
1649
- * An expression that allows you to control the 'read-only' state of the table.
1650
- * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
1651
- * current state.
1745
+ * Determines the data type of the field
1652
1746
  */
1653
- readOnly?:
1654
- | boolean
1655
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1656
- | `{${string}}`;
1747
+ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1657
1748
 
1658
1749
  /**
1659
- * Number of rows to be displayed in the table. Does not apply to responsive tables.
1750
+ * Determines the width of the column in characters
1660
1751
  */
1661
- rowCount?:
1662
- | int
1752
+ width?:
1753
+ | number
1663
1754
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1664
1755
  | `{${string}}`;
1665
1756
 
1666
1757
  /**
1667
- * Defines how the table handles the visible rows. Does not apply to Responsive tables.
1668
- * Allowed values are `Auto`, `Fixed`, and `Interactive`.
1669
- *
1670
- * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
1671
- *
1672
- * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
1673
- * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
1674
- * less than defined in the `rowCount` property.
1675
- *
1676
- * - If set to `Interactive` the table can have as many rows as defined in the rowCount property. This number
1677
- * of rows can be modified by dragging the resizer available in this mode.
1678
- */
1679
- rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1680
-
1681
- /**
1682
- * Defines how many additional data records are requested from the back-end system when the user scrolls
1683
- * vertically in the table.
1758
+ * Determines if the content needs to be wrapped.
1684
1759
  */
1685
- scrollThreshold?:
1686
- | number
1760
+ wrap?:
1761
+ | boolean
1687
1762
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1688
1763
  | `{${string}}`;
1764
+ }
1689
1765
 
1766
+ /**
1767
+ * Describes the settings that can be provided to the ColumnOverride constructor.
1768
+ */
1769
+ interface $ColumnOverrideSettings
1770
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1690
1771
  /**
1691
- * Defines the selection mode to be used by the table.
1692
- * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
1693
- * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
1694
- * the consistent selection mode.
1695
- * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
1696
- * Fiori guidelines.
1772
+ * Aligns the header as well as the content horizontally
1697
1773
  */
1698
- selectionMode?:
1774
+ horizontalAlign?:
1699
1775
  | string
1700
1776
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
1701
1777
 
1702
1778
  /**
1703
- * Defines the type of table that will be used by the building block to render the data.
1704
- * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
1779
+ * Defines the importance of the column.
1780
+ * You can define which columns should be automatically moved to the pop-in area based on their importance
1705
1781
  */
1706
- type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1782
+ importance?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1707
1783
 
1708
1784
  /**
1709
- * Controls the kind of variant management that should be enabled for the table.
1710
- * Allowed value is `Control`.
1711
- *
1712
- * If set with value `Control`, a variant management control is seen within the table and the table is linked
1713
- * to this.
1714
- *
1715
- * If not set with any value, control level variant management is not available for this table.
1785
+ * Unique identifier of the column to overridden.
1716
1786
  */
1717
- variantManagement?:
1718
- | string
1719
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1787
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1788
+
1789
+ /**
1790
+ * Determines the column's width.
1791
+ * Allowed values are 'auto', 'value', and 'inherit', according to {@link sap.ui.core.CSSSize }
1792
+ */
1793
+ width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1720
1794
 
1721
1795
  /**
1722
1796
  * Indicates if the column header should be a part of the width calculation.
@@ -1727,108 +1801,74 @@ declare namespace sap {
1727
1801
  | `{${string}}`;
1728
1802
 
1729
1803
  /**
1730
- * Aggregate actions of the table.
1731
- */
1732
- actions?:
1733
- | Array<
1734
- sap.fe.macros.table.ActionGroup | sap.fe.macros.table.Action
1735
- >
1736
- | sap.fe.macros.table.ActionGroup
1737
- | sap.fe.macros.table.Action
1738
- | sap.ui.base.ManagedObject.AggregationBindingInfo
1739
- | `{${string}}`;
1740
-
1741
- /**
1742
- * Aggregate columns of the table.
1743
- */
1744
- columns?:
1745
- | sap.fe.macros.table.Column[]
1746
- | sap.fe.macros.table.Column
1747
- | sap.ui.base.ManagedObject.AggregationBindingInfo
1748
- | `{${string}}`;
1749
-
1750
- /**
1751
- * Aggregation to forward the IllustratedMessage control to the mdc control.
1804
+ * Determines the export settings for the column.
1752
1805
  */
1753
- noData?:
1754
- | sap.m.Text
1755
- | sap.m.IllustratedMessage
1756
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1757
- | `{${string}}`;
1806
+ exportSettings?: sap.fe.macros.table.ColumnExportSettings;
1758
1807
  }
1759
1808
 
1760
1809
  /**
1761
- * Describes the settings that can be provided to the TableCreationOptions constructor.
1810
+ * Describes the settings that can be provided to the MassEdit constructor.
1762
1811
  */
1763
- interface $TableCreationOptionsSettings
1812
+ interface $MassEditSettings
1764
1813
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1765
1814
  /**
1766
- * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
1767
- * 'Inline'
1768
- *
1769
- * The default value is 'false'
1815
+ * Defines the list of fields that should be ignored in the mass edit dialog
1770
1816
  */
1771
- createAtEnd?:
1772
- | boolean
1817
+ ignoredFields?:
1818
+ | string[]
1773
1819
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1774
1820
  | `{${string}}`;
1775
1821
 
1776
1822
  /**
1777
- * Defines the list of properties that will be displayed in the creation dialog, when the creation mode
1778
- * is set to 'CreationDialog'.
1779
- *
1780
- * The value is a comma-separated list of property names.
1823
+ * Defines the mode of the operation grouping to save the new values
1824
+ * Allowed values are `ChangeSet` and `Isolated`
1781
1825
  */
1782
- creationFields?:
1826
+ operationGroupingMode?:
1783
1827
  | string
1784
1828
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
1785
1829
 
1786
1830
  /**
1787
- * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
1788
- * to responsive tables.
1789
- *
1790
- * The default value is 'false'
1831
+ * Defines the list of fields that should be visible in the mass edit dialog
1791
1832
  */
1792
- inlineCreationRowsHiddenInEditMode?:
1793
- | boolean
1833
+ visibleFields?:
1834
+ | string[]
1794
1835
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1795
1836
  | `{${string}}`;
1796
1837
 
1797
1838
  /**
1798
- * Defines the creation mode to be used by the table.
1799
- * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows`, `External` or `CreationDialog`.
1800
- *
1801
- *
1802
- *
1803
- * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
1804
- * or 'Deferred' is used
1805
- *
1806
- * Inline - The creation is done inline
1807
- *
1808
- * InlineCreationsRows - The creation is done inline with an empty row
1809
- *
1810
- * External - The creation is done in a different application specified via the parameter 'outbound'
1811
- * CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
1812
- * values (the properties are listed in `creationFields`).
1813
- *
1814
- * If not set with any value:
1815
- *
1816
- * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1839
+ * The custom form container that can be displayed at the top of the mass edit dialog
1817
1840
  */
1818
- name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1841
+ customContent?: sap.ui.layout.form.FormContainer;
1842
+ }
1819
1843
 
1844
+ /**
1845
+ * Describes the settings that can be provided to the QuickVariantSelection constructor.
1846
+ */
1847
+ interface $QuickVariantSelectionSettings
1848
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1820
1849
  /**
1821
- * The navigation target where the document is created in case of creationMode 'External'
1850
+ * Defines the list of paths pointing to the selection variants that should be used as quick filters
1822
1851
  */
1823
- outbound?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1852
+ paths?:
1853
+ | string[]
1854
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1855
+ | `{${string}}`;
1856
+
1857
+ /**
1858
+ * Defines whether the counts should be displayed next to the text
1859
+ */
1860
+ showCounts?:
1861
+ | boolean
1862
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1863
+ | `{${string}}`;
1824
1864
  }
1825
1865
 
1826
1866
  /**
1827
- * Describes the settings that can be provided to the TreeTable constructor.
1867
+ * Describes the settings that can be provided to the Table constructor.
1828
1868
  *
1829
- * @experimental As of version 1.125.0.
1869
+ * @experimental As of version 1.124.0.
1830
1870
  */
1831
- interface $TreeTableSettings
1871
+ interface $TableSettings
1832
1872
  extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
1833
1873
  /**
1834
1874
  * An expression that allows you to control the 'busy' state of the table.
@@ -1838,6 +1878,14 @@ declare namespace sap {
1838
1878
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1839
1879
  | `{${string}}`;
1840
1880
 
1881
+ /**
1882
+ * Determines whether the table adapts to the condensed layout.
1883
+ */
1884
+ condensedTableLayout?:
1885
+ | boolean
1886
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1887
+ | `{${string}}`;
1888
+
1841
1889
  /**
1842
1890
  * Defines the path of the context used in the current page or block.
1843
1891
  * This setting is defined by the framework.
@@ -1848,7 +1896,7 @@ declare namespace sap {
1848
1896
  * A set of options that can be configured.
1849
1897
  */
1850
1898
  creationMode?:
1851
- | sap.fe.macros.table.TreeTableCreationOptions
1899
+ | sap.fe.macros.table.TableCreationOptions
1852
1900
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1853
1901
  | `{${string}}`;
1854
1902
 
@@ -1892,6 +1940,23 @@ declare namespace sap {
1892
1940
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1893
1941
  | `{${string}}`;
1894
1942
 
1943
+ /**
1944
+ * Determine whether the data copied to the computed columns is sent to the back end.
1945
+ */
1946
+ enablePastingOfComputedProperties?:
1947
+ | boolean
1948
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1949
+ | `{${string}}`;
1950
+
1951
+ /**
1952
+ * Determines whether the Clear All button is enabled by default.
1953
+ * To enable the Clear All button by default, you must set this property to false.
1954
+ */
1955
+ enableSelectAll?:
1956
+ | boolean
1957
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1958
+ | `{${string}}`;
1959
+
1895
1960
  /**
1896
1961
  * Maximum allowed number of records to be exported in one request.
1897
1962
  */
@@ -1927,13 +1992,6 @@ declare namespace sap {
1927
1992
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1928
1993
  | `{${string}}`;
1929
1994
 
1930
- /**
1931
- * A set of options that can be configured.
1932
- */
1933
- hierarchyQualifier?:
1934
- | string
1935
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1936
-
1937
1995
  /**
1938
1996
  * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
1939
1997
  *
@@ -1946,20 +2004,6 @@ declare namespace sap {
1946
2004
  | string
1947
2005
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
1948
2006
 
1949
- /**
1950
- * Defines the extension point to control if a source node can be dropped on a specific parent node.
1951
- */
1952
- isMoveToPositionAllowed?:
1953
- | string
1954
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1955
-
1956
- /**
1957
- * Defines the extension point to control if a node can be dragged.
1958
- */
1959
- isNodeMovable?:
1960
- | string
1961
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1962
-
1963
2007
  /**
1964
2008
  * Defines whether to display the search action.
1965
2009
  */
@@ -2001,6 +2045,12 @@ declare namespace sap {
2001
2045
  * - Column
2002
2046
  *
2003
2047
  * - Filter
2048
+ *
2049
+ * - Group
2050
+ *
2051
+ *
2052
+ *
2053
+ * The Group option is only applicable to analytical tables and responsive tables.
2004
2054
  */
2005
2055
  personalization?:
2006
2056
  | string
@@ -2044,6 +2094,15 @@ declare namespace sap {
2044
2094
  * vertically in the table.
2045
2095
  */
2046
2096
  scrollThreshold?:
2097
+ | int
2098
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2099
+ | `{${string}}`;
2100
+
2101
+ /**
2102
+ * Defines the maximum number of rows that can be selected at once in the table.
2103
+ * This property does not apply to responsive tables.
2104
+ */
2105
+ selectionLimit?:
2047
2106
  | number
2048
2107
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2049
2108
  | `{${string}}`;
@@ -2061,9 +2120,8 @@ declare namespace sap {
2061
2120
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
2062
2121
 
2063
2122
  /**
2064
- * Defines the type of table that will be used by the building block to render the data. This setting is
2065
- * defined by the framework.
2066
- * Allowed value is `TreeTable`.
2123
+ * Defines the type of table that will be used by the building block to render the data.
2124
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
2067
2125
  */
2068
2126
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2069
2127
 
@@ -2100,15 +2158,28 @@ declare namespace sap {
2100
2158
  | sap.ui.base.ManagedObject.AggregationBindingInfo
2101
2159
  | `{${string}}`;
2102
2160
 
2161
+ /**
2162
+ * A set of options that can be configured to control the aggregation behavior
2163
+ */
2164
+ analyticalConfiguration?: sap.fe.macros.table.AnalyticalConfiguration;
2165
+
2103
2166
  /**
2104
2167
  * Aggregate columns of the table.
2105
2168
  */
2106
2169
  columns?:
2107
- | sap.fe.macros.table.Column[]
2170
+ | Array<
2171
+ sap.fe.macros.table.ColumnOverride | sap.fe.macros.table.Column
2172
+ >
2173
+ | sap.fe.macros.table.ColumnOverride
2108
2174
  | sap.fe.macros.table.Column
2109
2175
  | sap.ui.base.ManagedObject.AggregationBindingInfo
2110
2176
  | `{${string}}`;
2111
2177
 
2178
+ /**
2179
+ * Aggregate mass edit of the table.
2180
+ */
2181
+ massEdit?: sap.fe.macros.table.MassEdit;
2182
+
2112
2183
  /**
2113
2184
  * Aggregation to forward the IllustratedMessage control to the mdc control.
2114
2185
  */
@@ -2117,20 +2188,25 @@ declare namespace sap {
2117
2188
  | sap.m.IllustratedMessage
2118
2189
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2119
2190
  | `{${string}}`;
2191
+
2192
+ /**
2193
+ * Aggregate quickVariantSelection of the table.
2194
+ */
2195
+ quickVariantSelection?: sap.fe.macros.table.QuickVariantSelection;
2120
2196
  }
2121
2197
 
2122
2198
  /**
2123
- * Describes the settings that can be provided to the TreeTableCreationOptions constructor.
2199
+ * Describes the settings that can be provided to the TableCreationOptions constructor.
2124
2200
  */
2125
- interface $TreeTableCreationOptionsSettings
2201
+ interface $TableCreationOptionsSettings
2126
2202
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
2127
2203
  /**
2128
- * Specifies if the new entry should be placed at the position computed by the backend (e.g. taking sorting
2129
- * into account).
2204
+ * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
2205
+ * 'Inline'
2130
2206
  *
2131
- * The default value is 'false' (that is, the new entry is placed as the first child below its parent).
2207
+ * The default value is 'false'
2132
2208
  */
2133
- createInPlace?:
2209
+ createAtEnd?:
2134
2210
  | boolean
2135
2211
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2136
2212
  | `{${string}}`;
@@ -2146,23 +2222,30 @@ declare namespace sap {
2146
2222
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
2147
2223
 
2148
2224
  /**
2149
- * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
2225
+ * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
2226
+ * to responsive tables.
2227
+ *
2228
+ * The default value is 'false'
2150
2229
  */
2151
- isCreateEnabled?:
2152
- | string
2153
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
2230
+ inlineCreationRowsHiddenInEditMode?:
2231
+ | boolean
2232
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2233
+ | `{${string}}`;
2154
2234
 
2155
2235
  /**
2156
- * Defines the creation mode to be used by the tree table.
2157
- * Allowed values are `NewPage`, `Inline` or `CreationDialog`.
2236
+ * Defines the creation mode to be used by the table.
2237
+ * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows`, `External` or `CreationDialog`.
2158
2238
  *
2159
2239
  *
2160
2240
  *
2161
2241
  * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
2162
- * or 'Deferred' is used.
2242
+ * or 'Deferred' is used
2163
2243
  *
2164
- * Inline - the creation is done inline.
2244
+ * Inline - The creation is done inline
2165
2245
  *
2246
+ * InlineCreationsRows - The creation is done inline with an empty row
2247
+ *
2248
+ * External - The creation is done in a different application specified via the parameter 'outbound'
2166
2249
  * CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
2167
2250
  * values (the properties are listed in `creationFields`).
2168
2251
  *
@@ -2173,200 +2256,667 @@ declare namespace sap {
2173
2256
  name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2174
2257
 
2175
2258
  /**
2176
- * Defines the nodes to be added on the custom create.
2177
- * This object must have the following properties:
2178
- * propertyName: the name of the property on the page entity set used to categorize the node type to be
2179
- * created within the hierarchy
2180
- *
2181
- * values: an array of key, label and an optional creationFields that define a value of the property defined
2182
- * by the propertyName key, its label, and the specific fields to be shown in the creation dialog.
2259
+ * The navigation target where the document is created in case of creationMode 'External'
2183
2260
  */
2184
- nodeType?:
2185
- | object
2186
- | sap.ui.base.ManagedObject.PropertyBindingInfo
2187
- | `{${string}}`;
2261
+ outbound?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2188
2262
  }
2189
2263
 
2190
2264
  /**
2191
- * Parameters of the Table#beforeRebindTable event.
2192
- */
2193
- interface Table$BeforeRebindTableEventParameters {}
2194
-
2195
- /**
2196
- * Parameters of the Table#rowPress event.
2197
- */
2198
- interface Table$RowPressEventParameters {}
2199
-
2200
- /**
2201
- * Parameters of the Table#selectionChange event.
2202
- */
2203
- interface Table$SelectionChangeEventParameters {}
2204
-
2205
- /**
2206
- * Parameters of the TreeTable#beforeRebindTable event.
2207
- */
2208
- interface TreeTable$BeforeRebindTableEventParameters {}
2209
-
2210
- /**
2211
- * Parameters of the TreeTable#rowPress event.
2212
- */
2213
- interface TreeTable$RowPressEventParameters {}
2214
-
2215
- /**
2216
- * Parameters of the TreeTable#selectionChange event.
2217
- */
2218
- interface TreeTable$SelectionChangeEventParameters {}
2219
-
2220
- /**
2221
- * Definition of a custom action to be used inside the table toolbar
2222
- */
2223
- class Action extends sap.fe.macros.controls
2224
- .BuildingBlockObjectProperty {}
2225
- /**
2226
- * Definition of a custom ActionGroup to be used inside the table toolbar
2227
- */
2228
- class ActionGroup extends sap.fe.macros.controls
2229
- .BuildingBlockObjectProperty {}
2230
- /**
2231
- * Definition of a custom column to be used inside the table.
2232
- * The template for the column has to be provided as the default aggregation
2233
- */
2234
- class Column extends sap.fe.macros.controls
2235
- .BuildingBlockObjectProperty {}
2236
- /**
2237
- * Building block used to create a table based on the metadata provided by OData V4.
2238
- *
2239
- *
2240
- * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
2241
- * the Table building block can also be used to display an EntitySet.
2242
- *
2243
- *
2244
- * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
2245
- *
2246
- *
2247
- * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
2248
- * also has a UI.LineItem as the first property of the Visualizations.
2249
- * Usage example:
2250
- *
2251
- * ```javascript
2252
- *
2253
- * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
2254
- * ...
2255
- * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
2256
- * })
2257
- * ```
2258
- *
2259
- * This is currently an experimental API because the structure of the generated content will change to come
2260
- * closer to the Table that you get out of templates.
2261
- * The public method and property will not change but the internal structure will so be careful on your
2262
- * usage.
2263
- *
2265
+ * Describes the settings that can be provided to the TreeTable constructor.
2264
2266
  *
2265
- * @since 1.124.0
2266
- * @experimental As of version 1.124.0.
2267
+ * @experimental As of version 1.125.0.
2267
2268
  */
2268
- class Table extends sap.fe.macros.controls.BuildingBlockWithTemplating {
2269
+ interface $TreeTableSettings
2270
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
2269
2271
  /**
2270
- * Adds an action to the table.
2271
- *
2272
- * @since 1.124.0
2273
- * @experimental As of version 1.124.0.
2274
- *
2275
- * @returns Reference to this in order to allow method chaining
2272
+ * An expression that allows you to control the 'busy' state of the table.
2276
2273
  */
2277
- addAction(
2278
- /**
2279
- * The action to add
2280
- */
2281
- action: sap.fe.macros.table.Action
2282
- ): this;
2274
+ busy?:
2275
+ | boolean
2276
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2277
+ | `{${string}}`;
2278
+
2283
2279
  /**
2284
- * Adds a column to the table.
2285
- *
2286
- * @since 1.124.0
2287
- * @experimental As of version 1.124.0.
2288
- *
2289
- * @returns Reference to this in order to allow method chaining
2280
+ * Determines whether the table adapts to the condensed layout.
2290
2281
  */
2291
- addColumn(
2292
- /**
2293
- * The column to add
2294
- */
2295
- column: sap.fe.macros.table.Column
2296
- ): this;
2282
+ condensedTableLayout?:
2283
+ | boolean
2284
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2285
+ | `{${string}}`;
2286
+
2297
2287
  /**
2298
- * Adds a message to the table.
2299
- * The message applies to the whole table and not to an individual table row.
2300
- *
2301
- *
2302
- *
2303
- * @returns The ID of the message
2288
+ * Defines the path of the context used in the current page or block.
2289
+ * This setting is defined by the framework.
2304
2290
  */
2305
- addMessage(
2306
- /**
2307
- * The parameters to create the message
2308
- */
2309
- parameters: {
2310
- /**
2311
- * Message description
2312
- */
2313
- description?: string;
2314
- /**
2315
- * Message text
2316
- */
2317
- message?: string;
2318
- /**
2319
- * True if the message is persistent
2320
- */
2321
- persistent?: boolean;
2322
- /**
2323
- * Message type
2324
- */
2325
- type?: /* was: sap.ui.core.message.MessageType */ any;
2326
- }
2327
- ): string;
2291
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2292
+
2328
2293
  /**
2329
- * Get the variant management applied to the table.
2330
- *
2331
- *
2332
- * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
2294
+ * A set of options that can be configured.
2333
2295
  */
2334
- getCurrentVariantKey(): null | string;
2296
+ creationMode?:
2297
+ | sap.fe.macros.table.TreeTableCreationOptions
2298
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2299
+ | `{${string}}`;
2300
+
2335
2301
  /**
2336
- * Get the fields that should be ignored when generating the table.
2337
- *
2338
- * @since 1.124.0
2339
- * @experimental As of version 1.124.0.
2340
- *
2341
- * @returns The value of the ignoredFields property
2302
+ * Controls if the copy functionality of the table is disabled or not.
2342
2303
  */
2343
- getIgnoredFields(): string;
2304
+ disableCopyToClipboard?:
2305
+ | boolean
2306
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2307
+ | `{${string}}`;
2308
+
2344
2309
  /**
2345
- * Gets the path to the metadata that should be used to generate the table.
2346
- *
2347
- * @since 1.124.0
2348
- * @experimental As of version 1.124.0.
2349
- *
2350
- * @returns The path to the metadata
2310
+ * Specifies if the column width is automatically calculated.
2351
2311
  */
2352
- getMetaPath(): string;
2312
+ enableAutoColumnWidth?:
2313
+ | boolean
2314
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2315
+ | `{${string}}`;
2316
+
2353
2317
  /**
2354
- * Get the presentation variant that is currently applied on the table.
2355
- *
2356
- *
2357
- * @returns The presentation variant applied to the table
2318
+ * Controls if the export functionality of the table is enabled or not.
2358
2319
  */
2359
- getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
2320
+ enableExport?:
2321
+ | boolean
2322
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2323
+ | `{${string}}`;
2324
+
2360
2325
  /**
2361
- * Gets contexts from the table that have been selected by the user.
2362
- *
2363
- *
2364
- * @returns Contexts of the rows selected by the user
2326
+ * Controls whether the table can be opened in fullscreen mode or not.
2365
2327
  */
2366
- getSelectedContexts(): sap.ui.model.odata.v4.Context[];
2328
+ enableFullScreen?:
2329
+ | boolean
2330
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2331
+ | `{${string}}`;
2332
+
2367
2333
  /**
2368
- * Get the selection variant from the table. This function considers only the selection variant applied
2369
- * at the control level.
2334
+ * Controls if the paste functionality of the table is enabled or not.
2335
+ */
2336
+ enablePaste?:
2337
+ | boolean
2338
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2339
+ | `{${string}}`;
2340
+
2341
+ /**
2342
+ * Determine whether the data copied to the computed columns is sent to the back end.
2343
+ */
2344
+ enablePastingOfComputedProperties?:
2345
+ | boolean
2346
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2347
+ | `{${string}}`;
2348
+
2349
+ /**
2350
+ * Determines whether the Clear All button is enabled by default.
2351
+ * To enable the Clear All button by default, you must set this property to false.
2352
+ */
2353
+ enableSelectAll?:
2354
+ | boolean
2355
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2356
+ | `{${string}}`;
2357
+
2358
+ /**
2359
+ * Maximum allowed number of records to be exported in one request.
2360
+ */
2361
+ exportRequestSize?:
2362
+ | int
2363
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2364
+ | `{${string}}`;
2365
+
2366
+ /**
2367
+ * ID of the FilterBar building block associated with the table.
2368
+ */
2369
+ filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2370
+
2371
+ /**
2372
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
2373
+ * This property is not relevant for responsive tables
2374
+ */
2375
+ frozenColumnCount?:
2376
+ | int
2377
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2378
+ | `{${string}}`;
2379
+
2380
+ /**
2381
+ * Specifies the header text that is shown in the table.
2382
+ */
2383
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2384
+
2385
+ /**
2386
+ * Controls if the header text should be shown or not.
2387
+ */
2388
+ headerVisible?:
2389
+ | boolean
2390
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2391
+ | `{${string}}`;
2392
+
2393
+ /**
2394
+ * A set of options that can be configured.
2395
+ */
2396
+ hierarchyQualifier?:
2397
+ | string
2398
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2399
+
2400
+ /**
2401
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
2402
+ *
2403
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
2404
+ * value of fields that are provided in the ignoredfields.
2405
+ *
2406
+ * Any column referencing an ignored field is to be removed.
2407
+ */
2408
+ ignoredFields?:
2409
+ | string
2410
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2411
+
2412
+ /**
2413
+ * Defines the extension point to control whether a source node can be copied to a specific parent node.
2414
+ */
2415
+ isCopyToPositionAllowed?:
2416
+ | string
2417
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2418
+
2419
+ /**
2420
+ * Defines the extension point to control whether a source node can be dropped on a specific parent node.
2421
+ */
2422
+ isMoveToPositionAllowed?:
2423
+ | string
2424
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2425
+
2426
+ /**
2427
+ * efines the extension point to control whether a node can be copied.
2428
+ */
2429
+ isNodeCopyable?:
2430
+ | string
2431
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2432
+
2433
+ /**
2434
+ * Defines the extension point to control if a node can be dragged.
2435
+ */
2436
+ isNodeMovable?:
2437
+ | string
2438
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2439
+
2440
+ /**
2441
+ * Defines whether to display the search action.
2442
+ */
2443
+ isSearchable?:
2444
+ | boolean
2445
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2446
+ | `{${string}}`;
2447
+
2448
+ /**
2449
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
2450
+ * based on the current contextPath.
2451
+ */
2452
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2453
+
2454
+ /**
2455
+ * Changes the size of the IllustratedMessage in the table, or removes it completely.
2456
+ * Allowed values are `illustratedMessage-Auto`, `illustratedMessage-Base`, `illustratedMessage-Dialog`,
2457
+ * `illustratedMessage-Dot`, `illustratedMessage-Scene`, `illustratedMessage-Spot` or `text`.
2458
+ */
2459
+ modeForNoDataMessage?:
2460
+ | string
2461
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2462
+
2463
+ /**
2464
+ * Controls which options should be enabled for the table personalization dialog.
2465
+ * If it is set to `true`, all possible options for this kind of table are enabled.
2466
+ *
2467
+ * If it is set to `false`, personalization is disabled.
2468
+ *
2469
+ *
2470
+ *
2471
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
2472
+ * with the options you want to be available.
2473
+ *
2474
+ * Available options are:
2475
+ *
2476
+ * - Sort
2477
+ *
2478
+ * - Column
2479
+ *
2480
+ * - Filter
2481
+ *
2482
+ * - Group
2483
+ *
2484
+ *
2485
+ *
2486
+ * The Group option is only applicable to analytical tables and responsive tables.
2487
+ */
2488
+ personalization?:
2489
+ | string
2490
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2491
+
2492
+ /**
2493
+ * An expression that allows you to control the 'read-only' state of the table.
2494
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
2495
+ * current state.
2496
+ */
2497
+ readOnly?:
2498
+ | boolean
2499
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2500
+ | `{${string}}`;
2501
+
2502
+ /**
2503
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
2504
+ */
2505
+ rowCount?:
2506
+ | int
2507
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2508
+ | `{${string}}`;
2509
+
2510
+ /**
2511
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
2512
+ * Allowed values are `Auto`, `Fixed`, and `Interactive`.
2513
+ *
2514
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
2515
+ *
2516
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
2517
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
2518
+ * less than defined in the `rowCount` property.
2519
+ *
2520
+ * - If set to `Interactive` the table can have as many rows as defined in the rowCount property. This number
2521
+ * of rows can be modified by dragging the resizer available in this mode.
2522
+ */
2523
+ rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2524
+
2525
+ /**
2526
+ * Defines how many additional data records are requested from the back-end system when the user scrolls
2527
+ * vertically in the table.
2528
+ */
2529
+ scrollThreshold?:
2530
+ | int
2531
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2532
+ | `{${string}}`;
2533
+
2534
+ /**
2535
+ * Defines the maximum number of rows that can be selected at once in the table.
2536
+ * This property does not apply to responsive tables.
2537
+ */
2538
+ selectionLimit?:
2539
+ | number
2540
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2541
+ | `{${string}}`;
2542
+
2543
+ /**
2544
+ * Defines the selection mode to be used by the table.
2545
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
2546
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
2547
+ * the consistent selection mode.
2548
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
2549
+ * Fiori guidelines.
2550
+ */
2551
+ selectionMode?:
2552
+ | string
2553
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2554
+
2555
+ /**
2556
+ * Defines the type of table that will be used by the building block to render the data. This setting is
2557
+ * defined by the framework.
2558
+ * Allowed value is `TreeTable`.
2559
+ */
2560
+ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2561
+
2562
+ /**
2563
+ * Controls the kind of variant management that should be enabled for the table.
2564
+ * Allowed value is `Control`.
2565
+ *
2566
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
2567
+ * to this.
2568
+ *
2569
+ * If not set with any value, control level variant management is not available for this table.
2570
+ */
2571
+ variantManagement?:
2572
+ | string
2573
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2574
+
2575
+ /**
2576
+ * Indicates if the column header should be a part of the width calculation.
2577
+ */
2578
+ widthIncludingColumnHeader?:
2579
+ | boolean
2580
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2581
+ | `{${string}}`;
2582
+
2583
+ /**
2584
+ * Aggregate actions of the table.
2585
+ */
2586
+ actions?:
2587
+ | Array<
2588
+ sap.fe.macros.table.ActionGroup | sap.fe.macros.table.Action
2589
+ >
2590
+ | sap.fe.macros.table.ActionGroup
2591
+ | sap.fe.macros.table.Action
2592
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
2593
+ | `{${string}}`;
2594
+
2595
+ /**
2596
+ * A set of options that can be configured to control the aggregation behavior
2597
+ */
2598
+ analyticalConfiguration?: sap.fe.macros.table.AnalyticalConfiguration;
2599
+
2600
+ /**
2601
+ * Aggregate columns of the table.
2602
+ */
2603
+ columns?:
2604
+ | Array<
2605
+ sap.fe.macros.table.ColumnOverride | sap.fe.macros.table.Column
2606
+ >
2607
+ | sap.fe.macros.table.ColumnOverride
2608
+ | sap.fe.macros.table.Column
2609
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
2610
+ | `{${string}}`;
2611
+
2612
+ /**
2613
+ * Aggregate mass edit of the table.
2614
+ */
2615
+ massEdit?: sap.fe.macros.table.MassEdit;
2616
+
2617
+ /**
2618
+ * Aggregation to forward the IllustratedMessage control to the mdc control.
2619
+ */
2620
+ noData?:
2621
+ | sap.m.Text
2622
+ | sap.m.IllustratedMessage
2623
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2624
+ | `{${string}}`;
2625
+
2626
+ /**
2627
+ * Aggregate quickVariantSelection of the table.
2628
+ */
2629
+ quickVariantSelection?: sap.fe.macros.table.QuickVariantSelection;
2630
+ }
2631
+
2632
+ /**
2633
+ * Describes the settings that can be provided to the TreeTableCreationOptions constructor.
2634
+ */
2635
+ interface $TreeTableCreationOptionsSettings
2636
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
2637
+ /**
2638
+ * Specifies if the new entry should be placed at the position computed by the backend (e.g. taking sorting
2639
+ * into account).
2640
+ *
2641
+ * The default value is 'false' (that is, the new entry is placed as the first child below its parent).
2642
+ */
2643
+ createInPlace?:
2644
+ | boolean
2645
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2646
+ | `{${string}}`;
2647
+
2648
+ /**
2649
+ * Defines the list of properties that will be displayed in the creation dialog, when the creation mode
2650
+ * is set to 'CreationDialog'.
2651
+ *
2652
+ * The value is a comma-separated list of property names.
2653
+ */
2654
+ creationFields?:
2655
+ | string
2656
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2657
+
2658
+ /**
2659
+ * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
2660
+ */
2661
+ isCreateEnabled?:
2662
+ | string
2663
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2664
+
2665
+ /**
2666
+ * Defines the creation mode to be used by the tree table.
2667
+ * Allowed values are `NewPage`, `Inline` or `CreationDialog`.
2668
+ *
2669
+ *
2670
+ *
2671
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
2672
+ * or 'Deferred' is used.
2673
+ *
2674
+ * Inline - the creation is done inline.
2675
+ *
2676
+ * CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
2677
+ * values (the properties are listed in `creationFields`).
2678
+ *
2679
+ * If not set with any value:
2680
+ *
2681
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
2682
+ */
2683
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2684
+
2685
+ /**
2686
+ * Defines the nodes to be added on the custom create.
2687
+ * This object must have the following properties:
2688
+ * propertyName: the name of the property on the page entity set used to categorize the node type to be
2689
+ * created within the hierarchy
2690
+ *
2691
+ * values: an array of key, label and an optional creationFields that define a value of the property defined
2692
+ * by the propertyName key, its label, and the specific fields to be shown in the creation dialog.
2693
+ */
2694
+ nodeType?:
2695
+ | object
2696
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2697
+ | `{${string}}`;
2698
+ }
2699
+
2700
+ /**
2701
+ * Parameters of the Action#press event.
2702
+ */
2703
+ interface Action$PressEventParameters {}
2704
+
2705
+ /**
2706
+ * Parameters of the Table#beforeRebindTable event.
2707
+ */
2708
+ interface Table$BeforeRebindTableEventParameters {}
2709
+
2710
+ /**
2711
+ * Parameters of the Table#rowPress event.
2712
+ */
2713
+ interface Table$RowPressEventParameters {}
2714
+
2715
+ /**
2716
+ * Parameters of the Table#selectionChange event.
2717
+ */
2718
+ interface Table$SelectionChangeEventParameters {}
2719
+
2720
+ /**
2721
+ * Parameters of the TreeTable#beforeRebindTable event.
2722
+ */
2723
+ interface TreeTable$BeforeRebindTableEventParameters {}
2724
+
2725
+ /**
2726
+ * Parameters of the TreeTable#rowPress event.
2727
+ */
2728
+ interface TreeTable$RowPressEventParameters {}
2729
+
2730
+ /**
2731
+ * Parameters of the TreeTable#selectionChange event.
2732
+ */
2733
+ interface TreeTable$SelectionChangeEventParameters {}
2734
+
2735
+ /**
2736
+ * Definition of a custom action to be used inside the table toolbar
2737
+ */
2738
+ class Action extends sap.fe.macros.controls
2739
+ .BuildingBlockObjectProperty {}
2740
+ /**
2741
+ * Definition of a custom ActionGroup to be used inside the table toolbar
2742
+ */
2743
+ class ActionGroup extends sap.fe.macros.controls
2744
+ .BuildingBlockObjectProperty {}
2745
+ /**
2746
+ * Definition of an action group override to be used inside the Table building block.
2747
+ */
2748
+ class ActionGroupOverride extends sap.fe.macros.controls
2749
+ .BuildingBlockObjectProperty {}
2750
+ /**
2751
+ * Definition of an override for the action to be used inside the Table building block.
2752
+ */
2753
+ class ActionOverride extends sap.fe.macros.controls
2754
+ .BuildingBlockObjectProperty {}
2755
+ /**
2756
+ * A set of options that can be configured to control the aggregation behavior
2757
+ */
2758
+ class AnalyticalConfiguration extends sap.fe.macros.controls
2759
+ .BuildingBlockObjectProperty {}
2760
+ /**
2761
+ * Definition of a custom column to be used inside the table.
2762
+ * The template for the column has to be provided as the default aggregation
2763
+ */
2764
+ class Column extends sap.fe.macros.controls
2765
+ .BuildingBlockObjectProperty {}
2766
+ /**
2767
+ * Definition of the export settings applied to a column within the table.
2768
+ */
2769
+ class ColumnExportSettings extends sap.fe.macros.controls
2770
+ .BuildingBlockObjectProperty {}
2771
+ /**
2772
+ * Definition of an override for the column to be used inside the Table building block.
2773
+ */
2774
+ class ColumnOverride extends sap.fe.macros.controls
2775
+ .BuildingBlockObjectProperty {}
2776
+ /**
2777
+ * Definition of the mass edit to be used inside the table.
2778
+ */
2779
+ class MassEdit extends sap.fe.macros.controls
2780
+ .BuildingBlockObjectProperty {}
2781
+ /**
2782
+ * Definition of the quickVariantSelection to be used inside the table.
2783
+ */
2784
+ class QuickVariantSelection extends sap.fe.macros.controls
2785
+ .BuildingBlockObjectProperty {}
2786
+ /**
2787
+ * Building block used to create a table based on the metadata provided by OData V4.
2788
+ *
2789
+ *
2790
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
2791
+ * the Table building block can also be used to display an EntitySet.
2792
+ *
2793
+ *
2794
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
2795
+ *
2796
+ *
2797
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
2798
+ * also has a UI.LineItem as the first property of the Visualizations.
2799
+ * Usage example:
2800
+ *
2801
+ * ```javascript
2802
+ *
2803
+ * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
2804
+ * ...
2805
+ * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
2806
+ * })
2807
+ * ```
2808
+ *
2809
+ * This is currently an experimental API because the structure of the generated content will change to come
2810
+ * closer to the Table that you get out of templates.
2811
+ * The public method and property will not change but the internal structure will so be careful on your
2812
+ * usage.
2813
+ *
2814
+ *
2815
+ * @since 1.124.0
2816
+ * @experimental As of version 1.124.0.
2817
+ */
2818
+ class Table extends sap.fe.macros.controls.BuildingBlockWithTemplating {
2819
+ /**
2820
+ * Adds an action to the table.
2821
+ *
2822
+ * @since 1.124.0
2823
+ * @experimental As of version 1.124.0.
2824
+ *
2825
+ * @returns Reference to this in order to allow method chaining
2826
+ */
2827
+ addAction(
2828
+ /**
2829
+ * The action to add
2830
+ */
2831
+ action: sap.fe.macros.table.Action
2832
+ ): this;
2833
+ /**
2834
+ * Adds a column to the table.
2835
+ *
2836
+ * @since 1.124.0
2837
+ * @experimental As of version 1.124.0.
2838
+ *
2839
+ * @returns Reference to this in order to allow method chaining
2840
+ */
2841
+ addColumn(
2842
+ /**
2843
+ * The column to add
2844
+ */
2845
+ column: sap.fe.macros.table.Column
2846
+ ): this;
2847
+ /**
2848
+ * Adds a message to the table.
2849
+ * The message applies to the whole table and not to an individual table row.
2850
+ *
2851
+ *
2852
+ *
2853
+ * @returns The ID of the message
2854
+ */
2855
+ addMessage(
2856
+ /**
2857
+ * The parameters to create the message
2858
+ */
2859
+ parameters: {
2860
+ /**
2861
+ * Message description
2862
+ */
2863
+ description?: string;
2864
+ /**
2865
+ * Message text
2866
+ */
2867
+ message?: string;
2868
+ /**
2869
+ * True if the message is persistent
2870
+ */
2871
+ persistent?: boolean;
2872
+ /**
2873
+ * Message type
2874
+ */
2875
+ type?: /* was: sap.ui.core.message.MessageType */ any;
2876
+ }
2877
+ ): string;
2878
+ /**
2879
+ * Get the variant management applied to the table.
2880
+ *
2881
+ *
2882
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
2883
+ */
2884
+ getCurrentVariantKey(): null | string;
2885
+ /**
2886
+ * Get the fields that should be ignored when generating the table.
2887
+ *
2888
+ * @since 1.124.0
2889
+ * @experimental As of version 1.124.0.
2890
+ *
2891
+ * @returns The value of the ignoredFields property
2892
+ */
2893
+ getIgnoredFields(): string;
2894
+ /**
2895
+ * Gets the path to the metadata that should be used to generate the table.
2896
+ *
2897
+ * @since 1.124.0
2898
+ * @experimental As of version 1.124.0.
2899
+ *
2900
+ * @returns The path to the metadata
2901
+ */
2902
+ getMetaPath(): string;
2903
+ /**
2904
+ * Get the presentation variant that is currently applied on the table.
2905
+ *
2906
+ *
2907
+ * @returns The presentation variant applied to the table
2908
+ */
2909
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
2910
+ /**
2911
+ * Gets contexts from the table that have been selected by the user.
2912
+ *
2913
+ *
2914
+ * @returns Contexts of the rows selected by the user
2915
+ */
2916
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
2917
+ /**
2918
+ * Get the selection variant from the table. This function considers only the selection variant applied
2919
+ * at the control level.
2370
2920
  *
2371
2921
  *
2372
2922
  * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant }
@@ -2793,6 +3343,14 @@ declare namespace sap {
2793
3343
  class TreeTableCreationOptions extends sap.fe.macros.controls
2794
3344
  .BuildingBlockObjectProperty {}
2795
3345
 
3346
+ /**
3347
+ * Event object of the Action#press event.
3348
+ */
3349
+ type Action$PressEvent = sap.ui.base.Event<
3350
+ Action$PressEventParameters,
3351
+ Action
3352
+ >;
3353
+
2796
3354
  /**
2797
3355
  * Event object of the Table#beforeRebindTable event.
2798
3356
  */
@@ -2928,6 +3486,61 @@ declare namespace sap {
2928
3486
  | `{${string}}`;
2929
3487
  }
2930
3488
 
3489
+ /**
3490
+ * Describes the settings that can be provided to the Field constructor.
3491
+ */
3492
+ interface $FieldSettings extends sap.fe.macros.$MacroAPISettings {
3493
+ /**
3494
+ * Defines the path of the context used in the current page or block.
3495
+ * This setting is defined by the framework.
3496
+ */
3497
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3498
+
3499
+ /**
3500
+ * This is used to optionally provide an external description that comes from a different model than the
3501
+ * oData model.
3502
+ * This should be used in conjunction with the value property.
3503
+ */
3504
+ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3505
+
3506
+ /**
3507
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
3508
+ */
3509
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3510
+
3511
+ /**
3512
+ * An expression that allows you to control the read-only state of the field.
3513
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
3514
+ * current state.
3515
+ */
3516
+ readOnly?:
3517
+ | boolean
3518
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3519
+ | `{${string}}`;
3520
+
3521
+ /**
3522
+ * Option to add semantic objects for a field.
3523
+ * This parameter overwrites the semantic objects defined through annotations.
3524
+ * Valid options are either a single semantic object, a stringified array of semantic objects,
3525
+ * a formatter or a single binding expression returning either a single semantic object or an array of semantic
3526
+ * objects.
3527
+ */
3528
+ semanticObject?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3529
+
3530
+ /**
3531
+ * This is used to optionally provide an external value that comes from a different model than the oData
3532
+ * model.
3533
+ * It is designed to work with a field with value help, and without support for complex value help (currency
3534
+ * / unit).
3535
+ */
3536
+ value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3537
+
3538
+ /**
3539
+ * A set of options that can be configured.
3540
+ */
3541
+ formatOptions?: sap.fe.macros.field.FieldFormatOptions;
3542
+ }
3543
+
2931
3544
  /**
2932
3545
  * Describes the settings that can be provided to the KPITag constructor.
2933
3546
  */
@@ -2999,6 +3612,52 @@ declare namespace sap {
2999
3612
  metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3000
3613
  }
3001
3614
 
3615
+ /**
3616
+ * Describes the settings that can be provided to the MessageButton constructor.
3617
+ *
3618
+ * @experimental
3619
+ */
3620
+ interface $MessageButtonSettings
3621
+ extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {}
3622
+
3623
+ /**
3624
+ * Describes the settings that can be provided to the MicroChart constructor.
3625
+ */
3626
+ interface $MicroChartSettings
3627
+ extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
3628
+ /**
3629
+ * context path to the MicroChart.
3630
+ */
3631
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3632
+
3633
+ /**
3634
+ * Show blank space in case there is no data in the chart
3635
+ */
3636
+ hideOnNoData?:
3637
+ | boolean
3638
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3639
+ | `{${string}}`;
3640
+
3641
+ /**
3642
+ * Metadata path to the MicroChart.
3643
+ */
3644
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3645
+
3646
+ /**
3647
+ * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do
3648
+ * not see the inner labels of the MicroChart as well.
3649
+ */
3650
+ showOnlyChart?:
3651
+ | boolean
3652
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3653
+ | `{${string}}`;
3654
+
3655
+ /**
3656
+ * Size of the MicroChart
3657
+ */
3658
+ size?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3659
+ }
3660
+
3002
3661
  /**
3003
3662
  * Describes the settings that can be provided to the MultiValueField constructor.
3004
3663
  *
@@ -3020,17 +3679,49 @@ declare namespace sap {
3020
3679
  | `{${string}}`;
3021
3680
 
3022
3681
  /**
3023
- * Defines the relative Metadata path to the MultiValueField.
3024
- * The metaPath should point to a Property or DataField.
3682
+ * Defines the relative Metadata path to the MultiValueField.
3683
+ * The metaPath should point to a Property or DataField.
3684
+ */
3685
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3686
+
3687
+ /**
3688
+ * The readOnly flag
3689
+ */
3690
+ readOnly?:
3691
+ | boolean
3692
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3693
+ | `{${string}}`;
3694
+ }
3695
+
3696
+ /**
3697
+ * Describes the settings that can be provided to the Page constructor.
3698
+ */
3699
+ interface $PageSettings
3700
+ extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
3701
+ /**
3702
+ * Avatar source of the page. It is considered only if the title property is specified.
3703
+ */
3704
+ avatarSrc?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3705
+
3706
+ /**
3707
+ * Description of the page. It is considered only if the title property is specified.
3025
3708
  */
3026
- metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3709
+ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3027
3710
 
3028
3711
  /**
3029
- * The readOnly flag
3712
+ * Title of the page
3713
+ * If title is not given, then we will add a title, avatar and description based on the unqualified HeaderInfo
3714
+ * associated to the entity
3030
3715
  */
3031
- readOnly?:
3032
- | boolean
3033
- | sap.ui.base.ManagedObject.PropertyBindingInfo
3716
+ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3717
+
3718
+ /**
3719
+ * Content(s) of the page
3720
+ */
3721
+ items?:
3722
+ | sap.ui.core.Control[]
3723
+ | sap.ui.core.Control
3724
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
3034
3725
  | `{${string}}`;
3035
3726
  }
3036
3727
 
@@ -3173,61 +3864,6 @@ declare namespace sap {
3173
3864
  interface $FlexibleColumnLayoutActionsSettings
3174
3865
  extends sap.ui.core.$ControlSettings {}
3175
3866
 
3176
- /**
3177
- * Describes the settings that can be provided to the Field constructor.
3178
- */
3179
- interface $FieldSettings extends sap.fe.macros.$MacroAPISettings {
3180
- /**
3181
- * Defines the path of the context used in the current page or block.
3182
- * This setting is defined by the framework.
3183
- */
3184
- contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3185
-
3186
- /**
3187
- * This is used to optionally provide an external description that comes from a different model than the
3188
- * oData model.
3189
- * This should be used in conjunction with the value property.
3190
- */
3191
- description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3192
-
3193
- /**
3194
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
3195
- */
3196
- metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3197
-
3198
- /**
3199
- * An expression that allows you to control the read-only state of the field.
3200
- * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
3201
- * current state.
3202
- */
3203
- readOnly?:
3204
- | boolean
3205
- | sap.ui.base.ManagedObject.PropertyBindingInfo
3206
- | `{${string}}`;
3207
-
3208
- /**
3209
- * Option to add semantic objects for a field.
3210
- * This parameter overwrites the semantic objects defined through annotations.
3211
- * Valid options are either a single semantic object, a stringified array of semantic objects,
3212
- * a formatter or a single binding expression returning either a single semantic object or an array of semantic
3213
- * objects.
3214
- */
3215
- semanticObject?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3216
-
3217
- /**
3218
- * This is used to optionally provide an external value that comes from a different model than the oData
3219
- * model.
3220
- * It is designed to work with a field with value help, and without support for complex value help (currency
3221
- * / unit).
3222
- */
3223
- value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3224
-
3225
- /**
3226
- * A set of options that can be configured.
3227
- */
3228
- formatOptions?: sap.fe.macros.field.FieldFormatOptions;
3229
- }
3230
-
3231
3867
  /**
3232
3868
  * Describes the settings that can be provided to the FilterBar constructor.
3233
3869
  */
@@ -3353,27 +3989,6 @@ declare namespace sap {
3353
3989
  fields?: sap.ui.core.Control;
3354
3990
  }
3355
3991
 
3356
- /**
3357
- * Describes the settings that can be provided to the MicroChart constructor.
3358
- */
3359
- interface $MicroChartSettings extends sap.ui.core.$ControlSettings {
3360
- /**
3361
- * Show blank space in case there is no data in the chart
3362
- */
3363
- hideOnNoData?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3364
-
3365
- /**
3366
- * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do
3367
- * not see the inner labels of the MicroChart as well.
3368
- */
3369
- showOnlyChart?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3370
-
3371
- /**
3372
- * Size of the MicroChart
3373
- */
3374
- size?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3375
- }
3376
-
3377
3992
  /**
3378
3993
  * Describes the settings that can be provided to the Table constructor.
3379
3994
  */
@@ -3386,6 +4001,14 @@ declare namespace sap {
3386
4001
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3387
4002
  | `{${string}}`;
3388
4003
 
4004
+ /**
4005
+ * Determines whether the table adapts to the condensed layout.
4006
+ */
4007
+ condensedTableLayout?:
4008
+ | boolean
4009
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4010
+ | `{${string}}`;
4011
+
3389
4012
  /**
3390
4013
  * Defines the path of the context used in the current page or block.
3391
4014
  * This setting is defined by the framework.
@@ -3440,6 +4063,23 @@ declare namespace sap {
3440
4063
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3441
4064
  | `{${string}}`;
3442
4065
 
4066
+ /**
4067
+ * Determine whether the data copied to the computed columns is sent to the back end.
4068
+ */
4069
+ enablePastingOfComputedProperties?:
4070
+ | boolean
4071
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4072
+ | `{${string}}`;
4073
+
4074
+ /**
4075
+ * Determines whether the Clear All button is enabled by default.
4076
+ * To enable the Clear All button by default, you must set this property to false.
4077
+ */
4078
+ enableSelectAll?:
4079
+ | boolean
4080
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4081
+ | `{${string}}`;
4082
+
3443
4083
  /**
3444
4084
  * Maximum allowed number of records to be exported in one request.
3445
4085
  */
@@ -3526,6 +4166,12 @@ declare namespace sap {
3526
4166
  * - Column
3527
4167
  *
3528
4168
  * - Filter
4169
+ *
4170
+ * - Group
4171
+ *
4172
+ *
4173
+ *
4174
+ * The Group option is only applicable to analytical tables and responsive tables.
3529
4175
  */
3530
4176
  personalization?:
3531
4177
  | string
@@ -3569,6 +4215,15 @@ declare namespace sap {
3569
4215
  * vertically in the table.
3570
4216
  */
3571
4217
  scrollThreshold?:
4218
+ | int
4219
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4220
+ | `{${string}}`;
4221
+
4222
+ /**
4223
+ * Defines the maximum number of rows that can be selected at once in the table.
4224
+ * This property does not apply to responsive tables.
4225
+ */
4226
+ selectionLimit?:
3572
4227
  | number
3573
4228
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3574
4229
  | `{${string}}`;
@@ -3620,15 +4275,28 @@ declare namespace sap {
3620
4275
  | sap.ui.base.ManagedObject.AggregationBindingInfo
3621
4276
  | `{${string}}`;
3622
4277
 
4278
+ /**
4279
+ * A set of options that can be configured to control the aggregation behavior
4280
+ */
4281
+ analyticalConfiguration?: sap.fe.macros.table.AnalyticalConfiguration;
4282
+
3623
4283
  /**
3624
4284
  * Aggregate columns of the table.
3625
4285
  */
3626
4286
  columns?:
3627
- | sap.fe.macros.table.Column[]
4287
+ | Array<
4288
+ sap.fe.macros.table.ColumnOverride | sap.fe.macros.table.Column
4289
+ >
4290
+ | sap.fe.macros.table.ColumnOverride
3628
4291
  | sap.fe.macros.table.Column
3629
4292
  | sap.ui.base.ManagedObject.AggregationBindingInfo
3630
4293
  | `{${string}}`;
3631
4294
 
4295
+ /**
4296
+ * Aggregate mass edit of the table.
4297
+ */
4298
+ massEdit?: sap.fe.macros.table.MassEdit;
4299
+
3632
4300
  /**
3633
4301
  * Aggregation to forward the IllustratedMessage control to the mdc control.
3634
4302
  */
@@ -3637,6 +4305,11 @@ declare namespace sap {
3637
4305
  | sap.m.IllustratedMessage
3638
4306
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3639
4307
  | `{${string}}`;
4308
+
4309
+ /**
4310
+ * Aggregate quickVariantSelection of the table.
4311
+ */
4312
+ quickVariantSelection?: sap.fe.macros.table.QuickVariantSelection;
3640
4313
  }
3641
4314
 
3642
4315
  /**
@@ -3651,6 +4324,14 @@ declare namespace sap {
3651
4324
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3652
4325
  | `{${string}}`;
3653
4326
 
4327
+ /**
4328
+ * Determines whether the table adapts to the condensed layout.
4329
+ */
4330
+ condensedTableLayout?:
4331
+ | boolean
4332
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4333
+ | `{${string}}`;
4334
+
3654
4335
  /**
3655
4336
  * Defines the path of the context used in the current page or block.
3656
4337
  * This setting is defined by the framework.
@@ -3705,6 +4386,23 @@ declare namespace sap {
3705
4386
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3706
4387
  | `{${string}}`;
3707
4388
 
4389
+ /**
4390
+ * Determine whether the data copied to the computed columns is sent to the back end.
4391
+ */
4392
+ enablePastingOfComputedProperties?:
4393
+ | boolean
4394
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4395
+ | `{${string}}`;
4396
+
4397
+ /**
4398
+ * Determines whether the Clear All button is enabled by default.
4399
+ * To enable the Clear All button by default, you must set this property to false.
4400
+ */
4401
+ enableSelectAll?:
4402
+ | boolean
4403
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4404
+ | `{${string}}`;
4405
+
3708
4406
  /**
3709
4407
  * Maximum allowed number of records to be exported in one request.
3710
4408
  */
@@ -3758,12 +4456,24 @@ declare namespace sap {
3758
4456
  ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
3759
4457
 
3760
4458
  /**
3761
- * Defines the extension point to control if a source node can be dropped on a specific parent node.
4459
+ * Defines the extension point to control whether a source node can be copied to a specific parent node.
4460
+ */
4461
+ isCopyToPositionAllowed?:
4462
+ | string
4463
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
4464
+
4465
+ /**
4466
+ * Defines the extension point to control whether a source node can be dropped on a specific parent node.
3762
4467
  */
3763
4468
  isMoveToPositionAllowed?:
3764
4469
  | string
3765
4470
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
3766
4471
 
4472
+ /**
4473
+ * efines the extension point to control whether a node can be copied.
4474
+ */
4475
+ isNodeCopyable?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
4476
+
3767
4477
  /**
3768
4478
  * Defines the extension point to control if a node can be dragged.
3769
4479
  */
@@ -3810,6 +4520,12 @@ declare namespace sap {
3810
4520
  * - Column
3811
4521
  *
3812
4522
  * - Filter
4523
+ *
4524
+ * - Group
4525
+ *
4526
+ *
4527
+ *
4528
+ * The Group option is only applicable to analytical tables and responsive tables.
3813
4529
  */
3814
4530
  personalization?:
3815
4531
  | string
@@ -3853,6 +4569,15 @@ declare namespace sap {
3853
4569
  * vertically in the table.
3854
4570
  */
3855
4571
  scrollThreshold?:
4572
+ | int
4573
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4574
+ | `{${string}}`;
4575
+
4576
+ /**
4577
+ * Defines the maximum number of rows that can be selected at once in the table.
4578
+ * This property does not apply to responsive tables.
4579
+ */
4580
+ selectionLimit?:
3856
4581
  | number
3857
4582
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3858
4583
  | `{${string}}`;
@@ -3905,15 +4630,28 @@ declare namespace sap {
3905
4630
  | sap.ui.base.ManagedObject.AggregationBindingInfo
3906
4631
  | `{${string}}`;
3907
4632
 
4633
+ /**
4634
+ * A set of options that can be configured to control the aggregation behavior
4635
+ */
4636
+ analyticalConfiguration?: sap.fe.macros.table.AnalyticalConfiguration;
4637
+
3908
4638
  /**
3909
4639
  * Aggregate columns of the table.
3910
4640
  */
3911
4641
  columns?:
3912
- | sap.fe.macros.table.Column[]
4642
+ | Array<
4643
+ sap.fe.macros.table.ColumnOverride | sap.fe.macros.table.Column
4644
+ >
4645
+ | sap.fe.macros.table.ColumnOverride
3913
4646
  | sap.fe.macros.table.Column
3914
4647
  | sap.ui.base.ManagedObject.AggregationBindingInfo
3915
4648
  | `{${string}}`;
3916
4649
 
4650
+ /**
4651
+ * Aggregate mass edit of the table.
4652
+ */
4653
+ massEdit?: sap.fe.macros.table.MassEdit;
4654
+
3917
4655
  /**
3918
4656
  * Aggregation to forward the IllustratedMessage control to the mdc control.
3919
4657
  */
@@ -3922,6 +4660,11 @@ declare namespace sap {
3922
4660
  | sap.m.IllustratedMessage
3923
4661
  | sap.ui.base.ManagedObject.PropertyBindingInfo
3924
4662
  | `{${string}}`;
4663
+
4664
+ /**
4665
+ * Aggregate quickVariantSelection of the table.
4666
+ */
4667
+ quickVariantSelection?: sap.fe.macros.table.QuickVariantSelection;
3925
4668
  }
3926
4669
 
3927
4670
  /**
@@ -3929,11 +4672,6 @@ declare namespace sap {
3929
4672
  */
3930
4673
  interface Chart$SelectionChangeEventParameters {}
3931
4674
 
3932
- /**
3933
- * Parameters of the KPITag#press event.
3934
- */
3935
- interface KPITag$PressEventParameters {}
3936
-
3937
4675
  /**
3938
4676
  * Parameters of the Field#change event.
3939
4677
  */
@@ -3944,6 +4682,16 @@ declare namespace sap {
3944
4682
  */
3945
4683
  interface Field$LiveChangeEventParameters {}
3946
4684
 
4685
+ /**
4686
+ * Parameters of the KPITag#press event.
4687
+ */
4688
+ interface KPITag$PressEventParameters {}
4689
+
4690
+ /**
4691
+ * Parameters of the MessageButton#visibilityChange event.
4692
+ */
4693
+ interface MessageButton$VisibilityChangeEventParameters {}
4694
+
3947
4695
  /**
3948
4696
  * Parameters of the FilterBar#afterClear event.
3949
4697
  */
@@ -4016,253 +4764,452 @@ declare namespace sap {
4016
4764
  __implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
4017
4765
 
4018
4766
  /**
4019
- * Gets current value of property contextPath.
4767
+ * Gets current value of property contextPath.
4768
+ *
4769
+ *
4770
+ * @returns Value of property `contextPath`
4771
+ */
4772
+ getContextPath(): string;
4773
+ /**
4774
+ * Gets the key of the current variant in the associated variant management.
4775
+ *
4776
+ *
4777
+ * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
4778
+ */
4779
+ getCurrentVariantKey(): null | string;
4780
+ /**
4781
+ * Gets current value of property filterBar.
4782
+ *
4783
+ *
4784
+ * @returns Value of property `filterBar`
4785
+ */
4786
+ getFilterBar(): string;
4787
+ /**
4788
+ * Gets current value of property header.
4789
+ *
4790
+ *
4791
+ * @returns Value of property `header`
4792
+ */
4793
+ getHeader(): string;
4794
+ /**
4795
+ * Gets current value of property headerVisible.
4796
+ *
4797
+ *
4798
+ * @returns Value of property `headerVisible`
4799
+ */
4800
+ getHeaderVisible(): boolean;
4801
+ /**
4802
+ * Gets current value of property metaPath.
4803
+ *
4804
+ *
4805
+ * @returns Value of property `metaPath`
4806
+ */
4807
+ getMetaPath(): string;
4808
+ /**
4809
+ * Gets current value of property personalization.
4810
+ *
4811
+ *
4812
+ * @returns Value of property `personalization`
4813
+ */
4814
+ getPersonalization(): string;
4815
+ /**
4816
+ * Get the presentation variant that is currently applied on the chart.
4817
+ *
4818
+ *
4819
+ * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
4820
+ */
4821
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
4822
+ /**
4823
+ * Gets contexts from the chart that have been selected by the user.
4824
+ *
4825
+ *
4826
+ * @returns Contexts of the rows selected by the user
4827
+ */
4828
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
4829
+ /**
4830
+ * Gets current value of property selectionMode.
4831
+ *
4832
+ *
4833
+ * @returns Value of property `selectionMode`
4834
+ */
4835
+ getSelectionMode(): string;
4836
+ /**
4837
+ * Get the selection variant from the chart. This function considers only the selection variant applied
4838
+ * at the control level.
4839
+ *
4840
+ *
4841
+ * @returns A promise that resolves with {@link sap.fe.navigation.SelectionVariant }.
4842
+ */
4843
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
4844
+ /**
4845
+ * Gets current value of property variantManagement.
4020
4846
  *
4021
4847
  *
4022
- * @returns Value of property `contextPath`
4848
+ * @returns Value of property `variantManagement`
4023
4849
  */
4024
- getContextPath(): string;
4850
+ getVariantManagement(): string;
4025
4851
  /**
4026
- * Gets the key of the current variant in the associated variant management.
4852
+ * Gets current value of property contextPath.
4027
4853
  *
4028
4854
  *
4029
- * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
4855
+ * @returns Value of property `contextPath`
4030
4856
  */
4031
- getCurrentVariantKey(): null | string;
4857
+ setContextPath(): string;
4858
+ /**
4859
+ * Sets the variant of the provided key in the associated variant management.
4860
+ */
4861
+ setCurrentVariantKey(
4862
+ /**
4863
+ * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
4864
+ */
4865
+ key: string
4866
+ ): void;
4032
4867
  /**
4033
4868
  * Gets current value of property filterBar.
4034
4869
  *
4035
4870
  *
4036
4871
  * @returns Value of property `filterBar`
4037
4872
  */
4038
- getFilterBar(): string;
4873
+ setFilterBar(): string;
4039
4874
  /**
4040
4875
  * Gets current value of property header.
4041
4876
  *
4042
4877
  *
4043
4878
  * @returns Value of property `header`
4044
4879
  */
4045
- getHeader(): string;
4880
+ setHeader(): string;
4046
4881
  /**
4047
4882
  * Gets current value of property headerVisible.
4048
4883
  *
4049
4884
  *
4050
4885
  * @returns Value of property `headerVisible`
4051
4886
  */
4052
- getHeaderVisible(): boolean;
4887
+ setHeaderVisible(): boolean;
4053
4888
  /**
4054
4889
  * Gets current value of property metaPath.
4055
4890
  *
4056
4891
  *
4057
4892
  * @returns Value of property `metaPath`
4058
4893
  */
4059
- getMetaPath(): string;
4894
+ setMetaPath(): string;
4060
4895
  /**
4061
4896
  * Gets current value of property personalization.
4062
4897
  *
4063
4898
  *
4064
4899
  * @returns Value of property `personalization`
4065
4900
  */
4066
- getPersonalization(): string;
4901
+ setPersonalization(): string;
4067
4902
  /**
4068
- * Get the presentation variant that is currently applied on the chart.
4903
+ * Set the presentation variant for the mdc chart.
4904
+ * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
4905
+ * be followed while trying to set the PresentationVariant as needed.
4906
+ * The values dimensions, measures and other properties should also be given in the valid format and null
4907
+ * or empty values should be avoided.
4908
+ * One dimension attribute should have only one role associated with it on a given chart.
4909
+ */
4910
+ setPresentationVariant(
4911
+ /**
4912
+ * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
4913
+ */
4914
+ presentationVariant: sap.fe.navigation.PresentationVariant
4915
+ ): Promise<void>;
4916
+ /**
4917
+ * Gets current value of property selectionMode.
4069
4918
  *
4070
4919
  *
4071
- * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
4920
+ * @returns Value of property `selectionMode`
4072
4921
  */
4073
- getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
4922
+ setSelectionMode(): string;
4074
4923
  /**
4075
- * Gets contexts from the chart that have been selected by the user.
4924
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
4925
+ * filters and then apply the SelectionVariant values.
4076
4926
  *
4077
4927
  *
4078
- * @returns Contexts of the rows selected by the user
4928
+ * @returns A promise for asynchronous handling
4079
4929
  */
4080
- getSelectedContexts(): sap.ui.model.odata.v4.Context[];
4930
+ setSelectionVariant(
4931
+ /**
4932
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
4933
+ */
4934
+ selectionVariant: sap.fe.navigation.SelectionVariant,
4935
+ /**
4936
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
4937
+ * to display the filter value descriptions, instead of loading them from the backend
4938
+ */
4939
+ prefillDescriptions?: boolean
4940
+ ): Promise<any>;
4081
4941
  /**
4082
- * Gets current value of property selectionMode.
4942
+ * Gets current value of property variantManagement.
4083
4943
  *
4084
4944
  *
4085
- * @returns Value of property `selectionMode`
4945
+ * @returns Value of property `variantManagement`
4086
4946
  */
4087
- getSelectionMode(): string;
4947
+ setVariantManagement(): string;
4948
+ }
4949
+ /**
4950
+ * API to add parameters to the collection binding infos.
4951
+ */
4952
+ class CollectionBindingInfo {
4088
4953
  /**
4089
- * Get the selection variant from the chart. This function considers only the selection variant applied
4090
- * at the control level.
4954
+ * Adds a filter to the filters already present in the binding info.
4955
+ */
4956
+ addFilter(
4957
+ /**
4958
+ * The {@link sap.ui.model.Filter "filter"} to add
4959
+ */
4960
+ customFilter: sap.ui.model.Filter
4961
+ ): void;
4962
+ /**
4963
+ * Adds parameters to the select query.
4964
+ */
4965
+ addSelect(
4966
+ /**
4967
+ * The list or properties to add to the query
4968
+ */
4969
+ parameters: string[]
4970
+ ): void;
4971
+ /**
4972
+ * Adds a sorter to the sorter(s) already present, or create one if none exists.
4973
+ */
4974
+ addSorter(
4975
+ /**
4976
+ * The {@link sap.ui.model.Sorter "sorter"} to add to the query
4977
+ */
4978
+ sorter: sap.ui.model.Sorter
4979
+ ): void;
4980
+ /**
4981
+ * Retrieve the 'serialized' binding info, useful if you want to create your own binding
4091
4982
  *
4092
4983
  *
4093
- * @returns A promise that resolves with {@link sap.fe.navigation.SelectionVariant }.
4984
+ * @returns The {@link sap.fe.macros.CollectionBindingInfo "CollectionBindingInfo"}
4094
4985
  */
4095
- getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
4986
+ getBindingInfo(): /* was: sap.fe.macros.CollectionBindingInfo.CollectionBindingInfo */ any;
4096
4987
  /**
4097
- * Gets current value of property variantManagement.
4988
+ * Returns the current filters applied to the Table.
4098
4989
  *
4099
4990
  *
4100
- * @returns Value of property `variantManagement`
4991
+ * @returns The {@link sap.ui.model.Filter "filters"} on the table
4101
4992
  */
4102
- getVariantManagement(): string;
4993
+ getFilters(): sap.ui.model.Filter | undefined;
4994
+ /**
4995
+ * Returns the current sorters of the Table.
4996
+ *
4997
+ *
4998
+ * @returns The {@link sap.ui.model.Sorter "sorters"} on the table
4999
+ */
5000
+ getSorters(): sap.ui.model.Sorter[] | undefined;
5001
+ }
5002
+ /**
5003
+ * Building block for creating a field based on the metadata provided by OData V4.
5004
+ *
5005
+ *
5006
+ * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
5007
+ * property from the entity type.
5008
+ * When creating a Field building block, you must provide an ID to ensure everything works correctly.
5009
+ *
5010
+ * Usage example:
5011
+ *
5012
+ * ```javascript
5013
+ *
5014
+ * <macros:Field id="MyField" metaPath="MyProperty" />
5015
+ * ```
5016
+ *
5017
+ * Overview of Building Blocks
5018
+ */
5019
+ class Field extends sap.fe.macros.MacroAPI {
5020
+ /**
5021
+ * Adds a message to the field.
5022
+ *
5023
+ *
5024
+ * @returns The id of the message
5025
+ */
5026
+ addMessage(
5027
+ /**
5028
+ * The parameters to create message
5029
+ */
5030
+ parameters: {
5031
+ /**
5032
+ * Message description
5033
+ */
5034
+ description?: string;
5035
+ /**
5036
+ * Message text
5037
+ */
5038
+ message?: string;
5039
+ /**
5040
+ * True if the message is persistent
5041
+ */
5042
+ persistent?: boolean;
5043
+ /**
5044
+ * Type of the message
5045
+ */
5046
+ type?: /* was: sap.ui.core.message.MessageType */ any;
5047
+ }
5048
+ ): string;
5049
+ /**
5050
+ * Gets the current enablement state of the field.
5051
+ *
5052
+ *
5053
+ * @returns Boolean value with the enablement state
5054
+ */
5055
+ getEnabled(): boolean;
5056
+ /**
5057
+ * Retrieves the current value of the field.
5058
+ *
5059
+ *
5060
+ * @returns The current value of the field
5061
+ */
5062
+ getValue(): boolean | float | string | undefined;
5063
+ /**
5064
+ * Removes a message from the field.
5065
+ */
5066
+ removeMessage(
5067
+ /**
5068
+ * The id of the message
5069
+ */
5070
+ id: string
5071
+ ): void;
5072
+ /**
5073
+ * Sets the current enablement state of the field.
5074
+ *
5075
+ *
5076
+ * @returns The current field reference
5077
+ */
5078
+ setEnabled(): sap.ui.core.Control;
5079
+ /**
5080
+ * Sets the current value of the field.
5081
+ *
5082
+ *
5083
+ * @returns The current field reference
5084
+ */
5085
+ setValue(): sap.ui.core.Control;
5086
+ }
5087
+ /**
5088
+ * Building block used to create a KPI tag.
5089
+ */
5090
+ class KPITag extends sap.fe.core.buildingBlocks.BuildingBlock {}
5091
+ /**
5092
+ * Base API control for building blocks.
5093
+ */
5094
+ class MacroAPI
5095
+ extends sap.fe.core.buildingBlocks.BuildingBlock
5096
+ implements sap.ui.core.IFormContent
5097
+ {
5098
+ __implements__sap_ui_core_IFormContent: boolean;
5099
+ }
5100
+ /**
5101
+ * Building block used to show bound messages.
5102
+ * The Message Button Building Block gets the bound messages from the MessageModel.
5103
+ * Usage example:
5104
+ *
5105
+ * ```javascript
5106
+ *
5107
+ * <macros:MessageButton visibilityChange=".handler.onMessageButtonVisibilityChange" />
5108
+ * ```
5109
+ *
5110
+ *
5111
+ *
5112
+ * @experimental
5113
+ */
5114
+ class MessageButton extends sap.fe.core.buildingBlocks.BuildingBlock {}
5115
+ /**
5116
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
5117
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/ Overview of Micro Chart Building Block}
5118
+ *
5119
+ *
5120
+ * Usually, a contextPath and metaPath is expected.
5121
+ *
5122
+ * Usage example:
5123
+ *
5124
+ * ```javascript
5125
+ *
5126
+ * <macros:MicroChart id="MyMicroChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
5127
+ * ```
5128
+ *
5129
+ *
5130
+ * ```javascript
5131
+ *
5132
+ * sap.ui.require(["sap/fe/macros/MicroChart"], function(MicroChart) {
5133
+ * ...
5134
+ * new MicroChart("myMicroChart", {metaPath:"@com.sap.vocabularies.UI.v1.Chart"})
5135
+ * })
5136
+ * ```
5137
+ *
5138
+ *
5139
+ *
5140
+ * @since 1.93.0
5141
+ */
5142
+ class MicroChart extends sap.fe.core.buildingBlocks.BuildingBlock {
4103
5143
  /**
4104
5144
  * Gets current value of property contextPath.
4105
5145
  *
4106
5146
  *
4107
5147
  * @returns Value of property `contextPath`
4108
5148
  */
4109
- setContextPath(): string;
4110
- /**
4111
- * Sets the variant of the provided key in the associated variant management.
4112
- */
4113
- setCurrentVariantKey(
4114
- /**
4115
- * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
4116
- */
4117
- key: string
4118
- ): void;
4119
- /**
4120
- * Gets current value of property filterBar.
4121
- *
4122
- *
4123
- * @returns Value of property `filterBar`
4124
- */
4125
- setFilterBar(): string;
4126
- /**
4127
- * Gets current value of property header.
4128
- *
4129
- *
4130
- * @returns Value of property `header`
4131
- */
4132
- setHeader(): string;
5149
+ getContextPath(): string;
4133
5150
  /**
4134
- * Gets current value of property headerVisible.
5151
+ * Gets current value of property hideOnNoData.
4135
5152
  *
4136
5153
  *
4137
- * @returns Value of property `headerVisible`
5154
+ * @returns Value of property `hideOnNoData`
4138
5155
  */
4139
- setHeaderVisible(): boolean;
5156
+ getHideOnNoData(): boolean;
4140
5157
  /**
4141
5158
  * Gets current value of property metaPath.
4142
5159
  *
4143
5160
  *
4144
5161
  * @returns Value of property `metaPath`
4145
5162
  */
4146
- setMetaPath(): string;
5163
+ getMetaPath(): string;
4147
5164
  /**
4148
- * Gets current value of property personalization.
5165
+ * Gets current value of property showOnlyChart.
4149
5166
  *
4150
5167
  *
4151
- * @returns Value of property `personalization`
4152
- */
4153
- setPersonalization(): string;
4154
- /**
4155
- * Set the presentation variant for the mdc chart.
4156
- * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
4157
- * be followed while trying to set the PresentationVariant as needed.
4158
- * The values dimensions, measures and other properties should also be given in the valid format and null
4159
- * or empty values should be avoided.
4160
- * One dimension attribute should have only one role associated with it on a given chart.
5168
+ * @returns Value of property `showOnlyChart`
4161
5169
  */
4162
- setPresentationVariant(
4163
- /**
4164
- * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
4165
- */
4166
- presentationVariant: sap.fe.navigation.PresentationVariant
4167
- ): Promise<void>;
5170
+ getShowOnlyChart(): boolean;
4168
5171
  /**
4169
- * Gets current value of property selectionMode.
5172
+ * Gets current value of property size.
4170
5173
  *
4171
5174
  *
4172
- * @returns Value of property `selectionMode`
5175
+ * @returns Value of property `size`
4173
5176
  */
4174
- setSelectionMode(): string;
5177
+ getSize(): string;
4175
5178
  /**
4176
- * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
4177
- * filters and then apply the SelectionVariant values.
5179
+ * Gets current value of property contextPath.
4178
5180
  *
4179
5181
  *
4180
- * @returns A promise for asynchronous handling
5182
+ * @returns Value of property `contextPath`
4181
5183
  */
4182
- setSelectionVariant(
4183
- /**
4184
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
4185
- */
4186
- selectionVariant: sap.fe.navigation.SelectionVariant,
4187
- /**
4188
- * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
4189
- * to display the filter value descriptions, instead of loading them from the backend
4190
- */
4191
- prefillDescriptions?: boolean
4192
- ): Promise<any>;
5184
+ setContextPath(): string;
4193
5185
  /**
4194
- * Gets current value of property variantManagement.
5186
+ * Gets current value of property hideOnNoData.
4195
5187
  *
4196
5188
  *
4197
- * @returns Value of property `variantManagement`
4198
- */
4199
- setVariantManagement(): string;
4200
- }
4201
- /**
4202
- * API to add parameters to the collection binding infos.
4203
- */
4204
- class CollectionBindingInfo {
4205
- /**
4206
- * Adds a filter to the filters already present in the binding info.
4207
- */
4208
- addFilter(
4209
- /**
4210
- * The {@link sap.ui.model.Filter "filter"} to add
4211
- */
4212
- customFilter: sap.ui.model.Filter
4213
- ): void;
4214
- /**
4215
- * Adds parameters to the select query.
4216
- */
4217
- addSelect(
4218
- /**
4219
- * The list or properties to add to the query
4220
- */
4221
- parameters: string[]
4222
- ): void;
4223
- /**
4224
- * Adds a sorter to the sorter(s) already present, or create one if none exists.
5189
+ * @returns Value of property `hideOnNoData`
4225
5190
  */
4226
- addSorter(
4227
- /**
4228
- * The {@link sap.ui.model.Sorter "sorter"} to add to the query
4229
- */
4230
- sorter: sap.ui.model.Sorter
4231
- ): void;
5191
+ setHideOnNoData(): boolean;
4232
5192
  /**
4233
- * Retrieve the 'serialized' binding info, useful if you want to create your own binding
5193
+ * Gets current value of property metaPath.
4234
5194
  *
4235
5195
  *
4236
- * @returns The {@link sap.fe.macros.CollectionBindingInfo "CollectionBindingInfo"}
5196
+ * @returns Value of property `metaPath`
4237
5197
  */
4238
- getBindingInfo(): /* was: sap.fe.macros.CollectionBindingInfo.CollectionBindingInfo */ any;
5198
+ setMetaPath(): string;
4239
5199
  /**
4240
- * Returns the current filters applied to the Table.
5200
+ * Gets current value of property showOnlyChart.
4241
5201
  *
4242
5202
  *
4243
- * @returns The {@link sap.ui.model.Filter "filters"} on the table
5203
+ * @returns Value of property `showOnlyChart`
4244
5204
  */
4245
- getFilters(): sap.ui.model.Filter | undefined;
5205
+ setShowOnlyChart(): boolean;
4246
5206
  /**
4247
- * Returns the current sorters of the Table.
5207
+ * Gets current value of property size.
4248
5208
  *
4249
5209
  *
4250
- * @returns The {@link sap.ui.model.Sorter "sorters"} on the table
5210
+ * @returns Value of property `size`
4251
5211
  */
4252
- getSorters(): sap.ui.model.Sorter[] | undefined;
4253
- }
4254
- /**
4255
- * Building block used to create a KPI tag.
4256
- */
4257
- class KPITag extends sap.fe.core.buildingBlocks.BuildingBlock {}
4258
- /**
4259
- * Base API control for building blocks.
4260
- */
4261
- class MacroAPI
4262
- extends sap.fe.core.buildingBlocks.BuildingBlock
4263
- implements sap.ui.core.IFormContent
4264
- {
4265
- __implements__sap_ui_core_IFormContent: boolean;
5212
+ setSize(): string;
4266
5213
  }
4267
5214
  /**
4268
5215
  * Building block for creating a MultiValueField based on the metadata provided by OData V4.
@@ -4288,6 +5235,11 @@ declare namespace sap {
4288
5235
  * @experimental As of version 1.118.0.
4289
5236
  */
4290
5237
  class MultiValueField extends sap.fe.core.buildingBlocks.BuildingBlock {}
5238
+ /**
5239
+ * Provides a Page building block that can be used to create a page with a title and content
5240
+ * By default, the page comes with an ObjectTitle
5241
+ */
5242
+ class Page extends sap.fe.core.buildingBlocks.BuildingBlock {}
4291
5243
  /**
4292
5244
  * Building block used to create a paginator control.
4293
5245
  * Usage example:
@@ -4376,91 +5328,6 @@ declare namespace sap {
4376
5328
  * @since 1.93.0
4377
5329
  */
4378
5330
  class FlexibleColumnLayoutActions extends sap.ui.core.Control {}
4379
- /**
4380
- * Building block for creating a field based on the metadata provided by OData V4.
4381
- *
4382
- *
4383
- * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
4384
- * property from the entity type.
4385
- * When creating a Field building block, you must provide an ID to ensure everything works correctly.
4386
- *
4387
- * Usage example:
4388
- *
4389
- * ```javascript
4390
- *
4391
- * <macros:Field id="MyField" metaPath="MyProperty" />
4392
- * ```
4393
- *
4394
- * Overview of Building Blocks
4395
- */
4396
- class Field extends sap.fe.macros.MacroAPI {
4397
- /**
4398
- * Adds a message to the field.
4399
- *
4400
- *
4401
- * @returns The id of the message
4402
- */
4403
- addMessage(
4404
- /**
4405
- * The parameters to create message
4406
- */
4407
- parameters: {
4408
- /**
4409
- * Message description
4410
- */
4411
- description?: string;
4412
- /**
4413
- * Message text
4414
- */
4415
- message?: string;
4416
- /**
4417
- * True if the message is persistent
4418
- */
4419
- persistent?: boolean;
4420
- /**
4421
- * Type of the message
4422
- */
4423
- type?: /* was: sap.ui.core.message.MessageType */ any;
4424
- }
4425
- ): string;
4426
- /**
4427
- * Gets the current enablement state of the field.
4428
- *
4429
- *
4430
- * @returns Boolean value with the enablement state
4431
- */
4432
- getEnabled(): boolean;
4433
- /**
4434
- * Retrieves the current value of the field.
4435
- *
4436
- *
4437
- * @returns The current value of the field
4438
- */
4439
- getValue(): boolean | float | string | undefined;
4440
- /**
4441
- * Removes a message from the field.
4442
- */
4443
- removeMessage(
4444
- /**
4445
- * The id of the message
4446
- */
4447
- id: string
4448
- ): void;
4449
- /**
4450
- * Sets the current enablement state of the field.
4451
- *
4452
- *
4453
- * @returns The current field reference
4454
- */
4455
- setEnabled(): sap.ui.core.Control;
4456
- /**
4457
- * Sets the current value of the field.
4458
- *
4459
- *
4460
- * @returns The current field reference
4461
- */
4462
- setValue(): sap.ui.core.Control;
4463
- }
4464
5331
  /**
4465
5332
  * Building block for creating a FilterBar based on the metadata provided by OData V4.
4466
5333
  * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarDefault Overview of Building Blocks}
@@ -4645,18 +5512,11 @@ declare namespace sap {
4645
5512
  * @since 1.90.0
4646
5513
  */
4647
5514
  class FormElement extends sap.ui.core.Control {}
4648
- /**
4649
- * Building block used to create a MicroChart based on the metadata provided by OData V4.
4650
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/microChartDefault Overview of Building Blocks}
4651
- *
4652
- * @since 1.93.0
4653
- */
4654
- class MicroChart extends sap.ui.core.Control {}
4655
5515
  /**
4656
5516
  * Building block used to create a table based on the metadata provided by OData V4.
4657
5517
  *
4658
5518
  *
4659
- * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
5519
+ * Usually, a LineItem, PresentationVariant, or SelectionPresentationVariant annotation is expected, but
4660
5520
  * the Table building block can also be used to display an EntitySet.
4661
5521
  *
4662
5522
  *
@@ -5013,14 +5873,6 @@ declare namespace sap {
5013
5873
  Chart
5014
5874
  >;
5015
5875
 
5016
- /**
5017
- * Event object of the KPITag#press event.
5018
- */
5019
- type KPITag$PressEvent = sap.ui.base.Event<
5020
- KPITag$PressEventParameters,
5021
- KPITag
5022
- >;
5023
-
5024
5876
  /**
5025
5877
  * Event object of the Field#change event.
5026
5878
  */
@@ -5037,6 +5889,22 @@ declare namespace sap {
5037
5889
  Field
5038
5890
  >;
5039
5891
 
5892
+ /**
5893
+ * Event object of the KPITag#press event.
5894
+ */
5895
+ type KPITag$PressEvent = sap.ui.base.Event<
5896
+ KPITag$PressEventParameters,
5897
+ KPITag
5898
+ >;
5899
+
5900
+ /**
5901
+ * Event object of the MessageButton#visibilityChange event.
5902
+ */
5903
+ type MessageButton$VisibilityChangeEvent = sap.ui.base.Event<
5904
+ MessageButton$VisibilityChangeEventParameters,
5905
+ MessageButton
5906
+ >;
5907
+
5040
5908
  /**
5041
5909
  * Event object of the FilterBar#afterClear event.
5042
5910
  */
@@ -5138,9 +6006,9 @@ declare namespace sap {
5138
6006
 
5139
6007
  "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block": undefined;
5140
6008
 
5141
- "sap/fe/macros/field/Field": undefined;
6009
+ "sap/fe/macros/Field": undefined;
5142
6010
 
5143
- "sap/fe/macros/field/FieldAPI": undefined;
6011
+ "sap/fe/macros/field/Field": undefined;
5144
6012
 
5145
6013
  "sap/fe/macros/field/FieldFormatOptions": undefined;
5146
6014
 
@@ -5160,12 +6028,16 @@ declare namespace sap {
5160
6028
 
5161
6029
  "sap/fe/macros/MacroAPI": undefined;
5162
6030
 
5163
- "sap/fe/macros/microchart/MicroChart": undefined;
6031
+ "sap/fe/macros/MessageButton": undefined;
5164
6032
 
5165
- "sap/fe/macros/microchart/MicroChart.block": undefined;
6033
+ "sap/fe/macros/MicroChart": undefined;
6034
+
6035
+ "sap/fe/macros/microchart/MicroChart": undefined;
5166
6036
 
5167
6037
  "sap/fe/macros/MultiValueField": undefined;
5168
6038
 
6039
+ "sap/fe/macros/Page": undefined;
6040
+
5169
6041
  "sap/fe/macros/Paginator": undefined;
5170
6042
 
5171
6043
  "sap/fe/macros/RichTextEditor": undefined;
@@ -5184,8 +6056,22 @@ declare namespace sap {
5184
6056
 
5185
6057
  "sap/fe/macros/table/ActionGroup": undefined;
5186
6058
 
6059
+ "sap/fe/macros/table/ActionGroupOverride": undefined;
6060
+
6061
+ "sap/fe/macros/table/ActionOverride": undefined;
6062
+
6063
+ "sap/fe/macros/table/AnalyticalConfiguration": undefined;
6064
+
5187
6065
  "sap/fe/macros/table/Column": undefined;
5188
6066
 
6067
+ "sap/fe/macros/table/ColumnExportSettings": undefined;
6068
+
6069
+ "sap/fe/macros/table/ColumnOverride": undefined;
6070
+
6071
+ "sap/fe/macros/table/MassEdit": undefined;
6072
+
6073
+ "sap/fe/macros/table/QuickVariantSelection": undefined;
6074
+
5189
6075
  "sap/fe/macros/table/Table": undefined;
5190
6076
 
5191
6077
  "sap/fe/macros/table/Table.block": undefined;