@sapui5/types 1.123.1 → 1.124.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/LICENSE.txt +13 -10
  2. package/README.md +1 -1
  3. package/package.json +1 -1
  4. package/types/sap.apf.d.ts +1 -1
  5. package/types/sap.ca.ui.d.ts +1 -1
  6. package/types/sap.chart.d.ts +1 -1
  7. package/types/sap.collaboration.d.ts +5 -3
  8. package/types/sap.esh.search.ui.d.ts +126 -1
  9. package/types/sap.f.d.ts +49 -12
  10. package/types/sap.fe.core.d.ts +14 -6
  11. package/types/sap.fe.macros.d.ts +2309 -463
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +1 -1
  14. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  15. package/types/sap.fe.templates.d.ts +31 -4
  16. package/types/sap.fe.test.d.ts +1 -1
  17. package/types/sap.fe.tools.d.ts +1 -1
  18. package/types/sap.feedback.ui.d.ts +1 -1
  19. package/types/sap.gantt.d.ts +3 -2
  20. package/types/sap.insights.d.ts +1 -1
  21. package/types/sap.m.d.ts +4151 -476
  22. package/types/sap.makit.d.ts +1 -1
  23. package/types/sap.me.d.ts +1 -1
  24. package/types/sap.ndc.d.ts +1 -1
  25. package/types/sap.ovp.d.ts +1 -1
  26. package/types/sap.rules.ui.d.ts +1 -1
  27. package/types/sap.sac.df.d.ts +200 -82
  28. package/types/sap.suite.ui.commons.d.ts +5 -3
  29. package/types/sap.suite.ui.generic.template.d.ts +31 -1
  30. package/types/sap.suite.ui.microchart.d.ts +1 -1
  31. package/types/sap.tnt.d.ts +3 -2
  32. package/types/sap.ui.codeeditor.d.ts +1 -1
  33. package/types/sap.ui.commons.d.ts +17 -9
  34. package/types/sap.ui.comp.d.ts +171 -31
  35. package/types/sap.ui.core.d.ts +130 -231
  36. package/types/sap.ui.dt.d.ts +6 -2
  37. package/types/sap.ui.export.d.ts +1 -1
  38. package/types/sap.ui.fl.d.ts +3 -2
  39. package/types/sap.ui.generic.app.d.ts +1 -1
  40. package/types/sap.ui.generic.template.d.ts +1 -1
  41. package/types/sap.ui.integration.d.ts +1 -1
  42. package/types/sap.ui.layout.d.ts +7 -4
  43. package/types/sap.ui.mdc.d.ts +482 -755
  44. package/types/sap.ui.richtexteditor.d.ts +1 -1
  45. package/types/sap.ui.rta.d.ts +1 -1
  46. package/types/sap.ui.suite.d.ts +1 -1
  47. package/types/sap.ui.support.d.ts +1 -1
  48. package/types/sap.ui.table.d.ts +1 -1
  49. package/types/sap.ui.testrecorder.d.ts +1 -1
  50. package/types/sap.ui.unified.d.ts +4 -3
  51. package/types/sap.ui.ux3.d.ts +3 -2
  52. package/types/sap.ui.vbm.d.ts +3 -2
  53. package/types/sap.ui.vk.d.ts +77 -26
  54. package/types/sap.ui.vtm.d.ts +23 -12
  55. package/types/sap.ui.webc.common.d.ts +1 -1
  56. package/types/sap.ui.webc.fiori.d.ts +23 -12
  57. package/types/sap.ui.webc.main.d.ts +65 -33
  58. package/types/sap.uiext.inbox.d.ts +62 -1
  59. package/types/sap.ushell.d.ts +649 -198
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +11 -6
  62. package/types/sap.viz.d.ts +1 -1
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +1 -1
  65. package/types/sap.zen.crosstab.d.ts +1 -1
  66. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.123.0
1
+ // For Library Version: 1.124.0
2
2
 
3
3
  declare 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,191 @@ 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
+ /**
909
+ * Parameters of the Field#change event.
910
+ */
911
+ export interface Field$ChangeEventParameters {}
912
+
913
+ /**
914
+ * Event object of the Field#change event.
915
+ */
916
+ export type Field$ChangeEvent = Event<Field$ChangeEventParameters, Field>;
917
+
918
+ /**
919
+ * Parameters of the Field#liveChange event.
920
+ */
921
+ export interface Field$LiveChangeEventParameters {}
922
+
923
+ /**
924
+ * Event object of the Field#liveChange event.
925
+ */
926
+ export type Field$LiveChangeEvent = Event<
927
+ Field$LiveChangeEventParameters,
928
+ Field
929
+ >;
930
+ }
931
+
932
+ declare module "sap/fe/macros/field/FieldAPI" {
933
+ import {
934
+ default as MacroAPI,
935
+ $MacroAPISettings,
936
+ } from "sap/fe/macros/MacroAPI";
937
+
938
+ import { MessageType } from "sap/ui/core/library";
939
+
940
+ import Control from "sap/ui/core/Control";
941
+
942
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
943
+
944
+ import Event from "sap/ui/base/Event";
945
+
946
+ /**
947
+ * Building block for creating a field based on the metadata provided by OData V4.
948
+ *
949
+ *
950
+ * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display a
951
+ * property from the entity type.
952
+ * When creating a Field building block, you must provide an ID to ensure everything works correctly.
953
+ *
954
+ * Usage example:
955
+ *
956
+ * ```javascript
957
+ *
958
+ * <macros:Field id="MyField" metaPath="MyProperty" />
959
+ * ```
960
+ */
961
+ export default class Field extends MacroAPI {
962
+ /**
963
+ * Adds a message to the field.
964
+ *
965
+ *
966
+ * @returns The id of the message
967
+ */
968
+ addMessage(
969
+ /**
970
+ * The parameters to create message
971
+ */
972
+ parameters: {
973
+ /**
974
+ * Message description
975
+ */
976
+ description?: string;
977
+ /**
978
+ * Message text
979
+ */
980
+ message?: string;
981
+ /**
982
+ * True if the message is persistent
983
+ */
984
+ persistent?: boolean;
985
+ /**
986
+ * Type of the message
987
+ */
988
+ type?: MessageType;
989
+ }
990
+ ): string;
991
+ /**
992
+ * Gets the current enablement state of the field.
993
+ *
994
+ *
995
+ * @returns Boolean value with the enablement state
996
+ */
997
+ getEnabled(): boolean;
998
+ /**
999
+ * Retrieves the current value of the field.
1000
+ *
1001
+ *
1002
+ * @returns The current value of the field
1003
+ */
1004
+ getValue(): boolean | string;
1005
+ /**
1006
+ * Removes a message from the field.
1007
+ */
1008
+ removeMessage(
1009
+ /**
1010
+ * The id of the message
1011
+ */
1012
+ id: string
1013
+ ): void;
1014
+ /**
1015
+ * Sets the current enablement state of the field.
1016
+ *
1017
+ *
1018
+ * @returns The current field reference
1019
+ */
1020
+ setEnabled(): Control;
1021
+ /**
1022
+ * Sets the current value of the field.
1023
+ *
1024
+ *
1025
+ * @returns The current field reference
1026
+ */
1027
+ setValue(): Control;
1028
+ }
1029
+ /**
1030
+ * Additional format options for the field.
1031
+ */
1032
+ export type FieldFormatOptions = {
1033
+ /**
1034
+ * Defines how the field value and associated text will be displayed together.
1035
+ *
1036
+ * Allowed values are "Value", "Description", "DescriptionValue" and "ValueDescription"
1037
+ */
1038
+ displayMode: string;
1039
+ /**
1040
+ * Determines how the field should be rendered, e.g. as radio buttons.
1041
+ *
1042
+ * If not all prerequisites are met, the field will default back to the standard rendering.
1043
+ */
1044
+ fieldEditStyle: /* was: sap.fe.macros.field.FieldAPI.FieldEditStyle */ any;
1045
+ /**
1046
+ * Defines if and how the field measure will be displayed.
1047
+ *
1048
+ * Allowed values are "Hidden" and "ReadOnly"
1049
+ */
1050
+ measureDisplayMode: string;
1051
+ /**
1052
+ * Specifies if radio buttons should be rendered in a horizontal layout.
1053
+ */
1054
+ radioButtonsHorizontalLayout: boolean;
635
1055
  /**
636
1056
  * Defines if the date part of a date time with timezone field should be shown.
637
1057
  *
@@ -741,11 +1161,11 @@ declare module "sap/fe/macros/field/FieldAPI" {
741
1161
  >;
742
1162
  }
743
1163
 
744
- declare module "sap/fe/macros/filterBar/FilterBarAPI" {
1164
+ declare module "sap/fe/macros/filterBar/FilterBar" {
745
1165
  import {
746
- default as MacroAPI,
747
- $MacroAPISettings,
748
- } from "sap/fe/macros/MacroAPI";
1166
+ default as BuildingBlockWithTemplating,
1167
+ $BuildingBlockWithTemplatingSettings,
1168
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
749
1169
 
750
1170
  import SelectionVariant from "sap/fe/navigation/SelectionVariant";
751
1171
 
@@ -759,19 +1179,25 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
759
1179
  import Event from "sap/ui/base/Event";
760
1180
 
761
1181
  /**
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
1182
  * Usage example:
768
1183
  *
769
1184
  * ```javascript
770
1185
  *
771
- * <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
1186
+ * sap.ui.require(["sap/fe/macros/filterBar/FilterBar"], function(FilterBar) {
1187
+ * ...
1188
+ * new FilterBar("MyFilterBar", {metaPath:"@com.sap.vocabularies.UI.v1.SelectionFields"})
1189
+ * })
772
1190
  * ```
1191
+ *
1192
+ * This is currently an experimental API because the structure of the generated content will change to come
1193
+ * closer to the FilterBar that you get out of templates.
1194
+ * The public method and property will not change but the internal structure will so be careful on your
1195
+ * usage.
1196
+ *
1197
+ *
1198
+ * @experimental
773
1199
  */
774
- export default class FilterBar extends MacroAPI {
1200
+ export default class FilterBar extends BuildingBlockWithTemplating {
775
1201
  /**
776
1202
  * Get the Active Filters Text Summary for the filter bar.
777
1203
  *
@@ -922,8 +1348,11 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
922
1348
  }
923
1349
  /**
924
1350
  * Describes the settings that can be provided to the FilterBar constructor.
1351
+ *
1352
+ * @experimental
925
1353
  */
926
- export interface $FilterBarSettings extends $MacroAPISettings {
1354
+ export interface $FilterBarSettings
1355
+ extends $BuildingBlockWithTemplatingSettings {
927
1356
  /**
928
1357
  * Defines the path of the context used in the current page or block.
929
1358
  * This setting is defined by the framework.
@@ -1005,234 +1434,534 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
1005
1434
  >;
1006
1435
  }
1007
1436
 
1008
- declare module "sap/fe/macros/filterBar/FilterField" {
1437
+ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
1009
1438
  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;
1439
+ default as MacroAPI,
1440
+ $MacroAPISettings,
1441
+ } from "sap/fe/macros/MacroAPI";
1046
1442
 
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
- }
1443
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
1053
1444
 
1054
- declare module "sap/fe/macros/form/Form.block" {
1055
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1445
+ import {
1446
+ PropertyBindingInfo,
1447
+ AggregationBindingInfo,
1448
+ } from "sap/ui/base/ManagedObject";
1056
1449
 
1057
- import Context from "sap/ui/model/Context";
1450
+ import FilterField from "sap/fe/macros/filterBar/FilterField";
1058
1451
 
1059
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1452
+ import Event from "sap/ui/base/Event";
1060
1453
 
1061
1454
  /**
1062
- * Building block for creating a Form based on the metadata provided by OData V4.
1455
+ * Building block for creating a FilterBar based on the metadata provided by OData V4.
1063
1456
  *
1064
1457
  *
1065
- * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
1066
- * or a CollectionFacet
1458
+ * Usually, a SelectionFields annotation is expected.
1067
1459
  *
1068
1460
  * Usage example:
1069
1461
  *
1070
1462
  * ```javascript
1071
1463
  *
1072
- * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
1464
+ * <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
1073
1465
  * ```
1074
1466
  */
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 {
1467
+ export default class FilterBar extends MacroAPI {
1080
1468
  /**
1081
- * Defines the path of the context used in the current page or block.
1082
- * This setting is defined by the framework.
1469
+ * Get the Active Filters Text Summary for the filter bar.
1470
+ *
1471
+ *
1472
+ * @returns Active filters summary as text
1083
1473
  */
1084
- contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1085
-
1474
+ getActiveFiltersText(): string;
1086
1475
  /**
1087
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
1476
+ * Gets the key of the current variant in the associated variant management.
1477
+ *
1478
+ *
1479
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1088
1480
  */
1089
- metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1090
-
1481
+ getCurrentVariantKey(): null | string;
1091
1482
  /**
1092
- * The title of the form control.
1483
+ * Determines whether the field is enabled or disabled.
1484
+ *
1485
+ *
1486
+ * @returns Whether the filterField is enabled or disabled.
1093
1487
  */
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 {
1488
+ getFilterFieldEnabled(
1489
+ /**
1490
+ * Name of the field.
1491
+ */
1492
+ name: string
1493
+ ): boolean;
1115
1494
  /**
1116
- * Defines the path of the context used in the current page or block.
1117
- * This setting is defined by the framework.
1495
+ * Gets the visibility of a filter field.
1496
+ *
1497
+ *
1498
+ * @returns A {@link Promise } that resolves to check whether the filter field is visible or not.
1118
1499
  */
1119
- contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1120
-
1500
+ getFilterFieldVisible(
1501
+ /**
1502
+ * The path to the property as a condition path
1503
+ */
1504
+ conditionPath: string
1505
+ ): Promise<boolean>;
1121
1506
  /**
1122
- * Label shown for the field. If not set, the label from the annotations will be shown.
1507
+ * Provides all the filters that are currently active
1508
+ * along with the search expression.
1509
+ *
1510
+ *
1511
+ * @returns An array of active filters and the search expression.
1123
1512
  */
1124
- label?: string | PropertyBindingInfo;
1125
-
1513
+ getFilters(): object;
1126
1514
  /**
1127
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
1515
+ * Get the selection variant from the filter bar.
1516
+ *
1517
+ *
1518
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1128
1519
  */
1129
- metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1130
-
1520
+ getSelectionVariant(): Promise<SelectionVariant>;
1131
1521
  /**
1132
- * If set to false, the FormElement is not rendered.
1522
+ * Sets the new selected variant in the associated variant management.
1133
1523
  */
1134
- visible?: boolean | PropertyBindingInfo | `{${string}}`;
1135
-
1524
+ setCurrentVariantKey(
1525
+ /**
1526
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
1527
+ * ignored.
1528
+ */
1529
+ key: string
1530
+ ): void;
1136
1531
  /**
1137
- * Optional aggregation of controls that should be displayed inside the FormElement.
1138
- * If not set, a default Field building block will be rendered
1532
+ * Sets the enablement of the field.
1139
1533
  */
1140
- fields?: Control;
1534
+ setFilterFieldEnabled(
1535
+ /**
1536
+ * Name of the field that should be enabled or disabled.
1537
+ */
1538
+ name: string,
1539
+ /**
1540
+ * Whether the field should be enabled or disabled.
1541
+ */
1542
+ enabled: boolean
1543
+ ): void;
1544
+ /**
1545
+ * Shows or hides any filter field from the filter bar.
1546
+ * The property will not be hidden inside the adaptation dialog and may be re-added.
1547
+ *
1548
+ *
1549
+ * @returns A {@link Promise } resolving once the change in visibility was applied
1550
+ */
1551
+ setFilterFieldVisible(
1552
+ /**
1553
+ * The path to the property as a condition path
1554
+ */
1555
+ conditionPath: string,
1556
+ /**
1557
+ * Whether it should be shown or hidden
1558
+ */
1559
+ visible: boolean
1560
+ ): Promise<void>;
1561
+ /**
1562
+ * Set the filter values for the given property in the filter bar.
1563
+ * The filter values can be either a single value or an array of values.
1564
+ * Each filter value must be represented as a primitive value.
1565
+ *
1566
+ *
1567
+ * @returns A promise for asynchronous handling
1568
+ */
1569
+ setFilterValues(
1570
+ /**
1571
+ * The path to the property as a condition path
1572
+ */
1573
+ sConditionPath: string,
1574
+ /**
1575
+ * The operator to be used (optional) - if not set, the default operator (EQ) will be used
1576
+ */
1577
+ sOperator: string | undefined,
1578
+ /**
1579
+ * The values to be applied
1580
+ */
1581
+ vValues?:
1582
+ | boolean
1583
+ | boolean[]
1584
+ | number
1585
+ | number[]
1586
+ | string
1587
+ | string[]
1588
+ | undefined
1589
+ ): Promise<void>;
1590
+ /**
1591
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
1592
+ * existing filters and then apply the SelectionVariant values.
1593
+ *
1594
+ *
1595
+ * @returns A promise for asynchronous handling
1596
+ */
1597
+ setSelectionVariant(
1598
+ /**
1599
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the filter bar
1600
+ */
1601
+ selectionVariant: SelectionVariant,
1602
+ /**
1603
+ * Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
1604
+ * to display the filter value descriptions, instead of loading them from the backend
1605
+ */
1606
+ prefillDescriptions?: boolean
1607
+ ): Promise<any>;
1608
+ /**
1609
+ * Triggers the API search on the filter bar.
1610
+ *
1611
+ *
1612
+ * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
1613
+ */
1614
+ triggerSearch(): Promise<object | undefined>;
1141
1615
  }
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
1616
  /**
1156
- * Describes the settings that can be provided to the KPITag constructor.
1617
+ * Describes the settings that can be provided to the FilterBar constructor.
1157
1618
  */
1158
- export interface $KPITagSettings extends $ControlSettings {
1619
+ export interface $FilterBarSettings extends $MacroAPISettings {
1159
1620
  /**
1160
- * The Number to be displayed.
1621
+ * Defines the path of the context used in the current page or block.
1622
+ * This setting is defined by the framework.
1161
1623
  */
1162
- number?: number | PropertyBindingInfo | `{${string}}`;
1624
+ contextPath?: string | PropertyBindingInfo;
1163
1625
 
1164
1626
  /**
1165
- * Set it to `true` if the KPI should display its status icon.
1627
+ * If true, the search is triggered automatically when a filter value is changed.
1166
1628
  */
1167
- showIcon?: boolean | PropertyBindingInfo | `{${string}}`;
1629
+ liveMode?: boolean | PropertyBindingInfo | `{${string}}`;
1168
1630
 
1169
1631
  /**
1170
- * The Status to be displayed.
1632
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
1171
1633
  */
1172
- status?: string | PropertyBindingInfo;
1634
+ metaPath?: string | PropertyBindingInfo;
1173
1635
 
1174
1636
  /**
1175
- * The Text to be displayed.
1637
+ * Handles the visibility of the 'Clear' button on the FilterBar.
1176
1638
  */
1177
- text?: string | PropertyBindingInfo;
1639
+ showClearButton?: boolean | PropertyBindingInfo | `{${string}}`;
1178
1640
 
1179
1641
  /**
1180
- * The Tooltip to be displayed.
1642
+ * Displays possible errors during the search in a message box
1181
1643
  */
1182
- tooltip?: string | PropertyBindingInfo;
1644
+ showMessages?: boolean | PropertyBindingInfo | `{${string}}`;
1183
1645
 
1184
1646
  /**
1185
- * The Unit of Measure of the number to be displayed.
1647
+ * Parameter which sets the visibility of the FilterBar building block
1186
1648
  */
1187
- unit?: string | PropertyBindingInfo;
1649
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1650
+
1651
+ /**
1652
+ * Aggregate filter fields of the FilterBar building block
1653
+ */
1654
+ filterFields?:
1655
+ | FilterField[]
1656
+ | FilterField
1657
+ | AggregationBindingInfo
1658
+ | `{${string}}`;
1188
1659
  }
1189
1660
 
1190
1661
  /**
1191
- * Parameters of the KPITag#press event.
1662
+ * Parameters of the FilterBar#afterClear event.
1192
1663
  */
1193
- export interface KPITag$PressEventParameters {}
1664
+ export interface FilterBar$AfterClearEventParameters {}
1194
1665
 
1195
1666
  /**
1196
- * Event object of the KPITag#press event.
1667
+ * Event object of the FilterBar#afterClear event.
1197
1668
  */
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";
1669
+ export type FilterBar$AfterClearEvent = Event<
1670
+ FilterBar$AfterClearEventParameters,
1671
+ FilterBar
1672
+ >;
1203
1673
 
1204
1674
  /**
1205
- * Building block used to create a MicroChart based on the metadata provided by OData V4.
1206
- *
1207
- * @since 1.93.0
1675
+ * Parameters of the FilterBar#filterChanged event.
1208
1676
  */
1209
- export default class MicroChart extends Control {}
1677
+ export interface FilterBar$FilterChangedEventParameters {}
1678
+
1210
1679
  /**
1211
- * Describes the settings that can be provided to the MicroChart constructor.
1680
+ * Event object of the FilterBar#filterChanged event.
1212
1681
  */
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";
1682
+ export type FilterBar$FilterChangedEvent = Event<
1683
+ FilterBar$FilterChangedEventParameters,
1684
+ FilterBar
1685
+ >;
1220
1686
 
1221
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1687
+ /**
1688
+ * Parameters of the FilterBar#search event.
1689
+ */
1690
+ export interface FilterBar$SearchEventParameters {}
1222
1691
 
1223
1692
  /**
1224
- * Building block for creating a MultiValueField based on the metadata provided by OData V4.
1225
- *
1226
- *
1227
- * The MultiValueField can be used to display either a DataField or Property directly. It has to point to
1228
- * a collection property.
1693
+ * Event object of the FilterBar#search event.
1694
+ */
1695
+ export type FilterBar$SearchEvent = Event<
1696
+ FilterBar$SearchEventParameters,
1697
+ FilterBar
1698
+ >;
1699
+ }
1700
+
1701
+ declare module "sap/fe/macros/filterBar/FilterField" {
1702
+ import {
1703
+ default as BuildingBlockObjectProperty,
1704
+ $BuildingBlockObjectPropertySettings,
1705
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
1706
+
1707
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1708
+
1709
+ /**
1710
+ * Definition of a custom filter to be used inside the FilterBar.
1711
+ * The template for the FilterField has to be provided as the default aggregation
1712
+ */
1713
+ export default class FilterField extends BuildingBlockObjectProperty {}
1714
+ /**
1715
+ * Describes the settings that can be provided to the FilterField constructor.
1716
+ */
1717
+ export interface $FilterFieldSettings
1718
+ extends $BuildingBlockObjectPropertySettings {
1719
+ /**
1720
+ * Reference to the key of another filter already displayed in the table to properly place this one
1721
+ */
1722
+ anchor?: string | PropertyBindingInfo;
1723
+
1724
+ /**
1725
+ * The property name of the FilterField
1726
+ */
1727
+ key?: string | PropertyBindingInfo;
1728
+
1729
+ /**
1730
+ * The text that will be displayed for this FilterField
1731
+ */
1732
+ label?: string | PropertyBindingInfo;
1733
+
1734
+ /**
1735
+ * Defines where this filter should be placed relative to the defined anchor
1736
+ * Allowed values are `Before` and `After`
1737
+ */
1738
+ placement?: string | PropertyBindingInfo;
1739
+
1740
+ /**
1741
+ * If set, possible errors that occur during the search will be displayed in a message box.
1742
+ */
1743
+ showMessages?: boolean | PropertyBindingInfo | `{${string}}`;
1744
+ }
1745
+ }
1746
+
1747
+ declare module "sap/fe/macros/form/Form.block" {
1748
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1749
+
1750
+ import Context from "sap/ui/model/Context";
1751
+
1752
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1753
+
1754
+ /**
1755
+ * Building block for creating a Form based on the metadata provided by OData V4.
1756
+ *
1757
+ *
1758
+ * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
1759
+ * or a CollectionFacet
1760
+ *
1761
+ * Usage example:
1762
+ *
1763
+ * ```javascript
1764
+ *
1765
+ * <macros:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
1766
+ * ```
1767
+ */
1768
+ export default class Form extends Control {}
1769
+ /**
1770
+ * Describes the settings that can be provided to the Form constructor.
1771
+ */
1772
+ export interface $FormSettings extends $ControlSettings {
1773
+ /**
1774
+ * Defines the path of the context used in the current page or block.
1775
+ * This setting is defined by the framework.
1776
+ */
1777
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1778
+
1779
+ /**
1780
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
1781
+ */
1782
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1783
+
1784
+ /**
1785
+ * The title of the form control.
1786
+ */
1787
+ title?: string | PropertyBindingInfo;
1788
+ }
1789
+ }
1790
+
1791
+ declare module "sap/fe/macros/form/FormElement.block" {
1792
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1793
+
1794
+ import Context from "sap/ui/model/Context";
1795
+
1796
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1797
+
1798
+ /**
1799
+ * Building block used to create a form element based on the metadata provided by OData V4.
1800
+ *
1801
+ * @since 1.90.0
1802
+ */
1803
+ export default class FormElement extends Control {}
1804
+ /**
1805
+ * Describes the settings that can be provided to the FormElement constructor.
1806
+ */
1807
+ export interface $FormElementSettings extends $ControlSettings {
1808
+ /**
1809
+ * Defines the path of the context used in the current page or block.
1810
+ * This setting is defined by the framework.
1811
+ */
1812
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
1813
+
1814
+ /**
1815
+ * Label shown for the field. If not set, the label from the annotations will be shown.
1816
+ */
1817
+ label?: string | PropertyBindingInfo;
1818
+
1819
+ /**
1820
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
1821
+ */
1822
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
1823
+
1824
+ /**
1825
+ * If set to false, the FormElement is not rendered.
1826
+ */
1827
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1828
+
1829
+ /**
1830
+ * Optional aggregation of controls that should be displayed inside the FormElement.
1831
+ * If not set, a default Field building block will be rendered
1832
+ */
1833
+ fields?: Control;
1834
+ }
1835
+ }
1836
+
1837
+ declare module "sap/fe/macros/kpiTag/KPITag.block" {
1838
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1839
+
1840
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1841
+
1842
+ import Event from "sap/ui/base/Event";
1843
+
1844
+ /**
1845
+ * Building block used to create a KPI tag.
1846
+ */
1847
+ export default class KPITag extends Control {}
1848
+ /**
1849
+ * Describes the settings that can be provided to the KPITag constructor.
1850
+ */
1851
+ export interface $KPITagSettings extends $ControlSettings {
1852
+ /**
1853
+ * The Number to be displayed.
1854
+ */
1855
+ number?: number | PropertyBindingInfo | `{${string}}`;
1856
+
1857
+ /**
1858
+ * Set it to `true` if the KPI should display its status icon.
1859
+ */
1860
+ showIcon?: boolean | PropertyBindingInfo | `{${string}}`;
1861
+
1862
+ /**
1863
+ * The Status to be displayed.
1864
+ */
1865
+ status?: string | PropertyBindingInfo;
1866
+
1867
+ /**
1868
+ * The Text to be displayed.
1869
+ */
1870
+ text?: string | PropertyBindingInfo;
1871
+
1872
+ /**
1873
+ * The Tooltip to be displayed.
1874
+ */
1875
+ tooltip?: string | PropertyBindingInfo;
1876
+
1877
+ /**
1878
+ * The Unit of Measure of the number to be displayed.
1879
+ */
1880
+ unit?: string | PropertyBindingInfo;
1881
+ }
1882
+
1883
+ /**
1884
+ * Parameters of the KPITag#press event.
1885
+ */
1886
+ export interface KPITag$PressEventParameters {}
1887
+
1888
+ /**
1889
+ * Event object of the KPITag#press event.
1890
+ */
1891
+ export type KPITag$PressEvent = Event<KPITag$PressEventParameters, KPITag>;
1892
+ }
1893
+
1894
+ declare module "sap/fe/macros/microchart/MicroChart.block" {
1895
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1896
+
1897
+ /**
1898
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
1899
+ *
1900
+ * @since 1.93.0
1901
+ */
1902
+ export default class MicroChart extends Control {}
1903
+ /**
1904
+ * Describes the settings that can be provided to the MicroChart constructor.
1905
+ */
1906
+ export interface $MicroChartSettings extends $ControlSettings {}
1907
+ }
1908
+
1909
+ declare module "sap/fe/macros/microchart/MicroChart" {
1910
+ import {
1911
+ default as BuildingBlockWithTemplating,
1912
+ $BuildingBlockWithTemplatingSettings,
1913
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
1914
+
1915
+ /**
1916
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
1917
+ * Usage example:
1918
+ *
1919
+ * ```javascript
1920
+ *
1921
+ * sap.ui.require(["sap/fe/macros/microchart/MicroChart"], function(MicroChart) {
1922
+ * ...
1923
+ * new MicroChart("microChartID", {metaPath:"MyProperty"})
1924
+ * })
1925
+ * ```
1926
+ *
1927
+ * This is currently an experimental API because the structure of the generated content will change to come
1928
+ * closer to the MicroChart that you get out of templates.
1929
+ * The public method and property will not change but the internal structure will so be careful on your
1930
+ * usage.
1931
+ *
1932
+ *
1933
+ * @experimental
1934
+ */
1935
+ export default class MicroChart extends BuildingBlockWithTemplating {}
1936
+ /**
1937
+ * Describes the settings that can be provided to the MicroChart constructor.
1938
+ *
1939
+ * @experimental
1940
+ */
1941
+ export interface $MicroChartSettings
1942
+ extends $BuildingBlockWithTemplatingSettings {}
1943
+ }
1944
+
1945
+ declare module "sap/fe/macros/multiValueField/MultiValueField.block" {
1946
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1947
+
1948
+ import Context from "sap/ui/model/Context";
1949
+
1950
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1951
+
1952
+ /**
1953
+ * Building block for creating a MultiValueField based on the metadata provided by OData V4.
1954
+ *
1955
+ *
1956
+ * The MultiValueField can be used to display either a DataField or Property directly. It has to point to
1957
+ * a collection property.
1229
1958
  *
1230
1959
  *
1231
1960
  * Usage example:
1232
1961
  *
1233
1962
  * ```javascript
1234
1963
  *
1235
- * <macro:MultiValueField
1964
+ * <macros:MultiValueField
1236
1965
  * id="SomeUniqueIdentifier"
1237
1966
  * contextPath="{entitySet>}"
1238
1967
  * metaPath="{dataField>}"
@@ -1279,7 +2008,7 @@ declare module "sap/fe/macros/paginator/Paginator.block" {
1279
2008
  *
1280
2009
  * ```javascript
1281
2010
  *
1282
- * <macro:Paginator />
2011
+ * <macros:Paginator />
1283
2012
  * ```
1284
2013
  *
1285
2014
  *
@@ -1368,217 +2097,1239 @@ declare module "sap/fe/macros/richtexteditor/RichTextEditorWithMetadata.block" {
1368
2097
  import Context from "sap/ui/model/Context";
1369
2098
 
1370
2099
  /**
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
- *
2100
+ * Metadata-driven building block that exposes the RichTextEditor UI5 control.
2101
+ * It's used to enter formatted text and uses the third-party component called TinyMCE.
2102
+ *
2103
+ *
2104
+ * @since 1.117.0
2105
+ */
2106
+ export default class RichTextEditorWithMetadata extends Control {}
2107
+ /**
2108
+ * Describes the settings that can be provided to the RichTextEditorWithMetadata constructor.
2109
+ */
2110
+ export interface $RichTextEditorWithMetadataSettings
2111
+ extends $ControlSettings {
2112
+ /**
2113
+ * With the 'buttonGroups' attribute, you can customize the buttons that are displayed on the toolbar of
2114
+ * the editor.
2115
+ */
2116
+ buttonGroups?: any[] | PropertyBindingInfo | `{${string}}`;
2117
+
2118
+ /**
2119
+ * The context path of the property displayed
2120
+ */
2121
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
2122
+
2123
+ /**
2124
+ * With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default
2125
+ * The default plugins are "emoticons" "directionality" "image" "table" "link" "powerpaste".
2126
+ */
2127
+ excludeDefaultPlugins?: boolean | PropertyBindingInfo | `{${string}}`;
2128
+
2129
+ /**
2130
+ * The metaPath of the displayed property
2131
+ */
2132
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
2133
+
2134
+ /**
2135
+ * With the 'plugins' attribute you can customize the plugins that will be loaded by the editor.
2136
+ */
2137
+ plugins?: any[] | PropertyBindingInfo | `{${string}}`;
2138
+
2139
+ /**
2140
+ * Use the readOnly attribute to override the edit flow of the page.
2141
+ * By setting 'readOnly' to true, a FormattedText is displayed instead of the editor.
2142
+ */
2143
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
2144
+
2145
+ /**
2146
+ * Use the 'required' attribute, to make sure that the editor is filled with some text.
2147
+ */
2148
+ required?: boolean | PropertyBindingInfo | `{${string}}`;
2149
+ }
2150
+ }
2151
+
2152
+ declare module "sap/fe/macros/share/Share.block" {
2153
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
2154
+
2155
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2156
+
2157
+ /**
2158
+ * Building block used to create the ‘Share’ functionality.
2159
+ *
2160
+ *
2161
+ * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
2162
+ * SAP Jam.
2163
+ *
2164
+ *
2165
+ * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
2166
+ * the 'Save as Tile' option is not visible.
2167
+ *
2168
+ * Usage example:
2169
+ *
2170
+ * ```javascript
2171
+ *
2172
+ * <macros:Share
2173
+ * id="someID"
2174
+ * visible="true"
2175
+ * />
2176
+ * ```
2177
+ *
2178
+ *
2179
+ *
2180
+ * @since 1.93.0
2181
+ */
2182
+ export default class Share extends Control {}
2183
+ /**
2184
+ * Share Options.
2185
+ */
2186
+ export type ShareOptions = {};
2187
+
2188
+ /**
2189
+ * Describes the settings that can be provided to the Share constructor.
2190
+ */
2191
+ export interface $ShareSettings extends $ControlSettings {
2192
+ /**
2193
+ * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
2194
+ */
2195
+ shareOptions?: object | PropertyBindingInfo | `{${string}}`;
2196
+
2197
+ /**
2198
+ * Whether the share control should be visible on the screen.
2199
+ */
2200
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
2201
+ }
2202
+ }
2203
+
2204
+ declare module "sap/fe/macros/table/Action" {
2205
+ import {
2206
+ default as BuildingBlockObjectProperty,
2207
+ $BuildingBlockObjectPropertySettings,
2208
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
2209
+
2210
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2211
+
2212
+ /**
2213
+ * Definition of a custom action to be used inside the table toolbar
2214
+ */
2215
+ export default class Action extends BuildingBlockObjectProperty {}
2216
+ /**
2217
+ * Describes the settings that can be provided to the Action constructor.
2218
+ */
2219
+ export interface $ActionSettings
2220
+ extends $BuildingBlockObjectPropertySettings {
2221
+ /**
2222
+ * Reference to the key of another action already displayed in the toolbar to properly place this one
2223
+ */
2224
+ anchor?: string | PropertyBindingInfo;
2225
+
2226
+ /**
2227
+ * Enables or disables the action
2228
+ */
2229
+ enabled?: boolean | PropertyBindingInfo | `{${string}}`;
2230
+
2231
+ /**
2232
+ * Unique identifier of the action
2233
+ */
2234
+ key?: string | PropertyBindingInfo;
2235
+
2236
+ /**
2237
+ * Defines where this action should be placed relative to the defined anchor
2238
+ * Allowed values are `Before` and `After`
2239
+ */
2240
+ placement?: string | PropertyBindingInfo;
2241
+
2242
+ /**
2243
+ * Event handler to be called when the user chooses the action
2244
+ */
2245
+ press?: string | PropertyBindingInfo;
2246
+
2247
+ /**
2248
+ * Defines if the action requires a selection.
2249
+ */
2250
+ requiresSelection?: boolean | PropertyBindingInfo | `{${string}}`;
2251
+
2252
+ /**
2253
+ * The text that will be displayed for this action
2254
+ */
2255
+ text?: string | PropertyBindingInfo;
2256
+ }
2257
+ }
2258
+
2259
+ declare module "sap/fe/macros/table/ActionGroup" {
2260
+ import {
2261
+ default as BuildingBlockObjectProperty,
2262
+ $BuildingBlockObjectPropertySettings,
2263
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
2264
+
2265
+ import {
2266
+ PropertyBindingInfo,
2267
+ AggregationBindingInfo,
2268
+ } from "sap/ui/base/ManagedObject";
2269
+
2270
+ import Action from "sap/fe/macros/table/Action";
2271
+
2272
+ /**
2273
+ * Definition of a custom ActionGroup to be used inside the table toolbar
2274
+ */
2275
+ export default class ActionGroup extends BuildingBlockObjectProperty {}
2276
+ /**
2277
+ * Describes the settings that can be provided to the ActionGroup constructor.
2278
+ */
2279
+ export interface $ActionGroupSettings
2280
+ extends $BuildingBlockObjectPropertySettings {
2281
+ /**
2282
+ * Reference to the key of another action or action group already displayed in the toolbar to properly place
2283
+ * this one
2284
+ */
2285
+ anchor?: string | PropertyBindingInfo;
2286
+
2287
+ /**
2288
+ * Unique identifier of the ActionGroup
2289
+ */
2290
+ key?: string | PropertyBindingInfo;
2291
+
2292
+ /**
2293
+ * Defines where this action group should be placed relative to the defined anchor
2294
+ * Allowed values are `Before` and `After`
2295
+ */
2296
+ placement?: string | PropertyBindingInfo;
2297
+
2298
+ /**
2299
+ * The text that will be displayed for this action group
2300
+ */
2301
+ text?: string | PropertyBindingInfo;
2302
+
2303
+ /**
2304
+ * Defines nested actions
2305
+ */
2306
+ actions?: Action[] | Action | AggregationBindingInfo | `{${string}}`;
2307
+ }
2308
+ }
2309
+
2310
+ declare module "sap/fe/macros/table/Column" {
2311
+ import {
2312
+ default as BuildingBlockObjectProperty,
2313
+ $BuildingBlockObjectPropertySettings,
2314
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
2315
+
2316
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2317
+
2318
+ /**
2319
+ * Definition of a custom column to be used inside the table.
2320
+ * The template for the column has to be provided as the default aggregation
2321
+ */
2322
+ export default class Column extends BuildingBlockObjectProperty {}
2323
+ /**
2324
+ * Describes the settings that can be provided to the Column constructor.
2325
+ */
2326
+ export interface $ColumnSettings
2327
+ extends $BuildingBlockObjectPropertySettings {
2328
+ /**
2329
+ * Reference to the key of another column already displayed in the table to properly place this one
2330
+ */
2331
+ anchor?: string | PropertyBindingInfo;
2332
+
2333
+ /**
2334
+ * The text that will be displayed for this column header
2335
+ */
2336
+ header?: string | PropertyBindingInfo;
2337
+
2338
+ /**
2339
+ * Aligns the header as well as the content horizontally
2340
+ */
2341
+ horizontalAlign?: string | PropertyBindingInfo;
2342
+
2343
+ /**
2344
+ * Defines the column importance.
2345
+ * You can define which columns should be automatically moved to the pop-in area based on their importance
2346
+ */
2347
+ importance?: string | PropertyBindingInfo;
2348
+
2349
+ /**
2350
+ * Unique identifier of the column
2351
+ */
2352
+ key?: string | PropertyBindingInfo;
2353
+
2354
+ /**
2355
+ * Defines where this column should be placed relative to the defined anchor
2356
+ * Allowed values are `Before` and `After`
2357
+ */
2358
+ placement?: string | PropertyBindingInfo;
2359
+
2360
+ /**
2361
+ * Defines the column's width.
2362
+ * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
2363
+ */
2364
+ width?: string | PropertyBindingInfo;
2365
+
2366
+ /**
2367
+ * Indicates if the column header should be a part of the width calculation.
2368
+ */
2369
+ widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
2370
+ }
2371
+ }
2372
+
2373
+ declare module "sap/fe/macros/table/Table.block" {
2374
+ import {
2375
+ default as MacroAPI,
2376
+ $MacroAPISettings,
2377
+ } from "sap/fe/macros/MacroAPI";
2378
+
2379
+ import { MessageType } from "sap/ui/core/library";
2380
+
2381
+ import PresentationVariant from "sap/fe/navigation/PresentationVariant";
2382
+
2383
+ import Context from "sap/ui/model/odata/v4/Context";
2384
+
2385
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
2386
+
2387
+ import {
2388
+ PropertyBindingInfo,
2389
+ AggregationBindingInfo,
2390
+ } from "sap/ui/base/ManagedObject";
2391
+
2392
+ import TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
2393
+
2394
+ import ActionGroup from "sap/fe/macros/table/ActionGroup";
2395
+
2396
+ import Action from "sap/fe/macros/table/Action";
2397
+
2398
+ import Column from "sap/fe/macros/table/Column";
2399
+
2400
+ import Event from "sap/ui/base/Event";
2401
+
2402
+ /**
2403
+ * Building block used to create a table based on the metadata provided by OData V4.
2404
+ *
2405
+ *
2406
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
2407
+ * the Table building block can also be used to display an EntitySet.
2408
+ *
2409
+ *
2410
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
2411
+ *
2412
+ *
2413
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
2414
+ * also has a UI.LineItem as the first property of the Visualizations.
2415
+ * Usage example:
2416
+ *
2417
+ * ```javascript
2418
+ *
2419
+ * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
2420
+ * ```
2421
+ */
2422
+ export default class Table extends MacroAPI {
2423
+ /**
2424
+ * Adds a message to the table.
2425
+ * The message applies to the whole table and not to an individual table row.
2426
+ *
2427
+ *
2428
+ *
2429
+ * @returns The ID of the message
2430
+ */
2431
+ addMessage(
2432
+ /**
2433
+ * The parameters to create the message
2434
+ */
2435
+ parameters: {
2436
+ /**
2437
+ * Message description
2438
+ */
2439
+ description?: string;
2440
+ /**
2441
+ * Message text
2442
+ */
2443
+ message?: string;
2444
+ /**
2445
+ * True if the message is persistent
2446
+ */
2447
+ persistent?: boolean;
2448
+ /**
2449
+ * Message type
2450
+ */
2451
+ type?: MessageType;
2452
+ }
2453
+ ): string;
2454
+ /**
2455
+ * Get the variant management applied to the table.
2456
+ *
2457
+ *
2458
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
2459
+ */
2460
+ getCurrentVariantKey(): null | string;
2461
+ /**
2462
+ * Get the fields that should be ignored when generating the table.
2463
+ *
2464
+ * @since 1.124.0
2465
+ * @experimental (since 1.124.0)
2466
+ *
2467
+ * @returns The value of the ignoredFields property
2468
+ */
2469
+ getIgnoredFields(): string;
2470
+ /**
2471
+ * Get the presentation variant that is currently applied on the table.
2472
+ *
2473
+ *
2474
+ * @returns The presentation variant applied to the table
2475
+ */
2476
+ getPresentationVariant(): Promise<PresentationVariant>;
2477
+ /**
2478
+ * Gets contexts from the table that have been selected by the user.
2479
+ *
2480
+ *
2481
+ * @returns Contexts of the rows selected by the user
2482
+ */
2483
+ getSelectedContexts(): Context[];
2484
+ /**
2485
+ * Get the selection variant from the Table.
2486
+ *
2487
+ *
2488
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
2489
+ */
2490
+ getSelectionVariant(): Promise<SelectionVariant>;
2491
+ /**
2492
+ * Hide the columns with the given column keys by setting their availability to Default.
2493
+ *
2494
+ * @since 1.124.0
2495
+ * @experimental (since 1.124.0)
2496
+ *
2497
+ * @returns Promise
2498
+ */
2499
+ hideColumns(
2500
+ /**
2501
+ * The keys for the columns to hide
2502
+ */
2503
+ columnKeys: string[]
2504
+ ): Promise<void>;
2505
+ /**
2506
+ * Requests a refresh of the table.
2507
+ */
2508
+ refresh(): void;
2509
+ /**
2510
+ * Removes a message from the table.
2511
+ */
2512
+ removeMessage(
2513
+ /**
2514
+ * The id of the message
2515
+ */
2516
+ id: string
2517
+ ): void;
2518
+ /**
2519
+ * Set a variant management to the table.
2520
+ */
2521
+ setCurrentVariantKey(
2522
+ /**
2523
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
2524
+ * ignored.
2525
+ */
2526
+ key: string
2527
+ ): void;
2528
+ /**
2529
+ * Sets the fields that should be ignored when generating the table.
2530
+ *
2531
+ * @since 1.124.0
2532
+ * @experimental (since 1.124.0)
2533
+ *
2534
+ * @returns Reference to this in order to allow method chaining
2535
+ */
2536
+ setIgnoredFields(
2537
+ /**
2538
+ * The fields to ignore
2539
+ */
2540
+ ignoredFields: string
2541
+ ): this;
2542
+ /**
2543
+ * Set a new presentation variant to the table.
2544
+ */
2545
+ setPresentationVariant(
2546
+ /**
2547
+ * The new presentation variant that is to be set on the table.
2548
+ */
2549
+ tablePV: PresentationVariant
2550
+ ): Promise<void>;
2551
+ /**
2552
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
2553
+ * filters and then apply the SelectionVariant values.
2554
+ *
2555
+ *
2556
+ * @returns A promise for asynchronous handling
2557
+ */
2558
+ setSelectionVariant(
2559
+ /**
2560
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
2561
+ */
2562
+ selectionVariant: SelectionVariant,
2563
+ /**
2564
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
2565
+ * to display the filter value descriptions, instead of loading them from the backend
2566
+ */
2567
+ prefillDescriptions?: boolean
2568
+ ): Promise<any>;
2569
+ /**
2570
+ * Show the columns with the given column keys by setting their availability to Default.
2571
+ *
2572
+ * @since 1.124.0
2573
+ * @experimental (since 1.124.0)
2574
+ *
2575
+ * @returns Promise
2576
+ */
2577
+ showColumns(
2578
+ /**
2579
+ * The keys for the columns to show
2580
+ */
2581
+ columnKeys: string[]
2582
+ ): Promise<void>;
2583
+ }
2584
+ /**
2585
+ * Describes the settings that can be provided to the Table constructor.
2586
+ */
2587
+ export interface $TableSettings extends $MacroAPISettings {
2588
+ /**
2589
+ * An expression that allows you to control the 'busy' state of the table.
2590
+ */
2591
+ busy?: boolean | PropertyBindingInfo | `{${string}}`;
2592
+
2593
+ /**
2594
+ * Defines the path of the context used in the current page or block.
2595
+ * This setting is defined by the framework.
2596
+ */
2597
+ contextPath?: string | PropertyBindingInfo;
2598
+
2599
+ /**
2600
+ * A set of options that can be configured.
2601
+ */
2602
+ creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
2603
+
2604
+ /**
2605
+ * Controls if the copy functionality of the table is disabled or not.
2606
+ */
2607
+ disableCopyToClipboard?: boolean | PropertyBindingInfo | `{${string}}`;
2608
+
2609
+ /**
2610
+ * Specifies if the column width is automatically calculated.
2611
+ */
2612
+ enableAutoColumnWidth?: boolean | PropertyBindingInfo | `{${string}}`;
2613
+
2614
+ /**
2615
+ * Controls if the export functionality of the table is enabled or not.
2616
+ */
2617
+ enableExport?: boolean | PropertyBindingInfo | `{${string}}`;
2618
+
2619
+ /**
2620
+ * Controls whether the table can be opened in fullscreen mode or not.
2621
+ */
2622
+ enableFullScreen?: boolean | PropertyBindingInfo | `{${string}}`;
2623
+
2624
+ /**
2625
+ * Controls if the paste functionality of the table is enabled or not.
2626
+ */
2627
+ enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
2628
+
2629
+ /**
2630
+ * Maximum allowed number of records to be exported in one request.
2631
+ */
2632
+ exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
2633
+
2634
+ /**
2635
+ * ID of the FilterBar building block associated with the table.
2636
+ */
2637
+ filterBar?: string | PropertyBindingInfo;
2638
+
2639
+ /**
2640
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
2641
+ * This property is not relevant for responsive tables
2642
+ */
2643
+ frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
2644
+
2645
+ /**
2646
+ * Specifies the header text that is shown in the table.
2647
+ */
2648
+ header?: string | PropertyBindingInfo;
2649
+
2650
+ /**
2651
+ * Controls if the header text should be shown or not.
2652
+ */
2653
+ headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
2654
+
2655
+ /**
2656
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
2657
+ *
2658
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
2659
+ * value of fields that are provided in the ignoredfields.
2660
+ *
2661
+ * Any column referencing an ignored field is to be removed.
2662
+ */
2663
+ ignoredFields?: string | PropertyBindingInfo;
2664
+
2665
+ /**
2666
+ * Defines whether to display the search action.
2667
+ */
2668
+ isSearchable?: boolean | PropertyBindingInfo | `{${string}}`;
2669
+
2670
+ /**
2671
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
2672
+ * based on the current contextPath.
2673
+ */
2674
+ metaPath?: string | PropertyBindingInfo;
2675
+
2676
+ /**
2677
+ * Controls which options should be enabled for the table personalization dialog.
2678
+ * If it is set to `true`, all possible options for this kind of table are enabled.
2679
+ *
2680
+ * If it is set to `false`, personalization is disabled.
2681
+ *
2682
+ *
2683
+ *
2684
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
2685
+ * with the options you want to be available.
2686
+ *
2687
+ * Available options are:
2688
+ *
2689
+ * - Sort
2690
+ *
2691
+ * - Column
2692
+ *
2693
+ * - Filter
2694
+ */
2695
+ personalization?: string | PropertyBindingInfo;
2696
+
2697
+ /**
2698
+ * An expression that allows you to control the 'read-only' state of the table.
2699
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
2700
+ * current state.
2701
+ */
2702
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
2703
+
2704
+ /**
2705
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
2706
+ */
2707
+ rowCount?: int | PropertyBindingInfo | `{${string}}`;
2708
+
2709
+ /**
2710
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
2711
+ * Allowed values are `Auto`, `Fixed`.
2712
+ *
2713
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
2714
+ *
2715
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
2716
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
2717
+ * less than defined in the `rowCount` property.
2718
+ */
2719
+ rowCountMode?: string | PropertyBindingInfo;
2720
+
2721
+ /**
2722
+ * Defines the selection mode to be used by the table.
2723
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
2724
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
2725
+ * the consistent selection mode.
2726
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
2727
+ * Fiori guidelines.
2728
+ */
2729
+ selectionMode?: string | PropertyBindingInfo;
2730
+
2731
+ /**
2732
+ * Defines the type of table that will be used by the building block to render the data.
2733
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
2734
+ */
2735
+ type?: string | PropertyBindingInfo;
2736
+
2737
+ /**
2738
+ * Controls the kind of variant management that should be enabled for the table.
2739
+ * Allowed value is `Control`.
2740
+ *
2741
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
2742
+ * to this.
2743
+ *
2744
+ * If not set with any value, control level variant management is not available for this table.
2745
+ */
2746
+ variantManagement?: string | PropertyBindingInfo;
2747
+
2748
+ /**
2749
+ * Indicates if the column header should be a part of the width calculation.
2750
+ */
2751
+ widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
2752
+
2753
+ /**
2754
+ * Aggregate actions of the table.
2755
+ */
2756
+ actions?:
2757
+ | Array<ActionGroup | Action>
2758
+ | ActionGroup
2759
+ | Action
2760
+ | AggregationBindingInfo
2761
+ | `{${string}}`;
2762
+
2763
+ /**
2764
+ * Aggregate columns of the table.
2765
+ */
2766
+ columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
2767
+ }
2768
+
2769
+ /**
2770
+ * Parameters of the Table#beforeRebindTable event.
2771
+ */
2772
+ export interface Table$BeforeRebindTableEventParameters {}
2773
+
2774
+ /**
2775
+ * Event object of the Table#beforeRebindTable event.
2776
+ */
2777
+ export type Table$BeforeRebindTableEvent = Event<
2778
+ Table$BeforeRebindTableEventParameters,
2779
+ Table
2780
+ >;
2781
+
2782
+ /**
2783
+ * Parameters of the Table#rowPress event.
2784
+ */
2785
+ export interface Table$RowPressEventParameters {}
2786
+
2787
+ /**
2788
+ * Event object of the Table#rowPress event.
2789
+ */
2790
+ export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
2791
+
2792
+ /**
2793
+ * Parameters of the Table#selectionChange event.
2794
+ */
2795
+ export interface Table$SelectionChangeEventParameters {}
2796
+
2797
+ /**
2798
+ * Event object of the Table#selectionChange event.
2799
+ */
2800
+ export type Table$SelectionChangeEvent = Event<
2801
+ Table$SelectionChangeEventParameters,
2802
+ Table
2803
+ >;
2804
+ }
2805
+
2806
+ declare module "sap/fe/macros/table/Table" {
2807
+ import {
2808
+ default as BuildingBlockWithTemplating,
2809
+ $BuildingBlockWithTemplatingSettings,
2810
+ } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
2811
+
2812
+ import Action from "sap/fe/macros/table/Action";
2813
+
2814
+ import Column from "sap/fe/macros/table/Column";
2815
+
2816
+ import { MessageType } from "sap/ui/core/library";
2817
+
2818
+ import PresentationVariant from "sap/fe/navigation/PresentationVariant";
2819
+
2820
+ import Context from "sap/ui/model/odata/v4/Context";
2821
+
2822
+ import SelectionVariant from "sap/fe/navigation/SelectionVariant";
2823
+
2824
+ import {
2825
+ PropertyBindingInfo,
2826
+ AggregationBindingInfo,
2827
+ } from "sap/ui/base/ManagedObject";
2828
+
2829
+ import TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
2830
+
2831
+ import ActionGroup from "sap/fe/macros/table/ActionGroup";
2832
+
2833
+ import Event from "sap/ui/base/Event";
2834
+
2835
+ /**
2836
+ * Building block used to create a table based on the metadata provided by OData V4.
2837
+ *
2838
+ *
2839
+ * Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
2840
+ * the Table building block can also be used to display an EntitySet.
2841
+ *
2842
+ *
2843
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
2844
+ *
2845
+ *
2846
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
2847
+ * also has a UI.LineItem as the first property of the Visualizations.
2848
+ * Usage example:
2849
+ *
2850
+ * ```javascript
2851
+ *
2852
+ * sap.ui.require(["sap/fe/macros/table/Table"], function(Table) {
2853
+ * ...
2854
+ * new Table("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
2855
+ * })
2856
+ * ```
2857
+ *
2858
+ * This is currently an experimental API because the structure of the generated content will change to come
2859
+ * closer to the Table that you get out of templates.
2860
+ * The public method and property will not change but the internal structure will so be careful on your
2861
+ * usage.
2862
+ *
2863
+ *
2864
+ * @since 1.124.0
2865
+ * @experimental (since 1.124.0)
2866
+ */
2867
+ export default class Table extends BuildingBlockWithTemplating {
2868
+ /**
2869
+ * Adds an action to the table.
2870
+ *
2871
+ * @since 1.124.0
2872
+ * @experimental (since 1.124.0)
2873
+ *
2874
+ * @returns Reference to this in order to allow method chaining
2875
+ */
2876
+ addAction(
2877
+ /**
2878
+ * The action to add
2879
+ */
2880
+ action: Action
2881
+ ): this;
2882
+ /**
2883
+ * Adds a column to the table.
2884
+ *
2885
+ * @since 1.124.0
2886
+ * @experimental (since 1.124.0)
2887
+ *
2888
+ * @returns Reference to this in order to allow method chaining
2889
+ */
2890
+ addColumn(
2891
+ /**
2892
+ * The column to add
2893
+ */
2894
+ column: Column
2895
+ ): this;
2896
+ /**
2897
+ * Adds a message to the table.
2898
+ * The message applies to the whole table and not to an individual table row.
2899
+ *
2900
+ *
2901
+ *
2902
+ * @returns The ID of the message
2903
+ */
2904
+ addMessage(
2905
+ /**
2906
+ * The parameters to create the message
2907
+ */
2908
+ parameters: {
2909
+ /**
2910
+ * Message description
2911
+ */
2912
+ description?: string;
2913
+ /**
2914
+ * Message text
2915
+ */
2916
+ message?: string;
2917
+ /**
2918
+ * True if the message is persistent
2919
+ */
2920
+ persistent?: boolean;
2921
+ /**
2922
+ * Message type
2923
+ */
2924
+ type?: MessageType;
2925
+ }
2926
+ ): string;
2927
+ /**
2928
+ * Get the variant management applied to the table.
2929
+ *
2930
+ *
2931
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
2932
+ */
2933
+ getCurrentVariantKey(): null | string;
2934
+ /**
2935
+ * Get the fields that should be ignored when generating the table.
2936
+ *
2937
+ * @since 1.124.0
2938
+ * @experimental (since 1.124.0)
2939
+ *
2940
+ * @returns The value of the ignoredFields property
2941
+ */
2942
+ getIgnoredFields(): string;
2943
+ /**
2944
+ * Gets the path to the metadata that should be used to generate the table.
2945
+ *
2946
+ * @since 1.124.0
2947
+ * @experimental (since 1.124.0)
2948
+ *
2949
+ * @returns The path to the metadata
2950
+ */
2951
+ getMetaPath(): string;
2952
+ /**
2953
+ * Get the presentation variant that is currently applied on the table.
2954
+ *
2955
+ *
2956
+ * @returns The presentation variant applied to the table
2957
+ */
2958
+ getPresentationVariant(): Promise<PresentationVariant>;
2959
+ /**
2960
+ * Gets contexts from the table that have been selected by the user.
2961
+ *
2962
+ *
2963
+ * @returns Contexts of the rows selected by the user
2964
+ */
2965
+ getSelectedContexts(): Context[];
2966
+ /**
2967
+ * Get the selection variant from the Table.
2968
+ *
2969
+ *
2970
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
2971
+ */
2972
+ getSelectionVariant(): Promise<SelectionVariant>;
2973
+ /**
2974
+ * Hide the columns with the given column keys by setting their availability to Default.
2975
+ *
2976
+ * @since 1.124.0
2977
+ * @experimental (since 1.124.0)
2978
+ *
2979
+ * @returns Promise
2980
+ */
2981
+ hideColumns(
2982
+ /**
2983
+ * The keys for the columns to hide
2984
+ */
2985
+ columnKeys: string[]
2986
+ ): Promise<void>;
2987
+ /**
2988
+ * Requests a refresh of the table.
2989
+ */
2990
+ refresh(): void;
2991
+ /**
2992
+ * Removes an action from the table.
2993
+ *
2994
+ * @since 1.124.0
2995
+ * @experimental (since 1.124.0)
2996
+ *
2997
+ * @returns The removed action or null
2998
+ */
2999
+ removeAction(
3000
+ /**
3001
+ * The action to remove, or its index or ID
3002
+ */
3003
+ action: number | Action | string
3004
+ ): null | Action;
3005
+ /**
3006
+ * Removes a column from the table.
3007
+ *
3008
+ * @since 1.124.0
3009
+ * @experimental (since 1.124.0)
3010
+ *
3011
+ * @returns The removed column or null
3012
+ */
3013
+ removeColumn(
3014
+ /**
3015
+ * The column to remove, or its index or ID
3016
+ */
3017
+ column: number | Column | string
3018
+ ): null | Column;
3019
+ /**
3020
+ * Removes a message from the table.
3021
+ */
3022
+ removeMessage(
3023
+ /**
3024
+ * The id of the message
3025
+ */
3026
+ id: string
3027
+ ): void;
3028
+ /**
3029
+ * Set a variant management to the table.
3030
+ */
3031
+ setCurrentVariantKey(
3032
+ /**
3033
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
3034
+ * ignored.
3035
+ */
3036
+ key: string
3037
+ ): void;
3038
+ /**
3039
+ * Sets the fields that should be ignored when generating the table.
3040
+ *
3041
+ * @since 1.124.0
3042
+ * @experimental (since 1.124.0)
3043
+ *
3044
+ * @returns Reference to this in order to allow method chaining
3045
+ */
3046
+ setIgnoredFields(
3047
+ /**
3048
+ * The fields to ignore
3049
+ */
3050
+ ignoredFields: string
3051
+ ): this;
3052
+ /**
3053
+ * Sets the path to the metadata that should be used to generate the table.
3054
+ *
3055
+ * @since 1.124.0
3056
+ * @experimental (since 1.124.0)
3057
+ *
3058
+ * @returns Reference to this in order to allow method chaining
3059
+ */
3060
+ setMetaPath(
3061
+ /**
3062
+ * The path to the metadata
3063
+ */
3064
+ metaPath: string
3065
+ ): this;
3066
+ /**
3067
+ * Set a new presentation variant to the table.
3068
+ */
3069
+ setPresentationVariant(
3070
+ /**
3071
+ * The new presentation variant that is to be set on the table.
3072
+ */
3073
+ tablePV: PresentationVariant
3074
+ ): Promise<void>;
3075
+ /**
3076
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
3077
+ * filters and then apply the SelectionVariant values.
3078
+ *
3079
+ *
3080
+ * @returns A promise for asynchronous handling
3081
+ */
3082
+ setSelectionVariant(
3083
+ /**
3084
+ * The {@link sap.fe.navigation.SelectionVariant } to apply to the table
3085
+ */
3086
+ selectionVariant: SelectionVariant,
3087
+ /**
3088
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
3089
+ * to display the filter value descriptions, instead of loading them from the backend
3090
+ */
3091
+ prefillDescriptions?: boolean
3092
+ ): Promise<any>;
3093
+ /**
3094
+ * Show the columns with the given column keys by setting their availability to Default.
3095
+ *
3096
+ * @since 1.124.0
3097
+ * @experimental (since 1.124.0)
3098
+ *
3099
+ * @returns Promise
3100
+ */
3101
+ showColumns(
3102
+ /**
3103
+ * The keys for the columns to show
3104
+ */
3105
+ columnKeys: string[]
3106
+ ): Promise<void>;
3107
+ }
3108
+ /**
3109
+ * Describes the settings that can be provided to the Table constructor.
1374
3110
  *
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.
3111
+ * @experimental (since 1.124.0)
1380
3112
  */
1381
- export interface $RichTextEditorWithMetadataSettings
1382
- extends $ControlSettings {
3113
+ export interface $TableSettings extends $BuildingBlockWithTemplatingSettings {
1383
3114
  /**
1384
- * With the 'buttonGroups' attribute, you can customize the buttons that are displayed on the toolbar of
1385
- * the editor.
3115
+ * An expression that allows you to control the 'busy' state of the table.
1386
3116
  */
1387
- buttonGroups?: any[] | PropertyBindingInfo | `{${string}}`;
3117
+ busy?: boolean | PropertyBindingInfo | `{${string}}`;
1388
3118
 
1389
3119
  /**
1390
- * The context path of the property displayed
3120
+ * Defines the path of the context used in the current page or block.
3121
+ * This setting is defined by the framework.
1391
3122
  */
1392
- contextPath?: Context | PropertyBindingInfo | `{${string}}`;
3123
+ contextPath?: string | PropertyBindingInfo;
1393
3124
 
1394
3125
  /**
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".
3126
+ * A set of options that can be configured.
1397
3127
  */
1398
- excludeDefaultPlugins?: boolean | PropertyBindingInfo | `{${string}}`;
3128
+ creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
1399
3129
 
1400
3130
  /**
1401
- * The metaPath of the displayed property
3131
+ * Controls if the copy functionality of the table is disabled or not.
1402
3132
  */
1403
- metaPath?: Context | PropertyBindingInfo | `{${string}}`;
3133
+ disableCopyToClipboard?: boolean | PropertyBindingInfo | `{${string}}`;
1404
3134
 
1405
3135
  /**
1406
- * With the 'plugins' attribute you can customize the plugins that will be loaded by the editor.
3136
+ * Specifies if the column width is automatically calculated.
1407
3137
  */
1408
- plugins?: any[] | PropertyBindingInfo | `{${string}}`;
3138
+ enableAutoColumnWidth?: boolean | PropertyBindingInfo | `{${string}}`;
1409
3139
 
1410
3140
  /**
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.
3141
+ * Controls if the export functionality of the table is enabled or not.
1413
3142
  */
1414
- readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
3143
+ enableExport?: boolean | PropertyBindingInfo | `{${string}}`;
1415
3144
 
1416
3145
  /**
1417
- * Use the 'required' attribute, to make sure that the editor is filled with some text.
3146
+ * Controls whether the table can be opened in fullscreen mode or not.
1418
3147
  */
1419
- required?: boolean | PropertyBindingInfo | `{${string}}`;
1420
- }
1421
- }
3148
+ enableFullScreen?: boolean | PropertyBindingInfo | `{${string}}`;
1422
3149
 
1423
- declare module "sap/fe/macros/share/Share.block" {
1424
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3150
+ /**
3151
+ * Controls if the paste functionality of the table is enabled or not.
3152
+ */
3153
+ enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
1425
3154
 
1426
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3155
+ /**
3156
+ * Maximum allowed number of records to be exported in one request.
3157
+ */
3158
+ exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
1427
3159
 
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 = {};
3160
+ /**
3161
+ * ID of the FilterBar building block associated with the table.
3162
+ */
3163
+ filterBar?: string | PropertyBindingInfo;
1458
3164
 
1459
- /**
1460
- * Describes the settings that can be provided to the Share constructor.
1461
- */
1462
- export interface $ShareSettings extends $ControlSettings {
1463
3165
  /**
1464
- * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
3166
+ * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
3167
+ * This property is not relevant for responsive tables
1465
3168
  */
1466
- shareOptions?: object | PropertyBindingInfo | `{${string}}`;
3169
+ frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
1467
3170
 
1468
3171
  /**
1469
- * Whether the share control should be visible on the screen.
3172
+ * Specifies the header text that is shown in the table.
1470
3173
  */
1471
- visible?: boolean | PropertyBindingInfo | `{${string}}`;
1472
- }
1473
- }
3174
+ header?: string | PropertyBindingInfo;
1474
3175
 
1475
- declare module "sap/fe/macros/table/Action" {
1476
- import {
1477
- default as BuildingBlockObjectProperty,
1478
- $BuildingBlockObjectPropertySettings,
1479
- } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
3176
+ /**
3177
+ * Controls if the header text should be shown or not.
3178
+ */
3179
+ headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
1480
3180
 
1481
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3181
+ /**
3182
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
3183
+ *
3184
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
3185
+ * value of fields that are provided in the ignoredfields.
3186
+ *
3187
+ * Any column referencing an ignored field is to be removed.
3188
+ */
3189
+ ignoredFields?: string | PropertyBindingInfo;
1482
3190
 
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
3191
  /**
1493
- * Reference to the key of another action already displayed in the toolbar to properly place this one
3192
+ * Defines whether to display the search action.
1494
3193
  */
1495
- anchor?: string | PropertyBindingInfo;
3194
+ isSearchable?: boolean | PropertyBindingInfo | `{${string}}`;
1496
3195
 
1497
3196
  /**
1498
- * Enables or disables the action
3197
+ * Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
3198
+ * based on the current contextPath.
1499
3199
  */
1500
- enabled?: boolean | PropertyBindingInfo | `{${string}}`;
3200
+ metaPath?: string | PropertyBindingInfo;
1501
3201
 
1502
3202
  /**
1503
- * Unique identifier of the action
3203
+ * Controls which options should be enabled for the table personalization dialog.
3204
+ * If it is set to `true`, all possible options for this kind of table are enabled.
3205
+ *
3206
+ * If it is set to `false`, personalization is disabled.
3207
+ *
3208
+ *
3209
+ *
3210
+ * You can also provide a more granular control for the personalization by providing a comma-separated list
3211
+ * with the options you want to be available.
3212
+ *
3213
+ * Available options are:
3214
+ *
3215
+ * - Sort
3216
+ *
3217
+ * - Column
3218
+ *
3219
+ * - Filter
1504
3220
  */
1505
- key?: string | PropertyBindingInfo;
3221
+ personalization?: string | PropertyBindingInfo;
1506
3222
 
1507
3223
  /**
1508
- * Defines where this action should be placed relative to the defined anchor
1509
- * Allowed values are `Before` and `After`
3224
+ * An expression that allows you to control the 'read-only' state of the table.
3225
+ * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
3226
+ * current state.
1510
3227
  */
1511
- placement?: string | PropertyBindingInfo;
3228
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
1512
3229
 
1513
3230
  /**
1514
- * Event handler to be called when the user chooses the action
3231
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
1515
3232
  */
1516
- press?: string | PropertyBindingInfo;
3233
+ rowCount?: int | PropertyBindingInfo | `{${string}}`;
1517
3234
 
1518
3235
  /**
1519
- * Defines if the action requires a selection.
3236
+ * Defines how the table handles the visible rows. Does not apply to Responsive tables.
3237
+ * Allowed values are `Auto`, `Fixed`.
3238
+ *
3239
+ * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
3240
+ *
3241
+ * - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
3242
+ * row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
3243
+ * less than defined in the `rowCount` property.
1520
3244
  */
1521
- requiresSelection?: boolean | PropertyBindingInfo | `{${string}}`;
3245
+ rowCountMode?: string | PropertyBindingInfo;
1522
3246
 
1523
3247
  /**
1524
- * The text that will be displayed for this action
3248
+ * Defines the selection mode to be used by the table.
3249
+ * Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
3250
+ * If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
3251
+ * the consistent selection mode.
3252
+ * If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
3253
+ * Fiori guidelines.
1525
3254
  */
1526
- text?: string | PropertyBindingInfo;
1527
- }
1528
- }
3255
+ selectionMode?: string | PropertyBindingInfo;
1529
3256
 
1530
- declare module "sap/fe/macros/table/ActionGroup" {
1531
- import {
1532
- default as BuildingBlockObjectProperty,
1533
- $BuildingBlockObjectPropertySettings,
1534
- } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
3257
+ /**
3258
+ * Defines the type of table that will be used by the building block to render the data.
3259
+ * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
3260
+ */
3261
+ type?: string | PropertyBindingInfo;
1535
3262
 
1536
- import {
1537
- PropertyBindingInfo,
1538
- AggregationBindingInfo,
1539
- } from "sap/ui/base/ManagedObject";
3263
+ /**
3264
+ * Controls the kind of variant management that should be enabled for the table.
3265
+ * Allowed value is `Control`.
3266
+ *
3267
+ * If set with value `Control`, a variant management control is seen within the table and the table is linked
3268
+ * to this.
3269
+ *
3270
+ * If not set with any value, control level variant management is not available for this table.
3271
+ */
3272
+ variantManagement?: string | PropertyBindingInfo;
1540
3273
 
1541
- import Action from "sap/fe/macros/table/Action";
3274
+ /**
3275
+ * Indicates if the column header should be a part of the width calculation.
3276
+ */
3277
+ widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
1542
3278
 
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
3279
  /**
1553
- * Reference to the key of another action or action group already displayed in the toolbar to properly place
1554
- * this one
3280
+ * Aggregate actions of the table.
1555
3281
  */
1556
- anchor?: string | PropertyBindingInfo;
3282
+ actions?:
3283
+ | Array<ActionGroup | Action>
3284
+ | ActionGroup
3285
+ | Action
3286
+ | AggregationBindingInfo
3287
+ | `{${string}}`;
1557
3288
 
1558
3289
  /**
1559
- * Unique identifier of the ActionGroup
3290
+ * Aggregate columns of the table.
1560
3291
  */
1561
- key?: string | PropertyBindingInfo;
3292
+ columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
3293
+ }
3294
+
3295
+ /**
3296
+ * Parameters of the Table#beforeRebindTable event.
3297
+ */
3298
+ export interface Table$BeforeRebindTableEventParameters {}
3299
+
3300
+ /**
3301
+ * Event object of the Table#beforeRebindTable event.
3302
+ */
3303
+ export type Table$BeforeRebindTableEvent = Event<
3304
+ Table$BeforeRebindTableEventParameters,
3305
+ Table
3306
+ >;
1562
3307
 
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;
3308
+ /**
3309
+ * Parameters of the Table#rowPress event.
3310
+ */
3311
+ export interface Table$RowPressEventParameters {}
1568
3312
 
1569
- /**
1570
- * The text that will be displayed for this action group
1571
- */
1572
- text?: string | PropertyBindingInfo;
3313
+ /**
3314
+ * Event object of the Table#rowPress event.
3315
+ */
3316
+ export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
1573
3317
 
1574
- /**
1575
- * Defines nested actions
1576
- */
1577
- actions?: Action[] | Action | AggregationBindingInfo | `{${string}}`;
1578
- }
3318
+ /**
3319
+ * Parameters of the Table#selectionChange event.
3320
+ */
3321
+ export interface Table$SelectionChangeEventParameters {}
3322
+
3323
+ /**
3324
+ * Event object of the Table#selectionChange event.
3325
+ */
3326
+ export type Table$SelectionChangeEvent = Event<
3327
+ Table$SelectionChangeEventParameters,
3328
+ Table
3329
+ >;
1579
3330
  }
1580
3331
 
1581
- declare module "sap/fe/macros/table/Column" {
3332
+ declare module "sap/fe/macros/table/TableCreationOptions" {
1582
3333
  import {
1583
3334
  default as BuildingBlockObjectProperty,
1584
3335
  $BuildingBlockObjectPropertySettings,
@@ -1587,61 +3338,61 @@ declare module "sap/fe/macros/table/Column" {
1587
3338
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1588
3339
 
1589
3340
  /**
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
3341
+ * Create options for the table.
1592
3342
  */
1593
- export default class Column extends BuildingBlockObjectProperty {}
3343
+ export default class TableCreationOptions extends BuildingBlockObjectProperty {}
1594
3344
  /**
1595
- * Describes the settings that can be provided to the Column constructor.
3345
+ * Describes the settings that can be provided to the TableCreationOptions constructor.
1596
3346
  */
1597
- export interface $ColumnSettings
3347
+ export interface $TableCreationOptionsSettings
1598
3348
  extends $BuildingBlockObjectPropertySettings {
1599
3349
  /**
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
3350
+ * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
3351
+ * 'Inline'
3352
+ *
3353
+ * The default value is 'false'
1622
3354
  */
1623
- key?: string | PropertyBindingInfo;
3355
+ createAtEnd?: boolean | PropertyBindingInfo | `{${string}}`;
1624
3356
 
1625
3357
  /**
1626
- * Defines where this column should be placed relative to the defined anchor
1627
- * Allowed values are `Before` and `After`
3358
+ * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
3359
+ * to responsive tables.
3360
+ *
3361
+ * The default value is 'false'
1628
3362
  */
1629
- placement?: string | PropertyBindingInfo;
3363
+ inlineCreationRowsHiddenInEditMode?:
3364
+ | boolean
3365
+ | PropertyBindingInfo
3366
+ | `{${string}}`;
1630
3367
 
1631
3368
  /**
1632
- * Defines the column's width.
1633
- * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
3369
+ * Defines the creation mode to be used by the table.
3370
+ * Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
3371
+ *
3372
+ *
3373
+ *
3374
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
3375
+ * or 'Deferred' is used
3376
+ *
3377
+ * Inline - The creation is done inline
3378
+ *
3379
+ * InlineCreationsRows - The creation is done inline with an empty row
3380
+ *
3381
+ * External - The creation is done in a different application specified via the parameter 'outbound'
3382
+ * If not set with any value:
3383
+ *
3384
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
1634
3385
  */
1635
- width?: string | PropertyBindingInfo;
3386
+ name?: string | PropertyBindingInfo;
1636
3387
 
1637
3388
  /**
1638
- * Indicates if the column header should be a part of the width calculation.
3389
+ * The navigation target where the document is created in case of creationMode 'External'
1639
3390
  */
1640
- widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
3391
+ outbound?: string | PropertyBindingInfo;
1641
3392
  }
1642
3393
  }
1643
3394
 
1644
- declare module "sap/fe/macros/table/TableAPI" {
3395
+ declare module "sap/fe/macros/table/TreeTable.block" {
1645
3396
  import {
1646
3397
  default as MacroAPI,
1647
3398
  $MacroAPISettings,
@@ -1660,6 +3411,8 @@ declare module "sap/fe/macros/table/TableAPI" {
1660
3411
  AggregationBindingInfo,
1661
3412
  } from "sap/ui/base/ManagedObject";
1662
3413
 
3414
+ import TreeTableCreationOptions from "sap/fe/macros/table/TreeTableCreationOptions";
3415
+
1663
3416
  import ActionGroup from "sap/fe/macros/table/ActionGroup";
1664
3417
 
1665
3418
  import Action from "sap/fe/macros/table/Action";
@@ -1669,26 +3422,9 @@ declare module "sap/fe/macros/table/TableAPI" {
1669
3422
  import Event from "sap/ui/base/Event";
1670
3423
 
1671
3424
  /**
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
- * ```
3425
+ * Building block used to create a tree table based on the metadata provided by OData V4.
1690
3426
  */
1691
- export default class Table extends MacroAPI {
3427
+ export default class TreeTable extends MacroAPI {
1692
3428
  /**
1693
3429
  * Adds a message to the table.
1694
3430
  * The message applies to the whole table and not to an individual table row.
@@ -1727,6 +3463,15 @@ declare module "sap/fe/macros/table/TableAPI" {
1727
3463
  * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
1728
3464
  */
1729
3465
  getCurrentVariantKey(): null | string;
3466
+ /**
3467
+ * Get the fields that should be ignored when generating the table.
3468
+ *
3469
+ * @since 1.124.0
3470
+ * @experimental (since 1.124.0)
3471
+ *
3472
+ * @returns The value of the ignoredFields property
3473
+ */
3474
+ getIgnoredFields(): string;
1730
3475
  /**
1731
3476
  * Get the presentation variant that is currently applied on the table.
1732
3477
  *
@@ -1748,6 +3493,20 @@ declare module "sap/fe/macros/table/TableAPI" {
1748
3493
  * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
1749
3494
  */
1750
3495
  getSelectionVariant(): Promise<SelectionVariant>;
3496
+ /**
3497
+ * Hide the columns with the given column keys by setting their availability to Default.
3498
+ *
3499
+ * @since 1.124.0
3500
+ * @experimental (since 1.124.0)
3501
+ *
3502
+ * @returns Promise
3503
+ */
3504
+ hideColumns(
3505
+ /**
3506
+ * The keys for the columns to hide
3507
+ */
3508
+ columnKeys: string[]
3509
+ ): Promise<void>;
1751
3510
  /**
1752
3511
  * Requests a refresh of the table.
1753
3512
  */
@@ -1771,6 +3530,20 @@ declare module "sap/fe/macros/table/TableAPI" {
1771
3530
  */
1772
3531
  key: string
1773
3532
  ): void;
3533
+ /**
3534
+ * Sets the fields that should be ignored when generating the table.
3535
+ *
3536
+ * @since 1.124.0
3537
+ * @experimental (since 1.124.0)
3538
+ *
3539
+ * @returns Reference to this in order to allow method chaining
3540
+ */
3541
+ setIgnoredFields(
3542
+ /**
3543
+ * The fields to ignore
3544
+ */
3545
+ ignoredFields: string
3546
+ ): this;
1774
3547
  /**
1775
3548
  * Set a new presentation variant to the table.
1776
3549
  */
@@ -1798,54 +3571,25 @@ declare module "sap/fe/macros/table/TableAPI" {
1798
3571
  */
1799
3572
  prefillDescriptions?: boolean
1800
3573
  ): 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
3574
  /**
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
3575
+ * Show the columns with the given column keys by setting their availability to Default.
1832
3576
  *
1833
- * External - The creation is done in a different application specified via the parameter 'outbound'
1834
- * If not set with any value:
3577
+ * @since 1.124.0
3578
+ * @experimental (since 1.124.0)
1835
3579
  *
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'
3580
+ * @returns Promise
1841
3581
  */
1842
- outbound: string;
1843
- };
1844
-
3582
+ showColumns(
3583
+ /**
3584
+ * The keys for the columns to show
3585
+ */
3586
+ columnKeys: string[]
3587
+ ): Promise<void>;
3588
+ }
1845
3589
  /**
1846
- * Describes the settings that can be provided to the Table constructor.
3590
+ * Describes the settings that can be provided to the TreeTable constructor.
1847
3591
  */
1848
- export interface $TableSettings extends $MacroAPISettings {
3592
+ export interface $TreeTableSettings extends $MacroAPISettings {
1849
3593
  /**
1850
3594
  * An expression that allows you to control the 'busy' state of the table.
1851
3595
  */
@@ -1860,7 +3604,10 @@ declare module "sap/fe/macros/table/TableAPI" {
1860
3604
  /**
1861
3605
  * A set of options that can be configured.
1862
3606
  */
1863
- creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
3607
+ creationMode?:
3608
+ | TreeTableCreationOptions
3609
+ | PropertyBindingInfo
3610
+ | `{${string}}`;
1864
3611
 
1865
3612
  /**
1866
3613
  * Controls if the copy functionality of the table is disabled or not.
@@ -1890,7 +3637,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1890
3637
  /**
1891
3638
  * Maximum allowed number of records to be exported in one request.
1892
3639
  */
1893
- exportRequestSize?: number | PropertyBindingInfo | `{${string}}`;
3640
+ exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
1894
3641
 
1895
3642
  /**
1896
3643
  * ID of the FilterBar building block associated with the table.
@@ -1901,7 +3648,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1901
3648
  * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
1902
3649
  * This property is not relevant for responsive tables
1903
3650
  */
1904
- frozenColumnCount?: number | PropertyBindingInfo | `{${string}}`;
3651
+ frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
1905
3652
 
1906
3653
  /**
1907
3654
  * Specifies the header text that is shown in the table.
@@ -1913,6 +3660,31 @@ declare module "sap/fe/macros/table/TableAPI" {
1913
3660
  */
1914
3661
  headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
1915
3662
 
3663
+ /**
3664
+ * A set of options that can be configured.
3665
+ */
3666
+ hierarchyQualifier?: string | PropertyBindingInfo;
3667
+
3668
+ /**
3669
+ * Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
3670
+ *
3671
+ * The table building block is not going to create built-in columns or offer table personalization for comma-separated
3672
+ * value of fields that are provided in the ignoredfields.
3673
+ *
3674
+ * Any column referencing an ignored field is to be removed.
3675
+ */
3676
+ ignoredFields?: string | PropertyBindingInfo;
3677
+
3678
+ /**
3679
+ * Defines the extension point to control if a source node can be dropped on a specific parent node.
3680
+ */
3681
+ isMoveToPositionAllowed?: string | PropertyBindingInfo;
3682
+
3683
+ /**
3684
+ * Defines the extension point to control if a node can be dragged.
3685
+ */
3686
+ isNodeMovable?: string | PropertyBindingInfo;
3687
+
1916
3688
  /**
1917
3689
  * Defines whether to display the search action.
1918
3690
  */
@@ -1943,7 +3715,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1943
3715
  *
1944
3716
  * - Filter
1945
3717
  */
1946
- personalization?: boolean | string | PropertyBindingInfo | `{${string}}`;
3718
+ personalization?: string | PropertyBindingInfo;
1947
3719
 
1948
3720
  /**
1949
3721
  * An expression that allows you to control the 'read-only' state of the table.
@@ -1955,7 +3727,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1955
3727
  /**
1956
3728
  * Number of rows to be displayed in the table. Does not apply to responsive tables.
1957
3729
  */
1958
- rowCount?: number | PropertyBindingInfo | `{${string}}`;
3730
+ rowCount?: int | PropertyBindingInfo | `{${string}}`;
1959
3731
 
1960
3732
  /**
1961
3733
  * Defines how the table handles the visible rows. Does not apply to Responsive tables.
@@ -1980,8 +3752,9 @@ declare module "sap/fe/macros/table/TableAPI" {
1980
3752
  selectionMode?: string | PropertyBindingInfo;
1981
3753
 
1982
3754
  /**
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`.
3755
+ * Defines the type of table that will be used by the building block to render the data. This setting is
3756
+ * defined by the framework.
3757
+ * Allowed value is `TreeTable`.
1985
3758
  */
1986
3759
  type?: string | PropertyBindingInfo;
1987
3760
 
@@ -2018,58 +3791,121 @@ declare module "sap/fe/macros/table/TableAPI" {
2018
3791
  }
2019
3792
 
2020
3793
  /**
2021
- * Parameters of the Table#beforeRebindTable event.
3794
+ * Parameters of the TreeTable#beforeRebindTable event.
2022
3795
  */
2023
- export interface Table$BeforeRebindTableEventParameters {}
3796
+ export interface TreeTable$BeforeRebindTableEventParameters {}
2024
3797
 
2025
3798
  /**
2026
- * Event object of the Table#beforeRebindTable event.
3799
+ * Event object of the TreeTable#beforeRebindTable event.
2027
3800
  */
2028
- export type Table$BeforeRebindTableEvent = Event<
2029
- Table$BeforeRebindTableEventParameters,
2030
- Table
3801
+ export type TreeTable$BeforeRebindTableEvent = Event<
3802
+ TreeTable$BeforeRebindTableEventParameters,
3803
+ TreeTable
2031
3804
  >;
2032
3805
 
2033
3806
  /**
2034
- * Parameters of the Table#rowPress event.
3807
+ * Parameters of the TreeTable#rowPress event.
2035
3808
  */
2036
- export interface Table$RowPressEventParameters {}
3809
+ export interface TreeTable$RowPressEventParameters {}
2037
3810
 
2038
3811
  /**
2039
- * Event object of the Table#rowPress event.
3812
+ * Event object of the TreeTable#rowPress event.
2040
3813
  */
2041
- export type Table$RowPressEvent = Event<Table$RowPressEventParameters, Table>;
3814
+ export type TreeTable$RowPressEvent = Event<
3815
+ TreeTable$RowPressEventParameters,
3816
+ TreeTable
3817
+ >;
2042
3818
 
2043
3819
  /**
2044
- * Parameters of the Table#selectionChange event.
3820
+ * Parameters of the TreeTable#selectionChange event.
2045
3821
  */
2046
- export interface Table$SelectionChangeEventParameters {}
3822
+ export interface TreeTable$SelectionChangeEventParameters {}
2047
3823
 
2048
3824
  /**
2049
- * Event object of the Table#selectionChange event.
3825
+ * Event object of the TreeTable#selectionChange event.
2050
3826
  */
2051
- export type Table$SelectionChangeEvent = Event<
2052
- Table$SelectionChangeEventParameters,
2053
- Table
3827
+ export type TreeTable$SelectionChangeEvent = Event<
3828
+ TreeTable$SelectionChangeEventParameters,
3829
+ TreeTable
2054
3830
  >;
2055
3831
  }
2056
3832
 
3833
+ declare module "sap/fe/macros/table/TreeTableCreationOptions" {
3834
+ import {
3835
+ default as BuildingBlockObjectProperty,
3836
+ $BuildingBlockObjectPropertySettings,
3837
+ } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
3838
+
3839
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3840
+
3841
+ /**
3842
+ * Create options for the tree table.
3843
+ */
3844
+ export default class TreeTableCreationOptions extends BuildingBlockObjectProperty {}
3845
+ /**
3846
+ * Describes the settings that can be provided to the TreeTableCreationOptions constructor.
3847
+ */
3848
+ export interface $TreeTableCreationOptionsSettings
3849
+ extends $BuildingBlockObjectPropertySettings {
3850
+ /**
3851
+ * Defines the extension point to control the enablement of the Create button or Create Menu buttons.
3852
+ */
3853
+ isCreateEnabled?: string | PropertyBindingInfo;
3854
+
3855
+ /**
3856
+ * Defines the creation mode to be used by the tree table.
3857
+ * Allowed values are `NewPage` or `Inline`.
3858
+ *
3859
+ *
3860
+ *
3861
+ * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
3862
+ * or 'Deferred' is used.
3863
+ *
3864
+ * Inline - the creation is done inline.
3865
+ *
3866
+ * If not set with any value:
3867
+ *
3868
+ * if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
3869
+ */
3870
+ name?: string | PropertyBindingInfo;
3871
+
3872
+ /**
3873
+ * Defines the nodes to be added on the custom create.
3874
+ * This object must have the following properties:
3875
+ * propertyName: the name of the property on the page entity set used to categorize the node type to be
3876
+ * created within the hierarchy
3877
+ *
3878
+ * values: an array of key and label that define a value of the property defined by the propertyName key
3879
+ * and its label
3880
+ */
3881
+ nodeType?: object | PropertyBindingInfo | `{${string}}`;
3882
+ }
3883
+ }
3884
+
2057
3885
  declare namespace sap {
2058
3886
  interface IUI5DefineDependencyNames {
2059
3887
  "sap/fe/macros/chart/Action": undefined;
2060
3888
 
2061
3889
  "sap/fe/macros/chart/ActionGroup": undefined;
2062
3890
 
3891
+ "sap/fe/macros/chart/Chart": undefined;
3892
+
2063
3893
  "sap/fe/macros/chart/ChartAPI": undefined;
2064
3894
 
2065
3895
  "sap/fe/macros/CollectionBindingInfo": undefined;
2066
3896
 
2067
3897
  "sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;
2068
3898
 
3899
+ "sap/fe/macros/controls/BuildingBlockWithTemplating": undefined;
3900
+
2069
3901
  "sap/fe/macros/fcl/FlexibleColumnLayoutActions.block": undefined;
2070
3902
 
3903
+ "sap/fe/macros/field/Field": undefined;
3904
+
2071
3905
  "sap/fe/macros/field/FieldAPI": undefined;
2072
3906
 
3907
+ "sap/fe/macros/filterBar/FilterBar": undefined;
3908
+
2073
3909
  "sap/fe/macros/filterBar/FilterBarAPI": undefined;
2074
3910
 
2075
3911
  "sap/fe/macros/filterBar/FilterField": undefined;
@@ -2084,6 +3920,8 @@ declare namespace sap {
2084
3920
 
2085
3921
  "sap/fe/macros/MacroAPI": undefined;
2086
3922
 
3923
+ "sap/fe/macros/microchart/MicroChart": undefined;
3924
+
2087
3925
  "sap/fe/macros/microchart/MicroChart.block": undefined;
2088
3926
 
2089
3927
  "sap/fe/macros/multiValueField/MultiValueField.block": undefined;
@@ -2106,6 +3944,14 @@ declare namespace sap {
2106
3944
 
2107
3945
  "sap/fe/macros/table/Column": undefined;
2108
3946
 
2109
- "sap/fe/macros/table/TableAPI": undefined;
3947
+ "sap/fe/macros/table/Table": undefined;
3948
+
3949
+ "sap/fe/macros/table/Table.block": undefined;
3950
+
3951
+ "sap/fe/macros/table/TableCreationOptions": undefined;
3952
+
3953
+ "sap/fe/macros/table/TreeTable.block": undefined;
3954
+
3955
+ "sap/fe/macros/table/TreeTableCreationOptions": undefined;
2110
3956
  }
2111
3957
  }