@sapui5/ts-types 1.129.1 → 1.130.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 (69) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  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.cux.home.d.ts +42 -41
  8. package/types/sap.esh.search.ui.d.ts +1 -1
  9. package/types/sap.f.d.ts +83 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.controls.d.ts +3 -0
  12. package/types/sap.fe.core.d.ts +45 -6
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +508 -233
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +5 -2
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +727 -204
  23. package/types/sap.insights.d.ts +1 -1
  24. package/types/sap.m.d.ts +1291 -3674
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +99 -16
  31. package/types/sap.suite.ui.commons.d.ts +232 -123
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +251 -70
  34. package/types/sap.tnt.d.ts +1 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +1 -25
  38. package/types/sap.ui.core.d.ts +116 -109
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +3 -1
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +22 -5
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.mdc.d.ts +269 -234
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +6 -11
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +1 -1
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +1 -1
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +1 -1
  63. package/types/sap.ushell_abap.d.ts +1 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.129.1
1
+ // For Library Version: 1.130.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -95,10 +95,10 @@ declare namespace sap {
95
95
  /**
96
96
  * Describes the settings that can be provided to the Chart constructor.
97
97
  *
98
+ * @deprecated (since now) - As of version 1.130, use {@link sap.fe.macros.Chart } instead
98
99
  * @experimental
99
100
  */
100
- interface $ChartSettings
101
- extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
101
+ interface $ChartSettings extends sap.ui.core.$ControlSettings {
102
102
  /**
103
103
  * Metadata path to the entitySet or navigationProperty
104
104
  */
@@ -222,9 +222,17 @@ declare namespace sap {
222
222
  * usage.
223
223
  *
224
224
  *
225
+ * @deprecated (since now) - As of version 1.130, use {@link sap.fe.macros.Chart } instead
225
226
  * @experimental
226
227
  */
227
- class Chart extends sap.fe.macros.controls.BuildingBlockWithTemplating {
228
+ class Chart extends sap.ui.core.Control {
229
+ /**
230
+ * Gets current value of property contextPath.
231
+ *
232
+ *
233
+ * @returns Value of property `contextPath`
234
+ */
235
+ getContextPath(): string;
228
236
  /**
229
237
  * Gets the key of the current variant in the associated variant management.
230
238
  *
@@ -232,6 +240,41 @@ declare namespace sap {
232
240
  * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
233
241
  */
234
242
  getCurrentVariantKey(): null | string;
243
+ /**
244
+ * Gets current value of property filterBar.
245
+ *
246
+ *
247
+ * @returns Value of property `filterBar`
248
+ */
249
+ getFilterBar(): string;
250
+ /**
251
+ * Gets current value of property header.
252
+ *
253
+ *
254
+ * @returns Value of property `header`
255
+ */
256
+ getHeader(): string;
257
+ /**
258
+ * Gets current value of property headerVisible.
259
+ *
260
+ *
261
+ * @returns Value of property `headerVisible`
262
+ */
263
+ getHeaderVisible(): boolean;
264
+ /**
265
+ * Gets current value of property metaPath.
266
+ *
267
+ *
268
+ * @returns Value of property `metaPath`
269
+ */
270
+ getMetaPath(): string;
271
+ /**
272
+ * Gets current value of property personalization.
273
+ *
274
+ *
275
+ * @returns Value of property `personalization`
276
+ */
277
+ getPersonalization(): string;
235
278
  /**
236
279
  * Get the presentation variant that is currently applied on the chart.
237
280
  *
@@ -246,6 +289,13 @@ declare namespace sap {
246
289
  * @returns Contexts of the rows selected by the user
247
290
  */
248
291
  getSelectedContexts(): sap.ui.model.odata.v4.Context[];
292
+ /**
293
+ * Gets current value of property selectionMode.
294
+ *
295
+ *
296
+ * @returns Value of property `selectionMode`
297
+ */
298
+ getSelectionMode(): string;
249
299
  /**
250
300
  * Get the selection variant from the chart.
251
301
  *
@@ -253,6 +303,20 @@ declare namespace sap {
253
303
  * @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
254
304
  */
255
305
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
306
+ /**
307
+ * Gets current value of property variantManagement.
308
+ *
309
+ *
310
+ * @returns Value of property `variantManagement`
311
+ */
312
+ getVariantManagement(): string;
313
+ /**
314
+ * Gets current value of property contextPath.
315
+ *
316
+ *
317
+ * @returns Value of property `contextPath`
318
+ */
319
+ setContextPath(): string;
256
320
  /**
257
321
  * Sets the variant of the provided key in the associated variant management.
258
322
  */
@@ -262,6 +326,41 @@ declare namespace sap {
262
326
  */
263
327
  key: string
264
328
  ): void;
329
+ /**
330
+ * Gets current value of property filterBar.
331
+ *
332
+ *
333
+ * @returns Value of property `filterBar`
334
+ */
335
+ setFilterBar(): string;
336
+ /**
337
+ * Gets current value of property header.
338
+ *
339
+ *
340
+ * @returns Value of property `header`
341
+ */
342
+ setHeader(): string;
343
+ /**
344
+ * Gets current value of property headerVisible.
345
+ *
346
+ *
347
+ * @returns Value of property `headerVisible`
348
+ */
349
+ setHeaderVisible(): boolean;
350
+ /**
351
+ * Gets current value of property metaPath.
352
+ *
353
+ *
354
+ * @returns Value of property `metaPath`
355
+ */
356
+ setMetaPath(): string;
357
+ /**
358
+ * Gets current value of property personalization.
359
+ *
360
+ *
361
+ * @returns Value of property `personalization`
362
+ */
363
+ setPersonalization(): string;
265
364
  /**
266
365
  * Set the presentation variant for the mdc chart.
267
366
  * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
@@ -276,6 +375,13 @@ declare namespace sap {
276
375
  */
277
376
  presentationVariant: sap.fe.navigation.PresentationVariant
278
377
  ): Promise<void>;
378
+ /**
379
+ * Gets current value of property selectionMode.
380
+ *
381
+ *
382
+ * @returns Value of property `selectionMode`
383
+ */
384
+ setSelectionMode(): string;
279
385
  /**
280
386
  * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
281
387
  * filters and then apply the SelectionVariant values.
@@ -294,6 +400,13 @@ declare namespace sap {
294
400
  */
295
401
  prefillDescriptions?: boolean
296
402
  ): Promise<any>;
403
+ /**
404
+ * Gets current value of property variantManagement.
405
+ *
406
+ *
407
+ * @returns Value of property `variantManagement`
408
+ */
409
+ setVariantManagement(): string;
297
410
  }
298
411
 
299
412
  /**
@@ -1017,8 +1130,9 @@ declare namespace sap {
1017
1130
  * The priority of the group in the custom toolbar.
1018
1131
  */
1019
1132
  customToolbarPriority?:
1020
- | string
1021
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1133
+ | int
1134
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1135
+ | `{${string}}`;
1022
1136
 
1023
1137
  /**
1024
1138
  * The name of the group.
@@ -1028,7 +1142,18 @@ declare namespace sap {
1028
1142
  /**
1029
1143
  * The priority of the group.
1030
1144
  */
1031
- priority?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1145
+ priority?:
1146
+ | int
1147
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1148
+ | `{${string}}`;
1149
+
1150
+ /**
1151
+ * Row number in which the button should be
1152
+ */
1153
+ row?:
1154
+ | int
1155
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1156
+ | `{${string}}`;
1032
1157
 
1033
1158
  /**
1034
1159
  * Whether the group is visible.
@@ -1491,6 +1616,16 @@ declare namespace sap {
1491
1616
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1492
1617
  | `{${string}}`;
1493
1618
 
1619
+ /**
1620
+ * Defines the list of properties that will be displayed in the creation dialog, when the creation mode
1621
+ * is set to 'CreationDialog'.
1622
+ *
1623
+ * The value is a comma-separated list of property names.
1624
+ */
1625
+ creationFields?:
1626
+ | string
1627
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1628
+
1494
1629
  /**
1495
1630
  * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
1496
1631
  * to responsive tables.
@@ -1504,7 +1639,7 @@ declare namespace sap {
1504
1639
 
1505
1640
  /**
1506
1641
  * Defines the creation mode to be used by the table.
1507
- * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
1642
+ * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows`, `External` or `CreationDialog`.
1508
1643
  *
1509
1644
  *
1510
1645
  *
@@ -1516,6 +1651,9 @@ declare namespace sap {
1516
1651
  * InlineCreationsRows - The creation is done inline with an empty row
1517
1652
  *
1518
1653
  * External - The creation is done in a different application specified via the parameter 'outbound'
1654
+ * CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
1655
+ * values (the properties are listed in `creationFields`).
1656
+ *
1519
1657
  * If not set with any value:
1520
1658
  *
1521
1659
  * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
@@ -1828,6 +1966,16 @@ declare namespace sap {
1828
1966
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1829
1967
  | `{${string}}`;
1830
1968
 
1969
+ /**
1970
+ * Defines the list of properties that will be displayed in the creation dialog, when the creation mode
1971
+ * is set to 'CreationDialog'.
1972
+ *
1973
+ * The value is a comma-separated list of property names.
1974
+ */
1975
+ creationFields?:
1976
+ | string
1977
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1978
+
1831
1979
  /**
1832
1980
  * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
1833
1981
  */
@@ -1837,7 +1985,7 @@ declare namespace sap {
1837
1985
 
1838
1986
  /**
1839
1987
  * Defines the creation mode to be used by the tree table.
1840
- * Allowed values are `NewPage` or `Inline`.
1988
+ * Allowed values are `NewPage`, `Inline` or `CreationDialog`.
1841
1989
  *
1842
1990
  *
1843
1991
  *
@@ -1846,6 +1994,9 @@ declare namespace sap {
1846
1994
  *
1847
1995
  * Inline - the creation is done inline.
1848
1996
  *
1997
+ * CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
1998
+ * values (the properties are listed in `creationFields`).
1999
+ *
1849
2000
  * If not set with any value:
1850
2001
  *
1851
2002
  * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
@@ -1858,8 +2009,8 @@ declare namespace sap {
1858
2009
  * propertyName: the name of the property on the page entity set used to categorize the node type to be
1859
2010
  * created within the hierarchy
1860
2011
  *
1861
- * values: an array of key and label that define a value of the property defined by the propertyName key
1862
- * and its label
2012
+ * values: an array of key, label and an optional creationFields that define a value of the property defined
2013
+ * by the propertyName key, its label, and the specific fields to be shown in the creation dialog.
1863
2014
  */
1864
2015
  nodeType?:
1865
2016
  | object
@@ -2519,6 +2670,93 @@ declare namespace sap {
2519
2670
  TreeTable
2520
2671
  >;
2521
2672
  }
2673
+ /**
2674
+ * Describes the settings that can be provided to the Chart constructor.
2675
+ */
2676
+ interface $ChartSettings extends sap.fe.macros.$MacroAPISettings {
2677
+ /**
2678
+ * Metadata path to the entitySet or navigationProperty
2679
+ */
2680
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2681
+
2682
+ /**
2683
+ * Id of the FilterBar building block associated with the chart.
2684
+ */
2685
+ filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2686
+
2687
+ /**
2688
+ * Specifies the header text that is shown in the chart
2689
+ */
2690
+ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2691
+
2692
+ /**
2693
+ * Controls if the header text should be shown or not
2694
+ */
2695
+ headerVisible?:
2696
+ | boolean
2697
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2698
+ | `{${string}}`;
2699
+
2700
+ /**
2701
+ * Metadata path to the presentation context (UI.Chart with or without a qualifier)
2702
+ */
2703
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2704
+
2705
+ /**
2706
+ * Controls which options should be enabled for the chart personalization dialog.
2707
+ * If it is set to `true`, all possible options for this kind of chart are enabled.
2708
+ *
2709
+ * If it is set to `false`, personalization is disabled.
2710
+ *
2711
+ *
2712
+ *
2713
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
2714
+ * with the options you want to be available.
2715
+ *
2716
+ * Available options are:
2717
+ *
2718
+ * - Sort
2719
+ *
2720
+ * - Type
2721
+ *
2722
+ * - Item
2723
+ *
2724
+ * - Filter
2725
+ */
2726
+ personalization?:
2727
+ | string
2728
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2729
+
2730
+ /**
2731
+ * Defines the selection mode to be used by the chart.
2732
+ * Allowed values are `None`, `Single` or `Multiple`
2733
+ */
2734
+ selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2735
+
2736
+ /**
2737
+ * Controls the kind of variant management that should be enabled for the chart.
2738
+ * Allowed value is `Control`.
2739
+ *
2740
+ * If set with value `Control`, a variant management control is seen within the chart and the chart is linked
2741
+ * to this.
2742
+ *
2743
+ * If not set with any value, variant management control is not available for this chart.
2744
+ */
2745
+ variantManagement?:
2746
+ | string
2747
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2748
+
2749
+ /**
2750
+ * Aggregate actions of the chart.
2751
+ */
2752
+ actions?:
2753
+ | Array<sap.fe.macros.chart.ActionGroup | sap.fe.macros.chart.Action>
2754
+ | sap.fe.macros.chart.ActionGroup
2755
+ | sap.fe.macros.chart.Action
2756
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
2757
+ | `{${string}}`;
2758
+ }
2759
+
2522
2760
  /**
2523
2761
  * Describes the settings that can be provided to the KPITag constructor.
2524
2762
  */
@@ -2685,146 +2923,59 @@ declare namespace sap {
2685
2923
  }
2686
2924
 
2687
2925
  /**
2688
- * Describes the settings that can be provided to the Chart constructor.
2926
+ * Describes the settings that can be provided to the FlexibleColumnLayoutActions constructor.
2689
2927
  */
2690
- interface $ChartSettings extends sap.fe.macros.$MacroAPISettings {
2691
- /**
2692
- * Metadata path to the entitySet or navigationProperty
2693
- */
2694
- contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2928
+ interface $FlexibleColumnLayoutActionsSettings
2929
+ extends sap.ui.core.$ControlSettings {}
2695
2930
 
2931
+ /**
2932
+ * Describes the settings that can be provided to the Field constructor.
2933
+ */
2934
+ interface $FieldSettings extends sap.fe.macros.$MacroAPISettings {
2696
2935
  /**
2697
- * Id of the FilterBar building block associated with the chart.
2936
+ * Defines the path of the context used in the current page or block.
2937
+ * This setting is defined by the framework.
2698
2938
  */
2699
- filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2939
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2700
2940
 
2701
2941
  /**
2702
- * Specifies the header text that is shown in the chart
2942
+ * This is used to optionally provide an external description that comes from a different model than the
2943
+ * oData model.
2944
+ * This should be used in conjunction with the value property.
2703
2945
  */
2704
- header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2946
+ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2705
2947
 
2706
2948
  /**
2707
- * Controls if the header text should be shown or not
2949
+ * A set of options that can be configured.
2708
2950
  */
2709
- headerVisible?:
2710
- | boolean
2951
+ formatOptions?:
2952
+ | sap.fe.macros.FieldFormatOptions
2711
2953
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2712
2954
  | `{${string}}`;
2713
2955
 
2714
2956
  /**
2715
- * Metadata path to the presentation context (UI.Chart with or without a qualifier)
2957
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
2716
2958
  */
2717
2959
  metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2718
2960
 
2719
2961
  /**
2720
- * Controls which options should be enabled for the chart personalization dialog.
2721
- * If it is set to `true`, all possible options for this kind of chart are enabled.
2722
- *
2723
- * If it is set to `false`, personalization is disabled.
2724
- *
2725
- *
2726
- *
2727
- * You can also provide a more granular control for the personalization by providing a comma-separated list
2728
- * with the options you want to be available.
2729
- *
2730
- * Available options are:
2731
- *
2732
- * - Sort
2733
- *
2734
- * - Type
2735
- *
2736
- * - Item
2737
- *
2738
- * - Filter
2962
+ * An expression that allows you to control the read-only state of the field.
2963
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
2964
+ * current state.
2739
2965
  */
2740
- personalization?:
2741
- | string
2742
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
2966
+ readOnly?:
2967
+ | boolean
2968
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2969
+ | `{${string}}`;
2743
2970
 
2744
2971
  /**
2745
- * Defines the selection mode to be used by the chart.
2746
- * Allowed values are `None`, `Single` or `Multiple`
2972
+ * Option to add semantic objects for a field.
2973
+ * This parameter overwrites the semantic objects defined through annotations.
2974
+ * Valid options are either a single semantic object, a stringified array of semantic objects,
2975
+ * a formatter or a single binding expression returning either a single semantic object or an array of semantic
2976
+ * objects.
2747
2977
  */
2748
- selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2749
-
2750
- /**
2751
- * Controls the kind of variant management that should be enabled for the chart.
2752
- * Allowed value is `Control`.
2753
- *
2754
- * If set with value `Control`, a variant management control is seen within the chart and the chart is linked
2755
- * to this.
2756
- *
2757
- * If not set with any value, variant management control is not available for this chart.
2758
- */
2759
- variantManagement?:
2760
- | string
2761
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
2762
-
2763
- /**
2764
- * Aggregate actions of the chart.
2765
- */
2766
- actions?:
2767
- | Array<sap.fe.macros.chart.ActionGroup | sap.fe.macros.chart.Action>
2768
- | sap.fe.macros.chart.ActionGroup
2769
- | sap.fe.macros.chart.Action
2770
- | sap.ui.base.ManagedObject.AggregationBindingInfo
2771
- | `{${string}}`;
2772
- }
2773
-
2774
- /**
2775
- * Describes the settings that can be provided to the FlexibleColumnLayoutActions constructor.
2776
- */
2777
- interface $FlexibleColumnLayoutActionsSettings
2778
- extends sap.ui.core.$ControlSettings {}
2779
-
2780
- /**
2781
- * Describes the settings that can be provided to the Field constructor.
2782
- */
2783
- interface $FieldSettings extends sap.fe.macros.$MacroAPISettings {
2784
- /**
2785
- * Defines the path of the context used in the current page or block.
2786
- * This setting is defined by the framework.
2787
- */
2788
- contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2789
-
2790
- /**
2791
- * This is used to optionally provide an external description that comes from a different model than the
2792
- * oData model.
2793
- * This should be used in conjunction with the value property.
2794
- */
2795
- description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2796
-
2797
- /**
2798
- * A set of options that can be configured.
2799
- */
2800
- formatOptions?:
2801
- | sap.fe.macros.FieldFormatOptions
2802
- | sap.ui.base.ManagedObject.PropertyBindingInfo
2803
- | `{${string}}`;
2804
-
2805
- /**
2806
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
2807
- */
2808
- metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2809
-
2810
- /**
2811
- * An expression that allows you to control the read-only state of the field.
2812
- * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
2813
- * current state.
2814
- */
2815
- readOnly?:
2816
- | boolean
2817
- | sap.ui.base.ManagedObject.PropertyBindingInfo
2818
- | `{${string}}`;
2819
-
2820
- /**
2821
- * Option to add semantic objects for a field.
2822
- * This parameter overwrites the semantic objects defined through annotations.
2823
- * Valid options are either a single semantic object, a stringified array of semantic objects,
2824
- * a formatter or a single binding expression returning either a single semantic object or an array of semantic
2825
- * objects.
2826
- */
2827
- semanticObject?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2978
+ semanticObject?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2828
2979
 
2829
2980
  /**
2830
2981
  * This is used to optionally provide an external value that comes from a different model than the oData
@@ -3605,14 +3756,14 @@ declare namespace sap {
3605
3756
  }
3606
3757
 
3607
3758
  /**
3608
- * Parameters of the KPITag#press event.
3759
+ * Parameters of the Chart#selectionChange event.
3609
3760
  */
3610
- interface KPITag$PressEventParameters {}
3761
+ interface Chart$SelectionChangeEventParameters {}
3611
3762
 
3612
3763
  /**
3613
- * Parameters of the Chart#selectionChange event.
3764
+ * Parameters of the KPITag#press event.
3614
3765
  */
3615
- interface Chart$SelectionChangeEventParameters {}
3766
+ interface KPITag$PressEventParameters {}
3616
3767
 
3617
3768
  /**
3618
3769
  * Parameters of the Field#change event.
@@ -3669,6 +3820,208 @@ declare namespace sap {
3669
3820
  */
3670
3821
  interface TreeTable$SelectionChangeEventParameters {}
3671
3822
 
3823
+ /**
3824
+ * Building block used to create a chart based on the metadata provided by OData V4.
3825
+ *
3826
+ *
3827
+ * Usually, a contextPath and metaPath is expected.
3828
+ *
3829
+ * Usage example:
3830
+ *
3831
+ * ```javascript
3832
+ *
3833
+ * <macros:Chart id="MyChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
3834
+ * ```
3835
+ */
3836
+ class Chart
3837
+ extends sap.fe.macros.MacroAPI
3838
+ implements
3839
+ /* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
3840
+ {
3841
+ __implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
3842
+
3843
+ /**
3844
+ * Gets current value of property contextPath.
3845
+ *
3846
+ *
3847
+ * @returns Value of property `contextPath`
3848
+ */
3849
+ getContextPath(): string;
3850
+ /**
3851
+ * Gets the key of the current variant in the associated variant management.
3852
+ *
3853
+ *
3854
+ * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
3855
+ */
3856
+ getCurrentVariantKey(): null | string;
3857
+ /**
3858
+ * Gets current value of property filterBar.
3859
+ *
3860
+ *
3861
+ * @returns Value of property `filterBar`
3862
+ */
3863
+ getFilterBar(): string;
3864
+ /**
3865
+ * Gets current value of property header.
3866
+ *
3867
+ *
3868
+ * @returns Value of property `header`
3869
+ */
3870
+ getHeader(): string;
3871
+ /**
3872
+ * Gets current value of property headerVisible.
3873
+ *
3874
+ *
3875
+ * @returns Value of property `headerVisible`
3876
+ */
3877
+ getHeaderVisible(): boolean;
3878
+ /**
3879
+ * Gets current value of property metaPath.
3880
+ *
3881
+ *
3882
+ * @returns Value of property `metaPath`
3883
+ */
3884
+ getMetaPath(): string;
3885
+ /**
3886
+ * Gets current value of property personalization.
3887
+ *
3888
+ *
3889
+ * @returns Value of property `personalization`
3890
+ */
3891
+ getPersonalization(): string;
3892
+ /**
3893
+ * Get the presentation variant that is currently applied on the chart.
3894
+ *
3895
+ *
3896
+ * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
3897
+ */
3898
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
3899
+ /**
3900
+ * Gets contexts from the chart that have been selected by the user.
3901
+ *
3902
+ *
3903
+ * @returns Contexts of the rows selected by the user
3904
+ */
3905
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
3906
+ /**
3907
+ * Gets current value of property selectionMode.
3908
+ *
3909
+ *
3910
+ * @returns Value of property `selectionMode`
3911
+ */
3912
+ getSelectionMode(): string;
3913
+ /**
3914
+ * Get the selection variant from the chart.
3915
+ *
3916
+ *
3917
+ * @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
3918
+ */
3919
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
3920
+ /**
3921
+ * Gets current value of property variantManagement.
3922
+ *
3923
+ *
3924
+ * @returns Value of property `variantManagement`
3925
+ */
3926
+ getVariantManagement(): string;
3927
+ /**
3928
+ * Gets current value of property contextPath.
3929
+ *
3930
+ *
3931
+ * @returns Value of property `contextPath`
3932
+ */
3933
+ setContextPath(): string;
3934
+ /**
3935
+ * Sets the variant of the provided key in the associated variant management.
3936
+ */
3937
+ setCurrentVariantKey(
3938
+ /**
3939
+ * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
3940
+ */
3941
+ key: string
3942
+ ): void;
3943
+ /**
3944
+ * Gets current value of property filterBar.
3945
+ *
3946
+ *
3947
+ * @returns Value of property `filterBar`
3948
+ */
3949
+ setFilterBar(): string;
3950
+ /**
3951
+ * Gets current value of property header.
3952
+ *
3953
+ *
3954
+ * @returns Value of property `header`
3955
+ */
3956
+ setHeader(): string;
3957
+ /**
3958
+ * Gets current value of property headerVisible.
3959
+ *
3960
+ *
3961
+ * @returns Value of property `headerVisible`
3962
+ */
3963
+ setHeaderVisible(): boolean;
3964
+ /**
3965
+ * Gets current value of property metaPath.
3966
+ *
3967
+ *
3968
+ * @returns Value of property `metaPath`
3969
+ */
3970
+ setMetaPath(): string;
3971
+ /**
3972
+ * Gets current value of property personalization.
3973
+ *
3974
+ *
3975
+ * @returns Value of property `personalization`
3976
+ */
3977
+ setPersonalization(): string;
3978
+ /**
3979
+ * Set the presentation variant for the mdc chart.
3980
+ * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
3981
+ * be followed while trying to set the PresentationVariant as needed.
3982
+ * The values dimensions, measures and other properties should also be given in the valid format and null
3983
+ * or empty values should be avoided.
3984
+ * One dimension attribute should have only one role associated with it on a given chart.
3985
+ */
3986
+ setPresentationVariant(
3987
+ /**
3988
+ * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
3989
+ */
3990
+ presentationVariant: sap.fe.navigation.PresentationVariant
3991
+ ): Promise<void>;
3992
+ /**
3993
+ * Gets current value of property selectionMode.
3994
+ *
3995
+ *
3996
+ * @returns Value of property `selectionMode`
3997
+ */
3998
+ setSelectionMode(): string;
3999
+ /**
4000
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
4001
+ * filters and then apply the SelectionVariant values.
4002
+ *
4003
+ *
4004
+ * @returns A promise for asynchronous handling
4005
+ */
4006
+ setSelectionVariant(
4007
+ /**
4008
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
4009
+ */
4010
+ selectionVariant: sap.fe.navigation.SelectionVariant,
4011
+ /**
4012
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
4013
+ * to display the filter value descriptions, instead of loading them from the backend
4014
+ */
4015
+ prefillDescriptions?: boolean
4016
+ ): Promise<any>;
4017
+ /**
4018
+ * Gets current value of property variantManagement.
4019
+ *
4020
+ *
4021
+ * @returns Value of property `variantManagement`
4022
+ */
4023
+ setVariantManagement(): string;
4024
+ }
3672
4025
  /**
3673
4026
  * API to add parameters to the collection binding infos.
3674
4027
  */
@@ -3769,96 +4122,6 @@ declare namespace sap {
3769
4122
  */
3770
4123
  class RichTextEditor extends sap.fe.core.buildingBlocks
3771
4124
  .BuildingBlockBase {}
3772
- /**
3773
- * Building block used to create a chart based on the metadata provided by OData V4.
3774
- *
3775
- *
3776
- * Usually, a contextPath and metaPath is expected.
3777
- *
3778
- * Usage example:
3779
- *
3780
- * ```javascript
3781
- *
3782
- * <macros:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
3783
- * ```
3784
- */
3785
- class Chart
3786
- extends sap.fe.macros.MacroAPI
3787
- implements
3788
- /* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
3789
- {
3790
- __implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
3791
-
3792
- /**
3793
- * Gets the key of the current variant in the associated variant management.
3794
- *
3795
- *
3796
- * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
3797
- */
3798
- getCurrentVariantKey(): null | string;
3799
- /**
3800
- * Get the presentation variant that is currently applied on the chart.
3801
- *
3802
- *
3803
- * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
3804
- */
3805
- getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
3806
- /**
3807
- * Gets contexts from the chart that have been selected by the user.
3808
- *
3809
- *
3810
- * @returns Contexts of the rows selected by the user
3811
- */
3812
- getSelectedContexts(): sap.ui.model.odata.v4.Context[];
3813
- /**
3814
- * Get the selection variant from the chart.
3815
- *
3816
- *
3817
- * @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
3818
- */
3819
- getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
3820
- /**
3821
- * Sets the variant of the provided key in the associated variant management.
3822
- */
3823
- setCurrentVariantKey(
3824
- /**
3825
- * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
3826
- */
3827
- key: string
3828
- ): void;
3829
- /**
3830
- * Set the presentation variant for the mdc chart.
3831
- * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
3832
- * be followed while trying to set the PresentationVariant as needed.
3833
- * The values dimensions, measures and other properties should also be given in the valid format and null
3834
- * or empty values should be avoided.
3835
- * One dimension attribute should have only one role associated with it on a given chart.
3836
- */
3837
- setPresentationVariant(
3838
- /**
3839
- * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
3840
- */
3841
- presentationVariant: sap.fe.navigation.PresentationVariant
3842
- ): Promise<void>;
3843
- /**
3844
- * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
3845
- * filters and then apply the SelectionVariant values.
3846
- *
3847
- *
3848
- * @returns A promise for asynchronous handling
3849
- */
3850
- setSelectionVariant(
3851
- /**
3852
- * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
3853
- */
3854
- selectionVariant: sap.fe.navigation.SelectionVariant,
3855
- /**
3856
- * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
3857
- * to display the filter value descriptions, instead of loading them from the backend
3858
- */
3859
- prefillDescriptions?: boolean
3860
- ): Promise<any>;
3861
- }
3862
4125
  /**
3863
4126
  * Building block for adding overflow toolbar buttons to integrate into the flexible column layout support
3864
4127
  * from Fiori elements.
@@ -4552,6 +4815,18 @@ declare namespace sap {
4552
4815
  * Additional format options for the field.
4553
4816
  */
4554
4817
  type FieldFormatOptions = {
4818
+ /**
4819
+ * Property for defining a custom pattern for the date, time, or dateTime format.
4820
+ *
4821
+ * If there is a dateTimePattern defined dateTimeStyle is ignored.
4822
+ */
4823
+ dateTimePattern: string;
4824
+ /**
4825
+ * Property for defining the display style for the date, time, or dateTime format.
4826
+ *
4827
+ * If there is a dateTimePattern defined dateTimeStyle is ignored.
4828
+ */
4829
+ dateTimeStyle: /* was: sap.fe.core.templating.UIFormatters.DateTimeStyle */ any;
4555
4830
  /**
4556
4831
  * Defines how the field value and associated text will be displayed together.
4557
4832
  *
@@ -4622,14 +4897,6 @@ declare namespace sap {
4622
4897
  textMaxLines: number;
4623
4898
  };
4624
4899
 
4625
- /**
4626
- * Event object of the KPITag#press event.
4627
- */
4628
- type KPITag$PressEvent = sap.ui.base.Event<
4629
- KPITag$PressEventParameters,
4630
- KPITag
4631
- >;
4632
-
4633
4900
  /**
4634
4901
  * Event object of the Chart#selectionChange event.
4635
4902
  */
@@ -4638,6 +4905,14 @@ declare namespace sap {
4638
4905
  Chart
4639
4906
  >;
4640
4907
 
4908
+ /**
4909
+ * Event object of the KPITag#press event.
4910
+ */
4911
+ type KPITag$PressEvent = sap.ui.base.Event<
4912
+ KPITag$PressEventParameters,
4913
+ KPITag
4914
+ >;
4915
+
4641
4916
  /**
4642
4917
  * Event object of the Field#change event.
4643
4918
  */
@@ -4729,14 +5004,14 @@ declare namespace sap {
4729
5004
  }
4730
5005
 
4731
5006
  interface IUI5DefineDependencyNames {
5007
+ "sap/fe/macros/Chart": undefined;
5008
+
4732
5009
  "sap/fe/macros/chart/Action": undefined;
4733
5010
 
4734
5011
  "sap/fe/macros/chart/ActionGroup": undefined;
4735
5012
 
4736
5013
  "sap/fe/macros/chart/Chart": undefined;
4737
5014
 
4738
- "sap/fe/macros/chart/ChartAPI": undefined;
4739
-
4740
5015
  "sap/fe/macros/CollectionBindingInfo": undefined;
4741
5016
 
4742
5017
  "sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;