@itwin/frontend-devtools 4.0.0-dev.52 → 4.0.0-dev.54

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 (344) hide show
  1. package/lib/cjs/ClipboardUtilities.d.ts +8 -8
  2. package/lib/cjs/ClipboardUtilities.js +26 -26
  3. package/lib/cjs/FrontEndDevTools.d.ts +19 -19
  4. package/lib/cjs/FrontEndDevTools.js +221 -221
  5. package/lib/cjs/FrontEndDevTools.js.map +1 -1
  6. package/lib/cjs/effects/Convolution.d.ts +68 -68
  7. package/lib/cjs/effects/Convolution.js +148 -148
  8. package/lib/cjs/effects/Convolution.js.map +1 -1
  9. package/lib/cjs/effects/EffectTools.d.ts +33 -33
  10. package/lib/cjs/effects/EffectTools.js +67 -67
  11. package/lib/cjs/effects/EffectTools.js.map +1 -1
  12. package/lib/cjs/effects/Explosion.d.ts +12 -12
  13. package/lib/cjs/effects/Explosion.js +168 -168
  14. package/lib/cjs/effects/Explosion.js.map +1 -1
  15. package/lib/cjs/effects/FlipImage.d.ts +30 -30
  16. package/lib/cjs/effects/FlipImage.js +79 -79
  17. package/lib/cjs/effects/FlipImage.js.map +1 -1
  18. package/lib/cjs/effects/LensDistortion.d.ts +34 -34
  19. package/lib/cjs/effects/LensDistortion.js +88 -88
  20. package/lib/cjs/effects/LensDistortion.js.map +1 -1
  21. package/lib/cjs/effects/Random.d.ts +24 -24
  22. package/lib/cjs/effects/Random.js +49 -49
  23. package/lib/cjs/effects/Saturation.d.ts +30 -30
  24. package/lib/cjs/effects/Saturation.js +59 -59
  25. package/lib/cjs/effects/Saturation.js.map +1 -1
  26. package/lib/cjs/effects/Snow.d.ts +76 -76
  27. package/lib/cjs/effects/Snow.js +187 -187
  28. package/lib/cjs/effects/Snow.js.map +1 -1
  29. package/lib/cjs/effects/Vignette.d.ts +39 -39
  30. package/lib/cjs/effects/Vignette.js +79 -79
  31. package/lib/cjs/effects/Vignette.js.map +1 -1
  32. package/lib/cjs/frontend-devtools.d.ts +82 -82
  33. package/lib/cjs/frontend-devtools.js +102 -98
  34. package/lib/cjs/frontend-devtools.js.map +1 -1
  35. package/lib/cjs/tools/AnimationIntervalTool.d.ts +15 -15
  36. package/lib/cjs/tools/AnimationIntervalTool.js +30 -30
  37. package/lib/cjs/tools/AnimationIntervalTool.js.map +1 -1
  38. package/lib/cjs/tools/ChangeUnitsTool.d.ts +15 -15
  39. package/lib/cjs/tools/ChangeUnitsTool.js +41 -41
  40. package/lib/cjs/tools/ChangeUnitsTool.js.map +1 -1
  41. package/lib/cjs/tools/ClipTools.d.ts +67 -67
  42. package/lib/cjs/tools/ClipTools.js +161 -161
  43. package/lib/cjs/tools/ClipTools.js.map +1 -1
  44. package/lib/cjs/tools/DisplayStyleTools.d.ts +145 -145
  45. package/lib/cjs/tools/DisplayStyleTools.js +368 -368
  46. package/lib/cjs/tools/DisplayStyleTools.js.map +1 -1
  47. package/lib/cjs/tools/EmphasizeElementsTool.d.ts +60 -60
  48. package/lib/cjs/tools/EmphasizeElementsTool.js +154 -154
  49. package/lib/cjs/tools/EmphasizeElementsTool.js.map +1 -1
  50. package/lib/cjs/tools/FrustumDecoration.d.ts +57 -57
  51. package/lib/cjs/tools/FrustumDecoration.js +374 -374
  52. package/lib/cjs/tools/FrustumDecoration.js.map +1 -1
  53. package/lib/cjs/tools/InspectElementTool.d.ts +42 -42
  54. package/lib/cjs/tools/InspectElementTool.js +198 -198
  55. package/lib/cjs/tools/InspectElementTool.js.map +1 -1
  56. package/lib/cjs/tools/MapLayerTool.d.ts +264 -264
  57. package/lib/cjs/tools/MapLayerTool.js +507 -507
  58. package/lib/cjs/tools/MapLayerTool.js.map +1 -1
  59. package/lib/cjs/tools/MeasureTileLoadTime.d.ts +12 -12
  60. package/lib/cjs/tools/MeasureTileLoadTime.js +63 -63
  61. package/lib/cjs/tools/MeasureTileLoadTime.js.map +1 -1
  62. package/lib/cjs/tools/ModelAppearanceTools.d.ts +86 -86
  63. package/lib/cjs/tools/ModelAppearanceTools.js +183 -183
  64. package/lib/cjs/tools/ModelAppearanceTools.js.map +1 -1
  65. package/lib/cjs/tools/PlanProjectionTools.d.ts +40 -40
  66. package/lib/cjs/tools/PlanProjectionTools.js +149 -149
  67. package/lib/cjs/tools/PlanProjectionTools.js.map +1 -1
  68. package/lib/cjs/tools/PlanarMaskTools.d.ts +182 -182
  69. package/lib/cjs/tools/PlanarMaskTools.js +391 -391
  70. package/lib/cjs/tools/PlanarMaskTools.js.map +1 -1
  71. package/lib/cjs/tools/ProjectExtents.d.ts +41 -41
  72. package/lib/cjs/tools/ProjectExtents.js +110 -110
  73. package/lib/cjs/tools/ProjectExtents.js.map +1 -1
  74. package/lib/cjs/tools/RealityModelTools.d.ts +116 -116
  75. package/lib/cjs/tools/RealityModelTools.js +281 -281
  76. package/lib/cjs/tools/RealityModelTools.js.map +1 -1
  77. package/lib/cjs/tools/RealityTransitionTool.d.ts +25 -25
  78. package/lib/cjs/tools/RealityTransitionTool.js +115 -115
  79. package/lib/cjs/tools/RealityTransitionTool.js.map +1 -1
  80. package/lib/cjs/tools/RenderSystemTools.d.ts +38 -38
  81. package/lib/cjs/tools/RenderSystemTools.js +69 -69
  82. package/lib/cjs/tools/RenderSystemTools.js.map +1 -1
  83. package/lib/cjs/tools/RenderTargetTools.d.ts +107 -107
  84. package/lib/cjs/tools/RenderTargetTools.d.ts.map +1 -1
  85. package/lib/cjs/tools/RenderTargetTools.js +174 -174
  86. package/lib/cjs/tools/RenderTargetTools.js.map +1 -1
  87. package/lib/cjs/tools/ReportWebGLCompatibilityTool.d.ts +11 -11
  88. package/lib/cjs/tools/ReportWebGLCompatibilityTool.js +30 -30
  89. package/lib/cjs/tools/ReportWebGLCompatibilityTool.js.map +1 -1
  90. package/lib/cjs/tools/SavedViews.d.ts +46 -46
  91. package/lib/cjs/tools/SavedViews.js +136 -136
  92. package/lib/cjs/tools/SavedViews.js.map +1 -1
  93. package/lib/cjs/tools/ScheduleScriptTools.d.ts +37 -37
  94. package/lib/cjs/tools/ScheduleScriptTools.js +157 -157
  95. package/lib/cjs/tools/ScheduleScriptTools.js.map +1 -1
  96. package/lib/cjs/tools/SelectionTools.d.ts +28 -28
  97. package/lib/cjs/tools/SelectionTools.js +87 -87
  98. package/lib/cjs/tools/SelectionTools.js.map +1 -1
  99. package/lib/cjs/tools/SetGpuMemoryLimitTool.d.ts +15 -15
  100. package/lib/cjs/tools/SetGpuMemoryLimitTool.js +33 -33
  101. package/lib/cjs/tools/SetGpuMemoryLimitTool.js.map +1 -1
  102. package/lib/cjs/tools/SourceAspectIdTools.d.ts +40 -40
  103. package/lib/cjs/tools/SourceAspectIdTools.js +86 -86
  104. package/lib/cjs/tools/SourceAspectIdTools.js.map +1 -1
  105. package/lib/cjs/tools/TileRequestDecoration.d.ts +12 -12
  106. package/lib/cjs/tools/TileRequestDecoration.js +83 -83
  107. package/lib/cjs/tools/TileRequestDecoration.js.map +1 -1
  108. package/lib/cjs/tools/TileTreeBoundsDecoration.d.ts +11 -11
  109. package/lib/cjs/tools/TileTreeBoundsDecoration.js +74 -74
  110. package/lib/cjs/tools/TileTreeBoundsDecoration.js.map +1 -1
  111. package/lib/cjs/tools/ToolTipProvider.d.ts +15 -15
  112. package/lib/cjs/tools/ToolTipProvider.js +66 -66
  113. package/lib/cjs/tools/ToolTipProvider.js.map +1 -1
  114. package/lib/cjs/tools/ViewportTools.d.ts +218 -218
  115. package/lib/cjs/tools/ViewportTools.js +516 -516
  116. package/lib/cjs/tools/ViewportTools.js.map +1 -1
  117. package/lib/cjs/tools/parseArgs.d.ts +23 -23
  118. package/lib/cjs/tools/parseArgs.js +51 -51
  119. package/lib/cjs/tools/parseBoolean.d.ts +8 -8
  120. package/lib/cjs/tools/parseBoolean.js +26 -26
  121. package/lib/cjs/tools/parseToggle.d.ts +8 -8
  122. package/lib/cjs/tools/parseToggle.js +25 -25
  123. package/lib/cjs/ui/Button.d.ts +29 -29
  124. package/lib/cjs/ui/Button.d.ts.map +1 -1
  125. package/lib/cjs/ui/Button.js +26 -26
  126. package/lib/cjs/ui/CheckBox.d.ts +23 -23
  127. package/lib/cjs/ui/CheckBox.d.ts.map +1 -1
  128. package/lib/cjs/ui/CheckBox.js +27 -27
  129. package/lib/cjs/ui/ColorInput.d.ts +27 -27
  130. package/lib/cjs/ui/ColorInput.d.ts.map +1 -1
  131. package/lib/cjs/ui/ColorInput.js +53 -53
  132. package/lib/cjs/ui/ComboBox.d.ts +28 -28
  133. package/lib/cjs/ui/ComboBox.d.ts.map +1 -1
  134. package/lib/cjs/ui/ComboBox.js +42 -42
  135. package/lib/cjs/ui/DataList.d.ts +27 -27
  136. package/lib/cjs/ui/DataList.d.ts.map +1 -1
  137. package/lib/cjs/ui/DataList.js +39 -39
  138. package/lib/cjs/ui/NestedMenu.d.ts +19 -19
  139. package/lib/cjs/ui/NestedMenu.d.ts.map +1 -1
  140. package/lib/cjs/ui/NestedMenu.js +46 -46
  141. package/lib/cjs/ui/NumericInput.d.ts +35 -35
  142. package/lib/cjs/ui/NumericInput.d.ts.map +1 -1
  143. package/lib/cjs/ui/NumericInput.js +61 -61
  144. package/lib/cjs/ui/RadioBox.d.ts +29 -29
  145. package/lib/cjs/ui/RadioBox.d.ts.map +1 -1
  146. package/lib/cjs/ui/RadioBox.js +76 -76
  147. package/lib/cjs/ui/Slider.d.ts +28 -28
  148. package/lib/cjs/ui/Slider.d.ts.map +1 -1
  149. package/lib/cjs/ui/Slider.js +42 -42
  150. package/lib/cjs/ui/TextBox.d.ts +32 -32
  151. package/lib/cjs/ui/TextBox.d.ts.map +1 -1
  152. package/lib/cjs/ui/TextBox.js +56 -56
  153. package/lib/cjs/widgets/DiagnosticsPanel.d.ts +37 -37
  154. package/lib/cjs/widgets/DiagnosticsPanel.js +81 -81
  155. package/lib/cjs/widgets/FpsTracker.d.ts +19 -19
  156. package/lib/cjs/widgets/FpsTracker.js +56 -56
  157. package/lib/cjs/widgets/GpuProfiler.d.ts +16 -16
  158. package/lib/cjs/widgets/GpuProfiler.js +192 -192
  159. package/lib/cjs/widgets/KeyinField.d.ts +61 -61
  160. package/lib/cjs/widgets/KeyinField.js +186 -186
  161. package/lib/cjs/widgets/MemoryTracker.d.ts +27 -27
  162. package/lib/cjs/widgets/MemoryTracker.js +242 -242
  163. package/lib/cjs/widgets/MemoryTracker.js.map +1 -1
  164. package/lib/cjs/widgets/RenderCommandBreakdown.d.ts +15 -15
  165. package/lib/cjs/widgets/RenderCommandBreakdown.js +67 -67
  166. package/lib/cjs/widgets/TileMemoryBreakdown.d.ts +30 -30
  167. package/lib/cjs/widgets/TileMemoryBreakdown.js +203 -203
  168. package/lib/cjs/widgets/TileStatisticsTracker.d.ts +21 -21
  169. package/lib/cjs/widgets/TileStatisticsTracker.js +144 -144
  170. package/lib/cjs/widgets/ToolSettingsTracker.d.ts +9 -9
  171. package/lib/cjs/widgets/ToolSettingsTracker.js +211 -211
  172. package/lib/cjs/widgets/ToolSettingsTracker.js.map +1 -1
  173. package/lib/esm/ClipboardUtilities.d.ts +8 -8
  174. package/lib/esm/ClipboardUtilities.js +22 -22
  175. package/lib/esm/FrontEndDevTools.d.ts +19 -19
  176. package/lib/esm/FrontEndDevTools.js +218 -217
  177. package/lib/esm/FrontEndDevTools.js.map +1 -1
  178. package/lib/esm/effects/Convolution.d.ts +68 -68
  179. package/lib/esm/effects/Convolution.js +144 -138
  180. package/lib/esm/effects/Convolution.js.map +1 -1
  181. package/lib/esm/effects/EffectTools.d.ts +33 -33
  182. package/lib/esm/effects/EffectTools.js +63 -61
  183. package/lib/esm/effects/EffectTools.js.map +1 -1
  184. package/lib/esm/effects/Explosion.d.ts +12 -12
  185. package/lib/esm/effects/Explosion.js +165 -164
  186. package/lib/esm/effects/Explosion.js.map +1 -1
  187. package/lib/esm/effects/FlipImage.d.ts +30 -30
  188. package/lib/esm/effects/FlipImage.js +76 -74
  189. package/lib/esm/effects/FlipImage.js.map +1 -1
  190. package/lib/esm/effects/LensDistortion.d.ts +34 -34
  191. package/lib/esm/effects/LensDistortion.js +85 -83
  192. package/lib/esm/effects/LensDistortion.js.map +1 -1
  193. package/lib/esm/effects/Random.d.ts +24 -24
  194. package/lib/esm/effects/Random.js +41 -41
  195. package/lib/esm/effects/Saturation.d.ts +30 -30
  196. package/lib/esm/effects/Saturation.js +56 -54
  197. package/lib/esm/effects/Saturation.js.map +1 -1
  198. package/lib/esm/effects/Snow.d.ts +76 -76
  199. package/lib/esm/effects/Snow.js +184 -182
  200. package/lib/esm/effects/Snow.js.map +1 -1
  201. package/lib/esm/effects/Vignette.d.ts +39 -39
  202. package/lib/esm/effects/Vignette.js +76 -74
  203. package/lib/esm/effects/Vignette.js.map +1 -1
  204. package/lib/esm/frontend-devtools.d.ts +82 -82
  205. package/lib/esm/frontend-devtools.js +86 -86
  206. package/lib/esm/tools/AnimationIntervalTool.d.ts +15 -15
  207. package/lib/esm/tools/AnimationIntervalTool.js +27 -26
  208. package/lib/esm/tools/AnimationIntervalTool.js.map +1 -1
  209. package/lib/esm/tools/ChangeUnitsTool.d.ts +15 -15
  210. package/lib/esm/tools/ChangeUnitsTool.js +38 -37
  211. package/lib/esm/tools/ChangeUnitsTool.js.map +1 -1
  212. package/lib/esm/tools/ClipTools.d.ts +67 -67
  213. package/lib/esm/tools/ClipTools.js +158 -155
  214. package/lib/esm/tools/ClipTools.js.map +1 -1
  215. package/lib/esm/tools/DisplayStyleTools.d.ts +145 -145
  216. package/lib/esm/tools/DisplayStyleTools.js +364 -354
  217. package/lib/esm/tools/DisplayStyleTools.js.map +1 -1
  218. package/lib/esm/tools/EmphasizeElementsTool.d.ts +60 -60
  219. package/lib/esm/tools/EmphasizeElementsTool.js +150 -145
  220. package/lib/esm/tools/EmphasizeElementsTool.js.map +1 -1
  221. package/lib/esm/tools/FrustumDecoration.d.ts +57 -57
  222. package/lib/esm/tools/FrustumDecoration.js +370 -367
  223. package/lib/esm/tools/FrustumDecoration.js.map +1 -1
  224. package/lib/esm/tools/InspectElementTool.d.ts +42 -42
  225. package/lib/esm/tools/InspectElementTool.js +195 -194
  226. package/lib/esm/tools/InspectElementTool.js.map +1 -1
  227. package/lib/esm/tools/MapLayerTool.d.ts +264 -264
  228. package/lib/esm/tools/MapLayerTool.js +504 -485
  229. package/lib/esm/tools/MapLayerTool.js.map +1 -1
  230. package/lib/esm/tools/MeasureTileLoadTime.d.ts +12 -12
  231. package/lib/esm/tools/MeasureTileLoadTime.js +60 -59
  232. package/lib/esm/tools/MeasureTileLoadTime.js.map +1 -1
  233. package/lib/esm/tools/ModelAppearanceTools.d.ts +86 -86
  234. package/lib/esm/tools/ModelAppearanceTools.js +180 -172
  235. package/lib/esm/tools/ModelAppearanceTools.js.map +1 -1
  236. package/lib/esm/tools/PlanProjectionTools.d.ts +40 -40
  237. package/lib/esm/tools/PlanProjectionTools.js +146 -143
  238. package/lib/esm/tools/PlanProjectionTools.js.map +1 -1
  239. package/lib/esm/tools/PlanarMaskTools.d.ts +182 -182
  240. package/lib/esm/tools/PlanarMaskTools.js +387 -375
  241. package/lib/esm/tools/PlanarMaskTools.js.map +1 -1
  242. package/lib/esm/tools/ProjectExtents.d.ts +41 -41
  243. package/lib/esm/tools/ProjectExtents.js +105 -104
  244. package/lib/esm/tools/ProjectExtents.js.map +1 -1
  245. package/lib/esm/tools/RealityModelTools.d.ts +116 -116
  246. package/lib/esm/tools/RealityModelTools.js +278 -268
  247. package/lib/esm/tools/RealityModelTools.js.map +1 -1
  248. package/lib/esm/tools/RealityTransitionTool.d.ts +25 -25
  249. package/lib/esm/tools/RealityTransitionTool.js +112 -111
  250. package/lib/esm/tools/RealityTransitionTool.js.map +1 -1
  251. package/lib/esm/tools/RenderSystemTools.d.ts +38 -38
  252. package/lib/esm/tools/RenderSystemTools.js +65 -62
  253. package/lib/esm/tools/RenderSystemTools.js.map +1 -1
  254. package/lib/esm/tools/RenderTargetTools.d.ts +107 -107
  255. package/lib/esm/tools/RenderTargetTools.d.ts.map +1 -1
  256. package/lib/esm/tools/RenderTargetTools.js +169 -159
  257. package/lib/esm/tools/RenderTargetTools.js.map +1 -1
  258. package/lib/esm/tools/ReportWebGLCompatibilityTool.d.ts +11 -11
  259. package/lib/esm/tools/ReportWebGLCompatibilityTool.js +27 -26
  260. package/lib/esm/tools/ReportWebGLCompatibilityTool.js.map +1 -1
  261. package/lib/esm/tools/SavedViews.d.ts +46 -46
  262. package/lib/esm/tools/SavedViews.js +131 -128
  263. package/lib/esm/tools/SavedViews.js.map +1 -1
  264. package/lib/esm/tools/ScheduleScriptTools.d.ts +37 -37
  265. package/lib/esm/tools/ScheduleScriptTools.js +154 -151
  266. package/lib/esm/tools/ScheduleScriptTools.js.map +1 -1
  267. package/lib/esm/tools/SelectionTools.d.ts +28 -28
  268. package/lib/esm/tools/SelectionTools.js +84 -82
  269. package/lib/esm/tools/SelectionTools.js.map +1 -1
  270. package/lib/esm/tools/SetGpuMemoryLimitTool.d.ts +15 -15
  271. package/lib/esm/tools/SetGpuMemoryLimitTool.js +30 -29
  272. package/lib/esm/tools/SetGpuMemoryLimitTool.js.map +1 -1
  273. package/lib/esm/tools/SourceAspectIdTools.d.ts +40 -40
  274. package/lib/esm/tools/SourceAspectIdTools.js +82 -80
  275. package/lib/esm/tools/SourceAspectIdTools.js.map +1 -1
  276. package/lib/esm/tools/TileRequestDecoration.d.ts +12 -12
  277. package/lib/esm/tools/TileRequestDecoration.js +80 -79
  278. package/lib/esm/tools/TileRequestDecoration.js.map +1 -1
  279. package/lib/esm/tools/TileTreeBoundsDecoration.d.ts +11 -11
  280. package/lib/esm/tools/TileTreeBoundsDecoration.js +71 -70
  281. package/lib/esm/tools/TileTreeBoundsDecoration.js.map +1 -1
  282. package/lib/esm/tools/ToolTipProvider.d.ts +15 -15
  283. package/lib/esm/tools/ToolTipProvider.js +63 -62
  284. package/lib/esm/tools/ToolTipProvider.js.map +1 -1
  285. package/lib/esm/tools/ViewportTools.d.ts +218 -218
  286. package/lib/esm/tools/ViewportTools.js +511 -492
  287. package/lib/esm/tools/ViewportTools.js.map +1 -1
  288. package/lib/esm/tools/parseArgs.d.ts +23 -23
  289. package/lib/esm/tools/parseArgs.js +47 -47
  290. package/lib/esm/tools/parseBoolean.d.ts +8 -8
  291. package/lib/esm/tools/parseBoolean.js +22 -22
  292. package/lib/esm/tools/parseToggle.d.ts +8 -8
  293. package/lib/esm/tools/parseToggle.js +21 -21
  294. package/lib/esm/ui/Button.d.ts +29 -29
  295. package/lib/esm/ui/Button.d.ts.map +1 -1
  296. package/lib/esm/ui/Button.js +22 -22
  297. package/lib/esm/ui/CheckBox.d.ts +23 -23
  298. package/lib/esm/ui/CheckBox.d.ts.map +1 -1
  299. package/lib/esm/ui/CheckBox.js +23 -23
  300. package/lib/esm/ui/ColorInput.d.ts +27 -27
  301. package/lib/esm/ui/ColorInput.d.ts.map +1 -1
  302. package/lib/esm/ui/ColorInput.js +48 -48
  303. package/lib/esm/ui/ComboBox.d.ts +28 -28
  304. package/lib/esm/ui/ComboBox.d.ts.map +1 -1
  305. package/lib/esm/ui/ComboBox.js +38 -38
  306. package/lib/esm/ui/DataList.d.ts +27 -27
  307. package/lib/esm/ui/DataList.d.ts.map +1 -1
  308. package/lib/esm/ui/DataList.js +34 -34
  309. package/lib/esm/ui/NestedMenu.d.ts +19 -19
  310. package/lib/esm/ui/NestedMenu.d.ts.map +1 -1
  311. package/lib/esm/ui/NestedMenu.js +42 -42
  312. package/lib/esm/ui/NumericInput.d.ts +35 -35
  313. package/lib/esm/ui/NumericInput.d.ts.map +1 -1
  314. package/lib/esm/ui/NumericInput.js +56 -56
  315. package/lib/esm/ui/RadioBox.d.ts +29 -29
  316. package/lib/esm/ui/RadioBox.d.ts.map +1 -1
  317. package/lib/esm/ui/RadioBox.js +72 -72
  318. package/lib/esm/ui/Slider.d.ts +28 -28
  319. package/lib/esm/ui/Slider.d.ts.map +1 -1
  320. package/lib/esm/ui/Slider.js +38 -38
  321. package/lib/esm/ui/TextBox.d.ts +32 -32
  322. package/lib/esm/ui/TextBox.d.ts.map +1 -1
  323. package/lib/esm/ui/TextBox.js +52 -52
  324. package/lib/esm/widgets/DiagnosticsPanel.d.ts +37 -37
  325. package/lib/esm/widgets/DiagnosticsPanel.js +77 -77
  326. package/lib/esm/widgets/FpsTracker.d.ts +19 -19
  327. package/lib/esm/widgets/FpsTracker.js +52 -52
  328. package/lib/esm/widgets/GpuProfiler.d.ts +16 -16
  329. package/lib/esm/widgets/GpuProfiler.js +188 -188
  330. package/lib/esm/widgets/KeyinField.d.ts +61 -61
  331. package/lib/esm/widgets/KeyinField.js +182 -182
  332. package/lib/esm/widgets/MemoryTracker.d.ts +27 -27
  333. package/lib/esm/widgets/MemoryTracker.js +237 -237
  334. package/lib/esm/widgets/MemoryTracker.js.map +1 -1
  335. package/lib/esm/widgets/RenderCommandBreakdown.d.ts +15 -15
  336. package/lib/esm/widgets/RenderCommandBreakdown.js +63 -63
  337. package/lib/esm/widgets/TileMemoryBreakdown.d.ts +30 -30
  338. package/lib/esm/widgets/TileMemoryBreakdown.js +199 -199
  339. package/lib/esm/widgets/TileStatisticsTracker.d.ts +21 -21
  340. package/lib/esm/widgets/TileStatisticsTracker.js +140 -140
  341. package/lib/esm/widgets/ToolSettingsTracker.d.ts +9 -9
  342. package/lib/esm/widgets/ToolSettingsTracker.js +208 -207
  343. package/lib/esm/widgets/ToolSettingsTracker.js.map +1 -1
  344. package/package.json +8 -8
@@ -1,57 +1,57 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.FpsTracker = void 0;
8
- /** @packageDocumentation
9
- * @module Widgets
10
- */
11
- const core_frontend_1 = require("@itwin/core-frontend");
12
- const CheckBox_1 = require("../ui/CheckBox");
13
- /** Displays average frames-per-second.
14
- * NOTE: Enabling fps tracking causes a new frame to render on every tick of the render loop, which may negatively impact battery life.
15
- * @beta
16
- */
17
- class FpsTracker {
18
- constructor(parent, viewport) {
19
- this._vp = viewport;
20
- this._label = (0, CheckBox_1.createCheckBox)({
21
- parent,
22
- name: "Track FPS",
23
- id: "fpsTracker_toggle",
24
- handler: (cb) => this.toggle(cb.checked),
25
- }).label;
26
- }
27
- dispose() {
28
- this.toggle(false);
29
- }
30
- clearInterval() {
31
- if (undefined !== this._curIntervalId) {
32
- clearInterval(this._curIntervalId);
33
- this._curIntervalId = undefined;
34
- }
35
- }
36
- toggle(enabled) {
37
- this._vp.continuousRendering = enabled;
38
- if (enabled) {
39
- this._metrics = new core_frontend_1.PerformanceMetrics(false, true);
40
- this._curIntervalId = setInterval(() => this.updateFPS(), 500);
41
- this._label.innerText = "Tracking FPS...";
42
- }
43
- else {
44
- this._metrics = undefined;
45
- this.clearInterval();
46
- this._label.innerText = "Track FPS";
47
- }
48
- this._vp.target.performanceMetrics = this._metrics;
49
- }
50
- updateFPS() {
51
- const metrics = this._metrics;
52
- const fps = (metrics.spfTimes.length / metrics.spfSum).toFixed(2);
53
- this._label.innerText = `FPS: ${fps}`;
54
- }
55
- }
56
- exports.FpsTracker = FpsTracker;
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.FpsTracker = void 0;
8
+ /** @packageDocumentation
9
+ * @module Widgets
10
+ */
11
+ const core_frontend_1 = require("@itwin/core-frontend");
12
+ const CheckBox_1 = require("../ui/CheckBox");
13
+ /** Displays average frames-per-second.
14
+ * NOTE: Enabling fps tracking causes a new frame to render on every tick of the render loop, which may negatively impact battery life.
15
+ * @beta
16
+ */
17
+ class FpsTracker {
18
+ constructor(parent, viewport) {
19
+ this._vp = viewport;
20
+ this._label = (0, CheckBox_1.createCheckBox)({
21
+ parent,
22
+ name: "Track FPS",
23
+ id: "fpsTracker_toggle",
24
+ handler: (cb) => this.toggle(cb.checked),
25
+ }).label;
26
+ }
27
+ dispose() {
28
+ this.toggle(false);
29
+ }
30
+ clearInterval() {
31
+ if (undefined !== this._curIntervalId) {
32
+ clearInterval(this._curIntervalId);
33
+ this._curIntervalId = undefined;
34
+ }
35
+ }
36
+ toggle(enabled) {
37
+ this._vp.continuousRendering = enabled;
38
+ if (enabled) {
39
+ this._metrics = new core_frontend_1.PerformanceMetrics(false, true);
40
+ this._curIntervalId = setInterval(() => this.updateFPS(), 500);
41
+ this._label.innerText = "Tracking FPS...";
42
+ }
43
+ else {
44
+ this._metrics = undefined;
45
+ this.clearInterval();
46
+ this._label.innerText = "Track FPS";
47
+ }
48
+ this._vp.target.performanceMetrics = this._metrics;
49
+ }
50
+ updateFPS() {
51
+ const metrics = this._metrics;
52
+ const fps = (metrics.spfTimes.length / metrics.spfSum).toFixed(2);
53
+ this._label.innerText = `FPS: ${fps}`;
54
+ }
55
+ }
56
+ exports.FpsTracker = FpsTracker;
57
57
  //# sourceMappingURL=FpsTracker.js.map
@@ -1,17 +1,17 @@
1
- /** @alpha */
2
- export declare class GpuProfiler {
3
- private readonly _div;
4
- private readonly _resultsDiv;
5
- private readonly _results;
6
- private readonly _debugControl;
7
- private readonly _recordButton;
8
- private _recordedResults;
9
- private _isRecording;
10
- constructor(parent: HTMLElement);
11
- dispose(): void;
12
- private toggleProfileCheckBox;
13
- private _clickRecord;
14
- private stopRecording;
15
- private _resultsCallback;
16
- }
1
+ /** @alpha */
2
+ export declare class GpuProfiler {
3
+ private readonly _div;
4
+ private readonly _resultsDiv;
5
+ private readonly _results;
6
+ private readonly _debugControl;
7
+ private readonly _recordButton;
8
+ private _recordedResults;
9
+ private _isRecording;
10
+ constructor(parent: HTMLElement);
11
+ dispose(): void;
12
+ private toggleProfileCheckBox;
13
+ private _clickRecord;
14
+ private stopRecording;
15
+ private _resultsCallback;
16
+ }
17
17
  //# sourceMappingURL=GpuProfiler.d.ts.map
@@ -1,193 +1,193 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.GpuProfiler = void 0;
8
- /** @packageDocumentation
9
- * @module Widgets
10
- */
11
- const file_saver_1 = require("file-saver");
12
- const core_frontend_1 = require("@itwin/core-frontend");
13
- const CheckBox_1 = require("../ui/CheckBox");
14
- const dummyArgs = { 0: 0 }; // Reuse instead of allocating for each entry
15
- /**
16
- * @param name Label for the trace event
17
- * @param start Timestamp in microseconds of when trace event started
18
- * @param duration Duration in microseconds of trace event
19
- */
20
- function createTraceEvent(name, start, duration) {
21
- return {
22
- pid: 1,
23
- ts: start,
24
- dur: duration,
25
- ph: "X",
26
- name,
27
- args: dummyArgs,
28
- };
29
- }
30
- function createTraceFromTimerResults(timerResults) {
31
- const traceEvents = [];
32
- const addChildren = (startTime, children) => {
33
- for (const child of children) {
34
- if (child.nanoseconds < 100)
35
- continue;
36
- const microseconds = child.nanoseconds / 1E3;
37
- traceEvents.push(createTraceEvent(child.label, startTime, microseconds));
38
- if (child.children)
39
- addChildren(startTime, child.children);
40
- startTime += microseconds;
41
- }
42
- };
43
- let frameStartTime = 0;
44
- let frameNumber = 0;
45
- for (const tr of timerResults) {
46
- const microseconds = tr.nanoseconds / 1E3;
47
- traceEvents.push(createTraceEvent(`Frame ${frameNumber}`, frameStartTime, microseconds));
48
- if (tr.children)
49
- addChildren(frameStartTime, tr.children);
50
- frameStartTime += microseconds;
51
- ++frameNumber;
52
- }
53
- return { traceEvents };
54
- }
55
- /** @alpha */
56
- class GpuProfiler {
57
- constructor(parent) {
58
- this._clickRecord = () => {
59
- if (!this._isRecording) {
60
- this._isRecording = true;
61
- this._recordButton.innerText = "Stop Recording";
62
- return;
63
- }
64
- this.stopRecording();
65
- };
66
- this._resultsCallback = (result) => {
67
- if (this._isRecording)
68
- this._recordedResults.push(result);
69
- const fragment = document.createDocumentFragment();
70
- const numSavedFrames = 120;
71
- let lastValue;
72
- const changedResults = new Array(this._results.length); // default values false
73
- const printDepth = (depth, currentRes) => {
74
- const index = this._results.findIndex((res) => res.label === currentRes.label);
75
- if (index < 0) { // Add brand new entry
76
- const data = {
77
- label: currentRes.label,
78
- paddingLeft: `${depth}em`,
79
- sum: currentRes.nanoseconds,
80
- values: [currentRes.nanoseconds],
81
- };
82
- if (lastValue === undefined) {
83
- this._results.unshift(data);
84
- changedResults.unshift(true);
85
- }
86
- else if (currentRes.label === "Read Pixels") {
87
- this._results.push(data); // Read Pixels should go at the end of the list
88
- changedResults.push(true);
89
- }
90
- else {
91
- const prevIndex = this._results.findIndex((res) => res.label === lastValue);
92
- this._results.splice(prevIndex + 1, 0, data);
93
- changedResults.splice(prevIndex + 1, 0, true);
94
- }
95
- }
96
- else { // Edit old entry
97
- let oldVal = 0.0;
98
- const savedResults = this._results[index];
99
- if (savedResults.values.length >= numSavedFrames) { // keep up to numSavedFrames values to average between
100
- oldVal = savedResults.values.shift();
101
- }
102
- const newVal = currentRes.nanoseconds < 100 ? 0.0 : currentRes.nanoseconds; // high-pass filter, empty queries have some noise
103
- savedResults.sum += newVal - oldVal;
104
- savedResults.values.push(newVal);
105
- changedResults[index] = true;
106
- }
107
- lastValue = currentRes.label;
108
- if (!currentRes.children)
109
- return;
110
- for (const childRes of currentRes.children)
111
- printDepth(depth + 1, childRes);
112
- };
113
- printDepth(0, result);
114
- this._results.forEach((value, index) => {
115
- if (!changedResults[index]) { // if no data received on this item, add a value of 0.0 to the avg.
116
- const oldVal = value.values.length >= numSavedFrames ? value.values.shift() : 0.0;
117
- value.sum -= oldVal;
118
- value.values.push(0.0);
119
- }
120
- const div = document.createElement("div");
121
- div.style.display = "flex";
122
- div.style.width = "75%";
123
- const textLabel = document.createElement("text");
124
- textLabel.innerText = `${value.label}`;
125
- textLabel.style.paddingLeft = value.paddingLeft;
126
- div.appendChild(textLabel);
127
- const divLine = document.createElement("div");
128
- divLine.style.flexGrow = "1";
129
- divLine.style.borderBottom = "dotted 1px";
130
- div.appendChild(divLine);
131
- const textValue = document.createElement("text");
132
- textValue.innerText = `${(value.sum / value.values.length / 1.E6).toFixed(3)} ms\n`;
133
- div.appendChild(textValue);
134
- fragment.appendChild(div);
135
- });
136
- this._resultsDiv.innerHTML = "";
137
- this._resultsDiv.appendChild(fragment);
138
- };
139
- this._debugControl = core_frontend_1.IModelApp.renderSystem.debugControl;
140
- const checkBox = (0, CheckBox_1.createCheckBox)({
141
- parent,
142
- name: "Profile GPU",
143
- id: "gpu-profiler-toggle",
144
- handler: (cb) => this.toggleProfileCheckBox(cb.checked),
145
- });
146
- if (!this._debugControl.isGLTimerSupported) {
147
- checkBox.checkbox.disabled = true;
148
- checkBox.div.title = "EXT_disjoint_timer_query is not available in this browser";
149
- }
150
- this._div = document.createElement("div");
151
- this._div.style.display = "none";
152
- this._recordButton = document.createElement("button");
153
- this._recordButton.style.textAlign = "center";
154
- this._isRecording = false;
155
- this._recordButton.innerText = "Record Profile";
156
- this._recordButton.title = "Record a profile to open with chrome://tracing";
157
- this._recordedResults = [];
158
- this._recordButton.addEventListener("click", this._clickRecord);
159
- this._div.appendChild(this._recordButton);
160
- this._results = [];
161
- this._resultsDiv = document.createElement("div");
162
- this._resultsDiv.style.textAlign = "left";
163
- this._div.appendChild(this._resultsDiv);
164
- parent.appendChild(this._div);
165
- }
166
- dispose() {
167
- this._debugControl.resultsCallback = undefined;
168
- }
169
- toggleProfileCheckBox(isEnabled) {
170
- if (isEnabled) {
171
- this._debugControl.resultsCallback = this._resultsCallback;
172
- this._resultsDiv.innerHTML = "";
173
- this._div.style.display = "block";
174
- }
175
- else {
176
- this._debugControl.resultsCallback = undefined;
177
- this._div.style.display = "none";
178
- this.stopRecording();
179
- }
180
- }
181
- stopRecording() {
182
- this._isRecording = false;
183
- this._recordButton.innerText = "Record Profile";
184
- if (this._recordedResults.length !== 0) {
185
- const chromeTrace = createTraceFromTimerResults(this._recordedResults);
186
- const blob = new Blob([JSON.stringify(chromeTrace)], { type: "application/json;charset=utf-8" });
187
- (0, file_saver_1.saveAs)(blob, "gpu-profile.json");
188
- this._recordedResults = [];
189
- }
190
- }
191
- }
192
- exports.GpuProfiler = GpuProfiler;
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.GpuProfiler = void 0;
8
+ /** @packageDocumentation
9
+ * @module Widgets
10
+ */
11
+ const file_saver_1 = require("file-saver");
12
+ const core_frontend_1 = require("@itwin/core-frontend");
13
+ const CheckBox_1 = require("../ui/CheckBox");
14
+ const dummyArgs = { 0: 0 }; // Reuse instead of allocating for each entry
15
+ /**
16
+ * @param name Label for the trace event
17
+ * @param start Timestamp in microseconds of when trace event started
18
+ * @param duration Duration in microseconds of trace event
19
+ */
20
+ function createTraceEvent(name, start, duration) {
21
+ return {
22
+ pid: 1,
23
+ ts: start,
24
+ dur: duration,
25
+ ph: "X",
26
+ name,
27
+ args: dummyArgs,
28
+ };
29
+ }
30
+ function createTraceFromTimerResults(timerResults) {
31
+ const traceEvents = [];
32
+ const addChildren = (startTime, children) => {
33
+ for (const child of children) {
34
+ if (child.nanoseconds < 100)
35
+ continue;
36
+ const microseconds = child.nanoseconds / 1E3;
37
+ traceEvents.push(createTraceEvent(child.label, startTime, microseconds));
38
+ if (child.children)
39
+ addChildren(startTime, child.children);
40
+ startTime += microseconds;
41
+ }
42
+ };
43
+ let frameStartTime = 0;
44
+ let frameNumber = 0;
45
+ for (const tr of timerResults) {
46
+ const microseconds = tr.nanoseconds / 1E3;
47
+ traceEvents.push(createTraceEvent(`Frame ${frameNumber}`, frameStartTime, microseconds));
48
+ if (tr.children)
49
+ addChildren(frameStartTime, tr.children);
50
+ frameStartTime += microseconds;
51
+ ++frameNumber;
52
+ }
53
+ return { traceEvents };
54
+ }
55
+ /** @alpha */
56
+ class GpuProfiler {
57
+ constructor(parent) {
58
+ this._clickRecord = () => {
59
+ if (!this._isRecording) {
60
+ this._isRecording = true;
61
+ this._recordButton.innerText = "Stop Recording";
62
+ return;
63
+ }
64
+ this.stopRecording();
65
+ };
66
+ this._resultsCallback = (result) => {
67
+ if (this._isRecording)
68
+ this._recordedResults.push(result);
69
+ const fragment = document.createDocumentFragment();
70
+ const numSavedFrames = 120;
71
+ let lastValue;
72
+ const changedResults = new Array(this._results.length); // default values false
73
+ const printDepth = (depth, currentRes) => {
74
+ const index = this._results.findIndex((res) => res.label === currentRes.label);
75
+ if (index < 0) { // Add brand new entry
76
+ const data = {
77
+ label: currentRes.label,
78
+ paddingLeft: `${depth}em`,
79
+ sum: currentRes.nanoseconds,
80
+ values: [currentRes.nanoseconds],
81
+ };
82
+ if (lastValue === undefined) {
83
+ this._results.unshift(data);
84
+ changedResults.unshift(true);
85
+ }
86
+ else if (currentRes.label === "Read Pixels") {
87
+ this._results.push(data); // Read Pixels should go at the end of the list
88
+ changedResults.push(true);
89
+ }
90
+ else {
91
+ const prevIndex = this._results.findIndex((res) => res.label === lastValue);
92
+ this._results.splice(prevIndex + 1, 0, data);
93
+ changedResults.splice(prevIndex + 1, 0, true);
94
+ }
95
+ }
96
+ else { // Edit old entry
97
+ let oldVal = 0.0;
98
+ const savedResults = this._results[index];
99
+ if (savedResults.values.length >= numSavedFrames) { // keep up to numSavedFrames values to average between
100
+ oldVal = savedResults.values.shift();
101
+ }
102
+ const newVal = currentRes.nanoseconds < 100 ? 0.0 : currentRes.nanoseconds; // high-pass filter, empty queries have some noise
103
+ savedResults.sum += newVal - oldVal;
104
+ savedResults.values.push(newVal);
105
+ changedResults[index] = true;
106
+ }
107
+ lastValue = currentRes.label;
108
+ if (!currentRes.children)
109
+ return;
110
+ for (const childRes of currentRes.children)
111
+ printDepth(depth + 1, childRes);
112
+ };
113
+ printDepth(0, result);
114
+ this._results.forEach((value, index) => {
115
+ if (!changedResults[index]) { // if no data received on this item, add a value of 0.0 to the avg.
116
+ const oldVal = value.values.length >= numSavedFrames ? value.values.shift() : 0.0;
117
+ value.sum -= oldVal;
118
+ value.values.push(0.0);
119
+ }
120
+ const div = document.createElement("div");
121
+ div.style.display = "flex";
122
+ div.style.width = "75%";
123
+ const textLabel = document.createElement("text");
124
+ textLabel.innerText = `${value.label}`;
125
+ textLabel.style.paddingLeft = value.paddingLeft;
126
+ div.appendChild(textLabel);
127
+ const divLine = document.createElement("div");
128
+ divLine.style.flexGrow = "1";
129
+ divLine.style.borderBottom = "dotted 1px";
130
+ div.appendChild(divLine);
131
+ const textValue = document.createElement("text");
132
+ textValue.innerText = `${(value.sum / value.values.length / 1.E6).toFixed(3)} ms\n`;
133
+ div.appendChild(textValue);
134
+ fragment.appendChild(div);
135
+ });
136
+ this._resultsDiv.innerHTML = "";
137
+ this._resultsDiv.appendChild(fragment);
138
+ };
139
+ this._debugControl = core_frontend_1.IModelApp.renderSystem.debugControl;
140
+ const checkBox = (0, CheckBox_1.createCheckBox)({
141
+ parent,
142
+ name: "Profile GPU",
143
+ id: "gpu-profiler-toggle",
144
+ handler: (cb) => this.toggleProfileCheckBox(cb.checked),
145
+ });
146
+ if (!this._debugControl.isGLTimerSupported) {
147
+ checkBox.checkbox.disabled = true;
148
+ checkBox.div.title = "EXT_disjoint_timer_query is not available in this browser";
149
+ }
150
+ this._div = document.createElement("div");
151
+ this._div.style.display = "none";
152
+ this._recordButton = document.createElement("button");
153
+ this._recordButton.style.textAlign = "center";
154
+ this._isRecording = false;
155
+ this._recordButton.innerText = "Record Profile";
156
+ this._recordButton.title = "Record a profile to open with chrome://tracing";
157
+ this._recordedResults = [];
158
+ this._recordButton.addEventListener("click", this._clickRecord);
159
+ this._div.appendChild(this._recordButton);
160
+ this._results = [];
161
+ this._resultsDiv = document.createElement("div");
162
+ this._resultsDiv.style.textAlign = "left";
163
+ this._div.appendChild(this._resultsDiv);
164
+ parent.appendChild(this._div);
165
+ }
166
+ dispose() {
167
+ this._debugControl.resultsCallback = undefined;
168
+ }
169
+ toggleProfileCheckBox(isEnabled) {
170
+ if (isEnabled) {
171
+ this._debugControl.resultsCallback = this._resultsCallback;
172
+ this._resultsDiv.innerHTML = "";
173
+ this._div.style.display = "block";
174
+ }
175
+ else {
176
+ this._debugControl.resultsCallback = undefined;
177
+ this._div.style.display = "none";
178
+ this.stopRecording();
179
+ }
180
+ }
181
+ stopRecording() {
182
+ this._isRecording = false;
183
+ this._recordButton.innerText = "Record Profile";
184
+ if (this._recordedResults.length !== 0) {
185
+ const chromeTrace = createTraceFromTimerResults(this._recordedResults);
186
+ const blob = new Blob([JSON.stringify(chromeTrace)], { type: "application/json;charset=utf-8" });
187
+ (0, file_saver_1.saveAs)(blob, "gpu-profile.json");
188
+ this._recordedResults = [];
189
+ }
190
+ }
191
+ }
192
+ exports.GpuProfiler = GpuProfiler;
193
193
  //# sourceMappingURL=GpuProfiler.js.map
@@ -1,62 +1,62 @@
1
- import { DataList } from "../ui/DataList";
2
- import { TextBox } from "../ui/TextBox";
3
- /** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
4
- * @beta
5
- */
6
- export declare enum KeyinFieldLocalization {
7
- /** Include only non-localized key-in strings. */
8
- NonLocalized = 0,
9
- /** Include only localized key-in strings. */
10
- Localized = 1,
11
- /** Include localized and non-localized strings for each key-in. */
12
- Both = 2
13
- }
14
- /** Properties controlling how a KeyinField is created.
15
- * @beta
16
- */
17
- export interface KeyinFieldProps {
18
- /** If supplied, the keyin field's elements will be added as children of this parent element. */
19
- parent?: HTMLElement;
20
- /** Required, unique ID prefix used to produce unique IDs for child elements. */
21
- baseId: string;
22
- /** Default: false. */
23
- wantButton?: boolean;
24
- /** Default: false. */
25
- wantLabel?: boolean;
26
- /** The maximum number of submitted key-ins to store in the history.
27
- * If greater than zero, pressing up/down while the KeyinField has focus will move backwards/forwards through the history.
28
- * Default: zero;
29
- */
30
- historyLength?: number;
31
- /** Controls whether localized and/or non-localized keyin strings appear in the autocompletion list.
32
- * Note: the KeyinField will still accept either localized or non-localized strings; this option only controls what is displayed in the auto-completion list.
33
- * Default: non-localized
34
- */
35
- localization?: KeyinFieldLocalization;
36
- }
37
- /** A textbox allowing input of key-ins (localized tool names) combined with a drop-down that lists all registered key-ins, filtered by substring match on the current input.
38
- * Press `enter` or click the Enter button to run the key-in.
39
- * @beta
40
- */
41
- export declare class KeyinField {
42
- /** @alpha */
43
- readonly autoCompleteList: DataList;
44
- readonly textBox: TextBox;
45
- readonly keyins: string[];
46
- private _historyIndex?;
47
- private _historyLength;
48
- private readonly _history;
49
- private readonly _localization;
50
- constructor(props: KeyinFieldProps);
51
- focus(): void;
52
- loseFocus(): void;
53
- selectAll(): void;
54
- private handleKeyPress;
55
- private handleKeyDown;
56
- private resetHistoryIndex;
57
- private pushHistory;
58
- private submitKeyin;
59
- private respondToKeyinFocus;
60
- private findKeyins;
61
- }
1
+ import { DataList } from "../ui/DataList";
2
+ import { TextBox } from "../ui/TextBox";
3
+ /** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
4
+ * @beta
5
+ */
6
+ export declare enum KeyinFieldLocalization {
7
+ /** Include only non-localized key-in strings. */
8
+ NonLocalized = 0,
9
+ /** Include only localized key-in strings. */
10
+ Localized = 1,
11
+ /** Include localized and non-localized strings for each key-in. */
12
+ Both = 2
13
+ }
14
+ /** Properties controlling how a KeyinField is created.
15
+ * @beta
16
+ */
17
+ export interface KeyinFieldProps {
18
+ /** If supplied, the keyin field's elements will be added as children of this parent element. */
19
+ parent?: HTMLElement;
20
+ /** Required, unique ID prefix used to produce unique IDs for child elements. */
21
+ baseId: string;
22
+ /** Default: false. */
23
+ wantButton?: boolean;
24
+ /** Default: false. */
25
+ wantLabel?: boolean;
26
+ /** The maximum number of submitted key-ins to store in the history.
27
+ * If greater than zero, pressing up/down while the KeyinField has focus will move backwards/forwards through the history.
28
+ * Default: zero;
29
+ */
30
+ historyLength?: number;
31
+ /** Controls whether localized and/or non-localized keyin strings appear in the autocompletion list.
32
+ * Note: the KeyinField will still accept either localized or non-localized strings; this option only controls what is displayed in the auto-completion list.
33
+ * Default: non-localized
34
+ */
35
+ localization?: KeyinFieldLocalization;
36
+ }
37
+ /** A textbox allowing input of key-ins (localized tool names) combined with a drop-down that lists all registered key-ins, filtered by substring match on the current input.
38
+ * Press `enter` or click the Enter button to run the key-in.
39
+ * @beta
40
+ */
41
+ export declare class KeyinField {
42
+ /** @alpha */
43
+ readonly autoCompleteList: DataList;
44
+ readonly textBox: TextBox;
45
+ readonly keyins: string[];
46
+ private _historyIndex?;
47
+ private _historyLength;
48
+ private readonly _history;
49
+ private readonly _localization;
50
+ constructor(props: KeyinFieldProps);
51
+ focus(): void;
52
+ loseFocus(): void;
53
+ selectAll(): void;
54
+ private handleKeyPress;
55
+ private handleKeyDown;
56
+ private resetHistoryIndex;
57
+ private pushHistory;
58
+ private submitKeyin;
59
+ private respondToKeyinFocus;
60
+ private findKeyins;
61
+ }
62
62
  //# sourceMappingURL=KeyinField.d.ts.map