@sapui5/types 1.123.2 → 1.124.1

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 (64) 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 +5 -3
  6. package/types/sap.esh.search.ui.d.ts +126 -1
  7. package/types/sap.f.d.ts +49 -12
  8. package/types/sap.fe.core.d.ts +14 -6
  9. package/types/sap.fe.macros.d.ts +2319 -461
  10. package/types/sap.fe.navigation.d.ts +1 -1
  11. package/types/sap.fe.placeholder.d.ts +1 -1
  12. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +31 -4
  14. package/types/sap.fe.test.d.ts +1 -1
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +3 -2
  18. package/types/sap.insights.d.ts +1 -1
  19. package/types/sap.m.d.ts +4149 -474
  20. package/types/sap.makit.d.ts +1 -1
  21. package/types/sap.me.d.ts +1 -1
  22. package/types/sap.ndc.d.ts +1 -1
  23. package/types/sap.ovp.d.ts +1 -1
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +225 -313
  26. package/types/sap.suite.ui.commons.d.ts +11 -5
  27. package/types/sap.suite.ui.generic.template.d.ts +31 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +3 -2
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +17 -9
  32. package/types/sap.ui.comp.d.ts +171 -31
  33. package/types/sap.ui.core.d.ts +130 -231
  34. package/types/sap.ui.dt.d.ts +6 -2
  35. package/types/sap.ui.export.d.ts +1 -1
  36. package/types/sap.ui.fl.d.ts +3 -2
  37. package/types/sap.ui.generic.app.d.ts +1 -1
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +1 -1
  40. package/types/sap.ui.layout.d.ts +7 -4
  41. package/types/sap.ui.mdc.d.ts +485 -758
  42. package/types/sap.ui.richtexteditor.d.ts +1 -1
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +1 -1
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +4 -3
  49. package/types/sap.ui.ux3.d.ts +3 -2
  50. package/types/sap.ui.vbm.d.ts +3 -2
  51. package/types/sap.ui.vk.d.ts +77 -26
  52. package/types/sap.ui.vtm.d.ts +23 -12
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +191 -12
  55. package/types/sap.ui.webc.main.d.ts +557 -33
  56. package/types/sap.uiext.inbox.d.ts +62 -1
  57. package/types/sap.ushell.d.ts +649 -198
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +11 -6
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.123.1
1
+ // For Library Version: 1.124.1
2
2
 
3
3
  declare module "sap/fe/macros/CollectionBindingInfo" {
4
4
  import Filter from "sap/ui/model/Filter";
@@ -77,7 +77,8 @@ declare module "sap/fe/macros/MacroAPI" {
77
77
  */
78
78
  export default class MacroAPI
79
79
  extends BuildingBlockBase
80
- implements IFormContent {
80
+ implements IFormContent
81
+ {
81
82
  __implements__sap_ui_core_IFormContent: boolean;
82
83
  }
83
84
  /**
@@ -269,6 +270,219 @@ declare module "sap/fe/macros/chart/ActionGroup" {
269
270
  }
270
271
  }
271
272
 
273
+ declare module "sap/fe/macros/chart/Chart" {
274
+ import {
275
+ default as BuildingBlockWithTemplating,
276
+ $BuildingBlockWithTemplatingSettings,
277
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
278
+
279
+ import PresentationVariant from "sap/fe/navigation/PresentationVariant";
280
+
281
+ import Context from "sap/ui/model/odata/v4/Context";
282
+
283
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
284
+
285
+ import {
286
+ PropertyBindingInfo,
287
+ AggregationBindingInfo,
288
+ } from "sap/ui/base/ManagedObject";
289
+
290
+ import ActionGroup from "sap/fe/macros/chart/ActionGroup";
291
+
292
+ import Action from "sap/fe/macros/chart/Action";
293
+
294
+ import Event from "sap/ui/base/Event";
295
+
296
+ /**
297
+ * Building block used to create a chart based on the metadata provided by OData V4.
298
+ *
299
+ *
300
+ * Usually, a contextPath and metaPath is expected.
301
+ * Usage example:
302
+ *
303
+ * ```javascript
304
+ *
305
+ * sap.ui.require(["sap/fe/macros/chart/Chart"], function(Chart) {
306
+ * ...
307
+ * new Chart("myChart", {metaPath:"MyChart"})
308
+ * })
309
+ * ```
310
+ *
311
+ * This is currently an experimental API because the structure of the generated content will change to come
312
+ * closer to the Chart that you get out of templates.
313
+ * The public method and property will not change but the internal structure will so be careful on your
314
+ * usage.
315
+ *
316
+ *
317
+ * @experimental
318
+ */
319
+ export default class Chart extends BuildingBlockWithTemplating {
320
+ /**
321
+ * Gets the key of the current variant in the associated variant management.
322
+ *
323
+ *
324
+ * @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
325
+ */
326
+ getCurrentVariantKey(): null | string;
327
+ /**
328
+ * Get the presentation variant that is currently applied on the chart.
329
+ *
330
+ *
331
+ * @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
332
+ */
333
+ getPresentationVariant(): Promise<PresentationVariant>;
334
+ /**
335
+ * Gets contexts from the chart that have been selected by the user.
336
+ *
337
+ *
338
+ * @returns Contexts of the rows selected by the user
339
+ */
340
+ getSelectedContexts(): Context[];
341
+ /**
342
+ * Get the selection variant from the chart.
343
+ *
344
+ *
345
+ * @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
346
+ */
347
+ getSelectionVariant(): Promise<SelectionVariant>;
348
+ /**
349
+ * Sets the variant of the provided key in the associated variant management.
350
+ */
351
+ setCurrentVariantKey(
352
+ /**
353
+ * The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
354
+ */
355
+ key: string
356
+ ): void;
357
+ /**
358
+ * Set the presentation variant for the mdc chart.
359
+ * The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
360
+ * be followed while trying to set the PresentationVariant as needed.
361
+ * The values dimensions, measures and other properties should also be given in the valid format and null
362
+ * or empty values should be avoided.
363
+ * One dimension attribute should have only one role associated with it on a given chart.
364
+ */
365
+ setPresentationVariant(
366
+ /**
367
+ * the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
368
+ */
369
+ presentationVariant: PresentationVariant
370
+ ): Promise<void>;
371
+ /**
372
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
373
+ * filters and then apply the SelectionVariant values.
374
+ *
375
+ *
376
+ * @returns A promise for asynchronous handling
377
+ */
378
+ setSelectionVariant(
379
+ /**
380
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
381
+ */
382
+ selectionVariant: SelectionVariant,
383
+ /**
384
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
385
+ * to display the filter value descriptions, instead of loading them from the backend
386
+ */
387
+ prefillDescriptions?: boolean
388
+ ): Promise<any>;
389
+ }
390
+ /**
391
+ * Describes the settings that can be provided to the Chart constructor.
392
+ *
393
+ * @experimental
394
+ */
395
+ export interface $ChartSettings extends $BuildingBlockWithTemplatingSettings {
396
+ /**
397
+ * Metadata path to the entitySet or navigationProperty
398
+ */
399
+ contextPath?: string | PropertyBindingInfo;
400
+
401
+ /**
402
+ * Id of the FilterBar building block associated with the chart.
403
+ */
404
+ filterBar?: string | PropertyBindingInfo;
405
+
406
+ /**
407
+ * Specifies the header text that is shown in the chart
408
+ */
409
+ header?: string | PropertyBindingInfo;
410
+
411
+ /**
412
+ * Controls if the header text should be shown or not
413
+ */
414
+ headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
415
+
416
+ /**
417
+ * Metadata path to the presentation context (UI.Chart with or without a qualifier)
418
+ */
419
+ metaPath?: string | PropertyBindingInfo;
420
+
421
+ /**
422
+ * Controls which options should be enabled for the chart personalization dialog.
423
+ * If it is set to `true`, all possible options for this kind of chart are enabled.
424
+ *
425
+ * If it is set to `false`, personalization is disabled.
426
+ *
427
+ *
428
+ *
429
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
430
+ * with the options you want to be available.
431
+ *
432
+ * Available options are:
433
+ *
434
+ * - Sort
435
+ *
436
+ * - Type
437
+ *
438
+ * - Item
439
+ *
440
+ * - Filter
441
+ */
442
+ personalization?: string | PropertyBindingInfo;
443
+
444
+ /**
445
+ * Defines the selection mode to be used by the chart.
446
+ * Allowed values are `None`, `Single` or `Multiple`
447
+ */
448
+ selectionMode?: string | PropertyBindingInfo;
449
+
450
+ /**
451
+ * Controls the kind of variant management that should be enabled for the chart.
452
+ * Allowed value is `Control`.
453
+ *
454
+ * If set with value `Control`, a variant management control is seen within the chart and the chart is linked
455
+ * to this.
456
+ *
457
+ * If not set with any value, variant management control is not available for this chart.
458
+ */
459
+ variantManagement?: string | PropertyBindingInfo;
460
+
461
+ /**
462
+ * Aggregate actions of the chart.
463
+ */
464
+ actions?:
465
+ | Array<ActionGroup | Action>
466
+ | ActionGroup
467
+ | Action
468
+ | AggregationBindingInfo
469
+ | `{${string}}`;
470
+ }
471
+
472
+ /**
473
+ * Parameters of the Chart#selectionChange event.
474
+ */
475
+ export interface Chart$SelectionChangeEventParameters {}
476
+
477
+ /**
478
+ * Event object of the Chart#selectionChange event.
479
+ */
480
+ export type Chart$SelectionChangeEvent = Event<
481
+ Chart$SelectionChangeEventParameters,
482
+ Chart
483
+ >;
484
+ }
485
+
272
486
  declare module "sap/fe/macros/chart/ChartAPI" {
273
487
  import {
274
488
  default as MacroAPI,
@@ -302,10 +516,16 @@ declare module "sap/fe/macros/chart/ChartAPI" {
302
516
  *
303
517
  * ```javascript
304
518
  *
305
- * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
519
+ * <macros:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
306
520
  * ```
307
521
  */
308
- export default class Chart extends MacroAPI {
522
+ export default class Chart
523
+ extends MacroAPI
524
+ implements
525
+ /* was: sap.fe.macros.controls.section.ISingleSectionContributor */ Object
526
+ {
527
+ __implements__sap_fe_macros_controls_section_ISingleSectionContributor: boolean;
528
+
309
529
  /**
310
530
  * Gets the key of the current variant in the associated variant management.
311
531
  *
@@ -426,7 +646,7 @@ declare module "sap/fe/macros/chart/ChartAPI" {
426
646
  *
427
647
  * - Filter
428
648
  */
429
- personalization?: boolean | string | PropertyBindingInfo | `{${string}}`;
649
+ personalization?: string | PropertyBindingInfo;
430
650
 
431
651
  /**
432
652
  * Defines the selection mode to be used by the chart.
@@ -484,6 +704,29 @@ declare module "sap/fe/macros/controls/BuildingBlockObjectProperty" {
484
704
  extends $ElementSettings {}
485
705
  }
486
706
 
707
+ declare module "sap/fe/macros/controls/BuildingBlockWithTemplating" {
708
+ import {
709
+ default as BuildingBlockBase,
710
+ $BuildingBlockBaseSettings,
711
+ } from "sap/fe/core/buildingBlocks/BuildingBlockBase";
712
+
713
+ /**
714
+ * Using this class you can define a building block that will manage and render a templating based building
715
+ * block.
716
+ * On change of the main properties you will be able to recreate the content.
717
+ *
718
+ * @experimental
719
+ */
720
+ export default class BuildingBlockWithTemplating extends BuildingBlockBase {}
721
+ /**
722
+ * Describes the settings that can be provided to the BuildingBlockWithTemplating constructor.
723
+ *
724
+ * @experimental
725
+ */
726
+ export interface $BuildingBlockWithTemplatingSettings
727
+ extends $BuildingBlockBaseSettings {}
728
+ }
729
+
487
730
  declare module "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block" {
488
731
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
489
732
 
@@ -494,7 +737,7 @@ declare module "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block" {
494
737
  *
495
738
  * ```javascript
496
739
  *
497
- * <macro:FlexibleColumnLayoutActions />
740
+ * <macros:FlexibleColumnLayoutActions />
498
741
  * ```
499
742
  *
500
743
  *
@@ -509,18 +752,20 @@ declare module "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block" {
509
752
  extends $ControlSettings {}
510
753
  }
511
754
 
512
- declare module "sap/fe/macros/field/FieldAPI" {
755
+ declare module "sap/fe/macros/field/Field" {
513
756
  import {
514
- default as MacroAPI,
515
- $MacroAPISettings,
516
- } from "sap/fe/macros/MacroAPI";
757
+ default as BuildingBlockWithTemplating,
758
+ $BuildingBlockWithTemplatingSettings,
759
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
517
760
 
518
- import { MessageType } from "sap/ui/core/library";
761
+ import { IFormContent, MessageType } from "sap/ui/core/library";
519
762
 
520
763
  import Control from "sap/ui/core/Control";
521
764
 
522
765
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
523
766
 
767
+ import { FieldFormatOptions } from "sap/fe/macros/field/FieldAPI";
768
+
524
769
  import Event from "sap/ui/base/Event";
525
770
 
526
771
  /**
@@ -530,15 +775,30 @@ declare module "sap/fe/macros/field/FieldAPI" {
530
775
  * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
531
776
  * property from the entity type.
532
777
  * When creating a Field building block, you must provide an ID to ensure everything works correctly.
533
- *
534
778
  * Usage example:
535
779
  *
536
780
  * ```javascript
537
781
  *
538
- * <macro:Field id="MyField" metaPath="MyProperty" />
782
+ * sap.ui.require(["sap/fe/macros/field/Field"], function(Field) {
783
+ * ...
784
+ * new Field("MyField", {metaPath:"MyProperty"})
785
+ * })
539
786
  * ```
787
+ *
788
+ * This is currently an experimental API because the structure of the generated content will change to come
789
+ * closer to the Field that you get out of templates.
790
+ * The public method and property will not change but the internal structure will so be careful on your
791
+ * usage.
792
+ *
793
+ *
794
+ * @experimental
540
795
  */
541
- export default class Field extends MacroAPI {
796
+ export default class Field
797
+ extends BuildingBlockWithTemplating
798
+ implements IFormContent
799
+ {
800
+ __implements__sap_ui_core_IFormContent: boolean;
801
+
542
802
  /**
543
803
  * Adds a message to the field.
544
804
  *
@@ -607,31 +867,197 @@ declare module "sap/fe/macros/field/FieldAPI" {
607
867
  setValue(): Control;
608
868
  }
609
869
  /**
610
- * Additional format options for the field.
870
+ * Describes the settings that can be provided to the Field constructor.
871
+ *
872
+ * @experimental
611
873
  */
612
- export type FieldFormatOptions = {
874
+ export interface $FieldSettings extends $BuildingBlockWithTemplatingSettings {
613
875
  /**
614
- * Defines how the field value and associated text will be displayed together.
615
- *
616
- * Allowed values are "Value", "Description", "DescriptionValue" and "ValueDescription"
876
+ * Defines the path of the context used in the current page or block.
877
+ * This setting is defined by the framework.
617
878
  */
618
- displayMode: string;
879
+ contextPath?: string | PropertyBindingInfo;
880
+
619
881
  /**
620
- * Determines how the field should be rendered, e.g. as radio buttons.
621
- *
622
- * If not all prerequisites are met, the field will default back to the standard rendering.
882
+ * A set of options that can be configured.
623
883
  */
624
- fieldEditStyle: /* was: sap.fe.macros.field.FieldAPI.FieldEditStyle */ any;
884
+ formatOptions?: FieldFormatOptions | PropertyBindingInfo | `{${string}}`;
885
+
625
886
  /**
626
- * Defines if and how the field measure will be displayed.
627
- *
628
- * Allowed values are "Hidden" and "ReadOnly"
887
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
629
888
  */
630
- measureDisplayMode: string;
889
+ metaPath?: string | PropertyBindingInfo;
890
+
631
891
  /**
632
- * Specifies if radio buttons should be rendered in a horizontal layout.
892
+ * An expression that allows you to control the read-only state of the field.
893
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
894
+ * current state.
633
895
  */
634
- radioButtonsHorizontalLayout: boolean;
896
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
897
+
898
+ /**
899
+ * Option to add semantic objects for a field.
900
+ * This parameter overwrites the semantic objects defined through annotations.
901
+ * Valid options are either a single semantic object, a stringified array of semantic objects,
902
+ * a formatter or a single binding expression returning either a single semantic object or an array of semantic
903
+ * objects.
904
+ */
905
+ semanticObject?: string | PropertyBindingInfo;
906
+
907
+ /**
908
+ * This is used to optionally provide an external value that comes from a different model than the oData
909
+ * model
910
+ */
911
+ value?: string | PropertyBindingInfo;
912
+ }
913
+
914
+ /**
915
+ * Parameters of the Field#change event.
916
+ */
917
+ export interface Field$ChangeEventParameters {}
918
+
919
+ /**
920
+ * Event object of the Field#change event.
921
+ */
922
+ export type Field$ChangeEvent = Event<Field$ChangeEventParameters, Field>;
923
+
924
+ /**
925
+ * Parameters of the Field#liveChange event.
926
+ */
927
+ export interface Field$LiveChangeEventParameters {}
928
+
929
+ /**
930
+ * Event object of the Field#liveChange event.
931
+ */
932
+ export type Field$LiveChangeEvent = Event<
933
+ Field$LiveChangeEventParameters,
934
+ Field
935
+ >;
936
+ }
937
+
938
+ declare module "sap/fe/macros/field/FieldAPI" {
939
+ import {
940
+ default as MacroAPI,
941
+ $MacroAPISettings,
942
+ } from "sap/fe/macros/MacroAPI";
943
+
944
+ import { MessageType } from "sap/ui/core/library";
945
+
946
+ import Control from "sap/ui/core/Control";
947
+
948
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
949
+
950
+ import Event from "sap/ui/base/Event";
951
+
952
+ /**
953
+ * Building block for creating a field based on the metadata provided by OData V4.
954
+ *
955
+ *
956
+ * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
957
+ * property from the entity type.
958
+ * When creating a Field building block, you must provide an ID to ensure everything works correctly.
959
+ *
960
+ * Usage example:
961
+ *
962
+ * ```javascript
963
+ *
964
+ * <macros:Field id="MyField" metaPath="MyProperty" />
965
+ * ```
966
+ */
967
+ export default class Field extends MacroAPI {
968
+ /**
969
+ * Adds a message to the field.
970
+ *
971
+ *
972
+ * @returns The id of the message
973
+ */
974
+ addMessage(
975
+ /**
976
+ * The parameters to create message
977
+ */
978
+ parameters: {
979
+ /**
980
+ * Message description
981
+ */
982
+ description?: string;
983
+ /**
984
+ * Message text
985
+ */
986
+ message?: string;
987
+ /**
988
+ * True if the message is persistent
989
+ */
990
+ persistent?: boolean;
991
+ /**
992
+ * Type of the message
993
+ */
994
+ type?: MessageType;
995
+ }
996
+ ): string;
997
+ /**
998
+ * Gets the current enablement state of the field.
999
+ *
1000
+ *
1001
+ * @returns Boolean value with the enablement state
1002
+ */
1003
+ getEnabled(): boolean;
1004
+ /**
1005
+ * Retrieves the current value of the field.
1006
+ *
1007
+ *
1008
+ * @returns The current value of the field
1009
+ */
1010
+ getValue(): boolean | string;
1011
+ /**
1012
+ * Removes a message from the field.
1013
+ */
1014
+ removeMessage(
1015
+ /**
1016
+ * The id of the message
1017
+ */
1018
+ id: string
1019
+ ): void;
1020
+ /**
1021
+ * Sets the current enablement state of the field.
1022
+ *
1023
+ *
1024
+ * @returns The current field reference
1025
+ */
1026
+ setEnabled(): Control;
1027
+ /**
1028
+ * Sets the current value of the field.
1029
+ *
1030
+ *
1031
+ * @returns The current field reference
1032
+ */
1033
+ setValue(): Control;
1034
+ }
1035
+ /**
1036
+ * Additional format options for the field.
1037
+ */
1038
+ export type FieldFormatOptions = {
1039
+ /**
1040
+ * Defines how the field value and associated text will be displayed together.
1041
+ *
1042
+ * Allowed values are "Value", "Description", "DescriptionValue" and "ValueDescription"
1043
+ */
1044
+ displayMode: string;
1045
+ /**
1046
+ * Determines how the field should be rendered, e.g. as radio buttons.
1047
+ *
1048
+ * If not all prerequisites are met, the field will default back to the standard rendering.
1049
+ */
1050
+ fieldEditStyle: /* was: sap.fe.macros.field.FieldAPI.FieldEditStyle */ any;
1051
+ /**
1052
+ * Defines if and how the field measure will be displayed.
1053
+ *
1054
+ * Allowed values are "Hidden" and "ReadOnly"
1055
+ */
1056
+ measureDisplayMode: string;
1057
+ /**
1058
+ * Specifies if radio buttons should be rendered in a horizontal layout.
1059
+ */
1060
+ radioButtonsHorizontalLayout: boolean;
635
1061
  /**
636
1062
  * Defines if the date part of a date time with timezone field should be shown.
637
1063
  *
@@ -715,6 +1141,12 @@ declare module "sap/fe/macros/field/FieldAPI" {
715
1141
  * objects.
716
1142
  */
717
1143
  semanticObject?: string | PropertyBindingInfo;
1144
+
1145
+ /**
1146
+ * This is used to optionally provide an external value that comes from a different model than the oData
1147
+ * model
1148
+ */
1149
+ value?: string | PropertyBindingInfo;
718
1150
  }
719
1151
 
720
1152
  /**
@@ -741,11 +1173,11 @@ declare module "sap/fe/macros/field/FieldAPI" {
741
1173
  >;
742
1174
  }
743
1175
 
744
- declare module "sap/fe/macros/filterBar/FilterBarAPI" {
1176
+ declare module "sap/fe/macros/filterBar/FilterBar" {
745
1177
  import {
746
- default as MacroAPI,
747
- $MacroAPISettings,
748
- } from "sap/fe/macros/MacroAPI";
1178
+ default as BuildingBlockWithTemplating,
1179
+ $BuildingBlockWithTemplatingSettings,
1180
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
749
1181
 
750
1182
  import SelectionVariant from "sap/fe/navigation/SelectionVariant";
751
1183
 
@@ -759,19 +1191,25 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
759
1191
  import Event from "sap/ui/base/Event";
760
1192
 
761
1193
  /**
762
- * Building block for creating a FilterBar based on the metadata provided by OData V4.
763
- *
764
- *
765
- * Usually, a SelectionFields annotation is expected.
766
- *
767
1194
  * Usage example:
768
1195
  *
769
1196
  * ```javascript
770
1197
  *
771
- * <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
1198
+ * sap.ui.require(["sap/fe/macros/filterBar/FilterBar"], function(FilterBar) {
1199
+ * ...
1200
+ * new FilterBar("MyFilterBar", {metaPath:"@com.sap.vocabularies.UI.v1.SelectionFields"})
1201
+ * })
772
1202
  * ```
1203
+ *
1204
+ * This is currently an experimental API because the structure of the generated content will change to come
1205
+ * closer to the FilterBar that you get out of templates.
1206
+ * The public method and property will not change but the internal structure will so be careful on your
1207
+ * usage.
1208
+ *
1209
+ *
1210
+ * @experimental
773
1211
  */
774
- export default class FilterBar extends MacroAPI {
1212
+ export default class FilterBar extends BuildingBlockWithTemplating {
775
1213
  /**
776
1214
  * Get the Active Filters Text Summary for the filter bar.
777
1215
  *
@@ -922,8 +1360,11 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
922
1360
  }
923
1361
  /**
924
1362
  * Describes the settings that can be provided to the FilterBar constructor.
1363
+ *
1364
+ * @experimental
925
1365
  */
926
- export interface $FilterBarSettings extends $MacroAPISettings {
1366
+ export interface $FilterBarSettings
1367
+ extends $BuildingBlockWithTemplatingSettings {
927
1368
  /**
928
1369
  * Defines the path of the context used in the current page or block.
929
1370
  * This setting is defined by the framework.
@@ -1005,224 +1446,524 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
1005
1446
  >;
1006
1447
  }
1007
1448
 
1008
- declare module "sap/fe/macros/filterBar/FilterField" {
1449
+ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
1009
1450
  import {
1010
- default as BuildingBlockObjectProperty,
1011
- $BuildingBlockObjectPropertySettings,
1012
- } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
1013
-
1014
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1015
-
1016
- /**
1017
- * Definition of a custom filter to be used inside the FilterBar.
1018
- * The template for the FilterField has to be provided as the default aggregation
1019
- */
1020
- export default class FilterField extends BuildingBlockObjectProperty {}
1021
- /**
1022
- * Describes the settings that can be provided to the FilterField constructor.
1023
- */
1024
- export interface $FilterFieldSettings
1025
- extends $BuildingBlockObjectPropertySettings {
1026
- /**
1027
- * Reference to the key of another filter already displayed in the table to properly place this one
1028
- */
1029
- anchor?: string | PropertyBindingInfo;
1030
-
1031
- /**
1032
- * The property name of the FilterField
1033
- */
1034
- key?: string | PropertyBindingInfo;
1035
-
1036
- /**
1037
- * The text that will be displayed for this FilterField
1038
- */
1039
- label?: string | PropertyBindingInfo;
1040
-
1041
- /**
1042
- * Defines where this filter should be placed relative to the defined anchor
1043
- * Allowed values are `Before` and `After`
1044
- */
1045
- placement?: string | PropertyBindingInfo;
1451
+ default as MacroAPI,
1452
+ $MacroAPISettings,
1453
+ } from "sap/fe/macros/MacroAPI";
1046
1454
 
1047
- /**
1048
- * If set, possible errors that occur during the search will be displayed in a message box.
1049
- */
1050
- showMessages?: boolean | PropertyBindingInfo | `{${string}}`;
1051
- }
1052
- }
1455
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
1053
1456
 
1054
- declare module "sap/fe/macros/form/Form.block" {
1055
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1457
+ import {
1458
+ PropertyBindingInfo,
1459
+ AggregationBindingInfo,
1460
+ } from "sap/ui/base/ManagedObject";
1056
1461
 
1057
- import Context from "sap/ui/model/Context";
1462
+ import FilterField from "sap/fe/macros/filterBar/FilterField";
1058
1463
 
1059
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1464
+ import Event from "sap/ui/base/Event";
1060
1465
 
1061
1466
  /**
1062
- * Building block for creating a Form based on the metadata provided by OData V4.
1467
+ * Building block for creating a FilterBar based on the metadata provided by OData V4.
1063
1468
  *
1064
1469
  *
1065
- * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
1066
- * or a CollectionFacet
1470
+ * Usually, a SelectionFields annotation is expected.
1067
1471
  *
1068
1472
  * Usage example:
1069
1473
  *
1070
1474
  * ```javascript
1071
1475
  *
1072
- * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
1476
+ * <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
1073
1477
  * ```
1074
1478
  */
1075
- export default class Form extends Control {}
1076
- /**
1077
- * Describes the settings that can be provided to the Form constructor.
1078
- */
1079
- export interface $FormSettings extends $ControlSettings {
1479
+ export default class FilterBar extends MacroAPI {
1080
1480
  /**
1081
- * Defines the path of the context used in the current page or block.
1082
- * This setting is defined by the framework.
1481
+ * Get the Active Filters Text Summary for the filter bar.
1482
+ *
1483
+ *
1484
+ * @returns Active filters summary as text
1083
1485
  */
1084
- contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1085
-
1486
+ getActiveFiltersText(): string;
1086
1487
  /**
1087
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
1488
+ * Gets the key of the current variant in the associated variant management.
1489
+ *
1490
+ *
1491
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1088
1492
  */
1089
- metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1090
-
1493
+ getCurrentVariantKey(): null | string;
1091
1494
  /**
1092
- * The title of the form control.
1495
+ * Determines whether the field is enabled or disabled.
1496
+ *
1497
+ *
1498
+ * @returns Whether the filterField is enabled or disabled.
1093
1499
  */
1094
- title?: string | PropertyBindingInfo;
1095
- }
1096
- }
1097
-
1098
- declare module "sap/fe/macros/form/FormElement.block" {
1099
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1100
-
1101
- import Context from "sap/ui/model/Context";
1102
-
1103
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1104
-
1105
- /**
1106
- * Building block used to create a form element based on the metadata provided by OData V4.
1107
- *
1108
- * @since 1.90.0
1109
- */
1110
- export default class FormElement extends Control {}
1111
- /**
1112
- * Describes the settings that can be provided to the FormElement constructor.
1113
- */
1114
- export interface $FormElementSettings extends $ControlSettings {
1500
+ getFilterFieldEnabled(
1501
+ /**
1502
+ * Name of the field.
1503
+ */
1504
+ name: string
1505
+ ): boolean;
1115
1506
  /**
1116
- * Defines the path of the context used in the current page or block.
1117
- * This setting is defined by the framework.
1507
+ * Gets the visibility of a filter field.
1508
+ *
1509
+ *
1510
+ * @returns A {@link Promise } that resolves to check whether the filter field is visible or not.
1118
1511
  */
1119
- contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1120
-
1512
+ getFilterFieldVisible(
1513
+ /**
1514
+ * The path to the property as a condition path
1515
+ */
1516
+ conditionPath: string
1517
+ ): Promise<boolean>;
1121
1518
  /**
1122
- * Label shown for the field. If not set, the label from the annotations will be shown.
1519
+ * Provides all the filters that are currently active
1520
+ * along with the search expression.
1521
+ *
1522
+ *
1523
+ * @returns An array of active filters and the search expression.
1123
1524
  */
1124
- label?: string | PropertyBindingInfo;
1125
-
1525
+ getFilters(): object;
1126
1526
  /**
1127
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
1527
+ * Get the selection variant from the filter bar.
1528
+ *
1529
+ *
1530
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1128
1531
  */
1129
- metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1130
-
1532
+ getSelectionVariant(): Promise<SelectionVariant>;
1131
1533
  /**
1132
- * If set to false, the FormElement is not rendered.
1534
+ * Sets the new selected variant in the associated variant management.
1133
1535
  */
1134
- visible?: boolean | PropertyBindingInfo | `{${string}}`;
1135
-
1536
+ setCurrentVariantKey(
1537
+ /**
1538
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
1539
+ * ignored.
1540
+ */
1541
+ key: string
1542
+ ): void;
1136
1543
  /**
1137
- * Optional aggregation of controls that should be displayed inside the FormElement.
1138
- * If not set, a default Field building block will be rendered
1544
+ * Sets the enablement of the field.
1139
1545
  */
1140
- fields?: Control;
1546
+ setFilterFieldEnabled(
1547
+ /**
1548
+ * Name of the field that should be enabled or disabled.
1549
+ */
1550
+ name: string,
1551
+ /**
1552
+ * Whether the field should be enabled or disabled.
1553
+ */
1554
+ enabled: boolean
1555
+ ): void;
1556
+ /**
1557
+ * Shows or hides any filter field from the filter bar.
1558
+ * The property will not be hidden inside the adaptation dialog and may be re-added.
1559
+ *
1560
+ *
1561
+ * @returns A {@link Promise } resolving once the change in visibility was applied
1562
+ */
1563
+ setFilterFieldVisible(
1564
+ /**
1565
+ * The path to the property as a condition path
1566
+ */
1567
+ conditionPath: string,
1568
+ /**
1569
+ * Whether it should be shown or hidden
1570
+ */
1571
+ visible: boolean
1572
+ ): Promise<void>;
1573
+ /**
1574
+ * Set the filter values for the given property in the filter bar.
1575
+ * The filter values can be either a single value or an array of values.
1576
+ * Each filter value must be represented as a primitive value.
1577
+ *
1578
+ *
1579
+ * @returns A promise for asynchronous handling
1580
+ */
1581
+ setFilterValues(
1582
+ /**
1583
+ * The path to the property as a condition path
1584
+ */
1585
+ sConditionPath: string,
1586
+ /**
1587
+ * The operator to be used (optional) - if not set, the default operator (EQ) will be used
1588
+ */
1589
+ sOperator: string | undefined,
1590
+ /**
1591
+ * The values to be applied
1592
+ */
1593
+ vValues?:
1594
+ | boolean
1595
+ | boolean[]
1596
+ | number
1597
+ | number[]
1598
+ | string
1599
+ | string[]
1600
+ | undefined
1601
+ ): Promise<void>;
1602
+ /**
1603
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
1604
+ * existing filters and then apply the SelectionVariant values.
1605
+ *
1606
+ *
1607
+ * @returns A promise for asynchronous handling
1608
+ */
1609
+ setSelectionVariant(
1610
+ /**
1611
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
1612
+ */
1613
+ selectionVariant: SelectionVariant,
1614
+ /**
1615
+ * Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
1616
+ * to display the filter value descriptions, instead of loading them from the backend
1617
+ */
1618
+ prefillDescriptions?: boolean
1619
+ ): Promise<any>;
1620
+ /**
1621
+ * Triggers the API search on the filter bar.
1622
+ *
1623
+ *
1624
+ * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
1625
+ */
1626
+ triggerSearch(): Promise<object | undefined>;
1141
1627
  }
1142
- }
1143
-
1144
- declare module "sap/fe/macros/kpiTag/KPITag.block" {
1145
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1146
-
1147
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1148
-
1149
- import Event from "sap/ui/base/Event";
1150
-
1151
- /**
1152
- * Building block used to create a KPI tag.
1153
- */
1154
- export default class KPITag extends Control {}
1155
1628
  /**
1156
- * Describes the settings that can be provided to the KPITag constructor.
1629
+ * Describes the settings that can be provided to the FilterBar constructor.
1157
1630
  */
1158
- export interface $KPITagSettings extends $ControlSettings {
1631
+ export interface $FilterBarSettings extends $MacroAPISettings {
1159
1632
  /**
1160
- * The Number to be displayed.
1633
+ * Defines the path of the context used in the current page or block.
1634
+ * This setting is defined by the framework.
1161
1635
  */
1162
- number?: number | PropertyBindingInfo | `{${string}}`;
1636
+ contextPath?: string | PropertyBindingInfo;
1163
1637
 
1164
1638
  /**
1165
- * Set it to `true` if the KPI should display its status icon.
1639
+ * If true, the search is triggered automatically when a filter value is changed.
1166
1640
  */
1167
- showIcon?: boolean | PropertyBindingInfo | `{${string}}`;
1641
+ liveMode?: boolean | PropertyBindingInfo | `{${string}}`;
1168
1642
 
1169
1643
  /**
1170
- * The Status to be displayed.
1644
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
1171
1645
  */
1172
- status?: string | PropertyBindingInfo;
1646
+ metaPath?: string | PropertyBindingInfo;
1173
1647
 
1174
1648
  /**
1175
- * The Text to be displayed.
1649
+ * Handles the visibility of the 'Clear' button on the FilterBar.
1176
1650
  */
1177
- text?: string | PropertyBindingInfo;
1651
+ showClearButton?: boolean | PropertyBindingInfo | `{${string}}`;
1178
1652
 
1179
1653
  /**
1180
- * The Tooltip to be displayed.
1654
+ * Displays possible errors during the search in a message box
1181
1655
  */
1182
- tooltip?: string | PropertyBindingInfo;
1656
+ showMessages?: boolean | PropertyBindingInfo | `{${string}}`;
1183
1657
 
1184
1658
  /**
1185
- * The Unit of Measure of the number to be displayed.
1659
+ * Parameter which sets the visibility of the FilterBar building block
1186
1660
  */
1187
- unit?: string | PropertyBindingInfo;
1661
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1662
+
1663
+ /**
1664
+ * Aggregate filter fields of the FilterBar building block
1665
+ */
1666
+ filterFields?:
1667
+ | FilterField[]
1668
+ | FilterField
1669
+ | AggregationBindingInfo
1670
+ | `{${string}}`;
1188
1671
  }
1189
1672
 
1190
1673
  /**
1191
- * Parameters of the KPITag#press event.
1674
+ * Parameters of the FilterBar#afterClear event.
1192
1675
  */
1193
- export interface KPITag$PressEventParameters {}
1676
+ export interface FilterBar$AfterClearEventParameters {}
1194
1677
 
1195
1678
  /**
1196
- * Event object of the KPITag#press event.
1679
+ * Event object of the FilterBar#afterClear event.
1197
1680
  */
1198
- export type KPITag$PressEvent = Event<KPITag$PressEventParameters, KPITag>;
1199
- }
1200
-
1201
- declare module "sap/fe/macros/microchart/MicroChart.block" {
1202
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1681
+ export type FilterBar$AfterClearEvent = Event<
1682
+ FilterBar$AfterClearEventParameters,
1683
+ FilterBar
1684
+ >;
1203
1685
 
1204
1686
  /**
1205
- * Building block used to create a MicroChart based on the metadata provided by OData V4.
1206
- *
1207
- * @since 1.93.0
1687
+ * Parameters of the FilterBar#filterChanged event.
1208
1688
  */
1209
- export default class MicroChart extends Control {}
1689
+ export interface FilterBar$FilterChangedEventParameters {}
1690
+
1210
1691
  /**
1211
- * Describes the settings that can be provided to the MicroChart constructor.
1692
+ * Event object of the FilterBar#filterChanged event.
1212
1693
  */
1213
- export interface $MicroChartSettings extends $ControlSettings {}
1214
- }
1215
-
1216
- declare module "sap/fe/macros/multiValueField/MultiValueField.block" {
1217
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1218
-
1219
- import Context from "sap/ui/model/Context";
1220
-
1221
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1694
+ export type FilterBar$FilterChangedEvent = Event<
1695
+ FilterBar$FilterChangedEventParameters,
1696
+ FilterBar
1697
+ >;
1222
1698
 
1223
1699
  /**
1224
- * Building block for creating a MultiValueField based on the metadata provided by OData V4.
1225
- *
1700
+ * Parameters of the FilterBar#search event.
1701
+ */
1702
+ export interface FilterBar$SearchEventParameters {}
1703
+
1704
+ /**
1705
+ * Event object of the FilterBar#search event.
1706
+ */
1707
+ export type FilterBar$SearchEvent = Event<
1708
+ FilterBar$SearchEventParameters,
1709
+ FilterBar
1710
+ >;
1711
+ }
1712
+
1713
+ declare module "sap/fe/macros/filterBar/FilterField" {
1714
+ import {
1715
+ default as BuildingBlockObjectProperty,
1716
+ $BuildingBlockObjectPropertySettings,
1717
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
1718
+
1719
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1720
+
1721
+ /**
1722
+ * Definition of a custom filter to be used inside the FilterBar.
1723
+ * The template for the FilterField has to be provided as the default aggregation
1724
+ */
1725
+ export default class FilterField extends BuildingBlockObjectProperty {}
1726
+ /**
1727
+ * Describes the settings that can be provided to the FilterField constructor.
1728
+ */
1729
+ export interface $FilterFieldSettings
1730
+ extends $BuildingBlockObjectPropertySettings {
1731
+ /**
1732
+ * Reference to the key of another filter already displayed in the table to properly place this one
1733
+ */
1734
+ anchor?: string | PropertyBindingInfo;
1735
+
1736
+ /**
1737
+ * The property name of the FilterField
1738
+ */
1739
+ key?: string | PropertyBindingInfo;
1740
+
1741
+ /**
1742
+ * The text that will be displayed for this FilterField
1743
+ */
1744
+ label?: string | PropertyBindingInfo;
1745
+
1746
+ /**
1747
+ * Defines where this filter should be placed relative to the defined anchor
1748
+ * Allowed values are `Before` and `After`
1749
+ */
1750
+ placement?: string | PropertyBindingInfo;
1751
+
1752
+ /**
1753
+ * If set, possible errors that occur during the search will be displayed in a message box.
1754
+ */
1755
+ showMessages?: boolean | PropertyBindingInfo | `{${string}}`;
1756
+ }
1757
+ }
1758
+
1759
+ declare module "sap/fe/macros/form/Form.block" {
1760
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1761
+
1762
+ import Context from "sap/ui/model/Context";
1763
+
1764
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1765
+
1766
+ /**
1767
+ * Building block for creating a Form based on the metadata provided by OData V4.
1768
+ *
1769
+ *
1770
+ * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
1771
+ * or a CollectionFacet
1772
+ *
1773
+ * Usage example:
1774
+ *
1775
+ * ```javascript
1776
+ *
1777
+ * <macros:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
1778
+ * ```
1779
+ */
1780
+ export default class Form extends Control {}
1781
+ /**
1782
+ * Describes the settings that can be provided to the Form constructor.
1783
+ */
1784
+ export interface $FormSettings extends $ControlSettings {
1785
+ /**
1786
+ * Defines the path of the context used in the current page or block.
1787
+ * This setting is defined by the framework.
1788
+ */
1789
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1790
+
1791
+ /**
1792
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
1793
+ */
1794
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1795
+
1796
+ /**
1797
+ * The title of the form control.
1798
+ */
1799
+ title?: string | PropertyBindingInfo;
1800
+ }
1801
+ }
1802
+
1803
+ declare module "sap/fe/macros/form/FormElement.block" {
1804
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1805
+
1806
+ import Context from "sap/ui/model/Context";
1807
+
1808
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1809
+
1810
+ /**
1811
+ * Building block used to create a form element based on the metadata provided by OData V4.
1812
+ *
1813
+ * @since 1.90.0
1814
+ */
1815
+ export default class FormElement extends Control {}
1816
+ /**
1817
+ * Describes the settings that can be provided to the FormElement constructor.
1818
+ */
1819
+ export interface $FormElementSettings extends $ControlSettings {
1820
+ /**
1821
+ * Defines the path of the context used in the current page or block.
1822
+ * This setting is defined by the framework.
1823
+ */
1824
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1825
+
1826
+ /**
1827
+ * Label shown for the field. If not set, the label from the annotations will be shown.
1828
+ */
1829
+ label?: string | PropertyBindingInfo;
1830
+
1831
+ /**
1832
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
1833
+ */
1834
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1835
+
1836
+ /**
1837
+ * If set to false, the FormElement is not rendered.
1838
+ */
1839
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1840
+
1841
+ /**
1842
+ * Optional aggregation of controls that should be displayed inside the FormElement.
1843
+ * If not set, a default Field building block will be rendered
1844
+ */
1845
+ fields?: Control;
1846
+ }
1847
+ }
1848
+
1849
+ declare module "sap/fe/macros/kpiTag/KPITag.block" {
1850
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1851
+
1852
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1853
+
1854
+ import Event from "sap/ui/base/Event";
1855
+
1856
+ /**
1857
+ * Building block used to create a KPI tag.
1858
+ */
1859
+ export default class KPITag extends Control {}
1860
+ /**
1861
+ * Describes the settings that can be provided to the KPITag constructor.
1862
+ */
1863
+ export interface $KPITagSettings extends $ControlSettings {
1864
+ /**
1865
+ * The Number to be displayed.
1866
+ */
1867
+ number?: number | PropertyBindingInfo | `{${string}}`;
1868
+
1869
+ /**
1870
+ * Set it to `true` if the KPI should display its status icon.
1871
+ */
1872
+ showIcon?: boolean | PropertyBindingInfo | `{${string}}`;
1873
+
1874
+ /**
1875
+ * The Status to be displayed.
1876
+ */
1877
+ status?: string | PropertyBindingInfo;
1878
+
1879
+ /**
1880
+ * The Text to be displayed.
1881
+ */
1882
+ text?: string | PropertyBindingInfo;
1883
+
1884
+ /**
1885
+ * The Tooltip to be displayed.
1886
+ */
1887
+ tooltip?: string | PropertyBindingInfo;
1888
+
1889
+ /**
1890
+ * The Unit of Measure of the number to be displayed.
1891
+ */
1892
+ unit?: string | PropertyBindingInfo;
1893
+ }
1894
+
1895
+ /**
1896
+ * Parameters of the KPITag#press event.
1897
+ */
1898
+ export interface KPITag$PressEventParameters {}
1899
+
1900
+ /**
1901
+ * Event object of the KPITag#press event.
1902
+ */
1903
+ export type KPITag$PressEvent = Event<KPITag$PressEventParameters, KPITag>;
1904
+ }
1905
+
1906
+ declare module "sap/fe/macros/microchart/MicroChart.block" {
1907
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1908
+
1909
+ /**
1910
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
1911
+ *
1912
+ * @since 1.93.0
1913
+ */
1914
+ export default class MicroChart extends Control {}
1915
+ /**
1916
+ * Describes the settings that can be provided to the MicroChart constructor.
1917
+ */
1918
+ export interface $MicroChartSettings extends $ControlSettings {}
1919
+ }
1920
+
1921
+ declare module "sap/fe/macros/microchart/MicroChart" {
1922
+ import {
1923
+ default as BuildingBlockWithTemplating,
1924
+ $BuildingBlockWithTemplatingSettings,
1925
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
1926
+
1927
+ /**
1928
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
1929
+ * Usage example:
1930
+ *
1931
+ * ```javascript
1932
+ *
1933
+ * sap.ui.require(["sap/fe/macros/microchart/MicroChart"], function(MicroChart) {
1934
+ * ...
1935
+ * new MicroChart("microChartID", {metaPath:"MyProperty"})
1936
+ * })
1937
+ * ```
1938
+ *
1939
+ * This is currently an experimental API because the structure of the generated content will change to come
1940
+ * closer to the MicroChart that you get out of templates.
1941
+ * The public method and property will not change but the internal structure will so be careful on your
1942
+ * usage.
1943
+ *
1944
+ *
1945
+ * @experimental
1946
+ */
1947
+ export default class MicroChart extends BuildingBlockWithTemplating {}
1948
+ /**
1949
+ * Describes the settings that can be provided to the MicroChart constructor.
1950
+ *
1951
+ * @experimental
1952
+ */
1953
+ export interface $MicroChartSettings
1954
+ extends $BuildingBlockWithTemplatingSettings {}
1955
+ }
1956
+
1957
+ declare module "sap/fe/macros/multiValueField/MultiValueField.block" {
1958
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1959
+
1960
+ import Context from "sap/ui/model/Context";
1961
+
1962
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1963
+
1964
+ /**
1965
+ * Building block for creating a MultiValueField based on the metadata provided by OData V4.
1966
+ *
1226
1967
  *
1227
1968
  * The MultiValueField can be used to display either a DataField or Property directly. It has to point to
1228
1969
  * a collection property.
@@ -1232,7 +1973,7 @@ declare module "sap/fe/macros/multiValueField/MultiValueField.block" {
1232
1973
  *
1233
1974
  * ```javascript
1234
1975
  *
1235
- * <macro:MultiValueField
1976
+ * <macros:MultiValueField
1236
1977
  * id="SomeUniqueIdentifier"
1237
1978
  * contextPath="{entitySet>}"
1238
1979
  * metaPath="{dataField>}"
@@ -1279,7 +2020,7 @@ declare module "sap/fe/macros/paginator/Paginator.block" {
1279
2020
  *
1280
2021
  * ```javascript
1281
2022
  *
1282
- * <macro:Paginator />
2023
+ * <macros:Paginator />
1283
2024
  * ```
1284
2025
  *
1285
2026
  *
@@ -1368,217 +2109,1239 @@ declare module "sap/fe/macros/richtexteditor/RichTextEditorWithMetadata.block" {
1368
2109
  import Context from "sap/ui/model/Context";
1369
2110
 
1370
2111
  /**
1371
- * Metadata-driven building block that exposes the RichTextEditor UI5 control.
1372
- * It's used to enter formatted text and uses the third-party component called TinyMCE.
1373
- *
2112
+ * Metadata-driven building block that exposes the RichTextEditor UI5 control.
2113
+ * It's used to enter formatted text and uses the third-party component called TinyMCE.
2114
+ *
2115
+ *
2116
+ * @since 1.117.0
2117
+ */
2118
+ export default class RichTextEditorWithMetadata extends Control {}
2119
+ /**
2120
+ * Describes the settings that can be provided to the RichTextEditorWithMetadata constructor.
2121
+ */
2122
+ export interface $RichTextEditorWithMetadataSettings
2123
+ extends $ControlSettings {
2124
+ /**
2125
+ * With the 'buttonGroups' attribute, you can customize the buttons that are displayed on the toolbar of
2126
+ * the editor.
2127
+ */
2128
+ buttonGroups?: any[] | PropertyBindingInfo | `{${string}}`;
2129
+
2130
+ /**
2131
+ * The context path of the property displayed
2132
+ */
2133
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
2134
+
2135
+ /**
2136
+ * With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default
2137
+ * The default plugins are "emoticons" "directionality" "image" "table" "link" "powerpaste".
2138
+ */
2139
+ excludeDefaultPlugins?: boolean | PropertyBindingInfo | `{${string}}`;
2140
+
2141
+ /**
2142
+ * The metaPath of the displayed property
2143
+ */
2144
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
2145
+
2146
+ /**
2147
+ * With the 'plugins' attribute you can customize the plugins that will be loaded by the editor.
2148
+ */
2149
+ plugins?: any[] | PropertyBindingInfo | `{${string}}`;
2150
+
2151
+ /**
2152
+ * Use the readOnly attribute to override the edit flow of the page.
2153
+ * By setting 'readOnly' to true, a FormattedText is displayed instead of the editor.
2154
+ */
2155
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
2156
+
2157
+ /**
2158
+ * Use the 'required' attribute, to make sure that the editor is filled with some text.
2159
+ */
2160
+ required?: boolean | PropertyBindingInfo | `{${string}}`;
2161
+ }
2162
+ }
2163
+
2164
+ declare module "sap/fe/macros/share/Share.block" {
2165
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
2166
+
2167
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2168
+
2169
+ /**
2170
+ * Building block used to create the ‘Share’ functionality.
2171
+ *
2172
+ *
2173
+ * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
2174
+ * SAP Jam.
2175
+ *
2176
+ *
2177
+ * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
2178
+ * the 'Save as Tile' option is not visible.
2179
+ *
2180
+ * Usage example:
2181
+ *
2182
+ * ```javascript
2183
+ *
2184
+ * <macros:Share
2185
+ * id="someID"
2186
+ * visible="true"
2187
+ * />
2188
+ * ```
2189
+ *
2190
+ *
2191
+ *
2192
+ * @since 1.93.0
2193
+ */
2194
+ export default class Share extends Control {}
2195
+ /**
2196
+ * Share Options.
2197
+ */
2198
+ export type ShareOptions = {};
2199
+
2200
+ /**
2201
+ * Describes the settings that can be provided to the Share constructor.
2202
+ */
2203
+ export interface $ShareSettings extends $ControlSettings {
2204
+ /**
2205
+ * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
2206
+ */
2207
+ shareOptions?: object | PropertyBindingInfo | `{${string}}`;
2208
+
2209
+ /**
2210
+ * Whether the share control should be visible on the screen.
2211
+ */
2212
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
2213
+ }
2214
+ }
2215
+
2216
+ declare module "sap/fe/macros/table/Action" {
2217
+ import {
2218
+ default as BuildingBlockObjectProperty,
2219
+ $BuildingBlockObjectPropertySettings,
2220
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
2221
+
2222
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2223
+
2224
+ /**
2225
+ * Definition of a custom action to be used inside the table toolbar
2226
+ */
2227
+ export default class Action extends BuildingBlockObjectProperty {}
2228
+ /**
2229
+ * Describes the settings that can be provided to the Action constructor.
2230
+ */
2231
+ export interface $ActionSettings
2232
+ extends $BuildingBlockObjectPropertySettings {
2233
+ /**
2234
+ * Reference to the key of another action already displayed in the toolbar to properly place this one
2235
+ */
2236
+ anchor?: string | PropertyBindingInfo;
2237
+
2238
+ /**
2239
+ * Enables or disables the action
2240
+ */
2241
+ enabled?: boolean | PropertyBindingInfo | `{${string}}`;
2242
+
2243
+ /**
2244
+ * Unique identifier of the action
2245
+ */
2246
+ key?: string | PropertyBindingInfo;
2247
+
2248
+ /**
2249
+ * Defines where this action should be placed relative to the defined anchor
2250
+ * Allowed values are `Before` and `After`
2251
+ */
2252
+ placement?: string | PropertyBindingInfo;
2253
+
2254
+ /**
2255
+ * Event handler to be called when the user chooses the action
2256
+ */
2257
+ press?: string | PropertyBindingInfo;
2258
+
2259
+ /**
2260
+ * Defines if the action requires a selection.
2261
+ */
2262
+ requiresSelection?: boolean | PropertyBindingInfo | `{${string}}`;
2263
+
2264
+ /**
2265
+ * The text that will be displayed for this action
2266
+ */
2267
+ text?: string | PropertyBindingInfo;
2268
+ }
2269
+ }
2270
+
2271
+ declare module "sap/fe/macros/table/ActionGroup" {
2272
+ import {
2273
+ default as BuildingBlockObjectProperty,
2274
+ $BuildingBlockObjectPropertySettings,
2275
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
2276
+
2277
+ import {
2278
+ PropertyBindingInfo,
2279
+ AggregationBindingInfo,
2280
+ } from "sap/ui/base/ManagedObject";
2281
+
2282
+ import Action from "sap/fe/macros/table/Action";
2283
+
2284
+ /**
2285
+ * Definition of a custom ActionGroup to be used inside the table toolbar
2286
+ */
2287
+ export default class ActionGroup extends BuildingBlockObjectProperty {}
2288
+ /**
2289
+ * Describes the settings that can be provided to the ActionGroup constructor.
2290
+ */
2291
+ export interface $ActionGroupSettings
2292
+ extends $BuildingBlockObjectPropertySettings {
2293
+ /**
2294
+ * Reference to the key of another action or action group already displayed in the toolbar to properly place
2295
+ * this one
2296
+ */
2297
+ anchor?: string | PropertyBindingInfo;
2298
+
2299
+ /**
2300
+ * Unique identifier of the ActionGroup
2301
+ */
2302
+ key?: string | PropertyBindingInfo;
2303
+
2304
+ /**
2305
+ * Defines where this action group should be placed relative to the defined anchor
2306
+ * Allowed values are `Before` and `After`
2307
+ */
2308
+ placement?: string | PropertyBindingInfo;
2309
+
2310
+ /**
2311
+ * The text that will be displayed for this action group
2312
+ */
2313
+ text?: string | PropertyBindingInfo;
2314
+
2315
+ /**
2316
+ * Defines nested actions
2317
+ */
2318
+ actions?: Action[] | Action | AggregationBindingInfo | `{${string}}`;
2319
+ }
2320
+ }
2321
+
2322
+ declare module "sap/fe/macros/table/Column" {
2323
+ import {
2324
+ default as BuildingBlockObjectProperty,
2325
+ $BuildingBlockObjectPropertySettings,
2326
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
2327
+
2328
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2329
+
2330
+ /**
2331
+ * Definition of a custom column to be used inside the table.
2332
+ * The template for the column has to be provided as the default aggregation
2333
+ */
2334
+ export default class Column extends BuildingBlockObjectProperty {}
2335
+ /**
2336
+ * Describes the settings that can be provided to the Column constructor.
2337
+ */
2338
+ export interface $ColumnSettings
2339
+ extends $BuildingBlockObjectPropertySettings {
2340
+ /**
2341
+ * Reference to the key of another column already displayed in the table to properly place this one
2342
+ */
2343
+ anchor?: string | PropertyBindingInfo;
2344
+
2345
+ /**
2346
+ * The text that will be displayed for this column header
2347
+ */
2348
+ header?: string | PropertyBindingInfo;
2349
+
2350
+ /**
2351
+ * Aligns the header as well as the content horizontally
2352
+ */
2353
+ horizontalAlign?: string | PropertyBindingInfo;
2354
+
2355
+ /**
2356
+ * Defines the column importance.
2357
+ * You can define which columns should be automatically moved to the pop-in area based on their importance
2358
+ */
2359
+ importance?: string | PropertyBindingInfo;
2360
+
2361
+ /**
2362
+ * Unique identifier of the column
2363
+ */
2364
+ key?: string | PropertyBindingInfo;
2365
+
2366
+ /**
2367
+ * Defines where this column should be placed relative to the defined anchor
2368
+ * Allowed values are `Before` and `After`
2369
+ */
2370
+ placement?: string | PropertyBindingInfo;
2371
+
2372
+ /**
2373
+ * Defines the column's width.
2374
+ * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
2375
+ */
2376
+ width?: string | PropertyBindingInfo;
2377
+
2378
+ /**
2379
+ * Indicates if the column header should be a part of the width calculation.
2380
+ */
2381
+ widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
2382
+ }
2383
+ }
2384
+
2385
+ declare module "sap/fe/macros/table/Table.block" {
2386
+ import {
2387
+ default as MacroAPI,
2388
+ $MacroAPISettings,
2389
+ } from "sap/fe/macros/MacroAPI";
2390
+
2391
+ import { MessageType } from "sap/ui/core/library";
2392
+
2393
+ import PresentationVariant from "sap/fe/navigation/PresentationVariant";
2394
+
2395
+ import Context from "sap/ui/model/odata/v4/Context";
2396
+
2397
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
2398
+
2399
+ import {
2400
+ PropertyBindingInfo,
2401
+ AggregationBindingInfo,
2402
+ } from "sap/ui/base/ManagedObject";
2403
+
2404
+ import TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
2405
+
2406
+ import ActionGroup from "sap/fe/macros/table/ActionGroup";
2407
+
2408
+ import Action from "sap/fe/macros/table/Action";
2409
+
2410
+ import Column from "sap/fe/macros/table/Column";
2411
+
2412
+ import Event from "sap/ui/base/Event";
2413
+
2414
+ /**
2415
+ * Building block used to create a table based on the metadata provided by OData V4.
2416
+ *
2417
+ *
2418
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
2419
+ * the Table building block can also be used to display an EntitySet.
2420
+ *
2421
+ *
2422
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
2423
+ *
2424
+ *
2425
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
2426
+ * also has a UI.LineItem as the first property of the Visualizations.
2427
+ * Usage example:
2428
+ *
2429
+ * ```javascript
2430
+ *
2431
+ * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
2432
+ * ```
2433
+ */
2434
+ export default class Table extends MacroAPI {
2435
+ /**
2436
+ * Adds a message to the table.
2437
+ * The message applies to the whole table and not to an individual table row.
2438
+ *
2439
+ *
2440
+ *
2441
+ * @returns The ID of the message
2442
+ */
2443
+ addMessage(
2444
+ /**
2445
+ * The parameters to create the message
2446
+ */
2447
+ parameters: {
2448
+ /**
2449
+ * Message description
2450
+ */
2451
+ description?: string;
2452
+ /**
2453
+ * Message text
2454
+ */
2455
+ message?: string;
2456
+ /**
2457
+ * True if the message is persistent
2458
+ */
2459
+ persistent?: boolean;
2460
+ /**
2461
+ * Message type
2462
+ */
2463
+ type?: MessageType;
2464
+ }
2465
+ ): string;
2466
+ /**
2467
+ * Get the variant management applied to the table.
2468
+ *
2469
+ *
2470
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
2471
+ */
2472
+ getCurrentVariantKey(): null | string;
2473
+ /**
2474
+ * Get the fields that should be ignored when generating the table.
2475
+ *
2476
+ * @since 1.124.0
2477
+ * @experimental (since 1.124.0)
2478
+ *
2479
+ * @returns The value of the ignoredFields property
2480
+ */
2481
+ getIgnoredFields(): string;
2482
+ /**
2483
+ * Get the presentation variant that is currently applied on the table.
2484
+ *
2485
+ *
2486
+ * @returns The presentation variant applied to the table
2487
+ */
2488
+ getPresentationVariant(): Promise<PresentationVariant>;
2489
+ /**
2490
+ * Gets contexts from the table that have been selected by the user.
2491
+ *
2492
+ *
2493
+ * @returns Contexts of the rows selected by the user
2494
+ */
2495
+ getSelectedContexts(): Context[];
2496
+ /**
2497
+ * Get the selection variant from the Table.
2498
+ *
2499
+ *
2500
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
2501
+ */
2502
+ getSelectionVariant(): Promise<SelectionVariant>;
2503
+ /**
2504
+ * Hide the columns with the given column keys by setting their availability to Default.
2505
+ *
2506
+ * @since 1.124.0
2507
+ * @experimental (since 1.124.0)
2508
+ *
2509
+ * @returns Promise
2510
+ */
2511
+ hideColumns(
2512
+ /**
2513
+ * The keys for the columns to hide
2514
+ */
2515
+ columnKeys: string[]
2516
+ ): Promise<void>;
2517
+ /**
2518
+ * Requests a refresh of the table.
2519
+ */
2520
+ refresh(): void;
2521
+ /**
2522
+ * Removes a message from the table.
2523
+ */
2524
+ removeMessage(
2525
+ /**
2526
+ * The id of the message
2527
+ */
2528
+ id: string
2529
+ ): void;
2530
+ /**
2531
+ * Set a variant management to the table.
2532
+ */
2533
+ setCurrentVariantKey(
2534
+ /**
2535
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
2536
+ * ignored.
2537
+ */
2538
+ key: string
2539
+ ): void;
2540
+ /**
2541
+ * Sets the fields that should be ignored when generating the table.
2542
+ *
2543
+ * @since 1.124.0
2544
+ * @experimental (since 1.124.0)
2545
+ *
2546
+ * @returns Reference to this in order to allow method chaining
2547
+ */
2548
+ setIgnoredFields(
2549
+ /**
2550
+ * The fields to ignore
2551
+ */
2552
+ ignoredFields: string
2553
+ ): this;
2554
+ /**
2555
+ * Set a new presentation variant to the table.
2556
+ */
2557
+ setPresentationVariant(
2558
+ /**
2559
+ * The new presentation variant that is to be set on the table.
2560
+ */
2561
+ tablePV: PresentationVariant
2562
+ ): Promise<void>;
2563
+ /**
2564
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
2565
+ * filters and then apply the SelectionVariant values.
2566
+ *
2567
+ *
2568
+ * @returns A promise for asynchronous handling
2569
+ */
2570
+ setSelectionVariant(
2571
+ /**
2572
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
2573
+ */
2574
+ selectionVariant: SelectionVariant,
2575
+ /**
2576
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
2577
+ * to display the filter value descriptions, instead of loading them from the backend
2578
+ */
2579
+ prefillDescriptions?: boolean
2580
+ ): Promise<any>;
2581
+ /**
2582
+ * Show the columns with the given column keys by setting their availability to Default.
2583
+ *
2584
+ * @since 1.124.0
2585
+ * @experimental (since 1.124.0)
2586
+ *
2587
+ * @returns Promise
2588
+ */
2589
+ showColumns(
2590
+ /**
2591
+ * The keys for the columns to show
2592
+ */
2593
+ columnKeys: string[]
2594
+ ): Promise<void>;
2595
+ }
2596
+ /**
2597
+ * Describes the settings that can be provided to the Table constructor.
2598
+ */
2599
+ export interface $TableSettings extends $MacroAPISettings {
2600
+ /**
2601
+ * An expression that allows you to control the 'busy' state of the table.
2602
+ */
2603
+ busy?: boolean | PropertyBindingInfo | `{${string}}`;
2604
+
2605
+ /**
2606
+ * Defines the path of the context used in the current page or block.
2607
+ * This setting is defined by the framework.
2608
+ */
2609
+ contextPath?: string | PropertyBindingInfo;
2610
+
2611
+ /**
2612
+ * A set of options that can be configured.
2613
+ */
2614
+ creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
2615
+
2616
+ /**
2617
+ * Controls if the copy functionality of the table is disabled or not.
2618
+ */
2619
+ disableCopyToClipboard?: boolean | PropertyBindingInfo | `{${string}}`;
2620
+
2621
+ /**
2622
+ * Specifies if the column width is automatically calculated.
2623
+ */
2624
+ enableAutoColumnWidth?: boolean | PropertyBindingInfo | `{${string}}`;
2625
+
2626
+ /**
2627
+ * Controls if the export functionality of the table is enabled or not.
2628
+ */
2629
+ enableExport?: boolean | PropertyBindingInfo | `{${string}}`;
2630
+
2631
+ /**
2632
+ * Controls whether the table can be opened in fullscreen mode or not.
2633
+ */
2634
+ enableFullScreen?: boolean | PropertyBindingInfo | `{${string}}`;
2635
+
2636
+ /**
2637
+ * Controls if the paste functionality of the table is enabled or not.
2638
+ */
2639
+ enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
2640
+
2641
+ /**
2642
+ * Maximum allowed number of records to be exported in one request.
2643
+ */
2644
+ exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
2645
+
2646
+ /**
2647
+ * ID of the FilterBar building block associated with the table.
2648
+ */
2649
+ filterBar?: string | PropertyBindingInfo;
2650
+
2651
+ /**
2652
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
2653
+ * This property is not relevant for responsive tables
2654
+ */
2655
+ frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
2656
+
2657
+ /**
2658
+ * Specifies the header text that is shown in the table.
2659
+ */
2660
+ header?: string | PropertyBindingInfo;
2661
+
2662
+ /**
2663
+ * Controls if the header text should be shown or not.
2664
+ */
2665
+ headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
2666
+
2667
+ /**
2668
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
2669
+ *
2670
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
2671
+ * value of fields that are provided in the ignoredfields.
2672
+ *
2673
+ * Any column referencing an ignored field is to be removed.
2674
+ */
2675
+ ignoredFields?: string | PropertyBindingInfo;
2676
+
2677
+ /**
2678
+ * Defines whether to display the search action.
2679
+ */
2680
+ isSearchable?: boolean | PropertyBindingInfo | `{${string}}`;
2681
+
2682
+ /**
2683
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
2684
+ * based on the current contextPath.
2685
+ */
2686
+ metaPath?: string | PropertyBindingInfo;
2687
+
2688
+ /**
2689
+ * Controls which options should be enabled for the table personalization dialog.
2690
+ * If it is set to `true`, all possible options for this kind of table are enabled.
2691
+ *
2692
+ * If it is set to `false`, personalization is disabled.
2693
+ *
2694
+ *
2695
+ *
2696
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
2697
+ * with the options you want to be available.
2698
+ *
2699
+ * Available options are:
2700
+ *
2701
+ * - Sort
2702
+ *
2703
+ * - Column
2704
+ *
2705
+ * - Filter
2706
+ */
2707
+ personalization?: string | PropertyBindingInfo;
2708
+
2709
+ /**
2710
+ * An expression that allows you to control the 'read-only' state of the table.
2711
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
2712
+ * current state.
2713
+ */
2714
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
2715
+
2716
+ /**
2717
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
2718
+ */
2719
+ rowCount?: int | PropertyBindingInfo | `{${string}}`;
2720
+
2721
+ /**
2722
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
2723
+ * Allowed values are `Auto`, `Fixed`.
2724
+ *
2725
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
2726
+ *
2727
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
2728
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
2729
+ * less than defined in the `rowCount` property.
2730
+ */
2731
+ rowCountMode?: string | PropertyBindingInfo;
2732
+
2733
+ /**
2734
+ * Defines the selection mode to be used by the table.
2735
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
2736
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
2737
+ * the consistent selection mode.
2738
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
2739
+ * Fiori guidelines.
2740
+ */
2741
+ selectionMode?: string | PropertyBindingInfo;
2742
+
2743
+ /**
2744
+ * Defines the type of table that will be used by the building block to render the data.
2745
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
2746
+ */
2747
+ type?: string | PropertyBindingInfo;
2748
+
2749
+ /**
2750
+ * Controls the kind of variant management that should be enabled for the table.
2751
+ * Allowed value is `Control`.
2752
+ *
2753
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
2754
+ * to this.
2755
+ *
2756
+ * If not set with any value, control level variant management is not available for this table.
2757
+ */
2758
+ variantManagement?: string | PropertyBindingInfo;
2759
+
2760
+ /**
2761
+ * Indicates if the column header should be a part of the width calculation.
2762
+ */
2763
+ widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
2764
+
2765
+ /**
2766
+ * Aggregate actions of the table.
2767
+ */
2768
+ actions?:
2769
+ | Array<ActionGroup | Action>
2770
+ | ActionGroup
2771
+ | Action
2772
+ | AggregationBindingInfo
2773
+ | `{${string}}`;
2774
+
2775
+ /**
2776
+ * Aggregate columns of the table.
2777
+ */
2778
+ columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
2779
+ }
2780
+
2781
+ /**
2782
+ * Parameters of the Table#beforeRebindTable event.
2783
+ */
2784
+ export interface Table$BeforeRebindTableEventParameters {}
2785
+
2786
+ /**
2787
+ * Event object of the Table#beforeRebindTable event.
2788
+ */
2789
+ export type Table$BeforeRebindTableEvent = Event<
2790
+ Table$BeforeRebindTableEventParameters,
2791
+ Table
2792
+ >;
2793
+
2794
+ /**
2795
+ * Parameters of the Table#rowPress event.
2796
+ */
2797
+ export interface Table$RowPressEventParameters {}
2798
+
2799
+ /**
2800
+ * Event object of the Table#rowPress event.
2801
+ */
2802
+ export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
2803
+
2804
+ /**
2805
+ * Parameters of the Table#selectionChange event.
2806
+ */
2807
+ export interface Table$SelectionChangeEventParameters {}
2808
+
2809
+ /**
2810
+ * Event object of the Table#selectionChange event.
2811
+ */
2812
+ export type Table$SelectionChangeEvent = Event<
2813
+ Table$SelectionChangeEventParameters,
2814
+ Table
2815
+ >;
2816
+ }
2817
+
2818
+ declare module "sap/fe/macros/table/Table" {
2819
+ import {
2820
+ default as BuildingBlockWithTemplating,
2821
+ $BuildingBlockWithTemplatingSettings,
2822
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
2823
+
2824
+ import Action from "sap/fe/macros/table/Action";
2825
+
2826
+ import Column from "sap/fe/macros/table/Column";
2827
+
2828
+ import { MessageType } from "sap/ui/core/library";
2829
+
2830
+ import PresentationVariant from "sap/fe/navigation/PresentationVariant";
2831
+
2832
+ import Context from "sap/ui/model/odata/v4/Context";
2833
+
2834
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
2835
+
2836
+ import {
2837
+ PropertyBindingInfo,
2838
+ AggregationBindingInfo,
2839
+ } from "sap/ui/base/ManagedObject";
2840
+
2841
+ import TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
2842
+
2843
+ import ActionGroup from "sap/fe/macros/table/ActionGroup";
2844
+
2845
+ import Event from "sap/ui/base/Event";
2846
+
2847
+ /**
2848
+ * Building block used to create a table based on the metadata provided by OData V4.
2849
+ *
2850
+ *
2851
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
2852
+ * the Table building block can also be used to display an EntitySet.
2853
+ *
2854
+ *
2855
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
2856
+ *
2857
+ *
2858
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
2859
+ * also has a UI.LineItem as the first property of the Visualizations.
2860
+ * Usage example:
2861
+ *
2862
+ * ```javascript
2863
+ *
2864
+ * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
2865
+ * ...
2866
+ * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
2867
+ * })
2868
+ * ```
2869
+ *
2870
+ * This is currently an experimental API because the structure of the generated content will change to come
2871
+ * closer to the Table that you get out of templates.
2872
+ * The public method and property will not change but the internal structure will so be careful on your
2873
+ * usage.
2874
+ *
2875
+ *
2876
+ * @since 1.124.0
2877
+ * @experimental (since 1.124.0)
2878
+ */
2879
+ export default class Table extends BuildingBlockWithTemplating {
2880
+ /**
2881
+ * Adds an action to the table.
2882
+ *
2883
+ * @since 1.124.0
2884
+ * @experimental (since 1.124.0)
2885
+ *
2886
+ * @returns Reference to this in order to allow method chaining
2887
+ */
2888
+ addAction(
2889
+ /**
2890
+ * The action to add
2891
+ */
2892
+ action: Action
2893
+ ): this;
2894
+ /**
2895
+ * Adds a column to the table.
2896
+ *
2897
+ * @since 1.124.0
2898
+ * @experimental (since 1.124.0)
2899
+ *
2900
+ * @returns Reference to this in order to allow method chaining
2901
+ */
2902
+ addColumn(
2903
+ /**
2904
+ * The column to add
2905
+ */
2906
+ column: Column
2907
+ ): this;
2908
+ /**
2909
+ * Adds a message to the table.
2910
+ * The message applies to the whole table and not to an individual table row.
2911
+ *
2912
+ *
2913
+ *
2914
+ * @returns The ID of the message
2915
+ */
2916
+ addMessage(
2917
+ /**
2918
+ * The parameters to create the message
2919
+ */
2920
+ parameters: {
2921
+ /**
2922
+ * Message description
2923
+ */
2924
+ description?: string;
2925
+ /**
2926
+ * Message text
2927
+ */
2928
+ message?: string;
2929
+ /**
2930
+ * True if the message is persistent
2931
+ */
2932
+ persistent?: boolean;
2933
+ /**
2934
+ * Message type
2935
+ */
2936
+ type?: MessageType;
2937
+ }
2938
+ ): string;
2939
+ /**
2940
+ * Get the variant management applied to the table.
2941
+ *
2942
+ *
2943
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
2944
+ */
2945
+ getCurrentVariantKey(): null | string;
2946
+ /**
2947
+ * Get the fields that should be ignored when generating the table.
2948
+ *
2949
+ * @since 1.124.0
2950
+ * @experimental (since 1.124.0)
2951
+ *
2952
+ * @returns The value of the ignoredFields property
2953
+ */
2954
+ getIgnoredFields(): string;
2955
+ /**
2956
+ * Gets the path to the metadata that should be used to generate the table.
2957
+ *
2958
+ * @since 1.124.0
2959
+ * @experimental (since 1.124.0)
2960
+ *
2961
+ * @returns The path to the metadata
2962
+ */
2963
+ getMetaPath(): string;
2964
+ /**
2965
+ * Get the presentation variant that is currently applied on the table.
2966
+ *
2967
+ *
2968
+ * @returns The presentation variant applied to the table
2969
+ */
2970
+ getPresentationVariant(): Promise<PresentationVariant>;
2971
+ /**
2972
+ * Gets contexts from the table that have been selected by the user.
2973
+ *
2974
+ *
2975
+ * @returns Contexts of the rows selected by the user
2976
+ */
2977
+ getSelectedContexts(): Context[];
2978
+ /**
2979
+ * Get the selection variant from the Table.
2980
+ *
2981
+ *
2982
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
2983
+ */
2984
+ getSelectionVariant(): Promise<SelectionVariant>;
2985
+ /**
2986
+ * Hide the columns with the given column keys by setting their availability to Default.
2987
+ *
2988
+ * @since 1.124.0
2989
+ * @experimental (since 1.124.0)
2990
+ *
2991
+ * @returns Promise
2992
+ */
2993
+ hideColumns(
2994
+ /**
2995
+ * The keys for the columns to hide
2996
+ */
2997
+ columnKeys: string[]
2998
+ ): Promise<void>;
2999
+ /**
3000
+ * Requests a refresh of the table.
3001
+ */
3002
+ refresh(): void;
3003
+ /**
3004
+ * Removes an action from the table.
3005
+ *
3006
+ * @since 1.124.0
3007
+ * @experimental (since 1.124.0)
3008
+ *
3009
+ * @returns The removed action or null
3010
+ */
3011
+ removeAction(
3012
+ /**
3013
+ * The action to remove, or its index or ID
3014
+ */
3015
+ action: number | Action | string
3016
+ ): null | Action;
3017
+ /**
3018
+ * Removes a column from the table.
3019
+ *
3020
+ * @since 1.124.0
3021
+ * @experimental (since 1.124.0)
3022
+ *
3023
+ * @returns The removed column or null
3024
+ */
3025
+ removeColumn(
3026
+ /**
3027
+ * The column to remove, or its index or ID
3028
+ */
3029
+ column: number | Column | string
3030
+ ): null | Column;
3031
+ /**
3032
+ * Removes a message from the table.
3033
+ */
3034
+ removeMessage(
3035
+ /**
3036
+ * The id of the message
3037
+ */
3038
+ id: string
3039
+ ): void;
3040
+ /**
3041
+ * Set a variant management to the table.
3042
+ */
3043
+ setCurrentVariantKey(
3044
+ /**
3045
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
3046
+ * ignored.
3047
+ */
3048
+ key: string
3049
+ ): void;
3050
+ /**
3051
+ * Sets the fields that should be ignored when generating the table.
3052
+ *
3053
+ * @since 1.124.0
3054
+ * @experimental (since 1.124.0)
3055
+ *
3056
+ * @returns Reference to this in order to allow method chaining
3057
+ */
3058
+ setIgnoredFields(
3059
+ /**
3060
+ * The fields to ignore
3061
+ */
3062
+ ignoredFields: string
3063
+ ): this;
3064
+ /**
3065
+ * Sets the path to the metadata that should be used to generate the table.
3066
+ *
3067
+ * @since 1.124.0
3068
+ * @experimental (since 1.124.0)
3069
+ *
3070
+ * @returns Reference to this in order to allow method chaining
3071
+ */
3072
+ setMetaPath(
3073
+ /**
3074
+ * The path to the metadata
3075
+ */
3076
+ metaPath: string
3077
+ ): this;
3078
+ /**
3079
+ * Set a new presentation variant to the table.
3080
+ */
3081
+ setPresentationVariant(
3082
+ /**
3083
+ * The new presentation variant that is to be set on the table.
3084
+ */
3085
+ tablePV: PresentationVariant
3086
+ ): Promise<void>;
3087
+ /**
3088
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
3089
+ * filters and then apply the SelectionVariant values.
3090
+ *
3091
+ *
3092
+ * @returns A promise for asynchronous handling
3093
+ */
3094
+ setSelectionVariant(
3095
+ /**
3096
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
3097
+ */
3098
+ selectionVariant: SelectionVariant,
3099
+ /**
3100
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
3101
+ * to display the filter value descriptions, instead of loading them from the backend
3102
+ */
3103
+ prefillDescriptions?: boolean
3104
+ ): Promise<any>;
3105
+ /**
3106
+ * Show the columns with the given column keys by setting their availability to Default.
3107
+ *
3108
+ * @since 1.124.0
3109
+ * @experimental (since 1.124.0)
3110
+ *
3111
+ * @returns Promise
3112
+ */
3113
+ showColumns(
3114
+ /**
3115
+ * The keys for the columns to show
3116
+ */
3117
+ columnKeys: string[]
3118
+ ): Promise<void>;
3119
+ }
3120
+ /**
3121
+ * Describes the settings that can be provided to the Table constructor.
1374
3122
  *
1375
- * @since 1.117.0
1376
- */
1377
- export default class RichTextEditorWithMetadata extends Control {}
1378
- /**
1379
- * Describes the settings that can be provided to the RichTextEditorWithMetadata constructor.
3123
+ * @experimental (since 1.124.0)
1380
3124
  */
1381
- export interface $RichTextEditorWithMetadataSettings
1382
- extends $ControlSettings {
3125
+ export interface $TableSettings extends $BuildingBlockWithTemplatingSettings {
1383
3126
  /**
1384
- * With the 'buttonGroups' attribute, you can customize the buttons that are displayed on the toolbar of
1385
- * the editor.
3127
+ * An expression that allows you to control the 'busy' state of the table.
1386
3128
  */
1387
- buttonGroups?: any[] | PropertyBindingInfo | `{${string}}`;
3129
+ busy?: boolean | PropertyBindingInfo | `{${string}}`;
1388
3130
 
1389
3131
  /**
1390
- * The context path of the property displayed
3132
+ * Defines the path of the context used in the current page or block.
3133
+ * This setting is defined by the framework.
1391
3134
  */
1392
- contextPath?: Context | PropertyBindingInfo | `{${string}}`;
3135
+ contextPath?: string | PropertyBindingInfo;
1393
3136
 
1394
3137
  /**
1395
- * With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default
1396
- * The default plugins are "emoticons" "directionality" "image" "table" "link" "powerpaste".
3138
+ * A set of options that can be configured.
1397
3139
  */
1398
- excludeDefaultPlugins?: boolean | PropertyBindingInfo | `{${string}}`;
3140
+ creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
1399
3141
 
1400
3142
  /**
1401
- * The metaPath of the displayed property
3143
+ * Controls if the copy functionality of the table is disabled or not.
1402
3144
  */
1403
- metaPath?: Context | PropertyBindingInfo | `{${string}}`;
3145
+ disableCopyToClipboard?: boolean | PropertyBindingInfo | `{${string}}`;
1404
3146
 
1405
3147
  /**
1406
- * With the 'plugins' attribute you can customize the plugins that will be loaded by the editor.
3148
+ * Specifies if the column width is automatically calculated.
1407
3149
  */
1408
- plugins?: any[] | PropertyBindingInfo | `{${string}}`;
3150
+ enableAutoColumnWidth?: boolean | PropertyBindingInfo | `{${string}}`;
1409
3151
 
1410
3152
  /**
1411
- * Use the readOnly attribute to override the edit flow of the page.
1412
- * By setting 'readOnly' to true, a FormattedText is displayed instead of the editor.
3153
+ * Controls if the export functionality of the table is enabled or not.
1413
3154
  */
1414
- readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
3155
+ enableExport?: boolean | PropertyBindingInfo | `{${string}}`;
1415
3156
 
1416
3157
  /**
1417
- * Use the 'required' attribute, to make sure that the editor is filled with some text.
3158
+ * Controls whether the table can be opened in fullscreen mode or not.
1418
3159
  */
1419
- required?: boolean | PropertyBindingInfo | `{${string}}`;
1420
- }
1421
- }
3160
+ enableFullScreen?: boolean | PropertyBindingInfo | `{${string}}`;
1422
3161
 
1423
- declare module "sap/fe/macros/share/Share.block" {
1424
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3162
+ /**
3163
+ * Controls if the paste functionality of the table is enabled or not.
3164
+ */
3165
+ enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
1425
3166
 
1426
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3167
+ /**
3168
+ * Maximum allowed number of records to be exported in one request.
3169
+ */
3170
+ exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
1427
3171
 
1428
- /**
1429
- * Building block used to create the ‘Share’ functionality.
1430
- *
1431
- *
1432
- * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
1433
- * SAP Jam.
1434
- *
1435
- *
1436
- * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
1437
- * the 'Save as Tile' option is not visible.
1438
- *
1439
- * Usage example:
1440
- *
1441
- * ```javascript
1442
- *
1443
- * <macro:Share
1444
- * id="someID"
1445
- * visible="true"
1446
- * />
1447
- * ```
1448
- *
1449
- *
1450
- *
1451
- * @since 1.93.0
1452
- */
1453
- export default class Share extends Control {}
1454
- /**
1455
- * Share Options.
1456
- */
1457
- export type ShareOptions = {};
3172
+ /**
3173
+ * ID of the FilterBar building block associated with the table.
3174
+ */
3175
+ filterBar?: string | PropertyBindingInfo;
1458
3176
 
1459
- /**
1460
- * Describes the settings that can be provided to the Share constructor.
1461
- */
1462
- export interface $ShareSettings extends $ControlSettings {
1463
3177
  /**
1464
- * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
3178
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
3179
+ * This property is not relevant for responsive tables
1465
3180
  */
1466
- shareOptions?: object | PropertyBindingInfo | `{${string}}`;
3181
+ frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
1467
3182
 
1468
3183
  /**
1469
- * Whether the share control should be visible on the screen.
3184
+ * Specifies the header text that is shown in the table.
1470
3185
  */
1471
- visible?: boolean | PropertyBindingInfo | `{${string}}`;
1472
- }
1473
- }
3186
+ header?: string | PropertyBindingInfo;
1474
3187
 
1475
- declare module "sap/fe/macros/table/Action" {
1476
- import {
1477
- default as BuildingBlockObjectProperty,
1478
- $BuildingBlockObjectPropertySettings,
1479
- } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
3188
+ /**
3189
+ * Controls if the header text should be shown or not.
3190
+ */
3191
+ headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
1480
3192
 
1481
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3193
+ /**
3194
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
3195
+ *
3196
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
3197
+ * value of fields that are provided in the ignoredfields.
3198
+ *
3199
+ * Any column referencing an ignored field is to be removed.
3200
+ */
3201
+ ignoredFields?: string | PropertyBindingInfo;
1482
3202
 
1483
- /**
1484
- * Definition of a custom action to be used inside the table toolbar
1485
- */
1486
- export default class Action extends BuildingBlockObjectProperty {}
1487
- /**
1488
- * Describes the settings that can be provided to the Action constructor.
1489
- */
1490
- export interface $ActionSettings
1491
- extends $BuildingBlockObjectPropertySettings {
1492
3203
  /**
1493
- * Reference to the key of another action already displayed in the toolbar to properly place this one
3204
+ * Defines whether to display the search action.
1494
3205
  */
1495
- anchor?: string | PropertyBindingInfo;
3206
+ isSearchable?: boolean | PropertyBindingInfo | `{${string}}`;
1496
3207
 
1497
3208
  /**
1498
- * Enables or disables the action
3209
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
3210
+ * based on the current contextPath.
1499
3211
  */
1500
- enabled?: boolean | PropertyBindingInfo | `{${string}}`;
3212
+ metaPath?: string | PropertyBindingInfo;
1501
3213
 
1502
3214
  /**
1503
- * Unique identifier of the action
3215
+ * Controls which options should be enabled for the table personalization dialog.
3216
+ * If it is set to `true`, all possible options for this kind of table are enabled.
3217
+ *
3218
+ * If it is set to `false`, personalization is disabled.
3219
+ *
3220
+ *
3221
+ *
3222
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
3223
+ * with the options you want to be available.
3224
+ *
3225
+ * Available options are:
3226
+ *
3227
+ * - Sort
3228
+ *
3229
+ * - Column
3230
+ *
3231
+ * - Filter
1504
3232
  */
1505
- key?: string | PropertyBindingInfo;
3233
+ personalization?: string | PropertyBindingInfo;
1506
3234
 
1507
3235
  /**
1508
- * Defines where this action should be placed relative to the defined anchor
1509
- * Allowed values are `Before` and `After`
3236
+ * An expression that allows you to control the 'read-only' state of the table.
3237
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
3238
+ * current state.
1510
3239
  */
1511
- placement?: string | PropertyBindingInfo;
3240
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
1512
3241
 
1513
3242
  /**
1514
- * Event handler to be called when the user chooses the action
3243
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
1515
3244
  */
1516
- press?: string | PropertyBindingInfo;
3245
+ rowCount?: int | PropertyBindingInfo | `{${string}}`;
1517
3246
 
1518
3247
  /**
1519
- * Defines if the action requires a selection.
3248
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
3249
+ * Allowed values are `Auto`, `Fixed`.
3250
+ *
3251
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
3252
+ *
3253
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
3254
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
3255
+ * less than defined in the `rowCount` property.
1520
3256
  */
1521
- requiresSelection?: boolean | PropertyBindingInfo | `{${string}}`;
3257
+ rowCountMode?: string | PropertyBindingInfo;
1522
3258
 
1523
3259
  /**
1524
- * The text that will be displayed for this action
3260
+ * Defines the selection mode to be used by the table.
3261
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
3262
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
3263
+ * the consistent selection mode.
3264
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
3265
+ * Fiori guidelines.
1525
3266
  */
1526
- text?: string | PropertyBindingInfo;
1527
- }
1528
- }
3267
+ selectionMode?: string | PropertyBindingInfo;
1529
3268
 
1530
- declare module "sap/fe/macros/table/ActionGroup" {
1531
- import {
1532
- default as BuildingBlockObjectProperty,
1533
- $BuildingBlockObjectPropertySettings,
1534
- } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
3269
+ /**
3270
+ * Defines the type of table that will be used by the building block to render the data.
3271
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
3272
+ */
3273
+ type?: string | PropertyBindingInfo;
1535
3274
 
1536
- import {
1537
- PropertyBindingInfo,
1538
- AggregationBindingInfo,
1539
- } from "sap/ui/base/ManagedObject";
3275
+ /**
3276
+ * Controls the kind of variant management that should be enabled for the table.
3277
+ * Allowed value is `Control`.
3278
+ *
3279
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
3280
+ * to this.
3281
+ *
3282
+ * If not set with any value, control level variant management is not available for this table.
3283
+ */
3284
+ variantManagement?: string | PropertyBindingInfo;
1540
3285
 
1541
- import Action from "sap/fe/macros/table/Action";
3286
+ /**
3287
+ * Indicates if the column header should be a part of the width calculation.
3288
+ */
3289
+ widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
1542
3290
 
1543
- /**
1544
- * Definition of a custom ActionGroup to be used inside the table toolbar
1545
- */
1546
- export default class ActionGroup extends BuildingBlockObjectProperty {}
1547
- /**
1548
- * Describes the settings that can be provided to the ActionGroup constructor.
1549
- */
1550
- export interface $ActionGroupSettings
1551
- extends $BuildingBlockObjectPropertySettings {
1552
3291
  /**
1553
- * Reference to the key of another action or action group already displayed in the toolbar to properly place
1554
- * this one
3292
+ * Aggregate actions of the table.
1555
3293
  */
1556
- anchor?: string | PropertyBindingInfo;
3294
+ actions?:
3295
+ | Array<ActionGroup | Action>
3296
+ | ActionGroup
3297
+ | Action
3298
+ | AggregationBindingInfo
3299
+ | `{${string}}`;
1557
3300
 
1558
3301
  /**
1559
- * Unique identifier of the ActionGroup
3302
+ * Aggregate columns of the table.
1560
3303
  */
1561
- key?: string | PropertyBindingInfo;
3304
+ columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
3305
+ }
3306
+
3307
+ /**
3308
+ * Parameters of the Table#beforeRebindTable event.
3309
+ */
3310
+ export interface Table$BeforeRebindTableEventParameters {}
3311
+
3312
+ /**
3313
+ * Event object of the Table#beforeRebindTable event.
3314
+ */
3315
+ export type Table$BeforeRebindTableEvent = Event<
3316
+ Table$BeforeRebindTableEventParameters,
3317
+ Table
3318
+ >;
1562
3319
 
1563
- /**
1564
- * Defines where this action group should be placed relative to the defined anchor
1565
- * Allowed values are `Before` and `After`
1566
- */
1567
- placement?: string | PropertyBindingInfo;
3320
+ /**
3321
+ * Parameters of the Table#rowPress event.
3322
+ */
3323
+ export interface Table$RowPressEventParameters {}
1568
3324
 
1569
- /**
1570
- * The text that will be displayed for this action group
1571
- */
1572
- text?: string | PropertyBindingInfo;
3325
+ /**
3326
+ * Event object of the Table#rowPress event.
3327
+ */
3328
+ export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
1573
3329
 
1574
- /**
1575
- * Defines nested actions
1576
- */
1577
- actions?: Action[] | Action | AggregationBindingInfo | `{${string}}`;
1578
- }
3330
+ /**
3331
+ * Parameters of the Table#selectionChange event.
3332
+ */
3333
+ export interface Table$SelectionChangeEventParameters {}
3334
+
3335
+ /**
3336
+ * Event object of the Table#selectionChange event.
3337
+ */
3338
+ export type Table$SelectionChangeEvent = Event<
3339
+ Table$SelectionChangeEventParameters,
3340
+ Table
3341
+ >;
1579
3342
  }
1580
3343
 
1581
- declare module "sap/fe/macros/table/Column" {
3344
+ declare module "sap/fe/macros/table/TableCreationOptions" {
1582
3345
  import {
1583
3346
  default as BuildingBlockObjectProperty,
1584
3347
  $BuildingBlockObjectPropertySettings,
@@ -1587,61 +3350,61 @@ declare module "sap/fe/macros/table/Column" {
1587
3350
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1588
3351
 
1589
3352
  /**
1590
- * Definition of a custom column to be used inside the table.
1591
- * The template for the column has to be provided as the default aggregation
3353
+ * Create options for the table.
1592
3354
  */
1593
- export default class Column extends BuildingBlockObjectProperty {}
3355
+ export default class TableCreationOptions extends BuildingBlockObjectProperty {}
1594
3356
  /**
1595
- * Describes the settings that can be provided to the Column constructor.
3357
+ * Describes the settings that can be provided to the TableCreationOptions constructor.
1596
3358
  */
1597
- export interface $ColumnSettings
3359
+ export interface $TableCreationOptionsSettings
1598
3360
  extends $BuildingBlockObjectPropertySettings {
1599
3361
  /**
1600
- * Reference to the key of another column already displayed in the table to properly place this one
1601
- */
1602
- anchor?: string | PropertyBindingInfo;
1603
-
1604
- /**
1605
- * The text that will be displayed for this column header
1606
- */
1607
- header?: string | PropertyBindingInfo;
1608
-
1609
- /**
1610
- * Aligns the header as well as the content horizontally
1611
- */
1612
- horizontalAlign?: string | PropertyBindingInfo;
1613
-
1614
- /**
1615
- * Defines the column importance.
1616
- * You can define which columns should be automatically moved to the pop-in area based on their importance
1617
- */
1618
- importance?: string | PropertyBindingInfo;
1619
-
1620
- /**
1621
- * Unique identifier of the column
3362
+ * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
3363
+ * 'Inline'
3364
+ *
3365
+ * The default value is 'false'
1622
3366
  */
1623
- key?: string | PropertyBindingInfo;
3367
+ createAtEnd?: boolean | PropertyBindingInfo | `{${string}}`;
1624
3368
 
1625
3369
  /**
1626
- * Defines where this column should be placed relative to the defined anchor
1627
- * Allowed values are `Before` and `After`
3370
+ * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
3371
+ * to responsive tables.
3372
+ *
3373
+ * The default value is 'false'
1628
3374
  */
1629
- placement?: string | PropertyBindingInfo;
3375
+ inlineCreationRowsHiddenInEditMode?:
3376
+ | boolean
3377
+ | PropertyBindingInfo
3378
+ | `{${string}}`;
1630
3379
 
1631
3380
  /**
1632
- * Defines the column's width.
1633
- * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
3381
+ * Defines the creation mode to be used by the table.
3382
+ * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
3383
+ *
3384
+ *
3385
+ *
3386
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
3387
+ * or 'Deferred' is used
3388
+ *
3389
+ * Inline - The creation is done inline
3390
+ *
3391
+ * InlineCreationsRows - The creation is done inline with an empty row
3392
+ *
3393
+ * External - The creation is done in a different application specified via the parameter 'outbound'
3394
+ * If not set with any value:
3395
+ *
3396
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1634
3397
  */
1635
- width?: string | PropertyBindingInfo;
3398
+ name?: string | PropertyBindingInfo;
1636
3399
 
1637
3400
  /**
1638
- * Indicates if the column header should be a part of the width calculation.
3401
+ * The navigation target where the document is created in case of creationMode 'External'
1639
3402
  */
1640
- widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
3403
+ outbound?: string | PropertyBindingInfo;
1641
3404
  }
1642
3405
  }
1643
3406
 
1644
- declare module "sap/fe/macros/table/TableAPI" {
3407
+ declare module "sap/fe/macros/table/TreeTable.block" {
1645
3408
  import {
1646
3409
  default as MacroAPI,
1647
3410
  $MacroAPISettings,
@@ -1660,6 +3423,8 @@ declare module "sap/fe/macros/table/TableAPI" {
1660
3423
  AggregationBindingInfo,
1661
3424
  } from "sap/ui/base/ManagedObject";
1662
3425
 
3426
+ import TreeTableCreationOptions from "sap/fe/macros/table/TreeTableCreationOptions";
3427
+
1663
3428
  import ActionGroup from "sap/fe/macros/table/ActionGroup";
1664
3429
 
1665
3430
  import Action from "sap/fe/macros/table/Action";
@@ -1669,26 +3434,9 @@ declare module "sap/fe/macros/table/TableAPI" {
1669
3434
  import Event from "sap/ui/base/Event";
1670
3435
 
1671
3436
  /**
1672
- * Building block used to create a table based on the metadata provided by OData V4.
1673
- *
1674
- *
1675
- * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
1676
- * the Table building block can also be used to display an EntitySet.
1677
- *
1678
- *
1679
- * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
1680
- *
1681
- *
1682
- * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
1683
- * also has a UI.LineItem as the first property of the Visualizations.
1684
- * Usage example:
1685
- *
1686
- * ```javascript
1687
- *
1688
- * <macro:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
1689
- * ```
3437
+ * Building block used to create a tree table based on the metadata provided by OData V4.
1690
3438
  */
1691
- export default class Table extends MacroAPI {
3439
+ export default class TreeTable extends MacroAPI {
1692
3440
  /**
1693
3441
  * Adds a message to the table.
1694
3442
  * The message applies to the whole table and not to an individual table row.
@@ -1727,6 +3475,15 @@ declare module "sap/fe/macros/table/TableAPI" {
1727
3475
  * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1728
3476
  */
1729
3477
  getCurrentVariantKey(): null | string;
3478
+ /**
3479
+ * Get the fields that should be ignored when generating the table.
3480
+ *
3481
+ * @since 1.124.0
3482
+ * @experimental (since 1.124.0)
3483
+ *
3484
+ * @returns The value of the ignoredFields property
3485
+ */
3486
+ getIgnoredFields(): string;
1730
3487
  /**
1731
3488
  * Get the presentation variant that is currently applied on the table.
1732
3489
  *
@@ -1748,6 +3505,20 @@ declare module "sap/fe/macros/table/TableAPI" {
1748
3505
  * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1749
3506
  */
1750
3507
  getSelectionVariant(): Promise<SelectionVariant>;
3508
+ /**
3509
+ * Hide the columns with the given column keys by setting their availability to Default.
3510
+ *
3511
+ * @since 1.124.0
3512
+ * @experimental (since 1.124.0)
3513
+ *
3514
+ * @returns Promise
3515
+ */
3516
+ hideColumns(
3517
+ /**
3518
+ * The keys for the columns to hide
3519
+ */
3520
+ columnKeys: string[]
3521
+ ): Promise<void>;
1751
3522
  /**
1752
3523
  * Requests a refresh of the table.
1753
3524
  */
@@ -1771,6 +3542,20 @@ declare module "sap/fe/macros/table/TableAPI" {
1771
3542
  */
1772
3543
  key: string
1773
3544
  ): void;
3545
+ /**
3546
+ * Sets the fields that should be ignored when generating the table.
3547
+ *
3548
+ * @since 1.124.0
3549
+ * @experimental (since 1.124.0)
3550
+ *
3551
+ * @returns Reference to this in order to allow method chaining
3552
+ */
3553
+ setIgnoredFields(
3554
+ /**
3555
+ * The fields to ignore
3556
+ */
3557
+ ignoredFields: string
3558
+ ): this;
1774
3559
  /**
1775
3560
  * Set a new presentation variant to the table.
1776
3561
  */
@@ -1798,54 +3583,25 @@ declare module "sap/fe/macros/table/TableAPI" {
1798
3583
  */
1799
3584
  prefillDescriptions?: boolean
1800
3585
  ): Promise<any>;
1801
- }
1802
- /**
1803
- * Create options for the table.
1804
- */
1805
- export type TableCreationOptions = {
1806
- /**
1807
- * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
1808
- * 'Inline'
1809
- *
1810
- * The default value is 'false'
1811
- */
1812
- createAtEnd: boolean;
1813
- /**
1814
- * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
1815
- * to responsive tables.
1816
- *
1817
- * The default value is 'false'
1818
- */
1819
- inlineCreationRowsHiddenInEditMode: boolean;
1820
3586
  /**
1821
- * Defines the creation mode to be used by the table.
1822
- * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
1823
- *
1824
- *
1825
- *
1826
- * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
1827
- * or 'Deferred' is used
1828
- *
1829
- * Inline - The creation is done inline
1830
- *
1831
- * InlineCreationsRows - The creation is done inline with an empty row
3587
+ * Show the columns with the given column keys by setting their availability to Default.
1832
3588
  *
1833
- * External - The creation is done in a different application specified via the parameter 'outbound'
1834
- * If not set with any value:
3589
+ * @since 1.124.0
3590
+ * @experimental (since 1.124.0)
1835
3591
  *
1836
- * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1837
- */
1838
- name: string;
1839
- /**
1840
- * The navigation target where the document is created in case of creationMode 'External'
3592
+ * @returns Promise
1841
3593
  */
1842
- outbound: string;
1843
- };
1844
-
3594
+ showColumns(
3595
+ /**
3596
+ * The keys for the columns to show
3597
+ */
3598
+ columnKeys: string[]
3599
+ ): Promise<void>;
3600
+ }
1845
3601
  /**
1846
- * Describes the settings that can be provided to the Table constructor.
3602
+ * Describes the settings that can be provided to the TreeTable constructor.
1847
3603
  */
1848
- export interface $TableSettings extends $MacroAPISettings {
3604
+ export interface $TreeTableSettings extends $MacroAPISettings {
1849
3605
  /**
1850
3606
  * An expression that allows you to control the 'busy' state of the table.
1851
3607
  */
@@ -1860,7 +3616,10 @@ declare module "sap/fe/macros/table/TableAPI" {
1860
3616
  /**
1861
3617
  * A set of options that can be configured.
1862
3618
  */
1863
- creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
3619
+ creationMode?:
3620
+ | TreeTableCreationOptions
3621
+ | PropertyBindingInfo
3622
+ | `{${string}}`;
1864
3623
 
1865
3624
  /**
1866
3625
  * Controls if the copy functionality of the table is disabled or not.
@@ -1890,7 +3649,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1890
3649
  /**
1891
3650
  * Maximum allowed number of records to be exported in one request.
1892
3651
  */
1893
- exportRequestSize?: number | PropertyBindingInfo | `{${string}}`;
3652
+ exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
1894
3653
 
1895
3654
  /**
1896
3655
  * ID of the FilterBar building block associated with the table.
@@ -1901,7 +3660,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1901
3660
  * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
1902
3661
  * This property is not relevant for responsive tables
1903
3662
  */
1904
- frozenColumnCount?: number | PropertyBindingInfo | `{${string}}`;
3663
+ frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
1905
3664
 
1906
3665
  /**
1907
3666
  * Specifies the header text that is shown in the table.
@@ -1913,6 +3672,31 @@ declare module "sap/fe/macros/table/TableAPI" {
1913
3672
  */
1914
3673
  headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
1915
3674
 
3675
+ /**
3676
+ * A set of options that can be configured.
3677
+ */
3678
+ hierarchyQualifier?: string | PropertyBindingInfo;
3679
+
3680
+ /**
3681
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
3682
+ *
3683
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
3684
+ * value of fields that are provided in the ignoredfields.
3685
+ *
3686
+ * Any column referencing an ignored field is to be removed.
3687
+ */
3688
+ ignoredFields?: string | PropertyBindingInfo;
3689
+
3690
+ /**
3691
+ * Defines the extension point to control if a source node can be dropped on a specific parent node.
3692
+ */
3693
+ isMoveToPositionAllowed?: string | PropertyBindingInfo;
3694
+
3695
+ /**
3696
+ * Defines the extension point to control if a node can be dragged.
3697
+ */
3698
+ isNodeMovable?: string | PropertyBindingInfo;
3699
+
1916
3700
  /**
1917
3701
  * Defines whether to display the search action.
1918
3702
  */
@@ -1943,7 +3727,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1943
3727
  *
1944
3728
  * - Filter
1945
3729
  */
1946
- personalization?: boolean | string | PropertyBindingInfo | `{${string}}`;
3730
+ personalization?: string | PropertyBindingInfo;
1947
3731
 
1948
3732
  /**
1949
3733
  * An expression that allows you to control the 'read-only' state of the table.
@@ -1955,7 +3739,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1955
3739
  /**
1956
3740
  * Number of rows to be displayed in the table. Does not apply to responsive tables.
1957
3741
  */
1958
- rowCount?: number | PropertyBindingInfo | `{${string}}`;
3742
+ rowCount?: int | PropertyBindingInfo | `{${string}}`;
1959
3743
 
1960
3744
  /**
1961
3745
  * Defines how the table handles the visible rows. Does not apply to Responsive tables.
@@ -1980,8 +3764,9 @@ declare module "sap/fe/macros/table/TableAPI" {
1980
3764
  selectionMode?: string | PropertyBindingInfo;
1981
3765
 
1982
3766
  /**
1983
- * Defines the type of table that will be used by the building block to render the data.
1984
- * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
3767
+ * Defines the type of table that will be used by the building block to render the data. This setting is
3768
+ * defined by the framework.
3769
+ * Allowed value is `TreeTable`.
1985
3770
  */
1986
3771
  type?: string | PropertyBindingInfo;
1987
3772
 
@@ -2018,58 +3803,121 @@ declare module "sap/fe/macros/table/TableAPI" {
2018
3803
  }
2019
3804
 
2020
3805
  /**
2021
- * Parameters of the Table#beforeRebindTable event.
3806
+ * Parameters of the TreeTable#beforeRebindTable event.
2022
3807
  */
2023
- export interface Table$BeforeRebindTableEventParameters {}
3808
+ export interface TreeTable$BeforeRebindTableEventParameters {}
2024
3809
 
2025
3810
  /**
2026
- * Event object of the Table#beforeRebindTable event.
3811
+ * Event object of the TreeTable#beforeRebindTable event.
2027
3812
  */
2028
- export type Table$BeforeRebindTableEvent = Event<
2029
- Table$BeforeRebindTableEventParameters,
2030
- Table
3813
+ export type TreeTable$BeforeRebindTableEvent = Event<
3814
+ TreeTable$BeforeRebindTableEventParameters,
3815
+ TreeTable
2031
3816
  >;
2032
3817
 
2033
3818
  /**
2034
- * Parameters of the Table#rowPress event.
3819
+ * Parameters of the TreeTable#rowPress event.
2035
3820
  */
2036
- export interface Table$RowPressEventParameters {}
3821
+ export interface TreeTable$RowPressEventParameters {}
2037
3822
 
2038
3823
  /**
2039
- * Event object of the Table#rowPress event.
3824
+ * Event object of the TreeTable#rowPress event.
2040
3825
  */
2041
- export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
3826
+ export type TreeTable$RowPressEvent = Event<
3827
+ TreeTable$RowPressEventParameters,
3828
+ TreeTable
3829
+ >;
2042
3830
 
2043
3831
  /**
2044
- * Parameters of the Table#selectionChange event.
3832
+ * Parameters of the TreeTable#selectionChange event.
2045
3833
  */
2046
- export interface Table$SelectionChangeEventParameters {}
3834
+ export interface TreeTable$SelectionChangeEventParameters {}
2047
3835
 
2048
3836
  /**
2049
- * Event object of the Table#selectionChange event.
3837
+ * Event object of the TreeTable#selectionChange event.
2050
3838
  */
2051
- export type Table$SelectionChangeEvent = Event<
2052
- Table$SelectionChangeEventParameters,
2053
- Table
3839
+ export type TreeTable$SelectionChangeEvent = Event<
3840
+ TreeTable$SelectionChangeEventParameters,
3841
+ TreeTable
2054
3842
  >;
2055
3843
  }
2056
3844
 
3845
+ declare module "sap/fe/macros/table/TreeTableCreationOptions" {
3846
+ import {
3847
+ default as BuildingBlockObjectProperty,
3848
+ $BuildingBlockObjectPropertySettings,
3849
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
3850
+
3851
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3852
+
3853
+ /**
3854
+ * Create options for the tree table.
3855
+ */
3856
+ export default class TreeTableCreationOptions extends BuildingBlockObjectProperty {}
3857
+ /**
3858
+ * Describes the settings that can be provided to the TreeTableCreationOptions constructor.
3859
+ */
3860
+ export interface $TreeTableCreationOptionsSettings
3861
+ extends $BuildingBlockObjectPropertySettings {
3862
+ /**
3863
+ * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
3864
+ */
3865
+ isCreateEnabled?: string | PropertyBindingInfo;
3866
+
3867
+ /**
3868
+ * Defines the creation mode to be used by the tree table.
3869
+ * Allowed values are `NewPage` or `Inline`.
3870
+ *
3871
+ *
3872
+ *
3873
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
3874
+ * or 'Deferred' is used.
3875
+ *
3876
+ * Inline - the creation is done inline.
3877
+ *
3878
+ * If not set with any value:
3879
+ *
3880
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
3881
+ */
3882
+ name?: string | PropertyBindingInfo;
3883
+
3884
+ /**
3885
+ * Defines the nodes to be added on the custom create.
3886
+ * This object must have the following properties:
3887
+ * propertyName: the name of the property on the page entity set used to categorize the node type to be
3888
+ * created within the hierarchy
3889
+ *
3890
+ * values: an array of key and label that define a value of the property defined by the propertyName key
3891
+ * and its label
3892
+ */
3893
+ nodeType?: object | PropertyBindingInfo | `{${string}}`;
3894
+ }
3895
+ }
3896
+
2057
3897
  declare namespace sap {
2058
3898
  interface IUI5DefineDependencyNames {
2059
3899
  "sap/fe/macros/chart/Action": undefined;
2060
3900
 
2061
3901
  "sap/fe/macros/chart/ActionGroup": undefined;
2062
3902
 
3903
+ "sap/fe/macros/chart/Chart": undefined;
3904
+
2063
3905
  "sap/fe/macros/chart/ChartAPI": undefined;
2064
3906
 
2065
3907
  "sap/fe/macros/CollectionBindingInfo": undefined;
2066
3908
 
2067
3909
  "sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;
2068
3910
 
3911
+ "sap/fe/macros/controls/BuildingBlockWithTemplating": undefined;
3912
+
2069
3913
  "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block": undefined;
2070
3914
 
3915
+ "sap/fe/macros/field/Field": undefined;
3916
+
2071
3917
  "sap/fe/macros/field/FieldAPI": undefined;
2072
3918
 
3919
+ "sap/fe/macros/filterBar/FilterBar": undefined;
3920
+
2073
3921
  "sap/fe/macros/filterBar/FilterBarAPI": undefined;
2074
3922
 
2075
3923
  "sap/fe/macros/filterBar/FilterField": undefined;
@@ -2084,6 +3932,8 @@ declare namespace sap {
2084
3932
 
2085
3933
  "sap/fe/macros/MacroAPI": undefined;
2086
3934
 
3935
+ "sap/fe/macros/microchart/MicroChart": undefined;
3936
+
2087
3937
  "sap/fe/macros/microchart/MicroChart.block": undefined;
2088
3938
 
2089
3939
  "sap/fe/macros/multiValueField/MultiValueField.block": undefined;
@@ -2106,6 +3956,14 @@ declare namespace sap {
2106
3956
 
2107
3957
  "sap/fe/macros/table/Column": undefined;
2108
3958
 
2109
- "sap/fe/macros/table/TableAPI": undefined;
3959
+ "sap/fe/macros/table/Table": undefined;
3960
+
3961
+ "sap/fe/macros/table/Table.block": undefined;
3962
+
3963
+ "sap/fe/macros/table/TableCreationOptions": undefined;
3964
+
3965
+ "sap/fe/macros/table/TreeTable.block": undefined;
3966
+
3967
+ "sap/fe/macros/table/TreeTableCreationOptions": undefined;
2110
3968
  }
2111
3969
  }