@openui5/ts-types 1.136.2 → 1.138.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.2
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -967,7 +967,11 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
967
967
  /**
968
968
  * Type of the value
969
969
  */
970
- oType: sap.ui.model.Type
970
+ oType: sap.ui.model.Type,
971
+ /**
972
+ * If `true`, the connected control could be left empty (without conditions)
973
+ */
974
+ bEmptyAllowed: boolean
971
975
  ):
972
976
  | string
973
977
  | sap.ui.mdc.valuehelp.base.ValueHelpItem
@@ -1034,7 +1038,11 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
1034
1038
  /**
1035
1039
  * Type of the value
1036
1040
  */
1037
- oType: sap.ui.model.Type
1041
+ oType: sap.ui.model.Type,
1042
+ /**
1043
+ * If `true`, the connected control could be left empty (without conditions)
1044
+ */
1045
+ bEmptyAllowed: boolean
1038
1046
  ):
1039
1047
  | string
1040
1048
  | sap.ui.mdc.valuehelp.base.ValueHelpItem
@@ -1101,7 +1109,11 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
1101
1109
  /**
1102
1110
  * Type of the value
1103
1111
  */
1104
- oType: sap.ui.model.Type
1112
+ oType: sap.ui.model.Type,
1113
+ /**
1114
+ * If `true`, the connected control could be left empty (without conditions)
1115
+ */
1116
+ bEmptyAllowed: boolean
1105
1117
  ):
1106
1118
  | string
1107
1119
  | sap.ui.mdc.valuehelp.base.ValueHelpItem
@@ -1164,7 +1176,11 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
1164
1176
  /**
1165
1177
  * Type of the value
1166
1178
  */
1167
- oType: sap.ui.model.Type
1179
+ oType: sap.ui.model.Type,
1180
+ /**
1181
+ * If `true`, the connected control could be left empty (without conditions)
1182
+ */
1183
+ bEmptyAllowed: boolean
1168
1184
  ):
1169
1185
  | string
1170
1186
  | sap.ui.mdc.valuehelp.base.ValueHelpItem
@@ -1779,7 +1795,12 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1779
1795
  * Instance of the table
1780
1796
  */
1781
1797
  oTable: sap.ui.mdc.Table
1782
- ): Promise<sap.ui.mdc.odata.v4.TableDelegate.PropertyInfo[]>;
1798
+ ): Promise<
1799
+ Array<
1800
+ | sap.ui.mdc.odata.v4.TableDelegate.PropertyInfo
1801
+ | sap.ui.mdc.table.ComplexPropertyInfo
1802
+ >
1803
+ >;
1783
1804
  /**
1784
1805
  * Returns the keys of properties that should always be included in the result of the collection requested
1785
1806
  * from the back end. This information is applied when updating the table's binding.
@@ -1992,13 +2013,13 @@ declare module "sap/ui/mdc/TableDelegate" {
1992
2013
  *
1993
2014
  * By default, this method returns a `Promise` that resolves with an empty array.
1994
2015
  *
1995
- * **Note:** The result of this function must be kept stable throughout the lifecycle of your application.
1996
- * Any changes of the returned values might result in undesired effects.
1997
- *
1998
- * **Note**: Existing properties (set via `sap.ui.mdc.Table#setPropertyInfo`) must not be removed and their
1999
- * attributes must not be changed during the {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties }
2000
- * callback. Otherwise validation errors might occur whenever personalization-related control features (such
2001
- * as the opening of any personalization dialog) are activated.
2016
+ * **Note:**
2017
+ * - The result of this function must be kept stable throughout the lifecycle of your application. Any
2018
+ * changes of the returned values might result in undesired effects.
2019
+ * - Existing properties (set via `sap.ui.mdc.Table#setPropertyInfo`) must not be removed and their attributes
2020
+ * must not be changed during the {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties }
2021
+ * callback. Otherwise validation errors might occur whenever personalization-related control features (such
2022
+ * as the opening of any personalization dialog) are activated.
2002
2023
  *
2003
2024
  * @ui5-protected Do not call from applications (only from related classes in the framework)
2004
2025
  *
@@ -2009,7 +2030,11 @@ declare module "sap/ui/mdc/TableDelegate" {
2009
2030
  * Instance of the table
2010
2031
  */
2011
2032
  oTable: sap.ui.mdc.Table
2012
- ): Promise<sap.ui.mdc.table.PropertyInfo[]>;
2033
+ ): Promise<
2034
+ Array<
2035
+ sap.ui.mdc.table.PropertyInfo | sap.ui.mdc.table.ComplexPropertyInfo
2036
+ >
2037
+ >;
2013
2038
  /**
2014
2039
  * Formats the title text of a group header row of the table.
2015
2040
  *
@@ -2421,6 +2446,131 @@ declare module "sap/ui/mdc/util/TypeMap" {
2421
2446
  export default TypeMap;
2422
2447
  }
2423
2448
 
2449
+ declare module "sap/ui/mdc/valuehelp/RequestShowContainerDefault" {
2450
+ /**
2451
+ * This object contains default behavior for opening `ValueHelp` {@link sap.ui.mdc.valuehelp.base.Container containers }
2452
+ * in the context of interaction on connected controls. Please also see {@link module:sap/ui/mdc/ValueHelpDelegate.requestShowContainer requestShowContainer}
2453
+ *
2454
+ * @since 1.137
2455
+ */
2456
+ interface RequestShowContainerDefault {
2457
+ /**
2458
+ * Default behavior for {@link sap.ui.mdc.enums.RequestShowContainerReason.Filter RequestShowContainerReason.Filter}.
2459
+ *
2460
+ * On desktop, prevent showing FilterableListContent without given filterValue. On desktop, check ListContent
2461
+ * for available data. Show all other content without further checks.
2462
+ *
2463
+ *
2464
+ * @returns `true`, if the value help should trigger opening
2465
+ */
2466
+ Filter(
2467
+ /**
2468
+ * The `ValueHelp` control instance
2469
+ */
2470
+ oValueHelp: sap.ui.mdc.ValueHelp,
2471
+ /**
2472
+ * Container instance
2473
+ */
2474
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2475
+ ): Promise<boolean>;
2476
+ /**
2477
+ * Default behavior for {@link sap.ui.mdc.enums.RequestShowContainerReason.Focus RequestShowContainerReason.Focus}.
2478
+ *
2479
+ * By default, a container is not shown in response to focus events, as it cannot be determined whether
2480
+ * the event was triggered by user interaction or programmatically.
2481
+ *
2482
+ *
2483
+ * @returns `true`, if the value help should trigger opening
2484
+ */
2485
+ Focus(
2486
+ /**
2487
+ * The `ValueHelp` control instance
2488
+ */
2489
+ oValueHelp: sap.ui.mdc.ValueHelp,
2490
+ /**
2491
+ * Container instance
2492
+ */
2493
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2494
+ ): Promise<boolean>;
2495
+ /**
2496
+ * Default behavior for {@link sap.ui.mdc.enums.RequestShowContainerReason.Navigate RequestShowContainerReason.Navigate}.
2497
+ *
2498
+ * Preloads delegate content. By default, a container is not shown in response to navigation.
2499
+ *
2500
+ *
2501
+ * @returns `true`, if the value help should trigger opening
2502
+ */
2503
+ Navigate(
2504
+ /**
2505
+ * The `ValueHelp` control instance
2506
+ */
2507
+ oValueHelp: sap.ui.mdc.ValueHelp,
2508
+ /**
2509
+ * Container instance
2510
+ */
2511
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2512
+ ): Promise<boolean>;
2513
+ /**
2514
+ * Default behavior for {@link sap.ui.mdc.enums.RequestShowContainerReason.Tap RequestShowContainerReason.Tap}.
2515
+ *
2516
+ * On phones, return true for multi-select usage or if the container is not used as a valuehelp. At last,
2517
+ * check if the content is a non-boolean, unfiltered fixed list.
2518
+ *
2519
+ *
2520
+ * @returns `true`, if the value help should trigger opening
2521
+ */
2522
+ Tap(
2523
+ /**
2524
+ * The `ValueHelp` control instance
2525
+ */
2526
+ oValueHelp: sap.ui.mdc.ValueHelp,
2527
+ /**
2528
+ * Container instance
2529
+ */
2530
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2531
+ ): Promise<boolean>;
2532
+ /**
2533
+ * Default behavior for {@link sap.ui.mdc.enums.RequestShowContainerReason.Typing RequestShowContainerReason.Typing}.
2534
+ *
2535
+ * Preloads delegate content. On phones, return false for single-select usage or if the container is used
2536
+ * as a valuehelp. At last, check content's search support.
2537
+ *
2538
+ *
2539
+ * @returns `true`, if the value help should trigger opening
2540
+ */
2541
+ Typing(
2542
+ /**
2543
+ * The `ValueHelp` control instance
2544
+ */
2545
+ oValueHelp: sap.ui.mdc.ValueHelp,
2546
+ /**
2547
+ * Container instance
2548
+ */
2549
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2550
+ ): Promise<boolean>;
2551
+ /**
2552
+ * Default behavior for {@link sap.ui.mdc.enums.RequestShowContainerReason.ValueHelpRequest RequestShowContainerReason.ValueHelpRequest}.
2553
+ *
2554
+ * By default, a dialog-like container should be shown on `ValueHelpRequest` events.
2555
+ *
2556
+ *
2557
+ * @returns `true`, if the value help should trigger opening
2558
+ */
2559
+ ValueHelpRequest(
2560
+ /**
2561
+ * The `ValueHelp` control instance
2562
+ */
2563
+ oValueHelp: sap.ui.mdc.ValueHelp,
2564
+ /**
2565
+ * Container instance
2566
+ */
2567
+ oContainer: sap.ui.mdc.valuehelp.base.Container
2568
+ ): Promise<boolean>;
2569
+ }
2570
+ const RequestShowContainerDefault: RequestShowContainerDefault;
2571
+ export default RequestShowContainerDefault;
2572
+ }
2573
+
2424
2574
  declare module "sap/ui/mdc/ValueHelpDelegate" {
2425
2575
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
2426
2576
 
@@ -2818,6 +2968,32 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2818
2968
  */
2819
2969
  oConfig?: /* was: sap.ui.mdc.valuehelp.base.ConnectConfig */ any
2820
2970
  ): void;
2971
+ /**
2972
+ * Determines if a value help container is to be opened on user interaction, navigation, or configuration
2973
+ * changes. **Note:** This method can be called repeatedly with various {@link {sap.ui.mdc.enums.RequestShowContainerReason reasons }
2974
+ * depending on the given {@link sap.ui.mdc.valuehelp.base.Container container}.
2975
+ *
2976
+ * @since 1.136
2977
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2978
+ *
2979
+ * @returns `true`, if the value help is to be triggered
2980
+ */
2981
+ requestShowContainer(
2982
+ /**
2983
+ * The `ValueHelp` control instance
2984
+ */
2985
+ oValueHelp: sap.ui.mdc.ValueHelp,
2986
+ /**
2987
+ * Container instance
2988
+ */
2989
+ oContainer: sap.ui.mdc.valuehelp.base.Container,
2990
+ /**
2991
+ * Reason for the request
2992
+ */
2993
+ sRequestShowContainerReason:
2994
+ | sap.ui.mdc.enums.RequestShowContainerReason
2995
+ | keyof typeof sap.ui.mdc.enums.RequestShowContainerReason
2996
+ ): Promise<boolean>;
2821
2997
  /**
2822
2998
  * Requests additional content for the value help.
2823
2999
  *
@@ -2855,6 +3031,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2855
3031
  * Currently this is only supported for the type-ahead container.
2856
3032
  *
2857
3033
  * @since 1.121.0
3034
+ * @deprecated As of version 1.137. replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.requestShowContainer}.
2858
3035
  *
2859
3036
  * @returns If `true`, the value help is opened when user clicks into the connected field control
2860
3037
  */
@@ -2876,6 +3053,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2876
3053
  * Currently this is only supported for the type-ahead container.
2877
3054
  *
2878
3055
  * @since 1.121.0
3056
+ * @deprecated As of version 1.137. replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.requestShowContainer}.
2879
3057
  *
2880
3058
  * @returns If `true`, the value help is opened when user focuses on the connected field control
2881
3059
  */
@@ -2897,6 +3075,7 @@ declare module "sap/ui/mdc/ValueHelpDelegate" {
2897
3075
  * is returned.
2898
3076
  *
2899
3077
  * @since 1.110.0
3078
+ * @deprecated As of version 1.137. replaced by {@link module:sap/ui/mdc/ValueHelpDelegate.requestShowContainer}.
2900
3079
  *
2901
3080
  * @returns Boolean or `Promise` that resolves into a `boolean` indicating the desired behavior
2902
3081
  */
@@ -4158,6 +4337,9 @@ declare namespace sap {
4158
4337
  interface FilterOperatorUtil {
4159
4338
  /**
4160
4339
  * Adds an operator to the list of known operators.
4340
+ *
4341
+ * **Note:** For application-specific operators, use an application-specific name to prevent conflicts with
4342
+ * different applications.
4161
4343
  */
4162
4344
  addOperator(
4163
4345
  /**
@@ -4180,6 +4362,9 @@ declare namespace sap {
4180
4362
  ): void;
4181
4363
  /**
4182
4364
  * Adds an array of operators to the list of known operators.
4365
+ *
4366
+ * **Note:** For application-specific operators, use an application-specific name to prevent conflicts with
4367
+ * different applications.
4183
4368
  */
4184
4369
  addOperators(
4185
4370
  /**
@@ -4341,6 +4526,8 @@ declare namespace sap {
4341
4526
  /**
4342
4527
  * Alias names based on {@link sap.ui.mdc.enums.BaseType BaseType}, used to map to {@link sap.m.DynamicDateOption DynamicDateOption }
4343
4528
  * if {@link sap.m.DynamicDateRange DynamicDateRange} is used to visualize the filter
4529
+ * For example, if an operator must use the `DATE` option if used for a date type and the `DATETIME` option
4530
+ * if used for a date/time type, the `alias` needs to be configured as `{Date: "DATE", DateTime: "DATETIME"}`.
4344
4531
  */
4345
4532
  alias?: object;
4346
4533
  /**
@@ -4843,6 +5030,12 @@ declare namespace sap {
4843
5030
  * Edit mode for operator dependent controls This is used for single value and only one operator.
4844
5031
  */
4845
5032
  EditOperator = "EditOperator",
5033
+ /**
5034
+ * Edit mode for single value field that is rendered as `Select` control
5035
+ *
5036
+ * @since 1.138
5037
+ */
5038
+ EditSelect = "EditSelect",
4846
5039
  }
4847
5040
  /**
4848
5041
  * Defines the output of a {@link sap.ui.mdc.Field Field}, {@link sap.ui.mdc.FilterField FilterField}, or
@@ -6437,6 +6630,10 @@ declare namespace sap {
6437
6630
  * If set, the input and output might contain multiple lines
6438
6631
  */
6439
6632
  multipleLines?: boolean;
6633
+ /**
6634
+ * If `true`, the connected control could be left empty (without conditions)
6635
+ */
6636
+ emptyAllowed?: boolean;
6440
6637
  },
6441
6638
  /**
6442
6639
  * Value constraints
@@ -6660,6 +6857,10 @@ declare namespace sap {
6660
6857
  * If set, the input and output might contain multiple lines
6661
6858
  */
6662
6859
  multipleLines?: boolean;
6860
+ /**
6861
+ * If `true`, the connected control could be left empty (without conditions)
6862
+ */
6863
+ emptyAllowed?: boolean;
6663
6864
  },
6664
6865
  /**
6665
6866
  * Value constraints
@@ -6889,6 +7090,10 @@ declare namespace sap {
6889
7090
  * If set, the input and output might contain multiple lines
6890
7091
  */
6891
7092
  multipleLines?: boolean;
7093
+ /**
7094
+ * If `true`, the connected control could be left empty (without conditions)
7095
+ */
7096
+ emptyAllowed?: boolean;
6892
7097
  },
6893
7098
  /**
6894
7099
  * Value constraints
@@ -7435,6 +7640,25 @@ declare namespace sap {
7435
7640
  * @returns BaseType
7436
7641
  */
7437
7642
  getBaseType(): sap.ui.mdc.enums.BaseType;
7643
+ /**
7644
+ * Creates parameter for a `ParseError`, `ValidationError` or `ValidationSuccess` event based on the corresponding
7645
+ * event fired on the inner control.
7646
+ *
7647
+ * The basic implementation just adds the element and error information. The `property` and `type` information
7648
+ * must be added by the inheriting control. If no binding for the corresponding property exists `null` must
7649
+ * be returned, as the event must only be fired if there is a binding.
7650
+ *
7651
+ * @since 1.138.0
7652
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7653
+ *
7654
+ * @returns parameters for the new event
7655
+ */
7656
+ getBindingEventParameter(
7657
+ /**
7658
+ * original event fired on inner control
7659
+ */
7660
+ oEvent: sap.ui.base.Event
7661
+ ): object;
7438
7662
  /**
7439
7663
  * Gets current value of property {@link #getConditions conditions}.
7440
7664
  *
@@ -7828,6 +8052,20 @@ declare namespace sap {
7828
8052
  * @returns Value of property `valueState`
7829
8053
  */
7830
8054
  getValueState(): sap.ui.core.ValueState;
8055
+ /**
8056
+ * Gets the ValueState for content controls
8057
+ *
8058
+ * @since 1.138.0
8059
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8060
+ *
8061
+ * @returns value state information for content control
8062
+ */
8063
+ getValueStateForContent(
8064
+ /**
8065
+ * Id of the content control or Id of the field itself
8066
+ */
8067
+ sContentId: string
8068
+ ): object;
7831
8069
  /**
7832
8070
  * Gets current value of property {@link #getValueStateText valueStateText}.
7833
8071
  *
@@ -7883,6 +8121,15 @@ declare namespace sap {
7883
8121
  * @returns `true` if there is a pending user input
7884
8122
  */
7885
8123
  hasPendingUserInput(): boolean;
8124
+ /**
8125
+ * Return `true` if at least one content control has a own value state
8126
+ *
8127
+ * @since 1.138.0
8128
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8129
+ *
8130
+ * @returns `true` if at least one content control has a own value state
8131
+ */
8132
+ hasValueStateForContent(): boolean;
7886
8133
  /**
7887
8134
  * Initializes internal data-types and dependent objects.
7888
8135
  *
@@ -7981,6 +8228,13 @@ declare namespace sap {
7981
8228
  */
7982
8229
  bRemoveUIMessage: boolean
7983
8230
  ): void;
8231
+ /**
8232
+ * Resets the ValueState for content controls
8233
+ *
8234
+ * @since 1.138.0
8235
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8236
+ */
8237
+ resetValueStateForAllContent(): void;
7984
8238
  /**
7985
8239
  * Sets a new value for property {@link #getConditions conditions}.
7986
8240
  *
@@ -8403,6 +8657,26 @@ declare namespace sap {
8403
8657
  */
8404
8658
  sValueState?: sap.ui.core.ValueState
8405
8659
  ): this;
8660
+ /**
8661
+ * Sets the ValueState for content controls
8662
+ *
8663
+ * @since 1.138.0
8664
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8665
+ */
8666
+ setValueStateForContent(
8667
+ /**
8668
+ * Id of the content control
8669
+ */
8670
+ sContentId: string,
8671
+ /**
8672
+ * value state
8673
+ */
8674
+ sValueState: sap.ui.core.ValueState,
8675
+ /**
8676
+ * value state text
8677
+ */
8678
+ sValueStateText: string
8679
+ ): void;
8406
8680
  /**
8407
8681
  * Sets a new value for property {@link #getValueStateText valueStateText}.
8408
8682
  *
@@ -9941,6 +10215,17 @@ declare namespace sap {
9941
10215
  * @since 1.74.0
9942
10216
  */
9943
10217
  namespace util {
10218
+ /**
10219
+ * An object literal that describes attributes of a complex data property. A complex property references
10220
+ * other properties in the `propertyInfos` attribute.
10221
+ */
10222
+ type ComplexPropertyInfo = sap.ui.mdc.util.PropertyInfoBase & {
10223
+ /**
10224
+ * A list of related properties (by key). These related properties must not themselves be complex.
10225
+ */
10226
+ propertyInfos: string[];
10227
+ };
10228
+
9944
10229
  /**
9945
10230
  * Map-like configuration object for filter creation.
9946
10231
  * The keys for this object must be aligned with any {@link sap.ui.mdc.util.FilterTypeConfig} the `FilterConditionMap`
@@ -9991,31 +10276,25 @@ declare namespace sap {
9991
10276
  };
9992
10277
 
9993
10278
  /**
9994
- * An object literal describing a data property.
10279
+ * An object literal that describes attributes of a data property.
9995
10280
  */
9996
- type PropertyInfo = {
10281
+ type PropertyInfo = sap.ui.mdc.util.PropertyInfoBase & {
9997
10282
  /**
9998
- * Unique, stable key for the property. It must only contain characters allowed for IDs, see {@link sap.ui.core.ID}.
9999
- * Does not have to be an existing attribute in the data model or the technical name of an attribute in
10000
- * the data model.
10001
- */
10002
- key: string;
10003
- /**
10004
- * The technical path for a data source property.
10283
+ * The name of the data type
10005
10284
  */
10006
- path?: string;
10285
+ dataType: string;
10007
10286
  /**
10008
- * Translatable text that labels the property.
10287
+ * Defines the formatting options for the data type
10009
10288
  */
10010
- label: string;
10289
+ formatOptions?: object;
10011
10290
  /**
10012
- * Translatable text that can optionally be offered as tooltip (For example in a personalization dialog).
10291
+ * Defines the constraints for the data type
10013
10292
  */
10014
- tooltip?: string;
10293
+ constraints?: object;
10015
10294
  /**
10016
- * Whether the property is or can be visible to a user.
10295
+ * The technical path for a data source property
10017
10296
  */
10018
- visible?: boolean;
10297
+ path?: string;
10019
10298
  /**
10020
10299
  * Defines the maximum number of filter conditions for the property. Possible values that can be used:
10021
10300
  *
@@ -10025,29 +10304,39 @@ declare namespace sap {
10025
10304
  */
10026
10305
  maxConditions?: int;
10027
10306
  /**
10028
- * The name of the data type
10307
+ * Whether filtering by this property is case-sensitive
10029
10308
  */
10030
- dataType: string;
10309
+ caseSensitive?: boolean;
10310
+ };
10311
+
10312
+ type PropertyInfoBase = {
10313
+ /**
10314
+ * Unique, stable key for the property. It must only contain characters allowed for IDs, see {@link sap.ui.core.ID}.
10315
+ * Does not have to be an existing attribute in the data model or the technical name of an attribute in
10316
+ * the data model.
10317
+ */
10318
+ key: string;
10031
10319
  /**
10032
- * Defines the format options for the data type
10320
+ * Translatable text that labels the property
10033
10321
  */
10034
- formatOptions?: object;
10322
+ label: string;
10035
10323
  /**
10036
- * Defines the constraints for the data type
10324
+ * Translatable text that can optionally be offered as tooltip, for example, in a personalization dialog
10037
10325
  */
10038
- constraints?: object;
10326
+ tooltip?: string;
10327
+ /**
10328
+ * Whether the property is or can be visible to a user
10329
+ */
10330
+ visible?: boolean;
10039
10331
  /**
10040
- * Key of the group the property is inside. Used to visually group properties in personalization dialogs.
10332
+ * Key of the group in which the property is located. Used to visually group properties in personalization
10333
+ * dialogs.
10041
10334
  */
10042
10335
  group?: string;
10043
10336
  /**
10044
10337
  * Translatable text of the group.
10045
10338
  */
10046
10339
  groupLabel?: string;
10047
- /**
10048
- * Whether filtering by this property is case-sensitive.
10049
- */
10050
- caseSensitive?: boolean;
10051
10340
  };
10052
10341
  }
10053
10342
  /**
@@ -10236,24 +10525,27 @@ declare namespace sap {
10236
10525
  /**
10237
10526
  * Defines if the typeahead container desires to be opened whenever a user clicks on a connected control
10238
10527
  *
10528
+ * @deprecated As of version 1.137. with no replacement.
10239
10529
  *
10240
10530
  * @returns If `true`, the value help should open when user clicks into the connected field control
10241
10531
  */
10242
- shouldOpenOnClick(): Promise<boolean>;
10532
+ shouldOpenOnClick?(): Promise<boolean>;
10243
10533
  /**
10244
10534
  * Defines if the typeahead container desires to be opened whenever a user focuses a connected control
10245
10535
  *
10536
+ * @deprecated As of version 1.137. with no replacement.
10246
10537
  *
10247
10538
  * @returns If `true`, the value help should open when user focuses the connected field control
10248
10539
  */
10249
- shouldOpenOnFocus(): Promise<boolean>;
10540
+ shouldOpenOnFocus?(): Promise<boolean>;
10250
10541
  /**
10251
10542
  * Defines if the typeahead containers values can be navigated without visibly opening the help
10252
10543
  *
10544
+ * @deprecated As of version 1.137. with no replacement.
10253
10545
  *
10254
10546
  * @returns If `true`, the value help should open when user used the arrow keys in the connected field control
10255
10547
  */
10256
- shouldOpenOnNavigate(): boolean;
10548
+ shouldOpenOnNavigate?(): boolean;
10257
10549
  }
10258
10550
 
10259
10551
  /**
@@ -10342,17 +10634,19 @@ declare namespace sap {
10342
10634
  * Defines if the typeahead content desires opening the typeahead whenever a user clicks on a connected
10343
10635
  * control
10344
10636
  *
10637
+ * @deprecated As of version 1.137. with no replacement.
10345
10638
  *
10346
10639
  * @returns If `true`, the value help should open when user clicks into the connected field control
10347
10640
  */
10348
- shouldOpenOnClick(): boolean;
10641
+ shouldOpenOnClick?(): boolean;
10349
10642
  /**
10350
10643
  * Defines if the typeahead containers values can be navigated without visibly opening the help
10351
10644
  *
10645
+ * @deprecated As of version 1.137. with no replacement.
10352
10646
  *
10353
10647
  * @returns If `true`, the value help should open when user used the arrow keys in the connected field control
10354
10648
  */
10355
- shouldOpenOnNavigate(): boolean;
10649
+ shouldOpenOnNavigate?(): boolean;
10356
10650
  }
10357
10651
 
10358
10652
  /**
@@ -11249,27 +11543,6 @@ declare namespace sap {
11249
11543
  * @since 1.127.0
11250
11544
  */
11251
11545
  setVisualFocus(): void;
11252
- /**
11253
- * Defines if the typeahead container desires to be opened whenever a user clicks on a connected control
11254
- *
11255
- *
11256
- * @returns If `true`, the value help should open when user clicks into the connected field control
11257
- */
11258
- shouldOpenOnClick(): Promise<boolean>;
11259
- /**
11260
- * Defines if the typeahead container desires to be opened whenever a user focuses a connected control
11261
- *
11262
- *
11263
- * @returns If `true`, the value help should open when user focuses the connected field control
11264
- */
11265
- shouldOpenOnFocus(): Promise<boolean>;
11266
- /**
11267
- * Defines if the typeahead containers values can be navigated without visibly opening the help
11268
- *
11269
- *
11270
- * @returns If `true`, the value help should open when user used the arrow keys in the connected field control
11271
- */
11272
- shouldOpenOnNavigate(): boolean;
11273
11546
  /**
11274
11547
  * Unbinds the content from the container.
11275
11548
  *
@@ -11713,21 +11986,6 @@ declare namespace sap {
11713
11986
  * @since 1.127.0
11714
11987
  */
11715
11988
  setVisualFocus(): void;
11716
- /**
11717
- * Defines if the typeahead content desires opening the typeahead whenever a user clicks on a connected
11718
- * control
11719
- *
11720
- *
11721
- * @returns If `true`, the value help should open when user clicks into the connected field control
11722
- */
11723
- shouldOpenOnClick(): boolean;
11724
- /**
11725
- * Defines if the typeahead containers values can be navigated without visibly opening the help
11726
- *
11727
- *
11728
- * @returns If `true`, the value help should open when user used the arrow keys in the connected field control
11729
- */
11730
- shouldOpenOnNavigate(): boolean;
11731
11989
  }
11732
11990
  /**
11733
11991
  * Content for the {@link sap.ui.mdc.valuehelp.base.Container Container} element.
@@ -12264,67 +12522,7 @@ declare namespace sap {
12264
12522
  /**
12265
12523
  * Configuration object type to determine a `ValueHelpItem` for a given value.
12266
12524
  */
12267
- type ItemForValueConfiguration = {
12268
- /**
12269
- * Value as entered by user
12270
- */
12271
- value: any;
12272
- /**
12273
- * Value parsed by type of key to match the data type of the key
12274
- */
12275
- parsedValue?: any;
12276
- /**
12277
- * Value parsed by type of description to match the data type of the description
12278
- */
12279
- parsedDescription?: any;
12280
- /**
12281
- * Contextual information provided by the `payload` or `inParameters`/`outParameters` of the condition.
12282
- * This is only filled if the description needs to be determined for an existing condition.
12283
- */
12284
- context?: {
12285
- /**
12286
- * In parameters of the current condition (`inParameters` are not used any longer, but it might be filled
12287
- * in older conditions stored in variants.)
12288
- */
12289
- inParameter?: object;
12290
- /**
12291
- * Out parameters of the current condition (`outParameters` are not used any longer, but it might be filled
12292
- * in older conditions stored in variants.)
12293
- */
12294
- outParameter?: object;
12295
- /**
12296
- * Payload of the current condition
12297
- */
12298
- payload?: object;
12299
- };
12300
- /**
12301
- * `BindingContext` of the checked field. Inside a table, the `ValueHelp` element might be connected to
12302
- * a different row.
12303
- */
12304
- bindingContext?: sap.ui.model.Context;
12305
- /**
12306
- * If set, the value help checks only if there is an item with the given key. This is set to `false` if
12307
- * the value cannot be a valid key because of type validation.
12308
- */
12309
- checkKey: boolean;
12310
- /**
12311
- * If set, the value help checks only if there is an item with the given description. This is set to `false`
12312
- * if only the key is used in the field.
12313
- */
12314
- checkDescription: boolean;
12315
- /**
12316
- * If set, the check is done case-sensitively
12317
- */
12318
- caseSensitive?: boolean;
12319
- /**
12320
- * If set, only exact matches and no suggestions are requested
12321
- */
12322
- exactMatch?: boolean;
12323
- /**
12324
- * Instance of the calling control
12325
- */
12326
- control: sap.ui.core.Control;
12327
- };
12525
+ type ItemForValueConfiguration = (emptyAllowed?: boolean) => object;
12328
12526
 
12329
12527
  /**
12330
12528
  * Configuration object type for normalized definition of a `ValueHelpItem`.
@@ -12559,6 +12757,26 @@ declare namespace sap {
12559
12757
  | sap.ui.base.ManagedObject.PropertyBindingInfo
12560
12758
  | `{${string}}`;
12561
12759
 
12760
+ /**
12761
+ * If set, an item to clear the selection is added.
12762
+ *
12763
+ * This item is only available if the connected field can be cleared.
12764
+ *
12765
+ * @since 1.138
12766
+ */
12767
+ emptyText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
12768
+
12769
+ /**
12770
+ * If set, the connected field must not allow other values than the items of the `FixedList`. Free text
12771
+ * must be avoided.
12772
+ *
12773
+ * @since 1.138
12774
+ */
12775
+ restrictedToFixedValues?:
12776
+ | boolean
12777
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
12778
+ | `{${string}}`;
12779
+
12562
12780
  /**
12563
12781
  * Items of the value help.
12564
12782
  *
@@ -12894,6 +13112,20 @@ declare namespace sap {
12894
13112
  * @returns Reference to `this` in order to allow method chaining
12895
13113
  */
12896
13114
  destroyItems(): this;
13115
+ /**
13116
+ * Gets current value of property {@link #getEmptyText emptyText}.
13117
+ *
13118
+ * If set, an item to clear the selection is added.
13119
+ *
13120
+ * This item is only available if the connected field can be cleared.
13121
+ *
13122
+ * Default value is `empty string`.
13123
+ *
13124
+ * @since 1.138
13125
+ *
13126
+ * @returns Value of property `emptyText`
13127
+ */
13128
+ getEmptyText(): string;
12897
13129
  /**
12898
13130
  * Gets current value of property {@link #getFilterList filterList}.
12899
13131
  *
@@ -12934,6 +13166,19 @@ declare namespace sap {
12934
13166
  * **Note:** Icons are currently not supported.
12935
13167
  */
12936
13168
  getItems(): sap.ui.mdc.valuehelp.content.FixedListItem[];
13169
+ /**
13170
+ * Gets current value of property {@link #getRestrictedToFixedValues restrictedToFixedValues}.
13171
+ *
13172
+ * If set, the connected field must not allow other values than the items of the `FixedList`. Free text
13173
+ * must be avoided.
13174
+ *
13175
+ * Default value is `false`.
13176
+ *
13177
+ * @since 1.138
13178
+ *
13179
+ * @returns Value of property `restrictedToFixedValues`
13180
+ */
13181
+ getRestrictedToFixedValues(): boolean;
12937
13182
  /**
12938
13183
  * Checks for the provided `sap.ui.mdc.valuehelp.content.FixedListItem` in the aggregation {@link #getItems items}.
12939
13184
  * and returns its index if found or -1 otherwise.
@@ -12986,6 +13231,27 @@ declare namespace sap {
12986
13231
  */
12987
13232
  vItem: int | string | sap.ui.mdc.valuehelp.content.FixedListItem
12988
13233
  ): sap.ui.mdc.valuehelp.content.FixedListItem | null;
13234
+ /**
13235
+ * Sets a new value for property {@link #getEmptyText emptyText}.
13236
+ *
13237
+ * If set, an item to clear the selection is added.
13238
+ *
13239
+ * This item is only available if the connected field can be cleared.
13240
+ *
13241
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
13242
+ *
13243
+ * Default value is `empty string`.
13244
+ *
13245
+ * @since 1.138
13246
+ *
13247
+ * @returns Reference to `this` in order to allow method chaining
13248
+ */
13249
+ setEmptyText(
13250
+ /**
13251
+ * New value for property `emptyText`
13252
+ */
13253
+ sEmptyText?: string
13254
+ ): this;
12989
13255
  /**
12990
13256
  * Sets a new value for property {@link #getFilterList filterList}.
12991
13257
  *
@@ -13028,6 +13294,26 @@ declare namespace sap {
13028
13294
  */
13029
13295
  bGroupable?: boolean
13030
13296
  ): this;
13297
+ /**
13298
+ * Sets a new value for property {@link #getRestrictedToFixedValues restrictedToFixedValues}.
13299
+ *
13300
+ * If set, the connected field must not allow other values than the items of the `FixedList`. Free text
13301
+ * must be avoided.
13302
+ *
13303
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
13304
+ *
13305
+ * Default value is `false`.
13306
+ *
13307
+ * @since 1.138
13308
+ *
13309
+ * @returns Reference to `this` in order to allow method chaining
13310
+ */
13311
+ setRestrictedToFixedValues(
13312
+ /**
13313
+ * New value for property `restrictedToFixedValues`
13314
+ */
13315
+ bRestrictedToFixedValues?: boolean
13316
+ ): this;
13031
13317
  }
13032
13318
  /**
13033
13319
  * An item that is used in the {@link sap.ui.mdc.valuehelp.content.FixedList FixedList}.
@@ -14729,31 +15015,7 @@ declare namespace sap {
14729
15015
  };
14730
15016
 
14731
15017
  /**
14732
- * An object literal describing a data property in the context of a {@link sap.ui.mdc.Table} with {@link module:sap/ui/mdc/odata/v4/TableDelegate sap/ui/mdc/odata/v4/TableDelegate}.
14733
- *
14734
- * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
14735
- * property, the following attributes need to be specified:
14736
- * - `key`
14737
- * - `path`
14738
- * - `dataType`
14739
- * - `formatOptions`
14740
- * - `constraints`
14741
- * - `maxConditions`
14742
- * - `caseSensitive`
14743
- * - `visualSettings.widthCalculation`
14744
- * - `propertyInfos`
14745
- * - `groupable`
14746
- * - `isKey`
14747
- * - `unit`
14748
- * - `text`
14749
- * - `aggregatable`
14750
- * - `extension.technicallyGroupable`
14751
- * - `extension.technicallyAggregatable`
14752
- *
14753
- * If the property is complex, the following attributes need to be specified:
14754
- * - `key`
14755
- * - `visualSettings.widthCalculation`
14756
- * - `propertyInfos` (all referenced properties must be specified)
15018
+ * An object literal describing a data property in the context of an {@link sap.ui.mdc.Table} with {@link module:sap/ui/mdc/odata/v4/TableDelegate sap/ui/mdc/odata/v4/TableDelegate}.
14757
15019
  */
14758
15020
  type PropertyInfo = sap.ui.mdc.table.PropertyInfo & {
14759
15021
  /**
@@ -15067,10 +15329,11 @@ declare namespace sap {
15067
15329
  propertyKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
15068
15330
 
15069
15331
  /**
15070
- * Indicates whether the content of the column is required. **Note:** The table only takes care of announcing
15071
- * the state of the column header as defined by the `required` property. The application needs to take care
15072
- * of the screen reader announcement of the state of the table cells, for example, by setting the `required`
15073
- * property to `true` for `sap.m.Input`.
15332
+ * Indicates whether the content of the column is required.
15333
+ *
15334
+ * **Note:** The table only takes care of announcing the state of the column header as defined by the `required`
15335
+ * property. The application needs to take care of the screen reader announcement of the state of the table
15336
+ * cells, for example, by setting the `required` property to `true` for `sap.m.Input`.
15074
15337
  */
15075
15338
  required?:
15076
15339
  | boolean
@@ -15184,10 +15447,9 @@ declare namespace sap {
15184
15447
  | `{${string}}`;
15185
15448
 
15186
15449
  /**
15187
- * Row count of the inner table.
15188
- * This property specifies the minimum row count if `sap.ui.mdc.enums.TableRowCountMode.Auto` is used.
15189
- * This property specifies the row count if `sap.ui.mdc.enums.TableRowCountMode.Interactive` or `sap.ui.mdc.enums.TableRowCountMode.Fixed`
15190
- * is used.
15450
+ * Row count of the inner table. This property specifies the minimum row count if `sap.ui.mdc.enums.TableRowCountMode.Auto`
15451
+ * is used. This property specifies the row count if `sap.ui.mdc.enums.TableRowCountMode.Interactive` or
15452
+ * `sap.ui.mdc.enums.TableRowCountMode.Fixed` is used.
15191
15453
  */
15192
15454
  rowCount?:
15193
15455
  | int
@@ -15437,9 +15699,8 @@ declare namespace sap {
15437
15699
  /**
15438
15700
  * The actions that appear at the end of a row.
15439
15701
  *
15440
- * **Note:** This aggregation cannot be bound with a factory.
15441
- * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, only the `Navigation`
15442
- * row action type is supported.
15702
+ * **Note:** This aggregation cannot be bound with a factory. If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable},
15703
+ * only the `Navigation` row action type is supported.
15443
15704
  */
15444
15705
  rowActions?:
15445
15706
  | sap.ui.mdc.table.RowActionItem[]
@@ -15764,10 +16025,11 @@ declare namespace sap {
15764
16025
  /**
15765
16026
  * Gets current value of property {@link #getRequired required}.
15766
16027
  *
15767
- * Indicates whether the content of the column is required. **Note:** The table only takes care of announcing
15768
- * the state of the column header as defined by the `required` property. The application needs to take care
15769
- * of the screen reader announcement of the state of the table cells, for example, by setting the `required`
15770
- * property to `true` for `sap.m.Input`.
16028
+ * Indicates whether the content of the column is required.
16029
+ *
16030
+ * **Note:** The table only takes care of announcing the state of the column header as defined by the `required`
16031
+ * property. The application needs to take care of the screen reader announcement of the state of the table
16032
+ * cells, for example, by setting the `required` property to `true` for `sap.m.Input`.
15771
16033
  *
15772
16034
  * Default value is `false`.
15773
16035
  *
@@ -15949,10 +16211,11 @@ declare namespace sap {
15949
16211
  /**
15950
16212
  * Sets a new value for property {@link #getRequired required}.
15951
16213
  *
15952
- * Indicates whether the content of the column is required. **Note:** The table only takes care of announcing
15953
- * the state of the column header as defined by the `required` property. The application needs to take care
15954
- * of the screen reader announcement of the state of the table cells, for example, by setting the `required`
15955
- * property to `true` for `sap.m.Input`.
16214
+ * Indicates whether the content of the column is required.
16215
+ *
16216
+ * **Note:** The table only takes care of announcing the state of the column header as defined by the `required`
16217
+ * property. The application needs to take care of the screen reader announcement of the state of the table
16218
+ * cells, for example, by setting the `required` property to `true` for `sap.m.Input`.
15956
16219
  *
15957
16220
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
15958
16221
  *
@@ -16782,11 +17045,9 @@ declare namespace sap {
16782
17045
  /**
16783
17046
  * Gets current value of property {@link #getRowCount rowCount}.
16784
17047
  *
16785
- * Row count of the inner table.
16786
- * This property specifies the minimum row count if `sap.ui.mdc.enums.TableRowCountMode.Auto` is used.
16787
- * This property specifies the row count if `sap.ui.mdc.enums.TableRowCountMode.Interactive` or `sap.ui.mdc.enums.TableRowCountMode.Fixed`
16788
- * is used.
16789
- *
17048
+ * Row count of the inner table. This property specifies the minimum row count if `sap.ui.mdc.enums.TableRowCountMode.Auto`
17049
+ * is used. This property specifies the row count if `sap.ui.mdc.enums.TableRowCountMode.Interactive` or
17050
+ * `sap.ui.mdc.enums.TableRowCountMode.Fixed` is used.
16790
17051
  *
16791
17052
  * Default value is `10`.
16792
17053
  *
@@ -16896,11 +17157,9 @@ declare namespace sap {
16896
17157
  /**
16897
17158
  * Sets a new value for property {@link #getRowCount rowCount}.
16898
17159
  *
16899
- * Row count of the inner table.
16900
- * This property specifies the minimum row count if `sap.ui.mdc.enums.TableRowCountMode.Auto` is used.
16901
- * This property specifies the row count if `sap.ui.mdc.enums.TableRowCountMode.Interactive` or `sap.ui.mdc.enums.TableRowCountMode.Fixed`
16902
- * is used.
16903
- *
17160
+ * Row count of the inner table. This property specifies the minimum row count if `sap.ui.mdc.enums.TableRowCountMode.Auto`
17161
+ * is used. This property specifies the row count if `sap.ui.mdc.enums.TableRowCountMode.Interactive` or
17162
+ * `sap.ui.mdc.enums.TableRowCountMode.Fixed` is used.
16904
17163
  *
16905
17164
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16906
17165
  *
@@ -17756,9 +18015,8 @@ declare namespace sap {
17756
18015
  *
17757
18016
  * The actions that appear at the end of a row.
17758
18017
  *
17759
- * **Note:** This aggregation cannot be bound with a factory.
17760
- * If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, only the `Navigation`
17761
- * row action type is supported.
18018
+ * **Note:** This aggregation cannot be bound with a factory. If the table type is {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable},
18019
+ * only the `Navigation` row action type is supported.
17762
18020
  */
17763
18021
  getRowActions(): sap.ui.mdc.table.RowActionItem[];
17764
18022
  /**
@@ -18032,28 +18290,79 @@ declare namespace sap {
18032
18290
  }
18033
18291
 
18034
18292
  /**
18035
- * An object literal describing a data property in the context of an {@link sap.ui.mdc.Table}.
18293
+ * An object literal that describes attributes of a complex data property in the context of an {@link sap.ui.mdc.Table}.
18294
+ * A complex property references other properties in the `propertyInfos` attribute.
18036
18295
  *
18037
- * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
18038
- * property, the following attributes need to be specified:
18039
- * - `key`
18040
- * - `path`
18041
- * - `dataType`
18042
- * - `formatOptions`
18043
- * - `constraints`
18044
- * - `maxConditions`
18045
- * - `caseSensitive`
18046
- * - `visualSettings.widthCalculation`
18047
- * - `propertyInfos`
18048
- * - `groupable`
18049
- * - `isKey`
18050
- * - `unit`
18051
- * - `text`
18296
+ * If a `sap.ui.mdc.table.Column` points to a complex property via its `propertyKey` property, the table
18297
+ * considers all the referenced properties as visible in the column. All referenced properties are taken
18298
+ * into account for certain features, for example, for the column width calculation.
18052
18299
  *
18053
- * If the property is complex, the following attributes need to be specified:
18054
- * - `key`
18055
- * - `visualSettings.widthCalculation`
18056
- * - `propertyInfos` (all referenced properties must be specified)
18300
+ * Some attributes of the referenced properties can be overridden. If, for example, `exportSettings` are
18301
+ * specified for the complex property, the export settings of the referenced properties are ignored. This
18302
+ * can be used to provide a different formatting template, for example.
18303
+ */
18304
+ type ComplexPropertyInfo = sap.ui.mdc.util.ComplexPropertyInfo & {
18305
+ /**
18306
+ * The export settings. Set to `null` to prevent this property from being exported.
18307
+ */
18308
+ exportSettings?: /* was: sap.ui.export.Column */ any | null;
18309
+ /**
18310
+ * The clipboard settings. Set to `null` to prevent this property from being copied to clipboard.
18311
+ */
18312
+ clipboardSettings?: {
18313
+ /**
18314
+ * Defines the formatting template that supports indexed placeholders for referenced properties within curly
18315
+ * brackets, for example, "{0} ({1})".
18316
+ */
18317
+ template?: string;
18318
+ } | null;
18319
+ /**
18320
+ * This object contains all relevant attributes for visual adjustments.
18321
+ */
18322
+ visualSettings?: {
18323
+ /**
18324
+ * Settings for column width calculation. Set to `null` to disable the automatic column width calculation
18325
+ * for this property.
18326
+ */
18327
+ widthCalculation?: {
18328
+ /**
18329
+ * The minimum content width in rem
18330
+ */
18331
+ minWidth?: int;
18332
+ /**
18333
+ * The maximum content width in rem
18334
+ */
18335
+ maxWidth?: int;
18336
+ /**
18337
+ * The default column content width when type check fails
18338
+ */
18339
+ defaultWidth?: int;
18340
+ /**
18341
+ * The additional content width in rem
18342
+ */
18343
+ gap?: float;
18344
+ /**
18345
+ * Whether the label is taken into account
18346
+ */
18347
+ includeLabel?: boolean;
18348
+ /**
18349
+ * Whether the label is truncated
18350
+ */
18351
+ truncateLabel?: boolean;
18352
+ /**
18353
+ * Whether the referenced properties are arranged vertically
18354
+ */
18355
+ verticalArrangement?: boolean;
18356
+ /**
18357
+ * A list of invisible referenced property keys
18358
+ */
18359
+ excludeProperties?: string[];
18360
+ } | null;
18361
+ };
18362
+ };
18363
+
18364
+ /**
18365
+ * An object literal that describes attributes of a data property in the context of an {@link sap.ui.mdc.Table}.
18057
18366
  */
18058
18367
  type PropertyInfo = sap.ui.mdc.util.PropertyInfo & {
18059
18368
  /**
@@ -18083,26 +18392,25 @@ declare namespace sap {
18083
18392
  */
18084
18393
  text?: string;
18085
18394
  /**
18086
- * Object that contains information about the export settings, see {@link sap.ui.export.Spreadsheet}.
18395
+ * The export settings. Set to `null` to prevent this property from being exported.
18087
18396
  */
18088
- exportSettings?: object;
18397
+ exportSettings?: /* was: sap.ui.export.Column */ any | null;
18089
18398
  /**
18090
- * Object that contains information about the clipboard settings. Setting this value to `null` disables
18091
- * the copy function.
18399
+ * The clipboard settings. Set to `null` prevent this property from being copied to clipboard.
18092
18400
  */
18093
18401
  clipboardSettings?: {
18094
18402
  /**
18095
- * Defines the formatting template that supports indexed placeholders of `propertyInfos` within curly brackets,
18096
- * for example, "{0} ({1})".
18403
+ * Defines the formatting template that supports indexed placeholders, for example, "{0}".
18097
18404
  */
18098
18405
  template?: string;
18099
- };
18406
+ } | null;
18100
18407
  /**
18101
18408
  * This object contains all relevant properties for visual adjustments.
18102
18409
  */
18103
18410
  visualSettings?: {
18104
18411
  /**
18105
- * This object contains all properties and their default values for the column width calculation
18412
+ * Settings for column width calculation. Set to `null` to disable the automatic column width calculation
18413
+ * for this property.
18106
18414
  */
18107
18415
  widthCalculation?: {
18108
18416
  /**
@@ -18122,11 +18430,11 @@ declare namespace sap {
18122
18430
  */
18123
18431
  gap?: float;
18124
18432
  /**
18125
- * Whether the label should be taken into account
18433
+ * Whether the label is taken into account
18126
18434
  */
18127
18435
  includeLabel?: boolean;
18128
18436
  /**
18129
- * Whether the label should be trucated or not
18437
+ * Whether the label is truncated
18130
18438
  */
18131
18439
  truncateLabel?: boolean;
18132
18440
  /**
@@ -18137,13 +18445,8 @@ declare namespace sap {
18137
18445
  * A list of invisible referenced property keys
18138
18446
  */
18139
18447
  excludeProperties?: string[];
18140
- };
18448
+ } | null;
18141
18449
  };
18142
- /**
18143
- * The availability of this property makes the `PropertyInfo` a complex `PropertyInfo`. Provides a list
18144
- * of related properties (by key). These related properties must not themselves be complex.
18145
- */
18146
- propertyInfos?: string[];
18147
18450
  };
18148
18451
 
18149
18452
  /**
@@ -18891,11 +19194,11 @@ declare namespace sap {
18891
19194
  | `{${string}}`;
18892
19195
 
18893
19196
  /**
18894
- * Personalization options for the table.
19197
+ * Personalization options for the table. The order of the provided options does not influence their order
19198
+ * on the UI.
18895
19199
  *
18896
19200
  * **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
18897
- * the documentation of the individual delegates. The order of the provided options does not influence their
18898
- * order on the UI.
19201
+ * the documentation of the individual delegates.
18899
19202
  *
18900
19203
  * @since 1.62
18901
19204
  */
@@ -18906,11 +19209,14 @@ declare namespace sap {
18906
19209
 
18907
19210
  /**
18908
19211
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
18909
- * The object has the following properties:
19212
+ *
19213
+ * The object has the following properties:
18910
19214
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
18911
19215
  *
18912
19216
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
18913
- * Sample delegate object:
19217
+ *
19218
+ *
19219
+ * Sample delegate object:
18914
19220
  * ```javascript
18915
19221
  * {
18916
19222
  * name: "sap/ui/mdc/TableDelegate",
@@ -18919,8 +19225,7 @@ declare namespace sap {
18919
19225
  *
18920
19226
  *
18921
19227
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
18922
- * that).
18923
- * Do not bind or modify the module. This property can only be configured during control initialization.
19228
+ * that). Do not bind or modify the module. This property can only be configured during control initialization.
18924
19229
  */
18925
19230
  delegate?:
18926
19231
  | object
@@ -19010,8 +19315,7 @@ declare namespace sap {
19010
19315
  * is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
19011
19316
  * value is 0, thresholding is disabled.
19012
19317
  *
19013
- * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
19014
- * uses a type-dependent default value.
19318
+ * If the value is -1, a type-dependent default value is used.
19015
19319
  *
19016
19320
  * @since 1.63
19017
19321
  */
@@ -19023,8 +19327,8 @@ declare namespace sap {
19023
19327
  /**
19024
19328
  * Defines the sort conditions.
19025
19329
  *
19026
- * **Note:** This property must not be bound.
19027
- * This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
19330
+ * **Note:** This property must not be bound. It is used exclusively for handling SAPUI5 flexibility changes.
19331
+ * Do not use it otherwise.
19028
19332
  *
19029
19333
  * @since 1.73
19030
19334
  */
@@ -19036,8 +19340,8 @@ declare namespace sap {
19036
19340
  /**
19037
19341
  * Defines the filter conditions.
19038
19342
  *
19039
- * **Note:** This property must not be bound.
19040
- * This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
19343
+ * **Note:** This property must not be bound. It is used exclusively for handling SAPUI5 flexibility changes.
19344
+ * Do not use it otherwise.
19041
19345
  *
19042
19346
  * @since 1.80.0
19043
19347
  */
@@ -19049,8 +19353,8 @@ declare namespace sap {
19049
19353
  /**
19050
19354
  * Defines the group conditions.
19051
19355
  *
19052
- * **Note:** This property must not be bound.
19053
- * This property is used exclusively for handling SAPUI5 flexibility changes. Do not use it otherwise.
19356
+ * **Note:** This property must not be bound. It is used exclusively for handling SAPUI5 flexibility changes.
19357
+ * Do not use it otherwise.
19054
19358
  *
19055
19359
  * @since 1.87
19056
19360
  */
@@ -19062,8 +19366,8 @@ declare namespace sap {
19062
19366
  /**
19063
19367
  * Defines the aggregate conditions.
19064
19368
  *
19065
- * **Note:** This property must not be bound.
19066
- * This property is exclusively used for handling SAPUI5 flexibility changes. Do not use it otherwise.
19369
+ * **Note:** This property must not be bound. It is exclusively used for handling SAPUI5 flexibility changes.
19370
+ * Do not use it otherwise.
19067
19371
  *
19068
19372
  * @since 1.87
19069
19373
  */
@@ -19165,24 +19469,23 @@ declare namespace sap {
19165
19469
  * Specifies the table metadata.
19166
19470
  *
19167
19471
  * Whenever the `TableDelegate` needs to wait for, for example, server-side information to provide the `PropertyInfo`
19168
- * objects, specifying an array of {@link sap.ui.mdc.table.PropertyInfo PropertyInfo} objects here enables
19169
- * the table to speed up the initial setup.
19472
+ * objects, specifying an array of {@link sap.ui.mdc.table.PropertyInfo PropertyInfo} and {@link sap.ui.mdc.table.ComplexPropertyInfo ComplexPropertyInfo }
19473
+ * objects in this property enables the table to speed up the initial setup.
19170
19474
  *
19171
19475
  * Instead of requesting the `PropertyInfo` objects from the `TableDelegate` and waiting for them, the table
19172
19476
  * will use the `PropertyInfo` objects specified here for rendering-specific tasks, e.g. automatic column
19173
19477
  * width calculation, and to trigger the initial data request.
19174
19478
  *
19175
- * To enable the table for these tasks, certain attributes of a `PropertyInfo` must be specified. You can
19176
- * find the list of required attributes in the documentation of the `PropertyInfo`, for example, in {@link sap.ui.mdc.table.PropertyInfo}.
19177
- *
19178
- * This property is processed only once during the instantiation of the table. Any subsequent changes have
19179
- * no effect.
19479
+ * **Note:**
19480
+ * - This property is processed only once during the instantiation of the table. Any subsequent changes
19481
+ * have no effect.
19482
+ * - This property must not be bound.
19483
+ * - This property is used exclusively for SAPUI5 flexibility / Fiori Elements. Do not use it otherwise.
19180
19484
  *
19181
- * **Note**: This property must not be bound. **Note**: This property is used exclusively for SAPUI5 flexibility
19182
- * / Fiori Elements. Do not use it otherwise. **Note**: Existing properties (set via `sap.ui.mdc.Table#setPropertyInfo`)
19183
- * must not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties }
19184
- * callback. Otherwise validation errors might occur whenever personalization-related control features (such
19185
- * as the opening of any personalization dialog) are activated.
19485
+ * - Existing properties (set via `sap.ui.mdc.Table#setPropertyInfo`) must not be removed and their attributes
19486
+ * must not be changed during the {@link module:sap/ui/mdc/TableDelegate.fetchProperties fetchProperties }
19487
+ * callback. Otherwise validation errors might occur whenever personalization-related control features (such
19488
+ * as the opening of any personalization dialog) are activated.
19186
19489
  *
19187
19490
  * @since 1.111
19188
19491
  */
@@ -19195,7 +19498,6 @@ declare namespace sap {
19195
19498
  * Determines whether the toolbar is visible.
19196
19499
  *
19197
19500
  * **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
19198
- *
19199
19501
  * - The `showRowCount` property **must** be set to `false`.
19200
19502
  * - The export **must** be disabled by setting the `enableExport` property to `false`.
19201
19503
  * - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
@@ -19300,9 +19602,8 @@ declare namespace sap {
19300
19602
  * `false`.
19301
19603
  *
19302
19604
  * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
19303
- * must not be managed by the application.
19304
- * The `CopyProvider` requires a secure context to access the clipboard API. If the context is not secure,
19305
- * the plugin will not be added, and the Copy button will not be generated.
19605
+ * must not be managed by the application. The `CopyProvider` requires a secure context to access the clipboard
19606
+ * API. If the context is not secure, the plugin will not be added, and the Copy button will not be generated.
19306
19607
  *
19307
19608
  * @since 1.114
19308
19609
  */
@@ -22708,7 +23009,7 @@ declare namespace sap {
22708
23009
  /**
22709
23010
  * A metadata-driven table to simplify the usage of existing tables, such as the `ResponsiveTable` and `GridTable`
22710
23011
  * controls. The metadata needs to be provided via the {@link module:sap/ui/mdc/TableDelegate TableDelegate }
22711
- * implementation as {@link sap.ui.mdc.table.PropertyInfo}.
23012
+ * implementation as {@link sap.ui.mdc.table.PropertyInfo} and {@link sap.ui.mdc.table.ComplexPropertyInfo}.
22712
23013
  *
22713
23014
  * **Note:** Read and write access to internal elements is not permitted. Such elements are, for example,
22714
23015
  * the inner table including its children. This is independent of how access was gained. Internal elements
@@ -23369,9 +23670,8 @@ declare namespace sap {
23369
23670
  * `false`.
23370
23671
  *
23371
23672
  * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider`
23372
- * must not be managed by the application.
23373
- * The `CopyProvider` requires a secure context to access the clipboard API. If the context is not secure,
23374
- * the plugin will not be added, and the Copy button will not be generated.
23673
+ * must not be managed by the application. The `CopyProvider` requires a secure context to access the clipboard
23674
+ * API. If the context is not secure, the plugin will not be added, and the Copy button will not be generated.
23375
23675
  *
23376
23676
  * @since 1.114
23377
23677
  */
@@ -23388,11 +23688,14 @@ declare namespace sap {
23388
23688
  * Gets current value of property {@link #getDelegate delegate}.
23389
23689
  *
23390
23690
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
23391
- * The object has the following properties:
23691
+ *
23692
+ * The object has the following properties:
23392
23693
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
23393
23694
  *
23394
23695
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
23395
- * Sample delegate object:
23696
+ *
23697
+ *
23698
+ * Sample delegate object:
23396
23699
  * ```javascript
23397
23700
  * {
23398
23701
  * name: "sap/ui/mdc/TableDelegate",
@@ -23401,8 +23704,7 @@ declare namespace sap {
23401
23704
  *
23402
23705
  *
23403
23706
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
23404
- * that).
23405
- * Do not bind or modify the module. This property can only be configured during control initialization.
23707
+ * that). Do not bind or modify the module. This property can only be configured during control initialization.
23406
23708
  *
23407
23709
  * Default value is `...see text or source`.
23408
23710
  *
@@ -23529,7 +23831,6 @@ declare namespace sap {
23529
23831
  * Determines whether the toolbar is visible.
23530
23832
  *
23531
23833
  * **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
23532
- *
23533
23834
  * - The `showRowCount` property **must** be set to `false`.
23534
23835
  * - The export **must** be disabled by setting the `enableExport` property to `false`.
23535
23836
  * - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
@@ -23584,11 +23885,11 @@ declare namespace sap {
23584
23885
  /**
23585
23886
  * Gets current value of property {@link #getP13nMode p13nMode}.
23586
23887
  *
23587
- * Personalization options for the table.
23888
+ * Personalization options for the table. The order of the provided options does not influence their order
23889
+ * on the UI.
23588
23890
  *
23589
23891
  * **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
23590
- * the documentation of the individual delegates. The order of the provided options does not influence their
23591
- * order on the UI.
23892
+ * the documentation of the individual delegates.
23592
23893
  *
23593
23894
  * Default value is `[]`.
23594
23895
  *
@@ -23676,8 +23977,7 @@ declare namespace sap {
23676
23977
  * is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
23677
23978
  * value is 0, thresholding is disabled.
23678
23979
  *
23679
- * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
23680
- * uses a type-dependent default value.
23980
+ * If the value is -1, a type-dependent default value is used.
23681
23981
  *
23682
23982
  * Default value is `-1`.
23683
23983
  *
@@ -23879,11 +24179,14 @@ declare namespace sap {
23879
24179
  * Sets a new value for property {@link #getDelegate delegate}.
23880
24180
  *
23881
24181
  * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
23882
- * The object has the following properties:
24182
+ *
24183
+ * The object has the following properties:
23883
24184
  * - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
23884
24185
  *
23885
24186
  * - `payload` (optional) defines application-specific information that can be used in the given delegate
23886
- * Sample delegate object:
24187
+ *
24188
+ *
24189
+ * Sample delegate object:
23887
24190
  * ```javascript
23888
24191
  * {
23889
24192
  * name: "sap/ui/mdc/TableDelegate",
@@ -23892,8 +24195,7 @@ declare namespace sap {
23892
24195
  *
23893
24196
  *
23894
24197
  * **Note:** Ensure that the related file can be requested (any required library has to be loaded before
23895
- * that).
23896
- * Do not bind or modify the module. This property can only be configured during control initialization.
24198
+ * that). Do not bind or modify the module. This property can only be configured during control initialization.
23897
24199
  *
23898
24200
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
23899
24201
  *
@@ -24092,7 +24394,6 @@ declare namespace sap {
24092
24394
  * Determines whether the toolbar is visible.
24093
24395
  *
24094
24396
  * **Note:** Hiding the toolbar limits the functionality of the table in the following ways:
24095
- *
24096
24397
  * - The `showRowCount` property **must** be set to `false`.
24097
24398
  * - The export **must** be disabled by setting the `enableExport` property to `false`.
24098
24399
  * - For {@link sap.ui.mdc.table.ResponsiveTableType ResponsiveTable}, show and hide details won't be
@@ -24163,11 +24464,11 @@ declare namespace sap {
24163
24464
  /**
24164
24465
  * Sets a new value for property {@link #getP13nMode p13nMode}.
24165
24466
  *
24166
- * Personalization options for the table.
24467
+ * Personalization options for the table. The order of the provided options does not influence their order
24468
+ * on the UI.
24167
24469
  *
24168
24470
  * **Note:** Whether a personalization option is supported depends on the used delegate. Please refer to
24169
- * the documentation of the individual delegates. The order of the provided options does not influence their
24170
- * order on the UI.
24471
+ * the documentation of the individual delegates.
24171
24472
  *
24172
24473
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
24173
24474
  *
@@ -24285,8 +24586,7 @@ declare namespace sap {
24285
24586
  * is lower than the number of visible rows, the number of visible rows is used as the `threshold`. If the
24286
24587
  * value is 0, thresholding is disabled.
24287
24588
  *
24288
- * **Note:** This property only takes effect if it is set to a positive integer value. Otherwise the table
24289
- * uses a type-dependent default value.
24589
+ * If the value is -1, a type-dependent default value is used.
24290
24590
  *
24291
24591
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
24292
24592
  *
@@ -25157,6 +25457,8 @@ declare namespace sap {
25157
25457
 
25158
25458
  "sap/ui/mdc/field/FieldMultiInput": undefined;
25159
25459
 
25460
+ "sap/ui/mdc/field/FieldSelect": undefined;
25461
+
25160
25462
  "sap/ui/mdc/field/ListFieldHelpItem": undefined;
25161
25463
 
25162
25464
  "sap/ui/mdc/field/MultiValueFieldDelegate": undefined;
@@ -25301,6 +25603,8 @@ declare namespace sap {
25301
25603
 
25302
25604
  "sap/ui/mdc/valuehelp/Popover": undefined;
25303
25605
 
25606
+ "sap/ui/mdc/valuehelp/RequestShowContainerDefault": undefined;
25607
+
25304
25608
  "sap/ui/mdc/ValueHelpDelegate": undefined;
25305
25609
  }
25306
25610
  }