@sapui5/ts-types 1.100.2 → 1.102.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 (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -0
  3. package/types/sap.apf.d.ts +89 -1
  4. package/types/sap.ca.ui.d.ts +1747 -124
  5. package/types/sap.chart.d.ts +376 -30
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +6 -2
  8. package/types/sap.f.d.ts +2015 -119
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +77 -64
  11. package/types/sap.fe.macros.d.ts +92 -40
  12. package/types/sap.fe.navigation.d.ts +148 -74
  13. package/types/sap.fe.templates.d.ts +115 -187
  14. package/types/sap.fe.test.d.ts +539 -25
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7242 -516
  17. package/types/sap.insights.d.ts +80 -0
  18. package/types/sap.landvisz.d.ts +1015 -66
  19. package/types/sap.m.d.ts +16699 -1186
  20. package/types/sap.makit.d.ts +575 -54
  21. package/types/sap.me.d.ts +578 -51
  22. package/types/sap.ndc.d.ts +63 -5
  23. package/types/sap.ovp.d.ts +5 -6
  24. package/types/sap.rules.ui.d.ts +209 -18
  25. package/types/sap.sac.df.d.ts +2196 -0
  26. package/types/sap.sac.grid.d.ts +115 -8
  27. package/types/sap.suite.ui.commons.d.ts +5532 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +226 -31
  29. package/types/sap.suite.ui.microchart.d.ts +1801 -160
  30. package/types/sap.tnt.d.ts +279 -19
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3784 -313
  33. package/types/sap.ui.comp.d.ts +4005 -289
  34. package/types/sap.ui.core.d.ts +6317 -336
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +61 -6
  37. package/types/sap.ui.fl.d.ts +1 -1
  38. package/types/sap.ui.generic.app.d.ts +247 -73
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +316 -23
  41. package/types/sap.ui.layout.d.ts +1851 -199
  42. package/types/sap.ui.mdc.d.ts +9 -1
  43. package/types/sap.ui.richtexteditor.d.ts +340 -49
  44. package/types/sap.ui.rta.d.ts +5 -1
  45. package/types/sap.ui.suite.d.ts +87 -6
  46. package/types/sap.ui.support.d.ts +39 -6
  47. package/types/sap.ui.table.d.ts +1060 -113
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2704 -202
  50. package/types/sap.ui.ux3.d.ts +2379 -181
  51. package/types/sap.ui.vbm.d.ts +2002 -197
  52. package/types/sap.ui.vk.d.ts +6027 -327
  53. package/types/sap.ui.vtm.d.ts +1130 -41
  54. package/types/sap.uiext.inbox.d.ts +423 -22
  55. package/types/sap.ushell.d.ts +2036 -161
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +903 -88
  58. package/types/sap.viz.d.ts +5514 -380
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +249 -1688
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +1505 -4036
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.100.0
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace sac {
@@ -12,7 +12,8 @@ declare namespace sap {
12
12
  */
13
13
  alertLevel?:
14
14
  | sap.sac.grid.AlertLevel
15
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
15
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
16
+ | `{${string}}`;
16
17
 
17
18
  /**
18
19
  * The value that is displayed in the cell
@@ -24,12 +25,16 @@ declare namespace sap {
24
25
  */
25
26
  cellType?:
26
27
  | sap.sac.grid.CellType
27
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
28
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
29
+ | `{${string}}`;
28
30
 
29
31
  /**
30
32
  * The Column of the `Cell`
31
33
  */
32
- column?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
34
+ column?:
35
+ | int
36
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
37
+ | `{${string}}`;
33
38
 
34
39
  /**
35
40
  * The Icon to be displayed in the `Cell`
@@ -51,17 +56,24 @@ declare namespace sap {
51
56
  */
52
57
  valueState?:
53
58
  | sap.ui.core.ValueState
54
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
59
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
60
+ | `{${string}}`;
55
61
 
56
62
  /**
57
63
  * The row of the `Cell`.
58
64
  */
59
- row?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
65
+ row?:
66
+ | int
67
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
68
+ | `{${string}}`;
60
69
 
61
70
  /**
62
71
  * The indent level of the `Cell`.
63
72
  */
64
- displayLevel?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
73
+ displayLevel?:
74
+ | int
75
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
76
+ | `{${string}}`;
65
77
 
66
78
  /**
67
79
  * The semantic class of the Cell. The css class associated to the class is put into the cells td.
@@ -71,7 +83,15 @@ declare namespace sap {
71
83
  /**
72
84
  * Indicates whether the `Cell` is input enabled.
73
85
  */
74
- inputEnabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
86
+ inputEnabled?:
87
+ | boolean
88
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
89
+ | `{${string}}`;
90
+
91
+ /**
92
+ * The Document Id of the `Cell`.
93
+ */
94
+ documentId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
75
95
  }
76
96
 
77
97
  interface $SemanticStyleSettings extends sap.ui.core.$ElementSettings {
@@ -129,6 +149,8 @@ declare namespace sap {
129
149
  * contained in `oClassInfo`.
130
150
  *
131
151
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
152
+ *
153
+ * @returns Created class / constructor function
132
154
  */
133
155
  static extend<T extends Record<string, unknown>>(
134
156
  /**
@@ -147,18 +169,24 @@ declare namespace sap {
147
169
  ): Function;
148
170
  /**
149
171
  * Returns a metadata object for class sap.sac.grid.Cell.
172
+ *
173
+ * @returns Metadata object describing this class
150
174
  */
151
175
  static getMetadata(): sap.ui.core.ElementMetadata;
152
176
  /**
153
177
  * Gets current value of property {@link #getAlertLevel alertLevel}.
154
178
  *
155
179
  * The alert level (intensitiy of emphasis)
180
+ *
181
+ * @returns Value of property `alertLevel`
156
182
  */
157
183
  getAlertLevel(): sap.sac.grid.AlertLevel;
158
184
  /**
159
185
  * Gets current value of property {@link #getCellType cellType}.
160
186
  *
161
187
  * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
188
+ *
189
+ * @returns Value of property `cellType`
162
190
  */
163
191
  getCellType(): sap.sac.grid.CellType;
164
192
  /**
@@ -167,42 +195,64 @@ declare namespace sap {
167
195
  * The Column of the `Cell`
168
196
  *
169
197
  * Default value is `0`.
198
+ *
199
+ * @returns Value of property `column`
170
200
  */
171
201
  getColumn(): int;
172
202
  /**
173
203
  * Gets current value of property {@link #getContext context}.
174
204
  *
175
205
  * The context the `Cell`. Used for tagging a cell by the PivotTable.
206
+ *
207
+ * @returns Value of property `context`
176
208
  */
177
209
  getContext(): string;
178
210
  /**
179
211
  * Gets current value of property {@link #getDisplayLevel displayLevel}.
180
212
  *
181
213
  * The indent level of the `Cell`.
214
+ *
215
+ * @returns Value of property `displayLevel`
182
216
  */
183
217
  getDisplayLevel(): int;
184
218
  /**
185
219
  * Gets current value of property {@link #getDisplayValue displayValue}.
186
220
  *
187
221
  * The value that is displayed in the cell
222
+ *
223
+ * @returns Value of property `displayValue`
188
224
  */
189
225
  getDisplayValue(): string;
226
+ /**
227
+ * Gets current value of property {@link #getDocumentId documentId}.
228
+ *
229
+ * The Document Id of the `Cell`.
230
+ *
231
+ * @returns Value of property `documentId`
232
+ */
233
+ getDocumentId(): string;
190
234
  /**
191
235
  * Gets current value of property {@link #getHelpId helpId}.
192
236
  *
193
237
  * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
238
+ *
239
+ * @returns Value of property `helpId`
194
240
  */
195
241
  getHelpId(): string;
196
242
  /**
197
243
  * Gets current value of property {@link #getIcon icon}.
198
244
  *
199
245
  * The Icon to be displayed in the `Cell`
246
+ *
247
+ * @returns Value of property `icon`
200
248
  */
201
249
  getIcon(): string;
202
250
  /**
203
251
  * Gets current value of property {@link #getInputEnabled inputEnabled}.
204
252
  *
205
253
  * Indicates whether the `Cell` is input enabled.
254
+ *
255
+ * @returns Value of property `inputEnabled`
206
256
  */
207
257
  getInputEnabled(): boolean;
208
258
  /**
@@ -211,18 +261,24 @@ declare namespace sap {
211
261
  * The row of the `Cell`.
212
262
  *
213
263
  * Default value is `0`.
264
+ *
265
+ * @returns Value of property `row`
214
266
  */
215
267
  getRow(): int;
216
268
  /**
217
269
  * Gets current value of property {@link #getSemanticClass semanticClass}.
218
270
  *
219
271
  * The semantic class of the Cell. The css class associated to the class is put into the cells td.
272
+ *
273
+ * @returns Value of property `semanticClass`
220
274
  */
221
275
  getSemanticClass(): string;
222
276
  /**
223
277
  * Gets current value of property {@link #getValueState valueState}.
224
278
  *
225
279
  * The value state of the `Cell`. This property is used for entry ready cells.
280
+ *
281
+ * @returns Value of property `valueState`
226
282
  */
227
283
  getValueState(): sap.ui.core.ValueState;
228
284
  /**
@@ -231,6 +287,8 @@ declare namespace sap {
231
287
  * The alert level (intensitiy of emphasis)
232
288
  *
233
289
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
290
+ *
291
+ * @returns Reference to `this` in order to allow method chaining
234
292
  */
235
293
  setAlertLevel(
236
294
  /**
@@ -244,6 +302,8 @@ declare namespace sap {
244
302
  * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
245
303
  *
246
304
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
305
+ *
306
+ * @returns Reference to `this` in order to allow method chaining
247
307
  */
248
308
  setCellType(
249
309
  /**
@@ -259,6 +319,8 @@ declare namespace sap {
259
319
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
260
320
  *
261
321
  * Default value is `0`.
322
+ *
323
+ * @returns Reference to `this` in order to allow method chaining
262
324
  */
263
325
  setColumn(
264
326
  /**
@@ -272,6 +334,8 @@ declare namespace sap {
272
334
  * The context the `Cell`. Used for tagging a cell by the PivotTable.
273
335
  *
274
336
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
337
+ *
338
+ * @returns Reference to `this` in order to allow method chaining
275
339
  */
276
340
  setContext(
277
341
  /**
@@ -285,6 +349,8 @@ declare namespace sap {
285
349
  * The indent level of the `Cell`.
286
350
  *
287
351
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
352
+ *
353
+ * @returns Reference to `this` in order to allow method chaining
288
354
  */
289
355
  setDisplayLevel(
290
356
  /**
@@ -298,6 +364,8 @@ declare namespace sap {
298
364
  * The value that is displayed in the cell
299
365
  *
300
366
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
367
+ *
368
+ * @returns Reference to `this` in order to allow method chaining
301
369
  */
302
370
  setDisplayValue(
303
371
  /**
@@ -305,12 +373,29 @@ declare namespace sap {
305
373
  */
306
374
  sDisplayValue: string
307
375
  ): this;
376
+ /**
377
+ * Sets a new value for property {@link #getDocumentId documentId}.
378
+ *
379
+ * The Document Id of the `Cell`.
380
+ *
381
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
382
+ *
383
+ * @returns Reference to `this` in order to allow method chaining
384
+ */
385
+ setDocumentId(
386
+ /**
387
+ * New value for property `documentId`
388
+ */
389
+ sDocumentId: string
390
+ ): this;
308
391
  /**
309
392
  * Sets a new value for property {@link #getHelpId helpId}.
310
393
  *
311
394
  * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
312
395
  *
313
396
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
397
+ *
398
+ * @returns Reference to `this` in order to allow method chaining
314
399
  */
315
400
  setHelpId(
316
401
  /**
@@ -324,6 +409,8 @@ declare namespace sap {
324
409
  * The Icon to be displayed in the `Cell`
325
410
  *
326
411
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
412
+ *
413
+ * @returns Reference to `this` in order to allow method chaining
327
414
  */
328
415
  setIcon(
329
416
  /**
@@ -337,6 +424,8 @@ declare namespace sap {
337
424
  * Indicates whether the `Cell` is input enabled.
338
425
  *
339
426
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
427
+ *
428
+ * @returns Reference to `this` in order to allow method chaining
340
429
  */
341
430
  setInputEnabled(
342
431
  /**
@@ -352,6 +441,8 @@ declare namespace sap {
352
441
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
353
442
  *
354
443
  * Default value is `0`.
444
+ *
445
+ * @returns Reference to `this` in order to allow method chaining
355
446
  */
356
447
  setRow(
357
448
  /**
@@ -365,6 +456,8 @@ declare namespace sap {
365
456
  * The semantic class of the Cell. The css class associated to the class is put into the cells td.
366
457
  *
367
458
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
459
+ *
460
+ * @returns Reference to `this` in order to allow method chaining
368
461
  */
369
462
  setSemanticClass(
370
463
  /**
@@ -378,6 +471,8 @@ declare namespace sap {
378
471
  * The value state of the `Cell`. This property is used for entry ready cells.
379
472
  *
380
473
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
474
+ *
475
+ * @returns Reference to `this` in order to allow method chaining
381
476
  */
382
477
  setValueState(
383
478
  /**
@@ -407,6 +502,8 @@ declare namespace sap {
407
502
  * the information contained in `oClassInfo`.
408
503
  *
409
504
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
505
+ *
506
+ * @returns Created class / constructor function
410
507
  */
411
508
  static extend<T extends Record<string, unknown>>(
412
509
  /**
@@ -425,18 +522,24 @@ declare namespace sap {
425
522
  ): Function;
426
523
  /**
427
524
  * Returns a metadata object for class sap.sac.grid.SemanticStyle.
525
+ *
526
+ * @returns Metadata object describing this class
428
527
  */
429
528
  static getMetadata(): sap.ui.core.ElementMetadata;
430
529
  /**
431
530
  * Gets current value of property {@link #getClass class}.
432
531
  *
433
532
  * The associated css class
533
+ *
534
+ * @returns Value of property `class`
434
535
  */
435
536
  getClass(): string;
436
537
  /**
437
538
  * Gets current value of property {@link #getMember member}.
438
539
  *
439
540
  * The value that is displayed in the cell
541
+ *
542
+ * @returns Value of property `member`
440
543
  */
441
544
  getMember(): string;
442
545
  /**
@@ -445,6 +548,8 @@ declare namespace sap {
445
548
  * The associated css class
446
549
  *
447
550
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
551
+ *
552
+ * @returns Reference to `this` in order to allow method chaining
448
553
  */
449
554
  setClass(
450
555
  /**
@@ -458,6 +563,8 @@ declare namespace sap {
458
563
  * The value that is displayed in the cell
459
564
  *
460
565
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
566
+ *
567
+ * @returns Reference to `this` in order to allow method chaining
461
568
  */
462
569
  setMember(
463
570
  /**