@sapui5/ts-types-esm 1.131.0 → 1.132.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +5 -0
  7. package/types/sap.esh.search.ui.d.ts +35 -1
  8. package/types/sap.f.d.ts +103 -197
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +1 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +123 -94
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +1 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +408 -56
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +7 -2
  28. package/types/sap.rules.ui.d.ts +86 -1
  29. package/types/sap.sac.df.d.ts +1245 -890
  30. package/types/sap.suite.ui.commons.d.ts +1 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +7 -7
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +66 -5
  37. package/types/sap.ui.core.d.ts +363 -282
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +7 -1
  41. package/types/sap.ui.generic.app.d.ts +5 -11
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +1 -1
  44. package/types/sap.ui.layout.d.ts +1 -1
  45. package/types/sap.ui.mdc.d.ts +439 -342
  46. package/types/sap.ui.richtexteditor.d.ts +1 -1
  47. package/types/sap.ui.rta.d.ts +3 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +13 -1
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +25 -15
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +96 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +5 -1
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +1 -1
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.131.0
1
+ // For Library Version: 1.132.1
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -150,14 +150,20 @@ declare module "sap/ui/mdc/ChartDelegate" {
150
150
 
151
151
  import Item from "sap/ui/mdc/chart/Item";
152
152
 
153
+ import Control from "sap/ui/core/Control";
154
+
155
+ import Context from "sap/ui/model/Context";
156
+
157
+ import ChartSelectionDetails from "sap/ui/mdc/chart/ChartSelectionDetails";
158
+
159
+ import FieldInfoBase from "sap/ui/mdc/field/FieldInfoBase";
160
+
153
161
  import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
154
162
 
155
163
  import FilterField from "sap/ui/mdc/FilterField";
156
164
 
157
165
  import Filter from "sap/ui/model/Filter";
158
166
 
159
- import Control from "sap/ui/core/Control";
160
-
161
167
  import { URI } from "sap/ui/core/library";
162
168
 
163
169
  /**
@@ -180,7 +186,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
180
186
  */
181
187
  addItem(
182
188
  /**
183
- * Reference to the MDC chart to add the property to
189
+ * Reference to the chart to which the property is added
184
190
  */
185
191
  oChart: Chart,
186
192
  /**
@@ -203,7 +209,11 @@ declare module "sap/ui/mdc/ChartDelegate" {
203
209
  /**
204
210
  * Reference to the chart
205
211
  */
206
- oChart: Chart
212
+ oChart: Chart,
213
+ /**
214
+ * noDataControl which should be used
215
+ */
216
+ oControl: Control
207
217
  ): void;
208
218
  /**
209
219
  * Creates the initial content for the chart before the metadata is retrieved.
@@ -218,6 +228,9 @@ declare module "sap/ui/mdc/ChartDelegate" {
218
228
  ): void;
219
229
  /**
220
230
  * Binds the inner chart to the back-end data and creates the inner chart content.
231
+ *
232
+ *
233
+ * @returns Resolved once inner chart has been created
221
234
  */
222
235
  createInnerChartContent(
223
236
  /**
@@ -228,9 +241,53 @@ declare module "sap/ui/mdc/ChartDelegate" {
228
241
  * Callback function when data is loaded
229
242
  */
230
243
  fnCallbackDataLoaded: Function
231
- ): void;
244
+ ): Promise<any>;
245
+ /**
246
+ * Determines if a given `SelectionDetailsItem` is enabled.
247
+ *
248
+ *
249
+ * @returns Boolean value that is forwarded to the enableNav property of the `SelectionDetailsItem`
250
+ */
251
+ determineEnableNavForDetailsItem(
252
+ /**
253
+ * Reference to the chart
254
+ */
255
+ oChart: Chart,
256
+ /**
257
+ * The data array of the selected item
258
+ */
259
+ mData: any[],
260
+ /**
261
+ * Binding context of the item in the selection. This is undefined if no binding is used
262
+ */
263
+ oContext: Context | undefined
264
+ ): boolean;
232
265
  /**
233
- * Gets the relevant PropertyInfos based on the metadata used with the chart instance.
266
+ * The provided map is used to determine the navigation behavior of the {@link sap.ui.mdc.chart.ChartSelectionDetails}.
267
+ * The navigation shows a list of all entries if more than 1 entry of {@link sap.ui.mdc.field.FieldInfoBase }
268
+ * is given in the map. If there is only one entry, the navigation goes directly to the content of the given
269
+ * {@link sap.ui.mdc.field.FieldInfoBase}.
270
+ *
271
+ *
272
+ * @returns Promise resolving in a `Map` containing a Name as key and a {@link sap.ui.mdc.field.FieldInfoBase }
273
+ * as value
274
+ */
275
+ fetchFieldInfos(
276
+ /**
277
+ * Reference to the chart
278
+ */
279
+ oChart: Chart,
280
+ /**
281
+ * Instance of the {@link sap.ui.mdc.chart.ChartSelectionDetails}
282
+ */
283
+ oSelectionDetails: ChartSelectionDetails,
284
+ /**
285
+ * Binding context of the `SelectionDetailsItem` to which is navigated
286
+ */
287
+ oBindingContext: Context
288
+ ): Promise<Map<string, FieldInfoBase>>;
289
+ /**
290
+ * Gets the relevant `PropertyInfo` objects based on the metadata used with the chart instance.
234
291
  *
235
292
  * **Note:** The result of this function must be kept stable throughout the lifecycle of your application.
236
293
  * Any changes of the returned values might result in undesired effects.
@@ -262,7 +319,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
262
319
  oChart: Chart
263
320
  ): ChartTypeObject[];
264
321
  /**
265
- * Gets the binding info for given chart.
322
+ * Gets the binding info for a given chart.
266
323
  *
267
324
  *
268
325
  * @returns BindingInfo object
@@ -277,14 +334,16 @@ declare module "sap/ui/mdc/ChartDelegate" {
277
334
  * Gets the current chart type.
278
335
  *
279
336
  *
280
- * @returns Information about the current chart type
337
+ * @returns Information about the current chart type The object has the following properties:
338
+ * - `icon` defines the path to the `icon`
339
+ * - `text` (optional) defines tooltip of the chart type
281
340
  */
282
341
  getChartTypeInfo(
283
342
  /**
284
- * Reference to the MDC chart
343
+ * Reference to the chart
285
344
  */
286
345
  oChart: Chart
287
- ): ChartTypeObject[];
346
+ ): object;
288
347
  /**
289
348
  * This function is used by `P13n` to determine which chart type supports which layout options. There might
290
349
  * be chart types that do not support certain layout options (for example, "Axis3").
@@ -297,7 +356,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
297
356
  * Gets the drillable items. This function is used by the breadcrumb navigation.
298
357
  *
299
358
  *
300
- * @returns Array of MDC items that are drillable
359
+ * @returns Array of items that are drillable
301
360
  */
302
361
  getDrillableItems(
303
362
  /**
@@ -308,17 +367,17 @@ declare module "sap/ui/mdc/ChartDelegate" {
308
367
  /**
309
368
  * Gets the current drilling stack of the inner chart.
310
369
  * The returned objects need at least a `label` and a `name` property.
311
- * Also, a `dimension` array containing the dimension drill stack at the current level is required.
370
+ * Also, a `dimension` array containing the dimension drilling stack at the current level is required.
312
371
  *
313
372
  *
314
- * @returns Array containing the drill stack
373
+ * @returns Array containing the drilling stack
315
374
  */
316
375
  getDrillStack(
317
376
  /**
318
377
  * Reference to the chart
319
378
  */
320
379
  oChart: Chart
321
- ): any[];
380
+ ): object[];
322
381
  /**
323
382
  * Gets the filter delegate of the chart that provides basic filter functionality, such as adding filter
324
383
  * fields. **Note:** The functionality provided in this delegate acts as a subset of a `FilterBarDelegate`
@@ -332,8 +391,8 @@ declare module "sap/ui/mdc/ChartDelegate" {
332
391
  addItem: (p1: Chart, p2: string) => Promise<FilterField>;
333
392
  };
334
393
  /**
335
- * Gets the filters to be applied when updating the chart's binding based on the filter conditions of the
336
- * chart itself and it's associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
394
+ * Gets the filters that are applied when updating the chart's binding based on the filter conditions of
395
+ * the chart itself and its associated {@link sap.ui.mdc.IFilterSource IFilterSource}.
337
396
  *
338
397
  * @since 1.121
339
398
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -354,7 +413,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
354
413
  */
355
414
  getInnerChart(
356
415
  /**
357
- * Reference to the MDC chart
416
+ * Reference to the chart
358
417
  */
359
418
  oChart: Chart
360
419
  ): Control;
@@ -383,7 +442,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
383
442
  oChart: Chart
384
443
  ): SelectionDetails;
385
444
  /**
386
- * Gets an ID that should be used in the internal chart for the Measure/Dimension.
445
+ * Gets an ID that is used in the internal chart for the measure/dimension.
387
446
  * For standard cases, this is just the ID of the property.
388
447
  * If it is necessary to use another ID internally inside the chart (for example, for duplicate property
389
448
  * IDs) this method can be overwritten.
@@ -407,7 +466,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
407
466
  oChart: Chart
408
467
  ): string;
409
468
  /**
410
- * Gets a PropertyInfo object based on an internal chart dimension/measure and type of a property.
469
+ * Gets a `PropertyInfo` object based on an internal chart dimension/measure and type of a property.
411
470
  *
412
471
  *
413
472
  * @returns PropertyInfo object
@@ -431,14 +490,14 @@ declare module "sap/ui/mdc/ChartDelegate" {
431
490
  * in the drill-down popover of the chart.
432
491
  *
433
492
  *
434
- * @returns `Promise` containing an array of dimensions that is sorted
493
+ * @returns `Promise` containing an array of dimensions propertyInfo objects that is sorted
435
494
  */
436
495
  getSortedDimensions(
437
496
  /**
438
497
  * Reference to the chart
439
498
  */
440
499
  oChart: Chart
441
- ): Promise<Item[]>;
500
+ ): Promise<PropertyInfo[]>;
442
501
  /**
443
502
  * Gets the current zooming information for the inner chart.
444
503
  *
@@ -506,7 +565,7 @@ declare module "sap/ui/mdc/ChartDelegate" {
506
565
  */
507
566
  removeItem(
508
567
  /**
509
- * Reference to the MDC chart from which property is removed
568
+ * Reference to the chart from which the property is removed
510
569
  */
511
570
  oChart: Chart,
512
571
  /**
@@ -601,8 +660,10 @@ declare module "sap/ui/mdc/ChartDelegate" {
601
660
  bShow: boolean
602
661
  ): void;
603
662
  /**
604
- * Updates the binding info with the relevant filters.
605
- * By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
663
+ * Updates the binding info with the relevant filters and sorters.
664
+ *
665
+ *
666
+ * By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo }
606
667
  * with the return value from the delegate's own {@link module:sap/ui/mdc/ChartDelegate.getFilters getFilters}.
607
668
  */
608
669
  updateBindingInfo(
@@ -639,8 +700,6 @@ declare module "sap/ui/mdc/ChartDelegate" {
639
700
 
640
701
  /**
641
702
  * Chart `ChartTypeLayoutConfig` type.
642
- *
643
- * @experimental (since 1.80)
644
703
  */
645
704
  export type ChartTypeLayoutConfig = {
646
705
  /**
@@ -650,13 +709,11 @@ declare module "sap/ui/mdc/ChartDelegate" {
650
709
  /**
651
710
  * Layout configuration of chart type
652
711
  */
653
- allowedLayoutOptions: string[];
712
+ allowedLayoutOptions: /* was: sap.ui.mdc.enums.ChartItemRoleType */ any[];
654
713
  };
655
714
 
656
715
  /**
657
- * Chart `ChartTypeObject` type.
658
- *
659
- * @experimental (since 1.80)
716
+ * Defines the chart `ChartTypeObject` type.
660
717
  */
661
718
  export type ChartTypeObject = {
662
719
  /**
@@ -671,16 +728,10 @@ declare module "sap/ui/mdc/ChartDelegate" {
671
728
  * Name of the current chart type
672
729
  */
673
730
  text: string;
674
- /**
675
- * Whether the chart type is the one currently used
676
- */
677
- selected: boolean;
678
731
  };
679
732
 
680
733
  /**
681
734
  * Event handler for `SelectionDetails` popover.
682
- *
683
- * @experimental (since 1.80)
684
735
  */
685
736
  export type SelectionDetails = {
686
737
  /**
@@ -695,8 +746,6 @@ declare module "sap/ui/mdc/ChartDelegate" {
695
746
 
696
747
  /**
697
748
  * Chart `ZoomState` type.
698
- *
699
- * @experimental (since 1.80)
700
749
  */
701
750
  export type ZoomState = {
702
751
  /**
@@ -1789,7 +1838,10 @@ declare module "sap/ui/mdc/odata/TypeMap" {
1789
1838
  declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1790
1839
  import TableDelegate1 from "sap/ui/mdc/TableDelegate";
1791
1840
 
1792
- import { default as Table, TablePropertyInfo } from "sap/ui/mdc/Table";
1841
+ import {
1842
+ default as Table,
1843
+ PropertyInfo as PropertyInfo1,
1844
+ } from "sap/ui/mdc/Table";
1793
1845
 
1794
1846
  import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
1795
1847
 
@@ -1799,12 +1851,38 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1799
1851
  * Base delegate for {@link sap.ui.mdc.Table} and `ODataV4`. Extend this object in your project to use all
1800
1852
  * functionalities of the table. For more information, please see {@link module:sap/ui/mdc/TableDelegate}.
1801
1853
  *
1802
- * **Note:** This base delegate supports the `p13nMode` `Aggregate` only if the table type is {@link sap.ui.mdc.table.GridTableType GridTable},
1803
- * and the `p13nMode` `Group` is not supported if the table type is {@link sap.ui.mdc.table.TreeTableType TreeTable}.
1854
+ * Data aggregation is enabled if the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, and
1855
+ * at least one of the following conditions is fulfilled:
1856
+ * - `p13nMode` `Group` is enabled
1857
+ * - `p13nMode` `Aggregate` is enabled
1858
+ * - The table has group conditions
1859
+ * - The table has aggregate conditions
1860
+ *
1861
+ * Data aggregation can be configured via the delegate payload by providing `aggregationConfiguration`.
1862
+ * See {@link sap.ui.mdc.odata.v4.TableDelegate.Payload} for details.
1863
+ *
1864
+ * Sample delegate object:
1865
+ * ```javascript
1866
+ * {
1867
+ * name: "my/delegate/extending/sap/ui/mdc/odata/v4/TableDelegate",
1868
+ * payload: {
1869
+ * aggregationConfiguration: {
1870
+ * leafLevel: true
1871
+ * },
1872
+ * ...
1873
+ * }
1874
+ * }```
1875
+ *
1876
+ *
1877
+ * If data aggregation is enabled, the following restrictions apply:
1878
+ * - Only properties that are technically groupable or technically aggregatable are loaded from the back
1879
+ * end. See {@link sap.ui.mdc.odata.v4.TableDelegate.PropertyInfo} for more information about properties.
1880
+ *
1881
+ * - The path of a property must not contain a `NavigationProperty`.
1882
+ *
1883
+ * **Note:** This base delegate supports the `p13nMode` `Aggregate` only if the table type is {@link sap.ui.mdc.table.GridTableType GridTable}.
1884
+ * The `p13nMode` `Group` is not supported if the table type is {@link sap.ui.mdc.table.TreeTableType TreeTable}.
1804
1885
  * This cannot be changed in your delegate implementation.
1805
- * If the table type is {@link sap.ui.mdc.table.GridTableType GridTable}, and `p13nMode` `Group` or `p13nMode`
1806
- * `Aggregate` is enabled, only groupable or aggregatable properties are loaded from the back end. Also,
1807
- * the path of a property must not contain a `NavigationProperty`.
1808
1886
  *
1809
1887
  * @since 1.85
1810
1888
  */
@@ -1823,7 +1901,7 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1823
1901
  * Instance of the table
1824
1902
  */
1825
1903
  oTable: Table
1826
- ): Promise<TablePropertyInfo[]>;
1904
+ ): Promise<PropertyInfo[]>;
1827
1905
  /**
1828
1906
  * Returns the keys of properties that should always be included in the result of the collection requested
1829
1907
  * from the back end. This information is applied when updating the table's binding.
@@ -1836,9 +1914,9 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1836
1914
  * The path of a property must not be empty.
1837
1915
  * If a property is complex, the properties it references are taken into account.
1838
1916
  * If `autoExpandSelect` of the {@link sap.ui.model.odata.v4.ODataModel} is not enabled, this method must
1839
- * return an empty array. If the table type is {@link sap.ui.mdc.table.GridTableType GridTable} and `p13nMode`
1840
- * `Group` or `p13nMode` `Aggregate` is enabled, also see the restrictions in the description of the {@link module:sap/ui/mdc/odata/v4/TableDelegate TableDelegate}.
1841
- * For more information about properties, see {@link sap.ui.mdc.odata.v4.TablePropertyInfo PropertyInfo}.
1917
+ * return an empty array. See also the restrictions in the description of the {@link module:sap/ui/mdc/odata/v4/TableDelegate TableDelegate }
1918
+ * if data aggregation is enabled.
1919
+ * For more information about properties, see {@link sap.ui.mdc.odata.v4.TableDelegate.PropertyInfo PropertyInfo}.
1842
1920
  *
1843
1921
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1844
1922
  *
@@ -1892,6 +1970,82 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1892
1970
  }
1893
1971
  const TableDelegate: TableDelegate;
1894
1972
  export default TableDelegate;
1973
+
1974
+ /**
1975
+ * Payload for the {@link module:sap/ui/mdc/odata/v4/TableDelegate ODataV4 TableDelegate}. Contains settings
1976
+ * to control the behavior of the delegate.
1977
+ *
1978
+ * @since 1.132
1979
+ */
1980
+ export type Payload = {
1981
+ /**
1982
+ * The configuration that is applied if data aggregation is enabled in the delegate.
1983
+ */
1984
+ aggregationConfiguration?: {
1985
+ /**
1986
+ * Determines whether aggregation on the leaf level is enabled. If it is enabled, every column change affects
1987
+ * the data in the table.
1988
+ */
1989
+ leafLevel?: boolean;
1990
+ };
1991
+ };
1992
+
1993
+ /**
1994
+ * 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}.
1995
+ *
1996
+ * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
1997
+ * property, the following attributes need to be specified:
1998
+ * - `key`
1999
+ * - `path`
2000
+ * - `dataType`
2001
+ * - `formatOptions`
2002
+ * - `constraints`
2003
+ * - `maxConditions`
2004
+ * - `caseSensitive`
2005
+ * - `visualSettings.widthCalculation`
2006
+ * - `propertyInfos`
2007
+ * - `groupable`
2008
+ * - `isKey`
2009
+ * - `unit`
2010
+ * - `text`
2011
+ * - `aggregatable`
2012
+ * - `extension.technicallyGroupable`
2013
+ * - `extension.technicallyAggregatable`
2014
+ *
2015
+ * If the property is complex, the following attributes need to be specified:
2016
+ * - `key`
2017
+ * - `visualSettings.widthCalculation`
2018
+ * - `propertyInfos` (all referenced properties must be specified)
2019
+ */
2020
+ export type PropertyInfo = PropertyInfo1 & {
2021
+ /**
2022
+ * Defines whether a property is a key or part of a key in the data. A key property must be technically
2023
+ * groupable.
2024
+ */
2025
+ isKey?: boolean;
2026
+ /**
2027
+ * Defines whether the property is aggregatable. A property can only be declared aggregatable if there is
2028
+ * a `CustomAggregate` whose `Qualifier` is equal to the property key.
2029
+ */
2030
+ aggregatable?: boolean;
2031
+ /**
2032
+ * Contains model-specific information.
2033
+ */
2034
+ extension?: {
2035
+ /**
2036
+ * If `groupable` is set to `false` to exclude it from group personalization on the UI, the UI still needs
2037
+ * to know that this property is groupable for data requests. If this attribute is not set, the default
2038
+ * value is the same as the value of `groupable`.
2039
+ */
2040
+ technicallyGroupable?: boolean;
2041
+ /**
2042
+ * If `aggregatable` is set to `false` to exclude it from aggregate personalization on the UI, the UI still
2043
+ * needs to know that this property is aggregatable for data requests. If this attribute is not set, the
2044
+ * default value is the same as the value of `aggregatable`.
2045
+ */
2046
+ technicallyAggregatable?: boolean;
2047
+ };
2048
+ };
1895
2049
  }
1896
2050
 
1897
2051
  declare module "sap/ui/mdc/odata/v4/TypeMap" {
@@ -1999,31 +2153,28 @@ declare module "sap/ui/mdc/TableDelegate" {
1999
2153
  */
2000
2154
  oTable: Table | Element,
2001
2155
  /**
2002
- * The property name
2156
+ * The property key
2003
2157
  */
2004
- sPropertyName: string,
2158
+ sPropertyKey: string,
2005
2159
  /**
2006
2160
  * Instance of a property bag from the SAPUI5 flexibility API
2007
2161
  */
2008
2162
  mPropertyBag?: Object
2009
2163
  ): Promise<Column>;
2010
2164
  /**
2011
- * Returns the feature set for expanding or collapsing in the table.
2165
+ * Returns the feature set for expanding or collapsing nodes in the table.
2012
2166
  *
2013
2167
  * By default, this method returns an empty object.
2014
2168
  *
2015
- * The configuration object needs to contain the following functions to enable specific functionalities:
2169
+ * To enable specific functionalities, the configuration must contain the following functions:
2170
+ * - To enable **Expand Entire Tree**, the `expandAll` function needs to be implemented.
2171
+ * - To enable **Collapse Entire Tree**, the `collapseAll` function needs to be implemented.
2172
+ * - To enable **Expand Entire Node**, the `expandAllFromNode` and `isNodeExpanded` functions need to
2173
+ * be implemented.
2174
+ * - To enable **Collapse Entire Node**, the `collapseAllFromNode` and `isNodeExpanded` functions need
2175
+ * to be implemented.
2016
2176
  *
2017
- * - To enable the **expand all** functionality, you need to implement the `expandAll` function in the
2018
- * configuration object.
2019
- * - To enable the **collapse all** functionality, you need to implement the `collapseAll` function in
2020
- * the configuration object.
2021
- * - To enable the **expand all from a specific node** functionality, you need to implement the `expandAllFromNode`
2022
- * and the `isNodeExpanded` function in the configuration object.
2023
- * - To enable the **collapse all from a specific node** functionality, you need to implement the `collapseAllFromNode`
2024
- * and the `isNodeExpanded` function in the configuration object.
2025
- *
2026
- * **Note:** Expand and collapse all from a specific node is only supported, if the table rows are selectable.
2177
+ * **Note:** Expand and collapse all from a specific node is only supported if the table rows are selectable.
2027
2178
  *
2028
2179
  * @ui5-protected Do not call from applications (only from related classes in the framework)
2029
2180
  *
@@ -2031,10 +2182,10 @@ declare module "sap/ui/mdc/TableDelegate" {
2031
2182
  */
2032
2183
  fetchExpandAndCollapseConfiguration(
2033
2184
  /**
2034
- * table instance
2185
+ * Table instance
2035
2186
  */
2036
2187
  oTable: Table
2037
- ): Promise</* was: sap.ui.mdc.TableDelegate.ExpandAndCollapseConfiguration */ any>;
2188
+ ): Promise<ExpandAndCollapseConfiguration>;
2038
2189
  /**
2039
2190
  * Returns the feature set for exporting data in the table.
2040
2191
  *
@@ -2090,9 +2241,9 @@ declare module "sap/ui/mdc/TableDelegate" {
2090
2241
  */
2091
2242
  oContext: Context,
2092
2243
  /**
2093
- * Name of the grouped property
2244
+ * Key of the grouped property
2094
2245
  */
2095
- sProperty: string
2246
+ sPropertyKey: string
2096
2247
  ): string;
2097
2248
  /**
2098
2249
  * Returns the filter delegate of the table that provides basic filter functionality, such as adding filter
@@ -2228,6 +2379,44 @@ declare module "sap/ui/mdc/TableDelegate" {
2228
2379
  }
2229
2380
  const TableDelegate: TableDelegate;
2230
2381
  export default TableDelegate;
2382
+
2383
+ /**
2384
+ * Represents the expand and collapse configuration object.
2385
+ *
2386
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2387
+ */
2388
+ export type ExpandAndCollapseConfiguration = {
2389
+ /**
2390
+ * Function to expand all rows
2391
+ *
2392
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2393
+ */
2394
+ expandAll?: (p1: Table) => void;
2395
+ /**
2396
+ * Function to collapse all rows
2397
+ *
2398
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2399
+ */
2400
+ collapseAll?: (p1: Table) => void;
2401
+ /**
2402
+ * Function to expand all rows from a specific node
2403
+ *
2404
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2405
+ */
2406
+ expandAllFromNode?: (p1: Table, p2: Context) => void;
2407
+ /**
2408
+ * Function to collapse all rows from a specific node
2409
+ *
2410
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2411
+ */
2412
+ collapseAllFromNode?: (p1: Table, p2: Context) => void;
2413
+ /**
2414
+ * Function to check if a specific node is expanded
2415
+ *
2416
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2417
+ */
2418
+ isNodeExpanded?: (p1: Table, p2: Context) => void;
2419
+ };
2231
2420
  }
2232
2421
 
2233
2422
  declare module "sap/ui/mdc/util/TypeMap" {
@@ -3895,15 +4084,18 @@ declare module "sap/ui/mdc/Chart" {
3895
4084
  * Gets content of aggregation {@link #getItems items}.
3896
4085
  *
3897
4086
  * This property describes the measures and dimensions visible in the chart. Changes in the personalization
3898
- * are also reflected here. **Note:** This aggregation is managed by the control, can only be populated
3899
- * during the definition in the XML view, and is not bindable. Any changes of the initial aggregation content
3900
- * might result in undesired effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
4087
+ * are also reflected here.
4088
+ *
4089
+ * **Note:** This aggregation is managed by the control, can only be populated during the definition in
4090
+ * the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
4091
+ * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
3901
4092
  */
3902
4093
  getItems(): Item[];
3903
4094
  /**
3904
4095
  * Gets current value of property {@link #getLegendVisible legendVisible}.
3905
4096
  *
3906
- * Enables the legend of the chart. **Note:** The setter calls `setLegendVisible` of the delegate class.
4097
+ * Enables the legend of the chart.
4098
+ * **Note:** The setter calls `setLegendVisible` of the delegate class.
3907
4099
  *
3908
4100
  * Default value is `true`.
3909
4101
  *
@@ -3974,7 +4166,7 @@ declare module "sap/ui/mdc/Chart" {
3974
4166
  /**
3975
4167
  * Gets content of aggregation {@link #getSelectionDetailsActions selectionDetailsActions}.
3976
4168
  *
3977
- * Feeds details popover actions for data point selection in the mdc chart.
4169
+ * Feeds details popover actions for data point selection in the chart.
3978
4170
  * For more information, see {@link sap.ui.mdc.chart.SelectionDetailsActions SelectionDetailsActions}.
3979
4171
  */
3980
4172
  getSelectionDetailsActions(): SelectionDetailsActions;
@@ -3982,8 +4174,8 @@ declare module "sap/ui/mdc/Chart" {
3982
4174
  * Gets current value of property {@link #getShowChartTooltip showChartTooltip}.
3983
4175
  *
3984
4176
  * Controls the visibility of the chart tooltip.
3985
- * If set to `true`, a call of the `delegate.setChartTooltipVisibility` will be triggered and can be used
3986
- * to make the `Chart` tooltip visible.
4177
+ * **Note:** If set to `true`, a call of the `delegate.setChartTooltipVisibility` is triggered and can
4178
+ * be used to make the `Chart` tooltip visible.
3987
4179
  *
3988
4180
  * Default value is `true`.
3989
4181
  *
@@ -4228,7 +4420,8 @@ declare module "sap/ui/mdc/Chart" {
4228
4420
  /**
4229
4421
  * Sets a new value for property {@link #getLegendVisible legendVisible}.
4230
4422
  *
4231
- * Enables the legend of the chart. **Note:** The setter calls `setLegendVisible` of the delegate class.
4423
+ * Enables the legend of the chart.
4424
+ * **Note:** The setter calls `setLegendVisible` of the delegate class.
4232
4425
  *
4233
4426
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4234
4427
  *
@@ -4329,8 +4522,8 @@ declare module "sap/ui/mdc/Chart" {
4329
4522
  * Sets a new value for property {@link #getShowChartTooltip showChartTooltip}.
4330
4523
  *
4331
4524
  * Controls the visibility of the chart tooltip.
4332
- * If set to `true`, a call of the `delegate.setChartTooltipVisibility` will be triggered and can be used
4333
- * to make the `Chart` tooltip visible.
4525
+ * **Note:** If set to `true`, a call of the `delegate.setChartTooltipVisibility` is triggered and can
4526
+ * be used to make the `Chart` tooltip visible.
4334
4527
  *
4335
4528
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4336
4529
  *
@@ -4418,39 +4611,10 @@ declare module "sap/ui/mdc/Chart" {
4418
4611
  * Defines whether the property is aggregatable and is selectable as a measure in the chart
4419
4612
  */
4420
4613
  aggregatable: boolean;
4421
- /**
4422
- * The aggregation method used if the property is aggregatable
4423
- */
4424
- aggregationMethod?: string;
4425
4614
  /**
4426
4615
  * Defines the role that the property visualizes inside the chart
4427
4616
  */
4428
4617
  role: string;
4429
- /**
4430
- * Implementation-specific object containing information about the data point
4431
- */
4432
- datapoint?: object;
4433
- /**
4434
- * Implementation-specific object containing information about the criticality
4435
- */
4436
- criticality?: object;
4437
- /**
4438
- * The text property used for the dimension
4439
- */
4440
- textProperty?: string;
4441
- /**
4442
- * The text formatter object which can be used to format the textProperty
4443
- */
4444
- textFormatter?: object;
4445
- /**
4446
- * The name of the unit property which will be used to display and format measure values with a unit value
4447
- * on a selectionDetails popover
4448
- */
4449
- unitPath?: object;
4450
- /**
4451
- * The `timeUnitType` type for a `TimeDimension`. If set, a `TimeDimension` is created instead of a `Dimension`
4452
- */
4453
- timeUnitType?: string;
4454
4618
  };
4455
4619
 
4456
4620
  /**
@@ -4512,7 +4676,8 @@ declare module "sap/ui/mdc/Chart" {
4512
4676
  | `{${string}}`;
4513
4677
 
4514
4678
  /**
4515
- * Enables the legend of the chart. **Note:** The setter calls `setLegendVisible` of the delegate class.
4679
+ * Enables the legend of the chart.
4680
+ * **Note:** The setter calls `setLegendVisible` of the delegate class.
4516
4681
  *
4517
4682
  * @since 1.88
4518
4683
  */
@@ -4560,8 +4725,8 @@ declare module "sap/ui/mdc/Chart" {
4560
4725
 
4561
4726
  /**
4562
4727
  * Controls the visibility of the chart tooltip.
4563
- * If set to `true`, a call of the `delegate.setChartTooltipVisibility` will be triggered and can be used
4564
- * to make the `Chart` tooltip visible.
4728
+ * **Note:** If set to `true`, a call of the `delegate.setChartTooltipVisibility` is triggered and can
4729
+ * be used to make the `Chart` tooltip visible.
4565
4730
  *
4566
4731
  * @since 1.88
4567
4732
  */
@@ -4589,10 +4754,9 @@ declare module "sap/ui/mdc/Chart" {
4589
4754
  * **Note:** This property is exclusively used for handling SAPUI5 flexibility changes. Do not use it otherwise.
4590
4755
  * **Note**: Existing properties (set via `sap.ui.mdc.Chart#setPropertyInfo`) must not be removed and their
4591
4756
  * attributes must not be changed during the {@link module:sap/ui/mdc/ChartDelegate.fetchProperties fetchProperties }
4592
- * callback Otherwise validation errors might occur whenever personalization-related control features (such
4593
- * as the opening of any personalization dialog) are activated.
4594
- *
4595
- * **Note**: For more information about the supported inner elements, see {@link sap.ui.mdc.chart.PropertyInfo PropertyInfo}.
4757
+ * callback. Otherwise validation errors might occur whenever personalization-related control features (such
4758
+ * as the opening of any personalization dialog) are activated. **Note**: For more information about the
4759
+ * supported inner elements, see {@link sap.ui.mdc.chart.PropertyInfo PropertyInfo}.
4596
4760
  *
4597
4761
  * @since 1.99
4598
4762
  */
@@ -4629,9 +4793,11 @@ declare module "sap/ui/mdc/Chart" {
4629
4793
 
4630
4794
  /**
4631
4795
  * This property describes the measures and dimensions visible in the chart. Changes in the personalization
4632
- * are also reflected here. **Note:** This aggregation is managed by the control, can only be populated
4633
- * during the definition in the XML view, and is not bindable. Any changes of the initial aggregation content
4634
- * might result in undesired effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
4796
+ * are also reflected here.
4797
+ *
4798
+ * **Note:** This aggregation is managed by the control, can only be populated during the definition in
4799
+ * the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
4800
+ * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
4635
4801
  */
4636
4802
  items?: Item[] | Item | AggregationBindingInfo | `{${string}}`;
4637
4803
 
@@ -4646,7 +4812,7 @@ declare module "sap/ui/mdc/Chart" {
4646
4812
  actions?: Control1[] | Control1 | AggregationBindingInfo | `{${string}}`;
4647
4813
 
4648
4814
  /**
4649
- * Feeds details popover actions for data point selection in the mdc chart.
4815
+ * Feeds details popover actions for data point selection in the chart.
4650
4816
  * For more information, see {@link sap.ui.mdc.chart.SelectionDetailsActions SelectionDetailsActions}.
4651
4817
  */
4652
4818
  selectionDetailsActions?: SelectionDetailsActions;
@@ -5074,8 +5240,7 @@ declare module "sap/ui/mdc/chart/Item" {
5074
5240
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
5075
5241
 
5076
5242
  /**
5077
- * The `Item` control for the chart/property metadata used within MDC Chart. An instance can be created
5078
- * to override the default/metadata behavior.
5243
+ * The `Item` control for the chart/property metadata used within MDC Chart.
5079
5244
  *
5080
5245
  * @since 1.88
5081
5246
  * @experimental (since 1.88)
@@ -5156,8 +5321,7 @@ declare module "sap/ui/mdc/chart/Item" {
5156
5321
  /**
5157
5322
  * Gets current value of property {@link #getName name}.
5158
5323
  *
5159
- * The unique identifier of the chart item that reflects the name of the data property in the resulting
5160
- * data set.
5324
+ * The unique identifier of the chart item that reflects the name of the property in the PropertyInfo.
5161
5325
  *
5162
5326
  * @deprecated (since 1.115) - Please use `propertyKey` instead.
5163
5327
  *
@@ -5167,8 +5331,7 @@ declare module "sap/ui/mdc/chart/Item" {
5167
5331
  /**
5168
5332
  * Gets current value of property {@link #getPropertyKey propertyKey}.
5169
5333
  *
5170
- * The unique identifier of the chart item that reflects the name of the data property in the resulting
5171
- * data set.
5334
+ * The unique identifier of the chart item that reflects the name of property in the PropertyInfo.
5172
5335
  *
5173
5336
  * @since 1.115
5174
5337
  *
@@ -5192,8 +5355,6 @@ declare module "sap/ui/mdc/chart/Item" {
5192
5355
  * Specifies the type of the item for the chart (groupable and aggregatable). This is specific for the used
5193
5356
  * chart library.
5194
5357
  *
5195
- * Default value is `empty string`.
5196
- *
5197
5358
  *
5198
5359
  * @returns Value of property `type`
5199
5360
  */
@@ -5218,8 +5379,7 @@ declare module "sap/ui/mdc/chart/Item" {
5218
5379
  /**
5219
5380
  * Sets a new value for property {@link #getName name}.
5220
5381
  *
5221
- * The unique identifier of the chart item that reflects the name of the data property in the resulting
5222
- * data set.
5382
+ * The unique identifier of the chart item that reflects the name of the property in the PropertyInfo.
5223
5383
  *
5224
5384
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5225
5385
  *
@@ -5236,8 +5396,7 @@ declare module "sap/ui/mdc/chart/Item" {
5236
5396
  /**
5237
5397
  * Sets a new value for property {@link #getPropertyKey propertyKey}.
5238
5398
  *
5239
- * The unique identifier of the chart item that reflects the name of the data property in the resulting
5240
- * data set.
5399
+ * The unique identifier of the chart item that reflects the name of property in the PropertyInfo.
5241
5400
  *
5242
5401
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5243
5402
  *
@@ -5277,8 +5436,6 @@ declare module "sap/ui/mdc/chart/Item" {
5277
5436
  *
5278
5437
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5279
5438
  *
5280
- * Default value is `empty string`.
5281
- *
5282
5439
  *
5283
5440
  * @returns Reference to `this` in order to allow method chaining
5284
5441
  */
@@ -5286,7 +5443,7 @@ declare module "sap/ui/mdc/chart/Item" {
5286
5443
  /**
5287
5444
  * New value for property `type`
5288
5445
  */
5289
- sType?: string
5446
+ sType: string
5290
5447
  ): this;
5291
5448
  }
5292
5449
  /**
@@ -5296,16 +5453,14 @@ declare module "sap/ui/mdc/chart/Item" {
5296
5453
  */
5297
5454
  export interface $ItemSettings extends $ElementSettings {
5298
5455
  /**
5299
- * The unique identifier of the chart item that reflects the name of the data property in the resulting
5300
- * data set.
5456
+ * The unique identifier of the chart item that reflects the name of the property in the PropertyInfo.
5301
5457
  *
5302
5458
  * @deprecated (since 1.115) - Please use `propertyKey` instead.
5303
5459
  */
5304
5460
  name?: string | PropertyBindingInfo;
5305
5461
 
5306
5462
  /**
5307
- * The unique identifier of the chart item that reflects the name of the data property in the resulting
5308
- * data set.
5463
+ * The unique identifier of the chart item that reflects the name of property in the PropertyInfo.
5309
5464
  *
5310
5465
  * @since 1.115
5311
5466
  */
@@ -7189,7 +7344,7 @@ declare module "sap/ui/mdc/enums/OperatorName" {
7189
7344
  /**
7190
7345
  * "empty" operator
7191
7346
  *
7192
- * The operator is available for string types.
7347
+ * The operator is available for string, date, and date/time types.
7193
7348
  *
7194
7349
  * @since 1.73.0
7195
7350
  */
@@ -7639,7 +7794,7 @@ declare module "sap/ui/mdc/enums/OperatorName" {
7639
7794
  /**
7640
7795
  * "not empty" operator
7641
7796
  *
7642
- * The operator is available for string types.
7797
+ * The operator is available for string, date, and date/time types.
7643
7798
  *
7644
7799
  * @since 1.73.0
7645
7800
  */
@@ -9828,9 +9983,10 @@ declare module "sap/ui/mdc/field/FieldBase" {
9828
9983
  *
9829
9984
  * These should be bound to a {@link sap.ui.mdc.FilterBar FilterBar} using the corresponding `propertyPath`.
9830
9985
  *
9831
- * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property must be
9832
- * used to bind {@link sap.ui.mdc.FilterField FilterField} to a {@link @link sap.ui.mdc.FilterBar FilterBar}.
9833
- * For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar }
9986
+ * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property is used
9987
+ * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link @link sap.ui.mdc.FilterBar FilterBar}.
9988
+ * If this property is not explicitly configured, the {@link @link sap.ui.mdc.FilterBar FilterBar} sets
9989
+ * a default binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar }
9834
9990
  * control, the binding looks like this:
9835
9991
  * `conditions="{$filters>/conditions/propertyPath}"` with the following data:
9836
9992
  * - `$filters` as the name of the condition model
@@ -10373,9 +10529,10 @@ declare module "sap/ui/mdc/field/FieldBase" {
10373
10529
  *
10374
10530
  * These should be bound to a {@link sap.ui.mdc.FilterBar FilterBar} using the corresponding `propertyPath`.
10375
10531
  *
10376
- * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property must be
10377
- * used to bind {@link sap.ui.mdc.FilterField FilterField} to a {@link @link sap.ui.mdc.FilterBar FilterBar}.
10378
- * For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar }
10532
+ * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property is used
10533
+ * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link @link sap.ui.mdc.FilterBar FilterBar}.
10534
+ * If this property is not explicitly configured, the {@link @link sap.ui.mdc.FilterBar FilterBar} sets
10535
+ * a default binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar }
10379
10536
  * control, the binding looks like this:
10380
10537
  * `conditions="{$filters>/conditions/propertyPath}"` with the following data:
10381
10538
  * - `$filters` as the name of the condition model
@@ -10965,9 +11122,10 @@ declare module "sap/ui/mdc/field/FieldBase" {
10965
11122
  *
10966
11123
  * These should be bound to a {@link sap.ui.mdc.FilterBar FilterBar} using the corresponding `propertyPath`.
10967
11124
  *
10968
- * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property must be
10969
- * used to bind {@link sap.ui.mdc.FilterField FilterField} to a {@link @link sap.ui.mdc.FilterBar FilterBar}.
10970
- * For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar }
11125
+ * **Note:** For {@link sap.ui.mdc.FilterField FilterField} controls, the `conditions` property is used
11126
+ * to bind {@link sap.ui.mdc.FilterField FilterField} to its parent {@link @link sap.ui.mdc.FilterBar FilterBar}.
11127
+ * If this property is not explicitly configured, the {@link @link sap.ui.mdc.FilterBar FilterBar} sets
11128
+ * a default binding. For example, for a {@link sap.ui.mdc.FilterField FilterField} control inside a {@link sap.ui.mdc.FilterBar FilterBar }
10971
11129
  * control, the binding looks like this:
10972
11130
  * `conditions="{$filters>/conditions/propertyPath}"` with the following data:
10973
11131
  * - `$filters` as the name of the condition model
@@ -12254,8 +12412,9 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12254
12412
  /**
12255
12413
  * Gets content of aggregation {@link #getBasicSearchField basicSearchField}.
12256
12414
  *
12257
- * Contains the optional basic search field. **Note:** This field has to be bound against the `$search`
12258
- * property.
12415
+ * Contains the optional basic search field. **Note:** The `conditions` property of this field is managed
12416
+ * by the control. The `propertyKey` property of this field has to be `$search` and is enforced by this
12417
+ * control.
12259
12418
  */
12260
12419
  getBasicSearchField(): FilterField;
12261
12420
  /**
@@ -12304,6 +12463,7 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12304
12463
  * **Note:** This aggregation is managed by the control, can only be populated during the definition in
12305
12464
  * the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
12306
12465
  * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
12466
+ * Also, the `conditions` property of `filterItems` is managed by the control.
12307
12467
  */
12308
12468
  getFilterItems(): FilterField[];
12309
12469
  /**
@@ -12645,6 +12805,7 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12645
12805
  * **Note:** This aggregation is managed by the control, can only be populated during the definition in
12646
12806
  * the XML view, and is not bindable. Any changes of the initial aggregation content might result in undesired
12647
12807
  * effects. Changes of the aggregation have to be made with the {@link sap.ui.mdc.p13n.StateUtil StateUtil}.
12808
+ * Also, the `conditions` property of `filterItems` is managed by the control.
12648
12809
  */
12649
12810
  filterItems?:
12650
12811
  | FilterField[]
@@ -12653,8 +12814,9 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
12653
12814
  | `{${string}}`;
12654
12815
 
12655
12816
  /**
12656
- * Contains the optional basic search field. **Note:** This field has to be bound against the `$search`
12657
- * property.
12817
+ * Contains the optional basic search field. **Note:** The `conditions` property of this field is managed
12818
+ * by the control. The `propertyKey` property of this field has to be `$search` and is enforced by this
12819
+ * control.
12658
12820
  */
12659
12821
  basicSearchField?: FilterField;
12660
12822
 
@@ -14682,6 +14844,114 @@ declare module "sap/ui/mdc/MultiValueField" {
14682
14844
  >;
14683
14845
  }
14684
14846
 
14847
+ declare module "sap/ui/mdc/p13n/StateUtil" {
14848
+ import Control from "sap/ui/mdc/Control";
14849
+
14850
+ /**
14851
+ * Utility class for state handling of MDC controls. The `StateUtil` class is offering a generic way to
14852
+ * retrieve states and set a desired state for a given MDC control. The `StateUtil` class is tightly coupled
14853
+ * to the SAPUI5 flexibility integration of MDC controls. To use the APIs of `Stateutil`, the given MDC
14854
+ * control instance needs to fully enable all available `p13nMode` options. This way, `Stateutil` can create
14855
+ * the required changes and retrieve the relevant state of each control.
14856
+ *
14857
+ * @since 1.77.0
14858
+ */
14859
+ export default class StateUtil {
14860
+ constructor();
14861
+
14862
+ /**
14863
+ * Creates and applies the necessary changes for a given control and state. **Note:**The changes are created
14864
+ * in the same order as the objects are passed into the state object attributes. For example, by adding
14865
+ * two objects into the `items` attribute of the `oState` object, the first entry is created, and the second
14866
+ * entry is created on top of the first change. The item state is applied for each provided object in the
14867
+ * given order in the array and uses the provided position. If no index or only an invalid index has been
14868
+ * provided, the item is added to the array after the last item in the affected control's item
14869
+ * aggregation. In addition the following attributes can be used to remove a state:
14870
+ *
14871
+ *
14872
+ * - `filtered` - Set to `false` in the `filter` scope on condition level to remove one specific condition
14873
+ * for the given key.
14874
+ * - `sorted` - Set to `false` in the `sorters` scope to remove a sorter/code>.
14875
+ * - `grouped` - Set to `false` in the `groupLevels` scope to remove a grouping.
14876
+ * - `visible` - Set to `false` to remove an aggregation item.
14877
+ * - `aggregated` - Set to `false` to remove an aggregation.
14878
+ *
14879
+ * **Note:**To improve the performance, you should avoid additional calls of the control’s delegate. To
14880
+ * do this, the `propertyInfo` property of the relevant control can be enriched with the properties used
14881
+ * in the provided state.
14882
+ *
14883
+ *
14884
+ * @returns `Promise` that resolves after all changes have been applied
14885
+ */
14886
+ static applyExternalState(
14887
+ /**
14888
+ * The control that is used to create changes and to which changes are made
14889
+ */
14890
+ oControl: Control,
14891
+ /**
14892
+ * The state in which the control is represented
14893
+ */
14894
+ oState: object
14895
+ ): Promise<any>;
14896
+ /**
14897
+ * Attaches an event handler to the `StateUtil`. The event handler may be fired every time a user triggers
14898
+ * a personalization change for a control instance during runtime.
14899
+ */
14900
+ static attachStateChange(
14901
+ /**
14902
+ * fnFunction The handler function to call when the event occurs
14903
+ */
14904
+ fnListener: Function
14905
+ ): void;
14906
+ /**
14907
+ * Removes a previously attached state change event handler from the `StateUtil` class. The passed parameters
14908
+ * must match those used for registration with {@link StateUtil#attachChange} beforehand.
14909
+ */
14910
+ static detachStateChange(
14911
+ /**
14912
+ * fnFunction The handler function to detach from the event
14913
+ */
14914
+ fnListener: Function
14915
+ ): void;
14916
+ /**
14917
+ * Creates a delta between two states.
14918
+ *
14919
+ *
14920
+ * @returns `Promise` that resolves after the current state has been diffed
14921
+ */
14922
+ static diffState(
14923
+ /**
14924
+ * The control instance implementing IxState
14925
+ */
14926
+ oControl: Control,
14927
+ /**
14928
+ * The prior state
14929
+ */
14930
+ oOldState: object,
14931
+ /**
14932
+ * The new state
14933
+ */
14934
+ oNewState: object
14935
+ ): Promise<any>;
14936
+ /**
14937
+ * Retrieves the externalized state for a given control instance. The retrieved state is equivalent to the
14938
+ * `getCurrentState` API for the given control, after all necessary changes have been applied (for example,
14939
+ * variant appliance and `p13n, StateUtil` changes). After the returned `Promise` has been resolved, the
14940
+ * returned state is in sync with the according state object of the MDC control (for example, `filterConditions`
14941
+ * for the `FilterBar` control).
14942
+ *
14943
+ *
14944
+ * @returns `Promise` that resolves after the current state has been retrieved
14945
+ */
14946
+ static retrieveExternalState(
14947
+ /**
14948
+ * The control instance implementing IxState to retrieve the externalized state
14949
+ */
14950
+ oControl: Control
14951
+ ): Promise<any>;
14952
+ }
14953
+ }
14954
+
14685
14955
  declare module "sap/ui/mdc/Table" {
14686
14956
  import { default as Control, $ControlSettings } from "sap/ui/mdc/Control";
14687
14957
 
@@ -14724,85 +14994,6 @@ declare module "sap/ui/mdc/Table" {
14724
14994
 
14725
14995
  import Event from "sap/ui/base/Event";
14726
14996
 
14727
- /**
14728
- * 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}.
14729
- *
14730
- * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.Table#getPropertyInfo propertyInfo }
14731
- * property, the following attributes need to be specified:
14732
- * - `key`
14733
- * - `path`
14734
- * - `dataType`
14735
- * - `formatOptions`
14736
- * - `constraints`
14737
- * - `maxConditions`
14738
- * - `caseSensitive`
14739
- * - `visualSettings.widthCalculation`
14740
- * - `propertyInfos`
14741
- * - `groupable`
14742
- * - `isKey`
14743
- * - `unit`
14744
- * - `text`
14745
- * - `aggregatable`
14746
- * - `extension.technicallyGroupable`
14747
- * - `extension.technicallyAggregatable`
14748
- * - `extension.additionalProperties`
14749
- *
14750
- * If the property is complex, the following attributes need to be specified:
14751
- * - `key`
14752
- * - `visualSettings.widthCalculation`
14753
- * - `propertyInfos` (all referenced properties must be specified)
14754
- */
14755
- export type TablePropertyInfo = PropertyInfo & {
14756
- /**
14757
- * Defines whether a property is a key or part of a key in the data. A key property must be technically
14758
- * groupable.
14759
- */
14760
- isKey?: boolean;
14761
- /**
14762
- * Defines whether the property is aggregatable. A property can only be declared aggregatable if there is
14763
- * a `CustomAggregate` whose `Qualifier` is equal to the property key.
14764
- */
14765
- aggregatable?: boolean;
14766
- /**
14767
- * Contains model-specific information.
14768
- */
14769
- extension?: {
14770
- /**
14771
- * If `groupable` is set to `false` to exclude it from group personalization on the UI, the UI still needs
14772
- * to know that this property is groupable for data requests. If this attribute is not set, the default
14773
- * value is the same as the value of `groupable`.
14774
- */
14775
- technicallyGroupable?: boolean;
14776
- /**
14777
- * If `aggregatable` is set to `false` to exclude it from aggregate personalization on the UI, the UI still
14778
- * needs to know that this property is aggregatable for data requests. If this attribute is not set, the
14779
- * default value is the same as the value of `aggregatable`.
14780
- */
14781
- technicallyAggregatable?: boolean;
14782
- /**
14783
- * Properties that are loaded in addition if this property is loaded. These properties must be technically
14784
- * groupable, otherwise they can't be loaded. All nested additional properties must be listed at root level.
14785
- * For example, if property A references B and B references C, A must also reference C. This attribute is
14786
- * only taken into account if the `Aggregate` or `Group` `p13nMode` is enabled and the table type is {@link sap.ui.mdc.table.GridTableType GridTable}.
14787
- * These properties are not considered for any other functionality, such as export or column width calculation,
14788
- * for example.
14789
- *
14790
- * The following restrictions apply:
14791
- * - If the property is neither technically groupable nor technically aggregatable, it must not reference
14792
- * additional properties.
14793
- * - If the property is technically groupable but not technically aggregatable, not more than one additional
14794
- * property must be referenced. The additional property must be the property that is referencing this property
14795
- * in its `text` attribute (bidirectional reference). Regardless of the `groupable` attribute, the property
14796
- * cannot be grouped via the UI. This might change. If this change is not desired, set `groupable` to `false`
14797
- * explicitly. Do not group this property via API, for example, with the `StateUtil`.
14798
- * - If the property is both technically groupable and technically aggregatable, it must reference only
14799
- * properties that are related to the `CustomAggregate`.
14800
- * - Properties that are referenced via `text` or `unit` must not be repeated here.
14801
- */
14802
- additionalProperties?: string[];
14803
- };
14804
- };
14805
-
14806
14997
  /**
14807
14998
  * A metadata-driven table to simplify the usage of existing tables, such as the `ResponsiveTable` and `GridTable`
14808
14999
  * controls. The metadata needs to be provided via the {@link module:sap/ui/mdc/TableDelegate TableDelegate }
@@ -17107,114 +17298,6 @@ declare module "sap/ui/mdc/Table" {
17107
17298
  >;
17108
17299
  }
17109
17300
 
17110
- declare module "sap/ui/mdc/p13n/StateUtil" {
17111
- import Control from "sap/ui/mdc/Control";
17112
-
17113
- /**
17114
- * Utility class for state handling of MDC controls. The `StateUtil` class is offering a generic way to
17115
- * retrieve states and set a desired state for a given MDC control. The `StateUtil` class is tightly coupled
17116
- * to the SAPUI5 flexibility integration of MDC controls. To use the APIs of `Stateutil`, the given MDC
17117
- * control instance needs to fully enable all available `p13nMode` options. This way, `Stateutil` can create
17118
- * the required changes and retrieve the relevant state of each control.
17119
- *
17120
- * @since 1.77.0
17121
- */
17122
- export default class StateUtil {
17123
- constructor();
17124
-
17125
- /**
17126
- * Creates and applies the necessary changes for a given control and state. **Note:**The changes are created
17127
- * in the same order as the objects are passed into the state object attributes. For example, by adding
17128
- * two objects into the `items` attribute of the `oState` object, the first entry is created, and the second
17129
- * entry is created on top of the first change. The item state is applied for each provided object in the
17130
- * given order in the array and uses the provided position. If no index or only an invalid index has been
17131
- * provided, the item is added to the array after the last item in the affected control's item
17132
- * aggregation. In addition the following attributes can be used to remove a state:
17133
- *
17134
- *
17135
- * - `filtered` - Set to `false` in the `filter` scope on condition level to remove one specific condition
17136
- * for the given key.
17137
- * - `sorted` - Set to `false` in the `sorters` scope to remove a sorter/code>.
17138
- * - `grouped` - Set to `false` in the `groupLevels` scope to remove a grouping.
17139
- * - `visible` - Set to `false` to remove an aggregation item.
17140
- * - `aggregated` - Set to `false` to remove an aggregation.
17141
- *
17142
- * **Note:**To improve the performance, you should avoid additional calls of the control’s delegate. To
17143
- * do this, the `propertyInfo` property of the relevant control can be enriched with the properties used
17144
- * in the provided state.
17145
- *
17146
- *
17147
- * @returns `Promise` that resolves after all changes have been applied
17148
- */
17149
- static applyExternalState(
17150
- /**
17151
- * The control that is used to create changes and to which changes are made
17152
- */
17153
- oControl: Control,
17154
- /**
17155
- * The state in which the control is represented
17156
- */
17157
- oState: object
17158
- ): Promise<any>;
17159
- /**
17160
- * Attaches an event handler to the `StateUtil`. The event handler may be fired every time a user triggers
17161
- * a personalization change for a control instance during runtime.
17162
- */
17163
- static attachStateChange(
17164
- /**
17165
- * fnFunction The handler function to call when the event occurs
17166
- */
17167
- fnListener: Function
17168
- ): void;
17169
- /**
17170
- * Removes a previously attached state change event handler from the `StateUtil` class. The passed parameters
17171
- * must match those used for registration with {@link StateUtil#attachChange} beforehand.
17172
- */
17173
- static detachStateChange(
17174
- /**
17175
- * fnFunction The handler function to detach from the event
17176
- */
17177
- fnListener: Function
17178
- ): void;
17179
- /**
17180
- * Creates a delta between two states.
17181
- *
17182
- *
17183
- * @returns `Promise` that resolves after the current state has been diffed
17184
- */
17185
- static diffState(
17186
- /**
17187
- * The control instance implementing IxState
17188
- */
17189
- oControl: Control,
17190
- /**
17191
- * The prior state
17192
- */
17193
- oOldState: object,
17194
- /**
17195
- * The new state
17196
- */
17197
- oNewState: object
17198
- ): Promise<any>;
17199
- /**
17200
- * Retrieves the externalized state for a given control instance. The retrieved state is equivalent to the
17201
- * `getCurrentState` API for the given control, after all necessary changes have been applied (for example,
17202
- * variant appliance and `p13n, StateUtil` changes). After the returned `Promise` has been resolved, the
17203
- * returned state is in sync with the according state object of the MDC control (for example, `filterConditions`
17204
- * for the `FilterBar` control).
17205
- *
17206
- *
17207
- * @returns `Promise` that resolves after the current state has been retrieved
17208
- */
17209
- static retrieveExternalState(
17210
- /**
17211
- * The control instance implementing IxState to retrieve the externalized state
17212
- */
17213
- oControl: Control
17214
- ): Promise<any>;
17215
- }
17216
- }
17217
-
17218
17301
  declare module "sap/ui/mdc/table/Column" {
17219
17302
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
17220
17303
 
@@ -20904,8 +20987,8 @@ declare module "sap/ui/mdc/ValueHelp" {
20904
20987
  */
20905
20988
  parsedDescription?: any;
20906
20989
  /**
20907
- * Contextual information provided by condition `payload` or `inParameters`/`outParameters`. This is only
20908
- * filled if the description needs to be determined for an existing condition.
20990
+ * Contextual information provided by the `payload` or `inParameters`/`outParameters` of the condition.
20991
+ * This is only filled if the description needs to be determined for an existing condition.
20909
20992
  */
20910
20993
  context?: {
20911
20994
  /**
@@ -20917,7 +21000,7 @@ declare module "sap/ui/mdc/ValueHelp" {
20917
21000
  * Out parameters of the current condition (`outParameters` are not used any longer, but it might be filled
20918
21001
  * in older conditions stored in variants.)
20919
21002
  */
20920
- ouParameter?: object;
21003
+ outParameter?: object;
20921
21004
  /**
20922
21005
  * Payload of the current condition
20923
21006
  */
@@ -20943,7 +21026,7 @@ declare module "sap/ui/mdc/ValueHelp" {
20943
21026
  */
20944
21027
  caseSensitive?: boolean;
20945
21028
  /**
20946
- * If set, only exact matches are requested and no suggestions
21029
+ * If set, only exact matches and no suggestions are requested
20947
21030
  */
20948
21031
  exactMatch?: boolean;
20949
21032
  /**
@@ -21493,6 +21576,18 @@ declare module "sap/ui/mdc/valuehelp/base/Container" {
21493
21576
  */
21494
21577
  oEvent: Event
21495
21578
  ): void;
21579
+ /**
21580
+ * Handles the `close` event of the container control or element.
21581
+ *
21582
+ * @since 1.132
21583
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
21584
+ */
21585
+ handleClose(
21586
+ /**
21587
+ * event
21588
+ */
21589
+ oEvent: Event
21590
+ ): void;
21496
21591
  /**
21497
21592
  * Handles the `closed` event of the container control or element.
21498
21593
  *
@@ -25162,6 +25257,8 @@ declare namespace sap {
25162
25257
 
25163
25258
  "sap/ui/mdc/filterbar/p13n/AdaptationFilterBar": undefined;
25164
25259
 
25260
+ "sap/ui/mdc/filterbar/PropertyInfoValidator": undefined;
25261
+
25165
25262
  "sap/ui/mdc/filterbar/vh/CollectiveSearchSelect": undefined;
25166
25263
 
25167
25264
  "sap/ui/mdc/filterbar/vh/FilterBar": undefined;