@sapui5/ts-types-esm 1.139.0 → 1.141.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 (69) 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 +0 -1623
  7. package/types/sap.esh.search.ui.d.ts +384 -1
  8. package/types/sap.f.d.ts +102 -13
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -5
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +98 -8
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +369 -51
  15. package/types/sap.fe.navigation.d.ts +13 -15
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +47 -11
  23. package/types/sap.insights.d.ts +130 -2
  24. package/types/sap.m.d.ts +722 -282
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +118 -5
  31. package/types/sap.suite.ui.commons.d.ts +1 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +41 -5
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +5 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +16 -1
  38. package/types/sap.ui.core.d.ts +531 -163
  39. package/types/sap.ui.dt.d.ts +202 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +8 -13
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +13 -13
  45. package/types/sap.ui.layout.d.ts +63 -47
  46. package/types/sap.ui.mdc.d.ts +77 -25
  47. package/types/sap.ui.richtexteditor.d.ts +309 -9
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +585 -4
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +55 -3
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +438 -6
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +41 -8
  63. package/types/sap.ushell_abap.d.ts +7 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/fe/navigation/library" {
4
4
  /**
@@ -224,7 +224,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
224
224
  * {@link #.navigate NavigationHandler.navigate} method.
225
225
  *
226
226
  *
227
- * @returns Instance of {@link sap.fe.navigation.SelectionVariant }
227
+ * @returns Instance of {@link sap.fe.navigation.SelectionVariant}
228
228
  */
229
229
  mixAttributesAndSelectionVariant(
230
230
  /**
@@ -346,12 +346,12 @@ declare module "sap/fe/navigation/NavigationHandler" {
346
346
  * above. The app state is
347
347
  * an object that contains the following information:
348
348
  *
349
- * `oAppData.oSelectionVariant`: An instance of {@link sap.fe.navigation.SelectionVariant }
349
+ * `oAppData.oSelectionVariant`: An instance of {@link sap.fe.navigation.SelectionVariant}
350
350
  * containing only parameters/select options that are related to navigation
351
351
  *
352
352
  * - `oAppData.selectionVariant`: The navigation-related selection variant as a JSON-formatted string
353
353
  * `oAppData.oDefaultedSelectionVariant`: An instance of
354
- * {@link sap.fe.navigation.SelectionVariant } containing only the parameters/select options that are set
354
+ * {@link sap.fe.navigation.SelectionVariant} containing only the parameters/select options that are set
355
355
  * by user
356
356
  * default data
357
357
  * `oAppData.bNavSelVarHasDefaultsOnly`: A Boolean flag that indicates whether only defaulted parameters
@@ -364,11 +364,11 @@ declare module "sap/fe/navigation/NavigationHandler" {
364
364
  * If the navigation-related selection variant is empty, it is replaced by a copy of the defaulted selection
365
365
  * variant.
366
366
  *
367
- * The navigation type is an enumeration type of type {@link sap.fe.navigation.NavType } (possible values
367
+ * The navigation type is an enumeration type of type {@link sap.fe.navigation.NavType} (possible values
368
368
  * are
369
369
  * initial, URLParams, xAppState, and iAppState).
370
370
  *
371
- * **Note:** If the navigation type is {@link sap.fe.navigation.NavType.iAppState } oAppData has two
371
+ * **Note:** If the navigation type is {@link sap.fe.navigation.NavType.iAppState} oAppData has two
372
372
  * additional properties
373
373
  *
374
374
  *
@@ -380,9 +380,9 @@ declare module "sap/fe/navigation/NavigationHandler" {
380
380
  * `oAppData.oDefaultedSelectionVariant` is an empty selection variant and
381
381
  * `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
382
382
  *
383
- * **Note:** If the navigation type is {@link sap.fe.navigation.NavType.initial } oAppData is an empty object!
383
+ * **Note:** If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!
384
384
  *
385
- * If an error occurs, an error object of type {@link sap.fe.navigation.NavError }, URL parameters (if available)
385
+ * If an error occurs, an error object of type {@link sap.fe.navigation.NavError}, URL parameters (if available)
386
386
  * and the type of navigation are returned.
387
387
  */
388
388
  parseNavigation(): JQuery.Promise<any>;
@@ -417,7 +417,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
417
417
  * @returns A Promise object to monitor when all actions of the function have been executed; if the execution
418
418
  * is successful, the
419
419
  * modified oTableEventParameters is returned; if an error occurs, an error object of type
420
- * {@link sap.fe.navigation.NavError } is returned
420
+ * {@link sap.fe.navigation.NavError} is returned
421
421
  */
422
422
  processBeforeSmartLinkPopoverOpens(
423
423
  /**
@@ -497,13 +497,12 @@ declare module "sap/fe/navigation/NavigationHandler" {
497
497
  /**
498
498
  * Changes the URL according to the current app state and stores the app state for later retrieval.
499
499
  *
500
- * @deprecated As of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
500
+ * @deprecated As of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
501
501
  * instead.
502
502
  *
503
503
  * @returns A Promise object to monitor when all the actions of the function have been executed; if the
504
504
  * execution is successful, the
505
- * app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError }
506
- * is
505
+ * app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is
507
506
  * returned
508
507
  */
509
508
  storeInnerAppState(
@@ -524,8 +523,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
524
523
  *
525
524
  * @returns A Promise object to monitor when all the actions of the function have been executed; if the
526
525
  * execution is successful, the
527
- * app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError }
528
- * is
526
+ * app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is
529
527
  * returned
530
528
  */
531
529
  storeInnerAppStateAsync(
@@ -548,7 +546,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
548
546
  /**
549
547
  * Changes the URL according to the current app state and stores the app state for later retrieval.
550
548
  *
551
- * @deprecated As of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
549
+ * @deprecated As of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync }
552
550
  * instead.
553
551
  *
554
552
  * @returns An object containing the appStateId and a promise object to monitor when all the actions of
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/fe/plugins/managecache/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/fe/templates/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/fe/test/library" {}
4
4
 
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/gantt/library" {
4
4
  import ChartScheme from "sap/gantt/config/ChartScheme";
@@ -35305,8 +35305,6 @@ declare module "sap/gantt/simple/BaseShape" {
35305
35305
  *
35306
35306
  * Postion of left anchor for a shape to connect with other shapes whose value ranges from 0-100
35307
35307
  *
35308
- * Default value is `50`.
35309
- *
35310
35308
  * @since 1.131
35311
35309
  *
35312
35310
  * @returns Value of property `leftAnchorPosition`
@@ -35342,8 +35340,6 @@ declare module "sap/gantt/simple/BaseShape" {
35342
35340
  *
35343
35341
  * Postion of right anchor for a shape to connect with other shapes whose value ranges from 0-100
35344
35342
  *
35345
- * Default value is `50`.
35346
- *
35347
35343
  * @since 1.131
35348
35344
  *
35349
35345
  * @returns Value of property `rightAnchorPosition`
@@ -36025,8 +36021,6 @@ declare module "sap/gantt/simple/BaseShape" {
36025
36021
  *
36026
36022
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
36027
36023
  *
36028
- * Default value is `50`.
36029
- *
36030
36024
  * @since 1.131
36031
36025
  *
36032
36026
  * @returns Reference to `this` in order to allow method chaining
@@ -36035,7 +36029,7 @@ declare module "sap/gantt/simple/BaseShape" {
36035
36029
  /**
36036
36030
  * New value for property `leftAnchorPosition`
36037
36031
  */
36038
- iLeftAnchorPosition?: int
36032
+ iLeftAnchorPosition: int
36039
36033
  ): this;
36040
36034
  /**
36041
36035
  * Sets a new value for property {@link #getOpacity opacity}.
@@ -36083,8 +36077,6 @@ declare module "sap/gantt/simple/BaseShape" {
36083
36077
  *
36084
36078
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
36085
36079
  *
36086
- * Default value is `50`.
36087
- *
36088
36080
  * @since 1.131
36089
36081
  *
36090
36082
  * @returns Reference to `this` in order to allow method chaining
@@ -36093,7 +36085,7 @@ declare module "sap/gantt/simple/BaseShape" {
36093
36085
  /**
36094
36086
  * New value for property `rightAnchorPosition`
36095
36087
  */
36096
- iRightAnchorPosition?: int
36088
+ iRightAnchorPosition: int
36097
36089
  ): this;
36098
36090
  /**
36099
36091
  * Sets a new value for property {@link #getRowYCenter rowYCenter}.
@@ -48185,6 +48177,12 @@ declare module "sap/gantt/simple/GanttChartWithTable" {
48185
48177
  * The mouse position relative to the top edge of the document.
48186
48178
  */
48187
48179
  pageY?: int;
48180
+
48181
+ /**
48182
+ * Indicates whether the connector has a pin icon. This parameter is only valid when the shape is a connector
48183
+ * shape.
48184
+ */
48185
+ isPinConnector?: boolean;
48188
48186
  }
48189
48187
 
48190
48188
  /**
@@ -54237,6 +54235,8 @@ declare module "sap/gantt/simple/StockChart" {
54237
54235
 
54238
54236
  import StockChartDimension from "sap/gantt/simple/StockChartDimension";
54239
54237
 
54238
+ import BaseLine from "sap/gantt/simple/BaseLine";
54239
+
54240
54240
  import ElementMetadata from "sap/ui/core/ElementMetadata";
54241
54241
 
54242
54242
  import {
@@ -54326,6 +54326,14 @@ declare module "sap/gantt/simple/StockChart" {
54326
54326
  */
54327
54327
  oStockChartDimension: StockChartDimension
54328
54328
  ): this;
54329
+ /**
54330
+ * Destroys the customMiddleLine in the aggregation {@link #getCustomMiddleLine customMiddleLine}.
54331
+ *
54332
+ * @since 1.140
54333
+ *
54334
+ * @returns Reference to `this` in order to allow method chaining
54335
+ */
54336
+ destroyCustomMiddleLine(): this;
54329
54337
  /**
54330
54338
  * Destroys all the stockChartDimensions in the aggregation {@link #getStockChartDimensions stockChartDimensions}.
54331
54339
  *
@@ -54333,6 +54341,14 @@ declare module "sap/gantt/simple/StockChart" {
54333
54341
  * @returns Reference to `this` in order to allow method chaining
54334
54342
  */
54335
54343
  destroyStockChartDimensions(): this;
54344
+ /**
54345
+ * Gets content of aggregation {@link #getCustomMiddleLine customMiddleLine}.
54346
+ *
54347
+ * Custom configuration for middle line to define stroke, stroke-width and stroke-dasharray.
54348
+ *
54349
+ * @since 1.140
54350
+ */
54351
+ getCustomMiddleLine(): BaseLine;
54336
54352
  /**
54337
54353
  * Gets current value of property {@link #getMaxValue maxValue}.
54338
54354
  *
@@ -54463,6 +54479,19 @@ declare module "sap/gantt/simple/StockChart" {
54463
54479
  */
54464
54480
  oElement: object
54465
54481
  ): void;
54482
+ /**
54483
+ * Sets the aggregated {@link #getCustomMiddleLine customMiddleLine}.
54484
+ *
54485
+ * @since 1.140
54486
+ *
54487
+ * @returns Reference to `this` in order to allow method chaining
54488
+ */
54489
+ setCustomMiddleLine(
54490
+ /**
54491
+ * The customMiddleLine to set
54492
+ */
54493
+ oCustomMiddleLine: BaseLine
54494
+ ): this;
54466
54495
  /**
54467
54496
  * Sets a new value for property {@link #getMaxValue maxValue}.
54468
54497
  *
@@ -54597,6 +54626,13 @@ declare module "sap/gantt/simple/StockChart" {
54597
54626
  | StockChartDimension
54598
54627
  | AggregationBindingInfo
54599
54628
  | `{${string}}`;
54629
+
54630
+ /**
54631
+ * Custom configuration for middle line to define stroke, stroke-width and stroke-dasharray.
54632
+ *
54633
+ * @since 1.140
54634
+ */
54635
+ customMiddleLine?: BaseLine;
54600
54636
  }
54601
54637
  }
54602
54638
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.139.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/insights/library" {}
4
4
 
@@ -75,11 +75,137 @@ declare module "sap/insights/CardHelper" {
75
75
  /**
76
76
  * callback event to be called when confirm button is pressed
77
77
  */
78
- onConfirm: Function
78
+ onConfirm: Function,
79
+ /**
80
+ * callback event to be called when close button is pressed
81
+ */
82
+ onClose: Function
79
83
  ): Promise<void>;
80
84
  }
81
85
  }
82
86
 
87
+ declare module "sap/insights/CardProvider" {
88
+ import BaseObject from "sap/ui/base/Object";
89
+
90
+ import { Card } from "sap/insights/CardsChannel";
91
+
92
+ import Metadata from "sap/ui/base/Metadata";
93
+
94
+ /**
95
+ * This class is used to provide cards to consumers like SAP Collaboration Manager. It registers itself
96
+ * with the cards channel and shares available cards with interested consumers. It also handles requests
97
+ * for specific cards from consumers. It can be used to share cards with other applications or components
98
+ * that are interested in them
99
+ *
100
+ * @since 1.140
101
+ */
102
+ export default class CardProvider extends BaseObject {
103
+ /**
104
+ * Constructor for the card provider.
105
+ */
106
+ constructor(
107
+ /**
108
+ * unique ID to be used for registering the provider
109
+ */
110
+ sId: string,
111
+ /**
112
+ * An array containing available cards
113
+ */
114
+ aCards: Card[]
115
+ );
116
+
117
+ /**
118
+ * Creates a new subclass of class sap.insights.CardProvider with name `sClassName` and enriches it with
119
+ * the information contained in `oClassInfo`.
120
+ *
121
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
122
+ *
123
+ *
124
+ * @returns Created class / constructor function
125
+ */
126
+ static extend<T extends Record<string, unknown>>(
127
+ /**
128
+ * Name of the class being created
129
+ */
130
+ sClassName: string,
131
+ /**
132
+ * Object literal with information about the class
133
+ */
134
+ oClassInfo?: sap.ClassInfo<T, CardProvider>,
135
+ /**
136
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
137
+ * used by this class
138
+ */
139
+ FNMetaImpl?: Function
140
+ ): Function;
141
+ /**
142
+ * Returns a metadata object for class sap.insights.CardProvider.
143
+ *
144
+ *
145
+ * @returns Metadata object describing this class
146
+ */
147
+ static getMetadata(): Metadata;
148
+ /**
149
+ * This method is called when a consumer requests a specific card. It checks if the consumer is registered
150
+ * and if the card exists in the shared cards. If both conditions are met it publishes the card to the consumer.
151
+ * If the consumer is not registered, it does nothing.
152
+ *
153
+ * @since 1.140
154
+ */
155
+ onCardRequested(
156
+ /**
157
+ * id of the requesting consumer
158
+ */
159
+ sConsumerId: string,
160
+ /**
161
+ * unique ID of available card
162
+ */
163
+ sCardId: string
164
+ ): void;
165
+ /**
166
+ * This method is called when a consumer connects to the cards channel. It checks if the card detail control
167
+ * is loaded, and if not, it loads it. Then it shares the available cards with the consumer and navigates
168
+ * to the card list page. If the card detail control is already loaded, it simply shares the available cards.
169
+ *
170
+ * @since 1.140
171
+ */
172
+ onConsumerConnected(
173
+ /**
174
+ * id of the requesting consumer
175
+ */
176
+ sConsumerId: string
177
+ ): void;
178
+ /**
179
+ * This method is called when a consumer disconnects from the cards channel. It removes the consumer from
180
+ * the list of consumers and stops sharing cards with it. If the consumer is not registered, it does nothing.
181
+ *
182
+ * @since 1.140
183
+ */
184
+ onConsumerDisconnected(
185
+ /**
186
+ * id of the requesting consumer
187
+ */
188
+ sConsumerId: string
189
+ ): void;
190
+ /**
191
+ * This method is called when the view is updated. It checks if the home page is currently being rendered
192
+ * and registers or unregisters the card provider accordingly.
193
+ *
194
+ * @since 1.140
195
+ */
196
+ onViewUpdate(
197
+ /**
198
+ * true if the home page is currently being rendered.
199
+ */
200
+ bActive: boolean,
201
+ /**
202
+ * An array containing available cards
203
+ */
204
+ aCards: Card[]
205
+ ): void;
206
+ }
207
+ }
208
+
83
209
  declare module "sap/insights/CardsChannel" {
84
210
  import BaseObject from "sap/ui/base/Object";
85
211
 
@@ -660,6 +786,8 @@ declare namespace sap {
660
786
  interface IUI5DefineDependencyNames {
661
787
  "sap/insights/CardHelper": undefined;
662
788
 
789
+ "sap/insights/CardProvider": undefined;
790
+
663
791
  "sap/insights/CardsChannel": undefined;
664
792
 
665
793
  "sap/insights/channels/ContextChannel": undefined;