@sapui5/ts-types 1.101.1 → 1.102.2

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 +7209 -505
  17. package/types/sap.insights.d.ts +21 -0
  18. package/types/sap.landvisz.d.ts +1015 -66
  19. package/types/sap.m.d.ts +16677 -1155
  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 +3880 -276
  34. package/types/sap.ui.core.d.ts +6268 -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 +1977 -97
  52. package/types/sap.ui.vk.d.ts +5353 -310
  53. package/types/sap.ui.vtm.d.ts +1133 -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,8 +1,9 @@
1
- // For Library Version: 1.101.0
1
+ // For Library Version: 1.102.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
5
5
  /**
6
+ * @deprecated (since 1.96.10)
6
7
  * @EXPERIMENTAL (since 1.50.0)
7
8
  *
8
9
  * SAPUI5 library with controls to visualize, map and restructure hierarchical business data that maps to
@@ -79,6 +80,8 @@ declare namespace sap {
79
80
  *
80
81
  * The {@link sap.ui.vtm.Vtm} constructor can be used to create an instance of {@link sap.ui.vtm.Vtm} with
81
82
  * a specific set of extensions.
83
+ *
84
+ * @returns The created instance of {@link sap.ui.vtm.Vtm}.
82
85
  */
83
86
  function createVtm(
84
87
  /**
@@ -92,6 +95,7 @@ declare namespace sap {
92
95
  mSettings: object
93
96
  ): sap.ui.vtm.Vtm;
94
97
  /**
98
+ * @deprecated (since 1.96.10)
95
99
  * @EXPERIMENTAL (since 1.50.0)
96
100
  *
97
101
  * Namespace for extensions that are provided with the sap.ui.vtm library.
@@ -108,7 +112,8 @@ declare namespace sap {
108
112
  */
109
113
  predefinedView?:
110
114
  | sap.ui.vtm.PredefinedView
111
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
115
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
116
+ | `{${string}}`;
112
117
  }
113
118
 
114
119
  interface $LoadProgressExtensionSettings
@@ -127,7 +132,8 @@ declare namespace sap {
127
132
  */
128
133
  highlightColor?:
129
134
  | sap.ui.core.CSSColor
130
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
135
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
136
+ | `{${string}}`;
131
137
  }
132
138
 
133
139
  interface $SceneNodeHoverTooltipExtensionSettings
@@ -146,7 +152,10 @@ declare namespace sap {
146
152
  * ```
147
153
  * If function returns null no tooltip will be displayed.
148
154
  */
149
- tooltipCallback?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
155
+ tooltipCallback?:
156
+ | any
157
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
158
+ | `{${string}}`;
150
159
  }
151
160
 
152
161
  interface $SelectionLinkingExtensionSettings
@@ -162,7 +171,8 @@ declare namespace sap {
162
171
  */
163
172
  findMatchingTreeItems?:
164
173
  | any
165
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
174
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
175
+ | `{${string}}`;
166
176
  }
167
177
 
168
178
  interface $ViewLinkingExtensionSettings
@@ -208,6 +218,8 @@ declare namespace sap {
208
218
  * and enriches it with the information contained in `oClassInfo`.
209
219
  *
210
220
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
221
+ *
222
+ * @returns Created class / constructor function
211
223
  */
212
224
  static extend<T extends Record<string, unknown>>(
213
225
  /**
@@ -229,6 +241,8 @@ declare namespace sap {
229
241
  ): Function;
230
242
  /**
231
243
  * Returns a metadata object for class sap.ui.vtm.extensions.DisplayStateCalculationExtension.
244
+ *
245
+ * @returns Metadata object describing this class
232
246
  */
233
247
  static getMetadata(): sap.ui.core.ElementMetadata;
234
248
  }
@@ -265,6 +279,8 @@ declare namespace sap {
265
279
  * enriches it with the information contained in `oClassInfo`.
266
280
  *
267
281
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
282
+ *
283
+ * @returns Created class / constructor function
268
284
  */
269
285
  static extend<T extends Record<string, unknown>>(
270
286
  /**
@@ -286,6 +302,8 @@ declare namespace sap {
286
302
  ): Function;
287
303
  /**
288
304
  * Returns a metadata object for class sap.ui.vtm.extensions.InitialViewExtension.
305
+ *
306
+ * @returns Metadata object describing this class
289
307
  */
290
308
  static getMetadata(): sap.ui.core.ElementMetadata;
291
309
  /**
@@ -293,6 +311,8 @@ declare namespace sap {
293
311
  *
294
312
  * Specifies a predefined view to use. If a specific view is not specified this extension will zoom to fit
295
313
  * all geometry without changing the camera angle.
314
+ *
315
+ * @returns Value of property `predefinedView`
296
316
  */
297
317
  getPredefinedView(): sap.ui.vtm.PredefinedView;
298
318
  /**
@@ -302,6 +322,8 @@ declare namespace sap {
302
322
  * all geometry without changing the camera angle.
303
323
  *
304
324
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
325
+ *
326
+ * @returns Reference to `this` in order to allow method chaining
305
327
  */
306
328
  setPredefinedView(
307
329
  /**
@@ -342,6 +364,8 @@ declare namespace sap {
342
364
  * enriches it with the information contained in `oClassInfo`.
343
365
  *
344
366
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
367
+ *
368
+ * @returns Created class / constructor function
345
369
  */
346
370
  static extend<T extends Record<string, unknown>>(
347
371
  /**
@@ -363,6 +387,8 @@ declare namespace sap {
363
387
  ): Function;
364
388
  /**
365
389
  * Returns a metadata object for class sap.ui.vtm.extensions.LoadProgressExtension.
390
+ *
391
+ * @returns Metadata object describing this class
366
392
  */
367
393
  static getMetadata(): sap.ui.core.ElementMetadata;
368
394
  }
@@ -411,6 +437,8 @@ declare namespace sap {
411
437
  * and enriches it with the information contained in `oClassInfo`.
412
438
  *
413
439
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
440
+ *
441
+ * @returns Created class / constructor function
414
442
  */
415
443
  static extend<T extends Record<string, unknown>>(
416
444
  /**
@@ -432,6 +460,8 @@ declare namespace sap {
432
460
  ): Function;
433
461
  /**
434
462
  * Returns a metadata object for class sap.ui.vtm.extensions.MessageStatusCalculationExtension.
463
+ *
464
+ * @returns Metadata object describing this class
435
465
  */
436
466
  static getMetadata(): sap.ui.core.ElementMetadata;
437
467
  }
@@ -464,6 +494,8 @@ declare namespace sap {
464
494
  * and enriches it with the information contained in `oClassInfo`.
465
495
  *
466
496
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
497
+ *
498
+ * @returns Created class / constructor function
467
499
  */
468
500
  static extend<T extends Record<string, unknown>>(
469
501
  /**
@@ -485,6 +517,8 @@ declare namespace sap {
485
517
  ): Function;
486
518
  /**
487
519
  * Returns a metadata object for class sap.ui.vtm.extensions.MessageStatusIconClickExtension.
520
+ *
521
+ * @returns Metadata object describing this class
488
522
  */
489
523
  static getMetadata(): sap.ui.core.ElementMetadata;
490
524
  }
@@ -520,6 +554,8 @@ declare namespace sap {
520
554
  * and enriches it with the information contained in `oClassInfo`.
521
555
  *
522
556
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
557
+ *
558
+ * @returns Created class / constructor function
523
559
  */
524
560
  static extend<T extends Record<string, unknown>>(
525
561
  /**
@@ -541,6 +577,8 @@ declare namespace sap {
541
577
  ): Function;
542
578
  /**
543
579
  * Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension.
580
+ *
581
+ * @returns Metadata object describing this class
544
582
  */
545
583
  static getMetadata(): sap.ui.core.ElementMetadata;
546
584
  /**
@@ -549,6 +587,8 @@ declare namespace sap {
549
587
  * The highlight color to use for the scene node being hovered over.
550
588
  *
551
589
  * Default value is `"rgba(0, 0, 255, 0.7)"`.
590
+ *
591
+ * @returns Value of property `highlightColor`
552
592
  */
553
593
  getHighlightColor(): sap.ui.core.CSSColor;
554
594
  /**
@@ -559,6 +599,8 @@ declare namespace sap {
559
599
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
560
600
  *
561
601
  * Default value is `"rgba(0, 0, 255, 0.7)"`.
602
+ *
603
+ * @returns Reference to `this` in order to allow method chaining
562
604
  */
563
605
  setHighlightColor(
564
606
  /**
@@ -600,6 +642,8 @@ declare namespace sap {
600
642
  * and enriches it with the information contained in `oClassInfo`.
601
643
  *
602
644
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
645
+ *
646
+ * @returns Created class / constructor function
603
647
  */
604
648
  static extend<T extends Record<string, unknown>>(
605
649
  /**
@@ -621,6 +665,8 @@ declare namespace sap {
621
665
  ): Function;
622
666
  /**
623
667
  * Returns a metadata object for class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension.
668
+ *
669
+ * @returns Metadata object describing this class
624
670
  */
625
671
  static getMetadata(): sap.ui.core.ElementMetadata;
626
672
  /**
@@ -638,6 +684,8 @@ declare namespace sap {
638
684
  * }
639
685
  * ```
640
686
  * If function returns null no tooltip will be displayed.
687
+ *
688
+ * @returns Value of property `tooltipCallback`
641
689
  */
642
690
  getTooltipCallback(): any;
643
691
  /**
@@ -657,6 +705,8 @@ declare namespace sap {
657
705
  * If function returns null no tooltip will be displayed.
658
706
  *
659
707
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
708
+ *
709
+ * @returns Reference to `this` in order to allow method chaining
660
710
  */
661
711
  setTooltipCallback(
662
712
  /**
@@ -699,6 +749,8 @@ declare namespace sap {
699
749
  * and enriches it with the information contained in `oClassInfo`.
700
750
  *
701
751
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
752
+ *
753
+ * @returns Created class / constructor function
702
754
  */
703
755
  static extend<T extends Record<string, unknown>>(
704
756
  /**
@@ -720,6 +772,8 @@ declare namespace sap {
720
772
  ): Function;
721
773
  /**
722
774
  * Returns a metadata object for class sap.ui.vtm.extensions.SelectionLinkingExtension.
775
+ *
776
+ * @returns Metadata object describing this class
723
777
  */
724
778
  static getMetadata(): sap.ui.core.ElementMetadata;
725
779
  /**
@@ -732,6 +786,8 @@ declare namespace sap {
732
786
  * against.
733
787
  * The third parameter is the {@link sap.ui.vtm.Tree} to search for matches in.
734
788
  * The function returns an array of tree items that match the specified tree item.
789
+ *
790
+ * @returns Value of property `findMatchingTreeItems`
735
791
  */
736
792
  getFindMatchingTreeItems(): any;
737
793
  /**
@@ -746,6 +802,8 @@ declare namespace sap {
746
802
  * The function returns an array of tree items that match the specified tree item.
747
803
  *
748
804
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
805
+ *
806
+ * @returns Reference to `this` in order to allow method chaining
749
807
  */
750
808
  setFindMatchingTreeItems(
751
809
  /**
@@ -774,6 +832,8 @@ declare namespace sap {
774
832
  * enriches it with the information contained in `oClassInfo`.
775
833
  *
776
834
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
835
+ *
836
+ * @returns Created class / constructor function
777
837
  */
778
838
  static extend<T extends Record<string, unknown>>(
779
839
  /**
@@ -795,6 +855,8 @@ declare namespace sap {
795
855
  ): Function;
796
856
  /**
797
857
  * Returns a metadata object for class sap.ui.vtm.extensions.ViewLinkingExtension.
858
+ *
859
+ * @returns Metadata object describing this class
798
860
  */
799
861
  static getMetadata(): sap.ui.core.ElementMetadata;
800
862
  }
@@ -828,6 +890,8 @@ declare namespace sap {
828
890
  * and enriches it with the information contained in `oClassInfo`.
829
891
  *
830
892
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
893
+ *
894
+ * @returns Created class / constructor function
831
895
  */
832
896
  static extend<T extends Record<string, unknown>>(
833
897
  /**
@@ -849,6 +913,8 @@ declare namespace sap {
849
913
  ): Function;
850
914
  /**
851
915
  * Returns a metadata object for class sap.ui.vtm.extensions.ViewportSelectionLinkingExtension.
916
+ *
917
+ * @returns Metadata object describing this class
852
918
  */
853
919
  static getMetadata(): sap.ui.core.ElementMetadata;
854
920
  }
@@ -885,6 +951,8 @@ declare namespace sap {
885
951
  * and enriches it with the information contained in `oClassInfo`.
886
952
  *
887
953
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.vtm.Extension.extend}.
954
+ *
955
+ * @returns Created class / constructor function
888
956
  */
889
957
  static extend<T extends Record<string, unknown>>(
890
958
  /**
@@ -906,11 +974,14 @@ declare namespace sap {
906
974
  ): Function;
907
975
  /**
908
976
  * Returns a metadata object for class sap.ui.vtm.extensions.VisibilityIconClickExtension.
977
+ *
978
+ * @returns Metadata object describing this class
909
979
  */
910
980
  static getMetadata(): sap.ui.core.ElementMetadata;
911
981
  }
912
982
  }
913
983
  /**
984
+ * @deprecated (since 1.96.10)
914
985
  * @EXPERIMENTAL (since 1.50.0)
915
986
  *
916
987
  * Namespace for interfaces that are provided with the sap.ui.vtm library.
@@ -1071,7 +1142,8 @@ declare namespace sap {
1071
1142
  */
1072
1143
  type?:
1073
1144
  | sap.ui.vtm.ColumnType
1074
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1145
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1146
+ | `{${string}}`;
1075
1147
 
1076
1148
  /**
1077
1149
  * The descriptor is a JSON string identifying the column.
@@ -1100,19 +1172,24 @@ declare namespace sap {
1100
1172
  */
1101
1173
  hAlign?:
1102
1174
  | sap.ui.core.HorizontalAlign
1103
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1175
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1176
+ | `{${string}}`;
1104
1177
 
1105
1178
  /**
1106
1179
  * The width of the tree column.
1107
1180
  */
1108
1181
  width?:
1109
1182
  | sap.ui.core.CSSSize
1110
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1183
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1184
+ | `{${string}}`;
1111
1185
 
1112
1186
  /**
1113
1187
  * If set to true, the column can be resized.
1114
1188
  */
1115
- resizable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1189
+ resizable?:
1190
+ | boolean
1191
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1192
+ | `{${string}}`;
1116
1193
 
1117
1194
  /**
1118
1195
  * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so
@@ -1125,7 +1202,10 @@ declare namespace sap {
1125
1202
  * to the `label` property as the column header content. However the `label` property should also be specified
1126
1203
  * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}.
1127
1204
  */
1128
- labelControl?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1205
+ labelControl?:
1206
+ | object
1207
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1208
+ | `{${string}}`;
1129
1209
 
1130
1210
  /**
1131
1211
  * If defined, this is a function that specifies the formatting of cell content text for this column.
@@ -1134,7 +1214,10 @@ declare namespace sap {
1134
1214
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
1135
1215
  * table row.
1136
1216
  */
1137
- valueFormatter?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
1217
+ valueFormatter?:
1218
+ | any
1219
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1220
+ | `{${string}}`;
1138
1221
 
1139
1222
  /**
1140
1223
  * If defined, this is a function that specifies the formatting of cell content tooltips for this column
@@ -1145,7 +1228,10 @@ declare namespace sap {
1145
1228
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
1146
1229
  * table row.
1147
1230
  */
1148
- tooltipFormatter?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
1231
+ tooltipFormatter?:
1232
+ | any
1233
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1234
+ | `{${string}}`;
1149
1235
 
1150
1236
  /**
1151
1237
  * If defined, overrides the cell template for the column.
@@ -1153,7 +1239,8 @@ declare namespace sap {
1153
1239
  */
1154
1240
  template?:
1155
1241
  | sap.ui.core.Control
1156
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1242
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1243
+ | `{${string}}`;
1157
1244
  }
1158
1245
 
1159
1246
  interface $DisplayGroupSettings extends sap.ui.core.$ElementSettings {
@@ -1180,14 +1267,18 @@ declare namespace sap {
1180
1267
  */
1181
1268
  displayStatesBySceneNodeId?:
1182
1269
  | object
1183
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1270
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1271
+ | `{${string}}`;
1184
1272
  }
1185
1273
 
1186
1274
  interface $ExtensionSettings extends sap.ui.core.$ElementSettings {
1187
1275
  /**
1188
1276
  * Controls whether the extension is enabled.
1189
1277
  */
1190
- enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1278
+ enabled?:
1279
+ | boolean
1280
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1281
+ | `{${string}}`;
1191
1282
 
1192
1283
  /**
1193
1284
  * Fired when the enabled property is changed.
@@ -1211,14 +1302,18 @@ declare namespace sap {
1211
1302
  * - `text`
1212
1303
  * - `icon`
1213
1304
  */
1214
- messages?: object[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
1305
+ messages?:
1306
+ | object[]
1307
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1308
+ | `{${string}}`;
1215
1309
 
1216
1310
  /**
1217
1311
  * Maximum height of status window.
1218
1312
  */
1219
1313
  maxHeight?:
1220
1314
  | sap.ui.core.CSSSize
1221
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1315
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1316
+ | `{${string}}`;
1222
1317
  }
1223
1318
 
1224
1319
  interface $PanelSettings extends sap.ui.core.$ControlSettings {
@@ -1230,21 +1325,26 @@ declare namespace sap {
1230
1325
  /**
1231
1326
  * Controls whether the viewport will be shown for this panel.
1232
1327
  */
1233
- showViewport?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1328
+ showViewport?:
1329
+ | boolean
1330
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1331
+ | `{${string}}`;
1234
1332
 
1235
1333
  /**
1236
1334
  * The width of the tree.
1237
1335
  */
1238
1336
  treeWidth?:
1239
1337
  | sap.ui.core.CSSSize
1240
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1338
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1339
+ | `{${string}}`;
1241
1340
 
1242
1341
  /**
1243
1342
  * The height of the panel.
1244
1343
  */
1245
1344
  height?:
1246
1345
  | sap.ui.core.CSSSize
1247
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1346
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1347
+ | `{${string}}`;
1248
1348
 
1249
1349
  /**
1250
1350
  * The set of controls to render in the title bar area.
@@ -1252,7 +1352,8 @@ declare namespace sap {
1252
1352
  titleControls?:
1253
1353
  | sap.ui.core.Control[]
1254
1354
  | sap.ui.core.Control
1255
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1355
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1356
+ | `{${string}}`;
1256
1357
 
1257
1358
  /**
1258
1359
  * The set of controls to render in the tree header area.
@@ -1260,7 +1361,8 @@ declare namespace sap {
1260
1361
  treeHeaderControls?:
1261
1362
  | sap.ui.core.Control[]
1262
1363
  | sap.ui.core.Control
1263
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1364
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1365
+ | `{${string}}`;
1264
1366
 
1265
1367
  /**
1266
1368
  * The set of controls to render in the viewport header area.
@@ -1268,7 +1370,8 @@ declare namespace sap {
1268
1370
  viewportHeaderControls?:
1269
1371
  | sap.ui.core.Control[]
1270
1372
  | sap.ui.core.Control
1271
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1373
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1374
+ | `{${string}}`;
1272
1375
 
1273
1376
  /**
1274
1377
  * The {@link sap.ui.vtm.Vtm} instance this panel is associated with.
@@ -1296,14 +1399,18 @@ declare namespace sap {
1296
1399
  /**
1297
1400
  * The percentage (0-100) to show in the progress bar (if visible).
1298
1401
  */
1299
- percentComplete?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1402
+ percentComplete?:
1403
+ | int
1404
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1405
+ | `{${string}}`;
1300
1406
 
1301
1407
  /**
1302
1408
  * Whether the progress bar is visible.
1303
1409
  */
1304
1410
  progressBarVisible?:
1305
1411
  | boolean
1306
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1412
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1413
+ | `{${string}}`;
1307
1414
  }
1308
1415
 
1309
1416
  interface $SceneSettings extends sap.ui.core.$ElementSettings {
@@ -1361,7 +1468,10 @@ declare namespace sap {
1361
1468
  /**
1362
1469
  * The {@link sap.ui.vtm.Scene} for the scene node.
1363
1470
  */
1364
- scene?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1471
+ scene?:
1472
+ | object
1473
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1474
+ | `{${string}}`;
1365
1475
  }
1366
1476
 
1367
1477
  interface $SelectColumnsDialogSettings
@@ -1369,14 +1479,18 @@ declare namespace sap {
1369
1479
  /**
1370
1480
  * The {@link sap.ui.vtm.Tree} that column selection is being performed for.
1371
1481
  */
1372
- tree?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1482
+ tree?:
1483
+ | object
1484
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1485
+ | `{${string}}`;
1373
1486
 
1374
1487
  /**
1375
1488
  * The set of columns that should be shown in the dialog that may be selected for display.
1376
1489
  */
1377
1490
  selectableColumns?:
1378
1491
  | sap.ui.vtm.Column[]
1379
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1492
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1493
+ | `{${string}}`;
1380
1494
  }
1381
1495
 
1382
1496
  interface $TreeSettings extends sap.ui.core.$ControlSettings {
@@ -1385,7 +1499,8 @@ declare namespace sap {
1385
1499
  */
1386
1500
  selectionMode?:
1387
1501
  | sap.ui.vtm.SelectionMode
1388
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1502
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1503
+ | `{${string}}`;
1389
1504
 
1390
1505
  /**
1391
1506
  * A set of controls such as toolbars to show above the tree.
@@ -1393,7 +1508,8 @@ declare namespace sap {
1393
1508
  headerControls?:
1394
1509
  | sap.ui.core.Control[]
1395
1510
  | sap.ui.core.Control
1396
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1511
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1512
+ | `{${string}}`;
1397
1513
 
1398
1514
  /**
1399
1515
  * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault()
@@ -1473,7 +1589,10 @@ declare namespace sap {
1473
1589
  /**
1474
1590
  * The source URL (string) or File for this Viewable.
1475
1591
  */
1476
- source?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
1592
+ source?:
1593
+ | any
1594
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1595
+ | `{${string}}`;
1477
1596
 
1478
1597
  /**
1479
1598
  * The name for this Viewable.
@@ -1483,7 +1602,10 @@ declare namespace sap {
1483
1602
  /**
1484
1603
  * The root scene node IDs for this viewable.
1485
1604
  */
1486
- rootNodeIds?: string[] | sap.ui.base.ManagedObject.PropertyBindingInfo;
1605
+ rootNodeIds?:
1606
+ | string[]
1607
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1608
+ | `{${string}}`;
1487
1609
 
1488
1610
  /**
1489
1611
  * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded
@@ -1491,14 +1613,18 @@ declare namespace sap {
1491
1613
  */
1492
1614
  relativeMatrix?:
1493
1615
  | sap.ui.vtm.Matrix
1494
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1616
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1617
+ | `{${string}}`;
1495
1618
  }
1496
1619
 
1497
1620
  interface $ViewableLoadInfoSettings extends sap.ui.core.$ElementSettings {
1498
1621
  /**
1499
1622
  * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to.
1500
1623
  */
1501
- viewable?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1624
+ viewable?:
1625
+ | object
1626
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1627
+ | `{${string}}`;
1502
1628
 
1503
1629
  /**
1504
1630
  * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo}
@@ -1506,7 +1632,8 @@ declare namespace sap {
1506
1632
  */
1507
1633
  status?:
1508
1634
  | sap.ui.vtm.ViewableLoadStatus
1509
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1635
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1636
+ | `{${string}}`;
1510
1637
 
1511
1638
  /**
1512
1639
  * The error code describing why the Viewable failed to load.
@@ -1528,14 +1655,16 @@ declare namespace sap {
1528
1655
  */
1529
1656
  backgroundGradientTopColor?:
1530
1657
  | sap.ui.core.CSSColor
1531
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1658
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1659
+ | `{${string}}`;
1532
1660
 
1533
1661
  /**
1534
1662
  * The background gradient bottom color
1535
1663
  */
1536
1664
  backgroundGradientBottomColor?:
1537
1665
  | sap.ui.core.CSSColor
1538
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1666
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1667
+ | `{${string}}`;
1539
1668
 
1540
1669
  /**
1541
1670
  * Allows the calculated display state of scene nodes in the viewport o be overridden.
@@ -1548,7 +1677,8 @@ declare namespace sap {
1548
1677
  */
1549
1678
  overrideDisplayGroups?:
1550
1679
  | object[]
1551
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1680
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1681
+ | `{${string}}`;
1552
1682
 
1553
1683
  /**
1554
1684
  * Allows the calculated display state for scene nodes whose display state is not determined by tree item
@@ -1560,7 +1690,8 @@ declare namespace sap {
1560
1690
  */
1561
1691
  contextDisplayGroups?:
1562
1692
  | object[]
1563
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1693
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1694
+ | `{${string}}`;
1564
1695
 
1565
1696
  /**
1566
1697
  * A set of controls such as toolbars to appear above the 3D viewport.
@@ -1615,7 +1746,8 @@ declare namespace sap {
1615
1746
  */
1616
1747
  addDefaultExtensions?:
1617
1748
  | boolean
1618
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1749
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1750
+ | `{${string}}`;
1619
1751
 
1620
1752
  /**
1621
1753
  * The set of VTM extensions. Extensions are used to provide extensibility. Default behaviors are implemented
@@ -1624,7 +1756,8 @@ declare namespace sap {
1624
1756
  extensions?:
1625
1757
  | sap.ui.vtm.Extension[]
1626
1758
  | sap.ui.vtm.Extension
1627
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1759
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
1760
+ | `{${string}}`;
1628
1761
 
1629
1762
  /**
1630
1763
  * Raised when a panel has been added.
@@ -1654,6 +1787,8 @@ declare namespace sap {
1654
1787
  interface ArrayUtilities {
1655
1788
  /**
1656
1789
  * Returns `true` if a group of arrays are equal.
1790
+ *
1791
+ * @returns `true` if the all the arrays are equal.
1657
1792
  */
1658
1793
  areEqual(
1659
1794
  /**
@@ -1668,6 +1803,8 @@ declare namespace sap {
1668
1803
  ): boolean;
1669
1804
  /**
1670
1805
  * Creates a copy of an array in which the items are cloned.
1806
+ *
1807
+ * @returns The cloned array
1671
1808
  */
1672
1809
  deepClone(
1673
1810
  /**
@@ -1683,6 +1820,8 @@ declare namespace sap {
1683
1820
  /**
1684
1821
  * Returns the first item in an array that matches the supplied predicate or returns undefined if no match
1685
1822
  * is found.
1823
+ *
1824
+ * @returns The matching item or undefined if no match was found.
1686
1825
  */
1687
1826
  find(
1688
1827
  /**
@@ -1698,6 +1837,8 @@ declare namespace sap {
1698
1837
  /**
1699
1838
  * Returns the index of the first item in an array that matches the supplied predicate or returns -1 if
1700
1839
  * no match is found.
1840
+ *
1841
+ * @returns The index of the matching item or -1 if no match was found.
1701
1842
  */
1702
1843
  findIndex(
1703
1844
  /**
@@ -1712,6 +1853,8 @@ declare namespace sap {
1712
1853
  ): number;
1713
1854
  /**
1714
1855
  * Flattens an array of arrays down to an array.
1856
+ *
1857
+ * @returns A flattened array.
1715
1858
  */
1716
1859
  flatten(
1717
1860
  /**
@@ -1721,6 +1864,8 @@ declare namespace sap {
1721
1864
  ): any[];
1722
1865
  /**
1723
1866
  * Converts from an array-like object (an object that supports indexing and has a length) to an array.
1867
+ *
1868
+ * @returns The array containing the same values as the array-like object.
1724
1869
  */
1725
1870
  fromArrayLike(
1726
1871
  /**
@@ -1730,6 +1875,8 @@ declare namespace sap {
1730
1875
  ): any[];
1731
1876
  /**
1732
1877
  * Converts an ES6 Set to an array.
1878
+ *
1879
+ * @returns The array containing the same set of unique items as the Set.
1733
1880
  */
1734
1881
  fromSet(
1735
1882
  /**
@@ -1739,6 +1886,8 @@ declare namespace sap {
1739
1886
  ): any[];
1740
1887
  /**
1741
1888
  * Returns whether a group of arrays have a non empty set intersection.
1889
+ *
1890
+ * @returns Whether the arrays have a non empty set intersection.
1742
1891
  */
1743
1892
  haveIntersection(
1744
1893
  /**
@@ -1753,6 +1902,8 @@ declare namespace sap {
1753
1902
  ): boolean;
1754
1903
  /**
1755
1904
  * Returns the set intersection of a group of arrays.
1905
+ *
1906
+ * @returns The set intersection of the arrays.
1756
1907
  */
1757
1908
  intersect(
1758
1909
  /**
@@ -1767,6 +1918,8 @@ declare namespace sap {
1767
1918
  ): any[];
1768
1919
  /**
1769
1920
  * Creates a copy of an array in which the items are copied by reference rather than being cloned.
1921
+ *
1922
+ * @returns The cloned array
1770
1923
  */
1771
1924
  shallowClone(
1772
1925
  /**
@@ -1776,6 +1929,8 @@ declare namespace sap {
1776
1929
  ): any[];
1777
1930
  /**
1778
1931
  * Converts an array to an ES6 Set.
1932
+ *
1933
+ * @returns The Set containing the same set of unique items as the array.
1779
1934
  */
1780
1935
  toSet(
1781
1936
  /**
@@ -1785,6 +1940,8 @@ declare namespace sap {
1785
1940
  ): Set<any>;
1786
1941
  /**
1787
1942
  * Returns the set union (as an array) of a group of arrays.
1943
+ *
1944
+ * @returns The set union of the arrays.
1788
1945
  */
1789
1946
  union(
1790
1947
  /**
@@ -1805,6 +1962,8 @@ declare namespace sap {
1805
1962
  * - If the parameter is an array of length 0, `undefined` is returned.
1806
1963
  * - If the parameter is an array of length 1, the first element of the array is returned.
1807
1964
  * - Otherwise if the parameter is an array of length > 1, the parameter is returned (as an array).
1965
+ *
1966
+ * @returns The unwrapped value.
1808
1967
  */
1809
1968
  unwrap(
1810
1969
  /**
@@ -1819,6 +1978,9 @@ declare namespace sap {
1819
1978
  * - If the parameter is an array, the parameter is returned.
1820
1979
  * - If the parameter is `undefined` an empty array is returned.
1821
1980
  * - Otherwise a single element array containing the parameter value is returned.
1981
+ *
1982
+ * @returns The parameter if it is an array, otherwise returns a single element array containing the parameter
1983
+ * value
1822
1984
  */
1823
1985
  wrap(
1824
1986
  /**
@@ -1837,6 +1999,8 @@ declare namespace sap {
1837
1999
  interface DescriptorUtilities {
1838
2000
  /**
1839
2001
  * Creates a descriptor for an identifier.
2002
+ *
2003
+ * @returns The descriptor representing the identifier.
1840
2004
  */
1841
2005
  createIdentifierDescriptor(
1842
2006
  /**
@@ -1850,6 +2014,8 @@ declare namespace sap {
1850
2014
  ): string;
1851
2015
  /**
1852
2016
  * Creates a descriptor for a metadata field.
2017
+ *
2018
+ * @returns The descriptor representing the metadata field.
1853
2019
  */
1854
2020
  createMetadataDescriptor(
1855
2021
  /**
@@ -1872,6 +2038,8 @@ declare namespace sap {
1872
2038
  interface HashUtilities {
1873
2039
  /**
1874
2040
  * Creates a single hash code from a set of hash code values and normalizes it using {@link sap.ui.vtm.HashUtilities.normalizeHash}.
2041
+ *
2042
+ * @returns The combined hash code.
1875
2043
  */
1876
2044
  combineHashes(
1877
2045
  /**
@@ -1888,6 +2056,8 @@ declare namespace sap {
1888
2056
  *
1889
2057
  * The resulting hash value can be any integer value. Use {@link sap.ui.vtm.HashUtilities.normalizeHash}
1890
2058
  * on the result to create a hash code that is useful as a key in a {@link sap.ui.vtm.Lookup}.
2059
+ *
2060
+ * @returns The hash code for the specified transformation matrix.
1891
2061
  */
1892
2062
  hashMatrix(
1893
2063
  /**
@@ -1900,6 +2070,8 @@ declare namespace sap {
1900
2070
  *
1901
2071
  * The resulting hash value can be any integer value. Use {@link sap.ui.vtm.HashUtilities.normalizeHash}
1902
2072
  * on the result to create a hash code that is useful as a key in a {@link sap.ui.vtm.Lookup}.
2073
+ *
2074
+ * @returns The hash code value for the string.
1903
2075
  */
1904
2076
  hashString(
1905
2077
  /**
@@ -1910,6 +2082,8 @@ declare namespace sap {
1910
2082
  /**
1911
2083
  * Normalizes a hash code to a range between 0 and an upper bound. Useful for creating a hash code that
1912
2084
  * can be used as a key in a {@link sap.ui.vtm.Lookup} (to limit the number of buckets in the lookup).
2085
+ *
2086
+ * @returns The normalized hash code.
1913
2087
  */
1914
2088
  normalizeHash(
1915
2089
  /**
@@ -1932,34 +2106,50 @@ declare namespace sap {
1932
2106
  interface InternalColumns {
1933
2107
  /**
1934
2108
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.AbsoluteMatrix} column.
2109
+ *
2110
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.AbsoluteMatrix} column.
1935
2111
  */
1936
2112
  createAbsoluteMatrixColumn(): sap.ui.vtm.Column;
1937
2113
  /**
1938
2114
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus} internal column.
2115
+ *
2116
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus} internal column.
1939
2117
  */
1940
2118
  createMessageStatusColumn(): sap.ui.vtm.Column;
1941
2119
  /**
1942
2120
  * Creates an {@link sap.ui.vtm.InternalColumnDescriptor.Opacity} column.
2121
+ *
2122
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Opacity} column.
1943
2123
  */
1944
2124
  createOpacityColumn(): sap.ui.vtm.Column;
1945
2125
  /**
1946
2126
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.RelativeMatrix} column.
2127
+ *
2128
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.RelativeMatrix} column.
1947
2129
  */
1948
2130
  createRelativeMatrixColumn(): sap.ui.vtm.Column;
1949
2131
  /**
1950
2132
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.SceneNodeIds} column.
2133
+ *
2134
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.SceneNodeIds} column.
1951
2135
  */
1952
2136
  createSceneNodeIdsColumn(): sap.ui.vtm.Column;
1953
2137
  /**
1954
2138
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.Tree} internal column.
2139
+ *
2140
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Tree} internal column.
1955
2141
  */
1956
2142
  createTreeColumn(): sap.ui.vtm.Column;
1957
2143
  /**
1958
2144
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.TreeItemId} column.
2145
+ *
2146
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.TreeItemId} column.
1959
2147
  */
1960
2148
  createTreeItemIdColumn(): sap.ui.vtm.Column;
1961
2149
  /**
1962
2150
  * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} internal column.
2151
+ *
2152
+ * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} internal column.
1963
2153
  */
1964
2154
  createVisibilityColumn(): sap.ui.vtm.Column;
1965
2155
  }
@@ -1974,6 +2164,8 @@ declare namespace sap {
1974
2164
  interface MatrixUtilities {
1975
2165
  /**
1976
2166
  * Returns true when the two matrix parameters are equal.
2167
+ *
2168
+ * @returns `true` if the two matrix parameters are equal.
1977
2169
  */
1978
2170
  areEqual(
1979
2171
  /**
@@ -1987,10 +2179,14 @@ declare namespace sap {
1987
2179
  ): boolean;
1988
2180
  /**
1989
2181
  * Returns an identity transformation matrix.
2182
+ *
2183
+ * @returns A new identity transformation matrix.
1990
2184
  */
1991
2185
  createIdentity(): sap.ui.vtm.Matrix;
1992
2186
  /**
1993
2187
  * Converts a 4x4 transformation matrix to a {@link sap.ui.vtm.Matrix}.
2188
+ *
2189
+ * @returns The {@link sap.ui.vtm.Matrix} value.
1994
2190
  */
1995
2191
  from4x4Matrix(
1996
2192
  /**
@@ -2001,6 +2197,8 @@ declare namespace sap {
2001
2197
  /**
2002
2198
  * Converts a {@link sap.ui.vk.TransformationMatrix} (as used by the sap.ui.vk library) to a {@link sap.ui.vtm.Matrix}
2003
2199
  * value.
2200
+ *
2201
+ * @returns The {@link sap.ui.vtm.Matrix} value.
2004
2202
  */
2005
2203
  fromVkMatrix(
2006
2204
  /**
@@ -2010,6 +2208,8 @@ declare namespace sap {
2010
2208
  ): sap.ui.vtm.Matrix;
2011
2209
  /**
2012
2210
  * Converts a VSM transformation matrix string to a {@link sap.ui.vtm.Matrix} value.
2211
+ *
2212
+ * @returns The {@link sap.ui.vtm.Matrix} value.
2013
2213
  */
2014
2214
  fromVsmMatrixString(
2015
2215
  /**
@@ -2019,6 +2219,8 @@ declare namespace sap {
2019
2219
  ): sap.ui.vtm.Matrix;
2020
2220
  /**
2021
2221
  * Returns the inverse of the passed matrix without modifying the passed matrix.
2222
+ *
2223
+ * @returns The inverse of the specified matrix.
2022
2224
  */
2023
2225
  invert(
2024
2226
  /**
@@ -2028,6 +2230,8 @@ declare namespace sap {
2028
2230
  ): sap.ui.vtm.Matrix;
2029
2231
  /**
2030
2232
  * Returns whether a matrix is invertible.
2233
+ *
2234
+ * @returns Whether the matrix is invertible.
2031
2235
  */
2032
2236
  isInvertible(
2033
2237
  /**
@@ -2037,6 +2241,8 @@ declare namespace sap {
2037
2241
  ): boolean;
2038
2242
  /**
2039
2243
  * Returns true if the parameter represents a valid transformation matrix.
2244
+ *
2245
+ * @returns true if the parameter represents a valid transformation matrix.
2040
2246
  */
2041
2247
  isValid(
2042
2248
  /**
@@ -2052,6 +2258,8 @@ declare namespace sap {
2052
2258
  ): boolean;
2053
2259
  /**
2054
2260
  * Returns the result of multiplying two matrices (without modifying the passed matrices).
2261
+ *
2262
+ * @returns The matrix representing the multiplication result.
2055
2263
  */
2056
2264
  multiply(
2057
2265
  /**
@@ -2065,6 +2273,8 @@ declare namespace sap {
2065
2273
  ): sap.ui.vtm.Matrix;
2066
2274
  /**
2067
2275
  * Converts a {@link sap.ui.vtm.Matrix} to a 4x4 transformation matrix.
2276
+ *
2277
+ * @returns A 4x4 transformation matrix (represented as an array of arrays of numbers).
2068
2278
  */
2069
2279
  to4x4Matrix(
2070
2280
  /**
@@ -2075,6 +2285,8 @@ declare namespace sap {
2075
2285
  /**
2076
2286
  * Converts a {@link sap.ui.vtm.Matrix} value to a {@link sap.ui.vk.TransformationMatrix} as used by the
2077
2287
  * sap.ui.vk library.
2288
+ *
2289
+ * @returns The {@link sap.ui.vk.TransformationMatrix} value.
2078
2290
  */
2079
2291
  toVkMatrix(
2080
2292
  /**
@@ -2084,6 +2296,8 @@ declare namespace sap {
2084
2296
  ): sap.ui.vk.TransformationMatrix;
2085
2297
  /**
2086
2298
  * Converts a {@link sap.ui.vtm.Matrix} value to a VSM transformation matrix string.
2299
+ *
2300
+ * @returns The VSM transformation matrix string.
2087
2301
  */
2088
2302
  toVsmMatrixString(
2089
2303
  /**
@@ -2168,6 +2382,8 @@ declare namespace sap {
2168
2382
  /**
2169
2383
  * Calculates the absolute matrix that should be applied to a tree item given its relative matrix and the
2170
2384
  * absolute matrix of its parent.
2385
+ *
2386
+ * @returns The calculated absolute matrix.
2171
2387
  */
2172
2388
  calculateAbsoluteMatrix(
2173
2389
  /**
@@ -2182,6 +2398,8 @@ declare namespace sap {
2182
2398
  /**
2183
2399
  * Calculates the relative matrix that should be applied to a tree item given its absolute matrix and the
2184
2400
  * absolute matrix of its parent.
2401
+ *
2402
+ * @returns The calculated relative matrix.
2185
2403
  */
2186
2404
  calculateRelativeMatrix(
2187
2405
  /**
@@ -2195,6 +2413,8 @@ declare namespace sap {
2195
2413
  ): sap.ui.vtm.Matrix;
2196
2414
  /**
2197
2415
  * Returns a cloned copy of the appData on the passed tree item.
2416
+ *
2417
+ * @returns A cloned copy of the appData on the passed tree item.
2198
2418
  */
2199
2419
  cloneAppData(
2200
2420
  /**
@@ -2204,6 +2424,8 @@ declare namespace sap {
2204
2424
  ): object;
2205
2425
  /**
2206
2426
  * Returns a cloned copy of the identifiers on the passed tree item.
2427
+ *
2428
+ * @returns A cloned copy of the metadata on the passed tree item.
2207
2429
  */
2208
2430
  cloneIdentifiers(
2209
2431
  /**
@@ -2213,6 +2435,8 @@ declare namespace sap {
2213
2435
  ): object;
2214
2436
  /**
2215
2437
  * Returns a cloned copy of the metadata on the passed tree item.
2438
+ *
2439
+ * @returns A cloned copy of the metadata on the passed tree item.
2216
2440
  */
2217
2441
  cloneMetadata(
2218
2442
  /**
@@ -2237,6 +2461,8 @@ declare namespace sap {
2237
2461
  ): void;
2238
2462
  /**
2239
2463
  * Gets the application data field descriptors for a given tree item.
2464
+ *
2465
+ * @returns The application data field descriptors for the given tree item.
2240
2466
  */
2241
2467
  getAppDataDescriptors(
2242
2468
  /**
@@ -2246,6 +2472,8 @@ declare namespace sap {
2246
2472
  ): string[];
2247
2473
  /**
2248
2474
  * Gets the application data values associated with a particular descriptor for a tree item.
2475
+ *
2476
+ * @returns The application data values.
2249
2477
  */
2250
2478
  getAppDataValues(
2251
2479
  /**
@@ -2259,6 +2487,8 @@ declare namespace sap {
2259
2487
  ): string[] | number[] | boolean[] | object[];
2260
2488
  /**
2261
2489
  * Gets the children of a tree item from the `includedChildren` and/or `excludedChildren` collections.
2490
+ *
2491
+ * @returns The children of the tree item of the given type.
2262
2492
  */
2263
2493
  getChildren(
2264
2494
  /**
@@ -2279,6 +2509,8 @@ declare namespace sap {
2279
2509
  ): object[];
2280
2510
  /**
2281
2511
  * Gets the excluded children of a tree item.
2512
+ *
2513
+ * @returns The excluded children of the tree item.
2282
2514
  */
2283
2515
  getExcludedChildren(
2284
2516
  /**
@@ -2288,6 +2520,8 @@ declare namespace sap {
2288
2520
  ): object[];
2289
2521
  /**
2290
2522
  * Gets the identifier descriptors for a given tree item.
2523
+ *
2524
+ * @returns The identifier descriptors for the given tree item.
2291
2525
  */
2292
2526
  getIdentifierDescriptors(
2293
2527
  /**
@@ -2297,6 +2531,8 @@ declare namespace sap {
2297
2531
  ): string[];
2298
2532
  /**
2299
2533
  * Gets the identifier values associated with a particular descriptor for a tree item.
2534
+ *
2535
+ * @returns The identifier values.
2300
2536
  */
2301
2537
  getIdentifierValues(
2302
2538
  /**
@@ -2310,6 +2546,8 @@ declare namespace sap {
2310
2546
  ): string[];
2311
2547
  /**
2312
2548
  * Gets the included children of a tree item.
2549
+ *
2550
+ * @returns The included children of the tree item.
2313
2551
  */
2314
2552
  getIncludedChildren(
2315
2553
  /**
@@ -2319,6 +2557,8 @@ declare namespace sap {
2319
2557
  ): object[];
2320
2558
  /**
2321
2559
  * Gets the messages stored on a tree item.
2560
+ *
2561
+ * @returns The tree item messages.
2322
2562
  */
2323
2563
  getMessages(
2324
2564
  /**
@@ -2328,6 +2568,8 @@ declare namespace sap {
2328
2568
  ): sap.ui.core.Message[];
2329
2569
  /**
2330
2570
  * Gets the metadata field descriptors for a given tree item.
2571
+ *
2572
+ * @returns The metadata field descriptors for the given tree item.
2331
2573
  */
2332
2574
  getMetadataDescriptors(
2333
2575
  /**
@@ -2337,6 +2579,8 @@ declare namespace sap {
2337
2579
  ): string[];
2338
2580
  /**
2339
2581
  * Gets the metadata values associated with a particular descriptor for a tree item.
2582
+ *
2583
+ * @returns The metadata values.
2340
2584
  */
2341
2585
  getMetadataValues(
2342
2586
  /**
@@ -2350,6 +2594,8 @@ declare namespace sap {
2350
2594
  ): string[] | number[] | boolean[] | object[];
2351
2595
  /**
2352
2596
  * Gets the IDs of the scene nodes associated with a tree item as an array of strings.
2597
+ *
2598
+ * @returns The scene node IDs for the tree item.
2353
2599
  */
2354
2600
  getSceneNodeIds(
2355
2601
  /**
@@ -2359,6 +2605,8 @@ declare namespace sap {
2359
2605
  ): string[];
2360
2606
  /**
2361
2607
  * Gets whether a tree item has items in the `includedChildren` and/or `excludedChildren` collections.
2608
+ *
2609
+ * @returns Whether the tree item has children of the given type.
2362
2610
  */
2363
2611
  hasChildren(
2364
2612
  /**
@@ -2380,6 +2628,8 @@ declare namespace sap {
2380
2628
  ): boolean;
2381
2629
  /**
2382
2630
  * Gets whether a tree item has excluded children.
2631
+ *
2632
+ * @returns The excluded children of the tree item.
2383
2633
  */
2384
2634
  hasExcludedChildren(
2385
2635
  /**
@@ -2389,6 +2639,8 @@ declare namespace sap {
2389
2639
  ): object[];
2390
2640
  /**
2391
2641
  * Gets whether a tree item has included children.
2642
+ *
2643
+ * @returns The included children of the tree item.
2392
2644
  */
2393
2645
  hasIncludedChildren(
2394
2646
  /**
@@ -2398,6 +2650,8 @@ declare namespace sap {
2398
2650
  ): object[];
2399
2651
  /**
2400
2652
  * Returns whether the tree item has a `visibility` value.
2653
+ *
2654
+ * @returns Whether the tree item has a `visibility` value.
2401
2655
  */
2402
2656
  hasVisibility(
2403
2657
  /**
@@ -2422,6 +2676,8 @@ declare namespace sap {
2422
2676
  ): void;
2423
2677
  /**
2424
2678
  * Applies a mapping function to each tree item in a branch of a tree to create a new tree branch.
2679
+ *
2680
+ * @returns The mapped tree branch.
2425
2681
  */
2426
2682
  mapBranch(
2427
2683
  /**
@@ -2435,6 +2691,8 @@ declare namespace sap {
2435
2691
  ): object;
2436
2692
  /**
2437
2693
  * Applies a mapping function to each tree item in a tree to create a new tree.
2694
+ *
2695
+ * @returns The root tree items of the mapped tree.
2438
2696
  */
2439
2697
  mapTree(
2440
2698
  /**
@@ -2449,6 +2707,8 @@ declare namespace sap {
2449
2707
  /**
2450
2708
  * Removes a child tree item from the `includedChildren` and/or `excludedChildren` collection of its parent
2451
2709
  * tree item.
2710
+ *
2711
+ * @returns Returns the deleted item or undefined if no item was removed.
2452
2712
  */
2453
2713
  removeChild(
2454
2714
  /**
@@ -2475,6 +2735,8 @@ declare namespace sap {
2475
2735
  ): object | undefined;
2476
2736
  /**
2477
2737
  * Removes a child tree item from the `excludedChildren` collection of its parent tree item.
2738
+ *
2739
+ * @returns Returns the deleted item or undefined if no item was removed.
2478
2740
  */
2479
2741
  removeExcludedChild(
2480
2742
  /**
@@ -2488,6 +2750,8 @@ declare namespace sap {
2488
2750
  ): object | undefined;
2489
2751
  /**
2490
2752
  * Removes a child tree item from the `includedChildren` collection of its parent tree item.
2753
+ *
2754
+ * @returns Returns the deleted item or undefined if no item was removed.
2491
2755
  */
2492
2756
  removeIncludedChild(
2493
2757
  /**
@@ -2501,6 +2765,8 @@ declare namespace sap {
2501
2765
  ): object | undefined;
2502
2766
  /**
2503
2767
  * Removes a root item from the tree.
2768
+ *
2769
+ * @returns Returns the deleted item or undefined if no item was removed.
2504
2770
  */
2505
2771
  removeRoot(
2506
2772
  /**
@@ -2709,6 +2975,8 @@ declare namespace sap {
2709
2975
  ): void;
2710
2976
  /**
2711
2977
  * Validates a tree and returns a set of error messages.
2978
+ *
2979
+ * @returns The set of validation errors for the tree item.
2712
2980
  */
2713
2981
  validateTree(
2714
2982
  /**
@@ -2718,6 +2986,8 @@ declare namespace sap {
2718
2986
  ): string[];
2719
2987
  /**
2720
2988
  * Validates a tree item and returns a set of error messages.
2989
+ *
2990
+ * @returns The set of validation errors for the tree item.
2721
2991
  */
2722
2992
  validateTreeItem(
2723
2993
  /**
@@ -2757,6 +3027,8 @@ declare namespace sap {
2757
3027
  * contained in `oClassInfo`.
2758
3028
  *
2759
3029
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3030
+ *
3031
+ * @returns Created class / constructor function
2760
3032
  */
2761
3033
  static extend<T extends Record<string, unknown>>(
2762
3034
  /**
@@ -2775,6 +3047,8 @@ declare namespace sap {
2775
3047
  ): Function;
2776
3048
  /**
2777
3049
  * Returns a metadata object for class sap.ui.vtm.Column.
3050
+ *
3051
+ * @returns Metadata object describing this class
2778
3052
  */
2779
3053
  static getMetadata(): sap.ui.core.ElementMetadata;
2780
3054
  /**
@@ -2792,6 +3066,8 @@ declare namespace sap {
2792
3066
  *
2793
3067
  * When the type property has a value of {@link sap.ui.vtm.ColumnType.AppData} the descriptor property has
2794
3068
  * the following form: `'bomId'`
3069
+ *
3070
+ * @returns Value of property `descriptor`
2795
3071
  */
2796
3072
  getDescriptor(): string;
2797
3073
  /**
@@ -2800,6 +3076,8 @@ declare namespace sap {
2800
3076
  * The horizontal alignment for the tree column.
2801
3077
  *
2802
3078
  * Default value is `"Left"`.
3079
+ *
3080
+ * @returns Value of property `hAlign`
2803
3081
  */
2804
3082
  getHAlign(): sap.ui.core.HorizontalAlign;
2805
3083
  /**
@@ -2807,6 +3085,8 @@ declare namespace sap {
2807
3085
  *
2808
3086
  * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so
2809
3087
  * it should be included whether or not the `labelControl` property is used.
3088
+ *
3089
+ * @returns Value of property `label`
2810
3090
  */
2811
3091
  getLabel(): string;
2812
3092
  /**
@@ -2815,6 +3095,8 @@ declare namespace sap {
2815
3095
  * A {@link sap.ui.core.Control} that is used in the column header. When specified, this is used in preference
2816
3096
  * to the `label` property as the column header content. However the `label` property should also be specified
2817
3097
  * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}.
3098
+ *
3099
+ * @returns Value of property `labelControl`
2818
3100
  */
2819
3101
  getLabelControl(): object;
2820
3102
  /**
@@ -2823,6 +3105,8 @@ declare namespace sap {
2823
3105
  * If set to true, the column can be resized.
2824
3106
  *
2825
3107
  * Default value is `true`.
3108
+ *
3109
+ * @returns Value of property `resizable`
2826
3110
  */
2827
3111
  getResizable(): boolean;
2828
3112
  /**
@@ -2830,6 +3114,8 @@ declare namespace sap {
2830
3114
  *
2831
3115
  * If defined, overrides the cell template for the column.
2832
3116
  * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored.
3117
+ *
3118
+ * @returns Value of property `template`
2833
3119
  */
2834
3120
  getTemplate(): sap.ui.core.Control;
2835
3121
  /**
@@ -2837,6 +3123,8 @@ declare namespace sap {
2837
3123
  *
2838
3124
  * A localized string to show in the column header tooltip. If unspecified, the label value will be used
2839
3125
  * as the column header tooltip.
3126
+ *
3127
+ * @returns Value of property `tooltip`
2840
3128
  */
2841
3129
  getTooltip(): string;
2842
3130
  /**
@@ -2849,12 +3137,16 @@ declare namespace sap {
2849
3137
  * tree item.
2850
3138
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
2851
3139
  * table row.
3140
+ *
3141
+ * @returns Value of property `tooltipFormatter`
2852
3142
  */
2853
3143
  getTooltipFormatter(): any;
2854
3144
  /**
2855
3145
  * Gets current value of property {@link #getType type}.
2856
3146
  *
2857
3147
  * The type of column.
3148
+ *
3149
+ * @returns Value of property `type`
2858
3150
  */
2859
3151
  getType(): sap.ui.vtm.ColumnType;
2860
3152
  /**
@@ -2865,6 +3157,8 @@ declare namespace sap {
2865
3157
  * item.
2866
3158
  * The first parameter to the function (which may not always be defined) is the tree item for the tree
2867
3159
  * table row.
3160
+ *
3161
+ * @returns Value of property `valueFormatter`
2868
3162
  */
2869
3163
  getValueFormatter(): any;
2870
3164
  /**
@@ -2873,6 +3167,8 @@ declare namespace sap {
2873
3167
  * The width of the tree column.
2874
3168
  *
2875
3169
  * Default value is `"200px"`.
3170
+ *
3171
+ * @returns Value of property `width`
2876
3172
  */
2877
3173
  getWidth(): sap.ui.core.CSSSize;
2878
3174
  /**
@@ -2892,6 +3188,8 @@ declare namespace sap {
2892
3188
  * the following form: `'bomId'`
2893
3189
  *
2894
3190
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3191
+ *
3192
+ * @returns Reference to `this` in order to allow method chaining
2895
3193
  */
2896
3194
  setDescriptor(
2897
3195
  /**
@@ -2907,6 +3205,8 @@ declare namespace sap {
2907
3205
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2908
3206
  *
2909
3207
  * Default value is `"Left"`.
3208
+ *
3209
+ * @returns Reference to `this` in order to allow method chaining
2910
3210
  */
2911
3211
  setHAlign(
2912
3212
  /**
@@ -2921,6 +3221,8 @@ declare namespace sap {
2921
3221
  * it should be included whether or not the `labelControl` property is used.
2922
3222
  *
2923
3223
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3224
+ *
3225
+ * @returns Reference to `this` in order to allow method chaining
2924
3226
  */
2925
3227
  setLabel(
2926
3228
  /**
@@ -2936,6 +3238,8 @@ declare namespace sap {
2936
3238
  * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}.
2937
3239
  *
2938
3240
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3241
+ *
3242
+ * @returns Reference to `this` in order to allow method chaining
2939
3243
  */
2940
3244
  setLabelControl(
2941
3245
  /**
@@ -2951,6 +3255,8 @@ declare namespace sap {
2951
3255
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2952
3256
  *
2953
3257
  * Default value is `true`.
3258
+ *
3259
+ * @returns Reference to `this` in order to allow method chaining
2954
3260
  */
2955
3261
  setResizable(
2956
3262
  /**
@@ -2965,6 +3271,8 @@ declare namespace sap {
2965
3271
  * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored.
2966
3272
  *
2967
3273
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3274
+ *
3275
+ * @returns Reference to `this` in order to allow method chaining
2968
3276
  */
2969
3277
  setTemplate(
2970
3278
  /**
@@ -2979,6 +3287,8 @@ declare namespace sap {
2979
3287
  * as the column header tooltip.
2980
3288
  *
2981
3289
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3290
+ *
3291
+ * @returns Reference to `this` in order to allow method chaining
2982
3292
  */
2983
3293
  setTooltip(
2984
3294
  /**
@@ -2999,6 +3309,8 @@ declare namespace sap {
2999
3309
  * table row.
3000
3310
  *
3001
3311
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3312
+ *
3313
+ * @returns Reference to `this` in order to allow method chaining
3002
3314
  */
3003
3315
  setTooltipFormatter(
3004
3316
  /**
@@ -3012,6 +3324,8 @@ declare namespace sap {
3012
3324
  * The type of column.
3013
3325
  *
3014
3326
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3327
+ *
3328
+ * @returns Reference to `this` in order to allow method chaining
3015
3329
  */
3016
3330
  setType(
3017
3331
  /**
@@ -3029,6 +3343,8 @@ declare namespace sap {
3029
3343
  * table row.
3030
3344
  *
3031
3345
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3346
+ *
3347
+ * @returns Reference to `this` in order to allow method chaining
3032
3348
  */
3033
3349
  setValueFormatter(
3034
3350
  /**
@@ -3044,6 +3360,8 @@ declare namespace sap {
3044
3360
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3045
3361
  *
3046
3362
  * Default value is `"200px"`.
3363
+ *
3364
+ * @returns Reference to `this` in order to allow method chaining
3047
3365
  */
3048
3366
  setWidth(
3049
3367
  /**
@@ -3082,6 +3400,8 @@ declare namespace sap {
3082
3400
  * information contained in `oClassInfo`.
3083
3401
  *
3084
3402
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3403
+ *
3404
+ * @returns Created class / constructor function
3085
3405
  */
3086
3406
  static extend<T extends Record<string, unknown>>(
3087
3407
  /**
@@ -3100,6 +3420,8 @@ declare namespace sap {
3100
3420
  ): Function;
3101
3421
  /**
3102
3422
  * Returns a metadata object for class sap.ui.vtm.DisplayGroup.
3423
+ *
3424
+ * @returns Metadata object describing this class
3103
3425
  */
3104
3426
  static getMetadata(): sap.ui.core.ElementMetadata;
3105
3427
  /**
@@ -3126,6 +3448,8 @@ declare namespace sap {
3126
3448
  * Display state objects can be reused multiple times in the map to reduce memory usage.
3127
3449
  *
3128
3450
  * Default value is `{}`.
3451
+ *
3452
+ * @returns Value of property `displayStatesBySceneNodeId`
3129
3453
  */
3130
3454
  getDisplayStatesBySceneNodeId(): object;
3131
3455
  /**
@@ -3154,6 +3478,8 @@ declare namespace sap {
3154
3478
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3155
3479
  *
3156
3480
  * Default value is `{}`.
3481
+ *
3482
+ * @returns Reference to `this` in order to allow method chaining
3157
3483
  */
3158
3484
  setDisplayStatesBySceneNodeId(
3159
3485
  /**
@@ -3203,6 +3529,8 @@ declare namespace sap {
3203
3529
  * information contained in `oClassInfo`.
3204
3530
  *
3205
3531
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3532
+ *
3533
+ * @returns Created class / constructor function
3206
3534
  */
3207
3535
  static extend<T extends Record<string, unknown>>(
3208
3536
  /**
@@ -3221,6 +3549,8 @@ declare namespace sap {
3221
3549
  ): Function;
3222
3550
  /**
3223
3551
  * Returns a metadata object for class sap.ui.vtm.Extension.
3552
+ *
3553
+ * @returns Metadata object describing this class
3224
3554
  */
3225
3555
  static getMetadata(): sap.ui.core.ElementMetadata;
3226
3556
  /**
@@ -3243,6 +3573,8 @@ declare namespace sap {
3243
3573
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3244
3574
  *
3245
3575
  * Fired when the enabled property is changed.
3576
+ *
3577
+ * @returns Reference to `this` in order to allow method chaining
3246
3578
  */
3247
3579
  attachEnabledChanged(
3248
3580
  /**
@@ -3267,6 +3599,8 @@ declare namespace sap {
3267
3599
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3268
3600
  *
3269
3601
  * Fired when the enabled property is changed.
3602
+ *
3603
+ * @returns Reference to `this` in order to allow method chaining
3270
3604
  */
3271
3605
  attachEnabledChanged(
3272
3606
  /**
@@ -3285,6 +3619,8 @@ declare namespace sap {
3285
3619
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3286
3620
  *
3287
3621
  * Fired when initialization has completed.
3622
+ *
3623
+ * @returns Reference to `this` in order to allow method chaining
3288
3624
  */
3289
3625
  attachInitialized(
3290
3626
  /**
@@ -3308,6 +3644,8 @@ declare namespace sap {
3308
3644
  * otherwise it will be bound to this `sap.ui.vtm.Extension` itself.
3309
3645
  *
3310
3646
  * Fired when initialization has completed.
3647
+ *
3648
+ * @returns Reference to `this` in order to allow method chaining
3311
3649
  */
3312
3650
  attachInitialized(
3313
3651
  /**
@@ -3324,6 +3662,8 @@ declare namespace sap {
3324
3662
  *
3325
3663
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
3326
3664
  * of the possible properties of `oBindingInfo`
3665
+ *
3666
+ * @returns Reference to `this` in order to allow method chaining
3327
3667
  */
3328
3668
  bindEnabled(
3329
3669
  /**
@@ -3336,6 +3676,8 @@ declare namespace sap {
3336
3676
  * `sap.ui.vtm.Extension`.
3337
3677
  *
3338
3678
  * The passed function and listener object must match the ones used for event registration.
3679
+ *
3680
+ * @returns Reference to `this` in order to allow method chaining
3339
3681
  */
3340
3682
  detachEnabledChanged(
3341
3683
  /**
@@ -3351,6 +3693,8 @@ declare namespace sap {
3351
3693
  * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Extension`.
3352
3694
  *
3353
3695
  * The passed function and listener object must match the ones used for event registration.
3696
+ *
3697
+ * @returns Reference to `this` in order to allow method chaining
3354
3698
  */
3355
3699
  detachInitialized(
3356
3700
  /**
@@ -3364,6 +3708,8 @@ declare namespace sap {
3364
3708
  ): this;
3365
3709
  /**
3366
3710
  * Fires event {@link #event:enabledChanged enabledChanged} to attached listeners.
3711
+ *
3712
+ * @returns Reference to `this` in order to allow method chaining
3367
3713
  */
3368
3714
  fireEnabledChanged(
3369
3715
  /**
@@ -3373,6 +3719,8 @@ declare namespace sap {
3373
3719
  ): this;
3374
3720
  /**
3375
3721
  * Fires event {@link #event:initialized initialized} to attached listeners.
3722
+ *
3723
+ * @returns Reference to `this` in order to allow method chaining
3376
3724
  */
3377
3725
  fireInitialized(
3378
3726
  /**
@@ -3386,6 +3734,8 @@ declare namespace sap {
3386
3734
  * Controls whether the extension is enabled.
3387
3735
  *
3388
3736
  * Default value is `true`.
3737
+ *
3738
+ * @returns Value of property `enabled`
3389
3739
  */
3390
3740
  getEnabled(): boolean;
3391
3741
  /**
@@ -3394,6 +3744,9 @@ declare namespace sap {
3394
3744
  *
3395
3745
  * The {@link #initialize initialize} method is called after the {@link Promise} returned by {@link #getVtmPromise
3396
3746
  * getVtmPromise} resolves.
3747
+ *
3748
+ * @returns A {@link Promise} that is resolved after the {@link #initialize initialize} method has been
3749
+ * called for the extension.
3397
3750
  */
3398
3751
  getInitializedPromise(): Promise<any>;
3399
3752
  /**
@@ -3401,6 +3754,9 @@ declare namespace sap {
3401
3754
  * {@link sap.ui.vtm.Vtm} instance.
3402
3755
  *
3403
3756
  * The relevant {@link sap.ui.vtm.Vtm} instance is passed to the resolve handler.
3757
+ *
3758
+ * @returns A {@link Promise} that is resolved when the extension is added to the `extensions` aggregation
3759
+ * of an {@link sap.ui.vtm.Vtm} instance.
3404
3760
  */
3405
3761
  getVtmPromise(): Promise<any>;
3406
3762
  /**
@@ -3420,6 +3776,8 @@ declare namespace sap {
3420
3776
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3421
3777
  *
3422
3778
  * Default value is `true`.
3779
+ *
3780
+ * @returns Reference to `this` in order to allow method chaining
3423
3781
  */
3424
3782
  setEnabled(
3425
3783
  /**
@@ -3429,6 +3787,8 @@ declare namespace sap {
3429
3787
  ): this;
3430
3788
  /**
3431
3789
  * Unbinds property {@link #getEnabled enabled} from model data.
3790
+ *
3791
+ * @returns Reference to `this` in order to allow method chaining
3432
3792
  */
3433
3793
  unbindEnabled(): this;
3434
3794
  }
@@ -3469,6 +3829,8 @@ declare namespace sap {
3469
3829
  * contained in `oClassInfo`.
3470
3830
  *
3471
3831
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3832
+ *
3833
+ * @returns Created class / constructor function
3472
3834
  */
3473
3835
  static extend<T extends Record<string, unknown>>(
3474
3836
  /**
@@ -3487,10 +3849,14 @@ declare namespace sap {
3487
3849
  ): Function;
3488
3850
  /**
3489
3851
  * Returns a metadata object for class sap.ui.vtm.Lookup.
3852
+ *
3853
+ * @returns Metadata object describing this class
3490
3854
  */
3491
3855
  static getMetadata(): sap.ui.core.ElementMetadata;
3492
3856
  /**
3493
3857
  * Adds a value to the set of values stored against a given key.
3858
+ *
3859
+ * @returns `this` for method chaining.
3494
3860
  */
3495
3861
  addValue(
3496
3862
  /**
@@ -3504,10 +3870,14 @@ declare namespace sap {
3504
3870
  ): sap.ui.vtm.Lookup;
3505
3871
  /**
3506
3872
  * Clears the Lookup.
3873
+ *
3874
+ * @returns `this` for method chaining.
3507
3875
  */
3508
3876
  clear(): sap.ui.vtm.Lookup;
3509
3877
  /**
3510
3878
  * Loops over the key/value array pairs calling the callback function for each pair.
3879
+ *
3880
+ * @returns `this` for method chaining.
3511
3881
  */
3512
3882
  forEach(
3513
3883
  /**
@@ -3518,6 +3888,8 @@ declare namespace sap {
3518
3888
  ): sap.ui.vtm.Lookup;
3519
3889
  /**
3520
3890
  * Gets the values stored against a given key.
3891
+ *
3892
+ * @returns The values (if any) associated with the given key.
3521
3893
  */
3522
3894
  getValues(
3523
3895
  /**
@@ -3527,6 +3899,8 @@ declare namespace sap {
3527
3899
  ): any[];
3528
3900
  /**
3529
3901
  * Returns whether there are any values stored against the given key.
3902
+ *
3903
+ * @returns `true` if there are any values stored against the given key.
3530
3904
  */
3531
3905
  hasValue(
3532
3906
  /**
@@ -3536,6 +3910,8 @@ declare namespace sap {
3536
3910
  ): boolean;
3537
3911
  /**
3538
3912
  * Removes a particular value.
3913
+ *
3914
+ * @returns `this` for method chaining.
3539
3915
  */
3540
3916
  removeValue(
3541
3917
  /**
@@ -3573,6 +3949,8 @@ declare namespace sap {
3573
3949
  * the information contained in `oClassInfo`.
3574
3950
  *
3575
3951
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Popover.extend}.
3952
+ *
3953
+ * @returns Created class / constructor function
3576
3954
  */
3577
3955
  static extend<T extends Record<string, unknown>>(
3578
3956
  /**
@@ -3591,12 +3969,16 @@ declare namespace sap {
3591
3969
  ): Function;
3592
3970
  /**
3593
3971
  * Returns a metadata object for class sap.ui.vtm.MessagesPopover.
3972
+ *
3973
+ * @returns Metadata object describing this class
3594
3974
  */
3595
3975
  static getMetadata(): sap.ui.core.ElementMetadata;
3596
3976
  /**
3597
3977
  * Gets current value of property {@link #getMaxHeight maxHeight}.
3598
3978
  *
3599
3979
  * Maximum height of status window.
3980
+ *
3981
+ * @returns Value of property `maxHeight`
3600
3982
  */
3601
3983
  getMaxHeight(): sap.ui.core.CSSSize;
3602
3984
  /**
@@ -3608,6 +3990,8 @@ declare namespace sap {
3608
3990
  * - `level`
3609
3991
  * - `text`
3610
3992
  * - `icon`
3993
+ *
3994
+ * @returns Value of property `messages`
3611
3995
  */
3612
3996
  getMessages(): object[];
3613
3997
  /**
@@ -3616,6 +4000,8 @@ declare namespace sap {
3616
4000
  * Maximum height of status window.
3617
4001
  *
3618
4002
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4003
+ *
4004
+ * @returns Reference to `this` in order to allow method chaining
3619
4005
  */
3620
4006
  setMaxHeight(
3621
4007
  /**
@@ -3634,6 +4020,8 @@ declare namespace sap {
3634
4020
  * - `icon`
3635
4021
  *
3636
4022
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4023
+ *
4024
+ * @returns Reference to `this` in order to allow method chaining
3637
4025
  */
3638
4026
  setMessages(
3639
4027
  /**
@@ -3677,6 +4065,8 @@ declare namespace sap {
3677
4065
  * contained in `oClassInfo`.
3678
4066
  *
3679
4067
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4068
+ *
4069
+ * @returns Created class / constructor function
3680
4070
  */
3681
4071
  static extend<T extends Record<string, unknown>>(
3682
4072
  /**
@@ -3695,10 +4085,14 @@ declare namespace sap {
3695
4085
  ): Function;
3696
4086
  /**
3697
4087
  * Returns a metadata object for class sap.ui.vtm.Panel.
4088
+ *
4089
+ * @returns Metadata object describing this class
3698
4090
  */
3699
4091
  static getMetadata(): sap.ui.core.ElementMetadata;
3700
4092
  /**
3701
4093
  * Adds some titleControl to the aggregation {@link #getTitleControls titleControls}.
4094
+ *
4095
+ * @returns Reference to `this` in order to allow method chaining
3702
4096
  */
3703
4097
  addTitleControl(
3704
4098
  /**
@@ -3708,6 +4102,8 @@ declare namespace sap {
3708
4102
  ): this;
3709
4103
  /**
3710
4104
  * Adds some treeHeaderControl to the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4105
+ *
4106
+ * @returns Reference to `this` in order to allow method chaining
3711
4107
  */
3712
4108
  addTreeHeaderControl(
3713
4109
  /**
@@ -3717,6 +4113,8 @@ declare namespace sap {
3717
4113
  ): this;
3718
4114
  /**
3719
4115
  * Adds some viewportHeaderControl to the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4116
+ *
4117
+ * @returns Reference to `this` in order to allow method chaining
3720
4118
  */
3721
4119
  addViewportHeaderControl(
3722
4120
  /**
@@ -3732,6 +4130,8 @@ declare namespace sap {
3732
4130
  *
3733
4131
  * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu
3734
4132
  * from being shown call preventDefault() on the event.
4133
+ *
4134
+ * @returns Reference to `this` in order to allow method chaining
3735
4135
  */
3736
4136
  attachContextMenu(
3737
4137
  /**
@@ -3756,6 +4156,8 @@ declare namespace sap {
3756
4156
  *
3757
4157
  * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu
3758
4158
  * from being shown call preventDefault() on the event.
4159
+ *
4160
+ * @returns Reference to `this` in order to allow method chaining
3759
4161
  */
3760
4162
  attachContextMenu(
3761
4163
  /**
@@ -3774,6 +4176,8 @@ declare namespace sap {
3774
4176
  * otherwise it will be bound to this `sap.ui.vtm.Panel` itself.
3775
4177
  *
3776
4178
  * Raised when the panel is initialized.
4179
+ *
4180
+ * @returns Reference to `this` in order to allow method chaining
3777
4181
  */
3778
4182
  attachInitialized(
3779
4183
  /**
@@ -3797,6 +4201,8 @@ declare namespace sap {
3797
4201
  * otherwise it will be bound to this `sap.ui.vtm.Panel` itself.
3798
4202
  *
3799
4203
  * Raised when the panel is initialized.
4204
+ *
4205
+ * @returns Reference to `this` in order to allow method chaining
3800
4206
  */
3801
4207
  attachInitialized(
3802
4208
  /**
@@ -3810,20 +4216,28 @@ declare namespace sap {
3810
4216
  ): this;
3811
4217
  /**
3812
4218
  * Destroys all the titleControls in the aggregation {@link #getTitleControls titleControls}.
4219
+ *
4220
+ * @returns Reference to `this` in order to allow method chaining
3813
4221
  */
3814
4222
  destroyTitleControls(): this;
3815
4223
  /**
3816
4224
  * Destroys all the treeHeaderControls in the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4225
+ *
4226
+ * @returns Reference to `this` in order to allow method chaining
3817
4227
  */
3818
4228
  destroyTreeHeaderControls(): this;
3819
4229
  /**
3820
4230
  * Destroys all the viewportHeaderControls in the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4231
+ *
4232
+ * @returns Reference to `this` in order to allow method chaining
3821
4233
  */
3822
4234
  destroyViewportHeaderControls(): this;
3823
4235
  /**
3824
4236
  * Detaches event handler `fnFunction` from the {@link #event:contextMenu contextMenu} event of this `sap.ui.vtm.Panel`.
3825
4237
  *
3826
4238
  * The passed function and listener object must match the ones used for event registration.
4239
+ *
4240
+ * @returns Reference to `this` in order to allow method chaining
3827
4241
  */
3828
4242
  detachContextMenu(
3829
4243
  /**
@@ -3839,6 +4253,8 @@ declare namespace sap {
3839
4253
  * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Panel`.
3840
4254
  *
3841
4255
  * The passed function and listener object must match the ones used for event registration.
4256
+ *
4257
+ * @returns Reference to `this` in order to allow method chaining
3842
4258
  */
3843
4259
  detachInitialized(
3844
4260
  /**
@@ -3855,6 +4271,8 @@ declare namespace sap {
3855
4271
  *
3856
4272
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
3857
4273
  * event object. The return value of this method indicates whether the default action should be executed.
4274
+ *
4275
+ * @returns Whether or not to prevent the default action
3858
4276
  */
3859
4277
  fireContextMenu(
3860
4278
  /**
@@ -3893,6 +4311,8 @@ declare namespace sap {
3893
4311
  ): boolean;
3894
4312
  /**
3895
4313
  * Fires event {@link #event:initialized initialized} to attached listeners.
4314
+ *
4315
+ * @returns Reference to `this` in order to allow method chaining
3896
4316
  */
3897
4317
  fireInitialized(
3898
4318
  /**
@@ -3906,10 +4326,14 @@ declare namespace sap {
3906
4326
  * The height of the panel.
3907
4327
  *
3908
4328
  * Default value is `"inherit"`.
4329
+ *
4330
+ * @returns Value of property `height`
3909
4331
  */
3910
4332
  getHeight(): sap.ui.core.CSSSize;
3911
4333
  /**
3912
4334
  * Gets whether this is the active {@link sap.ui.vtm.Panel}.
4335
+ *
4336
+ * @returns `true` if this is the active panel.
3913
4337
  */
3914
4338
  getIsActive(): boolean;
3915
4339
  /**
@@ -3918,12 +4342,16 @@ declare namespace sap {
3918
4342
  * Controls whether the viewport will be shown for this panel.
3919
4343
  *
3920
4344
  * Default value is `true`.
4345
+ *
4346
+ * @returns Value of property `showViewport`
3921
4347
  */
3922
4348
  getShowViewport(): boolean;
3923
4349
  /**
3924
4350
  * Gets current value of property {@link #getTitle title}.
3925
4351
  *
3926
4352
  * The text to show in the title bar for this panel.
4353
+ *
4354
+ * @returns Value of property `title`
3927
4355
  */
3928
4356
  getTitle(): string;
3929
4357
  /**
@@ -3934,6 +4362,8 @@ declare namespace sap {
3934
4362
  getTitleControls(): sap.ui.core.Control[];
3935
4363
  /**
3936
4364
  * Gets the tree owned by this panel.
4365
+ *
4366
+ * @returns The tree owned by this panel.
3937
4367
  */
3938
4368
  getTree(): sap.ui.vtm.Tree;
3939
4369
  /**
@@ -3948,10 +4378,14 @@ declare namespace sap {
3948
4378
  * The width of the tree.
3949
4379
  *
3950
4380
  * Default value is `"50%"`.
4381
+ *
4382
+ * @returns Value of property `treeWidth`
3951
4383
  */
3952
4384
  getTreeWidth(): sap.ui.core.CSSSize;
3953
4385
  /**
3954
4386
  * Gets the viewport owned by this panel.
4387
+ *
4388
+ * @returns The viewport owned by this panel.
3955
4389
  */
3956
4390
  getViewport(): sap.ui.vtm.Viewport;
3957
4391
  /**
@@ -3962,6 +4396,8 @@ declare namespace sap {
3962
4396
  getViewportHeaderControls(): sap.ui.core.Control[];
3963
4397
  /**
3964
4398
  * Gets the {@link sap.ui.vtm.Vtm} instance that owns this panel.
4399
+ *
4400
+ * @returns The {@link sap.ui.vtm.Vtm} instance that owns this panel.
3965
4401
  */
3966
4402
  getVtm(): sap.ui.vtm.Vtm;
3967
4403
  /**
@@ -3971,6 +4407,8 @@ declare namespace sap {
3971
4407
  /**
3972
4408
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTitleControls titleControls}.
3973
4409
  * and returns its index if found or -1 otherwise.
4410
+ *
4411
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3974
4412
  */
3975
4413
  indexOfTitleControl(
3976
4414
  /**
@@ -3981,6 +4419,8 @@ declare namespace sap {
3981
4419
  /**
3982
4420
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
3983
4421
  * and returns its index if found or -1 otherwise.
4422
+ *
4423
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3984
4424
  */
3985
4425
  indexOfTreeHeaderControl(
3986
4426
  /**
@@ -3991,6 +4431,8 @@ declare namespace sap {
3991
4431
  /**
3992
4432
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
3993
4433
  * and returns its index if found or -1 otherwise.
4434
+ *
4435
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3994
4436
  */
3995
4437
  indexOfViewportHeaderControl(
3996
4438
  /**
@@ -4000,6 +4442,8 @@ declare namespace sap {
4000
4442
  ): int;
4001
4443
  /**
4002
4444
  * Inserts a titleControl into the aggregation {@link #getTitleControls titleControls}.
4445
+ *
4446
+ * @returns Reference to `this` in order to allow method chaining
4003
4447
  */
4004
4448
  insertTitleControl(
4005
4449
  /**
@@ -4015,6 +4459,8 @@ declare namespace sap {
4015
4459
  ): this;
4016
4460
  /**
4017
4461
  * Inserts a treeHeaderControl into the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4462
+ *
4463
+ * @returns Reference to `this` in order to allow method chaining
4018
4464
  */
4019
4465
  insertTreeHeaderControl(
4020
4466
  /**
@@ -4030,6 +4476,8 @@ declare namespace sap {
4030
4476
  ): this;
4031
4477
  /**
4032
4478
  * Inserts a viewportHeaderControl into the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4479
+ *
4480
+ * @returns Reference to `this` in order to allow method chaining
4033
4481
  */
4034
4482
  insertViewportHeaderControl(
4035
4483
  /**
@@ -4047,22 +4495,30 @@ declare namespace sap {
4047
4495
  * Removes all the controls from the aggregation {@link #getTitleControls titleControls}.
4048
4496
  *
4049
4497
  * Additionally, it unregisters them from the hosting UIArea.
4498
+ *
4499
+ * @returns An array of the removed elements (might be empty)
4050
4500
  */
4051
4501
  removeAllTitleControls(): sap.ui.core.Control[];
4052
4502
  /**
4053
4503
  * Removes all the controls from the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4054
4504
  *
4055
4505
  * Additionally, it unregisters them from the hosting UIArea.
4506
+ *
4507
+ * @returns An array of the removed elements (might be empty)
4056
4508
  */
4057
4509
  removeAllTreeHeaderControls(): sap.ui.core.Control[];
4058
4510
  /**
4059
4511
  * Removes all the controls from the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4060
4512
  *
4061
4513
  * Additionally, it unregisters them from the hosting UIArea.
4514
+ *
4515
+ * @returns An array of the removed elements (might be empty)
4062
4516
  */
4063
4517
  removeAllViewportHeaderControls(): sap.ui.core.Control[];
4064
4518
  /**
4065
4519
  * Removes a titleControl from the aggregation {@link #getTitleControls titleControls}.
4520
+ *
4521
+ * @returns The removed titleControl or `null`
4066
4522
  */
4067
4523
  removeTitleControl(
4068
4524
  /**
@@ -4072,6 +4528,8 @@ declare namespace sap {
4072
4528
  ): sap.ui.core.Control;
4073
4529
  /**
4074
4530
  * Removes a treeHeaderControl from the aggregation {@link #getTreeHeaderControls treeHeaderControls}.
4531
+ *
4532
+ * @returns The removed treeHeaderControl or `null`
4075
4533
  */
4076
4534
  removeTreeHeaderControl(
4077
4535
  /**
@@ -4081,6 +4539,8 @@ declare namespace sap {
4081
4539
  ): sap.ui.core.Control;
4082
4540
  /**
4083
4541
  * Removes a viewportHeaderControl from the aggregation {@link #getViewportHeaderControls viewportHeaderControls}.
4542
+ *
4543
+ * @returns The removed viewportHeaderControl or `null`
4084
4544
  */
4085
4545
  removeViewportHeaderControl(
4086
4546
  /**
@@ -4096,6 +4556,8 @@ declare namespace sap {
4096
4556
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4097
4557
  *
4098
4558
  * Default value is `"inherit"`.
4559
+ *
4560
+ * @returns Reference to `this` in order to allow method chaining
4099
4561
  */
4100
4562
  setHeight(
4101
4563
  /**
@@ -4111,6 +4573,8 @@ declare namespace sap {
4111
4573
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4112
4574
  *
4113
4575
  * Default value is `true`.
4576
+ *
4577
+ * @returns Reference to `this` in order to allow method chaining
4114
4578
  */
4115
4579
  setShowViewport(
4116
4580
  /**
@@ -4120,6 +4584,8 @@ declare namespace sap {
4120
4584
  ): this;
4121
4585
  /**
4122
4586
  * Sets the panel title.
4587
+ *
4588
+ * @returns Returns `this` for method chaining.
4123
4589
  */
4124
4590
  setTitle(
4125
4591
  /**
@@ -4135,6 +4601,8 @@ declare namespace sap {
4135
4601
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4136
4602
  *
4137
4603
  * Default value is `"50%"`.
4604
+ *
4605
+ * @returns Reference to `this` in order to allow method chaining
4138
4606
  */
4139
4607
  setTreeWidth(
4140
4608
  /**
@@ -4144,6 +4612,8 @@ declare namespace sap {
4144
4612
  ): this;
4145
4613
  /**
4146
4614
  * Sets the associated {@link #getVtmId vtmId}.
4615
+ *
4616
+ * @returns Reference to `this` in order to allow method chaining
4147
4617
  */
4148
4618
  setVtmId(
4149
4619
  /**
@@ -4178,6 +4648,8 @@ declare namespace sap {
4178
4648
  * the information contained in `oClassInfo`.
4179
4649
  *
4180
4650
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4651
+ *
4652
+ * @returns Created class / constructor function
4181
4653
  */
4182
4654
  static extend<T extends Record<string, unknown>>(
4183
4655
  /**
@@ -4196,10 +4668,14 @@ declare namespace sap {
4196
4668
  ): Function;
4197
4669
  /**
4198
4670
  * Returns a metadata object for class sap.ui.vtm.ProgressDialog.
4671
+ *
4672
+ * @returns Metadata object describing this class
4199
4673
  */
4200
4674
  static getMetadata(): sap.ui.core.ElementMetadata;
4201
4675
  /**
4202
4676
  * Closes the dialog.
4677
+ *
4678
+ * @returns `this` for method chaining.
4203
4679
  */
4204
4680
  close(): sap.ui.vtm.ProgressDialog;
4205
4681
  /**
@@ -4208,6 +4684,8 @@ declare namespace sap {
4208
4684
  * The percentage (0-100) to show in the progress bar (if visible).
4209
4685
  *
4210
4686
  * Default value is `0`.
4687
+ *
4688
+ * @returns Value of property `percentComplete`
4211
4689
  */
4212
4690
  getPercentComplete(): int;
4213
4691
  /**
@@ -4216,20 +4694,28 @@ declare namespace sap {
4216
4694
  * Whether the progress bar is visible.
4217
4695
  *
4218
4696
  * Default value is `"true"`.
4697
+ *
4698
+ * @returns Value of property `progressBarVisible`
4219
4699
  */
4220
4700
  getProgressBarVisible(): boolean;
4221
4701
  /**
4222
4702
  * Gets current value of property {@link #getProgressText progressText}.
4223
4703
  *
4224
4704
  * The text to display in the progress dialog.
4705
+ *
4706
+ * @returns Value of property `progressText`
4225
4707
  */
4226
4708
  getProgressText(): string;
4227
4709
  /**
4228
4710
  * Returns whether the dialog is open.
4711
+ *
4712
+ * @returns `true` when the dialog is open.
4229
4713
  */
4230
4714
  isOpen(): boolean;
4231
4715
  /**
4232
4716
  * Opens the dialog.
4717
+ *
4718
+ * @returns `this` for method chaining.
4233
4719
  */
4234
4720
  open(): sap.ui.vtm.ProgressDialog;
4235
4721
  /**
@@ -4240,6 +4726,8 @@ declare namespace sap {
4240
4726
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4241
4727
  *
4242
4728
  * Default value is `0`.
4729
+ *
4730
+ * @returns Reference to `this` in order to allow method chaining
4243
4731
  */
4244
4732
  setPercentComplete(
4245
4733
  /**
@@ -4255,6 +4743,8 @@ declare namespace sap {
4255
4743
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4256
4744
  *
4257
4745
  * Default value is `"true"`.
4746
+ *
4747
+ * @returns Reference to `this` in order to allow method chaining
4258
4748
  */
4259
4749
  setProgressBarVisible(
4260
4750
  /**
@@ -4268,6 +4758,8 @@ declare namespace sap {
4268
4758
  * The text to display in the progress dialog.
4269
4759
  *
4270
4760
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4761
+ *
4762
+ * @returns Reference to `this` in order to allow method chaining
4271
4763
  */
4272
4764
  setProgressText(
4273
4765
  /**
@@ -4300,6 +4792,8 @@ declare namespace sap {
4300
4792
  * contained in `oClassInfo`.
4301
4793
  *
4302
4794
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
4795
+ *
4796
+ * @returns Created class / constructor function
4303
4797
  */
4304
4798
  static extend<T extends Record<string, unknown>>(
4305
4799
  /**
@@ -4318,6 +4812,8 @@ declare namespace sap {
4318
4812
  ): Function;
4319
4813
  /**
4320
4814
  * Returns a metadata object for class sap.ui.vtm.Scene.
4815
+ *
4816
+ * @returns Metadata object describing this class
4321
4817
  */
4322
4818
  static getMetadata(): sap.ui.core.ElementMetadata;
4323
4819
  /**
@@ -4334,6 +4830,8 @@ declare namespace sap {
4334
4830
  * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted}
4335
4831
  * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted}
4336
4832
  * event being raised.
4833
+ *
4834
+ * @returns Reference to `this` in order to allow method chaining
4337
4835
  */
4338
4836
  attachDownloadCompleted(
4339
4837
  /**
@@ -4364,6 +4862,8 @@ declare namespace sap {
4364
4862
  * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted}
4365
4863
  * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted}
4366
4864
  * event being raised.
4865
+ *
4866
+ * @returns Reference to `this` in order to allow method chaining
4367
4867
  */
4368
4868
  attachDownloadCompleted(
4369
4869
  /**
@@ -4383,6 +4883,8 @@ declare namespace sap {
4383
4883
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4384
4884
  *
4385
4885
  * Raised to indicate download progress of a viewable while viewables are being downloaded
4886
+ *
4887
+ * @returns Reference to `this` in order to allow method chaining
4386
4888
  */
4387
4889
  attachDownloadProgress(
4388
4890
  /**
@@ -4407,6 +4909,8 @@ declare namespace sap {
4407
4909
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4408
4910
  *
4409
4911
  * Raised to indicate download progress of a viewable while viewables are being downloaded
4912
+ *
4913
+ * @returns Reference to `this` in order to allow method chaining
4410
4914
  */
4411
4915
  attachDownloadProgress(
4412
4916
  /**
@@ -4426,6 +4930,8 @@ declare namespace sap {
4426
4930
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4427
4931
  *
4428
4932
  * Raised when starting a download of a set of viewables.
4933
+ *
4934
+ * @returns Reference to `this` in order to allow method chaining
4429
4935
  */
4430
4936
  attachDownloadStarted(
4431
4937
  /**
@@ -4450,6 +4956,8 @@ declare namespace sap {
4450
4956
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4451
4957
  *
4452
4958
  * Raised when starting a download of a set of viewables.
4959
+ *
4960
+ * @returns Reference to `this` in order to allow method chaining
4453
4961
  */
4454
4962
  attachDownloadStarted(
4455
4963
  /**
@@ -4469,6 +4977,8 @@ declare namespace sap {
4469
4977
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4470
4978
  *
4471
4979
  * Raised when the scene hierarchy has been modified.
4980
+ *
4981
+ * @returns Reference to `this` in order to allow method chaining
4472
4982
  */
4473
4983
  attachHierarchyChanged(
4474
4984
  /**
@@ -4493,6 +5003,8 @@ declare namespace sap {
4493
5003
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4494
5004
  *
4495
5005
  * Raised when the scene hierarchy has been modified.
5006
+ *
5007
+ * @returns Reference to `this` in order to allow method chaining
4496
5008
  */
4497
5009
  attachHierarchyChanged(
4498
5010
  /**
@@ -4512,6 +5024,8 @@ declare namespace sap {
4512
5024
  *
4513
5025
  * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed
4514
5026
  * to load.
5027
+ *
5028
+ * @returns Reference to `this` in order to allow method chaining
4515
5029
  */
4516
5030
  attachLoadCompleted(
4517
5031
  /**
@@ -4536,6 +5050,8 @@ declare namespace sap {
4536
5050
  *
4537
5051
  * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed
4538
5052
  * to load.
5053
+ *
5054
+ * @returns Reference to `this` in order to allow method chaining
4539
5055
  */
4540
5056
  attachLoadCompleted(
4541
5057
  /**
@@ -4554,6 +5070,8 @@ declare namespace sap {
4554
5070
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4555
5071
  *
4556
5072
  * Raised to provide progress information for a viewable that is being loaded.
5073
+ *
5074
+ * @returns Reference to `this` in order to allow method chaining
4557
5075
  */
4558
5076
  attachLoadProgress(
4559
5077
  /**
@@ -4577,6 +5095,8 @@ declare namespace sap {
4577
5095
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4578
5096
  *
4579
5097
  * Raised to provide progress information for a viewable that is being loaded.
5098
+ *
5099
+ * @returns Reference to `this` in order to allow method chaining
4580
5100
  */
4581
5101
  attachLoadProgress(
4582
5102
  /**
@@ -4595,6 +5115,8 @@ declare namespace sap {
4595
5115
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4596
5116
  *
4597
5117
  * Raised when starting to load a set of viewables.
5118
+ *
5119
+ * @returns Reference to `this` in order to allow method chaining
4598
5120
  */
4599
5121
  attachLoadStarted(
4600
5122
  /**
@@ -4618,6 +5140,8 @@ declare namespace sap {
4618
5140
  * otherwise it will be bound to this `sap.ui.vtm.Scene` itself.
4619
5141
  *
4620
5142
  * Raised when starting to load a set of viewables.
5143
+ *
5144
+ * @returns Reference to `this` in order to allow method chaining
4621
5145
  */
4622
5146
  attachLoadStarted(
4623
5147
  /**
@@ -4631,6 +5155,8 @@ declare namespace sap {
4631
5155
  ): this;
4632
5156
  /**
4633
5157
  * Clones a scene node.
5158
+ *
5159
+ * @returns The scene node ID of the created node.
4634
5160
  */
4635
5161
  cloneNode(
4636
5162
  /**
@@ -4658,6 +5184,8 @@ declare namespace sap {
4658
5184
  ): string;
4659
5185
  /**
4660
5186
  * Creates a scene node.
5187
+ *
5188
+ * @returns The scene node ID of the created node.
4661
5189
  */
4662
5190
  createNode(
4663
5191
  /**
@@ -4677,6 +5205,8 @@ declare namespace sap {
4677
5205
  ): string;
4678
5206
  /**
4679
5207
  * Deletes a node from the scene.
5208
+ *
5209
+ * @returns `this` for method chaining.
4680
5210
  */
4681
5211
  deleteNode(
4682
5212
  /**
@@ -4689,6 +5219,8 @@ declare namespace sap {
4689
5219
  * of this `sap.ui.vtm.Scene`.
4690
5220
  *
4691
5221
  * The passed function and listener object must match the ones used for event registration.
5222
+ *
5223
+ * @returns Reference to `this` in order to allow method chaining
4692
5224
  */
4693
5225
  detachDownloadCompleted(
4694
5226
  /**
@@ -4705,6 +5237,8 @@ declare namespace sap {
4705
5237
  * this `sap.ui.vtm.Scene`.
4706
5238
  *
4707
5239
  * The passed function and listener object must match the ones used for event registration.
5240
+ *
5241
+ * @returns Reference to `this` in order to allow method chaining
4708
5242
  */
4709
5243
  detachDownloadProgress(
4710
5244
  /**
@@ -4721,6 +5255,8 @@ declare namespace sap {
4721
5255
  * this `sap.ui.vtm.Scene`.
4722
5256
  *
4723
5257
  * The passed function and listener object must match the ones used for event registration.
5258
+ *
5259
+ * @returns Reference to `this` in order to allow method chaining
4724
5260
  */
4725
5261
  detachDownloadStarted(
4726
5262
  /**
@@ -4737,6 +5273,8 @@ declare namespace sap {
4737
5273
  * this `sap.ui.vtm.Scene`.
4738
5274
  *
4739
5275
  * The passed function and listener object must match the ones used for event registration.
5276
+ *
5277
+ * @returns Reference to `this` in order to allow method chaining
4740
5278
  */
4741
5279
  detachHierarchyChanged(
4742
5280
  /**
@@ -4753,6 +5291,8 @@ declare namespace sap {
4753
5291
  * `sap.ui.vtm.Scene`.
4754
5292
  *
4755
5293
  * The passed function and listener object must match the ones used for event registration.
5294
+ *
5295
+ * @returns Reference to `this` in order to allow method chaining
4756
5296
  */
4757
5297
  detachLoadCompleted(
4758
5298
  /**
@@ -4768,6 +5308,8 @@ declare namespace sap {
4768
5308
  * Detaches event handler `fnFunction` from the {@link #event:loadProgress loadProgress} event of this `sap.ui.vtm.Scene`.
4769
5309
  *
4770
5310
  * The passed function and listener object must match the ones used for event registration.
5311
+ *
5312
+ * @returns Reference to `this` in order to allow method chaining
4771
5313
  */
4772
5314
  detachLoadProgress(
4773
5315
  /**
@@ -4783,6 +5325,8 @@ declare namespace sap {
4783
5325
  * Detaches event handler `fnFunction` from the {@link #event:loadStarted loadStarted} event of this `sap.ui.vtm.Scene`.
4784
5326
  *
4785
5327
  * The passed function and listener object must match the ones used for event registration.
5328
+ *
5329
+ * @returns Reference to `this` in order to allow method chaining
4786
5330
  */
4787
5331
  detachLoadStarted(
4788
5332
  /**
@@ -4796,6 +5340,8 @@ declare namespace sap {
4796
5340
  ): this;
4797
5341
  /**
4798
5342
  * Fires event {@link #event:downloadCompleted downloadCompleted} to attached listeners.
5343
+ *
5344
+ * @returns Reference to `this` in order to allow method chaining
4799
5345
  */
4800
5346
  fireDownloadCompleted(
4801
5347
  /**
@@ -4816,6 +5362,8 @@ declare namespace sap {
4816
5362
  ): this;
4817
5363
  /**
4818
5364
  * Fires event {@link #event:downloadProgress downloadProgress} to attached listeners.
5365
+ *
5366
+ * @returns Reference to `this` in order to allow method chaining
4819
5367
  */
4820
5368
  fireDownloadProgress(
4821
5369
  /**
@@ -4838,6 +5386,8 @@ declare namespace sap {
4838
5386
  ): this;
4839
5387
  /**
4840
5388
  * Fires event {@link #event:downloadStarted downloadStarted} to attached listeners.
5389
+ *
5390
+ * @returns Reference to `this` in order to allow method chaining
4841
5391
  */
4842
5392
  fireDownloadStarted(
4843
5393
  /**
@@ -4853,6 +5403,8 @@ declare namespace sap {
4853
5403
  ): this;
4854
5404
  /**
4855
5405
  * Fires event {@link #event:hierarchyChanged hierarchyChanged} to attached listeners.
5406
+ *
5407
+ * @returns Reference to `this` in order to allow method chaining
4856
5408
  */
4857
5409
  fireHierarchyChanged(
4858
5410
  /**
@@ -4862,6 +5414,8 @@ declare namespace sap {
4862
5414
  ): this;
4863
5415
  /**
4864
5416
  * Fires event {@link #event:loadCompleted loadCompleted} to attached listeners.
5417
+ *
5418
+ * @returns Reference to `this` in order to allow method chaining
4865
5419
  */
4866
5420
  fireLoadCompleted(
4867
5421
  /**
@@ -4887,6 +5441,8 @@ declare namespace sap {
4887
5441
  ): this;
4888
5442
  /**
4889
5443
  * Fires event {@link #event:loadProgress loadProgress} to attached listeners.
5444
+ *
5445
+ * @returns Reference to `this` in order to allow method chaining
4890
5446
  */
4891
5447
  fireLoadProgress(
4892
5448
  /**
@@ -4896,6 +5452,8 @@ declare namespace sap {
4896
5452
  ): this;
4897
5453
  /**
4898
5454
  * Fires event {@link #event:loadStarted loadStarted} to attached listeners.
5455
+ *
5456
+ * @returns Reference to `this` in order to allow method chaining
4899
5457
  */
4900
5458
  fireLoadStarted(
4901
5459
  /**
@@ -4911,11 +5469,15 @@ declare namespace sap {
4911
5469
  ): this;
4912
5470
  /**
4913
5471
  * Gets the scene node IDs of all the scene nodes in the scene.
5472
+ *
5473
+ * @returns The scene node IDs of all the scene nodes in the scene.
4914
5474
  */
4915
5475
  getAllIds(): string[];
4916
5476
  /**
4917
5477
  * Gets the scene node IDs of the ancestors of the specified scene node. The root scene node is the first
4918
5478
  * item in the array and the parent is the last.
5479
+ *
5480
+ * @returns The scene node IDs of the ancestors of the scene node.
4919
5481
  */
4920
5482
  getAncestorIds(
4921
5483
  /**
@@ -4957,10 +5519,15 @@ declare namespace sap {
4957
5519
  *
4958
5520
  * If this method is called before any scene traversal has occurred, it populates the set of cached scene
4959
5521
  * node IDs using {@link #getAllIds}.
5522
+ *
5523
+ * @returns The set of all scene node IDs in the scene that have been discovered via scene traversal performed
5524
+ * by the application.
4960
5525
  */
4961
5526
  getCachedIds(): string[];
4962
5527
  /**
4963
5528
  * Gets the scene node IDs of the children of the specified scene node.
5529
+ *
5530
+ * @returns The scene node IDs of the children of the specified scene node.
4964
5531
  */
4965
5532
  getChildIds(
4966
5533
  /**
@@ -4970,6 +5537,8 @@ declare namespace sap {
4970
5537
  ): string[];
4971
5538
  /**
4972
5539
  * Gets the scene node IDs of the descendants of the specified scene node.
5540
+ *
5541
+ * @returns The scene node IDs of the descendants of the specified scene node.
4973
5542
  */
4974
5543
  getDescendantIds(
4975
5544
  /**
@@ -4979,15 +5548,22 @@ declare namespace sap {
4979
5548
  ): string[];
4980
5549
  /**
4981
5550
  * Gets the set of downloaded viewables.
5551
+ *
5552
+ * @returns The set of downloaded viewables.
4982
5553
  */
4983
5554
  getDownloadedViewables(): sap.ui.vtm.Viewable[];
4984
5555
  /**
4985
5556
  * Gets the set of loaded viewables.
5557
+ *
5558
+ * @returns The set of loaded viewables.
4986
5559
  */
4987
5560
  getLoadedViewables(): sap.ui.vtm.Viewable[];
4988
5561
  /**
4989
5562
  * Gets the scene node ID of the parent node of the specified scene node or null if the specified scene
4990
5563
  * node is a root scene node.
5564
+ *
5565
+ * @returns The scene node ID of the parent scene node of the specified scene node or null if the specified
5566
+ * scene node is a root scene node.
4991
5567
  */
4992
5568
  getParentId(
4993
5569
  /**
@@ -4997,20 +5573,30 @@ declare namespace sap {
4997
5573
  ): string | null;
4998
5574
  /**
4999
5575
  * Gets the IDs of the the root scene nodes.
5576
+ *
5577
+ * @returns The root scene node IDs.
5000
5578
  */
5001
5579
  getRootIds(): string[];
5002
5580
  /**
5003
5581
  * Gets the set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable}
5004
5582
  * that has been passed to a {@link #loadViewablesAsyc} call made on this {@link sap.ui.vtm.Scene} instance.
5583
+ *
5584
+ * @returns The set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link
5585
+ * sap.ui.vtm.Viewable} that has been passed to a {@link #loadViewablesAsyc} call made on this {@link sap.ui.vtm.Scene}
5586
+ * instance.
5005
5587
  */
5006
5588
  getViewableLoadInfos(): sap.ui.vtm.ViewableLoadInfo[];
5007
5589
  /**
5008
5590
  * Gets the {@link sap.ui.vtm.Vtm} instance that owns this scene.
5591
+ *
5592
+ * @returns The {@link sap.ui.vtm.Vtm} instance that owns this scene.
5009
5593
  */
5010
5594
  getVtm(): sap.ui.vtm.Vtm;
5011
5595
  /**
5012
5596
  * Load a set of viewables asynchronously. Progress is indicated by the `progress` event and completion
5013
5597
  * is indicated by the `loadComplete` event.
5598
+ *
5599
+ * @returns `this` for method chaining.
5014
5600
  */
5015
5601
  loadViewablesAsync(
5016
5602
  /**
@@ -5022,6 +5608,8 @@ declare namespace sap {
5022
5608
  * Recursively traverses a scene tree branch calling a function on each scene node.
5023
5609
  *
5024
5610
  * Does not traverse the descendants of closed nodes.
5611
+ *
5612
+ * @returns this
5025
5613
  */
5026
5614
  traverseBranch(
5027
5615
  /**
@@ -5040,6 +5628,8 @@ declare namespace sap {
5040
5628
  ): sap.ui.vtm.Scene;
5041
5629
  /**
5042
5630
  * Traverses a set of scene nodes specified by scene node ID, calling a function on each scene node.
5631
+ *
5632
+ * @returns this
5043
5633
  */
5044
5634
  traverseNodes(
5045
5635
  /**
@@ -5057,6 +5647,8 @@ declare namespace sap {
5057
5647
  ): sap.ui.vtm.Scene;
5058
5648
  /**
5059
5649
  * Recursively traverses the scene tree calling a function on each scene node.
5650
+ *
5651
+ * @returns this
5060
5652
  */
5061
5653
  traverseTree(
5062
5654
  /**
@@ -5106,6 +5698,8 @@ declare namespace sap {
5106
5698
  * information contained in `oClassInfo`.
5107
5699
  *
5108
5700
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
5701
+ *
5702
+ * @returns Created class / constructor function
5109
5703
  */
5110
5704
  static extend<T extends Record<string, unknown>>(
5111
5705
  /**
@@ -5124,40 +5718,56 @@ declare namespace sap {
5124
5718
  ): Function;
5125
5719
  /**
5126
5720
  * Returns a metadata object for class sap.ui.vtm.SceneNode.
5721
+ *
5722
+ * @returns Metadata object describing this class
5127
5723
  */
5128
5724
  static getMetadata(): sap.ui.core.ElementMetadata;
5129
5725
  /**
5130
5726
  * Gets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.
5727
+ *
5728
+ * @returns The absolute transformation matrix that applies to the scene node in ISO 10303-42 format.
5131
5729
  */
5132
5730
  getAbsoluteMatrix(): sap.ui.vtm.Matrix;
5133
5731
  /**
5134
5732
  * Gets whether this scene node is closed. When a scene node is closed, the closed scene node and its descendants
5135
5733
  * are treated as a single scene node (at least in terms of selection).
5734
+ *
5735
+ * @returns Whether this scene node is closed.
5136
5736
  */
5137
5737
  getClosed(): boolean;
5138
5738
  /**
5139
5739
  * Gets a plain JavaScript object map of identifier values. Keys are in the form: `['{"source":"SAP","type":"VE_COMPONENT"}'`.
5140
5740
  * Values are strings or arrays of strings in the form: `'[{"name":"ID", "value":"_moto_x_asm"},{"name":"version",
5141
5741
  * "value": "00"},{"name": "timestamp", "value":"2016-05-18 03:44:53.93"}]'`.
5742
+ *
5743
+ * @returns The plain JavaScript object map of identifier values.
5142
5744
  */
5143
5745
  getIdentifiers(): object;
5144
5746
  /**
5145
5747
  * Gets the name of the scene node.
5748
+ *
5749
+ * @returns The scene node name.
5146
5750
  */
5147
5751
  getName(): string;
5148
5752
  /**
5149
5753
  * Gets a plain JavaScript object map of metadata values. Keys are in the form: `'{"category":"SAP","field":"MATERIAL"}'`.
5150
5754
  * Values are in the form of strings or arrays of strings.
5755
+ *
5756
+ * @returns The plain JavaScript object map of metadata values.
5151
5757
  */
5152
5758
  getNodeMetadata(): object;
5153
5759
  /**
5154
5760
  * Gets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.
5761
+ *
5762
+ * @returns The relative transformation matrix that applies to the scene node in ISO 10303-42 format.
5155
5763
  */
5156
5764
  getRelativeMatrix(): sap.ui.vtm.Matrix;
5157
5765
  /**
5158
5766
  * Gets current value of property {@link #getScene scene}.
5159
5767
  *
5160
5768
  * The {@link sap.ui.vtm.Scene} for the scene node.
5769
+ *
5770
+ * @returns Value of property `scene`
5161
5771
  */
5162
5772
  getScene(): object;
5163
5773
  /**
@@ -5166,10 +5776,14 @@ declare namespace sap {
5166
5776
  * The scene node id.
5167
5777
  *
5168
5778
  * This is a transient identifier that exists in the context of the current scene. It should not be persisted.
5779
+ *
5780
+ * @returns Value of property `sceneNodeId`
5169
5781
  */
5170
5782
  getSceneNodeId(): string;
5171
5783
  /**
5172
5784
  * Sets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format.
5785
+ *
5786
+ * @returns `this` for method chaining.
5173
5787
  */
5174
5788
  setAbsoluteMatrix(
5175
5789
  /**
@@ -5179,6 +5793,8 @@ declare namespace sap {
5179
5793
  ): sap.ui.vtm.SceneNode;
5180
5794
  /**
5181
5795
  * Sets the relative transformation matrix that applies to the scene node in ISO 10303-42 format.
5796
+ *
5797
+ * @returns `this` for method chaining.
5182
5798
  */
5183
5799
  setRelativeMatrix(
5184
5800
  /**
@@ -5192,6 +5808,8 @@ declare namespace sap {
5192
5808
  * The {@link sap.ui.vtm.Scene} for the scene node.
5193
5809
  *
5194
5810
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5811
+ *
5812
+ * @returns Reference to `this` in order to allow method chaining
5195
5813
  */
5196
5814
  setScene(
5197
5815
  /**
@@ -5207,6 +5825,8 @@ declare namespace sap {
5207
5825
  * This is a transient identifier that exists in the context of the current scene. It should not be persisted.
5208
5826
  *
5209
5827
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5828
+ *
5829
+ * @returns Reference to `this` in order to allow method chaining
5210
5830
  */
5211
5831
  setSceneNodeId(
5212
5832
  /**
@@ -5235,6 +5855,8 @@ declare namespace sap {
5235
5855
  * with the information contained in `oClassInfo`.
5236
5856
  *
5237
5857
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
5858
+ *
5859
+ * @returns Created class / constructor function
5238
5860
  */
5239
5861
  static extend<T extends Record<string, unknown>>(
5240
5862
  /**
@@ -5253,22 +5875,30 @@ declare namespace sap {
5253
5875
  ): Function;
5254
5876
  /**
5255
5877
  * Returns a metadata object for class sap.ui.vtm.SelectColumnsDialog.
5878
+ *
5879
+ * @returns Metadata object describing this class
5256
5880
  */
5257
5881
  static getMetadata(): sap.ui.core.ElementMetadata;
5258
5882
  /**
5259
5883
  * Gets current value of property {@link #getSelectableColumns selectableColumns}.
5260
5884
  *
5261
5885
  * The set of columns that should be shown in the dialog that may be selected for display.
5886
+ *
5887
+ * @returns Value of property `selectableColumns`
5262
5888
  */
5263
5889
  getSelectableColumns(): sap.ui.vtm.Column[];
5264
5890
  /**
5265
5891
  * Gets current value of property {@link #getTree tree}.
5266
5892
  *
5267
5893
  * The {@link sap.ui.vtm.Tree} that column selection is being performed for.
5894
+ *
5895
+ * @returns Value of property `tree`
5268
5896
  */
5269
5897
  getTree(): object;
5270
5898
  /**
5271
5899
  * Opens the dialog. The dialog applies the updated set of columns to the tree if confirmed.
5900
+ *
5901
+ * @returns `this` for method chaining.
5272
5902
  */
5273
5903
  open(): sap.ui.vtm.SelectColumnsDialog;
5274
5904
  /**
@@ -5277,6 +5907,8 @@ declare namespace sap {
5277
5907
  * The set of columns that should be shown in the dialog that may be selected for display.
5278
5908
  *
5279
5909
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5910
+ *
5911
+ * @returns Reference to `this` in order to allow method chaining
5280
5912
  */
5281
5913
  setSelectableColumns(
5282
5914
  /**
@@ -5290,6 +5922,8 @@ declare namespace sap {
5290
5922
  * The {@link sap.ui.vtm.Tree} that column selection is being performed for.
5291
5923
  *
5292
5924
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5925
+ *
5926
+ * @returns Reference to `this` in order to allow method chaining
5293
5927
  */
5294
5928
  setTree(
5295
5929
  /**
@@ -5431,6 +6065,8 @@ declare namespace sap {
5431
6065
  * contained in `oClassInfo`.
5432
6066
  *
5433
6067
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
6068
+ *
6069
+ * @returns Created class / constructor function
5434
6070
  */
5435
6071
  static extend<T extends Record<string, unknown>>(
5436
6072
  /**
@@ -5449,10 +6085,14 @@ declare namespace sap {
5449
6085
  ): Function;
5450
6086
  /**
5451
6087
  * Returns a metadata object for class sap.ui.vtm.Tree.
6088
+ *
6089
+ * @returns Metadata object describing this class
5452
6090
  */
5453
6091
  static getMetadata(): sap.ui.core.ElementMetadata;
5454
6092
  /**
5455
6093
  * Adds some headerControl to the aggregation {@link #getHeaderControls headerControls}.
6094
+ *
6095
+ * @returns Reference to `this` in order to allow method chaining
5456
6096
  */
5457
6097
  addHeaderControl(
5458
6098
  /**
@@ -5462,6 +6102,8 @@ declare namespace sap {
5462
6102
  ): this;
5463
6103
  /**
5464
6104
  * Adds a root item to the tree.
6105
+ *
6106
+ * @returns `this` to allow method chaining.
5465
6107
  */
5466
6108
  addRoot(
5467
6109
  /**
@@ -5477,6 +6119,8 @@ declare namespace sap {
5477
6119
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5478
6120
  *
5479
6121
  * Raised before the model is updated.
6122
+ *
6123
+ * @returns Reference to `this` in order to allow method chaining
5480
6124
  */
5481
6125
  attachBeforeModelUpdated(
5482
6126
  /**
@@ -5501,6 +6145,8 @@ declare namespace sap {
5501
6145
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5502
6146
  *
5503
6147
  * Raised before the model is updated.
6148
+ *
6149
+ * @returns Reference to `this` in order to allow method chaining
5504
6150
  */
5505
6151
  attachBeforeModelUpdated(
5506
6152
  /**
@@ -5520,6 +6166,8 @@ declare namespace sap {
5520
6166
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5521
6167
  *
5522
6168
  * Raised when the data columns are updated.
6169
+ *
6170
+ * @returns Reference to `this` in order to allow method chaining
5523
6171
  */
5524
6172
  attachDataColumnsChanged(
5525
6173
  /**
@@ -5544,6 +6192,8 @@ declare namespace sap {
5544
6192
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5545
6193
  *
5546
6194
  * Raised when the data columns are updated.
6195
+ *
6196
+ * @returns Reference to `this` in order to allow method chaining
5547
6197
  */
5548
6198
  attachDataColumnsChanged(
5549
6199
  /**
@@ -5563,6 +6213,8 @@ declare namespace sap {
5563
6213
  *
5564
6214
  * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop
5565
6215
  * to occur call preventDefault() on the event.
6216
+ *
6217
+ * @returns Reference to `this` in order to allow method chaining
5566
6218
  */
5567
6219
  attachDragOver(
5568
6220
  /**
@@ -5587,6 +6239,8 @@ declare namespace sap {
5587
6239
  *
5588
6240
  * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop
5589
6241
  * to occur call preventDefault() on the event.
6242
+ *
6243
+ * @returns Reference to `this` in order to allow method chaining
5590
6244
  */
5591
6245
  attachDragOver(
5592
6246
  /**
@@ -5606,6 +6260,8 @@ declare namespace sap {
5606
6260
  *
5607
6261
  * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault()
5608
6262
  * on the event.
6263
+ *
6264
+ * @returns Reference to `this` in order to allow method chaining
5609
6265
  */
5610
6266
  attachDragStart(
5611
6267
  /**
@@ -5630,6 +6286,8 @@ declare namespace sap {
5630
6286
  *
5631
6287
  * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault()
5632
6288
  * on the event.
6289
+ *
6290
+ * @returns Reference to `this` in order to allow method chaining
5633
6291
  */
5634
6292
  attachDragStart(
5635
6293
  /**
@@ -5649,6 +6307,8 @@ declare namespace sap {
5649
6307
  *
5650
6308
  * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur
5651
6309
  * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event.
6310
+ *
6311
+ * @returns Reference to `this` in order to allow method chaining
5652
6312
  */
5653
6313
  attachDrop(
5654
6314
  /**
@@ -5673,6 +6333,8 @@ declare namespace sap {
5673
6333
  *
5674
6334
  * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur
5675
6335
  * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event.
6336
+ *
6337
+ * @returns Reference to `this` in order to allow method chaining
5676
6338
  */
5677
6339
  attachDrop(
5678
6340
  /**
@@ -5692,6 +6354,8 @@ declare namespace sap {
5692
6354
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5693
6355
  *
5694
6356
  * Raised when a tree item entry is expanded or collapsed.
6357
+ *
6358
+ * @returns Reference to `this` in order to allow method chaining
5695
6359
  */
5696
6360
  attachExpandedChanged(
5697
6361
  /**
@@ -5716,6 +6380,8 @@ declare namespace sap {
5716
6380
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5717
6381
  *
5718
6382
  * Raised when a tree item entry is expanded or collapsed.
6383
+ *
6384
+ * @returns Reference to `this` in order to allow method chaining
5719
6385
  */
5720
6386
  attachExpandedChanged(
5721
6387
  /**
@@ -5735,6 +6401,8 @@ declare namespace sap {
5735
6401
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5736
6402
  *
5737
6403
  * Raised when the fixed columns are updated.
6404
+ *
6405
+ * @returns Reference to `this` in order to allow method chaining
5738
6406
  */
5739
6407
  attachFixedColumnsChanged(
5740
6408
  /**
@@ -5759,6 +6427,8 @@ declare namespace sap {
5759
6427
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5760
6428
  *
5761
6429
  * Raised when the fixed columns are updated.
6430
+ *
6431
+ * @returns Reference to `this` in order to allow method chaining
5762
6432
  */
5763
6433
  attachFixedColumnsChanged(
5764
6434
  /**
@@ -5778,6 +6448,8 @@ declare namespace sap {
5778
6448
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5779
6449
  *
5780
6450
  * Raised when the tree hierarchy (the set of parent child relationships) changes.
6451
+ *
6452
+ * @returns Reference to `this` in order to allow method chaining
5781
6453
  */
5782
6454
  attachHierarchyChanged(
5783
6455
  /**
@@ -5802,6 +6474,8 @@ declare namespace sap {
5802
6474
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5803
6475
  *
5804
6476
  * Raised when the tree hierarchy (the set of parent child relationships) changes.
6477
+ *
6478
+ * @returns Reference to `this` in order to allow method chaining
5805
6479
  */
5806
6480
  attachHierarchyChanged(
5807
6481
  /**
@@ -5821,6 +6495,8 @@ declare namespace sap {
5821
6495
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5822
6496
  *
5823
6497
  * Raised when a tree item message status icon is clicked.
6498
+ *
6499
+ * @returns Reference to `this` in order to allow method chaining
5824
6500
  */
5825
6501
  attachMessageStatusHeaderIconClicked(
5826
6502
  /**
@@ -5845,6 +6521,8 @@ declare namespace sap {
5845
6521
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5846
6522
  *
5847
6523
  * Raised when a tree item message status icon is clicked.
6524
+ *
6525
+ * @returns Reference to `this` in order to allow method chaining
5848
6526
  */
5849
6527
  attachMessageStatusHeaderIconClicked(
5850
6528
  /**
@@ -5864,6 +6542,8 @@ declare namespace sap {
5864
6542
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5865
6543
  *
5866
6544
  * Raised when a tree item message status icon is clicked.
6545
+ *
6546
+ * @returns Reference to `this` in order to allow method chaining
5867
6547
  */
5868
6548
  attachMessageStatusIconClicked(
5869
6549
  /**
@@ -5888,6 +6568,8 @@ declare namespace sap {
5888
6568
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5889
6569
  *
5890
6570
  * Raised when a tree item message status icon is clicked.
6571
+ *
6572
+ * @returns Reference to `this` in order to allow method chaining
5891
6573
  */
5892
6574
  attachMessageStatusIconClicked(
5893
6575
  /**
@@ -5906,6 +6588,8 @@ declare namespace sap {
5906
6588
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5907
6589
  *
5908
6590
  * Raised after the model has been updated.
6591
+ *
6592
+ * @returns Reference to `this` in order to allow method chaining
5909
6593
  */
5910
6594
  attachModelUpdated(
5911
6595
  /**
@@ -5929,6 +6613,8 @@ declare namespace sap {
5929
6613
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5930
6614
  *
5931
6615
  * Raised after the model has been updated.
6616
+ *
6617
+ * @returns Reference to `this` in order to allow method chaining
5932
6618
  */
5933
6619
  attachModelUpdated(
5934
6620
  /**
@@ -5948,6 +6634,8 @@ declare namespace sap {
5948
6634
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5949
6635
  *
5950
6636
  * Raised when the set of selected tree items for a tree changes.
6637
+ *
6638
+ * @returns Reference to `this` in order to allow method chaining
5951
6639
  */
5952
6640
  attachSelectionChanged(
5953
6641
  /**
@@ -5972,6 +6660,8 @@ declare namespace sap {
5972
6660
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5973
6661
  *
5974
6662
  * Raised when the set of selected tree items for a tree changes.
6663
+ *
6664
+ * @returns Reference to `this` in order to allow method chaining
5975
6665
  */
5976
6666
  attachSelectionChanged(
5977
6667
  /**
@@ -5991,6 +6681,8 @@ declare namespace sap {
5991
6681
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
5992
6682
  *
5993
6683
  * Raised when the icon in the visibility column header is clicked.
6684
+ *
6685
+ * @returns Reference to `this` in order to allow method chaining
5994
6686
  */
5995
6687
  attachVisibilityHeaderIconClicked(
5996
6688
  /**
@@ -6015,6 +6707,8 @@ declare namespace sap {
6015
6707
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
6016
6708
  *
6017
6709
  * Raised when the icon in the visibility column header is clicked.
6710
+ *
6711
+ * @returns Reference to `this` in order to allow method chaining
6018
6712
  */
6019
6713
  attachVisibilityHeaderIconClicked(
6020
6714
  /**
@@ -6034,6 +6728,8 @@ declare namespace sap {
6034
6728
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
6035
6729
  *
6036
6730
  * Raised when an icon in the visibility column is clicked.
6731
+ *
6732
+ * @returns Reference to `this` in order to allow method chaining
6037
6733
  */
6038
6734
  attachVisibilityIconClicked(
6039
6735
  /**
@@ -6058,6 +6754,8 @@ declare namespace sap {
6058
6754
  * otherwise it will be bound to this `sap.ui.vtm.Tree` itself.
6059
6755
  *
6060
6756
  * Raised when an icon in the visibility column is clicked.
6757
+ *
6758
+ * @returns Reference to `this` in order to allow method chaining
6061
6759
  */
6062
6760
  attachVisibilityIconClicked(
6063
6761
  /**
@@ -6071,10 +6769,14 @@ declare namespace sap {
6071
6769
  ): this;
6072
6770
  /**
6073
6771
  * Expands all tree items in the tree.
6772
+ *
6773
+ * @returns Returns `this` for method chaining.
6074
6774
  */
6075
6775
  collapseAll(): sap.ui.vtm.Tree;
6076
6776
  /**
6077
6777
  * Destroys all the headerControls in the aggregation {@link #getHeaderControls headerControls}.
6778
+ *
6779
+ * @returns Reference to `this` in order to allow method chaining
6078
6780
  */
6079
6781
  destroyHeaderControls(): this;
6080
6782
  /**
@@ -6082,6 +6784,8 @@ declare namespace sap {
6082
6784
  * of this `sap.ui.vtm.Tree`.
6083
6785
  *
6084
6786
  * The passed function and listener object must match the ones used for event registration.
6787
+ *
6788
+ * @returns Reference to `this` in order to allow method chaining
6085
6789
  */
6086
6790
  detachBeforeModelUpdated(
6087
6791
  /**
@@ -6098,6 +6802,8 @@ declare namespace sap {
6098
6802
  * of this `sap.ui.vtm.Tree`.
6099
6803
  *
6100
6804
  * The passed function and listener object must match the ones used for event registration.
6805
+ *
6806
+ * @returns Reference to `this` in order to allow method chaining
6101
6807
  */
6102
6808
  detachDataColumnsChanged(
6103
6809
  /**
@@ -6113,6 +6819,8 @@ declare namespace sap {
6113
6819
  * Detaches event handler `fnFunction` from the {@link #event:dragOver dragOver} event of this `sap.ui.vtm.Tree`.
6114
6820
  *
6115
6821
  * The passed function and listener object must match the ones used for event registration.
6822
+ *
6823
+ * @returns Reference to `this` in order to allow method chaining
6116
6824
  */
6117
6825
  detachDragOver(
6118
6826
  /**
@@ -6128,6 +6836,8 @@ declare namespace sap {
6128
6836
  * Detaches event handler `fnFunction` from the {@link #event:dragStart dragStart} event of this `sap.ui.vtm.Tree`.
6129
6837
  *
6130
6838
  * The passed function and listener object must match the ones used for event registration.
6839
+ *
6840
+ * @returns Reference to `this` in order to allow method chaining
6131
6841
  */
6132
6842
  detachDragStart(
6133
6843
  /**
@@ -6143,6 +6853,8 @@ declare namespace sap {
6143
6853
  * Detaches event handler `fnFunction` from the {@link #event:drop drop} event of this `sap.ui.vtm.Tree`.
6144
6854
  *
6145
6855
  * The passed function and listener object must match the ones used for event registration.
6856
+ *
6857
+ * @returns Reference to `this` in order to allow method chaining
6146
6858
  */
6147
6859
  detachDrop(
6148
6860
  /**
@@ -6159,6 +6871,8 @@ declare namespace sap {
6159
6871
  * this `sap.ui.vtm.Tree`.
6160
6872
  *
6161
6873
  * The passed function and listener object must match the ones used for event registration.
6874
+ *
6875
+ * @returns Reference to `this` in order to allow method chaining
6162
6876
  */
6163
6877
  detachExpandedChanged(
6164
6878
  /**
@@ -6175,6 +6889,8 @@ declare namespace sap {
6175
6889
  * of this `sap.ui.vtm.Tree`.
6176
6890
  *
6177
6891
  * The passed function and listener object must match the ones used for event registration.
6892
+ *
6893
+ * @returns Reference to `this` in order to allow method chaining
6178
6894
  */
6179
6895
  detachFixedColumnsChanged(
6180
6896
  /**
@@ -6191,6 +6907,8 @@ declare namespace sap {
6191
6907
  * this `sap.ui.vtm.Tree`.
6192
6908
  *
6193
6909
  * The passed function and listener object must match the ones used for event registration.
6910
+ *
6911
+ * @returns Reference to `this` in order to allow method chaining
6194
6912
  */
6195
6913
  detachHierarchyChanged(
6196
6914
  /**
@@ -6207,6 +6925,8 @@ declare namespace sap {
6207
6925
  * event of this `sap.ui.vtm.Tree`.
6208
6926
  *
6209
6927
  * The passed function and listener object must match the ones used for event registration.
6928
+ *
6929
+ * @returns Reference to `this` in order to allow method chaining
6210
6930
  */
6211
6931
  detachMessageStatusHeaderIconClicked(
6212
6932
  /**
@@ -6223,6 +6943,8 @@ declare namespace sap {
6223
6943
  * event of this `sap.ui.vtm.Tree`.
6224
6944
  *
6225
6945
  * The passed function and listener object must match the ones used for event registration.
6946
+ *
6947
+ * @returns Reference to `this` in order to allow method chaining
6226
6948
  */
6227
6949
  detachMessageStatusIconClicked(
6228
6950
  /**
@@ -6238,6 +6960,8 @@ declare namespace sap {
6238
6960
  * Detaches event handler `fnFunction` from the {@link #event:modelUpdated modelUpdated} event of this `sap.ui.vtm.Tree`.
6239
6961
  *
6240
6962
  * The passed function and listener object must match the ones used for event registration.
6963
+ *
6964
+ * @returns Reference to `this` in order to allow method chaining
6241
6965
  */
6242
6966
  detachModelUpdated(
6243
6967
  /**
@@ -6254,6 +6978,8 @@ declare namespace sap {
6254
6978
  * this `sap.ui.vtm.Tree`.
6255
6979
  *
6256
6980
  * The passed function and listener object must match the ones used for event registration.
6981
+ *
6982
+ * @returns Reference to `this` in order to allow method chaining
6257
6983
  */
6258
6984
  detachSelectionChanged(
6259
6985
  /**
@@ -6270,6 +6996,8 @@ declare namespace sap {
6270
6996
  * event of this `sap.ui.vtm.Tree`.
6271
6997
  *
6272
6998
  * The passed function and listener object must match the ones used for event registration.
6999
+ *
7000
+ * @returns Reference to `this` in order to allow method chaining
6273
7001
  */
6274
7002
  detachVisibilityHeaderIconClicked(
6275
7003
  /**
@@ -6286,6 +7014,8 @@ declare namespace sap {
6286
7014
  * event of this `sap.ui.vtm.Tree`.
6287
7015
  *
6288
7016
  * The passed function and listener object must match the ones used for event registration.
7017
+ *
7018
+ * @returns Reference to `this` in order to allow method chaining
6289
7019
  */
6290
7020
  detachVisibilityIconClicked(
6291
7021
  /**
@@ -6299,12 +7029,16 @@ declare namespace sap {
6299
7029
  ): this;
6300
7030
  /**
6301
7031
  * Expands all tree items in the tree.
7032
+ *
7033
+ * @returns Returns `this` for method chaining.
6302
7034
  */
6303
7035
  expandAll(): sap.ui.vtm.Tree;
6304
7036
  /**
6305
7037
  * Expands all ancestors of specified tree item.
6306
7038
  *
6307
7039
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7040
+ *
7041
+ * @returns Returns `this` for method chaining.
6308
7042
  */
6309
7043
  expandAncestors(
6310
7044
  /**
@@ -6314,6 +7048,8 @@ declare namespace sap {
6314
7048
  ): sap.ui.vtm.Tree;
6315
7049
  /**
6316
7050
  * Expands tree items in the tree from the root down to the given level.
7051
+ *
7052
+ * @returns Returns `this` for method chaining.
6317
7053
  */
6318
7054
  expandToLevel(
6319
7055
  /**
@@ -6323,6 +7059,8 @@ declare namespace sap {
6323
7059
  ): sap.ui.vtm.Tree;
6324
7060
  /**
6325
7061
  * Fires event {@link #event:beforeModelUpdated beforeModelUpdated} to attached listeners.
7062
+ *
7063
+ * @returns Reference to `this` in order to allow method chaining
6326
7064
  */
6327
7065
  fireBeforeModelUpdated(
6328
7066
  /**
@@ -6332,6 +7070,8 @@ declare namespace sap {
6332
7070
  ): this;
6333
7071
  /**
6334
7072
  * Fires event {@link #event:dataColumnsChanged dataColumnsChanged} to attached listeners.
7073
+ *
7074
+ * @returns Reference to `this` in order to allow method chaining
6335
7075
  */
6336
7076
  fireDataColumnsChanged(
6337
7077
  /**
@@ -6344,6 +7084,8 @@ declare namespace sap {
6344
7084
  *
6345
7085
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
6346
7086
  * event object. The return value of this method indicates whether the default action should be executed.
7087
+ *
7088
+ * @returns Whether or not to prevent the default action
6347
7089
  */
6348
7090
  fireDragOver(
6349
7091
  /**
@@ -6373,6 +7115,8 @@ declare namespace sap {
6373
7115
  *
6374
7116
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
6375
7117
  * event object. The return value of this method indicates whether the default action should be executed.
7118
+ *
7119
+ * @returns Whether or not to prevent the default action
6376
7120
  */
6377
7121
  fireDragStart(
6378
7122
  /**
@@ -6391,6 +7135,8 @@ declare namespace sap {
6391
7135
  ): boolean;
6392
7136
  /**
6393
7137
  * Fires event {@link #event:drop drop} to attached listeners.
7138
+ *
7139
+ * @returns Reference to `this` in order to allow method chaining
6394
7140
  */
6395
7141
  fireDrop(
6396
7142
  /**
@@ -6417,6 +7163,8 @@ declare namespace sap {
6417
7163
  ): this;
6418
7164
  /**
6419
7165
  * Fires event {@link #event:expandedChanged expandedChanged} to attached listeners.
7166
+ *
7167
+ * @returns Reference to `this` in order to allow method chaining
6420
7168
  */
6421
7169
  fireExpandedChanged(
6422
7170
  /**
@@ -6439,6 +7187,8 @@ declare namespace sap {
6439
7187
  ): this;
6440
7188
  /**
6441
7189
  * Fires event {@link #event:fixedColumnsChanged fixedColumnsChanged} to attached listeners.
7190
+ *
7191
+ * @returns Reference to `this` in order to allow method chaining
6442
7192
  */
6443
7193
  fireFixedColumnsChanged(
6444
7194
  /**
@@ -6448,6 +7198,8 @@ declare namespace sap {
6448
7198
  ): this;
6449
7199
  /**
6450
7200
  * Fires event {@link #event:hierarchyChanged hierarchyChanged} to attached listeners.
7201
+ *
7202
+ * @returns Reference to `this` in order to allow method chaining
6451
7203
  */
6452
7204
  fireHierarchyChanged(
6453
7205
  /**
@@ -6458,6 +7210,8 @@ declare namespace sap {
6458
7210
  /**
6459
7211
  * Fires event {@link #event:messageStatusHeaderIconClicked messageStatusHeaderIconClicked} to attached
6460
7212
  * listeners.
7213
+ *
7214
+ * @returns Reference to `this` in order to allow method chaining
6461
7215
  */
6462
7216
  fireMessageStatusHeaderIconClicked(
6463
7217
  /**
@@ -6467,6 +7221,8 @@ declare namespace sap {
6467
7221
  ): this;
6468
7222
  /**
6469
7223
  * Fires event {@link #event:messageStatusIconClicked messageStatusIconClicked} to attached listeners.
7224
+ *
7225
+ * @returns Reference to `this` in order to allow method chaining
6470
7226
  */
6471
7227
  fireMessageStatusIconClicked(
6472
7228
  /**
@@ -6485,6 +7241,8 @@ declare namespace sap {
6485
7241
  ): this;
6486
7242
  /**
6487
7243
  * Fires event {@link #event:modelUpdated modelUpdated} to attached listeners.
7244
+ *
7245
+ * @returns Reference to `this` in order to allow method chaining
6488
7246
  */
6489
7247
  fireModelUpdated(
6490
7248
  /**
@@ -6494,6 +7252,8 @@ declare namespace sap {
6494
7252
  ): this;
6495
7253
  /**
6496
7254
  * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
7255
+ *
7256
+ * @returns Reference to `this` in order to allow method chaining
6497
7257
  */
6498
7258
  fireSelectionChanged(
6499
7259
  /**
@@ -6516,6 +7276,8 @@ declare namespace sap {
6516
7276
  ): this;
6517
7277
  /**
6518
7278
  * Fires event {@link #event:visibilityHeaderIconClicked visibilityHeaderIconClicked} to attached listeners.
7279
+ *
7280
+ * @returns Reference to `this` in order to allow method chaining
6519
7281
  */
6520
7282
  fireVisibilityHeaderIconClicked(
6521
7283
  /**
@@ -6534,6 +7296,8 @@ declare namespace sap {
6534
7296
  ): this;
6535
7297
  /**
6536
7298
  * Fires event {@link #event:visibilityIconClicked visibilityIconClicked} to attached listeners.
7299
+ *
7300
+ * @returns Reference to `this` in order to allow method chaining
6537
7301
  */
6538
7302
  fireVisibilityIconClicked(
6539
7303
  /**
@@ -6558,6 +7322,8 @@ declare namespace sap {
6558
7322
  * Finds all tree items in the tree of a given type.
6559
7323
  *
6560
7324
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7325
+ *
7326
+ * @returns All the tree items in the tree.
6561
7327
  */
6562
7328
  getAllItems(
6563
7329
  /**
@@ -6575,6 +7341,8 @@ declare namespace sap {
6575
7341
  * - The parent item will be last element in the array.
6576
7342
  *
6577
7343
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7344
+ *
7345
+ * @returns The ancestors of the tree item.
6578
7346
  */
6579
7347
  getAncestorItems(
6580
7348
  /**
@@ -6584,12 +7352,16 @@ declare namespace sap {
6584
7352
  ): object[];
6585
7353
  /**
6586
7354
  * Gets the set of data columns for the tree.
7355
+ *
7356
+ * @returns The data columns for the tree.
6587
7357
  */
6588
7358
  getDataColumns(): sap.ui.vtm.Column[];
6589
7359
  /**
6590
7360
  * Gets the descendants of a tree item.
6591
7361
  *
6592
7362
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7363
+ *
7364
+ * @returns The descendants of the tree item or undefined if the tree item is not found.
6593
7365
  */
6594
7366
  getDescendantItems(
6595
7367
  /**
@@ -6605,6 +7377,8 @@ declare namespace sap {
6605
7377
  * Gets whether the row associated with a tree item is expanded.
6606
7378
  *
6607
7379
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7380
+ *
7381
+ * @returns Whether the row associated with the specified tree item is expanded.
6608
7382
  */
6609
7383
  getExpanded(
6610
7384
  /**
@@ -6614,6 +7388,8 @@ declare namespace sap {
6614
7388
  ): boolean;
6615
7389
  /**
6616
7390
  * Gets the fixed columns for the tree.
7391
+ *
7392
+ * @returns The fixed columns.
6617
7393
  */
6618
7394
  getFixedColumns(): sap.ui.vtm.Column[];
6619
7395
  /**
@@ -6627,6 +7403,9 @@ declare namespace sap {
6627
7403
  *
6628
7404
  * If a single tree item is passed to the method then a single value is returned.
6629
7405
  * If an array of tree items is passed to the method then an array is returned.
7406
+ *
7407
+ * @returns A single value or an array of values representing the highlight color values of the tree item(s)
7408
+ * passed in.
6630
7409
  */
6631
7410
  getHighlightColor(
6632
7411
  /**
@@ -6637,6 +7416,8 @@ declare namespace sap {
6637
7416
  /**
6638
7417
  * Finds a tree item by id or returns undefined if it is not found.
6639
7418
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7419
+ *
7420
+ * @returns The tree item matching the specified id or undefined if no match was found.
6640
7421
  */
6641
7422
  getItem(
6642
7423
  /**
@@ -6647,6 +7428,8 @@ declare namespace sap {
6647
7428
  /**
6648
7429
  * Finds a tree item by binding context path or returns undefined if it is not found. This is typically
6649
7430
  * used to find the corresponding tree item in event handlers for custom column template controls.
7431
+ *
7432
+ * @returns The tree item matching the specified binding context path or undefined if no match was found.
6650
7433
  */
6651
7434
  getItemByBindingContextPath(
6652
7435
  /**
@@ -6658,6 +7441,9 @@ declare namespace sap {
6658
7441
  * Finds the set of tree items that are associated with a particular scene node id.
6659
7442
  *
6660
7443
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7444
+ *
7445
+ * @returns The set of tree items that have a `sceneNodeIds` property that contains the specified scene
7446
+ * node id.
6661
7447
  */
6662
7448
  getItemsBySceneNodeId(
6663
7449
  /**
@@ -6674,6 +7460,9 @@ declare namespace sap {
6674
7460
  *
6675
7461
  * If a single tree item is passed to the method then a single value is returned.
6676
7462
  * If an array of tree items is passed to the method then an array is returned.
7463
+ *
7464
+ * @returns A single value or an array of values representing the opacity values of the tree item(s) passed
7465
+ * in.
6677
7466
  */
6678
7467
  getOpacity(
6679
7468
  /**
@@ -6683,12 +7472,16 @@ declare namespace sap {
6683
7472
  ): float | float[];
6684
7473
  /**
6685
7474
  * Gets the panel this tree belongs to.
7475
+ *
7476
+ * @returns The panel this tree belongs to.
6686
7477
  */
6687
7478
  getPanel(): sap.ui.vtm.Panel;
6688
7479
  /**
6689
7480
  * Finds a parent tree item or returns undefined if it is not found.
6690
7481
  *
6691
7482
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7483
+ *
7484
+ * @returns The parent tree item or undefined if no match was found.
6692
7485
  */
6693
7486
  getParentItem(
6694
7487
  /**
@@ -6698,10 +7491,14 @@ declare namespace sap {
6698
7491
  ): object | undefined;
6699
7492
  /**
6700
7493
  * Gets the root tree items.
7494
+ *
7495
+ * @returns The root tree items.
6701
7496
  */
6702
7497
  getRootItems(): object[];
6703
7498
  /**
6704
7499
  * Gets the selected tree items.
7500
+ *
7501
+ * @returns The selected tree items.
6705
7502
  */
6706
7503
  getSelectedItems(): object[];
6707
7504
  /**
@@ -6710,6 +7507,8 @@ declare namespace sap {
6710
7507
  * The tree selection mode.
6711
7508
  *
6712
7509
  * Default value is `"Single"`.
7510
+ *
7511
+ * @returns Value of property `selectionMode`
6713
7512
  */
6714
7513
  getSelectionMode(): sap.ui.vtm.SelectionMode;
6715
7514
  /**
@@ -6717,6 +7516,9 @@ declare namespace sap {
6717
7516
  *
6718
7517
  * If a single tree item is passed to the method then a single value is returned.
6719
7518
  * If an array of tree items is passed to the method then an array is returned.
7519
+ *
7520
+ * @returns A single value or an array of values where the value is `true` if the tree item is visible,
7521
+ * `false` otherwise.
6720
7522
  */
6721
7523
  getVisibility(
6722
7524
  /**
@@ -6727,6 +7529,8 @@ declare namespace sap {
6727
7529
  /**
6728
7530
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeaderControls headerControls}.
6729
7531
  * and returns its index if found or -1 otherwise.
7532
+ *
7533
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
6730
7534
  */
6731
7535
  indexOfHeaderControl(
6732
7536
  /**
@@ -6736,6 +7540,8 @@ declare namespace sap {
6736
7540
  ): int;
6737
7541
  /**
6738
7542
  * Inserts a headerControl into the aggregation {@link #getHeaderControls headerControls}.
7543
+ *
7544
+ * @returns Reference to `this` in order to allow method chaining
6739
7545
  */
6740
7546
  insertHeaderControl(
6741
7547
  /**
@@ -6751,12 +7557,16 @@ declare namespace sap {
6751
7557
  ): this;
6752
7558
  /**
6753
7559
  * Returns whether the tree is empty.
7560
+ *
7561
+ * @returns Whether the tree is empty.
6754
7562
  */
6755
7563
  isEmpty(): boolean;
6756
7564
  /**
6757
7565
  * Returns whether a tree item object is an excluded tree item in the tree model of this {@link sap.ui.vtm.Tree}.
6758
7566
  *
6759
7567
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7568
+ *
7569
+ * @returns Whether a tree item object is an included tree item in this tree.
6760
7570
  */
6761
7571
  isExcludedItem(
6762
7572
  /**
@@ -6768,6 +7578,8 @@ declare namespace sap {
6768
7578
  * Returns whether a tree item object is an included tree item in the tree model of this {@link sap.ui.vtm.Tree}.
6769
7579
  *
6770
7580
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7581
+ *
7582
+ * @returns Whether a tree item object is an included tree item in this tree.
6771
7583
  */
6772
7584
  isIncludedItem(
6773
7585
  /**
@@ -6779,10 +7591,14 @@ declare namespace sap {
6779
7591
  * Removes all the controls from the aggregation {@link #getHeaderControls headerControls}.
6780
7592
  *
6781
7593
  * Additionally, it unregisters them from the hosting UIArea.
7594
+ *
7595
+ * @returns An array of the removed elements (might be empty)
6782
7596
  */
6783
7597
  removeAllHeaderControls(): sap.ui.core.Control[];
6784
7598
  /**
6785
7599
  * Removes a headerControl from the aggregation {@link #getHeaderControls headerControls}.
7600
+ *
7601
+ * @returns The removed headerControl or `null`
6786
7602
  */
6787
7603
  removeHeaderControl(
6788
7604
  /**
@@ -6792,6 +7608,8 @@ declare namespace sap {
6792
7608
  ): sap.ui.core.Control;
6793
7609
  /**
6794
7610
  * Removes a root item from the tree.
7611
+ *
7612
+ * @returns Returns the deleted item or undefined if no item was removed.
6795
7613
  */
6796
7614
  removeRoot(
6797
7615
  /**
@@ -6803,6 +7621,8 @@ declare namespace sap {
6803
7621
  * Brings specified tree item to view, expanding the tree if necessary.
6804
7622
  *
6805
7623
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7624
+ *
7625
+ * @returns Returns `this` for method chaining.
6806
7626
  */
6807
7627
  scrollIntoView(
6808
7628
  /**
@@ -6812,6 +7632,8 @@ declare namespace sap {
6812
7632
  ): sap.ui.vtm.Tree;
6813
7633
  /**
6814
7634
  * Sets the data columns for the tree.
7635
+ *
7636
+ * @returns Returns `this` for method chaining.
6815
7637
  */
6816
7638
  setDataColumns(
6817
7639
  /**
@@ -6823,6 +7645,8 @@ declare namespace sap {
6823
7645
  * Expands or collapses the row associated with a tree item.
6824
7646
  *
6825
7647
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7648
+ *
7649
+ * @returns A reference to `this` for method chaining.
6826
7650
  */
6827
7651
  setExpanded(
6828
7652
  /**
@@ -6836,6 +7660,8 @@ declare namespace sap {
6836
7660
  ): sap.ui.vtm.Tree;
6837
7661
  /**
6838
7662
  * Sets the fixed columns for the tree.
7663
+ *
7664
+ * @returns Returns `this` for method chaining.
6839
7665
  */
6840
7666
  setFixedColumns(
6841
7667
  /**
@@ -6845,6 +7671,8 @@ declare namespace sap {
6845
7671
  ): sap.ui.vtm.Tree;
6846
7672
  /**
6847
7673
  * Sets the `highlightColor` property of some tree items.
7674
+ *
7675
+ * @returns `this` to allow method chaining.
6848
7676
  */
6849
7677
  setHighlightColor(
6850
7678
  /**
@@ -6874,6 +7702,8 @@ declare namespace sap {
6874
7702
  ): sap.ui.vtm.Tree;
6875
7703
  /**
6876
7704
  * Sets the `opacity` property of some tree items.
7705
+ *
7706
+ * @returns `this` to allow method chaining.
6877
7707
  */
6878
7708
  setOpacity(
6879
7709
  /**
@@ -6903,6 +7733,8 @@ declare namespace sap {
6903
7733
  ): sap.ui.vtm.Tree;
6904
7734
  /**
6905
7735
  * Sets the root tree items.
7736
+ *
7737
+ * @returns Returns `this` for method chaining.
6906
7738
  */
6907
7739
  setRootItems(
6908
7740
  /**
@@ -6914,6 +7746,8 @@ declare namespace sap {
6914
7746
  * Sets the selected tree items.
6915
7747
  *
6916
7748
  * This method relies on {@link #updateCollections} being called after the tree is populated/changed.
7749
+ *
7750
+ * @returns Returns `this` for method chaining.
6917
7751
  */
6918
7752
  setSelectedItems(
6919
7753
  /**
@@ -6933,6 +7767,8 @@ declare namespace sap {
6933
7767
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6934
7768
  *
6935
7769
  * Default value is `"Single"`.
7770
+ *
7771
+ * @returns Reference to `this` in order to allow method chaining
6936
7772
  */
6937
7773
  setSelectionMode(
6938
7774
  /**
@@ -6942,6 +7778,8 @@ declare namespace sap {
6942
7778
  ): this;
6943
7779
  /**
6944
7780
  * Sets the `visibility` property of some tree items.
7781
+ *
7782
+ * @returns `this` to allow method chaining.
6945
7783
  */
6946
7784
  setVisibility(
6947
7785
  /**
@@ -6972,6 +7810,8 @@ declare namespace sap {
6972
7810
  /**
6973
7811
  * Recursively traverses a tree branch calling a function on each item (including the tree item that is
6974
7812
  * the root of the branch).
7813
+ *
7814
+ * @returns `this` to allow method chaining.
6975
7815
  */
6976
7816
  traverseBranch(
6977
7817
  /**
@@ -6992,6 +7832,8 @@ declare namespace sap {
6992
7832
  ): sap.ui.vtm.Tree;
6993
7833
  /**
6994
7834
  * Recursively traverses the tree calling a function on each item.
7835
+ *
7836
+ * @returns `this` to allow method chaining.
6995
7837
  */
6996
7838
  traverseTree(
6997
7839
  /**
@@ -7030,6 +7872,8 @@ declare namespace sap {
7030
7872
  * ***** When the only changes to the tree since the last call to {@link #updateCollections} are changes
7031
7873
  * to the sceneNodeIds properties of the tree items, {@link #updateTreeItemsBySceneNodeId} can
7032
7874
  * be used instead of {@link #updateCollections}.
7875
+ *
7876
+ * @returns Returns `this` for method chaining.
7033
7877
  */
7034
7878
  updateCollections(
7035
7879
  /**
@@ -7044,6 +7888,8 @@ declare namespace sap {
7044
7888
  * Updates the model.
7045
7889
  *
7046
7890
  * The application should call this whenever changes are made to the tree model.
7891
+ *
7892
+ * @returns Returns `this` for method chaining.
7047
7893
  */
7048
7894
  updateModel(
7049
7895
  /**
@@ -7059,10 +7905,14 @@ declare namespace sap {
7059
7905
  *
7060
7906
  * This is useful when the only changes to the tree since the last call to {@link #updateCollections} are
7061
7907
  * changes to the sceneNodeIds properties of the tree items.
7908
+ *
7909
+ * @returns Returns `this` for method chaining.
7062
7910
  */
7063
7911
  updateTreeItemsBySceneNodeId(): sap.ui.vtm.Tree;
7064
7912
  /**
7065
7913
  * Validates the tree. If errors are found they are written to the console log and an exception is thrown.
7914
+ *
7915
+ * @returns `this` for method chaining.
7066
7916
  */
7067
7917
  validateTree(): sap.ui.vtm.Tree;
7068
7918
  }
@@ -7095,6 +7945,8 @@ declare namespace sap {
7095
7945
  * contained in `oClassInfo`.
7096
7946
  *
7097
7947
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
7948
+ *
7949
+ * @returns Created class / constructor function
7098
7950
  */
7099
7951
  static extend<T extends Record<string, unknown>>(
7100
7952
  /**
@@ -7113,12 +7965,16 @@ declare namespace sap {
7113
7965
  ): Function;
7114
7966
  /**
7115
7967
  * Returns a metadata object for class sap.ui.vtm.Viewable.
7968
+ *
7969
+ * @returns Metadata object describing this class
7116
7970
  */
7117
7971
  static getMetadata(): sap.ui.core.ElementMetadata;
7118
7972
  /**
7119
7973
  * Gets current value of property {@link #getName name}.
7120
7974
  *
7121
7975
  * The name for this Viewable.
7976
+ *
7977
+ * @returns Value of property `name`
7122
7978
  */
7123
7979
  getName(): string;
7124
7980
  /**
@@ -7126,31 +7982,43 @@ declare namespace sap {
7126
7982
  *
7127
7983
  * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded
7128
7984
  * viewable.
7985
+ *
7986
+ * @returns Value of property `relativeMatrix`
7129
7987
  */
7130
7988
  getRelativeMatrix(): sap.ui.vtm.Matrix;
7131
7989
  /**
7132
7990
  * Gets current value of property {@link #getRootNodeIds rootNodeIds}.
7133
7991
  *
7134
7992
  * The root scene node IDs for this viewable.
7993
+ *
7994
+ * @returns Value of property `rootNodeIds`
7135
7995
  */
7136
7996
  getRootNodeIds(): string[];
7137
7997
  /**
7138
7998
  * Gets current value of property {@link #getSource source}.
7139
7999
  *
7140
8000
  * The source URL (string) or File for this Viewable.
8001
+ *
8002
+ * @returns Value of property `source`
7141
8003
  */
7142
8004
  getSource(): any;
7143
8005
  /**
7144
8006
  * Gets the unique ID that identifies this Viewable. This is an alias for {@link #getId}
8007
+ *
8008
+ * @returns The unique ID that identifies this Viewable.
7145
8009
  */
7146
8010
  getSourceId(): string;
7147
8011
  /**
7148
8012
  * Returns a string representation of the source. If the source is a {@link File} this returns the file
7149
8013
  * name (which is not guaranteed to uniquely identify the file).
8014
+ *
8015
+ * @returns A string representation of the source.
7150
8016
  */
7151
8017
  getSourceString(): string;
7152
8018
  /**
7153
8019
  * Sets the name for this Viewable.
8020
+ *
8021
+ * @returns `this` for method chaining.
7154
8022
  */
7155
8023
  setName(
7156
8024
  /**
@@ -7165,6 +8033,8 @@ declare namespace sap {
7165
8033
  * viewable.
7166
8034
  *
7167
8035
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8036
+ *
8037
+ * @returns Reference to `this` in order to allow method chaining
7168
8038
  */
7169
8039
  setRelativeMatrix(
7170
8040
  /**
@@ -7178,6 +8048,8 @@ declare namespace sap {
7178
8048
  * The root scene node IDs for this viewable.
7179
8049
  *
7180
8050
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8051
+ *
8052
+ * @returns Reference to `this` in order to allow method chaining
7181
8053
  */
7182
8054
  setRootNodeIds(
7183
8055
  /**
@@ -7187,6 +8059,8 @@ declare namespace sap {
7187
8059
  ): this;
7188
8060
  /**
7189
8061
  * Sets the source URL or File for this Viewable.
8062
+ *
8063
+ * @returns `this` for method chaining.
7190
8064
  */
7191
8065
  setSource(
7192
8066
  /**
@@ -7220,6 +8094,8 @@ declare namespace sap {
7220
8094
  * the information contained in `oClassInfo`.
7221
8095
  *
7222
8096
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
8097
+ *
8098
+ * @returns Created class / constructor function
7223
8099
  */
7224
8100
  static extend<T extends Record<string, unknown>>(
7225
8101
  /**
@@ -7238,6 +8114,8 @@ declare namespace sap {
7238
8114
  ): Function;
7239
8115
  /**
7240
8116
  * Returns a metadata object for class sap.ui.vtm.ViewableLoadInfo.
8117
+ *
8118
+ * @returns Metadata object describing this class
7241
8119
  */
7242
8120
  static getMetadata(): sap.ui.core.ElementMetadata;
7243
8121
  /**
@@ -7246,6 +8124,8 @@ declare namespace sap {
7246
8124
  * The error code describing why the Viewable failed to load.
7247
8125
  *
7248
8126
  * Use when {@link #getSucceeded} returns false.
8127
+ *
8128
+ * @returns Value of property `errorCode`
7249
8129
  */
7250
8130
  getErrorCode(): string;
7251
8131
  /**
@@ -7253,6 +8133,8 @@ declare namespace sap {
7253
8133
  *
7254
8134
  * The error text describing why the Viewable failed to load. This is an untranslated technical message.
7255
8135
  * Use when {@link #getSucceeded} returns false.
8136
+ *
8137
+ * @returns Value of property `errorText`
7256
8138
  */
7257
8139
  getErrorText(): string;
7258
8140
  /**
@@ -7260,12 +8142,16 @@ declare namespace sap {
7260
8142
  *
7261
8143
  * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo}
7262
8144
  * relates to.
8145
+ *
8146
+ * @returns Value of property `status`
7263
8147
  */
7264
8148
  getStatus(): sap.ui.vtm.ViewableLoadStatus;
7265
8149
  /**
7266
8150
  * Gets current value of property {@link #getViewable viewable}.
7267
8151
  *
7268
8152
  * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to.
8153
+ *
8154
+ * @returns Value of property `viewable`
7269
8155
  */
7270
8156
  getViewable(): object;
7271
8157
  /**
@@ -7276,6 +8162,8 @@ declare namespace sap {
7276
8162
  * Use when {@link #getSucceeded} returns false.
7277
8163
  *
7278
8164
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8165
+ *
8166
+ * @returns Reference to `this` in order to allow method chaining
7279
8167
  */
7280
8168
  setErrorCode(
7281
8169
  /**
@@ -7290,6 +8178,8 @@ declare namespace sap {
7290
8178
  * Use when {@link #getSucceeded} returns false.
7291
8179
  *
7292
8180
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8181
+ *
8182
+ * @returns Reference to `this` in order to allow method chaining
7293
8183
  */
7294
8184
  setErrorText(
7295
8185
  /**
@@ -7304,6 +8194,8 @@ declare namespace sap {
7304
8194
  * relates to.
7305
8195
  *
7306
8196
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8197
+ *
8198
+ * @returns Reference to `this` in order to allow method chaining
7307
8199
  */
7308
8200
  setStatus(
7309
8201
  /**
@@ -7317,6 +8209,8 @@ declare namespace sap {
7317
8209
  * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to.
7318
8210
  *
7319
8211
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8212
+ *
8213
+ * @returns Reference to `this` in order to allow method chaining
7320
8214
  */
7321
8215
  setViewable(
7322
8216
  /**
@@ -7346,6 +8240,8 @@ declare namespace sap {
7346
8240
  * contained in `oClassInfo`.
7347
8241
  *
7348
8242
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
8243
+ *
8244
+ * @returns Created class / constructor function
7349
8245
  */
7350
8246
  static extend<T extends Record<string, unknown>>(
7351
8247
  /**
@@ -7364,10 +8260,14 @@ declare namespace sap {
7364
8260
  ): Function;
7365
8261
  /**
7366
8262
  * Returns a metadata object for class sap.ui.vtm.Viewport.
8263
+ *
8264
+ * @returns Metadata object describing this class
7367
8265
  */
7368
8266
  static getMetadata(): sap.ui.core.ElementMetadata;
7369
8267
  /**
7370
8268
  * Adds an override display group to the `overrideDisplayGroups` property.
8269
+ *
8270
+ * @returns `this` for method chaining.
7371
8271
  */
7372
8272
  addContextDisplayGroup(
7373
8273
  /**
@@ -7377,6 +8277,8 @@ declare namespace sap {
7377
8277
  ): sap.ui.vtm.Viewport;
7378
8278
  /**
7379
8279
  * Adds some headerControl into the association {@link #getHeaderControls headerControls}.
8280
+ *
8281
+ * @returns Reference to `this` in order to allow method chaining
7380
8282
  */
7381
8283
  addHeaderControl(
7382
8284
  /**
@@ -7386,6 +8288,8 @@ declare namespace sap {
7386
8288
  ): this;
7387
8289
  /**
7388
8290
  * Adds an override display group to the `overrideDisplayGroups` property.
8291
+ *
8292
+ * @returns `this` for method chaining.
7389
8293
  */
7390
8294
  addOverrideDisplayGroup(
7391
8295
  /**
@@ -7400,6 +8304,8 @@ declare namespace sap {
7400
8304
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7401
8305
  *
7402
8306
  * Raised when a gesture begins.
8307
+ *
8308
+ * @returns Reference to `this` in order to allow method chaining
7403
8309
  */
7404
8310
  attachBeginGesture(
7405
8311
  /**
@@ -7423,6 +8329,8 @@ declare namespace sap {
7423
8329
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7424
8330
  *
7425
8331
  * Raised when a gesture begins.
8332
+ *
8333
+ * @returns Reference to `this` in order to allow method chaining
7426
8334
  */
7427
8335
  attachBeginGesture(
7428
8336
  /**
@@ -7441,6 +8349,8 @@ declare namespace sap {
7441
8349
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7442
8350
  *
7443
8351
  * Raised when a gesture ends.
8352
+ *
8353
+ * @returns Reference to `this` in order to allow method chaining
7444
8354
  */
7445
8355
  attachEndGesture(
7446
8356
  /**
@@ -7464,6 +8374,8 @@ declare namespace sap {
7464
8374
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7465
8375
  *
7466
8376
  * Raised when a gesture ends.
8377
+ *
8378
+ * @returns Reference to `this` in order to allow method chaining
7467
8379
  */
7468
8380
  attachEndGesture(
7469
8381
  /**
@@ -7482,6 +8394,8 @@ declare namespace sap {
7482
8394
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7483
8395
  *
7484
8396
  * Raised on mouse move over viewport.
8397
+ *
8398
+ * @returns Reference to `this` in order to allow method chaining
7485
8399
  */
7486
8400
  attachHover(
7487
8401
  /**
@@ -7505,6 +8419,8 @@ declare namespace sap {
7505
8419
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7506
8420
  *
7507
8421
  * Raised on mouse move over viewport.
8422
+ *
8423
+ * @returns Reference to `this` in order to allow method chaining
7508
8424
  */
7509
8425
  attachHover(
7510
8426
  /**
@@ -7523,6 +8439,8 @@ declare namespace sap {
7523
8439
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7524
8440
  *
7525
8441
  * Raised when a node in the viewport is clicked.
8442
+ *
8443
+ * @returns Reference to `this` in order to allow method chaining
7526
8444
  */
7527
8445
  attachNodeClicked(
7528
8446
  /**
@@ -7546,6 +8464,8 @@ declare namespace sap {
7546
8464
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7547
8465
  *
7548
8466
  * Raised when a node in the viewport is clicked.
8467
+ *
8468
+ * @returns Reference to `this` in order to allow method chaining
7549
8469
  */
7550
8470
  attachNodeClicked(
7551
8471
  /**
@@ -7566,6 +8486,8 @@ declare namespace sap {
7566
8486
  *
7567
8487
  * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code
7568
8488
  * that is managing the viewport display state.
8489
+ *
8490
+ * @returns Reference to `this` in order to allow method chaining
7569
8491
  */
7570
8492
  attachRefreshRequested(
7571
8493
  /**
@@ -7591,6 +8513,8 @@ declare namespace sap {
7591
8513
  *
7592
8514
  * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code
7593
8515
  * that is managing the viewport display state.
8516
+ *
8517
+ * @returns Reference to `this` in order to allow method chaining
7594
8518
  */
7595
8519
  attachRefreshRequested(
7596
8520
  /**
@@ -7610,6 +8534,8 @@ declare namespace sap {
7610
8534
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7611
8535
  *
7612
8536
  * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space).
8537
+ *
8538
+ * @returns Reference to `this` in order to allow method chaining
7613
8539
  */
7614
8540
  attachSelectionChanged(
7615
8541
  /**
@@ -7634,6 +8560,8 @@ declare namespace sap {
7634
8560
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7635
8561
  *
7636
8562
  * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space).
8563
+ *
8564
+ * @returns Reference to `this` in order to allow method chaining
7637
8565
  */
7638
8566
  attachSelectionChanged(
7639
8567
  /**
@@ -7652,6 +8580,8 @@ declare namespace sap {
7652
8580
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7653
8581
  *
7654
8582
  * Raised when viewport's camera view changed.
8583
+ *
8584
+ * @returns Reference to `this` in order to allow method chaining
7655
8585
  */
7656
8586
  attachViewChanged(
7657
8587
  /**
@@ -7675,6 +8605,8 @@ declare namespace sap {
7675
8605
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7676
8606
  *
7677
8607
  * Raised when viewport's camera view changed.
8608
+ *
8609
+ * @returns Reference to `this` in order to allow method chaining
7678
8610
  */
7679
8611
  attachViewChanged(
7680
8612
  /**
@@ -7694,6 +8626,8 @@ declare namespace sap {
7694
8626
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7695
8627
  *
7696
8628
  * Raised when the visibility of scene nodes changed in the viewport.
8629
+ *
8630
+ * @returns Reference to `this` in order to allow method chaining
7697
8631
  */
7698
8632
  attachVisibilityChanged(
7699
8633
  /**
@@ -7718,6 +8652,8 @@ declare namespace sap {
7718
8652
  * otherwise it will be bound to this `sap.ui.vtm.Viewport` itself.
7719
8653
  *
7720
8654
  * Raised when the visibility of scene nodes changed in the viewport.
8655
+ *
8656
+ * @returns Reference to `this` in order to allow method chaining
7721
8657
  */
7722
8658
  attachVisibilityChanged(
7723
8659
  /**
@@ -7733,6 +8669,8 @@ declare namespace sap {
7733
8669
  * Detaches event handler `fnFunction` from the {@link #event:beginGesture beginGesture} event of this `sap.ui.vtm.Viewport`.
7734
8670
  *
7735
8671
  * The passed function and listener object must match the ones used for event registration.
8672
+ *
8673
+ * @returns Reference to `this` in order to allow method chaining
7736
8674
  */
7737
8675
  detachBeginGesture(
7738
8676
  /**
@@ -7748,6 +8686,8 @@ declare namespace sap {
7748
8686
  * Detaches event handler `fnFunction` from the {@link #event:endGesture endGesture} event of this `sap.ui.vtm.Viewport`.
7749
8687
  *
7750
8688
  * The passed function and listener object must match the ones used for event registration.
8689
+ *
8690
+ * @returns Reference to `this` in order to allow method chaining
7751
8691
  */
7752
8692
  detachEndGesture(
7753
8693
  /**
@@ -7763,6 +8703,8 @@ declare namespace sap {
7763
8703
  * Detaches event handler `fnFunction` from the {@link #event:hover hover} event of this `sap.ui.vtm.Viewport`.
7764
8704
  *
7765
8705
  * The passed function and listener object must match the ones used for event registration.
8706
+ *
8707
+ * @returns Reference to `this` in order to allow method chaining
7766
8708
  */
7767
8709
  detachHover(
7768
8710
  /**
@@ -7778,6 +8720,8 @@ declare namespace sap {
7778
8720
  * Detaches event handler `fnFunction` from the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vtm.Viewport`.
7779
8721
  *
7780
8722
  * The passed function and listener object must match the ones used for event registration.
8723
+ *
8724
+ * @returns Reference to `this` in order to allow method chaining
7781
8725
  */
7782
8726
  detachNodeClicked(
7783
8727
  /**
@@ -7794,6 +8738,8 @@ declare namespace sap {
7794
8738
  * this `sap.ui.vtm.Viewport`.
7795
8739
  *
7796
8740
  * The passed function and listener object must match the ones used for event registration.
8741
+ *
8742
+ * @returns Reference to `this` in order to allow method chaining
7797
8743
  */
7798
8744
  detachRefreshRequested(
7799
8745
  /**
@@ -7810,6 +8756,8 @@ declare namespace sap {
7810
8756
  * this `sap.ui.vtm.Viewport`.
7811
8757
  *
7812
8758
  * The passed function and listener object must match the ones used for event registration.
8759
+ *
8760
+ * @returns Reference to `this` in order to allow method chaining
7813
8761
  */
7814
8762
  detachSelectionChanged(
7815
8763
  /**
@@ -7825,6 +8773,8 @@ declare namespace sap {
7825
8773
  * Detaches event handler `fnFunction` from the {@link #event:viewChanged viewChanged} event of this `sap.ui.vtm.Viewport`.
7826
8774
  *
7827
8775
  * The passed function and listener object must match the ones used for event registration.
8776
+ *
8777
+ * @returns Reference to `this` in order to allow method chaining
7828
8778
  */
7829
8779
  detachViewChanged(
7830
8780
  /**
@@ -7841,6 +8791,8 @@ declare namespace sap {
7841
8791
  * of this `sap.ui.vtm.Viewport`.
7842
8792
  *
7843
8793
  * The passed function and listener object must match the ones used for event registration.
8794
+ *
8795
+ * @returns Reference to `this` in order to allow method chaining
7844
8796
  */
7845
8797
  detachVisibilityChanged(
7846
8798
  /**
@@ -7854,6 +8806,8 @@ declare namespace sap {
7854
8806
  ): this;
7855
8807
  /**
7856
8808
  * Fires event {@link #event:beginGesture beginGesture} to attached listeners.
8809
+ *
8810
+ * @returns Reference to `this` in order to allow method chaining
7857
8811
  */
7858
8812
  fireBeginGesture(
7859
8813
  /**
@@ -7863,6 +8817,8 @@ declare namespace sap {
7863
8817
  ): this;
7864
8818
  /**
7865
8819
  * Fires event {@link #event:endGesture endGesture} to attached listeners.
8820
+ *
8821
+ * @returns Reference to `this` in order to allow method chaining
7866
8822
  */
7867
8823
  fireEndGesture(
7868
8824
  /**
@@ -7872,6 +8828,8 @@ declare namespace sap {
7872
8828
  ): this;
7873
8829
  /**
7874
8830
  * Fires event {@link #event:hover hover} to attached listeners.
8831
+ *
8832
+ * @returns Reference to `this` in order to allow method chaining
7875
8833
  */
7876
8834
  fireHover(
7877
8835
  /**
@@ -7894,6 +8852,8 @@ declare namespace sap {
7894
8852
  ): this;
7895
8853
  /**
7896
8854
  * Fires event {@link #event:nodeClicked nodeClicked} to attached listeners.
8855
+ *
8856
+ * @returns Reference to `this` in order to allow method chaining
7897
8857
  */
7898
8858
  fireNodeClicked(
7899
8859
  /**
@@ -7903,6 +8863,8 @@ declare namespace sap {
7903
8863
  ): this;
7904
8864
  /**
7905
8865
  * Fires event {@link #event:refreshRequested refreshRequested} to attached listeners.
8866
+ *
8867
+ * @returns Reference to `this` in order to allow method chaining
7906
8868
  */
7907
8869
  fireRefreshRequested(
7908
8870
  /**
@@ -7912,6 +8874,8 @@ declare namespace sap {
7912
8874
  ): this;
7913
8875
  /**
7914
8876
  * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners.
8877
+ *
8878
+ * @returns Reference to `this` in order to allow method chaining
7915
8879
  */
7916
8880
  fireSelectionChanged(
7917
8881
  /**
@@ -7934,6 +8898,8 @@ declare namespace sap {
7934
8898
  ): this;
7935
8899
  /**
7936
8900
  * Fires event {@link #event:viewChanged viewChanged} to attached listeners.
8901
+ *
8902
+ * @returns Reference to `this` in order to allow method chaining
7937
8903
  */
7938
8904
  fireViewChanged(
7939
8905
  /**
@@ -7949,6 +8915,8 @@ declare namespace sap {
7949
8915
  ): this;
7950
8916
  /**
7951
8917
  * Fires event {@link #event:visibilityChanged visibilityChanged} to attached listeners.
8918
+ *
8919
+ * @returns Reference to `this` in order to allow method chaining
7952
8920
  */
7953
8921
  fireVisibilityChanged(
7954
8922
  /**
@@ -7975,6 +8943,8 @@ declare namespace sap {
7975
8943
  * The background gradient bottom color
7976
8944
  *
7977
8945
  * Default value is `"white"`.
8946
+ *
8947
+ * @returns Value of property `backgroundGradientBottomColor`
7978
8948
  */
7979
8949
  getBackgroundGradientBottomColor(): sap.ui.core.CSSColor;
7980
8950
  /**
@@ -7983,6 +8953,8 @@ declare namespace sap {
7983
8953
  * The background gradient top color.
7984
8954
  *
7985
8955
  * Default value is `"black"`.
8956
+ *
8957
+ * @returns Value of property `backgroundGradientTopColor`
7986
8958
  */
7987
8959
  getBackgroundGradientTopColor(): sap.ui.core.CSSColor;
7988
8960
  /**
@@ -7990,6 +8962,8 @@ declare namespace sap {
7990
8962
  *
7991
8963
  * This value can then be passed to {@link sap.ui.vtm.Viewport#setCameraInfo setCameraInfo} to restore the
7992
8964
  * camera position at a later point in time.
8965
+ *
8966
+ * @returns An object containing the current camera information for this viewport.
7993
8967
  */
7994
8968
  getCameraInfo(): object;
7995
8969
  /**
@@ -8003,6 +8977,8 @@ declare namespace sap {
8003
8977
  * state in the viewport after modifying override display groups.
8004
8978
  *
8005
8979
  * Default value is `[]`.
8980
+ *
8981
+ * @returns Value of property `contextDisplayGroups`
8006
8982
  */
8007
8983
  getContextDisplayGroups(): object[];
8008
8984
  /**
@@ -8012,6 +8988,8 @@ declare namespace sap {
8012
8988
  getHeaderControls(): sap.ui.core.ID[];
8013
8989
  /**
8014
8990
  * Gets the highlight colors for a set of scene nodes in this viewport.
8991
+ *
8992
+ * @returns The highlight colors for the relevant scene nodes. The
8015
8993
  */
8016
8994
  getHighlightColor(
8017
8995
  /**
@@ -8021,11 +8999,15 @@ declare namespace sap {
8021
8999
  ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[];
8022
9000
  /**
8023
9001
  * Returns whether the {@link sap.ui.vtm.Viewport} has been initialized.
9002
+ *
9003
+ * @returns Whether the {@link sap.ui.vtm.Viewport} has been initialized.
8024
9004
  */
8025
9005
  getInitialized(): boolean;
8026
9006
  /**
8027
9007
  * Gets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point
8028
9008
  * value in the interval [0,1].
9009
+ *
9010
+ * @returns The opacity states for the relevant scene nodes.
8029
9011
  */
8030
9012
  getOpacity(
8031
9013
  /**
@@ -8045,18 +9027,26 @@ declare namespace sap {
8045
9027
  * groups.
8046
9028
  *
8047
9029
  * Default value is `[]`.
9030
+ *
9031
+ * @returns Value of property `overrideDisplayGroups`
8048
9032
  */
8049
9033
  getOverrideDisplayGroups(): object[];
8050
9034
  /**
8051
9035
  * Gets the panel this viewport belongs to.
9036
+ *
9037
+ * @returns The panel this viewport belongs to.
8052
9038
  */
8053
9039
  getPanel(): sap.ui.vtm.Panel;
8054
9040
  /**
8055
9041
  * Gets the {@link sap.ui.vtm.Scene} used by this {@link sap.ui.vtm.Viewport}.
9042
+ *
9043
+ * @returns The sap.ui.vtm.Scene used by this Viewport.
8056
9044
  */
8057
9045
  getScene(): sap.ui.vtm.Scene;
8058
9046
  /**
8059
9047
  * Gets the selection state for a set of scene nodes in this viewport.
9048
+ *
9049
+ * @returns The selection states for the relevant scene nodes.
8060
9050
  */
8061
9051
  getSelected(
8062
9052
  /**
@@ -8066,10 +9056,14 @@ declare namespace sap {
8066
9056
  ): boolean | boolean[];
8067
9057
  /**
8068
9058
  * Gets the IDs of the scene nodes that are selected in this viewport.
9059
+ *
9060
+ * @returns The IDs of the scene nodes that are selected in this viewport.
8069
9061
  */
8070
9062
  getSelectedIds(): string[];
8071
9063
  /**
8072
9064
  * Gets the visibility state for a set of scene nodes in this viewport.
9065
+ *
9066
+ * @returns The visibility states for the relevant scene nodes.
8073
9067
  */
8074
9068
  getVisibility(
8075
9069
  /**
@@ -8079,14 +9073,20 @@ declare namespace sap {
8079
9073
  ): boolean | boolean[];
8080
9074
  /**
8081
9075
  * Fires a `refreshRequested` event.
9076
+ *
9077
+ * @returns `this` for method chaining.
8082
9078
  */
8083
9079
  refresh(): sap.ui.vtm.Viewport;
8084
9080
  /**
8085
9081
  * Removes all the controls in the association named {@link #getHeaderControls headerControls}.
9082
+ *
9083
+ * @returns An array of the removed elements (might be empty)
8086
9084
  */
8087
9085
  removeAllHeaderControls(): sap.ui.core.ID[];
8088
9086
  /**
8089
9087
  * Removes an headerControl from the association named {@link #getHeaderControls headerControls}.
9088
+ *
9089
+ * @returns The removed headerControl or `null`
8090
9090
  */
8091
9091
  removeHeaderControl(
8092
9092
  /**
@@ -8102,6 +9102,8 @@ declare namespace sap {
8102
9102
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8103
9103
  *
8104
9104
  * Default value is `"white"`.
9105
+ *
9106
+ * @returns Reference to `this` in order to allow method chaining
8105
9107
  */
8106
9108
  setBackgroundGradientBottomColor(
8107
9109
  /**
@@ -8117,6 +9119,8 @@ declare namespace sap {
8117
9119
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8118
9120
  *
8119
9121
  * Default value is `"black"`.
9122
+ *
9123
+ * @returns Reference to `this` in order to allow method chaining
8120
9124
  */
8121
9125
  setBackgroundGradientTopColor(
8122
9126
  /**
@@ -8126,6 +9130,8 @@ declare namespace sap {
8126
9130
  ): this;
8127
9131
  /**
8128
9132
  * Updates the camera for this viewport.
9133
+ *
9134
+ * @returns A reference to `this` to allow method chaining.
8129
9135
  */
8130
9136
  setCameraInfo(
8131
9137
  /**
@@ -8150,6 +9156,8 @@ declare namespace sap {
8150
9156
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8151
9157
  *
8152
9158
  * Default value is `[]`.
9159
+ *
9160
+ * @returns Reference to `this` in order to allow method chaining
8153
9161
  */
8154
9162
  setContextDisplayGroups(
8155
9163
  /**
@@ -8163,6 +9171,8 @@ declare namespace sap {
8163
9171
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8164
9172
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8165
9173
  * should perform all management of scene node visibility in the viewports.
9174
+ *
9175
+ * @returns `this` for method chaining.
8166
9176
  */
8167
9177
  setHighlightColor(
8168
9178
  /**
@@ -8187,6 +9197,8 @@ declare namespace sap {
8187
9197
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8188
9198
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8189
9199
  * should perform all management of scene node visibility in the viewports.
9200
+ *
9201
+ * @returns `this` for method chaining.
8190
9202
  */
8191
9203
  setOpacity(
8192
9204
  /**
@@ -8216,6 +9228,8 @@ declare namespace sap {
8216
9228
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8217
9229
  *
8218
9230
  * Default value is `[]`.
9231
+ *
9232
+ * @returns Reference to `this` in order to allow method chaining
8219
9233
  */
8220
9234
  setOverrideDisplayGroups(
8221
9235
  /**
@@ -8225,6 +9239,8 @@ declare namespace sap {
8225
9239
  ): this;
8226
9240
  /**
8227
9241
  * Sets the view in the current viewport to one of the predefined views.
9242
+ *
9243
+ * @returns `this` for method chaining.
8228
9244
  */
8229
9245
  setPredefinedView(
8230
9246
  /**
@@ -8238,6 +9254,8 @@ declare namespace sap {
8238
9254
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension}
8239
9255
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension}
8240
9256
  * should perform all management of scene node selection in the viewports.
9257
+ *
9258
+ * @returns `this` for method chaining.
8241
9259
  */
8242
9260
  setSelected(
8243
9261
  /**
@@ -8259,6 +9277,8 @@ declare namespace sap {
8259
9277
  * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8260
9278
  * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension}
8261
9279
  * should perform all management of scene node visibility in the viewports.
9280
+ *
9281
+ * @returns `this` for method chaining.
8262
9282
  */
8263
9283
  setVisibility(
8264
9284
  /**
@@ -8276,6 +9296,8 @@ declare namespace sap {
8276
9296
  ): sap.ui.vtm.Viewport;
8277
9297
  /**
8278
9298
  * Zooms to a view in the current viewport that can fit all geometry in the scene (visible or not).
9299
+ *
9300
+ * @returns Returns `this` for method chaining.
8279
9301
  */
8280
9302
  zoomToAll(
8281
9303
  /**
@@ -8286,6 +9308,8 @@ declare namespace sap {
8286
9308
  /**
8287
9309
  * Calls {@link sap.ui.vtm.Viewport#zoomToSelected zoomToSelected} if any geometry is selected in this viewport,
8288
9310
  * otherwise calls {@link sap.ui.vtm.Viewport#zoomToAll zoomToAll}.
9311
+ *
9312
+ * @returns Returns `this` for method chaining.
8289
9313
  */
8290
9314
  zoomToFit(
8291
9315
  /**
@@ -8296,6 +9320,8 @@ declare namespace sap {
8296
9320
  /**
8297
9321
  * Zooms to the set of geometry that is selected in the current viewport. If no geometry is selected, no
8298
9322
  * action is taken.
9323
+ *
9324
+ * @returns Returns `this` for method chaining.
8299
9325
  */
8300
9326
  zoomToSelected(
8301
9327
  /**
@@ -8306,6 +9332,8 @@ declare namespace sap {
8306
9332
  /**
8307
9333
  * Zooms to the set of geometry that is visible in the current viewport. If no geometry is visible, this
8308
9334
  * zooms to all geometry in the current viewport.
9335
+ *
9336
+ * @returns Returns `this` for method chaining.
8309
9337
  */
8310
9338
  zoomToVisible(
8311
9339
  /**
@@ -8346,6 +9374,8 @@ declare namespace sap {
8346
9374
  * contained in `oClassInfo`.
8347
9375
  *
8348
9376
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
9377
+ *
9378
+ * @returns Created class / constructor function
8349
9379
  */
8350
9380
  static extend<T extends Record<string, unknown>>(
8351
9381
  /**
@@ -8364,10 +9394,14 @@ declare namespace sap {
8364
9394
  ): Function;
8365
9395
  /**
8366
9396
  * Returns a metadata object for class sap.ui.vtm.Vtm.
9397
+ *
9398
+ * @returns Metadata object describing this class
8367
9399
  */
8368
9400
  static getMetadata(): sap.ui.core.ElementMetadata;
8369
9401
  /**
8370
9402
  * Adds some extension to the aggregation {@link #getExtensions extensions}.
9403
+ *
9404
+ * @returns Reference to `this` in order to allow method chaining
8371
9405
  */
8372
9406
  addExtension(
8373
9407
  /**
@@ -8383,6 +9417,8 @@ declare namespace sap {
8383
9417
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8384
9418
  *
8385
9419
  * Raised when the active panel has changed.
9420
+ *
9421
+ * @returns Reference to `this` in order to allow method chaining
8386
9422
  */
8387
9423
  attachActivePanelChanged(
8388
9424
  /**
@@ -8407,6 +9443,8 @@ declare namespace sap {
8407
9443
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8408
9444
  *
8409
9445
  * Raised when the active panel has changed.
9446
+ *
9447
+ * @returns Reference to `this` in order to allow method chaining
8410
9448
  */
8411
9449
  attachActivePanelChanged(
8412
9450
  /**
@@ -8429,6 +9467,8 @@ declare namespace sap {
8429
9467
  * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that
8430
9468
  * the extensions can attach event handlers before the application attempts to attach event handlers to
8431
9469
  * the same events.
9470
+ *
9471
+ * @returns Reference to `this` in order to allow method chaining
8432
9472
  */
8433
9473
  attachInitialized(
8434
9474
  /**
@@ -8456,6 +9496,8 @@ declare namespace sap {
8456
9496
  * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that
8457
9497
  * the extensions can attach event handlers before the application attempts to attach event handlers to
8458
9498
  * the same events.
9499
+ *
9500
+ * @returns Reference to `this` in order to allow method chaining
8459
9501
  */
8460
9502
  attachInitialized(
8461
9503
  /**
@@ -8474,6 +9516,8 @@ declare namespace sap {
8474
9516
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8475
9517
  *
8476
9518
  * Raised when a panel has been added.
9519
+ *
9520
+ * @returns Reference to `this` in order to allow method chaining
8477
9521
  */
8478
9522
  attachPanelAdded(
8479
9523
  /**
@@ -8497,6 +9541,8 @@ declare namespace sap {
8497
9541
  * otherwise it will be bound to this `sap.ui.vtm.Vtm` itself.
8498
9542
  *
8499
9543
  * Raised when a panel has been added.
9544
+ *
9545
+ * @returns Reference to `this` in order to allow method chaining
8500
9546
  */
8501
9547
  attachPanelAdded(
8502
9548
  /**
@@ -8510,6 +9556,8 @@ declare namespace sap {
8510
9556
  ): this;
8511
9557
  /**
8512
9558
  * Creates a VTM panel associated with this {@link sap.ui.vtm.Vtm} instance.
9559
+ *
9560
+ * @returns The created panel.
8513
9561
  */
8514
9562
  createPanel(
8515
9563
  /**
@@ -8523,6 +9571,8 @@ declare namespace sap {
8523
9571
  ): sap.ui.vtm.Panel;
8524
9572
  /**
8525
9573
  * Destroys all the extensions in the aggregation {@link #getExtensions extensions}.
9574
+ *
9575
+ * @returns Reference to `this` in order to allow method chaining
8526
9576
  */
8527
9577
  destroyExtensions(): this;
8528
9578
  /**
@@ -8530,6 +9580,8 @@ declare namespace sap {
8530
9580
  * of this `sap.ui.vtm.Vtm`.
8531
9581
  *
8532
9582
  * The passed function and listener object must match the ones used for event registration.
9583
+ *
9584
+ * @returns Reference to `this` in order to allow method chaining
8533
9585
  */
8534
9586
  detachActivePanelChanged(
8535
9587
  /**
@@ -8545,6 +9597,8 @@ declare namespace sap {
8545
9597
  * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Vtm`.
8546
9598
  *
8547
9599
  * The passed function and listener object must match the ones used for event registration.
9600
+ *
9601
+ * @returns Reference to `this` in order to allow method chaining
8548
9602
  */
8549
9603
  detachInitialized(
8550
9604
  /**
@@ -8560,6 +9614,8 @@ declare namespace sap {
8560
9614
  * Detaches event handler `fnFunction` from the {@link #event:panelAdded panelAdded} event of this `sap.ui.vtm.Vtm`.
8561
9615
  *
8562
9616
  * The passed function and listener object must match the ones used for event registration.
9617
+ *
9618
+ * @returns Reference to `this` in order to allow method chaining
8563
9619
  */
8564
9620
  detachPanelAdded(
8565
9621
  /**
@@ -8573,6 +9629,8 @@ declare namespace sap {
8573
9629
  ): this;
8574
9630
  /**
8575
9631
  * Fires event {@link #event:activePanelChanged activePanelChanged} to attached listeners.
9632
+ *
9633
+ * @returns Reference to `this` in order to allow method chaining
8576
9634
  */
8577
9635
  fireActivePanelChanged(
8578
9636
  /**
@@ -8582,6 +9640,8 @@ declare namespace sap {
8582
9640
  ): this;
8583
9641
  /**
8584
9642
  * Fires event {@link #event:initialized initialized} to attached listeners.
9643
+ *
9644
+ * @returns Reference to `this` in order to allow method chaining
8585
9645
  */
8586
9646
  fireInitialized(
8587
9647
  /**
@@ -8591,6 +9651,8 @@ declare namespace sap {
8591
9651
  ): this;
8592
9652
  /**
8593
9653
  * Fires event {@link #event:panelAdded panelAdded} to attached listeners.
9654
+ *
9655
+ * @returns Reference to `this` in order to allow method chaining
8594
9656
  */
8595
9657
  firePanelAdded(
8596
9658
  /**
@@ -8602,18 +9664,24 @@ declare namespace sap {
8602
9664
  ): this;
8603
9665
  /**
8604
9666
  * Gets the active panel.
9667
+ *
9668
+ * @returns The active panel, or null if there is no active panel.
8605
9669
  */
8606
9670
  getActivePanel(): sap.ui.vtm.Panel | null;
8607
9671
  /**
8608
9672
  * Gets current value of property {@link #getAddDefaultExtensions addDefaultExtensions}.
8609
9673
  *
8610
9674
  * When true populates the `extensions` aggregation with the default set of extensions in the default configuration.
9675
+ *
9676
+ * @returns Value of property `addDefaultExtensions`
8611
9677
  */
8612
9678
  getAddDefaultExtensions(): boolean;
8613
9679
  /**
8614
9680
  * Gets the extension implementing a specified interface.
8615
9681
  *
8616
9682
  * Returns `undefined` if there is not exactly one matching extension.
9683
+ *
9684
+ * @returns The matching extension or `undefined` if there is not exactly one matching extension.
8617
9685
  */
8618
9686
  getExtensionByInterface(
8619
9687
  /**
@@ -8625,6 +9693,8 @@ declare namespace sap {
8625
9693
  * Gets an extension with a specified class name.
8626
9694
  *
8627
9695
  * Returns `undefined` if there is not exactly one matching extension.
9696
+ *
9697
+ * @returns The matching extension or `undefined` if there is not exactly one matching extension.
8628
9698
  */
8629
9699
  getExtensionByName(
8630
9700
  /**
@@ -8641,6 +9711,8 @@ declare namespace sap {
8641
9711
  getExtensions(): sap.ui.vtm.Extension[];
8642
9712
  /**
8643
9713
  * Gets the extensions implementing a specified interface.
9714
+ *
9715
+ * @returns The matching extensions.
8644
9716
  */
8645
9717
  getExtensionsByInterface(
8646
9718
  /**
@@ -8650,6 +9722,8 @@ declare namespace sap {
8650
9722
  ): sap.ui.vtm.Extension[];
8651
9723
  /**
8652
9724
  * Gets the extensions with a specified class name.
9725
+ *
9726
+ * @returns The matching extensions.
8653
9727
  */
8654
9728
  getExtensionsByName(
8655
9729
  /**
@@ -8659,6 +9733,8 @@ declare namespace sap {
8659
9733
  ): sap.ui.vtm.Extension[];
8660
9734
  /**
8661
9735
  * Gets a panel given its id. Returns undefined if no match is found.
9736
+ *
9737
+ * @returns The matching panel or undefined if no match is found.
8662
9738
  */
8663
9739
  getPanel(
8664
9740
  /**
@@ -8668,15 +9744,21 @@ declare namespace sap {
8668
9744
  ): sap.ui.vtm.Panel | undefined;
8669
9745
  /**
8670
9746
  * Gets the set of created panels. Do not modify the returned array.
9747
+ *
9748
+ * @returns The created panels.
8671
9749
  */
8672
9750
  getPanels(): sap.ui.vtm.Panel[];
8673
9751
  /**
8674
9752
  * Gets the scene.
9753
+ *
9754
+ * @returns The scene.
8675
9755
  */
8676
9756
  getScene(): sap.ui.vtm.Scene;
8677
9757
  /**
8678
9758
  * Checks for the provided `sap.ui.vtm.Extension` in the aggregation {@link #getExtensions extensions}.
8679
9759
  * and returns its index if found or -1 otherwise.
9760
+ *
9761
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
8680
9762
  */
8681
9763
  indexOfExtension(
8682
9764
  /**
@@ -8686,6 +9768,8 @@ declare namespace sap {
8686
9768
  ): int;
8687
9769
  /**
8688
9770
  * Inserts a extension into the aggregation {@link #getExtensions extensions}.
9771
+ *
9772
+ * @returns Reference to `this` in order to allow method chaining
8689
9773
  */
8690
9774
  insertExtension(
8691
9775
  /**
@@ -8703,10 +9787,14 @@ declare namespace sap {
8703
9787
  * Removes all the controls from the aggregation {@link #getExtensions extensions}.
8704
9788
  *
8705
9789
  * Additionally, it unregisters them from the hosting UIArea.
9790
+ *
9791
+ * @returns An array of the removed elements (might be empty)
8706
9792
  */
8707
9793
  removeAllExtensions(): sap.ui.vtm.Extension[];
8708
9794
  /**
8709
9795
  * Removes a extension from the aggregation {@link #getExtensions extensions}.
9796
+ *
9797
+ * @returns The removed extension or `null`
8710
9798
  */
8711
9799
  removeExtension(
8712
9800
  /**
@@ -8716,6 +9804,8 @@ declare namespace sap {
8716
9804
  ): sap.ui.vtm.Extension;
8717
9805
  /**
8718
9806
  * Sets the active panel.
9807
+ *
9808
+ * @returns A reference to `this` for method chaining.
8719
9809
  */
8720
9810
  setActivePanel(
8721
9811
  /**
@@ -8729,6 +9819,8 @@ declare namespace sap {
8729
9819
  * When true populates the `extensions` aggregation with the default set of extensions in the default configuration.
8730
9820
  *
8731
9821
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9822
+ *
9823
+ * @returns Reference to `this` in order to allow method chaining
8732
9824
  */
8733
9825
  setAddDefaultExtensions(
8734
9826
  /**