@itwin/presentation-common 3.6.0-dev.36 → 3.6.0-dev.38

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 (463) hide show
  1. package/lib/cjs/assets/locales/en/BisCore.json +18 -18
  2. package/lib/cjs/assets/locales/en/ECPresentation.json +9 -9
  3. package/lib/cjs/assets/locales/en/RulesEngine.json +5 -5
  4. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  5. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  6. package/lib/cjs/presentation-common/AsyncTasks.js.map +1 -1
  7. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  9. package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -1
  10. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  11. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  12. package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
  13. package/lib/cjs/presentation-common/EC.d.ts +315 -315
  14. package/lib/cjs/presentation-common/EC.js +270 -270
  15. package/lib/cjs/presentation-common/EC.js.map +1 -1
  16. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  17. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  18. package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
  19. package/lib/cjs/presentation-common/Error.d.ts +45 -45
  20. package/lib/cjs/presentation-common/Error.js +62 -62
  21. package/lib/cjs/presentation-common/Error.js.map +1 -1
  22. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +59 -59
  23. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.js.map +1 -1
  25. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  26. package/lib/cjs/presentation-common/KeySet.js +423 -423
  27. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  28. package/lib/cjs/presentation-common/LabelDefinition.d.ts +79 -79
  29. package/lib/cjs/presentation-common/LabelDefinition.js +76 -76
  30. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  31. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  32. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  33. package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
  34. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  35. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  36. package/lib/cjs/presentation-common/PresentationIpcInterface.js.map +1 -1
  37. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +250 -250
  38. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  39. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  40. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +181 -181
  41. package/lib/cjs/presentation-common/PresentationRpcInterface.js +102 -102
  42. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  43. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  44. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  45. package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
  46. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  47. package/lib/cjs/presentation-common/RpcRequestsHandler.js +155 -155
  48. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  49. package/lib/cjs/presentation-common/RulesetVariables.d.ts +166 -166
  50. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  51. package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
  52. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  53. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  54. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  55. package/lib/cjs/presentation-common/Update.d.ts +196 -196
  56. package/lib/cjs/presentation-common/Update.js +196 -196
  57. package/lib/cjs/presentation-common/Update.js.map +1 -1
  58. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  59. package/lib/cjs/presentation-common/Utils.js +43 -43
  60. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  61. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  62. package/lib/cjs/presentation-common/content/Category.js +49 -49
  63. package/lib/cjs/presentation-common/content/Category.js.map +1 -1
  64. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  65. package/lib/cjs/presentation-common/content/Content.js +56 -56
  66. package/lib/cjs/presentation-common/content/Content.js.map +1 -1
  67. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +101 -101
  68. package/lib/cjs/presentation-common/content/ContentTraverser.js +420 -420
  69. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  70. package/lib/cjs/presentation-common/content/Descriptor.d.ts +275 -275
  71. package/lib/cjs/presentation-common/content/Descriptor.js +195 -195
  72. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  73. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  74. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  75. package/lib/cjs/presentation-common/content/DisplayTypes.js.map +1 -1
  76. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  77. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  78. package/lib/cjs/presentation-common/content/Editor.js.map +1 -1
  79. package/lib/cjs/presentation-common/content/Fields.d.ts +282 -282
  80. package/lib/cjs/presentation-common/content/Fields.js +394 -394
  81. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  82. package/lib/cjs/presentation-common/content/Item.d.ts +87 -87
  83. package/lib/cjs/presentation-common/content/Item.js +86 -86
  84. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  85. package/lib/cjs/presentation-common/content/Property.d.ts +51 -51
  86. package/lib/cjs/presentation-common/content/Property.js +36 -36
  87. package/lib/cjs/presentation-common/content/Property.js.map +1 -1
  88. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  89. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  90. package/lib/cjs/presentation-common/content/Renderer.js.map +1 -1
  91. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  92. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  93. package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
  94. package/lib/cjs/presentation-common/content/Value.d.ts +157 -157
  95. package/lib/cjs/presentation-common/content/Value.js +217 -217
  96. package/lib/cjs/presentation-common/content/Value.js.map +1 -1
  97. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +185 -185
  98. package/lib/cjs/presentation-common/hierarchy/Key.js +112 -112
  99. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  100. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +141 -141
  101. package/lib/cjs/presentation-common/hierarchy/Node.js +97 -97
  102. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  103. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  104. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +98 -98
  105. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  106. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  107. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  108. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  109. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  110. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  111. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  112. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  113. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  114. package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
  115. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  116. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  117. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  118. package/lib/cjs/presentation-common/rules/Rule.d.ts +74 -74
  119. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  120. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  121. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +66 -66
  122. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  123. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  124. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  125. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  126. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  127. package/lib/cjs/presentation-common/rules/Variables.d.ts +55 -55
  128. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  129. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  130. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  131. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  132. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  133. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  134. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  135. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  136. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  137. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  138. package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
  139. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  140. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  141. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  142. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  143. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  144. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  145. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  146. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  147. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  148. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  149. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  150. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  151. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  152. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  153. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  154. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  155. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  156. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  157. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  158. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  159. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  160. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  161. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  162. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  163. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  164. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  165. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  166. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  167. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  168. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  169. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  170. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  171. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  172. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  173. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  174. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  175. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  176. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  177. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  178. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  179. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  180. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  181. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  182. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  183. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  184. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  185. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  186. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  187. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  188. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  189. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  190. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  191. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  192. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  193. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  194. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  195. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  196. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  197. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  198. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  199. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  200. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +22 -22
  201. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  202. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  203. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  204. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  205. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  206. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  207. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  208. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  209. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  210. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  211. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  212. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  213. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  214. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  215. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  216. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  217. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  218. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  219. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  220. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  221. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  222. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  223. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  224. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  225. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  226. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +25 -25
  227. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  228. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  229. package/lib/cjs/presentation-common.d.ts +111 -111
  230. package/lib/cjs/presentation-common.js +127 -127
  231. package/lib/cjs/presentation-common.js.map +1 -1
  232. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  233. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  234. package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
  235. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  236. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  237. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
  238. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  239. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  240. package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
  241. package/lib/esm/presentation-common/EC.d.ts +315 -315
  242. package/lib/esm/presentation-common/EC.js +267 -267
  243. package/lib/esm/presentation-common/EC.js.map +1 -1
  244. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  245. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  246. package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
  247. package/lib/esm/presentation-common/Error.d.ts +45 -45
  248. package/lib/esm/presentation-common/Error.js +58 -58
  249. package/lib/esm/presentation-common/Error.js.map +1 -1
  250. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +59 -59
  251. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  252. package/lib/esm/presentation-common/InstanceFilterDefinition.js.map +1 -1
  253. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  254. package/lib/esm/presentation-common/KeySet.js +419 -419
  255. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  256. package/lib/esm/presentation-common/LabelDefinition.d.ts +79 -79
  257. package/lib/esm/presentation-common/LabelDefinition.js +73 -73
  258. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  259. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  260. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  261. package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
  262. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  263. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  264. package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
  265. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +250 -250
  266. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  267. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  268. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +181 -181
  269. package/lib/esm/presentation-common/PresentationRpcInterface.js +98 -98
  270. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  271. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  272. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  273. package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
  274. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  275. package/lib/esm/presentation-common/RpcRequestsHandler.js +151 -151
  276. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  277. package/lib/esm/presentation-common/RulesetVariables.d.ts +166 -166
  278. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  279. package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
  280. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  281. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  282. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  283. package/lib/esm/presentation-common/Update.d.ts +196 -196
  284. package/lib/esm/presentation-common/Update.js +193 -193
  285. package/lib/esm/presentation-common/Update.js.map +1 -1
  286. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  287. package/lib/esm/presentation-common/Utils.js +39 -39
  288. package/lib/esm/presentation-common/Utils.js.map +1 -1
  289. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  290. package/lib/esm/presentation-common/content/Category.js +46 -46
  291. package/lib/esm/presentation-common/content/Category.js.map +1 -1
  292. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  293. package/lib/esm/presentation-common/content/Content.js +52 -52
  294. package/lib/esm/presentation-common/content/Content.js.map +1 -1
  295. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +101 -101
  296. package/lib/esm/presentation-common/content/ContentTraverser.js +411 -411
  297. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  298. package/lib/esm/presentation-common/content/Descriptor.d.ts +275 -275
  299. package/lib/esm/presentation-common/content/Descriptor.js +191 -191
  300. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  301. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  302. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  303. package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
  304. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  305. package/lib/esm/presentation-common/content/Editor.js +8 -8
  306. package/lib/esm/presentation-common/content/Editor.js.map +1 -1
  307. package/lib/esm/presentation-common/content/Fields.d.ts +282 -282
  308. package/lib/esm/presentation-common/content/Fields.js +387 -387
  309. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  310. package/lib/esm/presentation-common/content/Item.d.ts +87 -87
  311. package/lib/esm/presentation-common/content/Item.js +82 -82
  312. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  313. package/lib/esm/presentation-common/content/Property.d.ts +51 -51
  314. package/lib/esm/presentation-common/content/Property.js +33 -33
  315. package/lib/esm/presentation-common/content/Property.js.map +1 -1
  316. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  317. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  318. package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
  319. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  320. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  321. package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
  322. package/lib/esm/presentation-common/content/Value.d.ts +157 -157
  323. package/lib/esm/presentation-common/content/Value.js +214 -214
  324. package/lib/esm/presentation-common/content/Value.js.map +1 -1
  325. package/lib/esm/presentation-common/hierarchy/Key.d.ts +185 -185
  326. package/lib/esm/presentation-common/hierarchy/Key.js +109 -109
  327. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  328. package/lib/esm/presentation-common/hierarchy/Node.d.ts +141 -141
  329. package/lib/esm/presentation-common/hierarchy/Node.js +94 -94
  330. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  331. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  332. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +95 -95
  333. package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  334. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  335. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  336. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  337. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  338. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  339. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  340. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  341. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  342. package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
  343. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  344. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  345. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  346. package/lib/esm/presentation-common/rules/Rule.d.ts +74 -74
  347. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  348. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  349. package/lib/esm/presentation-common/rules/Ruleset.d.ts +66 -66
  350. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  351. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  352. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  353. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  354. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  355. package/lib/esm/presentation-common/rules/Variables.d.ts +55 -55
  356. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  357. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  358. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  359. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  360. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  361. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  362. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  363. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  364. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  365. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  366. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  367. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  368. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  369. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  370. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  371. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  372. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  373. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  374. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  375. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  376. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  377. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  378. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  379. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  380. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  381. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  382. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  383. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  384. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  385. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  386. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  387. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  388. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  389. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  390. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  391. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  392. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  393. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  394. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  395. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  396. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  397. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  398. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  399. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  400. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  401. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  402. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  403. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  404. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  405. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  406. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  407. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  408. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  409. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  410. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  411. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  412. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  413. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  414. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  415. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  416. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  417. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  418. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  419. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  420. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  421. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  422. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  423. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  424. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  425. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  426. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  427. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  428. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +19 -19
  429. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  430. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  431. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  432. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  433. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  434. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  435. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  436. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  437. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  438. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  439. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  440. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  441. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  442. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  443. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  444. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  445. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  446. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  447. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  448. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  449. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  450. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  451. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  452. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  453. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  454. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +25 -25
  455. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  456. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  457. package/lib/esm/presentation-common.d.ts +111 -111
  458. package/lib/esm/presentation-common.js +115 -115
  459. package/lib/esm/presentation-common.js.map +1 -1
  460. package/lib/public/locales/en/BisCore.json +18 -18
  461. package/lib/public/locales/en/ECPresentation.json +9 -9
  462. package/lib/public/locales/en/RulesEngine.json +5 -5
  463. package/package.json +9 -9
@@ -1,16 +1,16 @@
1
- /** @packageDocumentation
2
- * @module Content
3
- */
4
- /**
5
- * A data structure which describes property editor used
6
- * for a content [[Field]].
7
- *
8
- * @public
9
- */
10
- export interface EditorDescription {
11
- /** Unique name */
12
- name: string;
13
- /** Editor-specific parameters */
14
- params?: any;
15
- }
1
+ /** @packageDocumentation
2
+ * @module Content
3
+ */
4
+ /**
5
+ * A data structure which describes property editor used
6
+ * for a content [[Field]].
7
+ *
8
+ * @public
9
+ */
10
+ export interface EditorDescription {
11
+ /** Unique name */
12
+ name: string;
13
+ /** Editor-specific parameters */
14
+ params?: any;
15
+ }
16
16
  //# sourceMappingURL=Editor.d.ts.map
@@ -1,9 +1,9 @@
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 Content
7
- */
8
- export {};
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 Content
7
+ */
8
+ export {};
9
9
  //# sourceMappingURL=Editor.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Editor.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 Content\n */\n\n/**\n * A data structure which describes property editor used\n * for a content [[Field]].\n *\n * @public\n */\nexport interface EditorDescription {\n /** Unique name */\n name: string;\n /** Editor-specific parameters */\n params?: any;\n}\n"]}
1
+ {"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Editor.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 Content\r\n */\r\n\r\n/**\r\n * A data structure which describes property editor used\r\n * for a content [[Field]].\r\n *\r\n * @public\r\n */\r\nexport interface EditorDescription {\r\n /** Unique name */\r\n name: string;\r\n /** Editor-specific parameters */\r\n params?: any;\r\n}\r\n"]}
@@ -1,283 +1,283 @@
1
- /** @packageDocumentation
2
- * @module Content
3
- */
4
- import { Id64String } from "@itwin/core-bentley";
5
- import { ClassInfo, ClassInfoJSON, CompressedClassInfoJSON, RelationshipPath, RelationshipPathJSON, StrippedRelationshipPath } from "../EC";
6
- import { RelationshipMeaning } from "../rules/content/modifiers/RelatedPropertiesSpecification";
7
- import { CategoryDescription } from "./Category";
8
- import { EditorDescription } from "./Editor";
9
- import { Property, PropertyJSON } from "./Property";
10
- import { RendererDescription } from "./Renderer";
11
- import { TypeDescription } from "./TypeDescription";
12
- /**
13
- * Data structure for a [[Field]] serialized to JSON.
14
- * @public
15
- */
16
- export interface BaseFieldJSON {
17
- category: string;
18
- name: string;
19
- label: string;
20
- type: TypeDescription;
21
- isReadonly: boolean;
22
- priority: number;
23
- renderer?: RendererDescription;
24
- editor?: EditorDescription;
25
- }
26
- /**
27
- * Data structure for a [[PropertiesField]] serialized to JSON.
28
- * @public
29
- */
30
- export interface PropertiesFieldJSON<TClassInfoJSON = ClassInfoJSON> extends BaseFieldJSON {
31
- properties: PropertyJSON<TClassInfoJSON>[];
32
- }
33
- /**
34
- * Data structure for a [[NestedContentField]] serialized to JSON.
35
- * @public
36
- */
37
- export interface NestedContentFieldJSON<TClassInfoJSON = ClassInfoJSON> extends BaseFieldJSON {
38
- contentClassInfo: TClassInfoJSON;
39
- pathToPrimaryClass: RelationshipPathJSON<TClassInfoJSON>;
40
- /** @alpha */
41
- relationshipMeaning?: RelationshipMeaning;
42
- /** @alpha */
43
- actualPrimaryClassIds?: Id64String[];
44
- autoExpand?: boolean;
45
- nestedFields: FieldJSON<TClassInfoJSON>[];
46
- }
47
- /**
48
- * JSON representation of a [[Field]]
49
- * @public
50
- */
51
- export declare type FieldJSON<TClassInfoJSON = ClassInfoJSON> = BaseFieldJSON | PropertiesFieldJSON<TClassInfoJSON> | NestedContentFieldJSON<TClassInfoJSON>;
52
- /**
53
- * Describes a single content field. A field is usually represented as a grid column
54
- * or a property pane row.
55
- *
56
- * @public
57
- */
58
- export declare class Field {
59
- /** Category information */
60
- category: CategoryDescription;
61
- /** Unique name */
62
- name: string;
63
- /** Display label */
64
- label: string;
65
- /** Description of this field's values data type */
66
- type: TypeDescription;
67
- /** Are values in this field read-only */
68
- isReadonly: boolean;
69
- /** Priority of the field. Higher priority fields should appear first in the UI */
70
- priority: number;
71
- /** Property renderer used to render values of this field */
72
- renderer?: RendererDescription;
73
- /** Property editor used to edit values of this field */
74
- editor?: EditorDescription;
75
- /** Parent field */
76
- private _parent?;
77
- /**
78
- * Creates an instance of Field.
79
- * @param category Category information
80
- * @param name Unique name
81
- * @param label Display label
82
- * @param type Description of this field's values data type
83
- * @param isReadonly Are values in this field read-only
84
- * @param priority Priority of the field
85
- * @param editor Property editor used to edit values of this field
86
- * @param renderer Property renderer used to render values of this field
87
- */
88
- constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, isReadonly: boolean, priority: number, editor?: EditorDescription, renderer?: RendererDescription);
89
- /**
90
- * Is this a [[PropertiesField]]
91
- */
92
- isPropertiesField(): this is PropertiesField;
93
- /**
94
- * Is this a [[NestedContentField]]
95
- */
96
- isNestedContentField(): this is NestedContentField;
97
- /**
98
- * Get parent
99
- */
100
- get parent(): NestedContentField | undefined;
101
- clone(): Field;
102
- /** Serialize this object to JSON */
103
- toJSON(): FieldJSON;
104
- /** Serialize this object to compressed JSON */
105
- toCompressedJSON(classesMap: {
106
- [id: string]: CompressedClassInfoJSON;
107
- }): FieldJSON<string>;
108
- /** Deserialize [[Field]] from JSON */
109
- static fromJSON(json: FieldJSON | undefined, categories: CategoryDescription[]): Field | undefined;
110
- /**
111
- * Deserialize a [[Field]] from compressed JSON.
112
- * @public
113
- */
114
- static fromCompressedJSON(json: FieldJSON<string> | undefined, classesMap: {
115
- [id: string]: CompressedClassInfoJSON;
116
- }, categories: CategoryDescription[]): Field | undefined;
117
- protected static getCategoryFromFieldJson(fieldJson: FieldJSON, categories: CategoryDescription[]): CategoryDescription;
118
- /** @internal */
119
- resetParentship(): void;
120
- /** @internal */
121
- rebuildParentship(parentField?: NestedContentField): void;
122
- /**
123
- * Get descriptor for this field.
124
- * @public
125
- */
126
- getFieldDescriptor(): FieldDescriptor;
127
- }
128
- /**
129
- * Describes a content field that's based on one or more similar
130
- * EC properties.
131
- *
132
- * @public
133
- */
134
- export declare class PropertiesField extends Field {
135
- /** A list of properties this field is created from */
136
- properties: Property[];
137
- /**
138
- * Creates an instance of PropertiesField.
139
- * @param category Category information
140
- * @param name Unique name
141
- * @param label Display label
142
- * @param type Description of this field's values data type
143
- * @param isReadonly Are values in this field read-only
144
- * @param priority Priority of the field
145
- * @param properties A list of properties this field is created from
146
- * @param editor Property editor used to edit values of this field
147
- * @param renderer Property renderer used to render values of this field
148
- */
149
- constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
150
- clone(): PropertiesField;
151
- /** Serialize this object to JSON */
152
- toJSON(): PropertiesFieldJSON;
153
- /** Deserialize [[PropertiesField]] from JSON */
154
- static fromJSON(json: PropertiesFieldJSON | undefined, categories: CategoryDescription[]): PropertiesField | undefined;
155
- /**
156
- * Deserialize a [[PropertiesField]] from compressed JSON.
157
- * @public
158
- */
159
- static fromCompressedJSON(json: PropertiesFieldJSON<Id64String>, classesMap: {
160
- [id: string]: CompressedClassInfoJSON;
161
- }, categories: CategoryDescription[]): PropertiesField | undefined;
162
- /**
163
- * Get descriptor for this field.
164
- * @public
165
- */
166
- getFieldDescriptor(): FieldDescriptor;
167
- }
168
- /**
169
- * Describes a content field that contains [Nested content]($docs/presentation/content/Terminology#nested-content).
170
- *
171
- * @public
172
- */
173
- export declare class NestedContentField extends Field {
174
- /** Information about an ECClass whose properties are nested inside this field */
175
- contentClassInfo: ClassInfo;
176
- /** Relationship path to [Primary class]($docs/presentation/content/Terminology#primary-class) */
177
- pathToPrimaryClass: RelationshipPath;
178
- /** @alpha */
179
- relationshipMeaning: RelationshipMeaning;
180
- /** @alpha */
181
- actualPrimaryClassIds: Id64String[];
182
- /** Contained nested fields */
183
- nestedFields: Field[];
184
- /** Flag specifying whether field should be expanded */
185
- autoExpand?: boolean;
186
- /**
187
- * Creates an instance of NestedContentField.
188
- * @param category Category information
189
- * @param name Unique name
190
- * @param label Display label
191
- * @param type Description of this field's values data type
192
- * @param isReadonly Are values in this field read-only
193
- * @param priority Priority of the field
194
- * @param contentClassInfo Information about an ECClass whose properties are nested inside this field
195
- * @param pathToPrimaryClass Relationship path to [Primary class]($docs/presentation/content/Terminology#primary-class)
196
- * @param nestedFields Contained nested fields
197
- * @param editor Property editor used to edit values of this field
198
- * @param autoExpand Flag specifying whether field should be expanded
199
- * @param relationshipMeaning RelationshipMeaning of the field
200
- * @param renderer Property renderer used to render values of this field
201
- */
202
- constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, contentClassInfo: ClassInfo, pathToPrimaryClass: RelationshipPath, nestedFields: Field[], editor?: EditorDescription, autoExpand?: boolean, renderer?: RendererDescription);
203
- clone(): NestedContentField;
204
- /**
205
- * Get field by its name
206
- * @param name Name of the field to find
207
- * @param recurse Recurse into nested fields
208
- */
209
- getFieldByName(name: string, recurse?: boolean): Field | undefined;
210
- /** Serialize this object to JSON */
211
- toJSON(): NestedContentFieldJSON;
212
- /** Deserialize [[NestedContentField]] from JSON */
213
- static fromJSON(json: NestedContentFieldJSON | undefined, categories: CategoryDescription[]): NestedContentField | undefined;
214
- /**
215
- * Deserialize a [[NestedContentField]] from compressed JSON.
216
- * @public
217
- */
218
- static fromCompressedJSON(json: NestedContentFieldJSON<Id64String>, classesMap: {
219
- [id: string]: CompressedClassInfoJSON;
220
- }, categories: CategoryDescription[]): any;
221
- private static fromCommonJSON;
222
- /** @internal */
223
- resetParentship(): void;
224
- /** @internal */
225
- rebuildParentship(parentField?: NestedContentField): void;
226
- }
227
- /** @internal */
228
- export declare const getFieldByName: (fields: Field[], name: string | undefined, recurse?: boolean | undefined) => Field | undefined;
229
- /**
230
- * Types of different field descriptors.
231
- * @public
232
- */
233
- export declare enum FieldDescriptorType {
234
- Name = "name",
235
- Properties = "properties"
236
- }
237
- /**
238
- * Base for a field descriptor
239
- * @public
240
- */
241
- export interface FieldDescriptorBase {
242
- type: FieldDescriptorType;
243
- }
244
- /**
245
- * A union of all possible field descriptor types
246
- * @public
247
- */
248
- export declare type FieldDescriptor = NamedFieldDescriptor | PropertiesFieldDescriptor;
249
- /** @public */
250
- export declare namespace FieldDescriptor {
251
- /** Is this a named field descriptor */
252
- function isNamed(d: FieldDescriptor): d is NamedFieldDescriptor;
253
- /** Is this a properties field descriptor */
254
- function isProperties(d: FieldDescriptor): d is PropertiesFieldDescriptor;
255
- }
256
- /**
257
- * Field descriptor that identifies a content field by its unique name.
258
- * @public
259
- */
260
- export interface NamedFieldDescriptor extends FieldDescriptorBase {
261
- type: FieldDescriptorType.Name;
262
- fieldName: string;
263
- }
264
- /**
265
- * Field descriptor that identifies a properties field using a list of
266
- * properties that the field contains.
267
- * @public
268
- */
269
- export interface PropertiesFieldDescriptor extends FieldDescriptorBase {
270
- type: FieldDescriptorType.Properties;
271
- pathFromSelectToPropertyClass: StrippedRelationshipPath;
272
- /**
273
- * A list of properties that describe the field. At least one property in the list must
274
- * match at least one property in the field for the descriptor to be considered matching.
275
- */
276
- properties: Array<{
277
- /** Full class name */
278
- class: string;
279
- /** Property name */
280
- name: string;
281
- }>;
282
- }
1
+ /** @packageDocumentation
2
+ * @module Content
3
+ */
4
+ import { Id64String } from "@itwin/core-bentley";
5
+ import { ClassInfo, ClassInfoJSON, CompressedClassInfoJSON, RelationshipPath, RelationshipPathJSON, StrippedRelationshipPath } from "../EC";
6
+ import { RelationshipMeaning } from "../rules/content/modifiers/RelatedPropertiesSpecification";
7
+ import { CategoryDescription } from "./Category";
8
+ import { EditorDescription } from "./Editor";
9
+ import { Property, PropertyJSON } from "./Property";
10
+ import { RendererDescription } from "./Renderer";
11
+ import { TypeDescription } from "./TypeDescription";
12
+ /**
13
+ * Data structure for a [[Field]] serialized to JSON.
14
+ * @public
15
+ */
16
+ export interface BaseFieldJSON {
17
+ category: string;
18
+ name: string;
19
+ label: string;
20
+ type: TypeDescription;
21
+ isReadonly: boolean;
22
+ priority: number;
23
+ renderer?: RendererDescription;
24
+ editor?: EditorDescription;
25
+ }
26
+ /**
27
+ * Data structure for a [[PropertiesField]] serialized to JSON.
28
+ * @public
29
+ */
30
+ export interface PropertiesFieldJSON<TClassInfoJSON = ClassInfoJSON> extends BaseFieldJSON {
31
+ properties: PropertyJSON<TClassInfoJSON>[];
32
+ }
33
+ /**
34
+ * Data structure for a [[NestedContentField]] serialized to JSON.
35
+ * @public
36
+ */
37
+ export interface NestedContentFieldJSON<TClassInfoJSON = ClassInfoJSON> extends BaseFieldJSON {
38
+ contentClassInfo: TClassInfoJSON;
39
+ pathToPrimaryClass: RelationshipPathJSON<TClassInfoJSON>;
40
+ /** @alpha */
41
+ relationshipMeaning?: RelationshipMeaning;
42
+ /** @alpha */
43
+ actualPrimaryClassIds?: Id64String[];
44
+ autoExpand?: boolean;
45
+ nestedFields: FieldJSON<TClassInfoJSON>[];
46
+ }
47
+ /**
48
+ * JSON representation of a [[Field]]
49
+ * @public
50
+ */
51
+ export declare type FieldJSON<TClassInfoJSON = ClassInfoJSON> = BaseFieldJSON | PropertiesFieldJSON<TClassInfoJSON> | NestedContentFieldJSON<TClassInfoJSON>;
52
+ /**
53
+ * Describes a single content field. A field is usually represented as a grid column
54
+ * or a property pane row.
55
+ *
56
+ * @public
57
+ */
58
+ export declare class Field {
59
+ /** Category information */
60
+ category: CategoryDescription;
61
+ /** Unique name */
62
+ name: string;
63
+ /** Display label */
64
+ label: string;
65
+ /** Description of this field's values data type */
66
+ type: TypeDescription;
67
+ /** Are values in this field read-only */
68
+ isReadonly: boolean;
69
+ /** Priority of the field. Higher priority fields should appear first in the UI */
70
+ priority: number;
71
+ /** Property renderer used to render values of this field */
72
+ renderer?: RendererDescription;
73
+ /** Property editor used to edit values of this field */
74
+ editor?: EditorDescription;
75
+ /** Parent field */
76
+ private _parent?;
77
+ /**
78
+ * Creates an instance of Field.
79
+ * @param category Category information
80
+ * @param name Unique name
81
+ * @param label Display label
82
+ * @param type Description of this field's values data type
83
+ * @param isReadonly Are values in this field read-only
84
+ * @param priority Priority of the field
85
+ * @param editor Property editor used to edit values of this field
86
+ * @param renderer Property renderer used to render values of this field
87
+ */
88
+ constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, isReadonly: boolean, priority: number, editor?: EditorDescription, renderer?: RendererDescription);
89
+ /**
90
+ * Is this a [[PropertiesField]]
91
+ */
92
+ isPropertiesField(): this is PropertiesField;
93
+ /**
94
+ * Is this a [[NestedContentField]]
95
+ */
96
+ isNestedContentField(): this is NestedContentField;
97
+ /**
98
+ * Get parent
99
+ */
100
+ get parent(): NestedContentField | undefined;
101
+ clone(): Field;
102
+ /** Serialize this object to JSON */
103
+ toJSON(): FieldJSON;
104
+ /** Serialize this object to compressed JSON */
105
+ toCompressedJSON(classesMap: {
106
+ [id: string]: CompressedClassInfoJSON;
107
+ }): FieldJSON<string>;
108
+ /** Deserialize [[Field]] from JSON */
109
+ static fromJSON(json: FieldJSON | undefined, categories: CategoryDescription[]): Field | undefined;
110
+ /**
111
+ * Deserialize a [[Field]] from compressed JSON.
112
+ * @public
113
+ */
114
+ static fromCompressedJSON(json: FieldJSON<string> | undefined, classesMap: {
115
+ [id: string]: CompressedClassInfoJSON;
116
+ }, categories: CategoryDescription[]): Field | undefined;
117
+ protected static getCategoryFromFieldJson(fieldJson: FieldJSON, categories: CategoryDescription[]): CategoryDescription;
118
+ /** @internal */
119
+ resetParentship(): void;
120
+ /** @internal */
121
+ rebuildParentship(parentField?: NestedContentField): void;
122
+ /**
123
+ * Get descriptor for this field.
124
+ * @public
125
+ */
126
+ getFieldDescriptor(): FieldDescriptor;
127
+ }
128
+ /**
129
+ * Describes a content field that's based on one or more similar
130
+ * EC properties.
131
+ *
132
+ * @public
133
+ */
134
+ export declare class PropertiesField extends Field {
135
+ /** A list of properties this field is created from */
136
+ properties: Property[];
137
+ /**
138
+ * Creates an instance of PropertiesField.
139
+ * @param category Category information
140
+ * @param name Unique name
141
+ * @param label Display label
142
+ * @param type Description of this field's values data type
143
+ * @param isReadonly Are values in this field read-only
144
+ * @param priority Priority of the field
145
+ * @param properties A list of properties this field is created from
146
+ * @param editor Property editor used to edit values of this field
147
+ * @param renderer Property renderer used to render values of this field
148
+ */
149
+ constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
150
+ clone(): PropertiesField;
151
+ /** Serialize this object to JSON */
152
+ toJSON(): PropertiesFieldJSON;
153
+ /** Deserialize [[PropertiesField]] from JSON */
154
+ static fromJSON(json: PropertiesFieldJSON | undefined, categories: CategoryDescription[]): PropertiesField | undefined;
155
+ /**
156
+ * Deserialize a [[PropertiesField]] from compressed JSON.
157
+ * @public
158
+ */
159
+ static fromCompressedJSON(json: PropertiesFieldJSON<Id64String>, classesMap: {
160
+ [id: string]: CompressedClassInfoJSON;
161
+ }, categories: CategoryDescription[]): PropertiesField | undefined;
162
+ /**
163
+ * Get descriptor for this field.
164
+ * @public
165
+ */
166
+ getFieldDescriptor(): FieldDescriptor;
167
+ }
168
+ /**
169
+ * Describes a content field that contains [Nested content]($docs/presentation/content/Terminology#nested-content).
170
+ *
171
+ * @public
172
+ */
173
+ export declare class NestedContentField extends Field {
174
+ /** Information about an ECClass whose properties are nested inside this field */
175
+ contentClassInfo: ClassInfo;
176
+ /** Relationship path to [Primary class]($docs/presentation/content/Terminology#primary-class) */
177
+ pathToPrimaryClass: RelationshipPath;
178
+ /** @alpha */
179
+ relationshipMeaning: RelationshipMeaning;
180
+ /** @alpha */
181
+ actualPrimaryClassIds: Id64String[];
182
+ /** Contained nested fields */
183
+ nestedFields: Field[];
184
+ /** Flag specifying whether field should be expanded */
185
+ autoExpand?: boolean;
186
+ /**
187
+ * Creates an instance of NestedContentField.
188
+ * @param category Category information
189
+ * @param name Unique name
190
+ * @param label Display label
191
+ * @param type Description of this field's values data type
192
+ * @param isReadonly Are values in this field read-only
193
+ * @param priority Priority of the field
194
+ * @param contentClassInfo Information about an ECClass whose properties are nested inside this field
195
+ * @param pathToPrimaryClass Relationship path to [Primary class]($docs/presentation/content/Terminology#primary-class)
196
+ * @param nestedFields Contained nested fields
197
+ * @param editor Property editor used to edit values of this field
198
+ * @param autoExpand Flag specifying whether field should be expanded
199
+ * @param relationshipMeaning RelationshipMeaning of the field
200
+ * @param renderer Property renderer used to render values of this field
201
+ */
202
+ constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, contentClassInfo: ClassInfo, pathToPrimaryClass: RelationshipPath, nestedFields: Field[], editor?: EditorDescription, autoExpand?: boolean, renderer?: RendererDescription);
203
+ clone(): NestedContentField;
204
+ /**
205
+ * Get field by its name
206
+ * @param name Name of the field to find
207
+ * @param recurse Recurse into nested fields
208
+ */
209
+ getFieldByName(name: string, recurse?: boolean): Field | undefined;
210
+ /** Serialize this object to JSON */
211
+ toJSON(): NestedContentFieldJSON;
212
+ /** Deserialize [[NestedContentField]] from JSON */
213
+ static fromJSON(json: NestedContentFieldJSON | undefined, categories: CategoryDescription[]): NestedContentField | undefined;
214
+ /**
215
+ * Deserialize a [[NestedContentField]] from compressed JSON.
216
+ * @public
217
+ */
218
+ static fromCompressedJSON(json: NestedContentFieldJSON<Id64String>, classesMap: {
219
+ [id: string]: CompressedClassInfoJSON;
220
+ }, categories: CategoryDescription[]): any;
221
+ private static fromCommonJSON;
222
+ /** @internal */
223
+ resetParentship(): void;
224
+ /** @internal */
225
+ rebuildParentship(parentField?: NestedContentField): void;
226
+ }
227
+ /** @internal */
228
+ export declare const getFieldByName: (fields: Field[], name: string | undefined, recurse?: boolean | undefined) => Field | undefined;
229
+ /**
230
+ * Types of different field descriptors.
231
+ * @public
232
+ */
233
+ export declare enum FieldDescriptorType {
234
+ Name = "name",
235
+ Properties = "properties"
236
+ }
237
+ /**
238
+ * Base for a field descriptor
239
+ * @public
240
+ */
241
+ export interface FieldDescriptorBase {
242
+ type: FieldDescriptorType;
243
+ }
244
+ /**
245
+ * A union of all possible field descriptor types
246
+ * @public
247
+ */
248
+ export declare type FieldDescriptor = NamedFieldDescriptor | PropertiesFieldDescriptor;
249
+ /** @public */
250
+ export declare namespace FieldDescriptor {
251
+ /** Is this a named field descriptor */
252
+ function isNamed(d: FieldDescriptor): d is NamedFieldDescriptor;
253
+ /** Is this a properties field descriptor */
254
+ function isProperties(d: FieldDescriptor): d is PropertiesFieldDescriptor;
255
+ }
256
+ /**
257
+ * Field descriptor that identifies a content field by its unique name.
258
+ * @public
259
+ */
260
+ export interface NamedFieldDescriptor extends FieldDescriptorBase {
261
+ type: FieldDescriptorType.Name;
262
+ fieldName: string;
263
+ }
264
+ /**
265
+ * Field descriptor that identifies a properties field using a list of
266
+ * properties that the field contains.
267
+ * @public
268
+ */
269
+ export interface PropertiesFieldDescriptor extends FieldDescriptorBase {
270
+ type: FieldDescriptorType.Properties;
271
+ pathFromSelectToPropertyClass: StrippedRelationshipPath;
272
+ /**
273
+ * A list of properties that describe the field. At least one property in the list must
274
+ * match at least one property in the field for the descriptor to be considered matching.
275
+ */
276
+ properties: Array<{
277
+ /** Full class name */
278
+ class: string;
279
+ /** Property name */
280
+ name: string;
281
+ }>;
282
+ }
283
283
  //# sourceMappingURL=Fields.d.ts.map