@sapui5/ts-types 1.101.1 → 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 +1 -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 +375 -29
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +1 -669
  8. package/types/sap.f.d.ts +1785 -100
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +70 -2
  11. package/types/sap.fe.macros.d.ts +78 -34
  12. package/types/sap.fe.navigation.d.ts +144 -4
  13. package/types/sap.fe.templates.d.ts +26 -5
  14. package/types/sap.fe.test.d.ts +497 -2
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7203 -502
  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 +16491 -1149
  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 +171 -15
  25. package/types/sap.sac.df.d.ts +1430 -215
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5515 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +157 -69
  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 +3853 -276
  34. package/types/sap.ui.core.d.ts +6248 -313
  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 +238 -64
  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 +1 -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 +30 -1
  47. package/types/sap.ui.table.d.ts +1050 -80
  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 +5353 -310
  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 +1488 -49
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +902 -87
  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 +165 -20
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +227 -14
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.101.0
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -79,6 +79,8 @@ declare namespace sap {
79
79
  *
80
80
  * The {@link sap.ui.vtm.Vtm} constructor can be used to create an instance of {@link sap.ui.vtm.Vtm} with
81
81
  * a specific set of extensions.
82
+ *
83
+ * @returns The created instance of {@link sap.ui.vtm.Vtm}.
82
84
  */
83
85
  function createVtm(
84
86
  /**
@@ -108,7 +110,8 @@ declare namespace sap {
108
110
  */
109
111
  predefinedView?:
110
112
  | sap.ui.vtm.PredefinedView
111
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
113
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
114
+ | `{${string}}`;
112
115
  }
113
116
 
114
117
  interface $LoadProgressExtensionSettings
@@ -127,7 +130,8 @@ declare namespace sap {
127
130
  */
128
131
  highlightColor?:
129
132
  | sap.ui.core.CSSColor
130
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
133
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
134
+ | `{${string}}`;
131
135
  }
132
136
 
133
137
  interface $SceneNodeHoverTooltipExtensionSettings
@@ -146,7 +150,10 @@ declare namespace sap {
146
150
  * ```
147
151
  * If function returns null no tooltip will be displayed.
148
152
  */
149
- tooltipCallback?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
153
+ tooltipCallback?:
154
+ | any
155
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
156
+ | `{${string}}`;
150
157
  }
151
158
 
152
159
  interface $SelectionLinkingExtensionSettings
@@ -162,7 +169,8 @@ declare namespace sap {
162
169
  */
163
170
  findMatchingTreeItems?:
164
171
  | any
165
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
172
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
173
+ | `{${string}}`;
166
174
  }
167
175
 
168
176
  interface $ViewLinkingExtensionSettings
@@ -208,6 +216,8 @@ declare namespace sap {
208
216
  * and enriches it with the information contained in `oClassInfo`.
209
217
  *
210
218
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
219
+ *
220
+ * @returns Created class / constructor function
211
221
  */
212
222
  static extend<T extends Record<string, unknown>>(
213
223
  /**
@@ -229,6 +239,8 @@ declare namespace sap {
229
239
  ): Function;
230
240
  /**
231
241
  * Returns a metadata object for class sap.ui.vtm.extensions.DisplayStateCalculationExtension.
242
+ *
243
+ * @returns Metadata object describing this class
232
244
  */
233
245
  static getMetadata(): sap.ui.core.ElementMetadata;
234
246
  }
@@ -265,6 +277,8 @@ declare namespace sap {
265
277
  * enriches it with the information contained in `oClassInfo`.
266
278
  *
267
279
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
280
+ *
281
+ * @returns Created class / constructor function
268
282
  */
269
283
  static extend<T extends Record<string, unknown>>(
270
284
  /**
@@ -286,6 +300,8 @@ declare namespace sap {
286
300
  ): Function;
287
301
  /**
288
302
  * Returns a metadata object for class sap.ui.vtm.extensions.InitialViewExtension.
303
+ *
304
+ * @returns Metadata object describing this class
289
305
  */
290
306
  static getMetadata(): sap.ui.core.ElementMetadata;
291
307
  /**
@@ -293,6 +309,8 @@ declare namespace sap {
293
309
  *
294
310
  * Specifies a predefined view to use. If a specific view is not specified this extension will zoom to fit
295
311
  * all geometry without changing the camera angle.
312
+ *
313
+ * @returns Value of property `predefinedView`
296
314
  */
297
315
  getPredefinedView(): sap.ui.vtm.PredefinedView;
298
316
  /**
@@ -302,6 +320,8 @@ declare namespace sap {
302
320
  * all geometry without changing the camera angle.
303
321
  *
304
322
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
323
+ *
324
+ * @returns Reference to `this` in order to allow method chaining
305
325
  */
306
326
  setPredefinedView(
307
327
  /**
@@ -342,6 +362,8 @@ declare namespace sap {
342
362
  * enriches it with the information contained in `oClassInfo`.
343
363
  *
344
364
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
365
+ *
366
+ * @returns Created class / constructor function
345
367
  */
346
368
  static extend<T extends Record<string, unknown>>(
347
369
  /**
@@ -363,6 +385,8 @@ declare namespace sap {
363
385
  ): Function;
364
386
  /**
365
387
  * Returns a metadata object for class sap.ui.vtm.extensions.LoadProgressExtension.
388
+ *
389
+ * @returns Metadata object describing this class
366
390
  */
367
391
  static getMetadata(): sap.ui.core.ElementMetadata;
368
392
  }
@@ -411,6 +435,8 @@ declare namespace sap {
411
435
  * and enriches it with the information contained in `oClassInfo`.
412
436
  *
413
437
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
438
+ *
439
+ * @returns Created class / constructor function
414
440
  */
415
441
  static extend<T extends Record<string, unknown>>(
416
442
  /**
@@ -432,6 +458,8 @@ declare namespace sap {
432
458
  ): Function;
433
459
  /**
434
460
  * Returns a metadata object for class sap.ui.vtm.extensions.MessageStatusCalculationExtension.
461
+ *
462
+ * @returns Metadata object describing this class
435
463
  */
436
464
  static getMetadata(): sap.ui.core.ElementMetadata;
437
465
  }
@@ -464,6 +492,8 @@ declare namespace sap {
464
492
  * and enriches it with the information contained in `oClassInfo`.
465
493
  *
466
494
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
495
+ *
496
+ * @returns Created class / constructor function
467
497
  */
468
498
  static extend<T extends Record<string, unknown>>(
469
499
  /**
@@ -485,6 +515,8 @@ declare namespace sap {
485
515
  ): Function;
486
516
  /**
487
517
  * Returns a metadata object for class sap.ui.vtm.extensions.MessageStatusIconClickExtension.
518
+ *
519
+ * @returns Metadata object describing this class
488
520
  */
489
521
  static getMetadata(): sap.ui.core.ElementMetadata;
490
522
  }
@@ -520,6 +552,8 @@ declare namespace sap {
520
552
  * and enriches it with the information contained in `oClassInfo`.
521
553
  *
522
554
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
555
+ *
556
+ * @returns Created class / constructor function
523
557
  */
524
558
  static extend<T extends Record<string, unknown>>(
525
559
  /**
@@ -541,6 +575,8 @@ declare namespace sap {
541
575
  ): Function;
542
576
  /**
543
577
  * Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.
578
+ *
579
+ * @returns Metadata object describing this class
544
580
  */
545
581
  static getMetadata(): sap.ui.core.ElementMetadata;
546
582
  /**
@@ -549,6 +585,8 @@ declare namespace sap {
549
585
  * The highlight color to use for the scene node being hovered over.
550
586
  *
551
587
  * Default value is `"rgba(0, 0, 255, 0.7)"`.
588
+ *
589
+ * @returns Value of property `highlightColor`
552
590
  */
553
591
  getHighlightColor(): sap.ui.core.CSSColor;
554
592
  /**
@@ -559,6 +597,8 @@ declare namespace sap {
559
597
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
560
598
  *
561
599
  * Default value is `"rgba(0, 0, 255, 0.7)"`.
600
+ *
601
+ * @returns Reference to `this` in order to allow method chaining
562
602
  */
563
603
  setHighlightColor(
564
604
  /**
@@ -600,6 +640,8 @@ declare namespace sap {
600
640
  * and enriches it with the information contained in `oClassInfo`.
601
641
  *
602
642
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
643
+ *
644
+ * @returns Created class / constructor function
603
645
  */
604
646
  static extend<T extends Record<string, unknown>>(
605
647
  /**
@@ -621,6 +663,8 @@ declare namespace sap {
621
663
  ): Function;
622
664
  /**
623
665
  * Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.
666
+ *
667
+ * @returns Metadata object describing this class
624
668
  */
625
669
  static getMetadata(): sap.ui.core.ElementMetadata;
626
670
  /**
@@ -638,6 +682,8 @@ declare namespace sap {
638
682
  * }
639
683
  * ```
640
684
  * If function returns null no tooltip will be displayed.
685
+ *
686
+ * @returns Value of property `tooltipCallback`
641
687
  */
642
688
  getTooltipCallback(): any;
643
689
  /**
@@ -657,6 +703,8 @@ declare namespace sap {
657
703
  * If function returns null no tooltip will be displayed.
658
704
  *
659
705
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
706
+ *
707
+ * @returns Reference to `this` in order to allow method chaining
660
708
  */
661
709
  setTooltipCallback(
662
710
  /**
@@ -699,6 +747,8 @@ declare namespace sap {
699
747
  * and enriches it with the information contained in `oClassInfo`.
700
748
  *
701
749
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
750
+ *
751
+ * @returns Created class / constructor function
702
752
  */
703
753
  static extend<T extends Record<string, unknown>>(
704
754
  /**
@@ -720,6 +770,8 @@ declare namespace sap {
720
770
  ): Function;
721
771
  /**
722
772
  * Returns a metadata object for class sap.ui.vtm.extensions.SelectionLinkingExtension.
773
+ *
774
+ * @returns Metadata object describing this class
723
775
  */
724
776
  static getMetadata(): sap.ui.core.ElementMetadata;
725
777
  /**
@@ -732,6 +784,8 @@ declare namespace sap {
732
784
  * against.
733
785
  * The third parameter is the {@link sap.ui.vtm.Tree} to search for matches in.
734
786
  * The function returns an array of tree items that match the specified tree item.
787
+ *
788
+ * @returns Value of property `findMatchingTreeItems`
735
789
  */
736
790
  getFindMatchingTreeItems(): any;
737
791
  /**
@@ -746,6 +800,8 @@ declare namespace sap {
746
800
  * The function returns an array of tree items that match the specified tree item.
747
801
  *
748
802
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
803
+ *
804
+ * @returns Reference to `this` in order to allow method chaining
749
805
  */
750
806
  setFindMatchingTreeItems(
751
807
  /**
@@ -774,6 +830,8 @@ declare namespace sap {
774
830
  * enriches it with the information contained in `oClassInfo`.
775
831
  *
776
832
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
833
+ *
834
+ * @returns Created class / constructor function
777
835
  */
778
836
  static extend<T extends Record<string, unknown>>(
779
837
  /**
@@ -795,6 +853,8 @@ declare namespace sap {
795
853
  ): Function;
796
854
  /**
797
855
  * Returns a metadata object for class sap.ui.vtm.extensions.ViewLinkingExtension.
856
+ *
857
+ * @returns Metadata object describing this class
798
858
  */
799
859
  static getMetadata(): sap.ui.core.ElementMetadata;
800
860
  }
@@ -828,6 +888,8 @@ declare namespace sap {
828
888
  * and enriches it with the information contained in `oClassInfo`.
829
889
  *
830
890
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
891
+ *
892
+ * @returns Created class / constructor function
831
893
  */
832
894
  static extend<T extends Record<string, unknown>>(
833
895
  /**
@@ -849,6 +911,8 @@ declare namespace sap {
849
911
  ): Function;
850
912
  /**
851
913
  * Returns a metadata object for class sap.ui.vtm.extensions.ViewportSelectionLinkingExtension.
914
+ *
915
+ * @returns Metadata object describing this class
852
916
  */
853
917
  static getMetadata(): sap.ui.core.ElementMetadata;
854
918
  }
@@ -885,6 +949,8 @@ declare namespace sap {
885
949
  * and enriches it with the information contained in `oClassInfo`.
886
950
  *
887
951
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
952
+ *
953
+ * @returns Created class / constructor function
888
954
  */
889
955
  static extend<T extends Record<string, unknown>>(
890
956
  /**
@@ -906,6 +972,8 @@ declare namespace sap {
906
972
  ): Function;
907
973
  /**
908
974
  * Returns a metadata object for class sap.ui.vtm.extensions.VisibilityIconClickExtension.
975
+ *
976
+ * @returns Metadata object describing this class
909
977
  */
910
978
  static getMetadata(): sap.ui.core.ElementMetadata;
911
979
  }
@@ -1071,7 +1139,8 @@ declare namespace sap {
1071
1139
  */
1072
1140
  type?:
1073
1141
  | sap.ui.vtm.ColumnType
1074
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1142
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1143
+ | `{${string}}`;
1075
1144
 
1076
1145
  /**
1077
1146
  * The descriptor is a JSON string identifying the column.
@@ -1100,19 +1169,24 @@ declare namespace sap {
1100
1169
  */
1101
1170
  hAlign?:
1102
1171
  | sap.ui.core.HorizontalAlign
1103
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1172
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1173
+ | `{${string}}`;
1104
1174
 
1105
1175
  /**
1106
1176
  * The width of the tree column.
1107
1177
  */
1108
1178
  width?:
1109
1179
  | sap.ui.core.CSSSize
1110
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1180
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1181
+ | `{${string}}`;
1111
1182
 
1112
1183
  /**
1113
1184
  * If set to true, the column can be resized.
1114
1185
  */
1115
- resizable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1186
+ resizable?:
1187
+ | boolean
1188
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1189
+ | `{${string}}`;
1116
1190
 
1117
1191
  /**
1118
1192
  * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so
@@ -1125,7 +1199,10 @@ declare namespace sap {
1125
1199
  * to the `label` property as the column header content. However the `label` property should also be specified
1126
1200
  * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}.
1127
1201
  */
1128
- labelControl?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1202
+ labelControl?:
1203
+ | object
1204
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1205
+ | `{${string}}`;
1129
1206
 
1130
1207
  /**
1131
1208
  * If defined, this is a function that specifies the formatting of cell content text for this column.
@@ -1134,7 +1211,10 @@ declare namespace sap {
1134
1211
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
1135
1212
  * table row.
1136
1213
  */
1137
- valueFormatter?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
1214
+ valueFormatter?:
1215
+ | any
1216
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1217
+ | `{${string}}`;
1138
1218
 
1139
1219
  /**
1140
1220
  * If defined, this is a function that specifies the formatting of cell content tooltips for this column
@@ -1145,7 +1225,10 @@ declare namespace sap {
1145
1225
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
1146
1226
  * table row.
1147
1227
  */
1148
- tooltipFormatter?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
1228
+ tooltipFormatter?:
1229
+ | any
1230
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1231
+ | `{${string}}`;
1149
1232
 
1150
1233
  /**
1151
1234
  * If defined, overrides the cell template for the column.
@@ -1153,7 +1236,8 @@ declare namespace sap {
1153
1236
  */
1154
1237
  template?:
1155
1238
  | sap.ui.core.Control
1156
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1239
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1240
+ | `{${string}}`;
1157
1241
  }
1158
1242
 
1159
1243
  interface $DisplayGroupSettings extends sap.ui.core.$ElementSettings {
@@ -1180,14 +1264,18 @@ declare namespace sap {
1180
1264
  */
1181
1265
  displayStatesBySceneNodeId?:
1182
1266
  | object
1183
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1267
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1268
+ | `{${string}}`;
1184
1269
  }
1185
1270
 
1186
1271
  interface $ExtensionSettings extends sap.ui.core.$ElementSettings {
1187
1272
  /**
1188
1273
  * Controls whether the extension is enabled.
1189
1274
  */
1190
- enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1275
+ enabled?:
1276
+ | boolean
1277
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1278
+ | `{${string}}`;
1191
1279
 
1192
1280
  /**
1193
1281
  * Fired when the enabled property is changed.
@@ -1211,14 +1299,18 @@ declare namespace sap {
1211
1299
  * - `text`
1212
1300
  * - `icon`
1213
1301
  */
1214
- messages?: object[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
1302
+ messages?:
1303
+ | object[]
1304
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1305
+ | `{${string}}`;
1215
1306
 
1216
1307
  /**
1217
1308
  * Maximum height of status window.
1218
1309
  */
1219
1310
  maxHeight?:
1220
1311
  | sap.ui.core.CSSSize
1221
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1312
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1313
+ | `{${string}}`;
1222
1314
  }
1223
1315
 
1224
1316
  interface $PanelSettings extends sap.ui.core.$ControlSettings {
@@ -1230,21 +1322,26 @@ declare namespace sap {
1230
1322
  /**
1231
1323
  * Controls whether the viewport will be shown for this panel.
1232
1324
  */
1233
- showViewport?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1325
+ showViewport?:
1326
+ | boolean
1327
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1328
+ | `{${string}}`;
1234
1329
 
1235
1330
  /**
1236
1331
  * The width of the tree.
1237
1332
  */
1238
1333
  treeWidth?:
1239
1334
  | sap.ui.core.CSSSize
1240
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1335
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1336
+ | `{${string}}`;
1241
1337
 
1242
1338
  /**
1243
1339
  * The height of the panel.
1244
1340
  */
1245
1341
  height?:
1246
1342
  | sap.ui.core.CSSSize
1247
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1343
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1344
+ | `{${string}}`;
1248
1345
 
1249
1346
  /**
1250
1347
  * The set of controls to render in the title bar area.
@@ -1252,7 +1349,8 @@ declare namespace sap {
1252
1349
  titleControls?:
1253
1350
  | sap.ui.core.Control[]
1254
1351
  | sap.ui.core.Control
1255
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1352
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1353
+ | `{${string}}`;
1256
1354
 
1257
1355
  /**
1258
1356
  * The set of controls to render in the tree header area.
@@ -1260,7 +1358,8 @@ declare namespace sap {
1260
1358
  treeHeaderControls?:
1261
1359
  | sap.ui.core.Control[]
1262
1360
  | sap.ui.core.Control
1263
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1361
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1362
+ | `{${string}}`;
1264
1363
 
1265
1364
  /**
1266
1365
  * The set of controls to render in the viewport header area.
@@ -1268,7 +1367,8 @@ declare namespace sap {
1268
1367
  viewportHeaderControls?:
1269
1368
  | sap.ui.core.Control[]
1270
1369
  | sap.ui.core.Control
1271
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1370
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1371
+ | `{${string}}`;
1272
1372
 
1273
1373
  /**
1274
1374
  * The {@link sap.ui.vtm.Vtm} instance this panel is associated with.
@@ -1296,14 +1396,18 @@ declare namespace sap {
1296
1396
  /**
1297
1397
  * The percentage (0-100) to show in the progress bar (if visible).
1298
1398
  */
1299
- percentComplete?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1399
+ percentComplete?:
1400
+ | int
1401
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1402
+ | `{${string}}`;
1300
1403
 
1301
1404
  /**
1302
1405
  * Whether the progress bar is visible.
1303
1406
  */
1304
1407
  progressBarVisible?:
1305
1408
  | boolean
1306
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1409
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1410
+ | `{${string}}`;
1307
1411
  }
1308
1412
 
1309
1413
  interface $SceneSettings extends sap.ui.core.$ElementSettings {
@@ -1361,7 +1465,10 @@ declare namespace sap {
1361
1465
  /**
1362
1466
  * The {@link sap.ui.vtm.Scene} for the scene node.
1363
1467
  */
1364
- scene?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1468
+ scene?:
1469
+ | object
1470
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1471
+ | `{${string}}`;
1365
1472
  }
1366
1473
 
1367
1474
  interface $SelectColumnsDialogSettings
@@ -1369,14 +1476,18 @@ declare namespace sap {
1369
1476
  /**
1370
1477
  * The {@link sap.ui.vtm.Tree} that column selection is being performed for.
1371
1478
  */
1372
- tree?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1479
+ tree?:
1480
+ | object
1481
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1482
+ | `{${string}}`;
1373
1483
 
1374
1484
  /**
1375
1485
  * The set of columns that should be shown in the dialog that may be selected for display.
1376
1486
  */
1377
1487
  selectableColumns?:
1378
1488
  | sap.ui.vtm.Column[]
1379
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1489
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1490
+ | `{${string}}`;
1380
1491
  }
1381
1492
 
1382
1493
  interface $TreeSettings extends sap.ui.core.$ControlSettings {
@@ -1385,7 +1496,8 @@ declare namespace sap {
1385
1496
  */
1386
1497
  selectionMode?:
1387
1498
  | sap.ui.vtm.SelectionMode
1388
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1499
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1500
+ | `{${string}}`;
1389
1501
 
1390
1502
  /**
1391
1503
  * A set of controls such as toolbars to show above the tree.
@@ -1393,7 +1505,8 @@ declare namespace sap {
1393
1505
  headerControls?:
1394
1506
  | sap.ui.core.Control[]
1395
1507
  | sap.ui.core.Control
1396
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1508
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1509
+ | `{${string}}`;
1397
1510
 
1398
1511
  /**
1399
1512
  * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault()
@@ -1473,7 +1586,10 @@ declare namespace sap {
1473
1586
  /**
1474
1587
  * The source URL (string) or File for this Viewable.
1475
1588
  */
1476
- source?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
1589
+ source?:
1590
+ | any
1591
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1592
+ | `{${string}}`;
1477
1593
 
1478
1594
  /**
1479
1595
  * The name for this Viewable.
@@ -1483,7 +1599,10 @@ declare namespace sap {
1483
1599
  /**
1484
1600
  * The root scene node IDs for this viewable.
1485
1601
  */
1486
- rootNodeIds?: string[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
1602
+ rootNodeIds?:
1603
+ | string[]
1604
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1605
+ | `{${string}}`;
1487
1606
 
1488
1607
  /**
1489
1608
  * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded
@@ -1491,14 +1610,18 @@ declare namespace sap {
1491
1610
  */
1492
1611
  relativeMatrix?:
1493
1612
  | sap.ui.vtm.Matrix
1494
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1613
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1614
+ | `{${string}}`;
1495
1615
  }
1496
1616
 
1497
1617
  interface $ViewableLoadInfoSettings extends sap.ui.core.$ElementSettings {
1498
1618
  /**
1499
1619
  * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to.
1500
1620
  */
1501
- viewable?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1621
+ viewable?:
1622
+ | object
1623
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1624
+ | `{${string}}`;
1502
1625
 
1503
1626
  /**
1504
1627
  * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo}
@@ -1506,7 +1629,8 @@ declare namespace sap {
1506
1629
  */
1507
1630
  status?:
1508
1631
  | sap.ui.vtm.ViewableLoadStatus
1509
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1632
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1633
+ | `{${string}}`;
1510
1634
 
1511
1635
  /**
1512
1636
  * The error code describing why the Viewable failed to load.
@@ -1528,14 +1652,16 @@ declare namespace sap {
1528
1652
  */
1529
1653
  backgroundGradientTopColor?:
1530
1654
  | sap.ui.core.CSSColor
1531
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1655
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1656
+ | `{${string}}`;
1532
1657
 
1533
1658
  /**
1534
1659
  * The background gradient bottom color
1535
1660
  */
1536
1661
  backgroundGradientBottomColor?:
1537
1662
  | sap.ui.core.CSSColor
1538
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1663
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1664
+ | `{${string}}`;
1539
1665
 
1540
1666
  /**
1541
1667
  * Allows the calculated display state of scene nodes in the viewport o be overridden.
@@ -1548,7 +1674,8 @@ declare namespace sap {
1548
1674
  */
1549
1675
  overrideDisplayGroups?:
1550
1676
  | object[]
1551
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1677
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1678
+ | `{${string}}`;
1552
1679
 
1553
1680
  /**
1554
1681
  * Allows the calculated display state for scene nodes whose display state is not determined by tree item
@@ -1560,7 +1687,8 @@ declare namespace sap {
1560
1687
  */
1561
1688
  contextDisplayGroups?:
1562
1689
  | object[]
1563
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1690
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1691
+ | `{${string}}`;
1564
1692
 
1565
1693
  /**
1566
1694
  * A set of controls such as toolbars to appear above the 3D viewport.
@@ -1615,7 +1743,8 @@ declare namespace sap {
1615
1743
  */
1616
1744
  addDefaultExtensions?:
1617
1745
  | boolean
1618
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1746
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1747
+ | `{${string}}`;
1619
1748
 
1620
1749
  /**
1621
1750
  * The set of VTM extensions. Extensions are used to provide extensibility. Default behaviors are implemented
@@ -1624,7 +1753,8 @@ declare namespace sap {
1624
1753
  extensions?:
1625
1754
  | sap.ui.vtm.Extension[]
1626
1755
  | sap.ui.vtm.Extension
1627
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1756
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1757
+ | `{${string}}`;
1628
1758
 
1629
1759
  /**
1630
1760
  * Raised when a panel has been added.
@@ -1654,6 +1784,8 @@ declare namespace sap {
1654
1784
  interface ArrayUtilities {
1655
1785
  /**
1656
1786
  * Returns `true` if a group of arrays are equal.
1787
+ *
1788
+ * @returns `true` if the all the arrays are equal.
1657
1789
  */
1658
1790
  areEqual(
1659
1791
  /**
@@ -1668,6 +1800,8 @@ declare namespace sap {
1668
1800
  ): boolean;
1669
1801
  /**
1670
1802
  * Creates a copy of an array in which the items are cloned.
1803
+ *
1804
+ * @returns The cloned array
1671
1805
  */
1672
1806
  deepClone(
1673
1807
  /**
@@ -1683,6 +1817,8 @@ declare namespace sap {
1683
1817
  /**
1684
1818
  * Returns the first item in an array that matches the supplied predicate or returns undefined if no match
1685
1819
  * is found.
1820
+ *
1821
+ * @returns The matching item or undefined if no match was found.
1686
1822
  */
1687
1823
  find(
1688
1824
  /**
@@ -1698,6 +1834,8 @@ declare namespace sap {
1698
1834
  /**
1699
1835
  * Returns the index of the first item in an array that matches the supplied predicate or returns -1 if
1700
1836
  * no match is found.
1837
+ *
1838
+ * @returns The index of the matching item or -1 if no match was found.
1701
1839
  */
1702
1840
  findIndex(
1703
1841
  /**
@@ -1712,6 +1850,8 @@ declare namespace sap {
1712
1850
  ): number;
1713
1851
  /**
1714
1852
  * Flattens an array of arrays down to an array.
1853
+ *
1854
+ * @returns A flattened array.
1715
1855
  */
1716
1856
  flatten(
1717
1857
  /**
@@ -1721,6 +1861,8 @@ declare namespace sap {
1721
1861
  ): any[];
1722
1862
  /**
1723
1863
  * Converts from an array-like object (an object that supports indexing and has a length) to an array.
1864
+ *
1865
+ * @returns The array containing the same values as the array-like object.
1724
1866
  */
1725
1867
  fromArrayLike(
1726
1868
  /**
@@ -1730,6 +1872,8 @@ declare namespace sap {
1730
1872
  ): any[];
1731
1873
  /**
1732
1874
  * Converts an ES6 Set to an array.
1875
+ *
1876
+ * @returns The array containing the same set of unique items as the Set.
1733
1877
  */
1734
1878
  fromSet(
1735
1879
  /**
@@ -1739,6 +1883,8 @@ declare namespace sap {
1739
1883
  ): any[];
1740
1884
  /**
1741
1885
  * Returns whether a group of arrays have a non empty set intersection.
1886
+ *
1887
+ * @returns Whether the arrays have a non empty set intersection.
1742
1888
  */
1743
1889
  haveIntersection(
1744
1890
  /**
@@ -1753,6 +1899,8 @@ declare namespace sap {
1753
1899
  ): boolean;
1754
1900
  /**
1755
1901
  * Returns the set intersection of a group of arrays.
1902
+ *
1903
+ * @returns The set intersection of the arrays.
1756
1904
  */
1757
1905
  intersect(
1758
1906
  /**
@@ -1767,6 +1915,8 @@ declare namespace sap {
1767
1915
  ): any[];
1768
1916
  /**
1769
1917
  * Creates a copy of an array in which the items are copied by reference rather than being cloned.
1918
+ *
1919
+ * @returns The cloned array
1770
1920
  */
1771
1921
  shallowClone(
1772
1922
  /**
@@ -1776,6 +1926,8 @@ declare namespace sap {
1776
1926
  ): any[];
1777
1927
  /**
1778
1928
  * Converts an array to an ES6 Set.
1929
+ *
1930
+ * @returns The Set containing the same set of unique items as the array.
1779
1931
  */
1780
1932
  toSet(
1781
1933
  /**
@@ -1785,6 +1937,8 @@ declare namespace sap {
1785
1937
  ): Set<any>;
1786
1938
  /**
1787
1939
  * Returns the set union (as an array) of a group of arrays.
1940
+ *
1941
+ * @returns The set union of the arrays.
1788
1942
  */
1789
1943
  union(
1790
1944
  /**
@@ -1805,6 +1959,8 @@ declare namespace sap {
1805
1959
  * - If the parameter is an array of length 0, `undefined` is returned.
1806
1960
  * - If the parameter is an array of length 1, the first element of the array is returned.
1807
1961
  * - Otherwise if the parameter is an array of length > 1, the parameter is returned (as an array).
1962
+ *
1963
+ * @returns The unwrapped value.
1808
1964
  */
1809
1965
  unwrap(
1810
1966
  /**
@@ -1819,6 +1975,9 @@ declare namespace sap {
1819
1975
  * - If the parameter is an array, the parameter is returned.
1820
1976
  * - If the parameter is `undefined` an empty array is returned.
1821
1977
  * - Otherwise a single element array containing the parameter value is returned.
1978
+ *
1979
+ * @returns The parameter if it is an array, otherwise returns a single element array containing the parameter
1980
+ * value
1822
1981
  */
1823
1982
  wrap(
1824
1983
  /**
@@ -1837,6 +1996,8 @@ declare namespace sap {
1837
1996
  interface DescriptorUtilities {
1838
1997
  /**
1839
1998
  * Creates a descriptor for an identifier.
1999
+ *
2000
+ * @returns The descriptor representing the identifier.
1840
2001
  */
1841
2002
  createIdentifierDescriptor(
1842
2003
  /**
@@ -1850,6 +2011,8 @@ declare namespace sap {
1850
2011
  ): string;
1851
2012
  /**
1852
2013
  * Creates a descriptor for a metadata field.
2014
+ *
2015
+ * @returns The descriptor representing the metadata field.
1853
2016
  */
1854
2017
  createMetadataDescriptor(
1855
2018
  /**
@@ -1872,6 +2035,8 @@ declare namespace sap {
1872
2035
  interface HashUtilities {
1873
2036
  /**
1874
2037
  * Creates a single hash code from a set of hash code values and normalizes it using {@link sap.ui.vtm.HashUtilities.normalizeHash}.
2038
+ *
2039
+ * @returns The combined hash code.
1875
2040
  */
1876
2041
  combineHashes(
1877
2042
  /**
@@ -1888,6 +2053,8 @@ declare namespace sap {
1888
2053
  *
1889
2054
  * The resulting hash value can be any integer value. Use {@link sap.ui.vtm.HashUtilities.normalizeHash}
1890
2055
  * on the result to create a hash code that is useful as a key in a {@link sap.ui.vtm.Lookup}.
2056
+ *
2057
+ * @returns The hash code for the specified transformation matrix.
1891
2058
  */
1892
2059
  hashMatrix(
1893
2060
  /**
@@ -1900,6 +2067,8 @@ declare namespace sap {
1900
2067
  *
1901
2068
  * The resulting hash value can be any integer value. Use {@link sap.ui.vtm.HashUtilities.normalizeHash}
1902
2069
  * on the result to create a hash code that is useful as a key in a {@link sap.ui.vtm.Lookup}.
2070
+ *
2071
+ * @returns The hash code value for the string.
1903
2072
  */
1904
2073
  hashString(
1905
2074
  /**
@@ -1910,6 +2079,8 @@ declare namespace sap {
1910
2079
  /**
1911
2080
  * Normalizes a hash code to a range between 0 and an upper bound. Useful for creating a hash code that
1912
2081
  * can be used as a key in a {@link sap.ui.vtm.Lookup} (to limit the number of buckets in the lookup).
2082
+ *
2083
+ * @returns The normalized hash code.
1913
2084
  */
1914
2085
  normalizeHash(
1915
2086
  /**
@@ -1932,34 +2103,50 @@ declare namespace sap {
1932
2103
  interface InternalColumns {
1933
2104
  /**
1934
2105
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.AbsoluteMatrix} column.
2106
+ *
2107
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.AbsoluteMatrix} column.
1935
2108
  */
1936
2109
  createAbsoluteMatrixColumn(): sap.ui.vtm.Column;
1937
2110
  /**
1938
2111
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus} internal column.
2112
+ *
2113
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus} internal column.
1939
2114
  */
1940
2115
  createMessageStatusColumn(): sap.ui.vtm.Column;
1941
2116
  /**
1942
2117
  * Creates an {@link sap.ui.vtm.InternalColumnDescriptor.Opacity} column.
2118
+ *
2119
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Opacity} column.
1943
2120
  */
1944
2121
  createOpacityColumn(): sap.ui.vtm.Column;
1945
2122
  /**
1946
2123
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.RelativeMatrix} column.
2124
+ *
2125
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.RelativeMatrix} column.
1947
2126
  */
1948
2127
  createRelativeMatrixColumn(): sap.ui.vtm.Column;
1949
2128
  /**
1950
2129
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.SceneNodeIds} column.
2130
+ *
2131
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.SceneNodeIds} column.
1951
2132
  */
1952
2133
  createSceneNodeIdsColumn(): sap.ui.vtm.Column;
1953
2134
  /**
1954
2135
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.Tree} internal column.
2136
+ *
2137
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Tree} internal column.
1955
2138
  */
1956
2139
  createTreeColumn(): sap.ui.vtm.Column;
1957
2140
  /**
1958
2141
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.TreeItemId} column.
2142
+ *
2143
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.TreeItemId} column.
1959
2144
  */
1960
2145
  createTreeItemIdColumn(): sap.ui.vtm.Column;
1961
2146
  /**
1962
2147
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} internal column.
2148
+ *
2149
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} internal column.
1963
2150
  */
1964
2151
  createVisibilityColumn(): sap.ui.vtm.Column;
1965
2152
  }
@@ -1974,6 +2161,8 @@ declare namespace sap {
1974
2161
  interface MatrixUtilities {
1975
2162
  /**
1976
2163
  * Returns true when the two matrix parameters are equal.
2164
+ *
2165
+ * @returns `true` if the two matrix parameters are equal.
1977
2166
  */
1978
2167
  areEqual(
1979
2168
  /**
@@ -1987,10 +2176,14 @@ declare namespace sap {
1987
2176
  ): boolean;
1988
2177
  /**
1989
2178
  * Returns an identity transformation matrix.
2179
+ *
2180
+ * @returns A new identity transformation matrix.
1990
2181
  */
1991
2182
  createIdentity(): sap.ui.vtm.Matrix;
1992
2183
  /**
1993
2184
  * Converts a 4x4 transformation matrix to a {@link sap.ui.vtm.Matrix}.
2185
+ *
2186
+ * @returns The {@link sap.ui.vtm.Matrix} value.
1994
2187
  */
1995
2188
  from4x4Matrix(
1996
2189
  /**
@@ -2001,6 +2194,8 @@ declare namespace sap {
2001
2194
  /**
2002
2195
  * Converts a {@link sap.ui.vk.TransformationMatrix} (as used by the sap.ui.vk library) to a {@link sap.ui.vtm.Matrix}
2003
2196
  * value.
2197
+ *
2198
+ * @returns The {@link sap.ui.vtm.Matrix} value.
2004
2199
  */
2005
2200
  fromVkMatrix(
2006
2201
  /**
@@ -2010,6 +2205,8 @@ declare namespace sap {
2010
2205
  ): sap.ui.vtm.Matrix;
2011
2206
  /**
2012
2207
  * Converts a VSM transformation matrix string to a {@link sap.ui.vtm.Matrix} value.
2208
+ *
2209
+ * @returns The {@link sap.ui.vtm.Matrix} value.
2013
2210
  */
2014
2211
  fromVsmMatrixString(
2015
2212
  /**
@@ -2019,6 +2216,8 @@ declare namespace sap {
2019
2216
  ): sap.ui.vtm.Matrix;
2020
2217
  /**
2021
2218
  * Returns the inverse of the passed matrix without modifying the passed matrix.
2219
+ *
2220
+ * @returns The inverse of the specified matrix.
2022
2221
  */
2023
2222
  invert(
2024
2223
  /**
@@ -2028,6 +2227,8 @@ declare namespace sap {
2028
2227
  ): sap.ui.vtm.Matrix;
2029
2228
  /**
2030
2229
  * Returns whether a matrix is invertible.
2230
+ *
2231
+ * @returns Whether the matrix is invertible.
2031
2232
  */
2032
2233
  isInvertible(
2033
2234
  /**
@@ -2037,6 +2238,8 @@ declare namespace sap {
2037
2238
  ): boolean;
2038
2239
  /**
2039
2240
  * Returns true if the parameter represents a valid transformation matrix.
2241
+ *
2242
+ * @returns true if the parameter represents a valid transformation matrix.
2040
2243
  */
2041
2244
  isValid(
2042
2245
  /**
@@ -2052,6 +2255,8 @@ declare namespace sap {
2052
2255
  ): boolean;
2053
2256
  /**
2054
2257
  * Returns the result of multiplying two matrices (without modifying the passed matrices).
2258
+ *
2259
+ * @returns The matrix representing the multiplication result.
2055
2260
  */
2056
2261
  multiply(
2057
2262
  /**
@@ -2065,6 +2270,8 @@ declare namespace sap {
2065
2270
  ): sap.ui.vtm.Matrix;
2066
2271
  /**
2067
2272
  * Converts a {@link sap.ui.vtm.Matrix} to a 4x4 transformation matrix.
2273
+ *
2274
+ * @returns A 4x4 transformation matrix (represented as an array of arrays of numbers).
2068
2275
  */
2069
2276
  to4x4Matrix(
2070
2277
  /**
@@ -2075,6 +2282,8 @@ declare namespace sap {
2075
2282
  /**
2076
2283
  * Converts a {@link sap.ui.vtm.Matrix} value to a {@link sap.ui.vk.TransformationMatrix} as used by the
2077
2284
  * sap.ui.vk library.
2285
+ *
2286
+ * @returns The {@link sap.ui.vk.TransformationMatrix} value.
2078
2287
  */
2079
2288
  toVkMatrix(
2080
2289
  /**
@@ -2084,6 +2293,8 @@ declare namespace sap {
2084
2293
  ): sap.ui.vk.TransformationMatrix;
2085
2294
  /**
2086
2295
  * Converts a {@link sap.ui.vtm.Matrix} value to a VSM transformation matrix string.
2296
+ *
2297
+ * @returns The VSM transformation matrix string.
2087
2298
  */
2088
2299
  toVsmMatrixString(
2089
2300
  /**
@@ -2168,6 +2379,8 @@ declare namespace sap {
2168
2379
  /**
2169
2380
  * Calculates the absolute matrix that should be applied to a tree item given its relative matrix and the
2170
2381
  * absolute matrix of its parent.
2382
+ *
2383
+ * @returns The calculated absolute matrix.
2171
2384
  */
2172
2385
  calculateAbsoluteMatrix(
2173
2386
  /**
@@ -2182,6 +2395,8 @@ declare namespace sap {
2182
2395
  /**
2183
2396
  * Calculates the relative matrix that should be applied to a tree item given its absolute matrix and the
2184
2397
  * absolute matrix of its parent.
2398
+ *
2399
+ * @returns The calculated relative matrix.
2185
2400
  */
2186
2401
  calculateRelativeMatrix(
2187
2402
  /**
@@ -2195,6 +2410,8 @@ declare namespace sap {
2195
2410
  ): sap.ui.vtm.Matrix;
2196
2411
  /**
2197
2412
  * Returns a cloned copy of the appData on the passed tree item.
2413
+ *
2414
+ * @returns A cloned copy of the appData on the passed tree item.
2198
2415
  */
2199
2416
  cloneAppData(
2200
2417
  /**
@@ -2204,6 +2421,8 @@ declare namespace sap {
2204
2421
  ): object;
2205
2422
  /**
2206
2423
  * Returns a cloned copy of the identifiers on the passed tree item.
2424
+ *
2425
+ * @returns A cloned copy of the metadata on the passed tree item.
2207
2426
  */
2208
2427
  cloneIdentifiers(
2209
2428
  /**
@@ -2213,6 +2432,8 @@ declare namespace sap {
2213
2432
  ): object;
2214
2433
  /**
2215
2434
  * Returns a cloned copy of the metadata on the passed tree item.
2435
+ *
2436
+ * @returns A cloned copy of the metadata on the passed tree item.
2216
2437
  */
2217
2438
  cloneMetadata(
2218
2439
  /**
@@ -2237,6 +2458,8 @@ declare namespace sap {
2237
2458
  ): void;
2238
2459
  /**
2239
2460
  * Gets the application data field descriptors for a given tree item.
2461
+ *
2462
+ * @returns The application data field descriptors for the given tree item.
2240
2463
  */
2241
2464
  getAppDataDescriptors(
2242
2465
  /**
@@ -2246,6 +2469,8 @@ declare namespace sap {
2246
2469
  ): string[];
2247
2470
  /**
2248
2471
  * Gets the application data values associated with a particular descriptor for a tree item.
2472
+ *
2473
+ * @returns The application data values.
2249
2474
  */
2250
2475
  getAppDataValues(
2251
2476
  /**
@@ -2259,6 +2484,8 @@ declare namespace sap {
2259
2484
  ): string[] | number[] | boolean[] | object[];
2260
2485
  /**
2261
2486
  * Gets the children of a tree item from the `includedChildren` and/or `excludedChildren` collections.
2487
+ *
2488
+ * @returns The children of the tree item of the given type.
2262
2489
  */
2263
2490
  getChildren(
2264
2491
  /**
@@ -2279,6 +2506,8 @@ declare namespace sap {
2279
2506
  ): object[];
2280
2507
  /**
2281
2508
  * Gets the excluded children of a tree item.
2509
+ *
2510
+ * @returns The excluded children of the tree item.
2282
2511
  */
2283
2512
  getExcludedChildren(
2284
2513
  /**
@@ -2288,6 +2517,8 @@ declare namespace sap {
2288
2517
  ): object[];
2289
2518
  /**
2290
2519
  * Gets the identifier descriptors for a given tree item.
2520
+ *
2521
+ * @returns The identifier descriptors for the given tree item.
2291
2522
  */
2292
2523
  getIdentifierDescriptors(
2293
2524
  /**
@@ -2297,6 +2528,8 @@ declare namespace sap {
2297
2528
  ): string[];
2298
2529
  /**
2299
2530
  * Gets the identifier values associated with a particular descriptor for a tree item.
2531
+ *
2532
+ * @returns The identifier values.
2300
2533
  */
2301
2534
  getIdentifierValues(
2302
2535
  /**
@@ -2310,6 +2543,8 @@ declare namespace sap {
2310
2543
  ): string[];
2311
2544
  /**
2312
2545
  * Gets the included children of a tree item.
2546
+ *
2547
+ * @returns The included children of the tree item.
2313
2548
  */
2314
2549
  getIncludedChildren(
2315
2550
  /**
@@ -2319,6 +2554,8 @@ declare namespace sap {
2319
2554
  ): object[];
2320
2555
  /**
2321
2556
  * Gets the messages stored on a tree item.
2557
+ *
2558
+ * @returns The tree item messages.
2322
2559
  */
2323
2560
  getMessages(
2324
2561
  /**
@@ -2328,6 +2565,8 @@ declare namespace sap {
2328
2565
  ): sap.ui.core.Message[];
2329
2566
  /**
2330
2567
  * Gets the metadata field descriptors for a given tree item.
2568
+ *
2569
+ * @returns The metadata field descriptors for the given tree item.
2331
2570
  */
2332
2571
  getMetadataDescriptors(
2333
2572
  /**
@@ -2337,6 +2576,8 @@ declare namespace sap {
2337
2576
  ): string[];
2338
2577
  /**
2339
2578
  * Gets the metadata values associated with a particular descriptor for a tree item.
2579
+ *
2580
+ * @returns The metadata values.
2340
2581
  */
2341
2582
  getMetadataValues(
2342
2583
  /**
@@ -2350,6 +2591,8 @@ declare namespace sap {
2350
2591
  ): string[] | number[] | boolean[] | object[];
2351
2592
  /**
2352
2593
  * Gets the IDs of the scene nodes associated with a tree item as an array of strings.
2594
+ *
2595
+ * @returns The scene node IDs for the tree item.
2353
2596
  */
2354
2597
  getSceneNodeIds(
2355
2598
  /**
@@ -2359,6 +2602,8 @@ declare namespace sap {
2359
2602
  ): string[];
2360
2603
  /**
2361
2604
  * Gets whether a tree item has items in the `includedChildren` and/or `excludedChildren` collections.
2605
+ *
2606
+ * @returns Whether the tree item has children of the given type.
2362
2607
  */
2363
2608
  hasChildren(
2364
2609
  /**
@@ -2380,6 +2625,8 @@ declare namespace sap {
2380
2625
  ): boolean;
2381
2626
  /**
2382
2627
  * Gets whether a tree item has excluded children.
2628
+ *
2629
+ * @returns The excluded children of the tree item.
2383
2630
  */
2384
2631
  hasExcludedChildren(
2385
2632
  /**
@@ -2389,6 +2636,8 @@ declare namespace sap {
2389
2636
  ): object[];
2390
2637
  /**
2391
2638
  * Gets whether a tree item has included children.
2639
+ *
2640
+ * @returns The included children of the tree item.
2392
2641
  */
2393
2642
  hasIncludedChildren(
2394
2643
  /**
@@ -2398,6 +2647,8 @@ declare namespace sap {
2398
2647
  ): object[];
2399
2648
  /**
2400
2649
  * Returns whether the tree item has a `visibility` value.
2650
+ *
2651
+ * @returns Whether the tree item has a `visibility` value.
2401
2652
  */
2402
2653
  hasVisibility(
2403
2654
  /**
@@ -2422,6 +2673,8 @@ declare namespace sap {
2422
2673
  ): void;
2423
2674
  /**
2424
2675
  * Applies a mapping function to each tree item in a branch of a tree to create a new tree branch.
2676
+ *
2677
+ * @returns The mapped tree branch.
2425
2678
  */
2426
2679
  mapBranch(
2427
2680
  /**
@@ -2435,6 +2688,8 @@ declare namespace sap {
2435
2688
  ): object;
2436
2689
  /**
2437
2690
  * Applies a mapping function to each tree item in a tree to create a new tree.
2691
+ *
2692
+ * @returns The root tree items of the mapped tree.
2438
2693
  */
2439
2694
  mapTree(
2440
2695
  /**
@@ -2449,6 +2704,8 @@ declare namespace sap {
2449
2704
  /**
2450
2705
  * Removes a child tree item from the `includedChildren` and/or `excludedChildren` collection of its parent
2451
2706
  * tree item.
2707
+ *
2708
+ * @returns Returns the deleted item or undefined if no item was removed.
2452
2709
  */
2453
2710
  removeChild(
2454
2711
  /**
@@ -2475,6 +2732,8 @@ declare namespace sap {
2475
2732
  ): object | undefined;
2476
2733
  /**
2477
2734
  * Removes a child tree item from the `excludedChildren` collection of its parent tree item.
2735
+ *
2736
+ * @returns Returns the deleted item or undefined if no item was removed.
2478
2737
  */
2479
2738
  removeExcludedChild(
2480
2739
  /**
@@ -2488,6 +2747,8 @@ declare namespace sap {
2488
2747
  ): object | undefined;
2489
2748
  /**
2490
2749
  * Removes a child tree item from the `includedChildren` collection of its parent tree item.
2750
+ *
2751
+ * @returns Returns the deleted item or undefined if no item was removed.
2491
2752
  */
2492
2753
  removeIncludedChild(
2493
2754
  /**
@@ -2501,6 +2762,8 @@ declare namespace sap {
2501
2762
  ): object | undefined;
2502
2763
  /**
2503
2764
  * Removes a root item from the tree.
2765
+ *
2766
+ * @returns Returns the deleted item or undefined if no item was removed.
2504
2767
  */
2505
2768
  removeRoot(
2506
2769
  /**
@@ -2709,6 +2972,8 @@ declare namespace sap {
2709
2972
  ): void;
2710
2973
  /**
2711
2974
  * Validates a tree and returns a set of error messages.
2975
+ *
2976
+ * @returns The set of validation errors for the tree item.
2712
2977
  */
2713
2978
  validateTree(
2714
2979
  /**
@@ -2718,6 +2983,8 @@ declare namespace sap {
2718
2983
  ): string[];
2719
2984
  /**
2720
2985
  * Validates a tree item and returns a set of error messages.
2986
+ *
2987
+ * @returns The set of validation errors for the tree item.
2721
2988
  */
2722
2989
  validateTreeItem(
2723
2990
  /**
@@ -2757,6 +3024,8 @@ declare namespace sap {
2757
3024
  * contained in `oClassInfo`.
2758
3025
  *
2759
3026
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3027
+ *
3028
+ * @returns Created class / constructor function
2760
3029
  */
2761
3030
  static extend<T extends Record<string, unknown>>(
2762
3031
  /**
@@ -2775,6 +3044,8 @@ declare namespace sap {
2775
3044
  ): Function;
2776
3045
  /**
2777
3046
  * Returns a metadata object for class sap.ui.vtm.Column.
3047
+ *
3048
+ * @returns Metadata object describing this class
2778
3049
  */
2779
3050
  static getMetadata(): sap.ui.core.ElementMetadata;
2780
3051
  /**
@@ -2792,6 +3063,8 @@ declare namespace sap {
2792
3063
  *
2793
3064
  * When the type property has a value of {@link sap.ui.vtm.ColumnType.AppData} the descriptor property has
2794
3065
  * the following form: `'bomId'`
3066
+ *
3067
+ * @returns Value of property `descriptor`
2795
3068
  */
2796
3069
  getDescriptor(): string;
2797
3070
  /**
@@ -2800,6 +3073,8 @@ declare namespace sap {
2800
3073
  * The horizontal alignment for the tree column.
2801
3074
  *
2802
3075
  * Default value is `"Left"`.
3076
+ *
3077
+ * @returns Value of property `hAlign`
2803
3078
  */
2804
3079
  getHAlign(): sap.ui.core.HorizontalAlign;
2805
3080
  /**
@@ -2807,6 +3082,8 @@ declare namespace sap {
2807
3082
  *
2808
3083
  * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so
2809
3084
  * it should be included whether or not the `labelControl` property is used.
3085
+ *
3086
+ * @returns Value of property `label`
2810
3087
  */
2811
3088
  getLabel(): string;
2812
3089
  /**
@@ -2815,6 +3092,8 @@ declare namespace sap {
2815
3092
  * A {@link sap.ui.core.Control} that is used in the column header. When specified, this is used in preference
2816
3093
  * to the `label` property as the column header content. However the `label` property should also be specified
2817
3094
  * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}.
3095
+ *
3096
+ * @returns Value of property `labelControl`
2818
3097
  */
2819
3098
  getLabelControl(): object;
2820
3099
  /**
@@ -2823,6 +3102,8 @@ declare namespace sap {
2823
3102
  * If set to true, the column can be resized.
2824
3103
  *
2825
3104
  * Default value is `true`.
3105
+ *
3106
+ * @returns Value of property `resizable`
2826
3107
  */
2827
3108
  getResizable(): boolean;
2828
3109
  /**
@@ -2830,6 +3111,8 @@ declare namespace sap {
2830
3111
  *
2831
3112
  * If defined, overrides the cell template for the column.
2832
3113
  * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored.
3114
+ *
3115
+ * @returns Value of property `template`
2833
3116
  */
2834
3117
  getTemplate(): sap.ui.core.Control;
2835
3118
  /**
@@ -2837,6 +3120,8 @@ declare namespace sap {
2837
3120
  *
2838
3121
  * A localized string to show in the column header tooltip. If unspecified, the label value will be used
2839
3122
  * as the column header tooltip.
3123
+ *
3124
+ * @returns Value of property `tooltip`
2840
3125
  */
2841
3126
  getTooltip(): string;
2842
3127
  /**
@@ -2849,12 +3134,16 @@ declare namespace sap {
2849
3134
  * tree item.
2850
3135
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
2851
3136
  * table row.
3137
+ *
3138
+ * @returns Value of property `tooltipFormatter`
2852
3139
  */
2853
3140
  getTooltipFormatter(): any;
2854
3141
  /**
2855
3142
  * Gets current value of property {@link #getType type}.
2856
3143
  *
2857
3144
  * The type of column.
3145
+ *
3146
+ * @returns Value of property `type`
2858
3147
  */
2859
3148
  getType(): sap.ui.vtm.ColumnType;
2860
3149
  /**
@@ -2865,6 +3154,8 @@ declare namespace sap {
2865
3154
  * item.
2866
3155
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
2867
3156
  * table row.
3157
+ *
3158
+ * @returns Value of property `valueFormatter`
2868
3159
  */
2869
3160
  getValueFormatter(): any;
2870
3161
  /**
@@ -2873,6 +3164,8 @@ declare namespace sap {
2873
3164
  * The width of the tree column.
2874
3165
  *
2875
3166
  * Default value is `"200px"`.
3167
+ *
3168
+ * @returns Value of property `width`
2876
3169
  */
2877
3170
  getWidth(): sap.ui.core.CSSSize;
2878
3171
  /**
@@ -2892,6 +3185,8 @@ declare namespace sap {
2892
3185
  * the following form: `'bomId'`
2893
3186
  *
2894
3187
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3188
+ *
3189
+ * @returns Reference to `this` in order to allow method chaining
2895
3190
  */
2896
3191
  setDescriptor(
2897
3192
  /**
@@ -2907,6 +3202,8 @@ declare namespace sap {
2907
3202
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2908
3203
  *
2909
3204
  * Default value is `"Left"`.
3205
+ *
3206
+ * @returns Reference to `this` in order to allow method chaining
2910
3207
  */
2911
3208
  setHAlign(
2912
3209
  /**
@@ -2921,6 +3218,8 @@ declare namespace sap {
2921
3218
  * it should be included whether or not the `labelControl` property is used.
2922
3219
  *
2923
3220
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3221
+ *
3222
+ * @returns Reference to `this` in order to allow method chaining
2924
3223
  */
2925
3224
  setLabel(
2926
3225
  /**
@@ -2936,6 +3235,8 @@ declare namespace sap {
2936
3235
  * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}.
2937
3236
  *
2938
3237
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3238
+ *
3239
+ * @returns Reference to `this` in order to allow method chaining
2939
3240
  */
2940
3241
  setLabelControl(
2941
3242
  /**
@@ -2951,6 +3252,8 @@ declare namespace sap {
2951
3252
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2952
3253
  *
2953
3254
  * Default value is `true`.
3255
+ *
3256
+ * @returns Reference to `this` in order to allow method chaining
2954
3257
  */
2955
3258
  setResizable(
2956
3259
  /**
@@ -2965,6 +3268,8 @@ declare namespace sap {
2965
3268
  * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored.
2966
3269
  *
2967
3270
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3271
+ *
3272
+ * @returns Reference to `this` in order to allow method chaining
2968
3273
  */
2969
3274
  setTemplate(
2970
3275
  /**
@@ -2979,6 +3284,8 @@ declare namespace sap {
2979
3284
  * as the column header tooltip.
2980
3285
  *
2981
3286
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3287
+ *
3288
+ * @returns Reference to `this` in order to allow method chaining
2982
3289
  */
2983
3290
  setTooltip(
2984
3291
  /**
@@ -2999,6 +3306,8 @@ declare namespace sap {
2999
3306
  * table row.
3000
3307
  *
3001
3308
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3309
+ *
3310
+ * @returns Reference to `this` in order to allow method chaining
3002
3311
  */
3003
3312
  setTooltipFormatter(
3004
3313
  /**
@@ -3012,6 +3321,8 @@ declare namespace sap {
3012
3321
  * The type of column.
3013
3322
  *
3014
3323
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3324
+ *
3325
+ * @returns Reference to `this` in order to allow method chaining
3015
3326
  */
3016
3327
  setType(
3017
3328
  /**
@@ -3029,6 +3340,8 @@ declare namespace sap {
3029
3340
  * table row.
3030
3341
  *
3031
3342
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3343
+ *
3344
+ * @returns Reference to `this` in order to allow method chaining
3032
3345
  */
3033
3346
  setValueFormatter(
3034
3347
  /**
@@ -3044,6 +3357,8 @@ declare namespace sap {
3044
3357
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3045
3358
  *
3046
3359
  * Default value is `"200px"`.
3360
+ *
3361
+ * @returns Reference to `this` in order to allow method chaining
3047
3362
  */
3048
3363
  setWidth(
3049
3364
  /**
@@ -3082,6 +3397,8 @@ declare namespace sap {
3082
3397
  * information contained in `oClassInfo`.
3083
3398
  *
3084
3399
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3400
+ *
3401
+ * @returns Created class / constructor function
3085
3402
  */
3086
3403
  static extend<T extends Record<string, unknown>>(
3087
3404
  /**
@@ -3100,6 +3417,8 @@ declare namespace sap {
3100
3417
  ): Function;
3101
3418
  /**
3102
3419
  * Returns a metadata object for class sap.ui.vtm.DisplayGroup.
3420
+ *
3421
+ * @returns Metadata object describing this class
3103
3422
  */
3104
3423
  static getMetadata(): sap.ui.core.ElementMetadata;
3105
3424
  /**
@@ -3126,6 +3445,8 @@ declare namespace sap {
3126
3445
  * Display state objects can be reused multiple times in the map to reduce memory usage.
3127
3446
  *
3128
3447
  * Default value is `{}`.
3448
+ *
3449
+ * @returns Value of property `displayStatesBySceneNodeId`
3129
3450
  */
3130
3451
  getDisplayStatesBySceneNodeId(): object;
3131
3452
  /**
@@ -3154,6 +3475,8 @@ declare namespace sap {
3154
3475
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3155
3476
  *
3156
3477
  * Default value is `{}`.
3478
+ *
3479
+ * @returns Reference to `this` in order to allow method chaining
3157
3480
  */
3158
3481
  setDisplayStatesBySceneNodeId(
3159
3482
  /**
@@ -3203,6 +3526,8 @@ declare namespace sap {
3203
3526
  * information contained in `oClassInfo`.
3204
3527
  *
3205
3528
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3529
+ *
3530
+ * @returns Created class / constructor function
3206
3531
  */
3207
3532
  static extend<T extends Record<string, unknown>>(
3208
3533
  /**
@@ -3221,6 +3546,8 @@ declare namespace sap {
3221
3546
  ): Function;
3222
3547
  /**
3223
3548
  * Returns a metadata object for class sap.ui.vtm.Extension.
3549
+ *
3550
+ * @returns Metadata object describing this class
3224
3551
  */
3225
3552
  static getMetadata(): sap.ui.core.ElementMetadata;
3226
3553
  /**
@@ -3243,6 +3570,8 @@ declare namespace sap {
3243
3570
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3244
3571
  *
3245
3572
  * Fired when the enabled property is changed.
3573
+ *
3574
+ * @returns Reference to `this` in order to allow method chaining
3246
3575
  */
3247
3576
  attachEnabledChanged(
3248
3577
  /**
@@ -3267,6 +3596,8 @@ declare namespace sap {
3267
3596
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3268
3597
  *
3269
3598
  * Fired when the enabled property is changed.
3599
+ *
3600
+ * @returns Reference to `this` in order to allow method chaining
3270
3601
  */
3271
3602
  attachEnabledChanged(
3272
3603
  /**
@@ -3285,6 +3616,8 @@ declare namespace sap {
3285
3616
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3286
3617
  *
3287
3618
  * Fired when initialization has completed.
3619
+ *
3620
+ * @returns Reference to `this` in order to allow method chaining
3288
3621
  */
3289
3622
  attachInitialized(
3290
3623
  /**
@@ -3308,6 +3641,8 @@ declare namespace sap {
3308
3641
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3309
3642
  *
3310
3643
  * Fired when initialization has completed.
3644
+ *
3645
+ * @returns Reference to `this` in order to allow method chaining
3311
3646
  */
3312
3647
  attachInitialized(
3313
3648
  /**
@@ -3324,6 +3659,8 @@ declare namespace sap {
3324
3659
  *
3325
3660
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
3326
3661
  * of the possible properties of `oBindingInfo`
3662
+ *
3663
+ * @returns Reference to `this` in order to allow method chaining
3327
3664
  */
3328
3665
  bindEnabled(
3329
3666
  /**
@@ -3336,6 +3673,8 @@ declare namespace sap {
3336
3673
  * `sap.ui.vtm.Extension`.
3337
3674
  *
3338
3675
  * The passed function and listener object must match the ones used for event registration.
3676
+ *
3677
+ * @returns Reference to `this` in order to allow method chaining
3339
3678
  */
3340
3679
  detachEnabledChanged(
3341
3680
  /**
@@ -3351,6 +3690,8 @@ declare namespace sap {
3351
3690
  * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Extension`.
3352
3691
  *
3353
3692
  * The passed function and listener object must match the ones used for event registration.
3693
+ *
3694
+ * @returns Reference to `this` in order to allow method chaining
3354
3695
  */
3355
3696
  detachInitialized(
3356
3697
  /**
@@ -3364,6 +3705,8 @@ declare namespace sap {
3364
3705
  ): this;
3365
3706
  /**
3366
3707
  * Fires event {@link #event:enabledChanged enabledChanged} to attached listeners.
3708
+ *
3709
+ * @returns Reference to `this` in order to allow method chaining
3367
3710
  */
3368
3711
  fireEnabledChanged(
3369
3712
  /**
@@ -3373,6 +3716,8 @@ declare namespace sap {
3373
3716
  ): this;
3374
3717
  /**
3375
3718
  * Fires event {@link #event:initialized initialized} to attached listeners.
3719
+ *
3720
+ * @returns Reference to `this` in order to allow method chaining
3376
3721
  */
3377
3722
  fireInitialized(
3378
3723
  /**
@@ -3386,6 +3731,8 @@ declare namespace sap {
3386
3731
  * Controls whether the extension is enabled.
3387
3732
  *
3388
3733
  * Default value is `true`.
3734
+ *
3735
+ * @returns Value of property `enabled`
3389
3736
  */
3390
3737
  getEnabled(): boolean;
3391
3738
  /**
@@ -3394,6 +3741,9 @@ declare namespace sap {
3394
3741
  *
3395
3742
  * The {@link #initialize initialize} method is called after the {@link Promise} returned by {@link #getVtmPromise
3396
3743
  * getVtmPromise} resolves.
3744
+ *
3745
+ * @returns A {@link Promise} that is resolved after the {@link #initialize initialize} method has been
3746
+ * called for the extension.
3397
3747
  */
3398
3748
  getInitializedPromise(): Promise<any>;
3399
3749
  /**
@@ -3401,6 +3751,9 @@ declare namespace sap {
3401
3751
  * {@link sap.ui.vtm.Vtm} instance.
3402
3752
  *
3403
3753
  * The relevant {@link sap.ui.vtm.Vtm} instance is passed to the resolve handler.
3754
+ *
3755
+ * @returns A {@link Promise} that is resolved when the extension is added to the `extensions` aggregation
3756
+ * of an {@link sap.ui.vtm.Vtm} instance.
3404
3757
  */
3405
3758
  getVtmPromise(): Promise<any>;
3406
3759
  /**
@@ -3420,6 +3773,8 @@ declare namespace sap {
3420
3773
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3421
3774
  *
3422
3775
  * Default value is `true`.
3776
+ *
3777
+ * @returns Reference to `this` in order to allow method chaining
3423
3778
  */
3424
3779
  setEnabled(
3425
3780
  /**
@@ -3429,6 +3784,8 @@ declare namespace sap {
3429
3784
  ): this;
3430
3785
  /**
3431
3786
  * Unbinds property {@link #getEnabled enabled} from model data.
3787
+ *
3788
+ * @returns Reference to `this` in order to allow method chaining
3432
3789
  */
3433
3790
  unbindEnabled(): this;
3434
3791
  }
@@ -3469,6 +3826,8 @@ declare namespace sap {
3469
3826
  * contained in `oClassInfo`.
3470
3827
  *
3471
3828
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3829
+ *
3830
+ * @returns Created class / constructor function
3472
3831
  */
3473
3832
  static extend<T extends Record<string, unknown>>(
3474
3833
  /**
@@ -3487,10 +3846,14 @@ declare namespace sap {
3487
3846
  ): Function;
3488
3847
  /**
3489
3848
  * Returns a metadata object for class sap.ui.vtm.Lookup.
3849
+ *
3850
+ * @returns Metadata object describing this class
3490
3851
  */
3491
3852
  static getMetadata(): sap.ui.core.ElementMetadata;
3492
3853
  /**
3493
3854
  * Adds a value to the set of values stored against a given key.
3855
+ *
3856
+ * @returns `this` for method chaining.
3494
3857
  */
3495
3858
  addValue(
3496
3859
  /**
@@ -3504,10 +3867,14 @@ declare namespace sap {
3504
3867
  ): sap.ui.vtm.Lookup;
3505
3868
  /**
3506
3869
  * Clears the Lookup.
3870
+ *
3871
+ * @returns `this` for method chaining.
3507
3872
  */
3508
3873
  clear(): sap.ui.vtm.Lookup;
3509
3874
  /**
3510
3875
  * Loops over the key/value array pairs calling the callback function for each pair.
3876
+ *
3877
+ * @returns `this` for method chaining.
3511
3878
  */
3512
3879
  forEach(
3513
3880
  /**
@@ -3518,6 +3885,8 @@ declare namespace sap {
3518
3885
  ): sap.ui.vtm.Lookup;
3519
3886
  /**
3520
3887
  * Gets the values stored against a given key.
3888
+ *
3889
+ * @returns The values (if any) associated with the given key.
3521
3890
  */
3522
3891
  getValues(
3523
3892
  /**
@@ -3527,6 +3896,8 @@ declare namespace sap {
3527
3896
  ): any[];
3528
3897
  /**
3529
3898
  * Returns whether there are any values stored against the given key.
3899
+ *
3900
+ * @returns `true` if there are any values stored against the given key.
3530
3901
  */
3531
3902
  hasValue(
3532
3903
  /**
@@ -3536,6 +3907,8 @@ declare namespace sap {
3536
3907
  ): boolean;
3537
3908
  /**
3538
3909
  * Removes a particular value.
3910
+ *
3911
+ * @returns `this` for method chaining.
3539
3912
  */
3540
3913
  removeValue(
3541
3914
  /**
@@ -3573,6 +3946,8 @@ declare namespace sap {
3573
3946
  * the information contained in `oClassInfo`.
3574
3947
  *
3575
3948
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Popover.extend}.
3949
+ *
3950
+ * @returns Created class / constructor function
3576
3951
  */
3577
3952
  static extend<T extends Record<string, unknown>>(
3578
3953
  /**
@@ -3591,12 +3966,16 @@ declare namespace sap {
3591
3966
  ): Function;
3592
3967
  /**
3593
3968
  * Returns a metadata object for class sap.ui.vtm.MessagesPopover.
3969
+ *
3970
+ * @returns Metadata object describing this class
3594
3971
  */
3595
3972
  static getMetadata(): sap.ui.core.ElementMetadata;
3596
3973
  /**
3597
3974
  * Gets current value of property {@link #getMaxHeight maxHeight}.
3598
3975
  *
3599
3976
  * Maximum height of status window.
3977
+ *
3978
+ * @returns Value of property `maxHeight`
3600
3979
  */
3601
3980
  getMaxHeight(): sap.ui.core.CSSSize;
3602
3981
  /**
@@ -3608,6 +3987,8 @@ declare namespace sap {
3608
3987
  * - `level`
3609
3988
  * - `text`
3610
3989
  * - `icon`
3990
+ *
3991
+ * @returns Value of property `messages`
3611
3992
  */
3612
3993
  getMessages(): object[];
3613
3994
  /**
@@ -3616,6 +3997,8 @@ declare namespace sap {
3616
3997
  * Maximum height of status window.
3617
3998
  *
3618
3999
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4000
+ *
4001
+ * @returns Reference to `this` in order to allow method chaining
3619
4002
  */
3620
4003
  setMaxHeight(
3621
4004
  /**
@@ -3634,6 +4017,8 @@ declare namespace sap {
3634
4017
  * - `icon`
3635
4018
  *
3636
4019
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4020
+ *
4021
+ * @returns Reference to `this` in order to allow method chaining
3637
4022
  */
3638
4023
  setMessages(
3639
4024
  /**
@@ -3677,6 +4062,8 @@ declare namespace sap {
3677
4062
  * contained in `oClassInfo`.
3678
4063
  *
3679
4064
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4065
+ *
4066
+ * @returns Created class / constructor function
3680
4067
  */
3681
4068
  static extend<T extends Record<string, unknown>>(
3682
4069
  /**
@@ -3695,10 +4082,14 @@ declare namespace sap {
3695
4082
  ): Function;
3696
4083
  /**
3697
4084
  * Returns a metadata object for class sap.ui.vtm.Panel.
4085
+ *
4086
+ * @returns Metadata object describing this class
3698
4087
  */
3699
4088
  static getMetadata(): sap.ui.core.ElementMetadata;
3700
4089
  /**
3701
4090
  * Adds some titleControl to the aggregation {@link #getTitleControls titleControls}.
4091
+ *
4092
+ * @returns Reference to `this` in order to allow method chaining
3702
4093
  */
3703
4094
  addTitleControl(
3704
4095
  /**
@@ -3708,6 +4099,8 @@ declare namespace sap {
3708
4099
  ): this;
3709
4100
  /**
3710
4101
  * Adds some treeHeaderControl to the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4102
+ *
4103
+ * @returns Reference to `this` in order to allow method chaining
3711
4104
  */
3712
4105
  addTreeHeaderControl(
3713
4106
  /**
@@ -3717,6 +4110,8 @@ declare namespace sap {
3717
4110
  ): this;
3718
4111
  /**
3719
4112
  * Adds some viewportHeaderControl to the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4113
+ *
4114
+ * @returns Reference to `this` in order to allow method chaining
3720
4115
  */
3721
4116
  addViewportHeaderControl(
3722
4117
  /**
@@ -3732,6 +4127,8 @@ declare namespace sap {
3732
4127
  *
3733
4128
  * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu
3734
4129
  * from being shown call preventDefault() on the event.
4130
+ *
4131
+ * @returns Reference to `this` in order to allow method chaining
3735
4132
  */
3736
4133
  attachContextMenu(
3737
4134
  /**
@@ -3756,6 +4153,8 @@ declare namespace sap {
3756
4153
  *
3757
4154
  * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu
3758
4155
  * from being shown call preventDefault() on the event.
4156
+ *
4157
+ * @returns Reference to `this` in order to allow method chaining
3759
4158
  */
3760
4159
  attachContextMenu(
3761
4160
  /**
@@ -3774,6 +4173,8 @@ declare namespace sap {
3774
4173
  * otherwise it will be bound to this `sap.ui.vtm.Panel` itself.
3775
4174
  *
3776
4175
  * Raised when the panel is initialized.
4176
+ *
4177
+ * @returns Reference to `this` in order to allow method chaining
3777
4178
  */
3778
4179
  attachInitialized(
3779
4180
  /**
@@ -3797,6 +4198,8 @@ declare namespace sap {
3797
4198
  * otherwise it will be bound to this `sap.ui.vtm.Panel` itself.
3798
4199
  *
3799
4200
  * Raised when the panel is initialized.
4201
+ *
4202
+ * @returns Reference to `this` in order to allow method chaining
3800
4203
  */
3801
4204
  attachInitialized(
3802
4205
  /**
@@ -3810,20 +4213,28 @@ declare namespace sap {
3810
4213
  ): this;
3811
4214
  /**
3812
4215
  * Destroys all the titleControls in the aggregation {@link #getTitleControls titleControls}.
4216
+ *
4217
+ * @returns Reference to `this` in order to allow method chaining
3813
4218
  */
3814
4219
  destroyTitleControls(): this;
3815
4220
  /**
3816
4221
  * Destroys all the treeHeaderControls in the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4222
+ *
4223
+ * @returns Reference to `this` in order to allow method chaining
3817
4224
  */
3818
4225
  destroyTreeHeaderControls(): this;
3819
4226
  /**
3820
4227
  * Destroys all the viewportHeaderControls in the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4228
+ *
4229
+ * @returns Reference to `this` in order to allow method chaining
3821
4230
  */
3822
4231
  destroyViewportHeaderControls(): this;
3823
4232
  /**
3824
4233
  * Detaches event handler `fnFunction` from the {@link #event:contextMenu contextMenu} event of this `sap.ui.vtm.Panel`.
3825
4234
  *
3826
4235
  * The passed function and listener object must match the ones used for event registration.
4236
+ *
4237
+ * @returns Reference to `this` in order to allow method chaining
3827
4238
  */
3828
4239
  detachContextMenu(
3829
4240
  /**
@@ -3839,6 +4250,8 @@ declare namespace sap {
3839
4250
  * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Panel`.
3840
4251
  *
3841
4252
  * The passed function and listener object must match the ones used for event registration.
4253
+ *
4254
+ * @returns Reference to `this` in order to allow method chaining
3842
4255
  */
3843
4256
  detachInitialized(
3844
4257
  /**
@@ -3855,6 +4268,8 @@ declare namespace sap {
3855
4268
  *
3856
4269
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
3857
4270
  * event object. The return value of this method indicates whether the default action should be executed.
4271
+ *
4272
+ * @returns Whether or not to prevent the default action
3858
4273
  */
3859
4274
  fireContextMenu(
3860
4275
  /**
@@ -3893,6 +4308,8 @@ declare namespace sap {
3893
4308
  ): boolean;
3894
4309
  /**
3895
4310
  * Fires event {@link #event:initialized initialized} to attached listeners.
4311
+ *
4312
+ * @returns Reference to `this` in order to allow method chaining
3896
4313
  */
3897
4314
  fireInitialized(
3898
4315
  /**
@@ -3906,10 +4323,14 @@ declare namespace sap {
3906
4323
  * The height of the panel.
3907
4324
  *
3908
4325
  * Default value is `"inherit"`.
4326
+ *
4327
+ * @returns Value of property `height`
3909
4328
  */
3910
4329
  getHeight(): sap.ui.core.CSSSize;
3911
4330
  /**
3912
4331
  * Gets whether this is the active {@link sap.ui.vtm.Panel}.
4332
+ *
4333
+ * @returns `true` if this is the active panel.
3913
4334
  */
3914
4335
  getIsActive(): boolean;
3915
4336
  /**
@@ -3918,12 +4339,16 @@ declare namespace sap {
3918
4339
  * Controls whether the viewport will be shown for this panel.
3919
4340
  *
3920
4341
  * Default value is `true`.
4342
+ *
4343
+ * @returns Value of property `showViewport`
3921
4344
  */
3922
4345
  getShowViewport(): boolean;
3923
4346
  /**
3924
4347
  * Gets current value of property {@link #getTitle title}.
3925
4348
  *
3926
4349
  * The text to show in the title bar for this panel.
4350
+ *
4351
+ * @returns Value of property `title`
3927
4352
  */
3928
4353
  getTitle(): string;
3929
4354
  /**
@@ -3934,6 +4359,8 @@ declare namespace sap {
3934
4359
  getTitleControls(): sap.ui.core.Control[];
3935
4360
  /**
3936
4361
  * Gets the tree owned by this panel.
4362
+ *
4363
+ * @returns The tree owned by this panel.
3937
4364
  */
3938
4365
  getTree(): sap.ui.vtm.Tree;
3939
4366
  /**
@@ -3948,10 +4375,14 @@ declare namespace sap {
3948
4375
  * The width of the tree.
3949
4376
  *
3950
4377
  * Default value is `"50%"`.
4378
+ *
4379
+ * @returns Value of property `treeWidth`
3951
4380
  */
3952
4381
  getTreeWidth(): sap.ui.core.CSSSize;
3953
4382
  /**
3954
4383
  * Gets the viewport owned by this panel.
4384
+ *
4385
+ * @returns The viewport owned by this panel.
3955
4386
  */
3956
4387
  getViewport(): sap.ui.vtm.Viewport;
3957
4388
  /**
@@ -3962,6 +4393,8 @@ declare namespace sap {
3962
4393
  getViewportHeaderControls(): sap.ui.core.Control[];
3963
4394
  /**
3964
4395
  * Gets the {@link sap.ui.vtm.Vtm} instance that owns this panel.
4396
+ *
4397
+ * @returns The {@link sap.ui.vtm.Vtm} instance that owns this panel.
3965
4398
  */
3966
4399
  getVtm(): sap.ui.vtm.Vtm;
3967
4400
  /**
@@ -3971,6 +4404,8 @@ declare namespace sap {
3971
4404
  /**
3972
4405
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTitleControls titleControls}.
3973
4406
  * and returns its index if found or -1 otherwise.
4407
+ *
4408
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3974
4409
  */
3975
4410
  indexOfTitleControl(
3976
4411
  /**
@@ -3981,6 +4416,8 @@ declare namespace sap {
3981
4416
  /**
3982
4417
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
3983
4418
  * and returns its index if found or -1 otherwise.
4419
+ *
4420
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3984
4421
  */
3985
4422
  indexOfTreeHeaderControl(
3986
4423
  /**
@@ -3991,6 +4428,8 @@ declare namespace sap {
3991
4428
  /**
3992
4429
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
3993
4430
  * and returns its index if found or -1 otherwise.
4431
+ *
4432
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3994
4433
  */
3995
4434
  indexOfViewportHeaderControl(
3996
4435
  /**
@@ -4000,6 +4439,8 @@ declare namespace sap {
4000
4439
  ): int;
4001
4440
  /**
4002
4441
  * Inserts a titleControl into the aggregation {@link #getTitleControls titleControls}.
4442
+ *
4443
+ * @returns Reference to `this` in order to allow method chaining
4003
4444
  */
4004
4445
  insertTitleControl(
4005
4446
  /**
@@ -4015,6 +4456,8 @@ declare namespace sap {
4015
4456
  ): this;
4016
4457
  /**
4017
4458
  * Inserts a treeHeaderControl into the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4459
+ *
4460
+ * @returns Reference to `this` in order to allow method chaining
4018
4461
  */
4019
4462
  insertTreeHeaderControl(
4020
4463
  /**
@@ -4030,6 +4473,8 @@ declare namespace sap {
4030
4473
  ): this;
4031
4474
  /**
4032
4475
  * Inserts a viewportHeaderControl into the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4476
+ *
4477
+ * @returns Reference to `this` in order to allow method chaining
4033
4478
  */
4034
4479
  insertViewportHeaderControl(
4035
4480
  /**
@@ -4047,22 +4492,30 @@ declare namespace sap {
4047
4492
  * Removes all the controls from the aggregation {@link #getTitleControls titleControls}.
4048
4493
  *
4049
4494
  * Additionally, it unregisters them from the hosting UIArea.
4495
+ *
4496
+ * @returns An array of the removed elements (might be empty)
4050
4497
  */
4051
4498
  removeAllTitleControls(): sap.ui.core.Control[];
4052
4499
  /**
4053
4500
  * Removes all the controls from the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4054
4501
  *
4055
4502
  * Additionally, it unregisters them from the hosting UIArea.
4503
+ *
4504
+ * @returns An array of the removed elements (might be empty)
4056
4505
  */
4057
4506
  removeAllTreeHeaderControls(): sap.ui.core.Control[];
4058
4507
  /**
4059
4508
  * Removes all the controls from the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4060
4509
  *
4061
4510
  * Additionally, it unregisters them from the hosting UIArea.
4511
+ *
4512
+ * @returns An array of the removed elements (might be empty)
4062
4513
  */
4063
4514
  removeAllViewportHeaderControls(): sap.ui.core.Control[];
4064
4515
  /**
4065
4516
  * Removes a titleControl from the aggregation {@link #getTitleControls titleControls}.
4517
+ *
4518
+ * @returns The removed titleControl or `null`
4066
4519
  */
4067
4520
  removeTitleControl(
4068
4521
  /**
@@ -4072,6 +4525,8 @@ declare namespace sap {
4072
4525
  ): sap.ui.core.Control;
4073
4526
  /**
4074
4527
  * Removes a treeHeaderControl from the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4528
+ *
4529
+ * @returns The removed treeHeaderControl or `null`
4075
4530
  */
4076
4531
  removeTreeHeaderControl(
4077
4532
  /**
@@ -4081,6 +4536,8 @@ declare namespace sap {
4081
4536
  ): sap.ui.core.Control;
4082
4537
  /**
4083
4538
  * Removes a viewportHeaderControl from the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4539
+ *
4540
+ * @returns The removed viewportHeaderControl or `null`
4084
4541
  */
4085
4542
  removeViewportHeaderControl(
4086
4543
  /**
@@ -4096,6 +4553,8 @@ declare namespace sap {
4096
4553
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4097
4554
  *
4098
4555
  * Default value is `"inherit"`.
4556
+ *
4557
+ * @returns Reference to `this` in order to allow method chaining
4099
4558
  */
4100
4559
  setHeight(
4101
4560
  /**
@@ -4111,6 +4570,8 @@ declare namespace sap {
4111
4570
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4112
4571
  *
4113
4572
  * Default value is `true`.
4573
+ *
4574
+ * @returns Reference to `this` in order to allow method chaining
4114
4575
  */
4115
4576
  setShowViewport(
4116
4577
  /**
@@ -4120,6 +4581,8 @@ declare namespace sap {
4120
4581
  ): this;
4121
4582
  /**
4122
4583
  * Sets the panel title.
4584
+ *
4585
+ * @returns Returns `this` for method chaining.
4123
4586
  */
4124
4587
  setTitle(
4125
4588
  /**
@@ -4135,6 +4598,8 @@ declare namespace sap {
4135
4598
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4136
4599
  *
4137
4600
  * Default value is `"50%"`.
4601
+ *
4602
+ * @returns Reference to `this` in order to allow method chaining
4138
4603
  */
4139
4604
  setTreeWidth(
4140
4605
  /**
@@ -4144,6 +4609,8 @@ declare namespace sap {
4144
4609
  ): this;
4145
4610
  /**
4146
4611
  * Sets the associated {@link #getVtmId vtmId}.
4612
+ *
4613
+ * @returns Reference to `this` in order to allow method chaining
4147
4614
  */
4148
4615
  setVtmId(
4149
4616
  /**
@@ -4178,6 +4645,8 @@ declare namespace sap {
4178
4645
  * the information contained in `oClassInfo`.
4179
4646
  *
4180
4647
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4648
+ *
4649
+ * @returns Created class / constructor function
4181
4650
  */
4182
4651
  static extend<T extends Record<string, unknown>>(
4183
4652
  /**
@@ -4196,10 +4665,14 @@ declare namespace sap {
4196
4665
  ): Function;
4197
4666
  /**
4198
4667
  * Returns a metadata object for class sap.ui.vtm.ProgressDialog.
4668
+ *
4669
+ * @returns Metadata object describing this class
4199
4670
  */
4200
4671
  static getMetadata(): sap.ui.core.ElementMetadata;
4201
4672
  /**
4202
4673
  * Closes the dialog.
4674
+ *
4675
+ * @returns `this` for method chaining.
4203
4676
  */
4204
4677
  close(): sap.ui.vtm.ProgressDialog;
4205
4678
  /**
@@ -4208,6 +4681,8 @@ declare namespace sap {
4208
4681
  * The percentage (0-100) to show in the progress bar (if visible).
4209
4682
  *
4210
4683
  * Default value is `0`.
4684
+ *
4685
+ * @returns Value of property `percentComplete`
4211
4686
  */
4212
4687
  getPercentComplete(): int;
4213
4688
  /**
@@ -4216,20 +4691,28 @@ declare namespace sap {
4216
4691
  * Whether the progress bar is visible.
4217
4692
  *
4218
4693
  * Default value is `"true"`.
4694
+ *
4695
+ * @returns Value of property `progressBarVisible`
4219
4696
  */
4220
4697
  getProgressBarVisible(): boolean;
4221
4698
  /**
4222
4699
  * Gets current value of property {@link #getProgressText progressText}.
4223
4700
  *
4224
4701
  * The text to display in the progress dialog.
4702
+ *
4703
+ * @returns Value of property `progressText`
4225
4704
  */
4226
4705
  getProgressText(): string;
4227
4706
  /**
4228
4707
  * Returns whether the dialog is open.
4708
+ *
4709
+ * @returns `true` when the dialog is open.
4229
4710
  */
4230
4711
  isOpen(): boolean;
4231
4712
  /**
4232
4713
  * Opens the dialog.
4714
+ *
4715
+ * @returns `this` for method chaining.
4233
4716
  */
4234
4717
  open(): sap.ui.vtm.ProgressDialog;
4235
4718
  /**
@@ -4240,6 +4723,8 @@ declare namespace sap {
4240
4723
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4241
4724
  *
4242
4725
  * Default value is `0`.
4726
+ *
4727
+ * @returns Reference to `this` in order to allow method chaining
4243
4728
  */
4244
4729
  setPercentComplete(
4245
4730
  /**
@@ -4255,6 +4740,8 @@ declare namespace sap {
4255
4740
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4256
4741
  *
4257
4742
  * Default value is `"true"`.
4743
+ *
4744
+ * @returns Reference to `this` in order to allow method chaining
4258
4745
  */
4259
4746
  setProgressBarVisible(
4260
4747
  /**
@@ -4268,6 +4755,8 @@ declare namespace sap {
4268
4755
  * The text to display in the progress dialog.
4269
4756
  *
4270
4757
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4758
+ *
4759
+ * @returns Reference to `this` in order to allow method chaining
4271
4760
  */
4272
4761
  setProgressText(
4273
4762
  /**
@@ -4300,6 +4789,8 @@ declare namespace sap {
4300
4789
  * contained in `oClassInfo`.
4301
4790
  *
4302
4791
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
4792
+ *
4793
+ * @returns Created class / constructor function
4303
4794
  */
4304
4795
  static extend<T extends Record<string, unknown>>(
4305
4796
  /**
@@ -4318,6 +4809,8 @@ declare namespace sap {
4318
4809
  ): Function;
4319
4810
  /**
4320
4811
  * Returns a metadata object for class sap.ui.vtm.Scene.
4812
+ *
4813
+ * @returns Metadata object describing this class
4321
4814
  */
4322
4815
  static getMetadata(): sap.ui.core.ElementMetadata;
4323
4816
  /**
@@ -4334,6 +4827,8 @@ declare namespace sap {
4334
4827
  * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted}
4335
4828
  * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted}
4336
4829
  * event being raised.
4830
+ *
4831
+ * @returns Reference to `this` in order to allow method chaining
4337
4832
  */
4338
4833
  attachDownloadCompleted(
4339
4834
  /**
@@ -4364,6 +4859,8 @@ declare namespace sap {
4364
4859
  * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted}
4365
4860
  * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted}
4366
4861
  * event being raised.
4862
+ *
4863
+ * @returns Reference to `this` in order to allow method chaining
4367
4864
  */
4368
4865
  attachDownloadCompleted(
4369
4866
  /**
@@ -4383,6 +4880,8 @@ declare namespace sap {
4383
4880
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4384
4881
  *
4385
4882
  * Raised to indicate download progress of a viewable while viewables are being downloaded
4883
+ *
4884
+ * @returns Reference to `this` in order to allow method chaining
4386
4885
  */
4387
4886
  attachDownloadProgress(
4388
4887
  /**
@@ -4407,6 +4906,8 @@ declare namespace sap {
4407
4906
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4408
4907
  *
4409
4908
  * Raised to indicate download progress of a viewable while viewables are being downloaded
4909
+ *
4910
+ * @returns Reference to `this` in order to allow method chaining
4410
4911
  */
4411
4912
  attachDownloadProgress(
4412
4913
  /**
@@ -4426,6 +4927,8 @@ declare namespace sap {
4426
4927
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4427
4928
  *
4428
4929
  * Raised when starting a download of a set of viewables.
4930
+ *
4931
+ * @returns Reference to `this` in order to allow method chaining
4429
4932
  */
4430
4933
  attachDownloadStarted(
4431
4934
  /**
@@ -4450,6 +4953,8 @@ declare namespace sap {
4450
4953
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4451
4954
  *
4452
4955
  * Raised when starting a download of a set of viewables.
4956
+ *
4957
+ * @returns Reference to `this` in order to allow method chaining
4453
4958
  */
4454
4959
  attachDownloadStarted(
4455
4960
  /**
@@ -4469,6 +4974,8 @@ declare namespace sap {
4469
4974
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4470
4975
  *
4471
4976
  * Raised when the scene hierarchy has been modified.
4977
+ *
4978
+ * @returns Reference to `this` in order to allow method chaining
4472
4979
  */
4473
4980
  attachHierarchyChanged(
4474
4981
  /**
@@ -4493,6 +5000,8 @@ declare namespace sap {
4493
5000
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4494
5001
  *
4495
5002
  * Raised when the scene hierarchy has been modified.
5003
+ *
5004
+ * @returns Reference to `this` in order to allow method chaining
4496
5005
  */
4497
5006
  attachHierarchyChanged(
4498
5007
  /**
@@ -4512,6 +5021,8 @@ declare namespace sap {
4512
5021
  *
4513
5022
  * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed
4514
5023
  * to load.
5024
+ *
5025
+ * @returns Reference to `this` in order to allow method chaining
4515
5026
  */
4516
5027
  attachLoadCompleted(
4517
5028
  /**
@@ -4536,6 +5047,8 @@ declare namespace sap {
4536
5047
  *
4537
5048
  * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed
4538
5049
  * to load.
5050
+ *
5051
+ * @returns Reference to `this` in order to allow method chaining
4539
5052
  */
4540
5053
  attachLoadCompleted(
4541
5054
  /**
@@ -4554,6 +5067,8 @@ declare namespace sap {
4554
5067
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4555
5068
  *
4556
5069
  * Raised to provide progress information for a viewable that is being loaded.
5070
+ *
5071
+ * @returns Reference to `this` in order to allow method chaining
4557
5072
  */
4558
5073
  attachLoadProgress(
4559
5074
  /**
@@ -4577,6 +5092,8 @@ declare namespace sap {
4577
5092
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4578
5093
  *
4579
5094
  * Raised to provide progress information for a viewable that is being loaded.
5095
+ *
5096
+ * @returns Reference to `this` in order to allow method chaining
4580
5097
  */
4581
5098
  attachLoadProgress(
4582
5099
  /**
@@ -4595,6 +5112,8 @@ declare namespace sap {
4595
5112
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4596
5113
  *
4597
5114
  * Raised when starting to load a set of viewables.
5115
+ *
5116
+ * @returns Reference to `this` in order to allow method chaining
4598
5117
  */
4599
5118
  attachLoadStarted(
4600
5119
  /**
@@ -4618,6 +5137,8 @@ declare namespace sap {
4618
5137
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4619
5138
  *
4620
5139
  * Raised when starting to load a set of viewables.
5140
+ *
5141
+ * @returns Reference to `this` in order to allow method chaining
4621
5142
  */
4622
5143
  attachLoadStarted(
4623
5144
  /**
@@ -4631,6 +5152,8 @@ declare namespace sap {
4631
5152
  ): this;
4632
5153
  /**
4633
5154
  * Clones a scene node.
5155
+ *
5156
+ * @returns The scene node ID of the created node.
4634
5157
  */
4635
5158
  cloneNode(
4636
5159
  /**
@@ -4658,6 +5181,8 @@ declare namespace sap {
4658
5181
  ): string;
4659
5182
  /**
4660
5183
  * Creates a scene node.
5184
+ *
5185
+ * @returns The scene node ID of the created node.
4661
5186
  */
4662
5187
  createNode(
4663
5188
  /**
@@ -4677,6 +5202,8 @@ declare namespace sap {
4677
5202
  ): string;
4678
5203
  /**
4679
5204
  * Deletes a node from the scene.
5205
+ *
5206
+ * @returns `this` for method chaining.
4680
5207
  */
4681
5208
  deleteNode(
4682
5209
  /**
@@ -4689,6 +5216,8 @@ declare namespace sap {
4689
5216
  * of this `sap.ui.vtm.Scene`.
4690
5217
  *
4691
5218
  * The passed function and listener object must match the ones used for event registration.
5219
+ *
5220
+ * @returns Reference to `this` in order to allow method chaining
4692
5221
  */
4693
5222
  detachDownloadCompleted(
4694
5223
  /**
@@ -4705,6 +5234,8 @@ declare namespace sap {
4705
5234
  * this `sap.ui.vtm.Scene`.
4706
5235
  *
4707
5236
  * The passed function and listener object must match the ones used for event registration.
5237
+ *
5238
+ * @returns Reference to `this` in order to allow method chaining
4708
5239
  */
4709
5240
  detachDownloadProgress(
4710
5241
  /**
@@ -4721,6 +5252,8 @@ declare namespace sap {
4721
5252
  * this `sap.ui.vtm.Scene`.
4722
5253
  *
4723
5254
  * The passed function and listener object must match the ones used for event registration.
5255
+ *
5256
+ * @returns Reference to `this` in order to allow method chaining
4724
5257
  */
4725
5258
  detachDownloadStarted(
4726
5259
  /**
@@ -4737,6 +5270,8 @@ declare namespace sap {
4737
5270
  * this `sap.ui.vtm.Scene`.
4738
5271
  *
4739
5272
  * The passed function and listener object must match the ones used for event registration.
5273
+ *
5274
+ * @returns Reference to `this` in order to allow method chaining
4740
5275
  */
4741
5276
  detachHierarchyChanged(
4742
5277
  /**
@@ -4753,6 +5288,8 @@ declare namespace sap {
4753
5288
  * `sap.ui.vtm.Scene`.
4754
5289
  *
4755
5290
  * The passed function and listener object must match the ones used for event registration.
5291
+ *
5292
+ * @returns Reference to `this` in order to allow method chaining
4756
5293
  */
4757
5294
  detachLoadCompleted(
4758
5295
  /**
@@ -4768,6 +5305,8 @@ declare namespace sap {
4768
5305
  * Detaches event handler `fnFunction` from the {@link #event:loadProgress loadProgress} event of this `sap.ui.vtm.Scene`.
4769
5306
  *
4770
5307
  * The passed function and listener object must match the ones used for event registration.
5308
+ *
5309
+ * @returns Reference to `this` in order to allow method chaining
4771
5310
  */
4772
5311
  detachLoadProgress(
4773
5312
  /**
@@ -4783,6 +5322,8 @@ declare namespace sap {
4783
5322
  * Detaches event handler `fnFunction` from the {@link #event:loadStarted loadStarted} event of this `sap.ui.vtm.Scene`.
4784
5323
  *
4785
5324
  * The passed function and listener object must match the ones used for event registration.
5325
+ *
5326
+ * @returns Reference to `this` in order to allow method chaining
4786
5327
  */
4787
5328
  detachLoadStarted(
4788
5329
  /**
@@ -4796,6 +5337,8 @@ declare namespace sap {
4796
5337
  ): this;
4797
5338
  /**
4798
5339
  * Fires event {@link #event:downloadCompleted downloadCompleted} to attached listeners.
5340
+ *
5341
+ * @returns Reference to `this` in order to allow method chaining
4799
5342
  */
4800
5343
  fireDownloadCompleted(
4801
5344
  /**
@@ -4816,6 +5359,8 @@ declare namespace sap {
4816
5359
  ): this;
4817
5360
  /**
4818
5361
  * Fires event {@link #event:downloadProgress downloadProgress} to attached listeners.
5362
+ *
5363
+ * @returns Reference to `this` in order to allow method chaining
4819
5364
  */
4820
5365
  fireDownloadProgress(
4821
5366
  /**
@@ -4838,6 +5383,8 @@ declare namespace sap {
4838
5383
  ): this;
4839
5384
  /**
4840
5385
  * Fires event {@link #event:downloadStarted downloadStarted} to attached listeners.
5386
+ *
5387
+ * @returns Reference to `this` in order to allow method chaining
4841
5388
  */
4842
5389
  fireDownloadStarted(
4843
5390
  /**
@@ -4853,6 +5400,8 @@ declare namespace sap {
4853
5400
  ): this;
4854
5401
  /**
4855
5402
  * Fires event {@link #event:hierarchyChanged hierarchyChanged} to attached listeners.
5403
+ *
5404
+ * @returns Reference to `this` in order to allow method chaining
4856
5405
  */
4857
5406
  fireHierarchyChanged(
4858
5407
  /**
@@ -4862,6 +5411,8 @@ declare namespace sap {
4862
5411
  ): this;
4863
5412
  /**
4864
5413
  * Fires event {@link #event:loadCompleted loadCompleted} to attached listeners.
5414
+ *
5415
+ * @returns Reference to `this` in order to allow method chaining
4865
5416
  */
4866
5417
  fireLoadCompleted(
4867
5418
  /**
@@ -4887,6 +5438,8 @@ declare namespace sap {
4887
5438
  ): this;
4888
5439
  /**
4889
5440
  * Fires event {@link #event:loadProgress loadProgress} to attached listeners.
5441
+ *
5442
+ * @returns Reference to `this` in order to allow method chaining
4890
5443
  */
4891
5444
  fireLoadProgress(
4892
5445
  /**
@@ -4896,6 +5449,8 @@ declare namespace sap {
4896
5449
  ): this;
4897
5450
  /**
4898
5451
  * Fires event {@link #event:loadStarted loadStarted} to attached listeners.
5452
+ *
5453
+ * @returns Reference to `this` in order to allow method chaining
4899
5454
  */
4900
5455
  fireLoadStarted(
4901
5456
  /**
@@ -4911,11 +5466,15 @@ declare namespace sap {
4911
5466
  ): this;
4912
5467
  /**
4913
5468
  * Gets the scene node IDs of all the scene nodes in the scene.
5469
+ *
5470
+ * @returns The scene node IDs of all the scene nodes in the scene.
4914
5471
  */
4915
5472
  getAllIds(): string[];
4916
5473
  /**
4917
5474
  * Gets the scene node IDs of the ancestors of the specified scene node. The root scene node is the first
4918
5475
  * item in the array and the parent is the last.
5476
+ *
5477
+ * @returns The scene node IDs of the ancestors of the scene node.
4919
5478
  */
4920
5479
  getAncestorIds(
4921
5480
  /**
@@ -4957,10 +5516,15 @@ declare namespace sap {
4957
5516
  *
4958
5517
  * If this method is called before any scene traversal has occurred, it populates the set of cached scene
4959
5518
  * node IDs using {@link #getAllIds}.
5519
+ *
5520
+ * @returns The set of all scene node IDs in the scene that have been discovered via scene traversal performed
5521
+ * by the application.
4960
5522
  */
4961
5523
  getCachedIds(): string[];
4962
5524
  /**
4963
5525
  * Gets the scene node IDs of the children of the specified scene node.
5526
+ *
5527
+ * @returns The scene node IDs of the children of the specified scene node.
4964
5528
  */
4965
5529
  getChildIds(
4966
5530
  /**
@@ -4970,6 +5534,8 @@ declare namespace sap {
4970
5534
  ): string[];
4971
5535
  /**
4972
5536
  * Gets the scene node IDs of the descendants of the specified scene node.
5537
+ *
5538
+ * @returns The scene node IDs of the descendants of the specified scene node.
4973
5539
  */
4974
5540
  getDescendantIds(
4975
5541
  /**
@@ -4979,15 +5545,22 @@ declare namespace sap {
4979
5545
  ): string[];
4980
5546
  /**
4981
5547
  * Gets the set of downloaded viewables.
5548
+ *
5549
+ * @returns The set of downloaded viewables.
4982
5550
  */
4983
5551
  getDownloadedViewables(): sap.ui.vtm.Viewable[];
4984
5552
  /**
4985
5553
  * Gets the set of loaded viewables.
5554
+ *
5555
+ * @returns The set of loaded viewables.
4986
5556
  */
4987
5557
  getLoadedViewables(): sap.ui.vtm.Viewable[];
4988
5558
  /**
4989
5559
  * Gets the scene node ID of the parent node of the specified scene node or null if the specified scene
4990
5560
  * node is a root scene node.
5561
+ *
5562
+ * @returns The scene node ID of the parent scene node of the specified scene node or null if the specified
5563
+ * scene node is a root scene node.
4991
5564
  */
4992
5565
  getParentId(
4993
5566
  /**
@@ -4997,20 +5570,30 @@ declare namespace sap {
4997
5570
  ): string | null;
4998
5571
  /**
4999
5572
  * Gets the IDs of the the root scene nodes.
5573
+ *
5574
+ * @returns The root scene node IDs.
5000
5575
  */
5001
5576
  getRootIds(): string[];
5002
5577
  /**
5003
5578
  * Gets the set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable}
5004
5579
  * that has been passed to a {@link #loadViewablesAsyc} call made on this {@link sap.ui.vtm.Scene} instance.
5580
+ *
5581
+ * @returns The set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link
5582
+ * sap.ui.vtm.Viewable} that has been passed to a {@link #loadViewablesAsyc} call made on this {@link sap.ui.vtm.Scene}
5583
+ * instance.
5005
5584
  */
5006
5585
  getViewableLoadInfos(): sap.ui.vtm.ViewableLoadInfo[];
5007
5586
  /**
5008
5587
  * Gets the {@link sap.ui.vtm.Vtm} instance that owns this scene.
5588
+ *
5589
+ * @returns The {@link sap.ui.vtm.Vtm} instance that owns this scene.
5009
5590
  */
5010
5591
  getVtm(): sap.ui.vtm.Vtm;
5011
5592
  /**
5012
5593
  * Load a set of viewables asynchronously. Progress is indicated by the `progress` event and completion
5013
5594
  * is indicated by the `loadComplete` event.
5595
+ *
5596
+ * @returns `this` for method chaining.
5014
5597
  */
5015
5598
  loadViewablesAsync(
5016
5599
  /**
@@ -5022,6 +5605,8 @@ declare namespace sap {
5022
5605
  * Recursively traverses a scene tree branch calling a function on each scene node.
5023
5606
  *
5024
5607
  * Does not traverse the descendants of closed nodes.
5608
+ *
5609
+ * @returns this
5025
5610
  */
5026
5611
  traverseBranch(
5027
5612
  /**
@@ -5040,6 +5625,8 @@ declare namespace sap {
5040
5625
  ): sap.ui.vtm.Scene;
5041
5626
  /**
5042
5627
  * Traverses a set of scene nodes specified by scene node ID, calling a function on each scene node.
5628
+ *
5629
+ * @returns this
5043
5630
  */
5044
5631
  traverseNodes(
5045
5632
  /**
@@ -5057,6 +5644,8 @@ declare namespace sap {
5057
5644
  ): sap.ui.vtm.Scene;
5058
5645
  /**
5059
5646
  * Recursively traverses the scene tree calling a function on each scene node.
5647
+ *
5648
+ * @returns this
5060
5649
  */
5061
5650
  traverseTree(
5062
5651
  /**
@@ -5106,6 +5695,8 @@ declare namespace sap {
5106
5695
  * information contained in `oClassInfo`.
5107
5696
  *
5108
5697
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
5698
+ *
5699
+ * @returns Created class / constructor function
5109
5700
  */
5110
5701
  static extend<T extends Record<string, unknown>>(
5111
5702
  /**
@@ -5124,40 +5715,56 @@ declare namespace sap {
5124
5715
  ): Function;
5125
5716
  /**
5126
5717
  * Returns a metadata object for class sap.ui.vtm.SceneNode.
5718
+ *
5719
+ * @returns Metadata object describing this class
5127
5720
  */
5128
5721
  static getMetadata(): sap.ui.core.ElementMetadata;
5129
5722
  /**
5130
5723
  * Gets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.
5724
+ *
5725
+ * @returns The absolute transformation matrix that applies to the scene node in ISO 10303-42 format.
5131
5726
  */
5132
5727
  getAbsoluteMatrix(): sap.ui.vtm.Matrix;
5133
5728
  /**
5134
5729
  * Gets whether this scene node is closed. When a scene node is closed, the closed scene node and its descendants
5135
5730
  * are treated as a single scene node (at least in terms of selection).
5731
+ *
5732
+ * @returns Whether this scene node is closed.
5136
5733
  */
5137
5734
  getClosed(): boolean;
5138
5735
  /**
5139
5736
  * Gets a plain JavaScript object map of identifier values. Keys are in the form: `['{"source":"SAP","type":"VE_COMPONENT"}'`.
5140
5737
  * Values are strings or arrays of strings in the form: `'[{"name":"ID", "value":"_moto_x_asm"},{"name":"version",
5141
5738
  * "value": "00"},{"name": "timestamp", "value":"2016-05-18 03:44:53.93"}]'`.
5739
+ *
5740
+ * @returns The plain JavaScript object map of identifier values.
5142
5741
  */
5143
5742
  getIdentifiers(): object;
5144
5743
  /**
5145
5744
  * Gets the name of the scene node.
5745
+ *
5746
+ * @returns The scene node name.
5146
5747
  */
5147
5748
  getName(): string;
5148
5749
  /**
5149
5750
  * Gets a plain JavaScript object map of metadata values. Keys are in the form: `'{"category":"SAP","field":"MATERIAL"}'`.
5150
5751
  * Values are in the form of strings or arrays of strings.
5752
+ *
5753
+ * @returns The plain JavaScript object map of metadata values.
5151
5754
  */
5152
5755
  getNodeMetadata(): object;
5153
5756
  /**
5154
5757
  * Gets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.
5758
+ *
5759
+ * @returns The relative transformation matrix that applies to the scene node in ISO 10303-42 format.
5155
5760
  */
5156
5761
  getRelativeMatrix(): sap.ui.vtm.Matrix;
5157
5762
  /**
5158
5763
  * Gets current value of property {@link #getScene scene}.
5159
5764
  *
5160
5765
  * The {@link sap.ui.vtm.Scene} for the scene node.
5766
+ *
5767
+ * @returns Value of property `scene`
5161
5768
  */
5162
5769
  getScene(): object;
5163
5770
  /**
@@ -5166,10 +5773,14 @@ declare namespace sap {
5166
5773
  * The scene node id.
5167
5774
  *
5168
5775
  * This is a transient identifier that exists in the context of the current scene. It should not be persisted.
5776
+ *
5777
+ * @returns Value of property `sceneNodeId`
5169
5778
  */
5170
5779
  getSceneNodeId(): string;
5171
5780
  /**
5172
5781
  * Sets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.
5782
+ *
5783
+ * @returns `this` for method chaining.
5173
5784
  */
5174
5785
  setAbsoluteMatrix(
5175
5786
  /**
@@ -5179,6 +5790,8 @@ declare namespace sap {
5179
5790
  ): sap.ui.vtm.SceneNode;
5180
5791
  /**
5181
5792
  * Sets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.
5793
+ *
5794
+ * @returns `this` for method chaining.
5182
5795
  */
5183
5796
  setRelativeMatrix(
5184
5797
  /**
@@ -5192,6 +5805,8 @@ declare namespace sap {
5192
5805
  * The {@link sap.ui.vtm.Scene} for the scene node.
5193
5806
  *
5194
5807
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5808
+ *
5809
+ * @returns Reference to `this` in order to allow method chaining
5195
5810
  */
5196
5811
  setScene(
5197
5812
  /**
@@ -5207,6 +5822,8 @@ declare namespace sap {
5207
5822
  * This is a transient identifier that exists in the context of the current scene. It should not be persisted.
5208
5823
  *
5209
5824
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5825
+ *
5826
+ * @returns Reference to `this` in order to allow method chaining
5210
5827
  */
5211
5828
  setSceneNodeId(
5212
5829
  /**
@@ -5235,6 +5852,8 @@ declare namespace sap {
5235
5852
  * with the information contained in `oClassInfo`.
5236
5853
  *
5237
5854
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
5855
+ *
5856
+ * @returns Created class / constructor function
5238
5857
  */
5239
5858
  static extend<T extends Record<string, unknown>>(
5240
5859
  /**
@@ -5253,22 +5872,30 @@ declare namespace sap {
5253
5872
  ): Function;
5254
5873
  /**
5255
5874
  * Returns a metadata object for class sap.ui.vtm.SelectColumnsDialog.
5875
+ *
5876
+ * @returns Metadata object describing this class
5256
5877
  */
5257
5878
  static getMetadata(): sap.ui.core.ElementMetadata;
5258
5879
  /**
5259
5880
  * Gets current value of property {@link #getSelectableColumns selectableColumns}.
5260
5881
  *
5261
5882
  * The set of columns that should be shown in the dialog that may be selected for display.
5883
+ *
5884
+ * @returns Value of property `selectableColumns`
5262
5885
  */
5263
5886
  getSelectableColumns(): sap.ui.vtm.Column[];
5264
5887
  /**
5265
5888
  * Gets current value of property {@link #getTree tree}.
5266
5889
  *
5267
5890
  * The {@link sap.ui.vtm.Tree} that column selection is being performed for.
5891
+ *
5892
+ * @returns Value of property `tree`
5268
5893
  */
5269
5894
  getTree(): object;
5270
5895
  /**
5271
5896
  * Opens the dialog. The dialog applies the updated set of columns to the tree if confirmed.
5897
+ *
5898
+ * @returns `this` for method chaining.
5272
5899
  */
5273
5900
  open(): sap.ui.vtm.SelectColumnsDialog;
5274
5901
  /**
@@ -5277,6 +5904,8 @@ declare namespace sap {
5277
5904
  * The set of columns that should be shown in the dialog that may be selected for display.
5278
5905
  *
5279
5906
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5907
+ *
5908
+ * @returns Reference to `this` in order to allow method chaining
5280
5909
  */
5281
5910
  setSelectableColumns(
5282
5911
  /**
@@ -5290,6 +5919,8 @@ declare namespace sap {
5290
5919
  * The {@link sap.ui.vtm.Tree} that column selection is being performed for.
5291
5920
  *
5292
5921
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5922
+ *
5923
+ * @returns Reference to `this` in order to allow method chaining
5293
5924
  */
5294
5925
  setTree(
5295
5926
  /**
@@ -5431,6 +6062,8 @@ declare namespace sap {
5431
6062
  * contained in `oClassInfo`.
5432
6063
  *
5433
6064
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
6065
+ *
6066
+ * @returns Created class / constructor function
5434
6067
  */
5435
6068
  static extend<T extends Record<string, unknown>>(
5436
6069
  /**
@@ -5449,10 +6082,14 @@ declare namespace sap {
5449
6082
  ): Function;
5450
6083
  /**
5451
6084
  * Returns a metadata object for class sap.ui.vtm.Tree.
6085
+ *
6086
+ * @returns Metadata object describing this class
5452
6087
  */
5453
6088
  static getMetadata(): sap.ui.core.ElementMetadata;
5454
6089
  /**
5455
6090
  * Adds some headerControl to the aggregation {@link #getHeaderControls headerControls}.
6091
+ *
6092
+ * @returns Reference to `this` in order to allow method chaining
5456
6093
  */
5457
6094
  addHeaderControl(
5458
6095
  /**
@@ -5462,6 +6099,8 @@ declare namespace sap {
5462
6099
  ): this;
5463
6100
  /**
5464
6101
  * Adds a root item to the tree.
6102
+ *
6103
+ * @returns `this` to allow method chaining.
5465
6104
  */
5466
6105
  addRoot(
5467
6106
  /**
@@ -5477,6 +6116,8 @@ declare namespace sap {
5477
6116
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5478
6117
  *
5479
6118
  * Raised before the model is updated.
6119
+ *
6120
+ * @returns Reference to `this` in order to allow method chaining
5480
6121
  */
5481
6122
  attachBeforeModelUpdated(
5482
6123
  /**
@@ -5501,6 +6142,8 @@ declare namespace sap {
5501
6142
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5502
6143
  *
5503
6144
  * Raised before the model is updated.
6145
+ *
6146
+ * @returns Reference to `this` in order to allow method chaining
5504
6147
  */
5505
6148
  attachBeforeModelUpdated(
5506
6149
  /**
@@ -5520,6 +6163,8 @@ declare namespace sap {
5520
6163
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5521
6164
  *
5522
6165
  * Raised when the data columns are updated.
6166
+ *
6167
+ * @returns Reference to `this` in order to allow method chaining
5523
6168
  */
5524
6169
  attachDataColumnsChanged(
5525
6170
  /**
@@ -5544,6 +6189,8 @@ declare namespace sap {
5544
6189
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5545
6190
  *
5546
6191
  * Raised when the data columns are updated.
6192
+ *
6193
+ * @returns Reference to `this` in order to allow method chaining
5547
6194
  */
5548
6195
  attachDataColumnsChanged(
5549
6196
  /**
@@ -5563,6 +6210,8 @@ declare namespace sap {
5563
6210
  *
5564
6211
  * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop
5565
6212
  * to occur call preventDefault() on the event.
6213
+ *
6214
+ * @returns Reference to `this` in order to allow method chaining
5566
6215
  */
5567
6216
  attachDragOver(
5568
6217
  /**
@@ -5587,6 +6236,8 @@ declare namespace sap {
5587
6236
  *
5588
6237
  * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop
5589
6238
  * to occur call preventDefault() on the event.
6239
+ *
6240
+ * @returns Reference to `this` in order to allow method chaining
5590
6241
  */
5591
6242
  attachDragOver(
5592
6243
  /**
@@ -5606,6 +6257,8 @@ declare namespace sap {
5606
6257
  *
5607
6258
  * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault()
5608
6259
  * on the event.
6260
+ *
6261
+ * @returns Reference to `this` in order to allow method chaining
5609
6262
  */
5610
6263
  attachDragStart(
5611
6264
  /**
@@ -5630,6 +6283,8 @@ declare namespace sap {
5630
6283
  *
5631
6284
  * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault()
5632
6285
  * on the event.
6286
+ *
6287
+ * @returns Reference to `this` in order to allow method chaining
5633
6288
  */
5634
6289
  attachDragStart(
5635
6290
  /**
@@ -5649,6 +6304,8 @@ declare namespace sap {
5649
6304
  *
5650
6305
  * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur
5651
6306
  * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event.
6307
+ *
6308
+ * @returns Reference to `this` in order to allow method chaining
5652
6309
  */
5653
6310
  attachDrop(
5654
6311
  /**
@@ -5673,6 +6330,8 @@ declare namespace sap {
5673
6330
  *
5674
6331
  * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur
5675
6332
  * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event.
6333
+ *
6334
+ * @returns Reference to `this` in order to allow method chaining
5676
6335
  */
5677
6336
  attachDrop(
5678
6337
  /**
@@ -5692,6 +6351,8 @@ declare namespace sap {
5692
6351
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5693
6352
  *
5694
6353
  * Raised when a tree item entry is expanded or collapsed.
6354
+ *
6355
+ * @returns Reference to `this` in order to allow method chaining
5695
6356
  */
5696
6357
  attachExpandedChanged(
5697
6358
  /**
@@ -5716,6 +6377,8 @@ declare namespace sap {
5716
6377
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5717
6378
  *
5718
6379
  * Raised when a tree item entry is expanded or collapsed.
6380
+ *
6381
+ * @returns Reference to `this` in order to allow method chaining
5719
6382
  */
5720
6383
  attachExpandedChanged(
5721
6384
  /**
@@ -5735,6 +6398,8 @@ declare namespace sap {
5735
6398
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5736
6399
  *
5737
6400
  * Raised when the fixed columns are updated.
6401
+ *
6402
+ * @returns Reference to `this` in order to allow method chaining
5738
6403
  */
5739
6404
  attachFixedColumnsChanged(
5740
6405
  /**
@@ -5759,6 +6424,8 @@ declare namespace sap {
5759
6424
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5760
6425
  *
5761
6426
  * Raised when the fixed columns are updated.
6427
+ *
6428
+ * @returns Reference to `this` in order to allow method chaining
5762
6429
  */
5763
6430
  attachFixedColumnsChanged(
5764
6431
  /**
@@ -5778,6 +6445,8 @@ declare namespace sap {
5778
6445
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5779
6446
  *
5780
6447
  * Raised when the tree hierarchy (the set of parent child relationships) changes.
6448
+ *
6449
+ * @returns Reference to `this` in order to allow method chaining
5781
6450
  */
5782
6451
  attachHierarchyChanged(
5783
6452
  /**
@@ -5802,6 +6471,8 @@ declare namespace sap {
5802
6471
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5803
6472
  *
5804
6473
  * Raised when the tree hierarchy (the set of parent child relationships) changes.
6474
+ *
6475
+ * @returns Reference to `this` in order to allow method chaining
5805
6476
  */
5806
6477
  attachHierarchyChanged(
5807
6478
  /**
@@ -5821,6 +6492,8 @@ declare namespace sap {
5821
6492
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5822
6493
  *
5823
6494
  * Raised when a tree item message status icon is clicked.
6495
+ *
6496
+ * @returns Reference to `this` in order to allow method chaining
5824
6497
  */
5825
6498
  attachMessageStatusHeaderIconClicked(
5826
6499
  /**
@@ -5845,6 +6518,8 @@ declare namespace sap {
5845
6518
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5846
6519
  *
5847
6520
  * Raised when a tree item message status icon is clicked.
6521
+ *
6522
+ * @returns Reference to `this` in order to allow method chaining
5848
6523
  */
5849
6524
  attachMessageStatusHeaderIconClicked(
5850
6525
  /**
@@ -5864,6 +6539,8 @@ declare namespace sap {
5864
6539
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5865
6540
  *
5866
6541
  * Raised when a tree item message status icon is clicked.
6542
+ *
6543
+ * @returns Reference to `this` in order to allow method chaining
5867
6544
  */
5868
6545
  attachMessageStatusIconClicked(
5869
6546
  /**
@@ -5888,6 +6565,8 @@ declare namespace sap {
5888
6565
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5889
6566
  *
5890
6567
  * Raised when a tree item message status icon is clicked.
6568
+ *
6569
+ * @returns Reference to `this` in order to allow method chaining
5891
6570
  */
5892
6571
  attachMessageStatusIconClicked(
5893
6572
  /**
@@ -5906,6 +6585,8 @@ declare namespace sap {
5906
6585
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5907
6586
  *
5908
6587
  * Raised after the model has been updated.
6588
+ *
6589
+ * @returns Reference to `this` in order to allow method chaining
5909
6590
  */
5910
6591
  attachModelUpdated(
5911
6592
  /**
@@ -5929,6 +6610,8 @@ declare namespace sap {
5929
6610
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5930
6611
  *
5931
6612
  * Raised after the model has been updated.
6613
+ *
6614
+ * @returns Reference to `this` in order to allow method chaining
5932
6615
  */
5933
6616
  attachModelUpdated(
5934
6617
  /**
@@ -5948,6 +6631,8 @@ declare namespace sap {
5948
6631
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5949
6632
  *
5950
6633
  * Raised when the set of selected tree items for a tree changes.
6634
+ *
6635
+ * @returns Reference to `this` in order to allow method chaining
5951
6636
  */
5952
6637
  attachSelectionChanged(
5953
6638
  /**
@@ -5972,6 +6657,8 @@ declare namespace sap {
5972
6657
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5973
6658
  *
5974
6659
  * Raised when the set of selected tree items for a tree changes.
6660
+ *
6661
+ * @returns Reference to `this` in order to allow method chaining
5975
6662
  */
5976
6663
  attachSelectionChanged(
5977
6664
  /**
@@ -5991,6 +6678,8 @@ declare namespace sap {
5991
6678
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5992
6679
  *
5993
6680
  * Raised when the icon in the visibility column header is clicked.
6681
+ *
6682
+ * @returns Reference to `this` in order to allow method chaining
5994
6683
  */
5995
6684
  attachVisibilityHeaderIconClicked(
5996
6685
  /**
@@ -6015,6 +6704,8 @@ declare namespace sap {
6015
6704
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
6016
6705
  *
6017
6706
  * Raised when the icon in the visibility column header is clicked.
6707
+ *
6708
+ * @returns Reference to `this` in order to allow method chaining
6018
6709
  */
6019
6710
  attachVisibilityHeaderIconClicked(
6020
6711
  /**
@@ -6034,6 +6725,8 @@ declare namespace sap {
6034
6725
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
6035
6726
  *
6036
6727
  * Raised when an icon in the visibility column is clicked.
6728
+ *
6729
+ * @returns Reference to `this` in order to allow method chaining
6037
6730
  */
6038
6731
  attachVisibilityIconClicked(
6039
6732
  /**
@@ -6058,6 +6751,8 @@ declare namespace sap {
6058
6751
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
6059
6752
  *
6060
6753
  * Raised when an icon in the visibility column is clicked.
6754
+ *
6755
+ * @returns Reference to `this` in order to allow method chaining
6061
6756
  */
6062
6757
  attachVisibilityIconClicked(
6063
6758
  /**
@@ -6071,10 +6766,14 @@ declare namespace sap {
6071
6766
  ): this;
6072
6767
  /**
6073
6768
  * Expands all tree items in the tree.
6769
+ *
6770
+ * @returns Returns `this` for method chaining.
6074
6771
  */
6075
6772
  collapseAll(): sap.ui.vtm.Tree;
6076
6773
  /**
6077
6774
  * Destroys all the headerControls in the aggregation {@link #getHeaderControls headerControls}.
6775
+ *
6776
+ * @returns Reference to `this` in order to allow method chaining
6078
6777
  */
6079
6778
  destroyHeaderControls(): this;
6080
6779
  /**
@@ -6082,6 +6781,8 @@ declare namespace sap {
6082
6781
  * of this `sap.ui.vtm.Tree`.
6083
6782
  *
6084
6783
  * The passed function and listener object must match the ones used for event registration.
6784
+ *
6785
+ * @returns Reference to `this` in order to allow method chaining
6085
6786
  */
6086
6787
  detachBeforeModelUpdated(
6087
6788
  /**
@@ -6098,6 +6799,8 @@ declare namespace sap {
6098
6799
  * of this `sap.ui.vtm.Tree`.
6099
6800
  *
6100
6801
  * The passed function and listener object must match the ones used for event registration.
6802
+ *
6803
+ * @returns Reference to `this` in order to allow method chaining
6101
6804
  */
6102
6805
  detachDataColumnsChanged(
6103
6806
  /**
@@ -6113,6 +6816,8 @@ declare namespace sap {
6113
6816
  * Detaches event handler `fnFunction` from the {@link #event:dragOver dragOver} event of this `sap.ui.vtm.Tree`.
6114
6817
  *
6115
6818
  * The passed function and listener object must match the ones used for event registration.
6819
+ *
6820
+ * @returns Reference to `this` in order to allow method chaining
6116
6821
  */
6117
6822
  detachDragOver(
6118
6823
  /**
@@ -6128,6 +6833,8 @@ declare namespace sap {
6128
6833
  * Detaches event handler `fnFunction` from the {@link #event:dragStart dragStart} event of this `sap.ui.vtm.Tree`.
6129
6834
  *
6130
6835
  * The passed function and listener object must match the ones used for event registration.
6836
+ *
6837
+ * @returns Reference to `this` in order to allow method chaining
6131
6838
  */
6132
6839
  detachDragStart(
6133
6840
  /**
@@ -6143,6 +6850,8 @@ declare namespace sap {
6143
6850
  * Detaches event handler `fnFunction` from the {@link #event:drop drop} event of this `sap.ui.vtm.Tree`.
6144
6851
  *
6145
6852
  * The passed function and listener object must match the ones used for event registration.
6853
+ *
6854
+ * @returns Reference to `this` in order to allow method chaining
6146
6855
  */
6147
6856
  detachDrop(
6148
6857
  /**
@@ -6159,6 +6868,8 @@ declare namespace sap {
6159
6868
  * this `sap.ui.vtm.Tree`.
6160
6869
  *
6161
6870
  * The passed function and listener object must match the ones used for event registration.
6871
+ *
6872
+ * @returns Reference to `this` in order to allow method chaining
6162
6873
  */
6163
6874
  detachExpandedChanged(
6164
6875
  /**
@@ -6175,6 +6886,8 @@ declare namespace sap {
6175
6886
  * of this `sap.ui.vtm.Tree`.
6176
6887
  *
6177
6888
  * The passed function and listener object must match the ones used for event registration.
6889
+ *
6890
+ * @returns Reference to `this` in order to allow method chaining
6178
6891
  */
6179
6892
  detachFixedColumnsChanged(
6180
6893
  /**
@@ -6191,6 +6904,8 @@ declare namespace sap {
6191
6904
  * this `sap.ui.vtm.Tree`.
6192
6905
  *
6193
6906
  * The passed function and listener object must match the ones used for event registration.
6907
+ *
6908
+ * @returns Reference to `this` in order to allow method chaining
6194
6909
  */
6195
6910
  detachHierarchyChanged(
6196
6911
  /**
@@ -6207,6 +6922,8 @@ declare namespace sap {
6207
6922
  * event of this `sap.ui.vtm.Tree`.
6208
6923
  *
6209
6924
  * The passed function and listener object must match the ones used for event registration.
6925
+ *
6926
+ * @returns Reference to `this` in order to allow method chaining
6210
6927
  */
6211
6928
  detachMessageStatusHeaderIconClicked(
6212
6929
  /**
@@ -6223,6 +6940,8 @@ declare namespace sap {
6223
6940
  * event of this `sap.ui.vtm.Tree`.
6224
6941
  *
6225
6942
  * The passed function and listener object must match the ones used for event registration.
6943
+ *
6944
+ * @returns Reference to `this` in order to allow method chaining
6226
6945
  */
6227
6946
  detachMessageStatusIconClicked(
6228
6947
  /**
@@ -6238,6 +6957,8 @@ declare namespace sap {
6238
6957
  * Detaches event handler `fnFunction` from the {@link #event:modelUpdated modelUpdated} event of this `sap.ui.vtm.Tree`.
6239
6958
  *
6240
6959
  * The passed function and listener object must match the ones used for event registration.
6960
+ *
6961
+ * @returns Reference to `this` in order to allow method chaining
6241
6962
  */
6242
6963
  detachModelUpdated(
6243
6964
  /**
@@ -6254,6 +6975,8 @@ declare namespace sap {
6254
6975
  * this `sap.ui.vtm.Tree`.
6255
6976
  *
6256
6977
  * The passed function and listener object must match the ones used for event registration.
6978
+ *
6979
+ * @returns Reference to `this` in order to allow method chaining
6257
6980
  */
6258
6981
  detachSelectionChanged(
6259
6982
  /**
@@ -6270,6 +6993,8 @@ declare namespace sap {
6270
6993
  * event of this `sap.ui.vtm.Tree`.
6271
6994
  *
6272
6995
  * The passed function and listener object must match the ones used for event registration.
6996
+ *
6997
+ * @returns Reference to `this` in order to allow method chaining
6273
6998
  */
6274
6999
  detachVisibilityHeaderIconClicked(
6275
7000
  /**
@@ -6286,6 +7011,8 @@ declare namespace sap {
6286
7011
  * event of this `sap.ui.vtm.Tree`.
6287
7012
  *
6288
7013
  * The passed function and listener object must match the ones used for event registration.
7014
+ *
7015
+ * @returns Reference to `this` in order to allow method chaining
6289
7016
  */
6290
7017
  detachVisibilityIconClicked(
6291
7018
  /**
@@ -6299,12 +7026,16 @@ declare namespace sap {
6299
7026
  ): this;
6300
7027
  /**
6301
7028
  * Expands all tree items in the tree.
7029
+ *
7030
+ * @returns Returns `this` for method chaining.
6302
7031
  */
6303
7032
  expandAll(): sap.ui.vtm.Tree;
6304
7033
  /**
6305
7034
  * Expands all ancestors of specified tree item.
6306
7035
  *
6307
7036
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7037
+ *
7038
+ * @returns Returns `this` for method chaining.
6308
7039
  */
6309
7040
  expandAncestors(
6310
7041
  /**
@@ -6314,6 +7045,8 @@ declare namespace sap {
6314
7045
  ): sap.ui.vtm.Tree;
6315
7046
  /**
6316
7047
  * Expands tree items in the tree from the root down to the given level.
7048
+ *
7049
+ * @returns Returns `this` for method chaining.
6317
7050
  */
6318
7051
  expandToLevel(
6319
7052
  /**
@@ -6323,6 +7056,8 @@ declare namespace sap {
6323
7056
  ): sap.ui.vtm.Tree;
6324
7057
  /**
6325
7058
  * Fires event {@link #event:beforeModelUpdated beforeModelUpdated} to attached listeners.
7059
+ *
7060
+ * @returns Reference to `this` in order to allow method chaining
6326
7061
  */
6327
7062
  fireBeforeModelUpdated(
6328
7063
  /**
@@ -6332,6 +7067,8 @@ declare namespace sap {
6332
7067
  ): this;
6333
7068
  /**
6334
7069
  * Fires event {@link #event:dataColumnsChanged dataColumnsChanged} to attached listeners.
7070
+ *
7071
+ * @returns Reference to `this` in order to allow method chaining
6335
7072
  */
6336
7073
  fireDataColumnsChanged(
6337
7074
  /**
@@ -6344,6 +7081,8 @@ declare namespace sap {
6344
7081
  *
6345
7082
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
6346
7083
  * event object. The return value of this method indicates whether the default action should be executed.
7084
+ *
7085
+ * @returns Whether or not to prevent the default action
6347
7086
  */
6348
7087
  fireDragOver(
6349
7088
  /**
@@ -6373,6 +7112,8 @@ declare namespace sap {
6373
7112
  *
6374
7113
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
6375
7114
  * event object. The return value of this method indicates whether the default action should be executed.
7115
+ *
7116
+ * @returns Whether or not to prevent the default action
6376
7117
  */
6377
7118
  fireDragStart(
6378
7119
  /**
@@ -6391,6 +7132,8 @@ declare namespace sap {
6391
7132
  ): boolean;
6392
7133
  /**
6393
7134
  * Fires event {@link #event:drop drop} to attached listeners.
7135
+ *
7136
+ * @returns Reference to `this` in order to allow method chaining
6394
7137
  */
6395
7138
  fireDrop(
6396
7139
  /**
@@ -6417,6 +7160,8 @@ declare namespace sap {
6417
7160
  ): this;
6418
7161
  /**
6419
7162
  * Fires event {@link #event:expandedChanged expandedChanged} to attached listeners.
7163
+ *
7164
+ * @returns Reference to `this` in order to allow method chaining
6420
7165
  */
6421
7166
  fireExpandedChanged(
6422
7167
  /**
@@ -6439,6 +7184,8 @@ declare namespace sap {
6439
7184
  ): this;
6440
7185
  /**
6441
7186
  * Fires event {@link #event:fixedColumnsChanged fixedColumnsChanged} to attached listeners.
7187
+ *
7188
+ * @returns Reference to `this` in order to allow method chaining
6442
7189
  */
6443
7190
  fireFixedColumnsChanged(
6444
7191
  /**
@@ -6448,6 +7195,8 @@ declare namespace sap {
6448
7195
  ): this;
6449
7196
  /**
6450
7197
  * Fires event {@link #event:hierarchyChanged hierarchyChanged} to attached listeners.
7198
+ *
7199
+ * @returns Reference to `this` in order to allow method chaining
6451
7200
  */
6452
7201
  fireHierarchyChanged(
6453
7202
  /**
@@ -6458,6 +7207,8 @@ declare namespace sap {
6458
7207
  /**
6459
7208
  * Fires event {@link #event:messageStatusHeaderIconClicked messageStatusHeaderIconClicked} to attached
6460
7209
  * listeners.
7210
+ *
7211
+ * @returns Reference to `this` in order to allow method chaining
6461
7212
  */
6462
7213
  fireMessageStatusHeaderIconClicked(
6463
7214
  /**
@@ -6467,6 +7218,8 @@ declare namespace sap {
6467
7218
  ): this;
6468
7219
  /**
6469
7220
  * Fires event {@link #event:messageStatusIconClicked messageStatusIconClicked} to attached listeners.
7221
+ *
7222
+ * @returns Reference to `this` in order to allow method chaining
6470
7223
  */
6471
7224
  fireMessageStatusIconClicked(
6472
7225
  /**
@@ -6485,6 +7238,8 @@ declare namespace sap {
6485
7238
  ): this;
6486
7239
  /**
6487
7240
  * Fires event {@link #event:modelUpdated modelUpdated} to attached listeners.
7241
+ *
7242
+ * @returns Reference to `this` in order to allow method chaining
6488
7243
  */
6489
7244
  fireModelUpdated(
6490
7245
  /**
@@ -6494,6 +7249,8 @@ declare namespace sap {
6494
7249
  ): this;
6495
7250
  /**
6496
7251
  * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
7252
+ *
7253
+ * @returns Reference to `this` in order to allow method chaining
6497
7254
  */
6498
7255
  fireSelectionChanged(
6499
7256
  /**
@@ -6516,6 +7273,8 @@ declare namespace sap {
6516
7273
  ): this;
6517
7274
  /**
6518
7275
  * Fires event {@link #event:visibilityHeaderIconClicked visibilityHeaderIconClicked} to attached listeners.
7276
+ *
7277
+ * @returns Reference to `this` in order to allow method chaining
6519
7278
  */
6520
7279
  fireVisibilityHeaderIconClicked(
6521
7280
  /**
@@ -6534,6 +7293,8 @@ declare namespace sap {
6534
7293
  ): this;
6535
7294
  /**
6536
7295
  * Fires event {@link #event:visibilityIconClicked visibilityIconClicked} to attached listeners.
7296
+ *
7297
+ * @returns Reference to `this` in order to allow method chaining
6537
7298
  */
6538
7299
  fireVisibilityIconClicked(
6539
7300
  /**
@@ -6558,6 +7319,8 @@ declare namespace sap {
6558
7319
  * Finds all tree items in the tree of a given type.
6559
7320
  *
6560
7321
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7322
+ *
7323
+ * @returns All the tree items in the tree.
6561
7324
  */
6562
7325
  getAllItems(
6563
7326
  /**
@@ -6575,6 +7338,8 @@ declare namespace sap {
6575
7338
  * - The parent item will be last element in the array.
6576
7339
  *
6577
7340
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7341
+ *
7342
+ * @returns The ancestors of the tree item.
6578
7343
  */
6579
7344
  getAncestorItems(
6580
7345
  /**
@@ -6584,12 +7349,16 @@ declare namespace sap {
6584
7349
  ): object[];
6585
7350
  /**
6586
7351
  * Gets the set of data columns for the tree.
7352
+ *
7353
+ * @returns The data columns for the tree.
6587
7354
  */
6588
7355
  getDataColumns(): sap.ui.vtm.Column[];
6589
7356
  /**
6590
7357
  * Gets the descendants of a tree item.
6591
7358
  *
6592
7359
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7360
+ *
7361
+ * @returns The descendants of the tree item or undefined if the tree item is not found.
6593
7362
  */
6594
7363
  getDescendantItems(
6595
7364
  /**
@@ -6605,6 +7374,8 @@ declare namespace sap {
6605
7374
  * Gets whether the row associated with a tree item is expanded.
6606
7375
  *
6607
7376
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7377
+ *
7378
+ * @returns Whether the row associated with the specified tree item is expanded.
6608
7379
  */
6609
7380
  getExpanded(
6610
7381
  /**
@@ -6614,6 +7385,8 @@ declare namespace sap {
6614
7385
  ): boolean;
6615
7386
  /**
6616
7387
  * Gets the fixed columns for the tree.
7388
+ *
7389
+ * @returns The fixed columns.
6617
7390
  */
6618
7391
  getFixedColumns(): sap.ui.vtm.Column[];
6619
7392
  /**
@@ -6627,6 +7400,9 @@ declare namespace sap {
6627
7400
  *
6628
7401
  * If a single tree item is passed to the method then a single value is returned.
6629
7402
  * If an array of tree items is passed to the method then an array is returned.
7403
+ *
7404
+ * @returns A single value or an array of values representing the highlight color values of the tree item(s)
7405
+ * passed in.
6630
7406
  */
6631
7407
  getHighlightColor(
6632
7408
  /**
@@ -6637,6 +7413,8 @@ declare namespace sap {
6637
7413
  /**
6638
7414
  * Finds a tree item by id or returns undefined if it is not found.
6639
7415
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7416
+ *
7417
+ * @returns The tree item matching the specified id or undefined if no match was found.
6640
7418
  */
6641
7419
  getItem(
6642
7420
  /**
@@ -6647,6 +7425,8 @@ declare namespace sap {
6647
7425
  /**
6648
7426
  * Finds a tree item by binding context path or returns undefined if it is not found. This is typically
6649
7427
  * used to find the corresponding tree item in event handlers for custom column template controls.
7428
+ *
7429
+ * @returns The tree item matching the specified binding context path or undefined if no match was found.
6650
7430
  */
6651
7431
  getItemByBindingContextPath(
6652
7432
  /**
@@ -6658,6 +7438,9 @@ declare namespace sap {
6658
7438
  * Finds the set of tree items that are associated with a particular scene node id.
6659
7439
  *
6660
7440
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7441
+ *
7442
+ * @returns The set of tree items that have a `sceneNodeIds` property that contains the specified scene
7443
+ * node id.
6661
7444
  */
6662
7445
  getItemsBySceneNodeId(
6663
7446
  /**
@@ -6674,6 +7457,9 @@ declare namespace sap {
6674
7457
  *
6675
7458
  * If a single tree item is passed to the method then a single value is returned.
6676
7459
  * If an array of tree items is passed to the method then an array is returned.
7460
+ *
7461
+ * @returns A single value or an array of values representing the opacity values of the tree item(s) passed
7462
+ * in.
6677
7463
  */
6678
7464
  getOpacity(
6679
7465
  /**
@@ -6683,12 +7469,16 @@ declare namespace sap {
6683
7469
  ): float | float[];
6684
7470
  /**
6685
7471
  * Gets the panel this tree belongs to.
7472
+ *
7473
+ * @returns The panel this tree belongs to.
6686
7474
  */
6687
7475
  getPanel(): sap.ui.vtm.Panel;
6688
7476
  /**
6689
7477
  * Finds a parent tree item or returns undefined if it is not found.
6690
7478
  *
6691
7479
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7480
+ *
7481
+ * @returns The parent tree item or undefined if no match was found.
6692
7482
  */
6693
7483
  getParentItem(
6694
7484
  /**
@@ -6698,10 +7488,14 @@ declare namespace sap {
6698
7488
  ): object | undefined;
6699
7489
  /**
6700
7490
  * Gets the root tree items.
7491
+ *
7492
+ * @returns The root tree items.
6701
7493
  */
6702
7494
  getRootItems(): object[];
6703
7495
  /**
6704
7496
  * Gets the selected tree items.
7497
+ *
7498
+ * @returns The selected tree items.
6705
7499
  */
6706
7500
  getSelectedItems(): object[];
6707
7501
  /**
@@ -6710,6 +7504,8 @@ declare namespace sap {
6710
7504
  * The tree selection mode.
6711
7505
  *
6712
7506
  * Default value is `"Single"`.
7507
+ *
7508
+ * @returns Value of property `selectionMode`
6713
7509
  */
6714
7510
  getSelectionMode(): sap.ui.vtm.SelectionMode;
6715
7511
  /**
@@ -6717,6 +7513,9 @@ declare namespace sap {
6717
7513
  *
6718
7514
  * If a single tree item is passed to the method then a single value is returned.
6719
7515
  * If an array of tree items is passed to the method then an array is returned.
7516
+ *
7517
+ * @returns A single value or an array of values where the value is `true` if the tree item is visible,
7518
+ * `false` otherwise.
6720
7519
  */
6721
7520
  getVisibility(
6722
7521
  /**
@@ -6727,6 +7526,8 @@ declare namespace sap {
6727
7526
  /**
6728
7527
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeaderControls headerControls}.
6729
7528
  * and returns its index if found or -1 otherwise.
7529
+ *
7530
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
6730
7531
  */
6731
7532
  indexOfHeaderControl(
6732
7533
  /**
@@ -6736,6 +7537,8 @@ declare namespace sap {
6736
7537
  ): int;
6737
7538
  /**
6738
7539
  * Inserts a headerControl into the aggregation {@link #getHeaderControls headerControls}.
7540
+ *
7541
+ * @returns Reference to `this` in order to allow method chaining
6739
7542
  */
6740
7543
  insertHeaderControl(
6741
7544
  /**
@@ -6751,12 +7554,16 @@ declare namespace sap {
6751
7554
  ): this;
6752
7555
  /**
6753
7556
  * Returns whether the tree is empty.
7557
+ *
7558
+ * @returns Whether the tree is empty.
6754
7559
  */
6755
7560
  isEmpty(): boolean;
6756
7561
  /**
6757
7562
  * Returns whether a tree item object is an excluded tree item in the tree model of this {@link sap.ui.vtm.Tree}.
6758
7563
  *
6759
7564
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7565
+ *
7566
+ * @returns Whether a tree item object is an included tree item in this tree.
6760
7567
  */
6761
7568
  isExcludedItem(
6762
7569
  /**
@@ -6768,6 +7575,8 @@ declare namespace sap {
6768
7575
  * Returns whether a tree item object is an included tree item in the tree model of this {@link sap.ui.vtm.Tree}.
6769
7576
  *
6770
7577
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7578
+ *
7579
+ * @returns Whether a tree item object is an included tree item in this tree.
6771
7580
  */
6772
7581
  isIncludedItem(
6773
7582
  /**
@@ -6779,10 +7588,14 @@ declare namespace sap {
6779
7588
  * Removes all the controls from the aggregation {@link #getHeaderControls headerControls}.
6780
7589
  *
6781
7590
  * Additionally, it unregisters them from the hosting UIArea.
7591
+ *
7592
+ * @returns An array of the removed elements (might be empty)
6782
7593
  */
6783
7594
  removeAllHeaderControls(): sap.ui.core.Control[];
6784
7595
  /**
6785
7596
  * Removes a headerControl from the aggregation {@link #getHeaderControls headerControls}.
7597
+ *
7598
+ * @returns The removed headerControl or `null`
6786
7599
  */
6787
7600
  removeHeaderControl(
6788
7601
  /**
@@ -6792,6 +7605,8 @@ declare namespace sap {
6792
7605
  ): sap.ui.core.Control;
6793
7606
  /**
6794
7607
  * Removes a root item from the tree.
7608
+ *
7609
+ * @returns Returns the deleted item or undefined if no item was removed.
6795
7610
  */
6796
7611
  removeRoot(
6797
7612
  /**
@@ -6803,6 +7618,8 @@ declare namespace sap {
6803
7618
  * Brings specified tree item to view, expanding the tree if necessary.
6804
7619
  *
6805
7620
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7621
+ *
7622
+ * @returns Returns `this` for method chaining.
6806
7623
  */
6807
7624
  scrollIntoView(
6808
7625
  /**
@@ -6812,6 +7629,8 @@ declare namespace sap {
6812
7629
  ): sap.ui.vtm.Tree;
6813
7630
  /**
6814
7631
  * Sets the data columns for the tree.
7632
+ *
7633
+ * @returns Returns `this` for method chaining.
6815
7634
  */
6816
7635
  setDataColumns(
6817
7636
  /**
@@ -6823,6 +7642,8 @@ declare namespace sap {
6823
7642
  * Expands or collapses the row associated with a tree item.
6824
7643
  *
6825
7644
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7645
+ *
7646
+ * @returns A reference to `this` for method chaining.
6826
7647
  */
6827
7648
  setExpanded(
6828
7649
  /**
@@ -6836,6 +7657,8 @@ declare namespace sap {
6836
7657
  ): sap.ui.vtm.Tree;
6837
7658
  /**
6838
7659
  * Sets the fixed columns for the tree.
7660
+ *
7661
+ * @returns Returns `this` for method chaining.
6839
7662
  */
6840
7663
  setFixedColumns(
6841
7664
  /**
@@ -6845,6 +7668,8 @@ declare namespace sap {
6845
7668
  ): sap.ui.vtm.Tree;
6846
7669
  /**
6847
7670
  * Sets the `highlightColor` property of some tree items.
7671
+ *
7672
+ * @returns `this` to allow method chaining.
6848
7673
  */
6849
7674
  setHighlightColor(
6850
7675
  /**
@@ -6874,6 +7699,8 @@ declare namespace sap {
6874
7699
  ): sap.ui.vtm.Tree;
6875
7700
  /**
6876
7701
  * Sets the `opacity` property of some tree items.
7702
+ *
7703
+ * @returns `this` to allow method chaining.
6877
7704
  */
6878
7705
  setOpacity(
6879
7706
  /**
@@ -6903,6 +7730,8 @@ declare namespace sap {
6903
7730
  ): sap.ui.vtm.Tree;
6904
7731
  /**
6905
7732
  * Sets the root tree items.
7733
+ *
7734
+ * @returns Returns `this` for method chaining.
6906
7735
  */
6907
7736
  setRootItems(
6908
7737
  /**
@@ -6914,6 +7743,8 @@ declare namespace sap {
6914
7743
  * Sets the selected tree items.
6915
7744
  *
6916
7745
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7746
+ *
7747
+ * @returns Returns `this` for method chaining.
6917
7748
  */
6918
7749
  setSelectedItems(
6919
7750
  /**
@@ -6933,6 +7764,8 @@ declare namespace sap {
6933
7764
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6934
7765
  *
6935
7766
  * Default value is `"Single"`.
7767
+ *
7768
+ * @returns Reference to `this` in order to allow method chaining
6936
7769
  */
6937
7770
  setSelectionMode(
6938
7771
  /**
@@ -6942,6 +7775,8 @@ declare namespace sap {
6942
7775
  ): this;
6943
7776
  /**
6944
7777
  * Sets the `visibility` property of some tree items.
7778
+ *
7779
+ * @returns `this` to allow method chaining.
6945
7780
  */
6946
7781
  setVisibility(
6947
7782
  /**
@@ -6972,6 +7807,8 @@ declare namespace sap {
6972
7807
  /**
6973
7808
  * Recursively traverses a tree branch calling a function on each item (including the tree item that is
6974
7809
  * the root of the branch).
7810
+ *
7811
+ * @returns `this` to allow method chaining.
6975
7812
  */
6976
7813
  traverseBranch(
6977
7814
  /**
@@ -6992,6 +7829,8 @@ declare namespace sap {
6992
7829
  ): sap.ui.vtm.Tree;
6993
7830
  /**
6994
7831
  * Recursively traverses the tree calling a function on each item.
7832
+ *
7833
+ * @returns `this` to allow method chaining.
6995
7834
  */
6996
7835
  traverseTree(
6997
7836
  /**
@@ -7030,6 +7869,8 @@ declare namespace sap {
7030
7869
  * ***** When the only changes to the tree since the last call to {@link #updateCollections} are changes
7031
7870
  * to the sceneNodeIds properties of the tree items, {@link #updateTreeItemsBySceneNodeId} can
7032
7871
  * be used instead of {@link #updateCollections}.
7872
+ *
7873
+ * @returns Returns `this` for method chaining.
7033
7874
  */
7034
7875
  updateCollections(
7035
7876
  /**
@@ -7044,6 +7885,8 @@ declare namespace sap {
7044
7885
  * Updates the model.
7045
7886
  *
7046
7887
  * The application should call this whenever changes are made to the tree model.
7888
+ *
7889
+ * @returns Returns `this` for method chaining.
7047
7890
  */
7048
7891
  updateModel(
7049
7892
  /**
@@ -7059,10 +7902,14 @@ declare namespace sap {
7059
7902
  *
7060
7903
  * This is useful when the only changes to the tree since the last call to {@link #updateCollections} are
7061
7904
  * changes to the sceneNodeIds properties of the tree items.
7905
+ *
7906
+ * @returns Returns `this` for method chaining.
7062
7907
  */
7063
7908
  updateTreeItemsBySceneNodeId(): sap.ui.vtm.Tree;
7064
7909
  /**
7065
7910
  * Validates the tree. If errors are found they are written to the console log and an exception is thrown.
7911
+ *
7912
+ * @returns `this` for method chaining.
7066
7913
  */
7067
7914
  validateTree(): sap.ui.vtm.Tree;
7068
7915
  }
@@ -7095,6 +7942,8 @@ declare namespace sap {
7095
7942
  * contained in `oClassInfo`.
7096
7943
  *
7097
7944
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
7945
+ *
7946
+ * @returns Created class / constructor function
7098
7947
  */
7099
7948
  static extend<T extends Record<string, unknown>>(
7100
7949
  /**
@@ -7113,12 +7962,16 @@ declare namespace sap {
7113
7962
  ): Function;
7114
7963
  /**
7115
7964
  * Returns a metadata object for class sap.ui.vtm.Viewable.
7965
+ *
7966
+ * @returns Metadata object describing this class
7116
7967
  */
7117
7968
  static getMetadata(): sap.ui.core.ElementMetadata;
7118
7969
  /**
7119
7970
  * Gets current value of property {@link #getName name}.
7120
7971
  *
7121
7972
  * The name for this Viewable.
7973
+ *
7974
+ * @returns Value of property `name`
7122
7975
  */
7123
7976
  getName(): string;
7124
7977
  /**
@@ -7126,31 +7979,43 @@ declare namespace sap {
7126
7979
  *
7127
7980
  * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded
7128
7981
  * viewable.
7982
+ *
7983
+ * @returns Value of property `relativeMatrix`
7129
7984
  */
7130
7985
  getRelativeMatrix(): sap.ui.vtm.Matrix;
7131
7986
  /**
7132
7987
  * Gets current value of property {@link #getRootNodeIds rootNodeIds}.
7133
7988
  *
7134
7989
  * The root scene node IDs for this viewable.
7990
+ *
7991
+ * @returns Value of property `rootNodeIds`
7135
7992
  */
7136
7993
  getRootNodeIds(): string[];
7137
7994
  /**
7138
7995
  * Gets current value of property {@link #getSource source}.
7139
7996
  *
7140
7997
  * The source URL (string) or File for this Viewable.
7998
+ *
7999
+ * @returns Value of property `source`
7141
8000
  */
7142
8001
  getSource(): any;
7143
8002
  /**
7144
8003
  * Gets the unique ID that identifies this Viewable. This is an alias for {@link #getId}
8004
+ *
8005
+ * @returns The unique ID that identifies this Viewable.
7145
8006
  */
7146
8007
  getSourceId(): string;
7147
8008
  /**
7148
8009
  * Returns a string representation of the source. If the source is a {@link File} this returns the file
7149
8010
  * name (which is not guaranteed to uniquely identify the file).
8011
+ *
8012
+ * @returns A string representation of the source.
7150
8013
  */
7151
8014
  getSourceString(): string;
7152
8015
  /**
7153
8016
  * Sets the name for this Viewable.
8017
+ *
8018
+ * @returns `this` for method chaining.
7154
8019
  */
7155
8020
  setName(
7156
8021
  /**
@@ -7165,6 +8030,8 @@ declare namespace sap {
7165
8030
  * viewable.
7166
8031
  *
7167
8032
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8033
+ *
8034
+ * @returns Reference to `this` in order to allow method chaining
7168
8035
  */
7169
8036
  setRelativeMatrix(
7170
8037
  /**
@@ -7178,6 +8045,8 @@ declare namespace sap {
7178
8045
  * The root scene node IDs for this viewable.
7179
8046
  *
7180
8047
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8048
+ *
8049
+ * @returns Reference to `this` in order to allow method chaining
7181
8050
  */
7182
8051
  setRootNodeIds(
7183
8052
  /**
@@ -7187,6 +8056,8 @@ declare namespace sap {
7187
8056
  ): this;
7188
8057
  /**
7189
8058
  * Sets the source URL or File for this Viewable.
8059
+ *
8060
+ * @returns `this` for method chaining.
7190
8061
  */
7191
8062
  setSource(
7192
8063
  /**
@@ -7220,6 +8091,8 @@ declare namespace sap {
7220
8091
  * the information contained in `oClassInfo`.
7221
8092
  *
7222
8093
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
8094
+ *
8095
+ * @returns Created class / constructor function
7223
8096
  */
7224
8097
  static extend<T extends Record<string, unknown>>(
7225
8098
  /**
@@ -7238,6 +8111,8 @@ declare namespace sap {
7238
8111
  ): Function;
7239
8112
  /**
7240
8113
  * Returns a metadata object for class sap.ui.vtm.ViewableLoadInfo.
8114
+ *
8115
+ * @returns Metadata object describing this class
7241
8116
  */
7242
8117
  static getMetadata(): sap.ui.core.ElementMetadata;
7243
8118
  /**
@@ -7246,6 +8121,8 @@ declare namespace sap {
7246
8121
  * The error code describing why the Viewable failed to load.
7247
8122
  *
7248
8123
  * Use when {@link #getSucceeded} returns false.
8124
+ *
8125
+ * @returns Value of property `errorCode`
7249
8126
  */
7250
8127
  getErrorCode(): string;
7251
8128
  /**
@@ -7253,6 +8130,8 @@ declare namespace sap {
7253
8130
  *
7254
8131
  * The error text describing why the Viewable failed to load. This is an untranslated technical message.
7255
8132
  * Use when {@link #getSucceeded} returns false.
8133
+ *
8134
+ * @returns Value of property `errorText`
7256
8135
  */
7257
8136
  getErrorText(): string;
7258
8137
  /**
@@ -7260,12 +8139,16 @@ declare namespace sap {
7260
8139
  *
7261
8140
  * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo}
7262
8141
  * relates to.
8142
+ *
8143
+ * @returns Value of property `status`
7263
8144
  */
7264
8145
  getStatus(): sap.ui.vtm.ViewableLoadStatus;
7265
8146
  /**
7266
8147
  * Gets current value of property {@link #getViewable viewable}.
7267
8148
  *
7268
8149
  * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to.
8150
+ *
8151
+ * @returns Value of property `viewable`
7269
8152
  */
7270
8153
  getViewable(): object;
7271
8154
  /**
@@ -7276,6 +8159,8 @@ declare namespace sap {
7276
8159
  * Use when {@link #getSucceeded} returns false.
7277
8160
  *
7278
8161
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8162
+ *
8163
+ * @returns Reference to `this` in order to allow method chaining
7279
8164
  */
7280
8165
  setErrorCode(
7281
8166
  /**
@@ -7290,6 +8175,8 @@ declare namespace sap {
7290
8175
  * Use when {@link #getSucceeded} returns false.
7291
8176
  *
7292
8177
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8178
+ *
8179
+ * @returns Reference to `this` in order to allow method chaining
7293
8180
  */
7294
8181
  setErrorText(
7295
8182
  /**
@@ -7304,6 +8191,8 @@ declare namespace sap {
7304
8191
  * relates to.
7305
8192
  *
7306
8193
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8194
+ *
8195
+ * @returns Reference to `this` in order to allow method chaining
7307
8196
  */
7308
8197
  setStatus(
7309
8198
  /**
@@ -7317,6 +8206,8 @@ declare namespace sap {
7317
8206
  * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to.
7318
8207
  *
7319
8208
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8209
+ *
8210
+ * @returns Reference to `this` in order to allow method chaining
7320
8211
  */
7321
8212
  setViewable(
7322
8213
  /**
@@ -7346,6 +8237,8 @@ declare namespace sap {
7346
8237
  * contained in `oClassInfo`.
7347
8238
  *
7348
8239
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
8240
+ *
8241
+ * @returns Created class / constructor function
7349
8242
  */
7350
8243
  static extend<T extends Record<string, unknown>>(
7351
8244
  /**
@@ -7364,10 +8257,14 @@ declare namespace sap {
7364
8257
  ): Function;
7365
8258
  /**
7366
8259
  * Returns a metadata object for class sap.ui.vtm.Viewport.
8260
+ *
8261
+ * @returns Metadata object describing this class
7367
8262
  */
7368
8263
  static getMetadata(): sap.ui.core.ElementMetadata;
7369
8264
  /**
7370
8265
  * Adds an override display group to the `overrideDisplayGroups` property.
8266
+ *
8267
+ * @returns `this` for method chaining.
7371
8268
  */
7372
8269
  addContextDisplayGroup(
7373
8270
  /**
@@ -7377,6 +8274,8 @@ declare namespace sap {
7377
8274
  ): sap.ui.vtm.Viewport;
7378
8275
  /**
7379
8276
  * Adds some headerControl into the association {@link #getHeaderControls headerControls}.
8277
+ *
8278
+ * @returns Reference to `this` in order to allow method chaining
7380
8279
  */
7381
8280
  addHeaderControl(
7382
8281
  /**
@@ -7386,6 +8285,8 @@ declare namespace sap {
7386
8285
  ): this;
7387
8286
  /**
7388
8287
  * Adds an override display group to the `overrideDisplayGroups` property.
8288
+ *
8289
+ * @returns `this` for method chaining.
7389
8290
  */
7390
8291
  addOverrideDisplayGroup(
7391
8292
  /**
@@ -7400,6 +8301,8 @@ declare namespace sap {
7400
8301
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7401
8302
  *
7402
8303
  * Raised when a gesture begins.
8304
+ *
8305
+ * @returns Reference to `this` in order to allow method chaining
7403
8306
  */
7404
8307
  attachBeginGesture(
7405
8308
  /**
@@ -7423,6 +8326,8 @@ declare namespace sap {
7423
8326
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7424
8327
  *
7425
8328
  * Raised when a gesture begins.
8329
+ *
8330
+ * @returns Reference to `this` in order to allow method chaining
7426
8331
  */
7427
8332
  attachBeginGesture(
7428
8333
  /**
@@ -7441,6 +8346,8 @@ declare namespace sap {
7441
8346
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7442
8347
  *
7443
8348
  * Raised when a gesture ends.
8349
+ *
8350
+ * @returns Reference to `this` in order to allow method chaining
7444
8351
  */
7445
8352
  attachEndGesture(
7446
8353
  /**
@@ -7464,6 +8371,8 @@ declare namespace sap {
7464
8371
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7465
8372
  *
7466
8373
  * Raised when a gesture ends.
8374
+ *
8375
+ * @returns Reference to `this` in order to allow method chaining
7467
8376
  */
7468
8377
  attachEndGesture(
7469
8378
  /**
@@ -7482,6 +8391,8 @@ declare namespace sap {
7482
8391
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7483
8392
  *
7484
8393
  * Raised on mouse move over viewport.
8394
+ *
8395
+ * @returns Reference to `this` in order to allow method chaining
7485
8396
  */
7486
8397
  attachHover(
7487
8398
  /**
@@ -7505,6 +8416,8 @@ declare namespace sap {
7505
8416
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7506
8417
  *
7507
8418
  * Raised on mouse move over viewport.
8419
+ *
8420
+ * @returns Reference to `this` in order to allow method chaining
7508
8421
  */
7509
8422
  attachHover(
7510
8423
  /**
@@ -7523,6 +8436,8 @@ declare namespace sap {
7523
8436
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7524
8437
  *
7525
8438
  * Raised when a node in the viewport is clicked.
8439
+ *
8440
+ * @returns Reference to `this` in order to allow method chaining
7526
8441
  */
7527
8442
  attachNodeClicked(
7528
8443
  /**
@@ -7546,6 +8461,8 @@ declare namespace sap {
7546
8461
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7547
8462
  *
7548
8463
  * Raised when a node in the viewport is clicked.
8464
+ *
8465
+ * @returns Reference to `this` in order to allow method chaining
7549
8466
  */
7550
8467
  attachNodeClicked(
7551
8468
  /**
@@ -7566,6 +8483,8 @@ declare namespace sap {
7566
8483
  *
7567
8484
  * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code
7568
8485
  * that is managing the viewport display state.
8486
+ *
8487
+ * @returns Reference to `this` in order to allow method chaining
7569
8488
  */
7570
8489
  attachRefreshRequested(
7571
8490
  /**
@@ -7591,6 +8510,8 @@ declare namespace sap {
7591
8510
  *
7592
8511
  * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code
7593
8512
  * that is managing the viewport display state.
8513
+ *
8514
+ * @returns Reference to `this` in order to allow method chaining
7594
8515
  */
7595
8516
  attachRefreshRequested(
7596
8517
  /**
@@ -7610,6 +8531,8 @@ declare namespace sap {
7610
8531
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7611
8532
  *
7612
8533
  * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space).
8534
+ *
8535
+ * @returns Reference to `this` in order to allow method chaining
7613
8536
  */
7614
8537
  attachSelectionChanged(
7615
8538
  /**
@@ -7634,6 +8557,8 @@ declare namespace sap {
7634
8557
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7635
8558
  *
7636
8559
  * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space).
8560
+ *
8561
+ * @returns Reference to `this` in order to allow method chaining
7637
8562
  */
7638
8563
  attachSelectionChanged(
7639
8564
  /**
@@ -7652,6 +8577,8 @@ declare namespace sap {
7652
8577
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7653
8578
  *
7654
8579
  * Raised when viewport's camera view changed.
8580
+ *
8581
+ * @returns Reference to `this` in order to allow method chaining
7655
8582
  */
7656
8583
  attachViewChanged(
7657
8584
  /**
@@ -7675,6 +8602,8 @@ declare namespace sap {
7675
8602
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7676
8603
  *
7677
8604
  * Raised when viewport's camera view changed.
8605
+ *
8606
+ * @returns Reference to `this` in order to allow method chaining
7678
8607
  */
7679
8608
  attachViewChanged(
7680
8609
  /**
@@ -7694,6 +8623,8 @@ declare namespace sap {
7694
8623
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7695
8624
  *
7696
8625
  * Raised when the visibility of scene nodes changed in the viewport.
8626
+ *
8627
+ * @returns Reference to `this` in order to allow method chaining
7697
8628
  */
7698
8629
  attachVisibilityChanged(
7699
8630
  /**
@@ -7718,6 +8649,8 @@ declare namespace sap {
7718
8649
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7719
8650
  *
7720
8651
  * Raised when the visibility of scene nodes changed in the viewport.
8652
+ *
8653
+ * @returns Reference to `this` in order to allow method chaining
7721
8654
  */
7722
8655
  attachVisibilityChanged(
7723
8656
  /**
@@ -7733,6 +8666,8 @@ declare namespace sap {
7733
8666
  * Detaches event handler `fnFunction` from the {@link #event:beginGesture beginGesture} event of this `sap.ui.vtm.Viewport`.
7734
8667
  *
7735
8668
  * The passed function and listener object must match the ones used for event registration.
8669
+ *
8670
+ * @returns Reference to `this` in order to allow method chaining
7736
8671
  */
7737
8672
  detachBeginGesture(
7738
8673
  /**
@@ -7748,6 +8683,8 @@ declare namespace sap {
7748
8683
  * Detaches event handler `fnFunction` from the {@link #event:endGesture endGesture} event of this `sap.ui.vtm.Viewport`.
7749
8684
  *
7750
8685
  * The passed function and listener object must match the ones used for event registration.
8686
+ *
8687
+ * @returns Reference to `this` in order to allow method chaining
7751
8688
  */
7752
8689
  detachEndGesture(
7753
8690
  /**
@@ -7763,6 +8700,8 @@ declare namespace sap {
7763
8700
  * Detaches event handler `fnFunction` from the {@link #event:hover hover} event of this `sap.ui.vtm.Viewport`.
7764
8701
  *
7765
8702
  * The passed function and listener object must match the ones used for event registration.
8703
+ *
8704
+ * @returns Reference to `this` in order to allow method chaining
7766
8705
  */
7767
8706
  detachHover(
7768
8707
  /**
@@ -7778,6 +8717,8 @@ declare namespace sap {
7778
8717
  * Detaches event handler `fnFunction` from the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vtm.Viewport`.
7779
8718
  *
7780
8719
  * The passed function and listener object must match the ones used for event registration.
8720
+ *
8721
+ * @returns Reference to `this` in order to allow method chaining
7781
8722
  */
7782
8723
  detachNodeClicked(
7783
8724
  /**
@@ -7794,6 +8735,8 @@ declare namespace sap {
7794
8735
  * this `sap.ui.vtm.Viewport`.
7795
8736
  *
7796
8737
  * The passed function and listener object must match the ones used for event registration.
8738
+ *
8739
+ * @returns Reference to `this` in order to allow method chaining
7797
8740
  */
7798
8741
  detachRefreshRequested(
7799
8742
  /**
@@ -7810,6 +8753,8 @@ declare namespace sap {
7810
8753
  * this `sap.ui.vtm.Viewport`.
7811
8754
  *
7812
8755
  * The passed function and listener object must match the ones used for event registration.
8756
+ *
8757
+ * @returns Reference to `this` in order to allow method chaining
7813
8758
  */
7814
8759
  detachSelectionChanged(
7815
8760
  /**
@@ -7825,6 +8770,8 @@ declare namespace sap {
7825
8770
  * Detaches event handler `fnFunction` from the {@link #event:viewChanged viewChanged} event of this `sap.ui.vtm.Viewport`.
7826
8771
  *
7827
8772
  * The passed function and listener object must match the ones used for event registration.
8773
+ *
8774
+ * @returns Reference to `this` in order to allow method chaining
7828
8775
  */
7829
8776
  detachViewChanged(
7830
8777
  /**
@@ -7841,6 +8788,8 @@ declare namespace sap {
7841
8788
  * of this `sap.ui.vtm.Viewport`.
7842
8789
  *
7843
8790
  * The passed function and listener object must match the ones used for event registration.
8791
+ *
8792
+ * @returns Reference to `this` in order to allow method chaining
7844
8793
  */
7845
8794
  detachVisibilityChanged(
7846
8795
  /**
@@ -7854,6 +8803,8 @@ declare namespace sap {
7854
8803
  ): this;
7855
8804
  /**
7856
8805
  * Fires event {@link #event:beginGesture beginGesture} to attached listeners.
8806
+ *
8807
+ * @returns Reference to `this` in order to allow method chaining
7857
8808
  */
7858
8809
  fireBeginGesture(
7859
8810
  /**
@@ -7863,6 +8814,8 @@ declare namespace sap {
7863
8814
  ): this;
7864
8815
  /**
7865
8816
  * Fires event {@link #event:endGesture endGesture} to attached listeners.
8817
+ *
8818
+ * @returns Reference to `this` in order to allow method chaining
7866
8819
  */
7867
8820
  fireEndGesture(
7868
8821
  /**
@@ -7872,6 +8825,8 @@ declare namespace sap {
7872
8825
  ): this;
7873
8826
  /**
7874
8827
  * Fires event {@link #event:hover hover} to attached listeners.
8828
+ *
8829
+ * @returns Reference to `this` in order to allow method chaining
7875
8830
  */
7876
8831
  fireHover(
7877
8832
  /**
@@ -7894,6 +8849,8 @@ declare namespace sap {
7894
8849
  ): this;
7895
8850
  /**
7896
8851
  * Fires event {@link #event:nodeClicked nodeClicked} to attached listeners.
8852
+ *
8853
+ * @returns Reference to `this` in order to allow method chaining
7897
8854
  */
7898
8855
  fireNodeClicked(
7899
8856
  /**
@@ -7903,6 +8860,8 @@ declare namespace sap {
7903
8860
  ): this;
7904
8861
  /**
7905
8862
  * Fires event {@link #event:refreshRequested refreshRequested} to attached listeners.
8863
+ *
8864
+ * @returns Reference to `this` in order to allow method chaining
7906
8865
  */
7907
8866
  fireRefreshRequested(
7908
8867
  /**
@@ -7912,6 +8871,8 @@ declare namespace sap {
7912
8871
  ): this;
7913
8872
  /**
7914
8873
  * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
8874
+ *
8875
+ * @returns Reference to `this` in order to allow method chaining
7915
8876
  */
7916
8877
  fireSelectionChanged(
7917
8878
  /**
@@ -7934,6 +8895,8 @@ declare namespace sap {
7934
8895
  ): this;
7935
8896
  /**
7936
8897
  * Fires event {@link #event:viewChanged viewChanged} to attached listeners.
8898
+ *
8899
+ * @returns Reference to `this` in order to allow method chaining
7937
8900
  */
7938
8901
  fireViewChanged(
7939
8902
  /**
@@ -7949,6 +8912,8 @@ declare namespace sap {
7949
8912
  ): this;
7950
8913
  /**
7951
8914
  * Fires event {@link #event:visibilityChanged visibilityChanged} to attached listeners.
8915
+ *
8916
+ * @returns Reference to `this` in order to allow method chaining
7952
8917
  */
7953
8918
  fireVisibilityChanged(
7954
8919
  /**
@@ -7975,6 +8940,8 @@ declare namespace sap {
7975
8940
  * The background gradient bottom color
7976
8941
  *
7977
8942
  * Default value is `"white"`.
8943
+ *
8944
+ * @returns Value of property `backgroundGradientBottomColor`
7978
8945
  */
7979
8946
  getBackgroundGradientBottomColor(): sap.ui.core.CSSColor;
7980
8947
  /**
@@ -7983,6 +8950,8 @@ declare namespace sap {
7983
8950
  * The background gradient top color.
7984
8951
  *
7985
8952
  * Default value is `"black"`.
8953
+ *
8954
+ * @returns Value of property `backgroundGradientTopColor`
7986
8955
  */
7987
8956
  getBackgroundGradientTopColor(): sap.ui.core.CSSColor;
7988
8957
  /**
@@ -7990,6 +8959,8 @@ declare namespace sap {
7990
8959
  *
7991
8960
  * This value can then be passed to {@link sap.ui.vtm.Viewport#setCameraInfo setCameraInfo} to restore the
7992
8961
  * camera position at a later point in time.
8962
+ *
8963
+ * @returns An object containing the current camera information for this viewport.
7993
8964
  */
7994
8965
  getCameraInfo(): object;
7995
8966
  /**
@@ -8003,6 +8974,8 @@ declare namespace sap {
8003
8974
  * state in the viewport after modifying override display groups.
8004
8975
  *
8005
8976
  * Default value is `[]`.
8977
+ *
8978
+ * @returns Value of property `contextDisplayGroups`
8006
8979
  */
8007
8980
  getContextDisplayGroups(): object[];
8008
8981
  /**
@@ -8012,6 +8985,8 @@ declare namespace sap {
8012
8985
  getHeaderControls(): sap.ui.core.ID[];
8013
8986
  /**
8014
8987
  * Gets the highlight colors for a set of scene nodes in this viewport.
8988
+ *
8989
+ * @returns The highlight colors for the relevant scene nodes. The
8015
8990
  */
8016
8991
  getHighlightColor(
8017
8992
  /**
@@ -8021,11 +8996,15 @@ declare namespace sap {
8021
8996
  ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[];
8022
8997
  /**
8023
8998
  * Returns whether the {@link sap.ui.vtm.Viewport} has been initialized.
8999
+ *
9000
+ * @returns Whether the {@link sap.ui.vtm.Viewport} has been initialized.
8024
9001
  */
8025
9002
  getInitialized(): boolean;
8026
9003
  /**
8027
9004
  * Gets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point
8028
9005
  * value in the interval [0,1].
9006
+ *
9007
+ * @returns The opacity states for the relevant scene nodes.
8029
9008
  */
8030
9009
  getOpacity(
8031
9010
  /**
@@ -8045,18 +9024,26 @@ declare namespace sap {
8045
9024
  * groups.
8046
9025
  *
8047
9026
  * Default value is `[]`.
9027
+ *
9028
+ * @returns Value of property `overrideDisplayGroups`
8048
9029
  */
8049
9030
  getOverrideDisplayGroups(): object[];
8050
9031
  /**
8051
9032
  * Gets the panel this viewport belongs to.
9033
+ *
9034
+ * @returns The panel this viewport belongs to.
8052
9035
  */
8053
9036
  getPanel(): sap.ui.vtm.Panel;
8054
9037
  /**
8055
9038
  * Gets the {@link sap.ui.vtm.Scene} used by this {@link sap.ui.vtm.Viewport}.
9039
+ *
9040
+ * @returns The sap.ui.vtm.Scene used by this Viewport.
8056
9041
  */
8057
9042
  getScene(): sap.ui.vtm.Scene;
8058
9043
  /**
8059
9044
  * Gets the selection state for a set of scene nodes in this viewport.
9045
+ *
9046
+ * @returns The selection states for the relevant scene nodes.
8060
9047
  */
8061
9048
  getSelected(
8062
9049
  /**
@@ -8066,10 +9053,14 @@ declare namespace sap {
8066
9053
  ): boolean | boolean[];
8067
9054
  /**
8068
9055
  * Gets the IDs of the scene nodes that are selected in this viewport.
9056
+ *
9057
+ * @returns The IDs of the scene nodes that are selected in this viewport.
8069
9058
  */
8070
9059
  getSelectedIds(): string[];
8071
9060
  /**
8072
9061
  * Gets the visibility state for a set of scene nodes in this viewport.
9062
+ *
9063
+ * @returns The visibility states for the relevant scene nodes.
8073
9064
  */
8074
9065
  getVisibility(
8075
9066
  /**
@@ -8079,14 +9070,20 @@ declare namespace sap {
8079
9070
  ): boolean | boolean[];
8080
9071
  /**
8081
9072
  * Fires a `refreshRequested` event.
9073
+ *
9074
+ * @returns `this` for method chaining.
8082
9075
  */
8083
9076
  refresh(): sap.ui.vtm.Viewport;
8084
9077
  /**
8085
9078
  * Removes all the controls in the association named {@link #getHeaderControls headerControls}.
9079
+ *
9080
+ * @returns An array of the removed elements (might be empty)
8086
9081
  */
8087
9082
  removeAllHeaderControls(): sap.ui.core.ID[];
8088
9083
  /**
8089
9084
  * Removes an headerControl from the association named {@link #getHeaderControls headerControls}.
9085
+ *
9086
+ * @returns The removed headerControl or `null`
8090
9087
  */
8091
9088
  removeHeaderControl(
8092
9089
  /**
@@ -8102,6 +9099,8 @@ declare namespace sap {
8102
9099
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8103
9100
  *
8104
9101
  * Default value is `"white"`.
9102
+ *
9103
+ * @returns Reference to `this` in order to allow method chaining
8105
9104
  */
8106
9105
  setBackgroundGradientBottomColor(
8107
9106
  /**
@@ -8117,6 +9116,8 @@ declare namespace sap {
8117
9116
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8118
9117
  *
8119
9118
  * Default value is `"black"`.
9119
+ *
9120
+ * @returns Reference to `this` in order to allow method chaining
8120
9121
  */
8121
9122
  setBackgroundGradientTopColor(
8122
9123
  /**
@@ -8126,6 +9127,8 @@ declare namespace sap {
8126
9127
  ): this;
8127
9128
  /**
8128
9129
  * Updates the camera for this viewport.
9130
+ *
9131
+ * @returns A reference to `this` to allow method chaining.
8129
9132
  */
8130
9133
  setCameraInfo(
8131
9134
  /**
@@ -8150,6 +9153,8 @@ declare namespace sap {
8150
9153
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8151
9154
  *
8152
9155
  * Default value is `[]`.
9156
+ *
9157
+ * @returns Reference to `this` in order to allow method chaining
8153
9158
  */
8154
9159
  setContextDisplayGroups(
8155
9160
  /**
@@ -8163,6 +9168,8 @@ declare namespace sap {
8163
9168
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8164
9169
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8165
9170
  * should perform all management of scene node visibility in the viewports.
9171
+ *
9172
+ * @returns `this` for method chaining.
8166
9173
  */
8167
9174
  setHighlightColor(
8168
9175
  /**
@@ -8187,6 +9194,8 @@ declare namespace sap {
8187
9194
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8188
9195
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8189
9196
  * should perform all management of scene node visibility in the viewports.
9197
+ *
9198
+ * @returns `this` for method chaining.
8190
9199
  */
8191
9200
  setOpacity(
8192
9201
  /**
@@ -8216,6 +9225,8 @@ declare namespace sap {
8216
9225
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8217
9226
  *
8218
9227
  * Default value is `[]`.
9228
+ *
9229
+ * @returns Reference to `this` in order to allow method chaining
8219
9230
  */
8220
9231
  setOverrideDisplayGroups(
8221
9232
  /**
@@ -8225,6 +9236,8 @@ declare namespace sap {
8225
9236
  ): this;
8226
9237
  /**
8227
9238
  * Sets the view in the current viewport to one of the predefined views.
9239
+ *
9240
+ * @returns `this` for method chaining.
8228
9241
  */
8229
9242
  setPredefinedView(
8230
9243
  /**
@@ -8238,6 +9251,8 @@ declare namespace sap {
8238
9251
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension}
8239
9252
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension}
8240
9253
  * should perform all management of scene node selection in the viewports.
9254
+ *
9255
+ * @returns `this` for method chaining.
8241
9256
  */
8242
9257
  setSelected(
8243
9258
  /**
@@ -8259,6 +9274,8 @@ declare namespace sap {
8259
9274
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8260
9275
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8261
9276
  * should perform all management of scene node visibility in the viewports.
9277
+ *
9278
+ * @returns `this` for method chaining.
8262
9279
  */
8263
9280
  setVisibility(
8264
9281
  /**
@@ -8276,6 +9293,8 @@ declare namespace sap {
8276
9293
  ): sap.ui.vtm.Viewport;
8277
9294
  /**
8278
9295
  * Zooms to a view in the current viewport that can fit all geometry in the scene (visible or not).
9296
+ *
9297
+ * @returns Returns `this` for method chaining.
8279
9298
  */
8280
9299
  zoomToAll(
8281
9300
  /**
@@ -8286,6 +9305,8 @@ declare namespace sap {
8286
9305
  /**
8287
9306
  * Calls {@link sap.ui.vtm.Viewport#zoomToSelected zoomToSelected} if any geometry is selected in this viewport,
8288
9307
  * otherwise calls {@link sap.ui.vtm.Viewport#zoomToAll zoomToAll}.
9308
+ *
9309
+ * @returns Returns `this` for method chaining.
8289
9310
  */
8290
9311
  zoomToFit(
8291
9312
  /**
@@ -8296,6 +9317,8 @@ declare namespace sap {
8296
9317
  /**
8297
9318
  * Zooms to the set of geometry that is selected in the current viewport. If no geometry is selected, no
8298
9319
  * action is taken.
9320
+ *
9321
+ * @returns Returns `this` for method chaining.
8299
9322
  */
8300
9323
  zoomToSelected(
8301
9324
  /**
@@ -8306,6 +9329,8 @@ declare namespace sap {
8306
9329
  /**
8307
9330
  * Zooms to the set of geometry that is visible in the current viewport. If no geometry is visible, this
8308
9331
  * zooms to all geometry in the current viewport.
9332
+ *
9333
+ * @returns Returns `this` for method chaining.
8309
9334
  */
8310
9335
  zoomToVisible(
8311
9336
  /**
@@ -8346,6 +9371,8 @@ declare namespace sap {
8346
9371
  * contained in `oClassInfo`.
8347
9372
  *
8348
9373
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
9374
+ *
9375
+ * @returns Created class / constructor function
8349
9376
  */
8350
9377
  static extend<T extends Record<string, unknown>>(
8351
9378
  /**
@@ -8364,10 +9391,14 @@ declare namespace sap {
8364
9391
  ): Function;
8365
9392
  /**
8366
9393
  * Returns a metadata object for class sap.ui.vtm.Vtm.
9394
+ *
9395
+ * @returns Metadata object describing this class
8367
9396
  */
8368
9397
  static getMetadata(): sap.ui.core.ElementMetadata;
8369
9398
  /**
8370
9399
  * Adds some extension to the aggregation {@link #getExtensions extensions}.
9400
+ *
9401
+ * @returns Reference to `this` in order to allow method chaining
8371
9402
  */
8372
9403
  addExtension(
8373
9404
  /**
@@ -8383,6 +9414,8 @@ declare namespace sap {
8383
9414
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8384
9415
  *
8385
9416
  * Raised when the active panel has changed.
9417
+ *
9418
+ * @returns Reference to `this` in order to allow method chaining
8386
9419
  */
8387
9420
  attachActivePanelChanged(
8388
9421
  /**
@@ -8407,6 +9440,8 @@ declare namespace sap {
8407
9440
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8408
9441
  *
8409
9442
  * Raised when the active panel has changed.
9443
+ *
9444
+ * @returns Reference to `this` in order to allow method chaining
8410
9445
  */
8411
9446
  attachActivePanelChanged(
8412
9447
  /**
@@ -8429,6 +9464,8 @@ declare namespace sap {
8429
9464
  * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that
8430
9465
  * the extensions can attach event handlers before the application attempts to attach event handlers to
8431
9466
  * the same events.
9467
+ *
9468
+ * @returns Reference to `this` in order to allow method chaining
8432
9469
  */
8433
9470
  attachInitialized(
8434
9471
  /**
@@ -8456,6 +9493,8 @@ declare namespace sap {
8456
9493
  * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that
8457
9494
  * the extensions can attach event handlers before the application attempts to attach event handlers to
8458
9495
  * the same events.
9496
+ *
9497
+ * @returns Reference to `this` in order to allow method chaining
8459
9498
  */
8460
9499
  attachInitialized(
8461
9500
  /**
@@ -8474,6 +9513,8 @@ declare namespace sap {
8474
9513
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8475
9514
  *
8476
9515
  * Raised when a panel has been added.
9516
+ *
9517
+ * @returns Reference to `this` in order to allow method chaining
8477
9518
  */
8478
9519
  attachPanelAdded(
8479
9520
  /**
@@ -8497,6 +9538,8 @@ declare namespace sap {
8497
9538
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8498
9539
  *
8499
9540
  * Raised when a panel has been added.
9541
+ *
9542
+ * @returns Reference to `this` in order to allow method chaining
8500
9543
  */
8501
9544
  attachPanelAdded(
8502
9545
  /**
@@ -8510,6 +9553,8 @@ declare namespace sap {
8510
9553
  ): this;
8511
9554
  /**
8512
9555
  * Creates a VTM panel associated with this {@link sap.ui.vtm.Vtm} instance.
9556
+ *
9557
+ * @returns The created panel.
8513
9558
  */
8514
9559
  createPanel(
8515
9560
  /**
@@ -8523,6 +9568,8 @@ declare namespace sap {
8523
9568
  ): sap.ui.vtm.Panel;
8524
9569
  /**
8525
9570
  * Destroys all the extensions in the aggregation {@link #getExtensions extensions}.
9571
+ *
9572
+ * @returns Reference to `this` in order to allow method chaining
8526
9573
  */
8527
9574
  destroyExtensions(): this;
8528
9575
  /**
@@ -8530,6 +9577,8 @@ declare namespace sap {
8530
9577
  * of this `sap.ui.vtm.Vtm`.
8531
9578
  *
8532
9579
  * The passed function and listener object must match the ones used for event registration.
9580
+ *
9581
+ * @returns Reference to `this` in order to allow method chaining
8533
9582
  */
8534
9583
  detachActivePanelChanged(
8535
9584
  /**
@@ -8545,6 +9594,8 @@ declare namespace sap {
8545
9594
  * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Vtm`.
8546
9595
  *
8547
9596
  * The passed function and listener object must match the ones used for event registration.
9597
+ *
9598
+ * @returns Reference to `this` in order to allow method chaining
8548
9599
  */
8549
9600
  detachInitialized(
8550
9601
  /**
@@ -8560,6 +9611,8 @@ declare namespace sap {
8560
9611
  * Detaches event handler `fnFunction` from the {@link #event:panelAdded panelAdded} event of this `sap.ui.vtm.Vtm`.
8561
9612
  *
8562
9613
  * The passed function and listener object must match the ones used for event registration.
9614
+ *
9615
+ * @returns Reference to `this` in order to allow method chaining
8563
9616
  */
8564
9617
  detachPanelAdded(
8565
9618
  /**
@@ -8573,6 +9626,8 @@ declare namespace sap {
8573
9626
  ): this;
8574
9627
  /**
8575
9628
  * Fires event {@link #event:activePanelChanged activePanelChanged} to attached listeners.
9629
+ *
9630
+ * @returns Reference to `this` in order to allow method chaining
8576
9631
  */
8577
9632
  fireActivePanelChanged(
8578
9633
  /**
@@ -8582,6 +9637,8 @@ declare namespace sap {
8582
9637
  ): this;
8583
9638
  /**
8584
9639
  * Fires event {@link #event:initialized initialized} to attached listeners.
9640
+ *
9641
+ * @returns Reference to `this` in order to allow method chaining
8585
9642
  */
8586
9643
  fireInitialized(
8587
9644
  /**
@@ -8591,6 +9648,8 @@ declare namespace sap {
8591
9648
  ): this;
8592
9649
  /**
8593
9650
  * Fires event {@link #event:panelAdded panelAdded} to attached listeners.
9651
+ *
9652
+ * @returns Reference to `this` in order to allow method chaining
8594
9653
  */
8595
9654
  firePanelAdded(
8596
9655
  /**
@@ -8602,18 +9661,24 @@ declare namespace sap {
8602
9661
  ): this;
8603
9662
  /**
8604
9663
  * Gets the active panel.
9664
+ *
9665
+ * @returns The active panel, or null if there is no active panel.
8605
9666
  */
8606
9667
  getActivePanel(): sap.ui.vtm.Panel | null;
8607
9668
  /**
8608
9669
  * Gets current value of property {@link #getAddDefaultExtensions addDefaultExtensions}.
8609
9670
  *
8610
9671
  * When true populates the `extensions` aggregation with the default set of extensions in the default configuration.
9672
+ *
9673
+ * @returns Value of property `addDefaultExtensions`
8611
9674
  */
8612
9675
  getAddDefaultExtensions(): boolean;
8613
9676
  /**
8614
9677
  * Gets the extension implementing a specified interface.
8615
9678
  *
8616
9679
  * Returns `undefined` if there is not exactly one matching extension.
9680
+ *
9681
+ * @returns The matching extension or `undefined` if there is not exactly one matching extension.
8617
9682
  */
8618
9683
  getExtensionByInterface(
8619
9684
  /**
@@ -8625,6 +9690,8 @@ declare namespace sap {
8625
9690
  * Gets an extension with a specified class name.
8626
9691
  *
8627
9692
  * Returns `undefined` if there is not exactly one matching extension.
9693
+ *
9694
+ * @returns The matching extension or `undefined` if there is not exactly one matching extension.
8628
9695
  */
8629
9696
  getExtensionByName(
8630
9697
  /**
@@ -8641,6 +9708,8 @@ declare namespace sap {
8641
9708
  getExtensions(): sap.ui.vtm.Extension[];
8642
9709
  /**
8643
9710
  * Gets the extensions implementing a specified interface.
9711
+ *
9712
+ * @returns The matching extensions.
8644
9713
  */
8645
9714
  getExtensionsByInterface(
8646
9715
  /**
@@ -8650,6 +9719,8 @@ declare namespace sap {
8650
9719
  ): sap.ui.vtm.Extension[];
8651
9720
  /**
8652
9721
  * Gets the extensions with a specified class name.
9722
+ *
9723
+ * @returns The matching extensions.
8653
9724
  */
8654
9725
  getExtensionsByName(
8655
9726
  /**
@@ -8659,6 +9730,8 @@ declare namespace sap {
8659
9730
  ): sap.ui.vtm.Extension[];
8660
9731
  /**
8661
9732
  * Gets a panel given its id. Returns undefined if no match is found.
9733
+ *
9734
+ * @returns The matching panel or undefined if no match is found.
8662
9735
  */
8663
9736
  getPanel(
8664
9737
  /**
@@ -8668,15 +9741,21 @@ declare namespace sap {
8668
9741
  ): sap.ui.vtm.Panel | undefined;
8669
9742
  /**
8670
9743
  * Gets the set of created panels. Do not modify the returned array.
9744
+ *
9745
+ * @returns The created panels.
8671
9746
  */
8672
9747
  getPanels(): sap.ui.vtm.Panel[];
8673
9748
  /**
8674
9749
  * Gets the scene.
9750
+ *
9751
+ * @returns The scene.
8675
9752
  */
8676
9753
  getScene(): sap.ui.vtm.Scene;
8677
9754
  /**
8678
9755
  * Checks for the provided `sap.ui.vtm.Extension` in the aggregation {@link #getExtensions extensions}.
8679
9756
  * and returns its index if found or -1 otherwise.
9757
+ *
9758
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
8680
9759
  */
8681
9760
  indexOfExtension(
8682
9761
  /**
@@ -8686,6 +9765,8 @@ declare namespace sap {
8686
9765
  ): int;
8687
9766
  /**
8688
9767
  * Inserts a extension into the aggregation {@link #getExtensions extensions}.
9768
+ *
9769
+ * @returns Reference to `this` in order to allow method chaining
8689
9770
  */
8690
9771
  insertExtension(
8691
9772
  /**
@@ -8703,10 +9784,14 @@ declare namespace sap {
8703
9784
  * Removes all the controls from the aggregation {@link #getExtensions extensions}.
8704
9785
  *
8705
9786
  * Additionally, it unregisters them from the hosting UIArea.
9787
+ *
9788
+ * @returns An array of the removed elements (might be empty)
8706
9789
  */
8707
9790
  removeAllExtensions(): sap.ui.vtm.Extension[];
8708
9791
  /**
8709
9792
  * Removes a extension from the aggregation {@link #getExtensions extensions}.
9793
+ *
9794
+ * @returns The removed extension or `null`
8710
9795
  */
8711
9796
  removeExtension(
8712
9797
  /**
@@ -8716,6 +9801,8 @@ declare namespace sap {
8716
9801
  ): sap.ui.vtm.Extension;
8717
9802
  /**
8718
9803
  * Sets the active panel.
9804
+ *
9805
+ * @returns A reference to `this` for method chaining.
8719
9806
  */
8720
9807
  setActivePanel(
8721
9808
  /**
@@ -8729,6 +9816,8 @@ declare namespace sap {
8729
9816
  * When true populates the `extensions` aggregation with the default set of extensions in the default configuration.
8730
9817
  *
8731
9818
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9819
+ *
9820
+ * @returns Reference to `this` in order to allow method chaining
8732
9821
  */
8733
9822
  setAddDefaultExtensions(
8734
9823
  /**