@itwin/appui-abstract 3.7.0-dev.6 → 3.7.0-dev.8

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 (308) hide show
  1. package/CHANGELOG.md +6 -1
  2. package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  3. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
  4. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js.map +1 -1
  5. package/lib/cjs/appui-abstract/UiAdmin.d.ts +221 -221
  6. package/lib/cjs/appui-abstract/UiAdmin.js +224 -224
  7. package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
  8. package/lib/cjs/appui-abstract/UiItemsManager.d.ts +113 -113
  9. package/lib/cjs/appui-abstract/UiItemsManager.js +199 -199
  10. package/lib/cjs/appui-abstract/UiItemsManager.js.map +1 -1
  11. package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +29 -29
  12. package/lib/cjs/appui-abstract/UiItemsProvider.js +9 -9
  13. package/lib/cjs/appui-abstract/UiItemsProvider.js.map +1 -1
  14. package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +91 -91
  15. package/lib/cjs/appui-abstract/backstage/BackstageItem.js +70 -70
  16. package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +1 -1
  17. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  18. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +133 -133
  19. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  20. package/lib/cjs/appui-abstract/common/KeyboardKey.d.ts +51 -51
  21. package/lib/cjs/appui-abstract/common/KeyboardKey.js +63 -63
  22. package/lib/cjs/appui-abstract/common/KeyboardKey.js.map +1 -1
  23. package/lib/cjs/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  24. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
  25. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js.map +1 -1
  26. package/lib/cjs/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  27. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +108 -108
  28. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  29. package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  30. package/lib/cjs/appui-abstract/dialogs/DialogItem.js +67 -67
  31. package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map +1 -1
  32. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  33. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
  34. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
  35. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  36. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +175 -175
  37. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  38. package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  39. package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
  40. package/lib/cjs/appui-abstract/items/AbstractItemProps.js.map +1 -1
  41. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  42. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js +9 -9
  43. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
  44. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  45. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
  46. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
  47. package/lib/cjs/appui-abstract/items/BadgeType.d.ts +14 -14
  48. package/lib/cjs/appui-abstract/items/BadgeType.js +22 -22
  49. package/lib/cjs/appui-abstract/items/BadgeType.js.map +1 -1
  50. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  51. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
  52. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
  53. package/lib/cjs/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  54. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +62 -62
  55. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js.map +1 -1
  56. package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +11 -11
  57. package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
  58. package/lib/cjs/appui-abstract/items/ProvidedItem.js.map +1 -1
  59. package/lib/cjs/appui-abstract/items/RelativePosition.d.ts +18 -18
  60. package/lib/cjs/appui-abstract/items/RelativePosition.js +26 -26
  61. package/lib/cjs/appui-abstract/items/RelativePosition.js.map +1 -1
  62. package/lib/cjs/appui-abstract/items/StageUsage.d.ts +16 -16
  63. package/lib/cjs/appui-abstract/items/StageUsage.js +24 -24
  64. package/lib/cjs/appui-abstract/items/StageUsage.js.map +1 -1
  65. package/lib/cjs/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  66. package/lib/cjs/appui-abstract/notification/MessagePresenter.js +24 -24
  67. package/lib/cjs/appui-abstract/notification/MessagePresenter.js.map +1 -1
  68. package/lib/cjs/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  69. package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
  70. package/lib/cjs/appui-abstract/notification/MessageSeverity.js.map +1 -1
  71. package/lib/cjs/appui-abstract/properties/Description.d.ts +127 -127
  72. package/lib/cjs/appui-abstract/properties/Description.js +196 -196
  73. package/lib/cjs/appui-abstract/properties/Description.js.map +1 -1
  74. package/lib/cjs/appui-abstract/properties/EditorParams.d.ts +260 -260
  75. package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
  76. package/lib/cjs/appui-abstract/properties/EditorParams.js.map +1 -1
  77. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  78. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js +9 -9
  79. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
  80. package/lib/cjs/appui-abstract/properties/Record.d.ts +57 -57
  81. package/lib/cjs/appui-abstract/properties/Record.js +78 -78
  82. package/lib/cjs/appui-abstract/properties/Record.js.map +1 -1
  83. package/lib/cjs/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  84. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js +30 -30
  85. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js.map +1 -1
  86. package/lib/cjs/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  87. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
  88. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js.map +1 -1
  89. package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
  90. package/lib/cjs/appui-abstract/properties/Value.js +20 -20
  91. package/lib/cjs/appui-abstract/properties/Value.js.map +1 -1
  92. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  93. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +48 -48
  94. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
  95. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
  96. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +87 -87
  97. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  98. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  99. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +135 -135
  100. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  101. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
  102. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +64 -64
  103. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  104. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  105. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +235 -235
  106. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  107. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  108. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +51 -51
  109. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  110. package/lib/cjs/appui-abstract/utils/PointProps.d.ts +10 -10
  111. package/lib/cjs/appui-abstract/utils/PointProps.js +9 -9
  112. package/lib/cjs/appui-abstract/utils/PointProps.js.map +1 -1
  113. package/lib/cjs/appui-abstract/utils/UiError.d.ts +12 -12
  114. package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
  115. package/lib/cjs/appui-abstract/utils/UiError.js.map +1 -1
  116. package/lib/cjs/appui-abstract/utils/UiEvent.d.ts +9 -9
  117. package/lib/cjs/appui-abstract/utils/UiEvent.js +17 -17
  118. package/lib/cjs/appui-abstract/utils/UiEvent.js.map +1 -1
  119. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  120. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
  121. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
  122. package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
  123. package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
  124. package/lib/cjs/appui-abstract/utils/callbacks.js.map +1 -1
  125. package/lib/cjs/appui-abstract/utils/filter/charCode.d.ts +416 -416
  126. package/lib/cjs/appui-abstract/utils/filter/charCode.js +6 -6
  127. package/lib/cjs/appui-abstract/utils/filter/charCode.js.map +1 -1
  128. package/lib/cjs/appui-abstract/utils/filter/filters.d.ts +98 -98
  129. package/lib/cjs/appui-abstract/utils/filter/filters.js +709 -709
  130. package/lib/cjs/appui-abstract/utils/filter/filters.js.map +1 -1
  131. package/lib/cjs/appui-abstract/utils/filter/map.d.ts +59 -59
  132. package/lib/cjs/appui-abstract/utils/filter/map.js +404 -404
  133. package/lib/cjs/appui-abstract/utils/filter/map.js.map +1 -1
  134. package/lib/cjs/appui-abstract/utils/filter/strings.d.ts +20 -20
  135. package/lib/cjs/appui-abstract/utils/filter/strings.js +78 -78
  136. package/lib/cjs/appui-abstract/utils/filter/strings.js.map +1 -1
  137. package/lib/cjs/appui-abstract/utils/isLetter.d.ts +9 -9
  138. package/lib/cjs/appui-abstract/utils/isLetter.js +19 -19
  139. package/lib/cjs/appui-abstract/utils/isLetter.js.map +1 -1
  140. package/lib/cjs/appui-abstract/utils/misc.d.ts +11 -11
  141. package/lib/cjs/appui-abstract/utils/misc.js +36 -36
  142. package/lib/cjs/appui-abstract/utils/misc.js.map +1 -1
  143. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
  144. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +9 -9
  145. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  146. package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +36 -36
  147. package/lib/cjs/appui-abstract/widget/StagePanel.js +46 -46
  148. package/lib/cjs/appui-abstract/widget/StagePanel.js.map +1 -1
  149. package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +19 -19
  150. package/lib/cjs/appui-abstract/widget/WidgetState.js +27 -27
  151. package/lib/cjs/appui-abstract/widget/WidgetState.js.map +1 -1
  152. package/lib/cjs/appui-abstract.d.ts +103 -103
  153. package/lib/cjs/appui-abstract.js +119 -119
  154. package/lib/cjs/appui-abstract.js.map +1 -1
  155. package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  156. package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
  157. package/lib/esm/appui-abstract/BaseUiItemsProvider.js.map +1 -1
  158. package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
  159. package/lib/esm/appui-abstract/UiAdmin.js +219 -219
  160. package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
  161. package/lib/esm/appui-abstract/UiItemsManager.d.ts +113 -113
  162. package/lib/esm/appui-abstract/UiItemsManager.js +195 -195
  163. package/lib/esm/appui-abstract/UiItemsManager.js.map +1 -1
  164. package/lib/esm/appui-abstract/UiItemsProvider.d.ts +29 -29
  165. package/lib/esm/appui-abstract/UiItemsProvider.js +8 -8
  166. package/lib/esm/appui-abstract/UiItemsProvider.js.map +1 -1
  167. package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +91 -91
  168. package/lib/esm/appui-abstract/backstage/BackstageItem.js +64 -64
  169. package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +1 -1
  170. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  171. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +129 -129
  172. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  173. package/lib/esm/appui-abstract/common/KeyboardKey.d.ts +51 -51
  174. package/lib/esm/appui-abstract/common/KeyboardKey.js +59 -59
  175. package/lib/esm/appui-abstract/common/KeyboardKey.js.map +1 -1
  176. package/lib/esm/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  177. package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
  178. package/lib/esm/appui-abstract/content/ContentLayoutProps.js.map +1 -1
  179. package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  180. package/lib/esm/appui-abstract/content/StandardContentLayouts.js +104 -104
  181. package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  182. package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  183. package/lib/esm/appui-abstract/dialogs/DialogItem.js +63 -63
  184. package/lib/esm/appui-abstract/dialogs/DialogItem.js.map +1 -1
  185. package/lib/esm/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  186. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
  187. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
  188. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  189. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +170 -170
  190. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  191. package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  192. package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
  193. package/lib/esm/appui-abstract/items/AbstractItemProps.js.map +1 -1
  194. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  195. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js +8 -8
  196. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
  197. package/lib/esm/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  198. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
  199. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
  200. package/lib/esm/appui-abstract/items/BadgeType.d.ts +14 -14
  201. package/lib/esm/appui-abstract/items/BadgeType.js +19 -19
  202. package/lib/esm/appui-abstract/items/BadgeType.js.map +1 -1
  203. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  204. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
  205. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
  206. package/lib/esm/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  207. package/lib/esm/appui-abstract/items/ConditionalStringValue.js +58 -58
  208. package/lib/esm/appui-abstract/items/ConditionalStringValue.js.map +1 -1
  209. package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +11 -11
  210. package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
  211. package/lib/esm/appui-abstract/items/ProvidedItem.js.map +1 -1
  212. package/lib/esm/appui-abstract/items/RelativePosition.d.ts +18 -18
  213. package/lib/esm/appui-abstract/items/RelativePosition.js +23 -23
  214. package/lib/esm/appui-abstract/items/RelativePosition.js.map +1 -1
  215. package/lib/esm/appui-abstract/items/StageUsage.d.ts +16 -16
  216. package/lib/esm/appui-abstract/items/StageUsage.js +21 -21
  217. package/lib/esm/appui-abstract/items/StageUsage.js.map +1 -1
  218. package/lib/esm/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  219. package/lib/esm/appui-abstract/notification/MessagePresenter.js +21 -21
  220. package/lib/esm/appui-abstract/notification/MessagePresenter.js.map +1 -1
  221. package/lib/esm/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  222. package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
  223. package/lib/esm/appui-abstract/notification/MessageSeverity.js.map +1 -1
  224. package/lib/esm/appui-abstract/properties/Description.d.ts +127 -127
  225. package/lib/esm/appui-abstract/properties/Description.js +192 -192
  226. package/lib/esm/appui-abstract/properties/Description.js.map +1 -1
  227. package/lib/esm/appui-abstract/properties/EditorParams.d.ts +260 -260
  228. package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
  229. package/lib/esm/appui-abstract/properties/EditorParams.js.map +1 -1
  230. package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  231. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js +8 -8
  232. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
  233. package/lib/esm/appui-abstract/properties/Record.d.ts +57 -57
  234. package/lib/esm/appui-abstract/properties/Record.js +74 -74
  235. package/lib/esm/appui-abstract/properties/Record.js.map +1 -1
  236. package/lib/esm/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  237. package/lib/esm/appui-abstract/properties/StandardEditorNames.js +27 -27
  238. package/lib/esm/appui-abstract/properties/StandardEditorNames.js.map +1 -1
  239. package/lib/esm/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  240. package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
  241. package/lib/esm/appui-abstract/properties/StandardTypeNames.js.map +1 -1
  242. package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
  243. package/lib/esm/appui-abstract/properties/Value.js +17 -17
  244. package/lib/esm/appui-abstract/properties/Value.js.map +1 -1
  245. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  246. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +44 -44
  247. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
  248. package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
  249. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +80 -80
  250. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  251. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  252. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +131 -131
  253. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  254. package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
  255. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +60 -60
  256. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  257. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  258. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +231 -231
  259. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  260. package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  261. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +47 -47
  262. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  263. package/lib/esm/appui-abstract/utils/PointProps.d.ts +10 -10
  264. package/lib/esm/appui-abstract/utils/PointProps.js +8 -8
  265. package/lib/esm/appui-abstract/utils/PointProps.js.map +1 -1
  266. package/lib/esm/appui-abstract/utils/UiError.d.ts +12 -12
  267. package/lib/esm/appui-abstract/utils/UiError.js +18 -18
  268. package/lib/esm/appui-abstract/utils/UiError.js.map +1 -1
  269. package/lib/esm/appui-abstract/utils/UiEvent.d.ts +9 -9
  270. package/lib/esm/appui-abstract/utils/UiEvent.js +13 -13
  271. package/lib/esm/appui-abstract/utils/UiEvent.js.map +1 -1
  272. package/lib/esm/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  273. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
  274. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
  275. package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
  276. package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
  277. package/lib/esm/appui-abstract/utils/callbacks.js.map +1 -1
  278. package/lib/esm/appui-abstract/utils/filter/charCode.d.ts +416 -416
  279. package/lib/esm/appui-abstract/utils/filter/charCode.js +5 -5
  280. package/lib/esm/appui-abstract/utils/filter/charCode.js.map +1 -1
  281. package/lib/esm/appui-abstract/utils/filter/filters.d.ts +98 -98
  282. package/lib/esm/appui-abstract/utils/filter/filters.js +694 -694
  283. package/lib/esm/appui-abstract/utils/filter/filters.js.map +1 -1
  284. package/lib/esm/appui-abstract/utils/filter/map.d.ts +59 -59
  285. package/lib/esm/appui-abstract/utils/filter/map.js +399 -399
  286. package/lib/esm/appui-abstract/utils/filter/map.js.map +1 -1
  287. package/lib/esm/appui-abstract/utils/filter/strings.d.ts +20 -20
  288. package/lib/esm/appui-abstract/utils/filter/strings.js +70 -70
  289. package/lib/esm/appui-abstract/utils/filter/strings.js.map +1 -1
  290. package/lib/esm/appui-abstract/utils/isLetter.d.ts +9 -9
  291. package/lib/esm/appui-abstract/utils/isLetter.js +15 -15
  292. package/lib/esm/appui-abstract/utils/isLetter.js.map +1 -1
  293. package/lib/esm/appui-abstract/utils/misc.d.ts +11 -11
  294. package/lib/esm/appui-abstract/utils/misc.js +31 -31
  295. package/lib/esm/appui-abstract/utils/misc.js.map +1 -1
  296. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
  297. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +8 -8
  298. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  299. package/lib/esm/appui-abstract/widget/StagePanel.d.ts +36 -36
  300. package/lib/esm/appui-abstract/widget/StagePanel.js +43 -43
  301. package/lib/esm/appui-abstract/widget/StagePanel.js.map +1 -1
  302. package/lib/esm/appui-abstract/widget/WidgetState.d.ts +19 -19
  303. package/lib/esm/appui-abstract/widget/WidgetState.js +24 -24
  304. package/lib/esm/appui-abstract/widget/WidgetState.js.map +1 -1
  305. package/lib/esm/appui-abstract.d.ts +103 -103
  306. package/lib/esm/appui-abstract.js +107 -107
  307. package/lib/esm/appui-abstract.js.map +1 -1
  308. package/package.json +5 -5
@@ -1,193 +1,193 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Properties
7
- */
8
- import { PropertyEditorParamTypes, } from "./EditorParams";
9
- import { StandardEditorNames } from "./StandardEditorNames";
10
- import { StandardTypeNames } from "./StandardTypeNames";
11
- /** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
12
- * @public
13
- */
14
- export class PropertyDescriptionHelper {
15
- /** Builds a number description with a "weight-picker" editor name
16
- * @public
17
- */
18
- static buildWeightPickerDescription(name, label, additionalParams = []) {
19
- return {
20
- name,
21
- displayLabel: label,
22
- typename: StandardTypeNames.Number,
23
- editor: {
24
- name: StandardEditorNames.WeightPicker,
25
- params: additionalParams,
26
- },
27
- };
28
- }
29
- /** Builds an editor that uses [NumberInput]($core-react) control
30
- * @public
31
- */
32
- static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
33
- const editorParams = [{
34
- type: PropertyEditorParamTypes.Range,
35
- step: 1,
36
- precision: 0,
37
- ...overrideParams,
38
- }, ...additionalParams];
39
- const editor = {
40
- name: StandardEditorNames.NumericInput,
41
- params: editorParams,
42
- };
43
- return {
44
- name,
45
- displayLabel: label,
46
- typename: StandardTypeNames.Number,
47
- editor,
48
- };
49
- }
50
- /** Builds a string description
51
- * @public
52
- */
53
- static buildTextEditorDescription(name, label, additionalParams = []) {
54
- const editor = {
55
- params: additionalParams,
56
- };
57
- return {
58
- name,
59
- displayLabel: label,
60
- typename: StandardTypeNames.String,
61
- editor,
62
- };
63
- }
64
- /** Builds an enum description
65
- * @public
66
- */
67
- static buildEnumPicklistEditorDescription(name, label, choices, additionalParams = []) {
68
- const editor = additionalParams.length ? {
69
- params: additionalParams,
70
- } : undefined;
71
- return {
72
- name,
73
- displayLabel: label,
74
- typename: StandardTypeNames.Enum,
75
- editor,
76
- enum: {
77
- choices,
78
- },
79
- };
80
- }
81
- /** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
82
- * @public
83
- */
84
- static buildColorPickerDescription(name, label, colorValues, numColumns, additionalParams = []) {
85
- const editorParams = [
86
- {
87
- type: PropertyEditorParamTypes.ColorData,
88
- colorValues,
89
- numColumns,
90
- },
91
- ...additionalParams,
92
- ];
93
- return {
94
- name,
95
- displayLabel: label,
96
- typename: StandardTypeNames.Number,
97
- editor: {
98
- name: StandardEditorNames.ColorPicker,
99
- params: editorParams,
100
- },
101
- };
102
- }
103
- /** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
104
- * @public
105
- */
106
- static buildToggleDescription(name, label, additionalParams = []) {
107
- return {
108
- name,
109
- displayLabel: label,
110
- typename: StandardTypeNames.Boolean,
111
- editor: {
112
- name: StandardEditorNames.Toggle,
113
- params: additionalParams,
114
- },
115
- };
116
- }
117
- /** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
118
- * @public
119
- */
120
- static buildImageCheckBoxDescription(name, label, imageOff, imageOn, additionalParams = []) {
121
- const editorParams = [{
122
- type: PropertyEditorParamTypes.CheckBoxImages,
123
- imageOff,
124
- imageOn,
125
- }, ...additionalParams];
126
- return {
127
- name,
128
- displayLabel: label,
129
- typename: StandardTypeNames.Boolean,
130
- editor: {
131
- name: StandardEditorNames.ImageCheckBox,
132
- params: editorParams,
133
- },
134
- };
135
- }
136
- /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
137
- * @public
138
- */
139
- static buildCheckboxDescription(name, label, additionalParams = []) {
140
- const editor = {
141
- params: additionalParams,
142
- };
143
- return {
144
- name,
145
- displayLabel: label,
146
- typename: StandardTypeNames.Boolean,
147
- editor,
148
- };
149
- }
150
- /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.
151
- * @public
152
- */
153
- static buildLockPropertyDescription(name, additionalParams = []) {
154
- const defaultParams = {
155
- type: PropertyEditorParamTypes.SuppressEditorLabel,
156
- suppressLabelPlaceholder: true,
157
- };
158
- const editor = {
159
- params: [defaultParams, ...additionalParams],
160
- };
161
- return {
162
- name,
163
- displayLabel: "",
164
- typename: StandardTypeNames.Boolean,
165
- editor,
166
- };
167
- }
168
- /** Bumps an enum property description value
169
- * @public
170
- */
171
- static async bumpEnumProperty(description, value) {
172
- let choices;
173
- if (description.enum) {
174
- if (description.enum.choices instanceof Promise) {
175
- choices = await description.enum.choices;
176
- }
177
- else {
178
- choices = description.enum.choices;
179
- }
180
- }
181
- if (!choices || choices.length === 0)
182
- return value;
183
- let choiceIndex = choices.findIndex((choice) => choice.value === value);
184
- if (choiceIndex < 0)
185
- return value;
186
- choiceIndex++;
187
- if (choiceIndex >= choices.length)
188
- choiceIndex = 0;
189
- const newValue = choices[choiceIndex].value;
190
- return newValue;
191
- }
192
- }
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Properties
7
+ */
8
+ import { PropertyEditorParamTypes, } from "./EditorParams";
9
+ import { StandardEditorNames } from "./StandardEditorNames";
10
+ import { StandardTypeNames } from "./StandardTypeNames";
11
+ /** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.
12
+ * @public
13
+ */
14
+ export class PropertyDescriptionHelper {
15
+ /** Builds a number description with a "weight-picker" editor name
16
+ * @public
17
+ */
18
+ static buildWeightPickerDescription(name, label, additionalParams = []) {
19
+ return {
20
+ name,
21
+ displayLabel: label,
22
+ typename: StandardTypeNames.Number,
23
+ editor: {
24
+ name: StandardEditorNames.WeightPicker,
25
+ params: additionalParams,
26
+ },
27
+ };
28
+ }
29
+ /** Builds an editor that uses [NumberInput]($core-react) control
30
+ * @public
31
+ */
32
+ static buildNumberEditorDescription(name, label, overrideParams, additionalParams = []) {
33
+ const editorParams = [{
34
+ type: PropertyEditorParamTypes.Range,
35
+ step: 1,
36
+ precision: 0,
37
+ ...overrideParams,
38
+ }, ...additionalParams];
39
+ const editor = {
40
+ name: StandardEditorNames.NumericInput,
41
+ params: editorParams,
42
+ };
43
+ return {
44
+ name,
45
+ displayLabel: label,
46
+ typename: StandardTypeNames.Number,
47
+ editor,
48
+ };
49
+ }
50
+ /** Builds a string description
51
+ * @public
52
+ */
53
+ static buildTextEditorDescription(name, label, additionalParams = []) {
54
+ const editor = {
55
+ params: additionalParams,
56
+ };
57
+ return {
58
+ name,
59
+ displayLabel: label,
60
+ typename: StandardTypeNames.String,
61
+ editor,
62
+ };
63
+ }
64
+ /** Builds an enum description
65
+ * @public
66
+ */
67
+ static buildEnumPicklistEditorDescription(name, label, choices, additionalParams = []) {
68
+ const editor = additionalParams.length ? {
69
+ params: additionalParams,
70
+ } : undefined;
71
+ return {
72
+ name,
73
+ displayLabel: label,
74
+ typename: StandardTypeNames.Enum,
75
+ editor,
76
+ enum: {
77
+ choices,
78
+ },
79
+ };
80
+ }
81
+ /** Builds a number description for a tool settings or dialog property that will display a "color-picker" control.
82
+ * @public
83
+ */
84
+ static buildColorPickerDescription(name, label, colorValues, numColumns, additionalParams = []) {
85
+ const editorParams = [
86
+ {
87
+ type: PropertyEditorParamTypes.ColorData,
88
+ colorValues,
89
+ numColumns,
90
+ },
91
+ ...additionalParams,
92
+ ];
93
+ return {
94
+ name,
95
+ displayLabel: label,
96
+ typename: StandardTypeNames.Number,
97
+ editor: {
98
+ name: StandardEditorNames.ColorPicker,
99
+ params: editorParams,
100
+ },
101
+ };
102
+ }
103
+ /** Builds a boolean description for a tool settings or dialog property that will display a "toggle" control.
104
+ * @public
105
+ */
106
+ static buildToggleDescription(name, label, additionalParams = []) {
107
+ return {
108
+ name,
109
+ displayLabel: label,
110
+ typename: StandardTypeNames.Boolean,
111
+ editor: {
112
+ name: StandardEditorNames.Toggle,
113
+ params: additionalParams,
114
+ },
115
+ };
116
+ }
117
+ /** Builds a boolean description for a tool settings or dialog property that will display a "image-check-box" control.
118
+ * @public
119
+ */
120
+ static buildImageCheckBoxDescription(name, label, imageOff, imageOn, additionalParams = []) {
121
+ const editorParams = [{
122
+ type: PropertyEditorParamTypes.CheckBoxImages,
123
+ imageOff,
124
+ imageOn,
125
+ }, ...additionalParams];
126
+ return {
127
+ name,
128
+ displayLabel: label,
129
+ typename: StandardTypeNames.Boolean,
130
+ editor: {
131
+ name: StandardEditorNames.ImageCheckBox,
132
+ params: editorParams,
133
+ },
134
+ };
135
+ }
136
+ /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.
137
+ * @public
138
+ */
139
+ static buildCheckboxDescription(name, label, additionalParams = []) {
140
+ const editor = {
141
+ params: additionalParams,
142
+ };
143
+ return {
144
+ name,
145
+ displayLabel: label,
146
+ typename: StandardTypeNames.Boolean,
147
+ editor,
148
+ };
149
+ }
150
+ /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.
151
+ * @public
152
+ */
153
+ static buildLockPropertyDescription(name, additionalParams = []) {
154
+ const defaultParams = {
155
+ type: PropertyEditorParamTypes.SuppressEditorLabel,
156
+ suppressLabelPlaceholder: true,
157
+ };
158
+ const editor = {
159
+ params: [defaultParams, ...additionalParams],
160
+ };
161
+ return {
162
+ name,
163
+ displayLabel: "",
164
+ typename: StandardTypeNames.Boolean,
165
+ editor,
166
+ };
167
+ }
168
+ /** Bumps an enum property description value
169
+ * @public
170
+ */
171
+ static async bumpEnumProperty(description, value) {
172
+ let choices;
173
+ if (description.enum) {
174
+ if (description.enum.choices instanceof Promise) {
175
+ choices = await description.enum.choices;
176
+ }
177
+ else {
178
+ choices = description.enum.choices;
179
+ }
180
+ }
181
+ if (!choices || choices.length === 0)
182
+ return value;
183
+ let choiceIndex = choices.findIndex((choice) => choice.value === value);
184
+ if (choiceIndex < 0)
185
+ return value;
186
+ choiceIndex++;
187
+ if (choiceIndex >= choices.length)
188
+ choiceIndex = 0;
189
+ const newValue = choices[choiceIndex].value;
190
+ return newValue;
191
+ }
192
+ }
193
193
  //# sourceMappingURL=Description.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Description.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/Description.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACmF,wBAAwB,GACjH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAsFxD;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACvH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,YAAY;gBACtC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,cAAkC,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,KAAK;gBACpC,IAAI,EAAE,CAAC;gBACP,SAAS,EAAE,CAAC;gBACZ,GAAG,cAAc;aACG,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,mBAAmB,CAAC,YAAY;YACtC,MAAM,EAAE,YAAY;SACrB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACrH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,kCAAkC,CAAC,IAAY,EAAE,KAAa,EAC1E,OAA2D,EAC3D,mBAA+C,EAAE;QACjD,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACvC,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,IAAI;YAChC,MAAM;YACN,IAAI,EAAE;gBACJ,OAAO;aACR;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,2BAA2B,CAAC,IAAY,EAAE,KAAa,EAAE,WAAqB,EAAE,UAAkB,EAC9G,mBAA+C,EAAE;QACjD,MAAM,YAAY,GAAG;YACnB;gBACE,IAAI,EAAE,wBAAwB,CAAC,SAAS;gBACxC,WAAW;gBACX,UAAU;aACU;YACtB,GAAG,gBAAgB;SACpB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,WAAW;gBACrC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACjH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,MAAM;gBAChC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,6BAA6B,CAAC,IAAY,EAAE,KAAa,EAAE,QAAgB,EAAE,OAAe,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,cAAc;gBAC7C,QAAQ;gBACR,OAAO;aACe,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE/C,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,aAAa;gBACvC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,wBAAwB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACnH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,mBAA+C,EAAE;QACxG,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,wBAAwB,CAAC,mBAAmB;YAClD,wBAAwB,EAAE,IAAI;SACF,CAAC;QAE/B,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,CAAC,aAAa,EAAE,GAAG,gBAAgB,CAAC;SAC7C,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAgC,EAAE,KAAsB;QAC3F,IAAI,OAAwC,CAAC;QAE7C,IAAI,WAAW,CAAC,IAAI,EAAE;YACpB,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,YAAY,OAAO,EAAE;gBAC/C,OAAO,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C;iBAAM;gBACL,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aACpC;SACF;QAED,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,OAAO,KAAK,CAAC;QAEf,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QACxE,IAAI,WAAW,GAAG,CAAC;YACjB,OAAO,KAAK,CAAC;QAEf,WAAW,EAAE,CAAC;QACd,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM;YAC/B,WAAW,GAAG,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Properties\r\n */\r\n\r\nimport {\r\n BasePropertyEditorParams, ColorEditorParams, ImageCheckBoxParams, PropertyEditorParams, PropertyEditorParamTypes, RangeEditorParams, SuppressLabelEditorParams,\r\n} from \"./EditorParams\";\r\nimport { StandardEditorNames } from \"./StandardEditorNames\";\r\nimport { StandardTypeNames } from \"./StandardTypeNames\";\r\n\r\n// cSpell:ignore Picklist\r\n\r\n/**\r\n * Information about an enumeration choice\r\n * @public\r\n */\r\nexport interface EnumerationChoice {\r\n label: string;\r\n value: string | number;\r\n}\r\n\r\n/**\r\n * Information about a set of enumeration choices\r\n * @public\r\n */\r\nexport interface EnumerationChoicesInfo {\r\n choices: Promise<EnumerationChoice[]> | EnumerationChoice[];\r\n isStrict?: boolean;\r\n maxDisplayedRows?: number;\r\n}\r\n\r\n/**\r\n * Property renderer identification and customization attributes\r\n * @public\r\n */\r\nexport interface PropertyRendererInfo {\r\n name: string;\r\n}\r\n\r\n/**\r\n * Information about a Property Editor\r\n * @public\r\n */\r\nexport interface PropertyEditorInfo {\r\n /** Editor name used in addition to the typename to find the registered property editor */\r\n name?: string;\r\n /** Editor params provided to the property editor */\r\n params?: PropertyEditorParams[];\r\n}\r\n\r\n/**\r\n * Information about a Property Converter\r\n * @public\r\n */\r\nexport interface PropertyConverterInfo {\r\n /** Converter name used in addition to the typename to find the registered property converter */\r\n name?: string;\r\n /** map of options for type converter */\r\n options?: { [key: string]: any };\r\n}\r\n\r\n/**\r\n * [[PropertyDescription]] contains metadata about a Property\r\n * @public\r\n */\r\nexport interface PropertyDescription {\r\n /** Name of the property description */\r\n name: string;\r\n /** Display label for the property description */\r\n displayLabel: string;\r\n /** Type name used to determine applicable Type Converter and Property Editor */\r\n typename: string;\r\n /** Additional information for enumerations */\r\n enum?: EnumerationChoicesInfo;\r\n /** Information for property renderer customization */\r\n renderer?: PropertyRendererInfo;\r\n /** Information for a property editor */\r\n editor?: PropertyEditorInfo;\r\n /** Information for a property converter */\r\n converter?: PropertyConverterInfo;\r\n /** Quantity type key used to look up formatting and parsing specs. This is typically either the name of a quantity type used by a tool\r\n * or the full name of a KOQ (schema:koq).\r\n * @alpha\r\n */\r\n quantityType?: string;\r\n /** Get the custom DataController by this name and register it with the property editor */\r\n dataController?: string;\r\n /**\r\n * Should property label for composite (struct & array) properties be rendered.\r\n * @alpha\r\n */\r\n hideCompositePropertyLabel?: boolean;\r\n}\r\n\r\n/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.\r\n * @public\r\n */\r\nexport class PropertyDescriptionHelper {\r\n /** Builds a number description with a \"weight-picker\" editor name\r\n * @public\r\n */\r\n public static buildWeightPickerDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Number,\r\n editor: {\r\n name: StandardEditorNames.WeightPicker,\r\n params: additionalParams,\r\n },\r\n };\r\n }\r\n\r\n /** Builds an editor that uses [NumberInput]($core-react) control\r\n * @public\r\n */\r\n public static buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const editorParams = [{\r\n type: PropertyEditorParamTypes.Range,\r\n step: 1,\r\n precision: 0,\r\n ...overrideParams,\r\n } as RangeEditorParams, ...additionalParams];\r\n\r\n const editor = {\r\n name: StandardEditorNames.NumericInput,\r\n params: editorParams,\r\n };\r\n\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Number,\r\n editor,\r\n };\r\n }\r\n\r\n /** Builds a string description\r\n * @public\r\n */\r\n public static buildTextEditorDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const editor = {\r\n params: additionalParams,\r\n };\r\n\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.String,\r\n editor,\r\n };\r\n }\r\n\r\n /** Builds an enum description\r\n * @public\r\n */\r\n public static buildEnumPicklistEditorDescription(name: string, label: string,\r\n choices: Promise<EnumerationChoice[]> | EnumerationChoice[],\r\n additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const editor = additionalParams.length ? {\r\n params: additionalParams,\r\n } : undefined;\r\n\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Enum,\r\n editor,\r\n enum: {\r\n choices,\r\n },\r\n };\r\n }\r\n\r\n /** Builds a number description for a tool settings or dialog property that will display a \"color-picker\" control.\r\n * @public\r\n */\r\n public static buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number,\r\n additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const editorParams = [\r\n {\r\n type: PropertyEditorParamTypes.ColorData,\r\n colorValues,\r\n numColumns,\r\n } as ColorEditorParams,\r\n ...additionalParams,\r\n ];\r\n\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Number,\r\n editor: {\r\n name: StandardEditorNames.ColorPicker,\r\n params: editorParams,\r\n },\r\n };\r\n }\r\n\r\n /** Builds a boolean description for a tool settings or dialog property that will display a \"toggle\" control.\r\n * @public\r\n */\r\n public static buildToggleDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Boolean,\r\n editor: {\r\n name: StandardEditorNames.Toggle,\r\n params: additionalParams,\r\n },\r\n };\r\n }\r\n\r\n /** Builds a boolean description for a tool settings or dialog property that will display a \"image-check-box\" control.\r\n * @public\r\n */\r\n public static buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const editorParams = [{\r\n type: PropertyEditorParamTypes.CheckBoxImages,\r\n imageOff,\r\n imageOn,\r\n } as ImageCheckBoxParams, ...additionalParams];\r\n\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Boolean,\r\n editor: {\r\n name: StandardEditorNames.ImageCheckBox,\r\n params: editorParams,\r\n },\r\n };\r\n }\r\n\r\n /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.\r\n * @public\r\n */\r\n public static buildCheckboxDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const editor = {\r\n params: additionalParams,\r\n };\r\n\r\n return {\r\n name,\r\n displayLabel: label,\r\n typename: StandardTypeNames.Boolean,\r\n editor,\r\n };\r\n }\r\n\r\n /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.\r\n * @public\r\n */\r\n public static buildLockPropertyDescription(name: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\r\n const defaultParams = {\r\n type: PropertyEditorParamTypes.SuppressEditorLabel,\r\n suppressLabelPlaceholder: true,\r\n } as SuppressLabelEditorParams;\r\n\r\n const editor = {\r\n params: [defaultParams, ...additionalParams],\r\n };\r\n\r\n return {\r\n name,\r\n displayLabel: \"\",\r\n typename: StandardTypeNames.Boolean,\r\n editor,\r\n };\r\n }\r\n\r\n /** Bumps an enum property description value\r\n * @public\r\n */\r\n public static async bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number> {\r\n let choices: EnumerationChoice[] | undefined;\r\n\r\n if (description.enum) {\r\n if (description.enum.choices instanceof Promise) {\r\n choices = await description.enum.choices;\r\n } else {\r\n choices = description.enum.choices;\r\n }\r\n }\r\n\r\n if (!choices || choices.length === 0)\r\n return value;\r\n\r\n let choiceIndex = choices.findIndex((choice) => choice.value === value);\r\n if (choiceIndex < 0)\r\n return value;\r\n\r\n choiceIndex++;\r\n if (choiceIndex >= choices.length)\r\n choiceIndex = 0;\r\n\r\n const newValue = choices[choiceIndex].value;\r\n return newValue;\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"Description.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/Description.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACmF,wBAAwB,GACjH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAsFxD;;GAEG;AACH,MAAM,OAAO,yBAAyB;IACpC;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACvH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,YAAY;gBACtC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,KAAa,EAAE,cAAkC,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,KAAK;gBACpC,IAAI,EAAE,CAAC;gBACP,SAAS,EAAE,CAAC;gBACZ,GAAG,cAAc;aACG,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,mBAAmB,CAAC,YAAY;YACtC,MAAM,EAAE,YAAY;SACrB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACrH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,kCAAkC,CAAC,IAAY,EAAE,KAAa,EAC1E,OAA2D,EAC3D,mBAA+C,EAAE;QACjD,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACvC,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,IAAI;YAChC,MAAM;YACN,IAAI,EAAE;gBACJ,OAAO;aACR;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,2BAA2B,CAAC,IAAY,EAAE,KAAa,EAAE,WAAqB,EAAE,UAAkB,EAC9G,mBAA+C,EAAE;QACjD,MAAM,YAAY,GAAG;YACnB;gBACE,IAAI,EAAE,wBAAwB,CAAC,SAAS;gBACxC,WAAW;gBACX,UAAU;aACU;YACtB,GAAG,gBAAgB;SACpB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,MAAM;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,WAAW;gBACrC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACjH,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,MAAM;gBAChC,MAAM,EAAE,gBAAgB;aACzB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,6BAA6B,CAAC,IAAY,EAAE,KAAa,EAAE,QAAgB,EAAE,OAAe,EAAE,mBAA+C,EAAE;QAC3J,MAAM,YAAY,GAAG,CAAC;gBACpB,IAAI,EAAE,wBAAwB,CAAC,cAAc;gBAC7C,QAAQ;gBACR,OAAO;aACe,EAAE,GAAG,gBAAgB,CAAC,CAAC;QAE/C,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,mBAAmB,CAAC,aAAa;gBACvC,MAAM,EAAE,YAAY;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,wBAAwB,CAAC,IAAY,EAAE,KAAa,EAAE,mBAA+C,EAAE;QACnH,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,gBAAgB;SACzB,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CAAC,IAAY,EAAE,mBAA+C,EAAE;QACxG,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,wBAAwB,CAAC,mBAAmB;YAClD,wBAAwB,EAAE,IAAI;SACF,CAAC;QAE/B,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,CAAC,aAAa,EAAE,GAAG,gBAAgB,CAAC;SAC7C,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,iBAAiB,CAAC,OAAO;YACnC,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,WAAgC,EAAE,KAAsB;QAC3F,IAAI,OAAwC,CAAC;QAE7C,IAAI,WAAW,CAAC,IAAI,EAAE;YACpB,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,YAAY,OAAO,EAAE;gBAC/C,OAAO,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C;iBAAM;gBACL,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;aACpC;SACF;QAED,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,OAAO,KAAK,CAAC;QAEf,IAAI,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QACxE,IAAI,WAAW,GAAG,CAAC;YACjB,OAAO,KAAK,CAAC;QAEf,WAAW,EAAE,CAAC;QACd,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM;YAC/B,WAAW,GAAG,CAAC,CAAC;QAElB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Properties\n */\n\nimport {\n BasePropertyEditorParams, ColorEditorParams, ImageCheckBoxParams, PropertyEditorParams, PropertyEditorParamTypes, RangeEditorParams, SuppressLabelEditorParams,\n} from \"./EditorParams\";\nimport { StandardEditorNames } from \"./StandardEditorNames\";\nimport { StandardTypeNames } from \"./StandardTypeNames\";\n\n// cSpell:ignore Picklist\n\n/**\n * Information about an enumeration choice\n * @public\n */\nexport interface EnumerationChoice {\n label: string;\n value: string | number;\n}\n\n/**\n * Information about a set of enumeration choices\n * @public\n */\nexport interface EnumerationChoicesInfo {\n choices: Promise<EnumerationChoice[]> | EnumerationChoice[];\n isStrict?: boolean;\n maxDisplayedRows?: number;\n}\n\n/**\n * Property renderer identification and customization attributes\n * @public\n */\nexport interface PropertyRendererInfo {\n name: string;\n}\n\n/**\n * Information about a Property Editor\n * @public\n */\nexport interface PropertyEditorInfo {\n /** Editor name used in addition to the typename to find the registered property editor */\n name?: string;\n /** Editor params provided to the property editor */\n params?: PropertyEditorParams[];\n}\n\n/**\n * Information about a Property Converter\n * @public\n */\nexport interface PropertyConverterInfo {\n /** Converter name used in addition to the typename to find the registered property converter */\n name?: string;\n /** map of options for type converter */\n options?: { [key: string]: any };\n}\n\n/**\n * [[PropertyDescription]] contains metadata about a Property\n * @public\n */\nexport interface PropertyDescription {\n /** Name of the property description */\n name: string;\n /** Display label for the property description */\n displayLabel: string;\n /** Type name used to determine applicable Type Converter and Property Editor */\n typename: string;\n /** Additional information for enumerations */\n enum?: EnumerationChoicesInfo;\n /** Information for property renderer customization */\n renderer?: PropertyRendererInfo;\n /** Information for a property editor */\n editor?: PropertyEditorInfo;\n /** Information for a property converter */\n converter?: PropertyConverterInfo;\n /** Quantity type key used to look up formatting and parsing specs. This is typically either the name of a quantity type used by a tool\n * or the full name of a KOQ (schema:koq).\n * @alpha\n */\n quantityType?: string;\n /** Get the custom DataController by this name and register it with the property editor */\n dataController?: string;\n /**\n * Should property label for composite (struct & array) properties be rendered.\n * @alpha\n */\n hideCompositePropertyLabel?: boolean;\n}\n\n/** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.\n * @public\n */\nexport class PropertyDescriptionHelper {\n /** Builds a number description with a \"weight-picker\" editor name\n * @public\n */\n public static buildWeightPickerDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Number,\n editor: {\n name: StandardEditorNames.WeightPicker,\n params: additionalParams,\n },\n };\n }\n\n /** Builds an editor that uses [NumberInput]($core-react) control\n * @public\n */\n public static buildNumberEditorDescription(name: string, label: string, overrideParams?: RangeEditorParams, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const editorParams = [{\n type: PropertyEditorParamTypes.Range,\n step: 1,\n precision: 0,\n ...overrideParams,\n } as RangeEditorParams, ...additionalParams];\n\n const editor = {\n name: StandardEditorNames.NumericInput,\n params: editorParams,\n };\n\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Number,\n editor,\n };\n }\n\n /** Builds a string description\n * @public\n */\n public static buildTextEditorDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const editor = {\n params: additionalParams,\n };\n\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.String,\n editor,\n };\n }\n\n /** Builds an enum description\n * @public\n */\n public static buildEnumPicklistEditorDescription(name: string, label: string,\n choices: Promise<EnumerationChoice[]> | EnumerationChoice[],\n additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const editor = additionalParams.length ? {\n params: additionalParams,\n } : undefined;\n\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Enum,\n editor,\n enum: {\n choices,\n },\n };\n }\n\n /** Builds a number description for a tool settings or dialog property that will display a \"color-picker\" control.\n * @public\n */\n public static buildColorPickerDescription(name: string, label: string, colorValues: number[], numColumns: number,\n additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const editorParams = [\n {\n type: PropertyEditorParamTypes.ColorData,\n colorValues,\n numColumns,\n } as ColorEditorParams,\n ...additionalParams,\n ];\n\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Number,\n editor: {\n name: StandardEditorNames.ColorPicker,\n params: editorParams,\n },\n };\n }\n\n /** Builds a boolean description for a tool settings or dialog property that will display a \"toggle\" control.\n * @public\n */\n public static buildToggleDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Boolean,\n editor: {\n name: StandardEditorNames.Toggle,\n params: additionalParams,\n },\n };\n }\n\n /** Builds a boolean description for a tool settings or dialog property that will display a \"image-check-box\" control.\n * @public\n */\n public static buildImageCheckBoxDescription(name: string, label: string, imageOff: string, imageOn: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const editorParams = [{\n type: PropertyEditorParamTypes.CheckBoxImages,\n imageOff,\n imageOn,\n } as ImageCheckBoxParams, ...additionalParams];\n\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Boolean,\n editor: {\n name: StandardEditorNames.ImageCheckBox,\n params: editorParams,\n },\n };\n }\n\n /** Builds a boolean description for a tool settings or dialog property that will display a checkbox control.\n * @public\n */\n public static buildCheckboxDescription(name: string, label: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const editor = {\n params: additionalParams,\n };\n\n return {\n name,\n displayLabel: label,\n typename: StandardTypeNames.Boolean,\n editor,\n };\n }\n\n /** Builds a property description for a tool settings or dialog `lock` property. This will create a checkbox control with no label.\n * @public\n */\n public static buildLockPropertyDescription(name: string, additionalParams: BasePropertyEditorParams[] = []): PropertyDescription {\n const defaultParams = {\n type: PropertyEditorParamTypes.SuppressEditorLabel,\n suppressLabelPlaceholder: true,\n } as SuppressLabelEditorParams;\n\n const editor = {\n params: [defaultParams, ...additionalParams],\n };\n\n return {\n name,\n displayLabel: \"\",\n typename: StandardTypeNames.Boolean,\n editor,\n };\n }\n\n /** Bumps an enum property description value\n * @public\n */\n public static async bumpEnumProperty(description: PropertyDescription, value: string | number): Promise<string | number> {\n let choices: EnumerationChoice[] | undefined;\n\n if (description.enum) {\n if (description.enum.choices instanceof Promise) {\n choices = await description.enum.choices;\n } else {\n choices = description.enum.choices;\n }\n }\n\n if (!choices || choices.length === 0)\n return value;\n\n let choiceIndex = choices.findIndex((choice) => choice.value === value);\n if (choiceIndex < 0)\n return value;\n\n choiceIndex++;\n if (choiceIndex >= choices.length)\n choiceIndex = 0;\n\n const newValue = choices[choiceIndex].value;\n return newValue;\n }\n}\n"]}