@itwin/presentation-common 3.2.0-dev.9 → 3.3.0-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (303) hide show
  1. package/CHANGELOG.md +28 -1
  2. package/Ruleset.schema.json +304 -289
  3. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +13 -0
  4. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts.map +1 -0
  5. package/lib/cjs/presentation-common/CommonLoggerCategory.js +21 -0
  6. package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -0
  7. package/lib/cjs/presentation-common/EC.d.ts +36 -0
  8. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  9. package/lib/cjs/presentation-common/EC.js +38 -4
  10. package/lib/cjs/presentation-common/EC.js.map +1 -1
  11. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  12. package/lib/cjs/presentation-common/RpcRequestsHandler.js +26 -0
  13. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  14. package/lib/cjs/presentation-common/Utils.d.ts +0 -2
  15. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  16. package/lib/cjs/presentation-common/Utils.js +1 -25
  17. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  18. package/lib/cjs/presentation-common/content/Descriptor.d.ts +6 -6
  19. package/lib/cjs/presentation-common/content/Descriptor.js +1 -1
  20. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  21. package/lib/cjs/presentation-common/content/Fields.d.ts +3 -3
  22. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  23. package/lib/cjs/presentation-common/content/Fields.js +11 -3
  24. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  25. package/lib/cjs/presentation-common/content/Item.d.ts +3 -3
  26. package/lib/cjs/presentation-common/content/Item.js +1 -1
  27. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  28. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +7 -7
  29. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  30. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +10 -8
  31. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts.map +1 -1
  32. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  33. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +10 -62
  34. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts.map +1 -1
  35. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  36. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +20 -13
  37. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  38. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  39. package/lib/cjs/presentation-common/rules/Rule.d.ts +11 -12
  40. package/lib/cjs/presentation-common/rules/Rule.d.ts.map +1 -1
  41. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  42. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +6 -5
  43. package/lib/cjs/presentation-common/rules/Ruleset.d.ts.map +1 -1
  44. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  45. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +5 -2
  46. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts.map +1 -1
  47. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  48. package/lib/cjs/presentation-common/rules/Variables.d.ts +3 -3
  49. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  50. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +12 -14
  51. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts.map +1 -1
  52. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  53. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +6 -8
  54. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts.map +1 -1
  55. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  56. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +15 -10
  57. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts.map +1 -1
  58. package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
  59. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +9 -6
  60. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts.map +1 -1
  61. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  62. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +3 -4
  63. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts.map +1 -1
  64. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  65. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +56 -21
  66. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts.map +1 -1
  67. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  68. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +5 -10
  69. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts.map +1 -1
  70. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  71. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +7 -10
  72. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts.map +1 -1
  73. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  74. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +22 -12
  75. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts.map +1 -1
  76. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  77. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +8 -2
  78. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts.map +1 -1
  79. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  80. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +30 -10
  81. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  82. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  83. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +9 -4
  84. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts.map +1 -1
  85. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  86. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +25 -21
  87. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts.map +1 -1
  88. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +5 -7
  89. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  90. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +8 -11
  91. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts.map +1 -1
  92. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  93. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +1 -1
  94. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  95. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +9 -24
  96. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts.map +1 -1
  97. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  98. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +55 -72
  99. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts.map +1 -1
  100. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +1 -1
  101. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  102. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +9 -10
  103. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts.map +1 -1
  104. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  105. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +33 -22
  106. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  107. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +1 -1
  108. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  109. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +13 -16
  110. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts.map +1 -1
  111. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  112. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +16 -29
  113. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  114. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  115. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +11 -12
  116. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts.map +1 -1
  117. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  118. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +4 -5
  119. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts.map +1 -1
  120. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  121. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +30 -32
  122. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  123. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  124. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +11 -6
  125. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts.map +1 -1
  126. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  127. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +19 -20
  128. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts.map +1 -1
  129. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  130. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +14 -10
  131. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts.map +1 -1
  132. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  133. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +16 -15
  134. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  135. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  136. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +9 -28
  137. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts.map +1 -1
  138. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  139. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +8 -9
  140. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts.map +1 -1
  141. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  142. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +3 -4
  143. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts.map +1 -1
  144. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  145. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +17 -10
  146. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts.map +1 -1
  147. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  148. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +1 -1
  149. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  150. package/lib/cjs/presentation-common.d.ts +3 -3
  151. package/lib/cjs/presentation-common.js +3 -3
  152. package/lib/cjs/presentation-common.js.map +1 -1
  153. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +13 -0
  154. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts.map +1 -0
  155. package/lib/esm/presentation-common/CommonLoggerCategory.js +18 -0
  156. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -0
  157. package/lib/esm/presentation-common/EC.d.ts +36 -0
  158. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  159. package/lib/esm/presentation-common/EC.js +37 -3
  160. package/lib/esm/presentation-common/EC.js.map +1 -1
  161. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  162. package/lib/esm/presentation-common/RpcRequestsHandler.js +27 -1
  163. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  164. package/lib/esm/presentation-common/Utils.d.ts +0 -2
  165. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  166. package/lib/esm/presentation-common/Utils.js +0 -4
  167. package/lib/esm/presentation-common/Utils.js.map +1 -1
  168. package/lib/esm/presentation-common/content/Descriptor.d.ts +6 -6
  169. package/lib/esm/presentation-common/content/Descriptor.js +1 -1
  170. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  171. package/lib/esm/presentation-common/content/Fields.d.ts +3 -3
  172. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  173. package/lib/esm/presentation-common/content/Fields.js +11 -3
  174. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  175. package/lib/esm/presentation-common/content/Item.d.ts +3 -3
  176. package/lib/esm/presentation-common/content/Item.js +1 -1
  177. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  178. package/lib/esm/presentation-common/hierarchy/Node.d.ts +7 -7
  179. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  180. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +10 -8
  181. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts.map +1 -1
  182. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  183. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +10 -62
  184. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts.map +1 -1
  185. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  186. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +20 -13
  187. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  188. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  189. package/lib/esm/presentation-common/rules/Rule.d.ts +11 -12
  190. package/lib/esm/presentation-common/rules/Rule.d.ts.map +1 -1
  191. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  192. package/lib/esm/presentation-common/rules/Ruleset.d.ts +6 -5
  193. package/lib/esm/presentation-common/rules/Ruleset.d.ts.map +1 -1
  194. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  195. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +5 -2
  196. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts.map +1 -1
  197. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  198. package/lib/esm/presentation-common/rules/Variables.d.ts +3 -3
  199. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  200. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +12 -14
  201. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts.map +1 -1
  202. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  203. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +6 -8
  204. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts.map +1 -1
  205. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  206. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +15 -10
  207. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts.map +1 -1
  208. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  209. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +9 -6
  210. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts.map +1 -1
  211. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  212. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +3 -4
  213. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts.map +1 -1
  214. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  215. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +56 -21
  216. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts.map +1 -1
  217. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  218. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +5 -10
  219. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts.map +1 -1
  220. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  221. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +7 -10
  222. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts.map +1 -1
  223. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  224. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +22 -12
  225. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts.map +1 -1
  226. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  227. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +8 -2
  228. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts.map +1 -1
  229. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  230. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +30 -10
  231. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  232. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  233. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +9 -4
  234. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts.map +1 -1
  235. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  236. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +25 -21
  237. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts.map +1 -1
  238. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +5 -7
  239. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  240. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +8 -11
  241. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts.map +1 -1
  242. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  243. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +1 -1
  244. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  245. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +9 -24
  246. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts.map +1 -1
  247. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  248. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +55 -72
  249. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts.map +1 -1
  250. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +1 -1
  251. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  252. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +9 -10
  253. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts.map +1 -1
  254. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  255. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +33 -22
  256. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  257. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +1 -1
  258. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  259. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +13 -16
  260. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts.map +1 -1
  261. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  262. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +16 -29
  263. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  264. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  265. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +11 -12
  266. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts.map +1 -1
  267. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  268. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +4 -5
  269. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts.map +1 -1
  270. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  271. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +30 -32
  272. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  273. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  274. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +11 -6
  275. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts.map +1 -1
  276. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  277. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +19 -20
  278. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts.map +1 -1
  279. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  280. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +14 -10
  281. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts.map +1 -1
  282. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  283. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +16 -15
  284. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  285. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  286. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +9 -28
  287. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts.map +1 -1
  288. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  289. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +8 -9
  290. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts.map +1 -1
  291. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  292. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +3 -4
  293. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts.map +1 -1
  294. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  295. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +17 -10
  296. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts.map +1 -1
  297. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  298. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +1 -1
  299. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  300. package/lib/esm/presentation-common.d.ts +3 -3
  301. package/lib/esm/presentation-common.js +3 -3
  302. package/lib/esm/presentation-common.js.map +1 -1
  303. package/package.json +9 -10
@@ -1,41 +1,38 @@
1
1
  /** @packageDocumentation
2
2
  * @module PresentationRules
3
3
  */
4
- import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
4
+ import { RuleBase, RuleTypes } from "../Rule";
5
5
  /**
6
- * Rule to override labels and descriptions of nodes which pass rule's
7
- * condition.
6
+ * Label override rules provide advanced ways to override instance labels and descriptions in
7
+ * exchange of some performance penalty.
8
8
  *
9
- * **Important:** Prefer [[InstanceLabelOverride]] over this rule when possible as it
10
- * has better performance.
11
- *
12
- * @see [More details]($docs/presentation/Customization/LabelOverride.md)
9
+ * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)
13
10
  * @public
14
11
  * @deprecated Use [[InstanceLabelOverride]] rule instead.
15
12
  */
16
- export interface LabelOverride extends RuleBase, ConditionContainer {
13
+ export interface LabelOverride extends RuleBase {
17
14
  /** Used for serializing to JSON. */
18
15
  ruleType: RuleTypes.LabelOverride;
19
16
  /**
20
17
  * Defines a condition for the rule, which needs to be met in order to execute it. Condition
21
- * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
22
- * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).
18
+ * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
19
+ * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
23
20
  */
24
21
  condition?: string;
25
22
  /**
26
- * Defines the label that should be used for node. This is
27
- * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so label
23
+ * An expression whose result becomes the label. This is
24
+ * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label
28
25
  * can be defined/formatted dynamically based on the context - for example
29
- * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).
26
+ * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
30
27
  *
31
28
  * @minLength 1
32
29
  */
33
30
  label?: string;
34
31
  /**
35
- * Defines the description that should be used for node. This is
36
- * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so
32
+ * An expression whose result becomes the description. This is
33
+ * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so
37
34
  * description can be defined/formatted dynamically based on the context - for example
38
- * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).
35
+ * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
39
36
  *
40
37
  * @minLength 1
41
38
  */
@@ -1 +1 @@
1
- {"version":3,"file":"LabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,kBAAkB;IACjE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
1
+ {"version":3,"file":"LabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
@@ -1 +1 @@
1
- {"version":3,"file":"LabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.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 PresentationRules\r\n */\r\n\r\nimport { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule to override labels and descriptions of nodes which pass rule's\r\n * condition.\r\n *\r\n * **Important:** Prefer [[InstanceLabelOverride]] over this rule when possible as it\r\n * has better performance.\r\n *\r\n * @see [More details]($docs/presentation/Customization/LabelOverride.md)\r\n * @public\r\n * @deprecated Use [[InstanceLabelOverride]] rule instead.\r\n */\r\nexport interface LabelOverride extends RuleBase, ConditionContainer {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.LabelOverride;\r\n\r\n /**\r\n * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * Defines the label that should be used for node. This is\r\n * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so label\r\n * can be defined/formatted dynamically based on the context - for example\r\n * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n *\r\n * @minLength 1\r\n */\r\n label?: string;\r\n\r\n /**\r\n * Defines the description that should be used for node. This is\r\n * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so\r\n * description can be defined/formatted dynamically based on the context - for example\r\n * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n *\r\n * @minLength 1\r\n */\r\n description?: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"LabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.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 PresentationRules\r\n */\r\n\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Label override rules provide advanced ways to override instance labels and descriptions in\r\n * exchange of some performance penalty.\r\n *\r\n * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)\r\n * @public\r\n * @deprecated Use [[InstanceLabelOverride]] rule instead.\r\n */\r\nexport interface LabelOverride extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.LabelOverride;\r\n\r\n /**\r\n * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\r\n * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * An expression whose result becomes the label. This is\r\n * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label\r\n * can be defined/formatted dynamically based on the context - for example\r\n * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\r\n *\r\n * @minLength 1\r\n */\r\n label?: string;\r\n\r\n /**\r\n * An expression whose result becomes the description. This is\r\n * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so\r\n * description can be defined/formatted dynamically based on the context - for example\r\n * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\r\n *\r\n * @minLength 1\r\n */\r\n description?: string;\r\n}\r\n"]}
@@ -2,67 +2,54 @@
2
2
  * @module PresentationRules
3
3
  */
4
4
  import { SingleSchemaClassSpecification } from "../ClassSpecifications";
5
- import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
5
+ import { RuleBase, RuleTypes } from "../Rule";
6
6
  /**
7
- * Base class for all [[SortingRule]] implementations. Not
8
- * meant to be used directly, see `SortingRule`.
7
+ * Sorting rules provide a way to either disable sorting or sort instances by specific properties.
9
8
  *
9
+ * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
10
10
  * @public
11
11
  */
12
- export interface SortingRuleBase extends RuleBase, ConditionContainer {
12
+ export interface SortingRuleBase extends RuleBase {
13
13
  /**
14
- * Defines a condition for the rule, which needs to be met in order to execute it. Condition
15
- * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
16
- * a [limited set of symbols]($docs/presentation/Hierarchies/ECExpressions.md#rule-condition).
14
+ * Defines a condition which needs to be met in order for the rule to be used. The condition is an
15
+ * [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has to
16
+ * evaluate to a boolean value.
17
17
  */
18
18
  condition?: string;
19
- /**
20
- * Specification of ECClass whose ECInstances should be sorted by this rule.
21
- * Defaults to all classes in current context if not specified.
22
- */
19
+ /** Specifies ECClass whose ECInstances should be sorted. */
23
20
  class?: SingleSchemaClassSpecification;
24
- /** Should [[class]] defined in this rule be handled polymorphically. */
21
+ /** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */
25
22
  isPolymorphic?: boolean;
26
23
  }
27
24
  /**
28
- * Sorting rule implementations
25
+ * Sorting rules provide a way to either disable sorting or sort instances by specific properties.
29
26
  *
30
- * @see [More details]($docs/presentation/Customization/SortingRule.md)
27
+ * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
31
28
  * @public
32
29
  */
33
30
  export declare type SortingRule = PropertySortingRule | DisabledSortingRule;
34
31
  /**
35
- * Rule to configure sorting for certain ECInstances in the hierarchy and/or content.
36
- * It is possible to configure different sorting for different types of ECInstances.
37
- *
38
- * Multiple sorting rules may be applied for the same instances - in this case the
39
- * instances are first sorted by the highest priority rule and then the lower priority ones.
40
- *
41
- * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or
42
- * other non ECInstance type of nodes.
32
+ * Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.
43
33
  *
34
+ * @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)
44
35
  * @public
45
36
  */
46
37
  export interface PropertySortingRule extends SortingRuleBase {
47
38
  /** Used for serializing to JSON. */
48
39
  ruleType: RuleTypes.PropertySorting;
49
40
  /**
50
- * Name of the property which should be used for sorting
41
+ * Specifies name of the property which should be used for sorting.
51
42
  *
52
43
  * @minLength 1
53
44
  */
54
45
  propertyName: string;
55
- /** Will sort in ascending order if set to true, otherwise descending. Defaults to `true`. */
46
+ /** Specifies whether instances should be sorted in ascending order or descending. */
56
47
  sortAscending?: boolean;
57
48
  }
58
49
  /**
59
50
  * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.
60
51
  *
61
- * **Note:** Disabling sorting increases performance
62
- *
63
- * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or
64
- * other non ECInstance type of nodes.
65
- *
52
+ * @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)
66
53
  * @public
67
54
  */
68
55
  export interface DisabledSortingRule extends SortingRuleBase {
@@ -1 +1 @@
1
- {"version":3,"file":"SortingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,kBAAkB;IACnE;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,8BAA8B,CAAC;IAEvC,wEAAwE;IACxE,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,oBAAY,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,6FAA6F;IAC7F,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;CACrC"}
1
+ {"version":3,"file":"SortingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,8BAA8B,CAAC;IAEvC,iGAAiG;IACjG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,oBAAY,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;CACrC"}
@@ -1 +1 @@
1
- {"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.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 PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications\";\r\nimport { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Base class for all [[SortingRule]] implementations. Not\r\n * meant to be used directly, see `SortingRule`.\r\n *\r\n * @public\r\n */\r\nexport interface SortingRuleBase extends RuleBase, ConditionContainer {\r\n /**\r\n * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n * a [limited set of symbols]($docs/presentation/Hierarchies/ECExpressions.md#rule-condition).\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * Specification of ECClass whose ECInstances should be sorted by this rule.\r\n * Defaults to all classes in current context if not specified.\r\n */\r\n class?: SingleSchemaClassSpecification;\r\n\r\n /** Should [[class]] defined in this rule be handled polymorphically. */\r\n isPolymorphic?: boolean;\r\n}\r\n\r\n/**\r\n * Sorting rule implementations\r\n *\r\n * @see [More details]($docs/presentation/Customization/SortingRule.md)\r\n * @public\r\n */\r\nexport type SortingRule = PropertySortingRule | DisabledSortingRule;\r\n\r\n/**\r\n * Rule to configure sorting for certain ECInstances in the hierarchy and/or content.\r\n * It is possible to configure different sorting for different types of ECInstances.\r\n *\r\n * Multiple sorting rules may be applied for the same instances - in this case the\r\n * instances are first sorted by the highest priority rule and then the lower priority ones.\r\n *\r\n * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or\r\n * other non ECInstance type of nodes.\r\n *\r\n * @public\r\n */\r\nexport interface PropertySortingRule extends SortingRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.PropertySorting;\r\n\r\n /**\r\n * Name of the property which should be used for sorting\r\n *\r\n * @minLength 1\r\n */\r\n propertyName: string;\r\n\r\n /** Will sort in ascending order if set to true, otherwise descending. Defaults to `true`. */\r\n sortAscending?: boolean;\r\n}\r\n\r\n/**\r\n * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.\r\n *\r\n * **Note:** Disabling sorting increases performance\r\n *\r\n * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or\r\n * other non ECInstance type of nodes.\r\n *\r\n * @public\r\n */\r\nexport interface DisabledSortingRule extends SortingRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.DisabledSorting;\r\n}\r\n"]}
1
+ {"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.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 PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\r\n *\r\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\r\n * @public\r\n */\r\nexport interface SortingRuleBase extends RuleBase {\r\n /**\r\n * Defines a condition which needs to be met in order for the rule to be used. The condition is an\r\n * [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has to\r\n * evaluate to a boolean value.\r\n */\r\n condition?: string;\r\n\r\n /** Specifies ECClass whose ECInstances should be sorted. */\r\n class?: SingleSchemaClassSpecification;\r\n\r\n /** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */\r\n isPolymorphic?: boolean;\r\n}\r\n\r\n/**\r\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\r\n *\r\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\r\n * @public\r\n */\r\nexport type SortingRule = PropertySortingRule | DisabledSortingRule;\r\n\r\n/**\r\n * Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.\r\n *\r\n * @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)\r\n * @public\r\n */\r\nexport interface PropertySortingRule extends SortingRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.PropertySorting;\r\n\r\n /**\r\n * Specifies name of the property which should be used for sorting.\r\n *\r\n * @minLength 1\r\n */\r\n propertyName: string;\r\n\r\n /** Specifies whether instances should be sorted in ascending order or descending. */\r\n sortAscending?: boolean;\r\n}\r\n\r\n/**\r\n * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.\r\n *\r\n * @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)\r\n * @public\r\n */\r\nexport interface DisabledSortingRule extends SortingRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.DisabledSorting;\r\n}\r\n"]}
@@ -1,26 +1,25 @@
1
1
  /** @packageDocumentation
2
2
  * @module PresentationRules
3
3
  */
4
- import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
4
+ import { RuleBase, RuleTypes } from "../Rule";
5
5
  /**
6
- * Rule to override default node style and dynamically define a foreground/background
7
- * colors and a font style for a particular nodes.
6
+ * Style override rules allow customizing display style of specific types of ECInstances.
8
7
  *
9
- * @see [More details]($docs/presentation/Customization/StyleOverride.md)
8
+ * @see [Style override reference documentation page]($docs/presentation/customization/StyleOverride.md)
10
9
  * @public
11
- * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.
10
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
12
11
  */
13
- export interface StyleOverride extends RuleBase, ConditionContainer {
12
+ export interface StyleOverride extends RuleBase {
14
13
  /** Used for serializing to JSON. */
15
14
  ruleType: RuleTypes.StyleOverride;
16
15
  /**
17
16
  * Defines a condition for the rule, which needs to be met in order to execute it. Condition
18
- * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
19
- * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).
17
+ * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
18
+ * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
20
19
  */
21
20
  condition?: string;
22
21
  /**
23
- * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)
22
+ * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)
24
23
  * whose result would evaluate to one the following formats:
25
24
  * - color name (`Red`, `Blue`, etc.)
26
25
  * - `rgb(255, 255, 255)`
@@ -28,7 +27,7 @@ export interface StyleOverride extends RuleBase, ConditionContainer {
28
27
  */
29
28
  foreColor?: string;
30
29
  /**
31
- * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)
30
+ * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)
32
31
  * whose result would evaluate to one the following formats:
33
32
  * - color name (`Red`, `Blue`, etc.)
34
33
  * - `rgb(255, 255, 255)`
@@ -36,14 +35,14 @@ export interface StyleOverride extends RuleBase, ConditionContainer {
36
35
  */
37
36
  backColor?: string;
38
37
  /**
39
- * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)
38
+ * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)
40
39
  * whose result would evaluate to one the following values:
41
40
  * - `"Bold"`
42
41
  * - `"Italic"`
43
42
  * - `"Italic,Bold"`
44
43
  * - `"Regular"`
45
44
  *
46
- * Defaults to `"FontStyle.Regular"`.
45
+ * Defaults to `"Regular"`.
47
46
  */
48
47
  fontStyle?: string;
49
48
  }
@@ -1 +1 @@
1
- {"version":3,"file":"StyleOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,kBAAkB;IACjE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
1
+ {"version":3,"file":"StyleOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
@@ -1 +1 @@
1
- {"version":3,"file":"StyleOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.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 PresentationRules\r\n */\r\n\r\nimport { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule to override default node style and dynamically define a foreground/background\r\n * colors and a font style for a particular nodes.\r\n *\r\n * @see [More details]($docs/presentation/Customization/StyleOverride.md)\r\n * @public\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n */\r\nexport interface StyleOverride extends RuleBase, ConditionContainer {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.StyleOverride;\r\n\r\n /**\r\n * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)\r\n * whose result would evaluate to one the following formats:\r\n * - color name (`Red`, `Blue`, etc.)\r\n * - `rgb(255, 255, 255)`\r\n * - `#0F0F0F`\r\n */\r\n foreColor?: string;\r\n\r\n /**\r\n * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)\r\n * whose result would evaluate to one the following formats:\r\n * - color name (`Red`, `Blue`, etc.)\r\n * - `rgb(255, 255, 255)`\r\n * - `#0F0F0F`\r\n */\r\n backColor?: string;\r\n\r\n /**\r\n * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)\r\n * whose result would evaluate to one the following values:\r\n * - `\"Bold\"`\r\n * - `\"Italic\"`\r\n * - `\"Italic,Bold\"`\r\n * - `\"Regular\"`\r\n *\r\n * Defaults to `\"FontStyle.Regular\"`.\r\n */\r\n fontStyle?: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"StyleOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.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 PresentationRules\r\n */\r\n\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Style override rules allow customizing display style of specific types of ECInstances.\r\n *\r\n * @see [Style override reference documentation page]($docs/presentation/customization/StyleOverride.md)\r\n * @public\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\nexport interface StyleOverride extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.StyleOverride;\r\n\r\n /**\r\n * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\r\n * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)\r\n * whose result would evaluate to one the following formats:\r\n * - color name (`Red`, `Blue`, etc.)\r\n * - `rgb(255, 255, 255)`\r\n * - `#0F0F0F`\r\n */\r\n foreColor?: string;\r\n\r\n /**\r\n * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)\r\n * whose result would evaluate to one the following formats:\r\n * - color name (`Red`, `Blue`, etc.)\r\n * - `rgb(255, 255, 255)`\r\n * - `#0F0F0F`\r\n */\r\n backColor?: string;\r\n\r\n /**\r\n * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)\r\n * whose result would evaluate to one the following values:\r\n * - `\"Bold\"`\r\n * - `\"Italic\"`\r\n * - `\"Italic,Bold\"`\r\n * - `\"Regular\"`\r\n *\r\n * Defaults to `\"Regular\"`.\r\n */\r\n fontStyle?: string;\r\n}\r\n"]}
@@ -1,16 +1,15 @@
1
1
  /** @packageDocumentation
2
2
  * @module PresentationRules
3
3
  */
4
- import { ConditionContainer, RuleTypes } from "../Rule";
4
+ import { RuleTypes } from "../Rule";
5
5
  import { NavigationRuleBase } from "./NavigationRule";
6
6
  /**
7
- * Child node rules define nodes that are displayed at
8
- * each child hierarchy level.
7
+ * Child node rules are used to define child nodes in a hierarchy.
9
8
  *
10
- * @see [More details]($docs/presentation/Hierarchies/ChildNodeRule.md)
9
+ * @see [Child node rule reference documentation page]($docs/presentation/hierarchies/ChildNodeRule.md)
11
10
  * @public
12
11
  */
13
- export interface ChildNodeRule extends NavigationRuleBase, ConditionContainer {
12
+ export interface ChildNodeRule extends NavigationRuleBase {
14
13
  /** Used for serializing to JSON. */
15
14
  ruleType: RuleTypes.ChildNodes;
16
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ChildNodeRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB,EAAE,kBAAkB;IAC3E,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;CAChC"}
1
+ {"version":3,"file":"ChildNodeRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;CAChC"}
@@ -1 +1 @@
1
- {"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.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 PresentationRules\r\n */\r\n\r\nimport { ConditionContainer, RuleTypes } from \"../Rule\";\r\nimport { NavigationRuleBase } from \"./NavigationRule\";\r\n\r\n/**\r\n * Child node rules define nodes that are displayed at\r\n * each child hierarchy level.\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/ChildNodeRule.md)\r\n * @public\r\n */\r\nexport interface ChildNodeRule extends NavigationRuleBase, ConditionContainer {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.ChildNodes;\r\n}\r\n"]}
1
+ {"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.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 PresentationRules\r\n */\r\n\r\nimport { RuleTypes } from \"../Rule\";\r\nimport { NavigationRuleBase } from \"./NavigationRule\";\r\n\r\n/**\r\n * Child node rules are used to define child nodes in a hierarchy.\r\n *\r\n * @see [Child node rule reference documentation page]($docs/presentation/hierarchies/ChildNodeRule.md)\r\n * @public\r\n */\r\nexport interface ChildNodeRule extends NavigationRuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.ChildNodes;\r\n}\r\n"]}
@@ -18,82 +18,80 @@ export declare enum ChildNodeSpecificationTypes {
18
18
  CustomNode = "CustomNode"
19
19
  }
20
20
  /**
21
- * Base interface for all [[ChildNodeSpecification]] implementations. Not
22
- * meant to be used directly, see `ChildNodeSpecification`.
21
+ * Base interface for all [[ChildNodeSpecification]] implementations.
23
22
  *
23
+ * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)
24
24
  * @public
25
25
  */
26
26
  export interface ChildNodeSpecificationBase {
27
27
  /** Used for serializing to JSON. */
28
28
  specType: ChildNodeSpecificationTypes;
29
29
  /**
30
- * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.
30
+ * Controls the order in which specifications are handled specification with higher priority value is
31
+ * handled first. If priorities are equal, the specifications are handled in the order they appear in the
32
+ * ruleset.
31
33
  *
32
34
  * @type integer
33
35
  */
34
36
  priority?: number;
35
37
  /**
36
- * This tells the rules engine that nodes produced using this
37
- * specification always or never have children. Defaults to `Unknown`.
38
- *
39
- * **Note:** setting this flag to `Always` or `Never` improves performance.
38
+ * This attribute allows telling the engine that nodes created by this specification always or never have children.
40
39
  */
41
40
  hasChildren?: "Always" | "Never" | "Unknown";
42
41
  /**
43
- * Hide instance nodes provided by this specification and directly show nodes of its children.
44
- * This helps if you need to define related instance nodes of particular parent node that is not available in the
45
- * hierarchy.
42
+ * When `true`, instances nodes produced by this specification are omitted and their children appear one
43
+ * hierarchy level higher.
46
44
  */
47
45
  hideNodesInHierarchy?: boolean;
48
46
  /**
49
- * Hide nodes if they don't have children.
47
+ * Specifies whether nodes created through this specification should be hidden if they have no child nodes.
50
48
  */
51
49
  hideIfNoChildren?: boolean;
52
50
  /**
53
- * An [ECExpression]($docs/presentation/Hierarchies/ECExpressions.md#specification) which
54
- * indicates whether a node should be hidden or not.
55
- *
56
- * @note While the attribute provides much flexibility, it also has performance implications - it's
57
- * strongly suggested to first consider using `instanceFilter`, `hideNodesInHierarchy` or `hideIfNoChildren`
58
- * and only use `hideExpression` if none of them are sufficient.
51
+ * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates
52
+ * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level
53
+ * higher.
59
54
  */
60
55
  hideExpression?: string;
61
56
  /**
62
- * Set this flag to `true` to suppress default sorting of ECInstances returned by this specification.
63
- *
64
- * **Note:** setting this flag to `true` improves performance.
57
+ * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order
58
+ * of returned nodes is undefined.
65
59
  */
66
60
  doNotSort?: boolean;
67
61
  /**
68
- * Suppress similar ancestor nodes' checking when creating nodes based on this specification.
69
- *
70
- * By default we stop creating hierarchy at the node that has a similar ancestor representing
71
- * the same ECInstance and created using the same specification to prevent creating infinite
72
- * hierarchies. With this flag enabled, we allow up to 10 similar ancestors before we consider
73
- * the hierarchy infinite.
62
+ * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this
63
+ * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).
74
64
  *
75
65
  * @beta
76
66
  */
77
67
  suppressSimilarAncestorsCheck?: boolean;
78
- /** Specifications of related instances that can be used in nodes' creation. */
68
+ /**
69
+ * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used
70
+ * when creating the nodes.
71
+ */
79
72
  relatedInstances?: RelatedInstanceSpecification[];
80
- /** [Nested rule]($docs/presentation/Hierarchies/Terminology.md#nested-rule) specifications. */
73
+ /**
74
+ * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that
75
+ * allow creating child nodes without the need of supplying a condition to match the parent node.
76
+ */
81
77
  nestedRules?: ChildNodeRule[];
82
78
  }
83
79
  /**
84
80
  * A container of default grouping properties. Used for specifications that support
85
- * default grouping. Not meant to be used directly, see `ChildNodeSpecification`.
81
+ * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].
86
82
  *
87
83
  * @public
88
84
  */
89
85
  export interface DefaultGroupingPropertiesContainer {
90
- /** Group instances by ECClass. Defaults to `true`. */
86
+ /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */
91
87
  groupByClass?: boolean;
92
- /** Group instances by label. Defaults to `true`. */
88
+ /** Controls whether returned instances should be grouped by label. Defaults to `true`. */
93
89
  groupByLabel?: boolean;
94
90
  }
95
91
  /**
96
- * Navigation rule specifications that define what content the rule results in.
92
+ * Hierarchy rule specifications that define what nodes are going to be returned by the rule.
93
+ *
94
+ * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)
97
95
  * @public
98
96
  */
99
97
  export declare type ChildNodeSpecification = CustomNodeSpecification | InstanceNodesOfSpecificClassesSpecification | RelatedInstanceNodesSpecification | CustomQueryInstanceNodesSpecification;
@@ -1 +1 @@
1
- {"version":3,"file":"ChildNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAExF;;;GAGG;AACH,oBAAY,2BAA2B;IAErC,oBAAoB,yBAAyB;IAC7C,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;IACrD,UAAU,eAAe;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;;;;;OASG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD,+FAA+F;IAC/F,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IACjD,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,oDAAoD;IACpD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,oBAAY,sBAAsB,GAChC,uBAAuB,GAAG,2CAA2C,GACrE,iCAAiC,GAAG,qCAAqC,CAAC"}
1
+ {"version":3,"file":"ChildNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAExF;;;GAGG;AACH,oBAAY,2BAA2B;IAErC,oBAAoB,yBAAyB;IAC7C,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;IACrD,UAAU,eAAe;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7C;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD;;;OAGG;IACH,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IACjD,4FAA4F;IAC5F,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,0FAA0F;IAC1F,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;GAKG;AACH,oBAAY,sBAAsB,GAChC,uBAAuB,GAAG,2CAA2C,GACrE,iCAAiC,GAAG,qCAAqC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AASH;;;GAGG;AACH,MAAM,CAAN,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,2BAA2B;IAC3B,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EANW,2BAA2B,KAA3B,2BAA2B,QAMtC","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 PresentationRules\r\n */\r\n\r\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule\";\r\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification\";\r\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification\";\r\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification\";\r\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ChildNodeSpecification]]\r\n * @public\r\n */\r\nexport enum ChildNodeSpecificationTypes {\r\n // hierarchy specifications\r\n RelatedInstanceNodes = \"RelatedInstanceNodes\",\r\n InstanceNodesOfSpecificClasses = \"InstanceNodesOfSpecificClasses\",\r\n CustomQueryInstanceNodes = \"CustomQueryInstanceNodes\",\r\n CustomNode = \"CustomNode\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ChildNodeSpecification]] implementations. Not\r\n * meant to be used directly, see `ChildNodeSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ChildNodeSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ChildNodeSpecificationTypes;\r\n\r\n /**\r\n * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n\r\n /**\r\n * This tells the rules engine that nodes produced using this\r\n * specification always or never have children. Defaults to `Unknown`.\r\n *\r\n * **Note:** setting this flag to `Always` or `Never` improves performance.\r\n */\r\n hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\r\n\r\n /**\r\n * Hide instance nodes provided by this specification and directly show nodes of its children.\r\n * This helps if you need to define related instance nodes of particular parent node that is not available in the\r\n * hierarchy.\r\n */\r\n hideNodesInHierarchy?: boolean;\r\n\r\n /**\r\n * Hide nodes if they don't have children.\r\n */\r\n hideIfNoChildren?: boolean;\r\n\r\n /**\r\n * An [ECExpression]($docs/presentation/Hierarchies/ECExpressions.md#specification) which\r\n * indicates whether a node should be hidden or not.\r\n *\r\n * @note While the attribute provides much flexibility, it also has performance implications - it's\r\n * strongly suggested to first consider using `instanceFilter`, `hideNodesInHierarchy` or `hideIfNoChildren`\r\n * and only use `hideExpression` if none of them are sufficient.\r\n */\r\n hideExpression?: string;\r\n\r\n /**\r\n * Set this flag to `true` to suppress default sorting of ECInstances returned by this specification.\r\n *\r\n * **Note:** setting this flag to `true` improves performance.\r\n */\r\n doNotSort?: boolean;\r\n\r\n /**\r\n * Suppress similar ancestor nodes' checking when creating nodes based on this specification.\r\n *\r\n * By default we stop creating hierarchy at the node that has a similar ancestor representing\r\n * the same ECInstance and created using the same specification to prevent creating infinite\r\n * hierarchies. With this flag enabled, we allow up to 10 similar ancestors before we consider\r\n * the hierarchy infinite.\r\n *\r\n * @beta\r\n */\r\n suppressSimilarAncestorsCheck?: boolean;\r\n\r\n /** Specifications of related instances that can be used in nodes' creation. */\r\n relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n /** [Nested rule]($docs/presentation/Hierarchies/Terminology.md#nested-rule) specifications. */\r\n nestedRules?: ChildNodeRule[];\r\n}\r\n\r\n/**\r\n * A container of default grouping properties. Used for specifications that support\r\n * default grouping. Not meant to be used directly, see `ChildNodeSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface DefaultGroupingPropertiesContainer {\r\n /** Group instances by ECClass. Defaults to `true`. */\r\n groupByClass?: boolean;\r\n\r\n /** Group instances by label. Defaults to `true`. */\r\n groupByLabel?: boolean;\r\n}\r\n\r\n/**\r\n * Navigation rule specifications that define what content the rule results in.\r\n * @public\r\n */\r\nexport type ChildNodeSpecification =\r\n CustomNodeSpecification | InstanceNodesOfSpecificClassesSpecification |\r\n RelatedInstanceNodesSpecification | CustomQueryInstanceNodesSpecification;\r\n"]}
1
+ {"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AASH;;;GAGG;AACH,MAAM,CAAN,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,2BAA2B;IAC3B,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EANW,2BAA2B,KAA3B,2BAA2B,QAMtC","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 PresentationRules\r\n */\r\n\r\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule\";\r\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification\";\r\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification\";\r\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification\";\r\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ChildNodeSpecification]]\r\n * @public\r\n */\r\nexport enum ChildNodeSpecificationTypes {\r\n // hierarchy specifications\r\n RelatedInstanceNodes = \"RelatedInstanceNodes\",\r\n InstanceNodesOfSpecificClasses = \"InstanceNodesOfSpecificClasses\",\r\n CustomQueryInstanceNodes = \"CustomQueryInstanceNodes\",\r\n CustomNode = \"CustomNode\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ChildNodeSpecification]] implementations.\r\n *\r\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\r\n * @public\r\n */\r\nexport interface ChildNodeSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ChildNodeSpecificationTypes;\r\n\r\n /**\r\n * Controls the order in which specifications are handled specification with higher priority value is\r\n * handled first. If priorities are equal, the specifications are handled in the order they appear in the\r\n * ruleset.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n\r\n /**\r\n * This attribute allows telling the engine that nodes created by this specification always or never have children.\r\n */\r\n hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\r\n\r\n /**\r\n * When `true`, instances nodes produced by this specification are omitted and their children appear one\r\n * hierarchy level higher.\r\n */\r\n hideNodesInHierarchy?: boolean;\r\n\r\n /**\r\n * Specifies whether nodes created through this specification should be hidden if they have no child nodes.\r\n */\r\n hideIfNoChildren?: boolean;\r\n\r\n /**\r\n * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates\r\n * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\r\n * higher.\r\n */\r\n hideExpression?: string;\r\n\r\n /**\r\n * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\r\n * of returned nodes is undefined.\r\n */\r\n doNotSort?: boolean;\r\n\r\n /**\r\n * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\r\n * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).\r\n *\r\n * @beta\r\n */\r\n suppressSimilarAncestorsCheck?: boolean;\r\n\r\n /**\r\n * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used\r\n * when creating the nodes.\r\n */\r\n relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n /**\r\n * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that\r\n * allow creating child nodes without the need of supplying a condition to match the parent node.\r\n */\r\n nestedRules?: ChildNodeRule[];\r\n}\r\n\r\n/**\r\n * A container of default grouping properties. Used for specifications that support\r\n * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].\r\n *\r\n * @public\r\n */\r\nexport interface DefaultGroupingPropertiesContainer {\r\n /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */\r\n groupByClass?: boolean;\r\n\r\n /** Controls whether returned instances should be grouped by label. Defaults to `true`. */\r\n groupByLabel?: boolean;\r\n}\r\n\r\n/**\r\n * Hierarchy rule specifications that define what nodes are going to be returned by the rule.\r\n *\r\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\r\n * @public\r\n */\r\nexport type ChildNodeSpecification =\r\n CustomNodeSpecification | InstanceNodesOfSpecificClassesSpecification |\r\n RelatedInstanceNodesSpecification | CustomQueryInstanceNodesSpecification;\r\n"]}
@@ -3,25 +3,30 @@
3
3
  */
4
4
  import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from "./ChildNodeSpecification";
5
5
  /**
6
- * Creates a custom-defined node.
6
+ * Returns a static custom-defined node that's not based on an ECInstance.
7
7
  *
8
- * @see [More details]($docs/presentation/Hierarchies/CustomNode.md)
8
+ * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)
9
9
  * @public
10
10
  */
11
11
  export interface CustomNodeSpecification extends ChildNodeSpecificationBase {
12
12
  /** Used for serializing to JSON. */
13
13
  specType: ChildNodeSpecificationTypes.CustomNode;
14
- /** Type of the node. */
14
+ /** Specifies node type, which is assigned to node's key. */
15
15
  type: string;
16
16
  /**
17
- * Label of the node. May be [localized]($docs/presentation/Advanced/Localization.md).
17
+ * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).
18
18
  */
19
19
  label: string;
20
20
  /**
21
- * Description of the node. May be [localized]($docs/presentation/Advanced/Localization.md).
21
+ * Specifies the value of [[Node.description]] property, which is a string that may
22
+ * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose
23
+ * whether and how to surface this information to users.
22
24
  */
23
25
  description?: string;
24
- /** Id of the image to use for this custom node. */
26
+ /**
27
+ * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's
28
+ * up to the UI component to decide what to do with it.
29
+ */
25
30
  imageId?: string;
26
31
  }
27
32
  //# sourceMappingURL=CustomNodeSpecification.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CustomNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,UAAU,CAAC;IAEjD,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"CustomNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,UAAU,CAAC;IAEjD,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
@@ -1 +1 @@
1
- {"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.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 PresentationRules\r\n */\r\n\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Creates a custom-defined node.\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/CustomNode.md)\r\n * @public\r\n */\r\nexport interface CustomNodeSpecification extends ChildNodeSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ChildNodeSpecificationTypes.CustomNode;\r\n\r\n /** Type of the node. */\r\n type: string;\r\n\r\n /**\r\n * Label of the node. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n */\r\n label: string;\r\n\r\n /**\r\n * Description of the node. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n */\r\n description?: string;\r\n\r\n /** Id of the image to use for this custom node. */\r\n imageId?: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.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 PresentationRules\r\n */\r\n\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Returns a static custom-defined node that's not based on an ECInstance.\r\n *\r\n * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)\r\n * @public\r\n */\r\nexport interface CustomNodeSpecification extends ChildNodeSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ChildNodeSpecificationTypes.CustomNode;\r\n\r\n /** Specifies node type, which is assigned to node's key. */\r\n type: string;\r\n\r\n /**\r\n * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).\r\n */\r\n label: string;\r\n\r\n /**\r\n * Specifies the value of [[Node.description]] property, which is a string that may\r\n * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose\r\n * whether and how to surface this information to users.\r\n */\r\n description?: string;\r\n\r\n /**\r\n * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's\r\n * up to the UI component to decide what to do with it.\r\n */\r\n imageId?: string;\r\n}\r\n"]}