@sapui5/ts-types 1.104.2 → 1.106.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 (64) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +2 -2
  5. package/types/sap.collaboration.d.ts +25 -25
  6. package/types/sap.esh.search.ui.d.ts +939 -1
  7. package/types/sap.f.d.ts +80 -4
  8. package/types/sap.fe.common.d.ts +1 -1
  9. package/types/sap.fe.core.d.ts +5 -5
  10. package/types/sap.fe.macros.d.ts +30 -98
  11. package/types/sap.fe.navigation.d.ts +53 -5
  12. package/types/sap.fe.templates.d.ts +155 -1
  13. package/types/sap.fe.test.d.ts +17 -3
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +218 -57
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +1 -1
  18. package/types/sap.m.d.ts +583 -149
  19. package/types/sap.makit.d.ts +1 -1
  20. package/types/sap.me.d.ts +1 -1
  21. package/types/sap.ndc.d.ts +68 -3
  22. package/types/sap.ovp.d.ts +1 -1
  23. package/types/sap.rules.ui.d.ts +1 -1
  24. package/types/sap.sac.df.d.ts +152 -171
  25. package/types/sap.sac.grid.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +121 -16
  27. package/types/sap.suite.ui.generic.template.d.ts +17 -3
  28. package/types/sap.suite.ui.microchart.d.ts +13 -13
  29. package/types/sap.tnt.d.ts +3 -3
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +31 -31
  32. package/types/sap.ui.comp.d.ts +182 -57
  33. package/types/sap.ui.core.d.ts +618 -265
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +3 -3
  36. package/types/sap.ui.fl.d.ts +1117 -5
  37. package/types/sap.ui.generic.app.d.ts +14 -11
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +101 -18
  40. package/types/sap.ui.layout.d.ts +7 -7
  41. package/types/sap.ui.mdc.d.ts +5 -1
  42. package/types/sap.ui.richtexteditor.d.ts +2 -2
  43. package/types/sap.ui.rta.d.ts +3 -1
  44. package/types/sap.ui.suite.d.ts +5 -5
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +26 -8
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +66 -19
  49. package/types/sap.ui.ux3.d.ts +11 -11
  50. package/types/sap.ui.vbm.d.ts +3 -3
  51. package/types/sap.ui.vk.d.ts +315 -24
  52. package/types/sap.ui.vtm.d.ts +2 -2
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +239 -43
  55. package/types/sap.ui.webc.main.d.ts +636 -146
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +12 -10
  58. package/types/sap.ushell_abap.d.ts +1 -215
  59. package/types/sap.uxap.d.ts +41 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +2 -6
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.104.0
1
+ // For Library Version: 1.106.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -9093,7 +9093,7 @@ declare namespace sap {
9093
9093
  * The headerControl to be removed or its index or ID
9094
9094
  */
9095
9095
  vHeaderControl: int | sap.ui.core.ID | sap.ui.core.Control
9096
- ): sap.ui.core.ID;
9096
+ ): sap.ui.core.ID | null;
9097
9097
  /**
9098
9098
  * Sets a new value for property {@link #getBackgroundGradientBottomColor backgroundGradientBottomColor}.
9099
9099
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.104.0
1
+ // For Library Version: 1.106.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.104.0
1
+ // For Library Version: 1.106.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -153,7 +153,7 @@ declare namespace sap {
153
153
  interface $BarSettings
154
154
  extends sap.ui.webc.common.$WebComponentSettings {
155
155
  /**
156
- * Defines the `sap.ui.webc.fiori.Bar` design.
156
+ * Defines the component's design.
157
157
  *
158
158
  *
159
159
  *
@@ -469,6 +469,24 @@ declare namespace sap {
469
469
  | sap.ui.base.ManagedObject.PropertyBindingInfo
470
470
  | `{${string}}`;
471
471
 
472
+ /**
473
+ * Determines which illustration breakpoint variant is used.
474
+ *
475
+ * Available options are:
476
+ * - `Auto`
477
+ * - `Base`
478
+ * - `Spot`
479
+ * - `Dialog`
480
+ * - `Scene`
481
+ *
482
+ * As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the component
483
+ * are displayed differently on the different breakpoints/illustration sizes.
484
+ */
485
+ size?:
486
+ | sap.ui.webc.fiori.IllustrationMessageSize
487
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
488
+ | `{${string}}`;
489
+
472
490
  /**
473
491
  * Defines the subtitle of the component.
474
492
  *
@@ -668,7 +686,7 @@ declare namespace sap {
668
686
  * Defines the `icon` source URI.
669
687
  *
670
688
  * **Note:** SAP-icons font provides numerous built-in icons. To find all the available icons, see the
671
- * Icon Explorer.
689
+ * {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
672
690
  */
673
691
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
674
692
 
@@ -991,7 +1009,7 @@ declare namespace sap {
991
1009
  * ui5-product-switch-item icon="palette"```
992
1010
  *
993
1011
  *
994
- * See all the available icons in the Icon Explorer.
1012
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
995
1013
  */
996
1014
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
997
1015
 
@@ -1265,7 +1283,7 @@ declare namespace sap {
1265
1283
  *
1266
1284
  *
1267
1285
  * The SAP-icons font provides numerous options.
1268
- * See all the available icons in the Icon Explorer.
1286
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
1269
1287
  */
1270
1288
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1271
1289
 
@@ -1311,7 +1329,7 @@ declare namespace sap {
1311
1329
  *
1312
1330
  *
1313
1331
  * The SAP-icons font provides numerous options.
1314
- * See all the available icons in the Icon Explorer.
1332
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
1315
1333
  */
1316
1334
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1317
1335
 
@@ -1402,7 +1420,7 @@ declare namespace sap {
1402
1420
  *
1403
1421
  *
1404
1422
  *
1405
- * See all the available icons in the Icon Explorer.
1423
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
1406
1424
  */
1407
1425
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1408
1426
 
@@ -1690,6 +1708,11 @@ declare namespace sap {
1690
1708
  | sap.ui.base.ManagedObject.AggregationBindingInfo
1691
1709
  | `{${string}}`;
1692
1710
 
1711
+ /**
1712
+ * Fired before the component is opened. **This event does not bubble.**
1713
+ */
1714
+ beforeOpen?: (oEvent: sap.ui.base.Event) => void;
1715
+
1693
1716
  /**
1694
1717
  * Fired when cancel button is activated.
1695
1718
  */
@@ -1763,7 +1786,8 @@ declare namespace sap {
1763
1786
  *
1764
1787
  *
1765
1788
  *
1766
- * The SAP-icons font provides numerous options. See all the available icons in the Icon Explorer.
1789
+ * The SAP-icons font provides numerous options. See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html
1790
+ * Icon Explorer}.
1767
1791
  */
1768
1792
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1769
1793
 
@@ -1827,8 +1851,8 @@ declare namespace sap {
1827
1851
  *
1828
1852
  * CSS Shadow Parts:
1829
1853
  *
1830
- * CSS Shadow Parts
1831
- * allow developers to style elements inside the Shadow DOM.
1854
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/::part CSS Shadow Parts} allow developers to
1855
+ * style elements inside the Shadow DOM.
1832
1856
  * The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
1833
1857
  * - bar - Used to style the wrapper of the content of the component
1834
1858
  *
@@ -1952,7 +1976,7 @@ declare namespace sap {
1952
1976
  /**
1953
1977
  * Gets current value of property {@link #getDesign design}.
1954
1978
  *
1955
- * Defines the `sap.ui.webc.fiori.Bar` design.
1979
+ * Defines the component's design.
1956
1980
  *
1957
1981
  *
1958
1982
  *
@@ -2140,7 +2164,7 @@ declare namespace sap {
2140
2164
  /**
2141
2165
  * Sets a new value for property {@link #getDesign design}.
2142
2166
  *
2143
- * Defines the `sap.ui.webc.fiori.Bar` design.
2167
+ * Defines the component's design.
2144
2168
  *
2145
2169
  *
2146
2170
  *
@@ -2193,7 +2217,7 @@ declare namespace sap {
2193
2217
  *
2194
2218
  * Internally, the component uses the zxing-js/library third party OSS.
2195
2219
  *
2196
- * For a list of supported barcode formats, see the zxing-js/library
2220
+ * For a list of supported barcode formats, see the {@link https://github.com/zxing-js/library zxing-js/library}
2197
2221
  * documentation.
2198
2222
  */
2199
2223
  class BarcodeScannerDialog extends sap.ui.webc.common.WebComponent {
@@ -3323,7 +3347,7 @@ declare namespace sap {
3323
3347
  *
3324
3348
  * Overview:
3325
3349
  *
3326
- * The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
3350
+ * The `FlexibleColumnLayout` implements the list-detail-detail paradigm by displaying up to three pages
3327
3351
  * in separate columns. There are several possible layouts that can be changed either with the component
3328
3352
  * API, or by pressing the arrows, displayed between the columns.
3329
3353
  *
@@ -3950,6 +3974,26 @@ declare namespace sap {
3950
3974
  * @returns Value of property `name`
3951
3975
  */
3952
3976
  getName(): sap.ui.webc.fiori.IllustrationMessageType;
3977
+ /**
3978
+ * Gets current value of property {@link #getSize size}.
3979
+ *
3980
+ * Determines which illustration breakpoint variant is used.
3981
+ *
3982
+ * Available options are:
3983
+ * - `Auto`
3984
+ * - `Base`
3985
+ * - `Spot`
3986
+ * - `Dialog`
3987
+ * - `Scene`
3988
+ *
3989
+ * As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the component
3990
+ * are displayed differently on the different breakpoints/illustration sizes.
3991
+ *
3992
+ * Default value is `Auto`.
3993
+ *
3994
+ * @returns Value of property `size`
3995
+ */
3996
+ getSize(): sap.ui.webc.fiori.IllustrationMessageSize;
3953
3997
  /**
3954
3998
  * Gets content of aggregation {@link #getSubtitle subtitle}.
3955
3999
  *
@@ -4048,6 +4092,33 @@ declare namespace sap {
4048
4092
  */
4049
4093
  sName?: sap.ui.webc.fiori.IllustrationMessageType
4050
4094
  ): this;
4095
+ /**
4096
+ * Sets a new value for property {@link #getSize size}.
4097
+ *
4098
+ * Determines which illustration breakpoint variant is used.
4099
+ *
4100
+ * Available options are:
4101
+ * - `Auto`
4102
+ * - `Base`
4103
+ * - `Spot`
4104
+ * - `Dialog`
4105
+ * - `Scene`
4106
+ *
4107
+ * As `IllustratedMessage` adapts itself around the `Illustration`, the other elements of the component
4108
+ * are displayed differently on the different breakpoints/illustration sizes.
4109
+ *
4110
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4111
+ *
4112
+ * Default value is `Auto`.
4113
+ *
4114
+ * @returns Reference to `this` in order to allow method chaining
4115
+ */
4116
+ setSize(
4117
+ /**
4118
+ * New value for property `size`
4119
+ */
4120
+ sSize?: sap.ui.webc.fiori.IllustrationMessageSize
4121
+ ): this;
4051
4122
  /**
4052
4123
  * Sets the aggregated {@link #getSubtitle subtitle}.
4053
4124
  *
@@ -4106,8 +4177,8 @@ declare namespace sap {
4106
4177
  *
4107
4178
  * Overview:
4108
4179
  *
4109
- * The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
4110
- * items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
4180
+ * The `sap.ui.webc.fiori.MediaGallery` component allows the user to browse through multimedia items. Currently,
4181
+ * the supported items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
4111
4182
  * component.
4112
4183
  *
4113
4184
  * The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
@@ -4992,7 +5063,7 @@ declare namespace sap {
4992
5063
  * Defines the `icon` source URI.
4993
5064
  *
4994
5065
  * **Note:** SAP-icons font provides numerous built-in icons. To find all the available icons, see the
4995
- * Icon Explorer.
5066
+ * {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
4996
5067
  *
4997
5068
  * Default value is `empty string`.
4998
5069
  *
@@ -5059,7 +5130,7 @@ declare namespace sap {
5059
5130
  * Defines the `icon` source URI.
5060
5131
  *
5061
5132
  * **Note:** SAP-icons font provides numerous built-in icons. To find all the available icons, see the
5062
- * Icon Explorer.
5133
+ * {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
5063
5134
  *
5064
5135
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5065
5136
  *
@@ -5110,8 +5181,8 @@ declare namespace sap {
5110
5181
  *
5111
5182
  * CSS Shadow Parts:
5112
5183
  *
5113
- * CSS Shadow Parts
5114
- * allow developers to style elements inside the Shadow DOM.
5184
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/::part CSS Shadow Parts} allow developers to
5185
+ * style elements inside the Shadow DOM.
5115
5186
  * The `sap.ui.webc.fiori.NotificationListGroupItem` exposes the following CSS Shadow Parts:
5116
5187
  * - title-text - Used to style the titleText of the notification list group item
5117
5188
  */
@@ -5728,8 +5799,8 @@ declare namespace sap {
5728
5799
  *
5729
5800
  * CSS Shadow Parts:
5730
5801
  *
5731
- * CSS Shadow Parts
5732
- * allow developers to style elements inside the Shadow DOM.
5802
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/::part CSS Shadow Parts} allow developers to
5803
+ * style elements inside the Shadow DOM.
5733
5804
  * The `sap.ui.webc.fiori.NotificationListItem` exposes the following CSS Shadow Parts:
5734
5805
  * - title-text - Used to style the titleText of the notification list item
5735
5806
  */
@@ -6295,8 +6366,8 @@ declare namespace sap {
6295
6366
  *
6296
6367
  * Overview:
6297
6368
  *
6298
- * The `sap.ui.webc.fiori.Page` is a container control that holds one whole screen of an application. The
6299
- * page has three distinct areas that can hold content - a header, content area and a footer. Structure:
6369
+ * The `sap.ui.webc.fiori.Page` is a container component that holds one whole screen of an application.
6370
+ * The page has three distinct areas that can hold content - a header, content area and a footer. Structure:
6300
6371
  * Header: The top most area of the page is occupied by the header. The standard header includes a navigation
6301
6372
  * button and a title. Content: The content occupies the main part of the page. Only the content area is
6302
6373
  * scrollable by default. This can be prevented by setting `enableScrolling` to `false`. Footer: The footer
@@ -6986,7 +7057,7 @@ declare namespace sap {
6986
7057
  * ui5-product-switch-item icon="palette"```
6987
7058
  *
6988
7059
  *
6989
- * See all the available icons in the Icon Explorer.
7060
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
6990
7061
  *
6991
7062
  * Default value is `empty string`.
6992
7063
  *
@@ -7051,7 +7122,7 @@ declare namespace sap {
7051
7122
  * ui5-product-switch-item icon="palette"```
7052
7123
  *
7053
7124
  *
7054
- * See all the available icons in the Icon Explorer.
7125
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
7055
7126
  *
7056
7127
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7057
7128
  *
@@ -7164,8 +7235,8 @@ declare namespace sap {
7164
7235
  *
7165
7236
  * CSS Shadow Parts:
7166
7237
  *
7167
- * CSS Shadow Parts
7168
- * allow developers to style elements inside the Shadow DOM.
7238
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/::part CSS Shadow Parts} allow developers to
7239
+ * style elements inside the Shadow DOM.
7169
7240
  * The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
7170
7241
  * - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
7171
7242
  *
@@ -8957,7 +9028,7 @@ declare namespace sap {
8957
9028
  *
8958
9029
  *
8959
9030
  * The SAP-icons font provides numerous options.
8960
- * See all the available icons in the Icon Explorer.
9031
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
8961
9032
  *
8962
9033
  * Default value is `empty string`.
8963
9034
  *
@@ -9076,7 +9147,7 @@ declare namespace sap {
9076
9147
  *
9077
9148
  *
9078
9149
  * The SAP-icons font provides numerous options.
9079
- * See all the available icons in the Icon Explorer.
9150
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
9080
9151
  *
9081
9152
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9082
9153
  *
@@ -9229,7 +9300,7 @@ declare namespace sap {
9229
9300
  *
9230
9301
  *
9231
9302
  * The SAP-icons font provides numerous options.
9232
- * See all the available icons in the Icon Explorer.
9303
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
9233
9304
  *
9234
9305
  * Default value is `empty string`.
9235
9306
  *
@@ -9264,7 +9335,7 @@ declare namespace sap {
9264
9335
  *
9265
9336
  *
9266
9337
  * The SAP-icons font provides numerous options.
9267
- * See all the available icons in the Icon Explorer.
9338
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
9268
9339
  *
9269
9340
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9270
9341
  *
@@ -9874,7 +9945,7 @@ declare namespace sap {
9874
9945
  *
9875
9946
  *
9876
9947
  *
9877
- * See all the available icons in the Icon Explorer.
9948
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
9878
9949
  *
9879
9950
  * Default value is `empty string`.
9880
9951
  *
@@ -9977,7 +10048,7 @@ declare namespace sap {
9977
10048
  *
9978
10049
  *
9979
10050
  *
9980
- * See all the available icons in the Icon Explorer.
10051
+ * See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html Icon Explorer}.
9981
10052
  *
9982
10053
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9983
10054
  *
@@ -11545,6 +11616,53 @@ declare namespace sap {
11545
11616
  */
11546
11617
  oSortItem: sap.ui.webc.fiori.ISortItem
11547
11618
  ): this;
11619
+ /**
11620
+ * Attaches event handler `fnFunction` to the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
11621
+ *
11622
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
11623
+ * otherwise it will be bound to this `sap.ui.webc.fiori.ViewSettingsDialog` itself.
11624
+ *
11625
+ * Fired before the component is opened. **This event does not bubble.**
11626
+ *
11627
+ * @returns Reference to `this` in order to allow method chaining
11628
+ */
11629
+ attachBeforeOpen(
11630
+ /**
11631
+ * An application-specific payload object that will be passed to the event handler along with the event
11632
+ * object when firing the event
11633
+ */
11634
+ oData: object,
11635
+ /**
11636
+ * The function to be called when the event occurs
11637
+ */
11638
+ fnFunction: (p1: sap.ui.base.Event) => void,
11639
+ /**
11640
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
11641
+ * itself
11642
+ */
11643
+ oListener?: object
11644
+ ): this;
11645
+ /**
11646
+ * Attaches event handler `fnFunction` to the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
11647
+ *
11648
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
11649
+ * otherwise it will be bound to this `sap.ui.webc.fiori.ViewSettingsDialog` itself.
11650
+ *
11651
+ * Fired before the component is opened. **This event does not bubble.**
11652
+ *
11653
+ * @returns Reference to `this` in order to allow method chaining
11654
+ */
11655
+ attachBeforeOpen(
11656
+ /**
11657
+ * The function to be called when the event occurs
11658
+ */
11659
+ fnFunction: (p1: sap.ui.base.Event) => void,
11660
+ /**
11661
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
11662
+ * itself
11663
+ */
11664
+ oListener?: object
11665
+ ): this;
11548
11666
  /**
11549
11667
  * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
11550
11668
  *
@@ -11651,6 +11769,23 @@ declare namespace sap {
11651
11769
  * @returns Reference to `this` in order to allow method chaining
11652
11770
  */
11653
11771
  destroySortItems(): this;
11772
+ /**
11773
+ * Detaches event handler `fnFunction` from the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
11774
+ *
11775
+ * The passed function and listener object must match the ones used for event registration.
11776
+ *
11777
+ * @returns Reference to `this` in order to allow method chaining
11778
+ */
11779
+ detachBeforeOpen(
11780
+ /**
11781
+ * The function to be called, when the event occurs
11782
+ */
11783
+ fnFunction: (p1: sap.ui.base.Event) => void,
11784
+ /**
11785
+ * Context object on which the given function had to be called
11786
+ */
11787
+ oListener?: object
11788
+ ): this;
11654
11789
  /**
11655
11790
  * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
11656
11791
  *
@@ -11685,6 +11820,17 @@ declare namespace sap {
11685
11820
  */
11686
11821
  oListener?: object
11687
11822
  ): this;
11823
+ /**
11824
+ * Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
11825
+ *
11826
+ * @returns Reference to `this` in order to allow method chaining
11827
+ */
11828
+ fireBeforeOpen(
11829
+ /**
11830
+ * Parameters to pass along with the event
11831
+ */
11832
+ mParameters?: object
11833
+ ): this;
11688
11834
  /**
11689
11835
  * Fires event {@link #event:cancel cancel} to attached listeners.
11690
11836
  *
@@ -11863,6 +12009,19 @@ declare namespace sap {
11863
12009
  */
11864
12010
  vSortItem: int | string | sap.ui.webc.fiori.ISortItem
11865
12011
  ): sap.ui.webc.fiori.ISortItem | null;
12012
+ /**
12013
+ * Sets a JavaScript object, as settings to the `sap.ui.webc.fiori.ViewSettingsDialog`. This method can
12014
+ * be used after the dialog is initially open, as the dialog need to set its initial settings. The `sap.ui.webc.fiori.ViewSettingsDialog`
12015
+ * throws an event called "before-open", this can be used as trigger point. The object should have the following
12016
+ * format: `{ { "sortOrder" : "Ascending", "sortBy" : "Name", "filters" : [{"Filter 1": ["Some filter 1",
12017
+ * "Some filter 2"]}, {"Filter 2": ["Some filter 4"]}]} }`
12018
+ */
12019
+ setConfirmedSettings(
12020
+ /**
12021
+ * A value to be set as predefined settings.
12022
+ */
12023
+ settings: string
12024
+ ): void;
11866
12025
  /**
11867
12026
  * Sets a new value for property {@link #getSortDescending sortDescending}.
11868
12027
  *
@@ -12344,7 +12503,8 @@ declare namespace sap {
12344
12503
  *
12345
12504
  *
12346
12505
  *
12347
- * The SAP-icons font provides numerous options. See all the available icons in the Icon Explorer.
12506
+ * The SAP-icons font provides numerous options. See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html
12507
+ * Icon Explorer}.
12348
12508
  *
12349
12509
  * Default value is `empty string`.
12350
12510
  *
@@ -12494,7 +12654,8 @@ declare namespace sap {
12494
12654
  *
12495
12655
  *
12496
12656
  *
12497
- * The SAP-icons font provides numerous options. See all the available icons in the Icon Explorer.
12657
+ * The SAP-icons font provides numerous options. See all the available icons in the {@link demo:sap/m/demokit/iconExplorer/webapp/index.html
12658
+ * Icon Explorer}.
12498
12659
  *
12499
12660
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12500
12661
  *
@@ -12626,7 +12787,7 @@ declare namespace sap {
12626
12787
  * Desktop: 25/25/50 Start, Mid and End (expanded) columns are displayed Tablet: 0/33/67 Mid and End (expanded)
12627
12788
  * columns are displayed, Start is accessible by layout arrows Phone: -/-/100 (only the End column is displayed)
12628
12789
  *
12629
- * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail-detail.
12790
+ * Use to display all three pages (list, detail, detail-detail) when the user should focus on the detail-detail.
12630
12791
  */
12631
12792
  ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",
12632
12793
  /**
@@ -12634,7 +12795,7 @@ declare namespace sap {
12634
12795
  * and End columns are displayed, Start is accessible by a layout arrow Phone: -/-/100 only the End column
12635
12796
  * is displayed
12636
12797
  *
12637
- * Use to display all three pages (master, detail, detail-detail) when the user should focus on the detail.
12798
+ * Use to display all three pages (list, detail, detail-detail) when the user should focus on the detail.
12638
12799
  */
12639
12800
  ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",
12640
12801
  /**
@@ -12642,7 +12803,7 @@ declare namespace sap {
12642
12803
  * Tablet: 33/67/0 Start and Mid (expanded) columns are displayed, End is accessible by a layout arrow Phone:
12643
12804
  * -/-/100 only the End column is displayed
12644
12805
  *
12645
- * Use to display the master and detail pages when the user should focus on the detail. The detail-detail
12806
+ * Use to display the list and detail pages when the user should focus on the detail. The detail-detail
12646
12807
  * is still loaded and easily accessible with a layout arrow.
12647
12808
  */
12648
12809
  ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",
@@ -12651,25 +12812,60 @@ declare namespace sap {
12651
12812
  * 67/33/0 Start (expanded) and Mid columns are displayed, End is accessible by layout arrows Phone: -/-/100
12652
12813
  * only the End column is displayed
12653
12814
  *
12654
- * Use to display the master and detail pages when the user should focus on the master. The detail-detail
12655
- * is still loaded and easily accessible with layout arrows.
12815
+ * Use to display the list and detail pages when the user should focus on the list. The detail-detail is
12816
+ * still loaded and easily accessible with layout arrows.
12656
12817
  */
12657
12818
  ThreeColumnsStartExpandedEndHidden = "ThreeColumnsStartExpandedEndHidden",
12658
12819
  /**
12659
12820
  * Desktop: 33/67/- Start and Mid (expanded) columns are displayed Tablet: 33/67/- Start and Mid (expanded)
12660
12821
  * columns are displayed Phone: -/100/- only the Mid column is displayed
12661
12822
  *
12662
- * Use to display both a master and a detail page when the user should focus on the detail page.
12823
+ * Use to display both a list and a detail page when the user should focus on the detail page.
12663
12824
  */
12664
12825
  TwoColumnsMidExpanded = "TwoColumnsMidExpanded",
12665
12826
  /**
12666
12827
  * Desktop: 67/33/- Start (expanded) and Mid columns are displayed Tablet: 67/33/- Start (expanded) and
12667
12828
  * Mid columns are displayed Phone: -/100/- only the Mid column is displayed
12668
12829
  *
12669
- * Use to display both a master and a detail page when the user should focus on the master page.
12830
+ * Use to display both a list and a detail page when the user should focus on the list page.
12670
12831
  */
12671
12832
  TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
12672
12833
  }
12834
+ /**
12835
+ * @SINCE 1.106.0
12836
+ * @EXPERIMENTAL (since 1.106.0)
12837
+ *
12838
+ * Different types of IllustrationMessageSize.
12839
+ */
12840
+ enum IllustrationMessageSize {
12841
+ /**
12842
+ * Automatically decides the `Illustration` size (`Base`, `Spot`, `Dialog`, or `Scene`) depending on the
12843
+ * `IllustratedMessage` container width.
12844
+ *
12845
+ * **Note:** `Auto` is the only option where the illustration size is changed according to the available
12846
+ * container width. If any other `IllustratedMessageSize` is chosen, it remains until changed by the app
12847
+ * developer.
12848
+ */
12849
+ Auto = "Auto",
12850
+ /**
12851
+ * Base `Illustration` size (XS breakpoint). Suitable for cards (two columns).
12852
+ *
12853
+ * **Note:** When `Base` is in use, no illustration is displayed.
12854
+ */
12855
+ Base = "Base",
12856
+ /**
12857
+ * Dialog `Illustration` size (M breakpoint). Suitable for dialogs.
12858
+ */
12859
+ Dialog = "Dialog",
12860
+ /**
12861
+ * Scene `Illustration` size (L breakpoint). Suitable for a `Page` or a table.
12862
+ */
12863
+ Scene = "Scene",
12864
+ /**
12865
+ * Spot `Illustration` size (S breakpoint). Suitable for cards (four columns).
12866
+ */
12867
+ Spot = "Spot",
12868
+ }
12673
12869
  /**
12674
12870
  * @SINCE 1.95.0
12675
12871
  * @EXPERIMENTAL (since 1.95.0)