@sapui5/ts-types 1.124.1 → 1.125.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +6 -5
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +7 -0
  10. package/types/sap.fe.core.d.ts +5 -5
  11. package/types/sap.fe.macros.d.ts +664 -78
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +1 -1
  14. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  15. package/types/sap.fe.templates.d.ts +1 -1
  16. package/types/sap.fe.test.d.ts +1 -1
  17. package/types/sap.fe.tools.d.ts +1 -1
  18. package/types/sap.feedback.ui.d.ts +1 -1
  19. package/types/sap.gantt.d.ts +363 -330
  20. package/types/sap.insights.d.ts +1 -1
  21. package/types/{mobile-1.124.0-d.ts → sap.m.d.ts} +303 -87
  22. package/types/sap.makit.d.ts +1 -1
  23. package/types/sap.me.d.ts +1 -1
  24. package/types/sap.ndc.d.ts +1 -1
  25. package/types/sap.ovp.d.ts +1 -1
  26. package/types/sap.rules.ui.d.ts +1 -1
  27. package/types/sap.sac.df.d.ts +1 -1
  28. package/types/sap.suite.ui.commons.d.ts +4 -4
  29. package/types/sap.suite.ui.generic.template.d.ts +4 -4
  30. package/types/sap.suite.ui.microchart.d.ts +19 -19
  31. package/types/{tnt-1.124.0-d.ts → sap.tnt.d.ts} +1 -1
  32. package/types/sap.ui.codeeditor.d.ts +1 -1
  33. package/types/sap.ui.commons.d.ts +1 -1
  34. package/types/sap.ui.comp.d.ts +110 -38
  35. package/types/{core-1.124.0-d.ts → sap.ui.core.d.ts} +130 -80
  36. package/types/{dt-1.124.0-d.ts → sap.ui.dt.d.ts} +1 -1
  37. package/types/sap.ui.export.d.ts +1 -1
  38. package/types/sap.ui.fl.d.ts +3 -1
  39. package/types/sap.ui.generic.app.d.ts +1 -1
  40. package/types/sap.ui.generic.template.d.ts +1 -1
  41. package/types/sap.ui.integration.d.ts +6 -1
  42. package/types/sap.ui.layout.d.ts +1 -1
  43. package/types/{mdc-1.124.0-d.ts → sap.ui.mdc.d.ts} +43 -10
  44. package/types/sap.ui.richtexteditor.d.ts +1 -1
  45. package/types/sap.ui.rta.d.ts +1 -1
  46. package/types/sap.ui.suite.d.ts +1 -1
  47. package/types/sap.ui.support.d.ts +1 -1
  48. package/types/sap.ui.table.d.ts +27 -16
  49. package/types/sap.ui.testrecorder.d.ts +1 -1
  50. package/types/sap.ui.unified.d.ts +1 -1
  51. package/types/sap.ui.ux3.d.ts +1 -1
  52. package/types/sap.ui.vbm.d.ts +1 -1
  53. package/types/sap.ui.vk.d.ts +1 -1
  54. package/types/sap.ui.vtm.d.ts +1 -1
  55. package/types/sap.ui.webc.common.d.ts +3 -1
  56. package/types/sap.ui.webc.fiori.d.ts +1 -1
  57. package/types/sap.ui.webc.main.d.ts +1 -1
  58. package/types/sap.uiext.inbox.d.ts +1 -1
  59. package/types/sap.ushell.d.ts +49 -103
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +1 -1
  62. package/types/sap.viz.d.ts +1 -1
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +1 -1
  65. package/types/sap.zen.crosstab.d.ts +1 -1
  66. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.124.1
1
+ // For Library Version: 1.125.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -1359,80 +1359,639 @@ declare namespace sap {
1359
1359
  outbound?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1360
1360
  }
1361
1361
 
1362
+ /**
1363
+ * Describes the settings that can be provided to the TreeTable constructor.
1364
+ *
1365
+ * @experimental (since 1.125.0)
1366
+ */
1367
+ interface $TreeTableSettings
1368
+ extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
1369
+ /**
1370
+ * An expression that allows you to control the 'busy' state of the table.
1371
+ */
1372
+ busy?:
1373
+ | boolean
1374
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1375
+ | `{${string}}`;
1376
+
1377
+ /**
1378
+ * Defines the path of the context used in the current page or block.
1379
+ * This setting is defined by the framework.
1380
+ */
1381
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1382
+
1383
+ /**
1384
+ * A set of options that can be configured.
1385
+ */
1386
+ creationMode?:
1387
+ | sap.fe.macros.table.TreeTableCreationOptions
1388
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1389
+ | `{${string}}`;
1390
+
1391
+ /**
1392
+ * Controls if the copy functionality of the table is disabled or not.
1393
+ */
1394
+ disableCopyToClipboard?:
1395
+ | boolean
1396
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1397
+ | `{${string}}`;
1398
+
1399
+ /**
1400
+ * Specifies if the column width is automatically calculated.
1401
+ */
1402
+ enableAutoColumnWidth?:
1403
+ | boolean
1404
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1405
+ | `{${string}}`;
1406
+
1407
+ /**
1408
+ * Controls if the export functionality of the table is enabled or not.
1409
+ */
1410
+ enableExport?:
1411
+ | boolean
1412
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1413
+ | `{${string}}`;
1414
+
1415
+ /**
1416
+ * Controls whether the table can be opened in fullscreen mode or not.
1417
+ */
1418
+ enableFullScreen?:
1419
+ | boolean
1420
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1421
+ | `{${string}}`;
1422
+
1423
+ /**
1424
+ * Controls if the paste functionality of the table is enabled or not.
1425
+ */
1426
+ enablePaste?:
1427
+ | boolean
1428
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1429
+ | `{${string}}`;
1430
+
1431
+ /**
1432
+ * Maximum allowed number of records to be exported in one request.
1433
+ */
1434
+ exportRequestSize?:
1435
+ | int
1436
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1437
+ | `{${string}}`;
1438
+
1439
+ /**
1440
+ * ID of the FilterBar building block associated with the table.
1441
+ */
1442
+ filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1443
+
1444
+ /**
1445
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
1446
+ * This property is not relevant for responsive tables
1447
+ */
1448
+ frozenColumnCount?:
1449
+ | int
1450
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1451
+ | `{${string}}`;
1452
+
1453
+ /**
1454
+ * Specifies the header text that is shown in the table.
1455
+ */
1456
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1457
+
1458
+ /**
1459
+ * Controls if the header text should be shown or not.
1460
+ */
1461
+ headerVisible?:
1462
+ | boolean
1463
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1464
+ | `{${string}}`;
1465
+
1466
+ /**
1467
+ * A set of options that can be configured.
1468
+ */
1469
+ hierarchyQualifier?:
1470
+ | string
1471
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1472
+
1473
+ /**
1474
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
1475
+ *
1476
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
1477
+ * value of fields that are provided in the ignoredfields.
1478
+ *
1479
+ * Any column referencing an ignored field is to be removed.
1480
+ */
1481
+ ignoredFields?:
1482
+ | string
1483
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1484
+
1485
+ /**
1486
+ * Defines the extension point to control if a source node can be dropped on a specific parent node.
1487
+ */
1488
+ isMoveToPositionAllowed?:
1489
+ | string
1490
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1491
+
1492
+ /**
1493
+ * Defines the extension point to control if a node can be dragged.
1494
+ */
1495
+ isNodeMovable?:
1496
+ | string
1497
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1498
+
1499
+ /**
1500
+ * Defines whether to display the search action.
1501
+ */
1502
+ isSearchable?:
1503
+ | boolean
1504
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1505
+ | `{${string}}`;
1506
+
1507
+ /**
1508
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
1509
+ * based on the current contextPath.
1510
+ */
1511
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1512
+
1513
+ /**
1514
+ * Controls which options should be enabled for the table personalization dialog.
1515
+ * If it is set to `true`, all possible options for this kind of table are enabled.
1516
+ *
1517
+ * If it is set to `false`, personalization is disabled.
1518
+ *
1519
+ *
1520
+ *
1521
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
1522
+ * with the options you want to be available.
1523
+ *
1524
+ * Available options are:
1525
+ *
1526
+ * - Sort
1527
+ *
1528
+ * - Column
1529
+ *
1530
+ * - Filter
1531
+ */
1532
+ personalization?:
1533
+ | string
1534
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1535
+
1536
+ /**
1537
+ * An expression that allows you to control the 'read-only' state of the table.
1538
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
1539
+ * current state.
1540
+ */
1541
+ readOnly?:
1542
+ | boolean
1543
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1544
+ | `{${string}}`;
1545
+
1546
+ /**
1547
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
1548
+ */
1549
+ rowCount?:
1550
+ | int
1551
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1552
+ | `{${string}}`;
1553
+
1554
+ /**
1555
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
1556
+ * Allowed values are `Auto`, `Fixed`.
1557
+ *
1558
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
1559
+ *
1560
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
1561
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
1562
+ * less than defined in the `rowCount` property.
1563
+ */
1564
+ rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1565
+
1566
+ /**
1567
+ * Defines the selection mode to be used by the table.
1568
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
1569
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
1570
+ * the consistent selection mode.
1571
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
1572
+ * Fiori guidelines.
1573
+ */
1574
+ selectionMode?:
1575
+ | string
1576
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1577
+
1578
+ /**
1579
+ * Defines the type of table that will be used by the building block to render the data. This setting is
1580
+ * defined by the framework.
1581
+ * Allowed value is `TreeTable`.
1582
+ */
1583
+ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1584
+
1585
+ /**
1586
+ * Controls the kind of variant management that should be enabled for the table.
1587
+ * Allowed value is `Control`.
1588
+ *
1589
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
1590
+ * to this.
1591
+ *
1592
+ * If not set with any value, control level variant management is not available for this table.
1593
+ */
1594
+ variantManagement?:
1595
+ | string
1596
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1597
+
1598
+ /**
1599
+ * Indicates if the column header should be a part of the width calculation.
1600
+ */
1601
+ widthIncludingColumnHeader?:
1602
+ | boolean
1603
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1604
+ | `{${string}}`;
1605
+
1606
+ /**
1607
+ * Aggregate actions of the table.
1608
+ */
1609
+ actions?:
1610
+ | Array<
1611
+ sap.fe.macros.table.ActionGroup | sap.fe.macros.table.Action
1612
+ >
1613
+ | sap.fe.macros.table.ActionGroup
1614
+ | sap.fe.macros.table.Action
1615
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1616
+ | `{${string}}`;
1617
+
1618
+ /**
1619
+ * Aggregate columns of the table.
1620
+ */
1621
+ columns?:
1622
+ | sap.fe.macros.table.Column[]
1623
+ | sap.fe.macros.table.Column
1624
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1625
+ | `{${string}}`;
1626
+ }
1627
+
1362
1628
  /**
1363
1629
  * Describes the settings that can be provided to the TreeTableCreationOptions constructor.
1364
1630
  */
1365
1631
  interface $TreeTableCreationOptionsSettings
1366
1632
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1367
1633
  /**
1368
- * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
1634
+ * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
1635
+ */
1636
+ isCreateEnabled?:
1637
+ | string
1638
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1639
+
1640
+ /**
1641
+ * Defines the creation mode to be used by the tree table.
1642
+ * Allowed values are `NewPage` or `Inline`.
1643
+ *
1644
+ *
1645
+ *
1646
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
1647
+ * or 'Deferred' is used.
1648
+ *
1649
+ * Inline - the creation is done inline.
1650
+ *
1651
+ * If not set with any value:
1652
+ *
1653
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1654
+ */
1655
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1656
+
1657
+ /**
1658
+ * Defines the nodes to be added on the custom create.
1659
+ * This object must have the following properties:
1660
+ * propertyName: the name of the property on the page entity set used to categorize the node type to be
1661
+ * created within the hierarchy
1662
+ *
1663
+ * values: an array of key and label that define a value of the property defined by the propertyName key
1664
+ * and its label
1665
+ */
1666
+ nodeType?:
1667
+ | object
1668
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1669
+ | `{${string}}`;
1670
+ }
1671
+
1672
+ /**
1673
+ * Parameters of the Table#beforeRebindTable event.
1674
+ */
1675
+ interface Table$BeforeRebindTableEventParameters {}
1676
+
1677
+ /**
1678
+ * Parameters of the Table#rowPress event.
1679
+ */
1680
+ interface Table$RowPressEventParameters {}
1681
+
1682
+ /**
1683
+ * Parameters of the Table#selectionChange event.
1684
+ */
1685
+ interface Table$SelectionChangeEventParameters {}
1686
+
1687
+ /**
1688
+ * Parameters of the TreeTable#beforeRebindTable event.
1689
+ */
1690
+ interface TreeTable$BeforeRebindTableEventParameters {}
1691
+
1692
+ /**
1693
+ * Parameters of the TreeTable#rowPress event.
1694
+ */
1695
+ interface TreeTable$RowPressEventParameters {}
1696
+
1697
+ /**
1698
+ * Parameters of the TreeTable#selectionChange event.
1699
+ */
1700
+ interface TreeTable$SelectionChangeEventParameters {}
1701
+
1702
+ /**
1703
+ * Definition of a custom action to be used inside the table toolbar
1704
+ */
1705
+ class Action extends sap.fe.macros.controls
1706
+ .BuildingBlockObjectProperty {}
1707
+ /**
1708
+ * Definition of a custom ActionGroup to be used inside the table toolbar
1709
+ */
1710
+ class ActionGroup extends sap.fe.macros.controls
1711
+ .BuildingBlockObjectProperty {}
1712
+ /**
1713
+ * Definition of a custom column to be used inside the table.
1714
+ * The template for the column has to be provided as the default aggregation
1715
+ */
1716
+ class Column extends sap.fe.macros.controls
1717
+ .BuildingBlockObjectProperty {}
1718
+ /**
1719
+ * Building block used to create a table based on the metadata provided by OData V4.
1720
+ *
1721
+ *
1722
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
1723
+ * the Table building block can also be used to display an EntitySet.
1724
+ *
1725
+ *
1726
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
1727
+ *
1728
+ *
1729
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
1730
+ * also has a UI.LineItem as the first property of the Visualizations.
1731
+ * Usage example:
1732
+ *
1733
+ * ```javascript
1734
+ *
1735
+ * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
1736
+ * ...
1737
+ * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
1738
+ * })
1739
+ * ```
1740
+ *
1741
+ * This is currently an experimental API because the structure of the generated content will change to come
1742
+ * closer to the Table that you get out of templates.
1743
+ * The public method and property will not change but the internal structure will so be careful on your
1744
+ * usage.
1745
+ *
1746
+ *
1747
+ * @since 1.124.0
1748
+ * @experimental (since 1.124.0)
1749
+ */
1750
+ class Table extends sap.fe.macros.controls.BuildingBlockWithTemplating {
1751
+ /**
1752
+ * Adds an action to the table.
1753
+ *
1754
+ * @since 1.124.0
1755
+ * @experimental (since 1.124.0)
1756
+ *
1757
+ * @returns Reference to this in order to allow method chaining
1758
+ */
1759
+ addAction(
1760
+ /**
1761
+ * The action to add
1762
+ */
1763
+ action: sap.fe.macros.table.Action
1764
+ ): this;
1765
+ /**
1766
+ * Adds a column to the table.
1767
+ *
1768
+ * @since 1.124.0
1769
+ * @experimental (since 1.124.0)
1770
+ *
1771
+ * @returns Reference to this in order to allow method chaining
1772
+ */
1773
+ addColumn(
1774
+ /**
1775
+ * The column to add
1776
+ */
1777
+ column: sap.fe.macros.table.Column
1778
+ ): this;
1779
+ /**
1780
+ * Adds a message to the table.
1781
+ * The message applies to the whole table and not to an individual table row.
1782
+ *
1783
+ *
1784
+ *
1785
+ * @returns The ID of the message
1786
+ */
1787
+ addMessage(
1788
+ /**
1789
+ * The parameters to create the message
1790
+ */
1791
+ parameters: {
1792
+ /**
1793
+ * Message description
1794
+ */
1795
+ description?: string;
1796
+ /**
1797
+ * Message text
1798
+ */
1799
+ message?: string;
1800
+ /**
1801
+ * True if the message is persistent
1802
+ */
1803
+ persistent?: boolean;
1804
+ /**
1805
+ * Message type
1806
+ */
1807
+ type?: sap.ui.core.MessageType;
1808
+ }
1809
+ ): string;
1810
+ /**
1811
+ * Get the variant management applied to the table.
1812
+ *
1813
+ *
1814
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1815
+ */
1816
+ getCurrentVariantKey(): null | string;
1817
+ /**
1818
+ * Get the fields that should be ignored when generating the table.
1819
+ *
1820
+ * @since 1.124.0
1821
+ * @experimental (since 1.124.0)
1822
+ *
1823
+ * @returns The value of the ignoredFields property
1369
1824
  */
1370
- isCreateEnabled?:
1371
- | string
1372
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1373
-
1825
+ getIgnoredFields(): string;
1374
1826
  /**
1375
- * Defines the creation mode to be used by the tree table.
1376
- * Allowed values are `NewPage` or `Inline`.
1827
+ * Gets the path to the metadata that should be used to generate the table.
1377
1828
  *
1829
+ * @since 1.124.0
1830
+ * @experimental (since 1.124.0)
1378
1831
  *
1832
+ * @returns The path to the metadata
1833
+ */
1834
+ getMetaPath(): string;
1835
+ /**
1836
+ * Get the presentation variant that is currently applied on the table.
1379
1837
  *
1380
- * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
1381
- * or 'Deferred' is used.
1382
1838
  *
1383
- * Inline - the creation is done inline.
1839
+ * @returns The presentation variant applied to the table
1840
+ */
1841
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
1842
+ /**
1843
+ * Gets contexts from the table that have been selected by the user.
1384
1844
  *
1385
- * If not set with any value:
1386
1845
  *
1387
- * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1846
+ * @returns Contexts of the rows selected by the user
1388
1847
  */
1389
- name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1390
-
1848
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
1391
1849
  /**
1392
- * Defines the nodes to be added on the custom create.
1393
- * This object must have the following properties:
1394
- * propertyName: the name of the property on the page entity set used to categorize the node type to be
1395
- * created within the hierarchy
1850
+ * Get the selection variant from the Table.
1396
1851
  *
1397
- * values: an array of key and label that define a value of the property defined by the propertyName key
1398
- * and its label
1852
+ *
1853
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1399
1854
  */
1400
- nodeType?:
1401
- | object
1402
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1403
- | `{${string}}`;
1855
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
1856
+ /**
1857
+ * Hide the columns with the given column keys by setting their availability to Default.
1858
+ *
1859
+ * @since 1.124.0
1860
+ * @experimental (since 1.124.0)
1861
+ *
1862
+ * @returns Promise
1863
+ */
1864
+ hideColumns(
1865
+ /**
1866
+ * The keys for the columns to hide
1867
+ */
1868
+ columnKeys: string[]
1869
+ ): Promise<void>;
1870
+ /**
1871
+ * Requests a refresh of the table.
1872
+ */
1873
+ refresh(): void;
1874
+ /**
1875
+ * Removes an action from the table.
1876
+ *
1877
+ * @since 1.124.0
1878
+ * @experimental (since 1.124.0)
1879
+ *
1880
+ * @returns The removed action or null
1881
+ */
1882
+ removeAction(
1883
+ /**
1884
+ * The action to remove, or its index or ID
1885
+ */
1886
+ action: number | sap.fe.macros.table.Action | string
1887
+ ): null | sap.fe.macros.table.Action;
1888
+ /**
1889
+ * Removes a column from the table.
1890
+ *
1891
+ * @since 1.124.0
1892
+ * @experimental (since 1.124.0)
1893
+ *
1894
+ * @returns The removed column or null
1895
+ */
1896
+ removeColumn(
1897
+ /**
1898
+ * The column to remove, or its index or ID
1899
+ */
1900
+ column: number | sap.fe.macros.table.Column | string
1901
+ ): null | sap.fe.macros.table.Column;
1902
+ /**
1903
+ * Removes a message from the table.
1904
+ */
1905
+ removeMessage(
1906
+ /**
1907
+ * The id of the message
1908
+ */
1909
+ id: string
1910
+ ): void;
1911
+ /**
1912
+ * Set a variant management to the table.
1913
+ */
1914
+ setCurrentVariantKey(
1915
+ /**
1916
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
1917
+ * ignored.
1918
+ */
1919
+ key: string
1920
+ ): void;
1921
+ /**
1922
+ * Sets the fields that should be ignored when generating the table.
1923
+ *
1924
+ * @since 1.124.0
1925
+ * @experimental (since 1.124.0)
1926
+ *
1927
+ * @returns Reference to this in order to allow method chaining
1928
+ */
1929
+ setIgnoredFields(
1930
+ /**
1931
+ * The fields to ignore
1932
+ */
1933
+ ignoredFields: string
1934
+ ): this;
1935
+ /**
1936
+ * Sets the path to the metadata that should be used to generate the table.
1937
+ *
1938
+ * @since 1.124.0
1939
+ * @experimental (since 1.124.0)
1940
+ *
1941
+ * @returns Reference to this in order to allow method chaining
1942
+ */
1943
+ setMetaPath(
1944
+ /**
1945
+ * The path to the metadata
1946
+ */
1947
+ metaPath: string
1948
+ ): this;
1949
+ /**
1950
+ * Set a new presentation variant to the table.
1951
+ */
1952
+ setPresentationVariant(
1953
+ /**
1954
+ * The new presentation variant that is to be set on the table.
1955
+ */
1956
+ tablePV: sap.fe.navigation.PresentationVariant
1957
+ ): Promise<void>;
1958
+ /**
1959
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
1960
+ * filters and then apply the SelectionVariant values.
1961
+ *
1962
+ *
1963
+ * @returns A promise for asynchronous handling
1964
+ */
1965
+ setSelectionVariant(
1966
+ /**
1967
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
1968
+ */
1969
+ selectionVariant: sap.fe.navigation.SelectionVariant,
1970
+ /**
1971
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
1972
+ * to display the filter value descriptions, instead of loading them from the backend
1973
+ */
1974
+ prefillDescriptions?: boolean
1975
+ ): Promise<any>;
1976
+ /**
1977
+ * Show the columns with the given column keys by setting their availability to Default.
1978
+ *
1979
+ * @since 1.124.0
1980
+ * @experimental (since 1.124.0)
1981
+ *
1982
+ * @returns Promise
1983
+ */
1984
+ showColumns(
1985
+ /**
1986
+ * The keys for the columns to show
1987
+ */
1988
+ columnKeys: string[]
1989
+ ): Promise<void>;
1404
1990
  }
1405
-
1406
- /**
1407
- * Parameters of the Table#beforeRebindTable event.
1408
- */
1409
- interface Table$BeforeRebindTableEventParameters {}
1410
-
1411
- /**
1412
- * Parameters of the Table#rowPress event.
1413
- */
1414
- interface Table$RowPressEventParameters {}
1415
-
1416
- /**
1417
- * Parameters of the Table#selectionChange event.
1418
- */
1419
- interface Table$SelectionChangeEventParameters {}
1420
-
1421
- /**
1422
- * Definition of a custom action to be used inside the table toolbar
1423
- */
1424
- class Action extends sap.fe.macros.controls
1425
- .BuildingBlockObjectProperty {}
1426
- /**
1427
- * Definition of a custom ActionGroup to be used inside the table toolbar
1428
- */
1429
- class ActionGroup extends sap.fe.macros.controls
1430
- .BuildingBlockObjectProperty {}
1431
1991
  /**
1432
- * Definition of a custom column to be used inside the table.
1433
- * The template for the column has to be provided as the default aggregation
1992
+ * Create options for the table.
1434
1993
  */
1435
- class Column extends sap.fe.macros.controls
1994
+ class TableCreationOptions extends sap.fe.macros.controls
1436
1995
  .BuildingBlockObjectProperty {}
1437
1996
  /**
1438
1997
  * Building block used to create a table based on the metadata provided by OData V4.
@@ -1451,9 +2010,9 @@ declare namespace sap {
1451
2010
  *
1452
2011
  * ```javascript
1453
2012
  *
1454
- * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
2013
+ * sap.ui.require(["sap/fe/macros/table/TreeTable"], function(TreeTable) {
1455
2014
  * ...
1456
- * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
2015
+ * new TreeTable("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
1457
2016
  * })
1458
2017
  * ```
1459
2018
  *
@@ -1463,15 +2022,16 @@ declare namespace sap {
1463
2022
  * usage.
1464
2023
  *
1465
2024
  *
1466
- * @since 1.124.0
1467
- * @experimental (since 1.124.0)
2025
+ * @since 1.125.0
2026
+ * @experimental (since 1.125.0)
1468
2027
  */
1469
- class Table extends sap.fe.macros.controls.BuildingBlockWithTemplating {
2028
+ class TreeTable extends sap.fe.macros.controls
2029
+ .BuildingBlockWithTemplating {
1470
2030
  /**
1471
2031
  * Adds an action to the table.
1472
2032
  *
1473
- * @since 1.124.0
1474
- * @experimental (since 1.124.0)
2033
+ * @since 1.125.0
2034
+ * @experimental (since 1.125.0)
1475
2035
  *
1476
2036
  * @returns Reference to this in order to allow method chaining
1477
2037
  */
@@ -1536,8 +2096,8 @@ declare namespace sap {
1536
2096
  /**
1537
2097
  * Get the fields that should be ignored when generating the table.
1538
2098
  *
1539
- * @since 1.124.0
1540
- * @experimental (since 1.124.0)
2099
+ * @since 1.125.0
2100
+ * @experimental (since 1.125.0)
1541
2101
  *
1542
2102
  * @returns The value of the ignoredFields property
1543
2103
  */
@@ -1545,8 +2105,8 @@ declare namespace sap {
1545
2105
  /**
1546
2106
  * Gets the path to the metadata that should be used to generate the table.
1547
2107
  *
1548
- * @since 1.124.0
1549
- * @experimental (since 1.124.0)
2108
+ * @since 1.125.0
2109
+ * @experimental (since 1.125.0)
1550
2110
  *
1551
2111
  * @returns The path to the metadata
1552
2112
  */
@@ -1593,8 +2153,8 @@ declare namespace sap {
1593
2153
  /**
1594
2154
  * Removes an action from the table.
1595
2155
  *
1596
- * @since 1.124.0
1597
- * @experimental (since 1.124.0)
2156
+ * @since 1.125.0
2157
+ * @experimental (since 1.125.0)
1598
2158
  *
1599
2159
  * @returns The removed action or null
1600
2160
  */
@@ -1607,8 +2167,8 @@ declare namespace sap {
1607
2167
  /**
1608
2168
  * Removes a column from the table.
1609
2169
  *
1610
- * @since 1.124.0
1611
- * @experimental (since 1.124.0)
2170
+ * @since 1.125.0
2171
+ * @experimental (since 1.125.0)
1612
2172
  *
1613
2173
  * @returns The removed column or null
1614
2174
  */
@@ -1640,8 +2200,8 @@ declare namespace sap {
1640
2200
  /**
1641
2201
  * Sets the fields that should be ignored when generating the table.
1642
2202
  *
1643
- * @since 1.124.0
1644
- * @experimental (since 1.124.0)
2203
+ * @since 1.125.0
2204
+ * @experimental (since 1.125.0)
1645
2205
  *
1646
2206
  * @returns Reference to this in order to allow method chaining
1647
2207
  */
@@ -1654,8 +2214,8 @@ declare namespace sap {
1654
2214
  /**
1655
2215
  * Sets the path to the metadata that should be used to generate the table.
1656
2216
  *
1657
- * @since 1.124.0
1658
- * @experimental (since 1.124.0)
2217
+ * @since 1.125.0
2218
+ * @experimental (since 1.125.0)
1659
2219
  *
1660
2220
  * @returns Reference to this in order to allow method chaining
1661
2221
  */
@@ -1707,11 +2267,6 @@ declare namespace sap {
1707
2267
  columnKeys: string[]
1708
2268
  ): Promise<void>;
1709
2269
  }
1710
- /**
1711
- * Create options for the table.
1712
- */
1713
- class TableCreationOptions extends sap.fe.macros.controls
1714
- .BuildingBlockObjectProperty {}
1715
2270
  /**
1716
2271
  * Create options for the tree table.
1717
2272
  */
@@ -1741,6 +2296,30 @@ declare namespace sap {
1741
2296
  Table$SelectionChangeEventParameters,
1742
2297
  Table
1743
2298
  >;
2299
+
2300
+ /**
2301
+ * Event object of the TreeTable#beforeRebindTable event.
2302
+ */
2303
+ type TreeTable$BeforeRebindTableEvent = sap.ui.base.Event<
2304
+ TreeTable$BeforeRebindTableEventParameters,
2305
+ TreeTable
2306
+ >;
2307
+
2308
+ /**
2309
+ * Event object of the TreeTable#rowPress event.
2310
+ */
2311
+ type TreeTable$RowPressEvent = sap.ui.base.Event<
2312
+ TreeTable$RowPressEventParameters,
2313
+ TreeTable
2314
+ >;
2315
+
2316
+ /**
2317
+ * Event object of the TreeTable#selectionChange event.
2318
+ */
2319
+ type TreeTable$SelectionChangeEvent = sap.ui.base.Event<
2320
+ TreeTable$SelectionChangeEventParameters,
2321
+ TreeTable
2322
+ >;
1744
2323
  }
1745
2324
  /**
1746
2325
  * Describes the settings that can be provided to the MacroAPI constructor.
@@ -2145,6 +2724,11 @@ declare namespace sap {
2145
2724
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2146
2725
  | `{${string}}`;
2147
2726
 
2727
+ /**
2728
+ * Property added to be able to add data / items to the multi value field via a different model
2729
+ */
2730
+ items?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2731
+
2148
2732
  /**
2149
2733
  * Defines the relative Metadata path to the MultiValueField.
2150
2734
  * The metaPath should point to a Property or DataField.
@@ -3934,6 +4518,8 @@ declare namespace sap {
3934
4518
 
3935
4519
  "sap/fe/macros/table/TableCreationOptions": undefined;
3936
4520
 
4521
+ "sap/fe/macros/table/TreeTable": undefined;
4522
+
3937
4523
  "sap/fe/macros/table/TreeTable.block": undefined;
3938
4524
 
3939
4525
  "sap/fe/macros/table/TreeTableCreationOptions": undefined;