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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -4,40 +4,38 @@
4
4
  import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
5
5
  import { ContentSpecificationBase, ContentSpecificationTypes } from "./ContentSpecification";
6
6
  /**
7
- * Creates content for ECInstance(s) of specified classes.
7
+ * This specification creates content for all instances of specific ECClasses.
8
8
  *
9
- * **Note**: this specification doesn't rely on selection. It always returns instances no matter
10
- * what the selection is, so pre-filtering should be done in [[ContentRule]] condition and [[instanceFilter]].
11
- *
12
- * @see [More details]($docs/presentation/Content/ContentInstancesOfSpecificClasses.md)
9
+ * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)
13
10
  * @public
14
11
  */
15
12
  export interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {
16
13
  /** Used for serializing to JSON. */
17
14
  specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses;
18
15
  /**
19
- * List of ECClass specifications whose ECInstances should be selected.
16
+ * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which
17
+ * ECClasses need to be selected to form the result.
20
18
  */
21
19
  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
22
20
  /**
23
- * List of ECClass specifications whose ECInstances should be excluded.
21
+ * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified
22
+ * ECClasses and subclasses from being selected by [[classes]] attribute.
24
23
  */
25
24
  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
26
25
  /**
27
- * Whether to get content from instances of derived `classes`.
28
- * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].
26
+ * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]
27
+ * attributes should be polymorphic or not.
28
+ *
29
29
  * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].
30
30
  */
31
31
  handleInstancesPolymorphically?: boolean;
32
32
  /**
33
- * Whether to get content from properties of derived `classes`. If `true`, properties from `classes` with no instances
34
- * do not appear in the result set.
33
+ * Specifies whether properties of derived [[classes]] should be included in the content.
35
34
  */
36
35
  handlePropertiesPolymorphically?: boolean;
37
36
  /**
38
- * Condition for filtering instances of defined classes.
39
- *
40
- * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
37
+ * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
38
+ * of ECClasses specified through the [[classes]] attribute.
41
39
  */
42
40
  instanceFilter?: string;
43
41
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,WAAW,8CAA+C,SAAQ,wBAAwB;IAC9F,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,iCAAiC,CAAC;IAEtE;;OAEG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;OAIG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;;OAGG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
1
+ {"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,8CAA+C,SAAQ,wBAAwB;IAC9F,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,iCAAiC,CAAC;IAEtE;;;OAGG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;;OAGG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
@@ -1 +1 @@
1
- {"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.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 { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for ECInstance(s) of specified classes.\r\n *\r\n * **Note**: this specification doesn't rely on selection. It always returns instances no matter\r\n * what the selection is, so pre-filtering should be done in [[ContentRule]] condition and [[instanceFilter]].\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentInstancesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses;\r\n\r\n /**\r\n * List of ECClass specifications whose ECInstances should be selected.\r\n */\r\n classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * List of ECClass specifications whose ECInstances should be excluded.\r\n */\r\n excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Whether to get content from instances of derived `classes`.\r\n * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].\r\n * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n */\r\n handleInstancesPolymorphically?: boolean;\r\n\r\n /**\r\n * Whether to get content from properties of derived `classes`. If `true`, properties from `classes` with no instances\r\n * do not appear in the result set.\r\n */\r\n handlePropertiesPolymorphically?: boolean;\r\n\r\n /**\r\n * Condition for filtering instances of defined classes.\r\n *\r\n * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.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 { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * This specification creates content for all instances of specific ECClasses.\r\n *\r\n * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses;\r\n\r\n /**\r\n * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which\r\n * ECClasses need to be selected to form the result.\r\n */\r\n classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified\r\n * ECClasses and subclasses from being selected by [[classes]] attribute.\r\n */\r\n excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]\r\n * attributes should be polymorphic or not.\r\n *\r\n * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n */\r\n handleInstancesPolymorphically?: boolean;\r\n\r\n /**\r\n * Specifies whether properties of derived [[classes]] should be included in the content.\r\n */\r\n handlePropertiesPolymorphically?: boolean;\r\n\r\n /**\r\n * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances\r\n * of ECClasses specified through the [[classes]] attribute.\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
@@ -4,24 +4,22 @@
4
4
  import { RepeatableRelationshipPathSpecification } from "../RelationshipPathSpecification";
5
5
  import { ContentSpecificationBase, ContentSpecificationTypes } from "./ContentSpecification";
6
6
  /**
7
- * Creates content for ECInstance(s) related to current selection.
7
+ * Returns content for instances related to the selected (input) instances.
8
8
  *
9
- * **Note:** Use [[ContentRule.condition]] to apply specification on correct selection.
10
- *
11
- * @see [More details]($docs/presentation/Content/ContentRelatedInstances.md)
9
+ * @see [Content related instances specification reference documentation page]($docs/presentation/content/ContentRelatedInstances.md)
12
10
  * @public
13
11
  */
14
12
  export interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {
15
13
  /** Used for serializing to JSON. */
16
14
  specType: ContentSpecificationTypes.ContentRelatedInstances;
17
15
  /**
18
- * Relationship paths from input (selected) instance class to content class.
16
+ * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md) that
17
+ * forms a path from an input instance to the output instances. When this array is empty, the specification produces no results.
19
18
  */
20
19
  relationshipPaths: RepeatableRelationshipPathSpecification[];
21
20
  /**
22
- * Condition for filtering instances targeted by specified relationship paths.
23
- *
24
- * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
21
+ * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
22
+ * of ECClasses targeted through the [[relationshipPaths]] attribute.
25
23
  */
26
24
  instanceFilter?: string;
27
25
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ContentRelatedInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uCAAuC,EAAE,MAAM,kCAAkC,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,oCAAqC,SAAQ,wBAAwB;IACpF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,uBAAuB,CAAC;IAE5D;;OAEG;IACH,iBAAiB,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
1
+ {"version":3,"file":"ContentRelatedInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uCAAuC,EAAE,MAAM,kCAAkC,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,oCAAqC,SAAQ,wBAAwB;IACpF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,uBAAuB,CAAC;IAE5D;;;OAGG;IACH,iBAAiB,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
@@ -1 +1 @@
1
- {"version":3,"file":"ContentRelatedInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.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 { RepeatableRelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for ECInstance(s) related to current selection.\r\n *\r\n * **Note:** Use [[ContentRule.condition]] to apply specification on correct selection.\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentRelatedInstances.md)\r\n * @public\r\n */\r\nexport interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.ContentRelatedInstances;\r\n\r\n /**\r\n * Relationship paths from input (selected) instance class to content class.\r\n */\r\n relationshipPaths: RepeatableRelationshipPathSpecification[];\r\n\r\n /**\r\n * Condition for filtering instances targeted by specified relationship paths.\r\n *\r\n * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"ContentRelatedInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.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 { RepeatableRelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Returns content for instances related to the selected (input) instances.\r\n *\r\n * @see [Content related instances specification reference documentation page]($docs/presentation/content/ContentRelatedInstances.md)\r\n * @public\r\n */\r\nexport interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.ContentRelatedInstances;\r\n\r\n /**\r\n * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md) that\r\n * forms a path from an input instance to the output instances. When this array is empty, the specification produces no results.\r\n */\r\n relationshipPaths: RepeatableRelationshipPathSpecification[];\r\n\r\n /**\r\n * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances\r\n * of ECClasses targeted through the [[relationshipPaths]] attribute.\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
@@ -1,26 +1,31 @@
1
1
  /** @packageDocumentation
2
2
  * @module PresentationRules
3
3
  */
4
- import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
4
+ import { RuleBase, RuleTypes } from "../Rule";
5
5
  import { ContentSpecification } from "./ContentSpecification";
6
6
  /**
7
- * Defines content that's displayed in content controls (table view,
8
- * property pane, etc.) and the content that's selected in
9
- * [unified selection]($docs/presentation/unified-selection/index.md) controls
7
+ * Content rules are used to define content that is displayed for specific type of [input]($docs/presentation/content/Terminology.md#input-instance).
8
+ * Input consists of either ECInstances or [nodes]($docs/presentation/hierarchies/Terminology.md#node) and to make things
9
+ * simpler everything is considered a [node]($docs/presentation/hierarchies/Terminology.md#node) - instances get converted to
10
+ * *ECInstance nodes* (thus the `SelectedNode` symbol in [`condition` ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition)).
10
11
  *
11
- * @see [More details]($docs/presentation/Content/ContentRule.md)
12
+ * @see [Content rule reference documentation page]($docs/presentation/content/ContentRule.md)
12
13
  * @public
13
14
  */
14
- export interface ContentRule extends RuleBase, ConditionContainer {
15
+ export interface ContentRule extends RuleBase {
15
16
  /** Used for serializing to JSON. */
16
17
  ruleType: RuleTypes.Content;
17
18
  /**
18
- * Defines a condition for the rule, which needs to be met in order to execute it. Condition
19
- * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
20
- * a [limited set of symbols]($docs/presentation/Content/ECExpressions.md#rule-condition).
19
+ * Defines a condition which needs to be met in order for the rule to be used. The condition is an
20
+ * [ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition) which has to evaluate to
21
+ * a boolean value.
21
22
  */
22
23
  condition?: string;
23
- /** Specifications that define content returned by the rule */
24
+ /**
25
+ * A list of content specifications that define what content is going to be returned. This is the most
26
+ * important attribute which is responsible for defining what instances' properties are included in the
27
+ * returned content.
28
+ */
24
29
  specifications: ContentSpecification[];
25
30
  }
26
31
  //# sourceMappingURL=ContentRule.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ContentRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ,EAAE,kBAAkB;IAC/D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC;IAE5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,8DAA8D;IAC9D,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC"}
1
+ {"version":3,"file":"ContentRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC;IAE5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC"}
@@ -1 +1 @@
1
- {"version":3,"file":"ContentRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.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\nimport { ContentSpecification } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Defines content that's displayed in content controls (table view,\r\n * property pane, etc.) and the content that's selected in\r\n * [unified selection]($docs/presentation/unified-selection/index.md) controls\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentRule.md)\r\n * @public\r\n */\r\nexport interface ContentRule extends RuleBase, ConditionContainer {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.Content;\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/Content/ECExpressions.md#rule-condition).\r\n */\r\n condition?: string;\r\n\r\n /** Specifications that define content returned by the rule */\r\n specifications: ContentSpecification[];\r\n}\r\n"]}
1
+ {"version":3,"file":"ContentRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.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\nimport { ContentSpecification } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Content rules are used to define content that is displayed for specific type of [input]($docs/presentation/content/Terminology.md#input-instance).\r\n * Input consists of either ECInstances or [nodes]($docs/presentation/hierarchies/Terminology.md#node) and to make things\r\n * simpler everything is considered a [node]($docs/presentation/hierarchies/Terminology.md#node) - instances get converted to\r\n * *ECInstance nodes* (thus the `SelectedNode` symbol in [`condition` ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition)).\r\n *\r\n * @see [Content rule reference documentation page]($docs/presentation/content/ContentRule.md)\r\n * @public\r\n */\r\nexport interface ContentRule extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.Content;\r\n\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/content/ECExpressions.md#rule-condition) which has to evaluate to\r\n * a boolean value.\r\n */\r\n condition?: string;\r\n\r\n /**\r\n * A list of content specifications that define what content is going to be returned. This is the most\r\n * important attribute which is responsible for defining what instances' properties are included in the\r\n * returned content.\r\n */\r\n specifications: ContentSpecification[];\r\n}\r\n"]}
@@ -25,21 +25,24 @@ export interface ContentSpecificationBase extends ContentModifiersList {
25
25
  /** Used for serializing to JSON. */
26
26
  specType: ContentSpecificationTypes;
27
27
  /**
28
- * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.
28
+ * Controls the order in which specifications are handled specification with higher priority value is handled
29
+ * first. If priorities are equal, the specifications are handled in the order they appear in the ruleset.
29
30
  *
30
31
  * @type integer
31
32
  */
32
33
  priority?: number;
33
34
  /**
34
- * Should each content record be assigned an image id
35
- * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.
35
+ * Should image IDs be calculated for the returned instances. When `true`, [[ImageIdOverride]] rules get applied when
36
+ * creating the content.
37
+ *
38
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
36
39
  */
37
40
  showImages?: boolean;
38
- /** Specifications for joining related instances */
41
+ /** Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used when creating the content. */
39
42
  relatedInstances?: RelatedInstanceSpecification[];
40
43
  /**
41
- * Identifies whether we should ignore this specification if there is already an existing specification
42
- * with higher `priority` that already provides content.
44
+ * Specifies whether this specification should be ignored if another specification was handled before as
45
+ * determined by rule and specification priorities. This provides a mechanism for defining a fallback specification.
43
46
  */
44
47
  onlyIfNotHandled?: boolean;
45
48
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ContentSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,8CAA8C,EAAE,MAAM,kDAAkD,CAAC;AAClH,OAAO,EAAE,oCAAoC,EAAE,MAAM,wCAAwC,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAE1F;;;GAGG;AACH,oBAAY,yBAAyB;IACnC,iCAAiC,sCAAsC;IACvE,uBAAuB,4BAA4B;IACnD,qBAAqB,0BAA0B;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,oBAAoB,GAAG,8CAA8C,GAAG,oCAAoC,GAAG,kCAAkC,CAAC"}
1
+ {"version":3,"file":"ContentSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,8CAA8C,EAAE,MAAM,kDAAkD,CAAC;AAClH,OAAO,EAAE,oCAAoC,EAAE,MAAM,wCAAwC,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAE1F;;;GAGG;AACH,oBAAY,yBAAyB;IACnC,iCAAiC,sCAAsC;IACvE,uBAAuB,4BAA4B;IACnD,qBAAqB,0BAA0B;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC;IAEpC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,4IAA4I;IAC5I,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,oBAAoB,GAAG,8CAA8C,GAAG,oCAAoC,GAAG,kCAAkC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"ContentSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAQH;;;GAGG;AACH,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,oGAAuE,CAAA;IACvE,gFAAmD,CAAA;IACnD,4EAA+C,CAAA;AACjD,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC","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 { ContentInstancesOfSpecificClassesSpecification } from \"./ContentInstancesOfSpecificClassesSpecification\";\r\nimport { ContentRelatedInstancesSpecification } from \"./ContentRelatedInstancesSpecification\";\r\nimport { ContentModifiersList } from \"./modifiers/ContentModifier\";\r\nimport { SelectedNodeInstancesSpecification } from \"./SelectedNodeInstancesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ContentSpecification]]\r\n * @public\r\n */\r\nexport enum ContentSpecificationTypes {\r\n ContentInstancesOfSpecificClasses = \"ContentInstancesOfSpecificClasses\",\r\n ContentRelatedInstances = \"ContentRelatedInstances\",\r\n SelectedNodeInstances = \"SelectedNodeInstances\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ContentSpecification]] implementations. Not\r\n * meant to be used directly, see `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentSpecificationBase extends ContentModifiersList {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes;\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 * Should each content record be assigned an image id\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n */\r\n showImages?: boolean;\r\n\r\n /** Specifications for joining related instances */\r\n relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n /**\r\n * Identifies whether we should ignore this specification if there is already an existing specification\r\n * with higher `priority` that already provides content.\r\n */\r\n onlyIfNotHandled?: boolean;\r\n}\r\n\r\n/**\r\n * Content rule specifications which define what content is returned\r\n * when rule is used.\r\n *\r\n * @public\r\n */\r\nexport declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;\r\n"]}
1
+ {"version":3,"file":"ContentSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAQH;;;GAGG;AACH,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,oGAAuE,CAAA;IACvE,gFAAmD,CAAA;IACnD,4EAA+C,CAAA;AACjD,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC","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 { ContentInstancesOfSpecificClassesSpecification } from \"./ContentInstancesOfSpecificClassesSpecification\";\r\nimport { ContentRelatedInstancesSpecification } from \"./ContentRelatedInstancesSpecification\";\r\nimport { ContentModifiersList } from \"./modifiers/ContentModifier\";\r\nimport { SelectedNodeInstancesSpecification } from \"./SelectedNodeInstancesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ContentSpecification]]\r\n * @public\r\n */\r\nexport enum ContentSpecificationTypes {\r\n ContentInstancesOfSpecificClasses = \"ContentInstancesOfSpecificClasses\",\r\n ContentRelatedInstances = \"ContentRelatedInstances\",\r\n SelectedNodeInstances = \"SelectedNodeInstances\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ContentSpecification]] implementations. Not\r\n * meant to be used directly, see `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentSpecificationBase extends ContentModifiersList {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes;\r\n\r\n /**\r\n * Controls the order in which specifications are handled specification with higher priority value is handled\r\n * first. If priorities are equal, the specifications are handled in the order they appear in the ruleset.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n\r\n /**\r\n * Should image IDs be calculated for the returned instances. When `true`, [[ImageIdOverride]] rules get applied when\r\n * creating the content.\r\n *\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\n showImages?: boolean;\r\n\r\n /** Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used when creating the content. */\r\n relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n /**\r\n * Specifies whether this specification should be ignored if another specification was handled before as\r\n * determined by rule and specification priorities. This provides a mechanism for defining a fallback specification.\r\n */\r\n onlyIfNotHandled?: boolean;\r\n}\r\n\r\n/**\r\n * Content rule specifications which define what content is returned\r\n * when rule is used.\r\n *\r\n * @public\r\n */\r\nexport declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;\r\n"]}
@@ -6,16 +6,15 @@ import { PropertyCategorySpecification } from "./modifiers/PropertyCategorySpeci
6
6
  /**
7
7
  * A rule that allows overriding the default property category.
8
8
  *
9
- * The default property category is a category that gets assigned to properties
10
- * that otherwise have no category.
9
+ * The default property category is a category that gets assigned to properties that otherwise have no category.
11
10
  *
12
- * @see [More details]($docs/presentation/Content/DefaultPropertyCategoryOverride.md)
11
+ * @see [Default property category override reference documentation page]($docs/presentation/content/DefaultPropertyCategoryOverride.md)
13
12
  * @public
14
13
  */
15
14
  export interface DefaultPropertyCategoryOverride extends RuleBase {
16
15
  /** Used for serializing to JSON. */
17
16
  ruleType: RuleTypes.DefaultPropertyCategoryOverride;
18
- /** Specification of the category override */
17
+ /** Specification for the custom property category. */
19
18
  specification: PropertyCategorySpecification;
20
19
  }
21
20
  //# sourceMappingURL=DefaultPropertyCategoryOverride.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DefaultPropertyCategoryOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAE1F;;;;;;;;GAQG;AACH,MAAM,WAAW,+BAAgC,SAAQ,QAAQ;IAC/D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,+BAA+B,CAAC;IAEpD,6CAA6C;IAC7C,aAAa,EAAE,6BAA6B,CAAC;CAC9C"}
1
+ {"version":3,"file":"DefaultPropertyCategoryOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAM,WAAW,+BAAgC,SAAQ,QAAQ;IAC/D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,+BAA+B,CAAC;IAEpD,sDAAsD;IACtD,aAAa,EAAE,6BAA6B,CAAC;CAC9C"}
@@ -1 +1 @@
1
- {"version":3,"file":"DefaultPropertyCategoryOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.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\nimport { PropertyCategorySpecification } from \"./modifiers/PropertyCategorySpecification\";\r\n\r\n/**\r\n * A rule that allows overriding the default property category.\r\n *\r\n * The default property category is a category that gets assigned to properties\r\n * that otherwise have no category.\r\n *\r\n * @see [More details]($docs/presentation/Content/DefaultPropertyCategoryOverride.md)\r\n * @public\r\n */\r\nexport interface DefaultPropertyCategoryOverride extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.DefaultPropertyCategoryOverride;\r\n\r\n /** Specification of the category override */\r\n specification: PropertyCategorySpecification;\r\n}\r\n"]}
1
+ {"version":3,"file":"DefaultPropertyCategoryOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.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\nimport { PropertyCategorySpecification } from \"./modifiers/PropertyCategorySpecification\";\r\n\r\n/**\r\n * A rule that allows overriding the default property category.\r\n *\r\n * The default property category is a category that gets assigned to properties that otherwise have no category.\r\n *\r\n * @see [Default property category override reference documentation page]($docs/presentation/content/DefaultPropertyCategoryOverride.md)\r\n * @public\r\n */\r\nexport interface DefaultPropertyCategoryOverride extends RuleBase {\r\n /** Used for serializing to JSON. */\r\n ruleType: RuleTypes.DefaultPropertyCategoryOverride;\r\n\r\n /** Specification for the custom property category. */\r\n specification: PropertyCategorySpecification;\r\n}\r\n"]}
@@ -6,46 +6,81 @@ import { CategoryIdentifier } from "./modifiers/PropertyCategorySpecification";
6
6
  import { PropertyEditorSpecification } from "./modifiers/PropertyEditorsSpecification";
7
7
  /**
8
8
  * A container structure for possible property overrides
9
+ *
10
+ * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
9
11
  * @public
10
12
  */
11
13
  export interface PropertyOverrides {
12
- /** Priority of the specified overrides. */
14
+ /**
15
+ * There may be multiple property specifications that apply to a single property and there may be conflicts between
16
+ * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications
17
+ * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.
18
+ * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in
19
+ * the overrides list.
20
+ */
13
21
  overridesPriority?: number;
14
- /** Label override. May be [localized]($docs/presentation/Advanced/Localization.md). */
22
+ /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */
15
23
  labelOverride?: string;
16
- /** Identifier of a category that should be used for the property. */
24
+ /** The attribute allows moving the property into a different category. */
17
25
  categoryId?: string | CategoryIdentifier;
18
- /** Display override. `true` to force display, `false` to force hide, `undefined` to use default. */
19
- isDisplayed?: boolean;
20
- /** Custom property renderer specification. */
26
+ /**
27
+ * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the
28
+ * ECSchema. The allowed settings are:
29
+ *
30
+ * - Omitted or `undefined`: property visibility is controlled by the ECSchema.
31
+ *
32
+ * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.
33
+ * If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.
34
+ *
35
+ * - `false`: property is made hidden.
36
+ *
37
+ * The value can also be set using an ECExpression.
38
+ */
39
+ isDisplayed?: boolean | string;
40
+ /**
41
+ * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a
42
+ * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for
43
+ * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.
44
+ */
21
45
  renderer?: CustomRendererSpecification;
22
- /** Custom property editor specification. */
46
+ /**
47
+ * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning
48
+ * a custom value editor to be used in UI.
49
+ */
23
50
  editor?: PropertyEditorSpecification;
24
51
  /**
25
- * Flag to control behavior of `isDisplayed` override when it's set to `true`.
26
- * By default, forcing property display hides all other properties.
27
- * Setting `doNotHideOtherPropertiesOnDisplayOverride` to `true` disables that behavior and
28
- * prevents forcing property display of one property from hiding other properties.
52
+ * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide
53
+ * all other properties of the same class. When `true`, this behavior is disabled.
29
54
  */
30
55
  doNotHideOtherPropertiesOnDisplayOverride?: boolean;
56
+ /**
57
+ * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is
58
+ * read-only when at least one of the properties is read-only.
59
+ */
60
+ isReadOnly?: boolean;
61
+ /**
62
+ * This attribute controls the order in which property fields should be displayed. Property fields with higher priority
63
+ * will appear before property fields with lower priority. If the attribute value is not set, the field's priority
64
+ * will be the maximum priority of its properties.
65
+ */
66
+ priority?: number;
31
67
  }
32
68
  /**
33
- * Specification of an ECProperty and its overrides
69
+ * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.
34
70
  *
35
- * @see [More details]($docs/presentation/Content/PropertySpecification.md)
71
+ * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
36
72
  * @public
37
73
  */
38
74
  export interface PropertySpecification extends PropertyOverrides {
39
75
  /**
40
- * Name of the ECProperty.
76
+ * Name of the ECProperty to apply overrides to. A `"*"` may be specified to match all properties in current context.
77
+ * The current context is determined based on where the override is specified:
78
+ *
79
+ * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the
80
+ * properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.
41
81
  *
42
- * A `"*"` may be specified to match all properties in current context:
43
- * - when the specification is used in an ECClass context (e.g. in a [[ContentModifier]] rule),
44
- * all properties of that class are matched (including properties derived from base classes, but excluding
45
- * subclass properties).
46
- * - when specification is used outside of class context, all properties found in that context are matched. E.g. when
47
- * used in [[ContentSpecification.propertyOverrides]] where [[ContentSpecification]] creates content with properties of
48
- * different classes.
82
+ * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),
83
+ * properties produced by that specification are used.
49
84
  */
50
85
  name: string;
51
86
  }
@@ -1 +1 @@
1
- {"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,2CAA2C;IAC3C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uFAAuF;IACvF,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC,oGAAoG;IACpG,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC,4CAA4C;IAC5C,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;;;OAKG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
1
+ {"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;IAEpD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
@@ -1 +1 @@
1
- {"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 { CustomRendererSpecification } from \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n /** Priority of the specified overrides. */\r\n overridesPriority?: number;\r\n\r\n /** Label override. May be [localized]($docs/presentation/Advanced/Localization.md). */\r\n labelOverride?: string;\r\n\r\n /** Identifier of a category that should be used for the property. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /** Display override. `true` to force display, `false` to force hide, `undefined` to use default. */\r\n isDisplayed?: boolean;\r\n\r\n /** Custom property renderer specification. */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /** Custom property editor specification. */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * Flag to control behavior of `isDisplayed` override when it's set to `true`.\r\n * By default, forcing property display hides all other properties.\r\n * Setting `doNotHideOtherPropertiesOnDisplayOverride` to `true` disables that behavior and\r\n * prevents forcing property display of one property from hiding other properties.\r\n */\r\n doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * Specification of an ECProperty and its overrides\r\n *\r\n * @see [More details]($docs/presentation/Content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n /**\r\n * Name of the ECProperty.\r\n *\r\n * A `\"*\"` may be specified to match all properties in current context:\r\n * - when the specification is used in an ECClass context (e.g. in a [[ContentModifier]] rule),\r\n * all properties of that class are matched (including properties derived from base classes, but excluding\r\n * subclass properties).\r\n * - when specification is used outside of class context, all properties found in that context are matched. E.g. when\r\n * used in [[ContentSpecification.propertyOverrides]] where [[ContentSpecification]] creates content with properties of\r\n * different classes.\r\n */\r\n name: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 { CustomRendererSpecification } from \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n /**\r\n * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n * the overrides list.\r\n */\r\n overridesPriority?: number;\r\n\r\n /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n labelOverride?: string;\r\n\r\n /** The attribute allows moving the property into a different category. */\r\n categoryId?: string | CategoryIdentifier;\r\n\r\n /**\r\n * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n * ECSchema. The allowed settings are:\r\n *\r\n * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n *\r\n * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n * If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n *\r\n * - `false`: property is made hidden.\r\n *\r\n * The value can also be set using an ECExpression.\r\n */\r\n isDisplayed?: boolean | string;\r\n\r\n /**\r\n * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n */\r\n renderer?: CustomRendererSpecification;\r\n\r\n /**\r\n * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n * a custom value editor to be used in UI.\r\n */\r\n editor?: PropertyEditorSpecification;\r\n\r\n /**\r\n * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n * all other properties of the same class. When `true`, this behavior is disabled.\r\n */\r\n doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n\r\n /**\r\n * This attribute controls whether the property field is read-only. If the attribute value is not set, the field is\r\n * read-only when at least one of the properties is read-only.\r\n */\r\n isReadOnly?: boolean;\r\n\r\n /**\r\n * This attribute controls the order in which property fields should be displayed. Property fields with higher priority\r\n * will appear before property fields with lower priority. If the attribute value is not set, the field's priority\r\n * will be the maximum priority of its properties.\r\n */\r\n priority?: number;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n /**\r\n * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n * The current context is determined based on where the override is specified:\r\n *\r\n * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n * properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n *\r\n * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n * properties produced by that specification are used.\r\n */\r\n name: string;\r\n}\r\n"]}
@@ -3,31 +3,26 @@
3
3
  */
4
4
  import { ContentSpecificationBase, ContentSpecificationTypes } from "./ContentSpecification";
5
5
  /**
6
- * Creates content for current selection.
6
+ * Returns content for selected (input) instances.
7
7
  *
8
- * **Note:** No data is returned for selected custom nodes.
9
- *
10
- * @see [More details]($docs/presentation/Content/SelectedNodeInstances.md)
8
+ * @see [Selected node instances specification reference documentation page]($docs/presentation/content/SelectedNodeInstances.md)
11
9
  * @public
12
10
  */
13
11
  export interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {
14
12
  /** Used for serializing to JSON. */
15
13
  specType: ContentSpecificationTypes.SelectedNodeInstances;
16
14
  /**
17
- * Filter selected nodes by specified schema name. All schemas are
18
- * accepted if not specified.
15
+ * Specifies ECSchema name which the input instances have to match for the specification to be used.
19
16
  *
20
17
  * @pattern ^[\w\d]+$
21
18
  */
22
19
  acceptableSchemaName?: string;
23
20
  /**
24
- * Filter selected nodes by specified class names. All classes are
25
- * accepted if not specified.
21
+ * Specifies a list of class names which the input instances have to match for the specification to be used.
26
22
  */
27
23
  acceptableClassNames?: string[];
28
24
  /**
29
- * Should [[acceptableClassNames]] property be checked polymorphically. If true, all derived
30
- * classes are accepted as well.
25
+ * Specifies whether derived classes of [[acceptableClassNames]] should be included in the content.
31
26
  */
32
27
  acceptablePolymorphically?: boolean;
33
28
  }
@@ -1 +1 @@
1
- {"version":3,"file":"SelectedNodeInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,kCAAmC,SAAQ,wBAAwB;IAClF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAE1D;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}
1
+ {"version":3,"file":"SelectedNodeInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,kCAAmC,SAAQ,wBAAwB;IAClF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAE1D;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}
@@ -1 +1 @@
1
- {"version":3,"file":"SelectedNodeInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.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 { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for current selection.\r\n *\r\n * **Note:** No data is returned for selected custom nodes.\r\n *\r\n * @see [More details]($docs/presentation/Content/SelectedNodeInstances.md)\r\n * @public\r\n */\r\nexport interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.SelectedNodeInstances;\r\n\r\n /**\r\n * Filter selected nodes by specified schema name. All schemas are\r\n * accepted if not specified.\r\n *\r\n * @pattern ^[\\w\\d]+$\r\n */\r\n acceptableSchemaName?: string;\r\n\r\n /**\r\n * Filter selected nodes by specified class names. All classes are\r\n * accepted if not specified.\r\n */\r\n acceptableClassNames?: string[];\r\n\r\n /**\r\n * Should [[acceptableClassNames]] property be checked polymorphically. If true, all derived\r\n * classes are accepted as well.\r\n */\r\n acceptablePolymorphically?: boolean;\r\n}\r\n"]}
1
+ {"version":3,"file":"SelectedNodeInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.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 { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Returns content for selected (input) instances.\r\n *\r\n * @see [Selected node instances specification reference documentation page]($docs/presentation/content/SelectedNodeInstances.md)\r\n * @public\r\n */\r\nexport interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.SelectedNodeInstances;\r\n\r\n /**\r\n * Specifies ECSchema name which the input instances have to match for the specification to be used.\r\n *\r\n * @pattern ^[\\w\\d]+$\r\n */\r\n acceptableSchemaName?: string;\r\n\r\n /**\r\n * Specifies a list of class names which the input instances have to match for the specification to be used.\r\n */\r\n acceptableClassNames?: string[];\r\n\r\n /**\r\n * Specifies whether derived classes of [[acceptableClassNames]] should be included in the content.\r\n */\r\n acceptablePolymorphically?: boolean;\r\n}\r\n"]}
@@ -2,25 +2,22 @@
2
2
  * @module PresentationRules
3
3
  */
4
4
  /**
5
- * Sub-specification to include additional calculated properties into the content.
5
+ * This content modifier allows including additional calculated properties into the content.
6
6
  *
7
- * @see [More details]($docs/presentation/Content/CalculatedPropertiesSpecification.md)
7
+ * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)
8
8
  * @public
9
9
  */
10
10
  export interface CalculatedPropertiesSpecification {
11
- /** Label of the calculated property. May be [localized]($docs/presentation/Advanced/Localization.md). */
11
+ /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */
12
12
  label: string;
13
13
  /**
14
- * [ECExpression]($docs/presentation/Advanced/ECExpressions.md) used to calculate the value. The
15
- * following symbol sets are available:
16
- * - [ECInstance ECExpression context]($docs/presentation/Advanced/ECExpressions.md#ecinstance)
17
- * - [Ruleset variables]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)
14
+ * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)
15
+ * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.
18
16
  */
19
17
  value: string;
20
18
  /**
21
- * Priority of the property. Determines the position of this property in UI
22
- * components - higher priority means the property should be more visible.
23
- * Defaults to `1000`.
19
+ * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority
20
+ * is respected - properties with higher priority should appear before or above properties with lower priority.
24
21
  *
25
22
  * @type integer
26
23
  */
@@ -1 +1 @@
1
- {"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,yGAAyG;IACzG,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
1
+ {"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,wHAAwH;IACxH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
@@ -1 +1 @@
1
- {"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.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\n/**\r\n * Sub-specification to include additional calculated properties into the content.\r\n *\r\n * @see [More details]($docs/presentation/Content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n /** Label of the calculated property. May be [localized]($docs/presentation/Advanced/Localization.md). */\r\n label: string;\r\n\r\n /**\r\n * [ECExpression]($docs/presentation/Advanced/ECExpressions.md) used to calculate the value. The\r\n * following symbol sets are available:\r\n * - [ECInstance ECExpression context]($docs/presentation/Advanced/ECExpressions.md#ecinstance)\r\n * - [Ruleset variables]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n */\r\n value: string;\r\n\r\n /**\r\n * Priority of the property. Determines the position of this property in UI\r\n * components - higher priority means the property should be more visible.\r\n * Defaults to `1000`.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n}\r\n"]}
1
+ {"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.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\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n label: string;\r\n\r\n /**\r\n * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n */\r\n value: string;\r\n\r\n /**\r\n * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n *\r\n * @type integer\r\n */\r\n priority?: number;\r\n}\r\n"]}