@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

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 (366) hide show
  1. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  2. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  3. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  4. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  5. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  6. package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
  7. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  8. package/lib/cjs/presentation-common/EC.d.ts +350 -350
  9. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  10. package/lib/cjs/presentation-common/EC.js +290 -290
  11. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  12. package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
  13. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  14. package/lib/cjs/presentation-common/Error.d.ts +47 -47
  15. package/lib/cjs/presentation-common/Error.js +64 -64
  16. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  17. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  18. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  19. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  20. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  21. package/lib/cjs/presentation-common/KeySet.js +428 -428
  22. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -93
  23. package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
  24. package/lib/cjs/presentation-common/LabelDefinition.js +78 -78
  25. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  26. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  27. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  28. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  29. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -273
  30. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  31. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  32. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
  33. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  34. package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
  35. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  36. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +30 -30
  37. package/lib/cjs/presentation-common/PropertyFormatter.js +198 -198
  38. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  39. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  40. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  41. package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -166
  42. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  43. package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
  44. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  45. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  46. package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
  47. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  48. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  49. package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
  50. package/lib/cjs/presentation-common/Update.js +226 -226
  51. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  52. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  53. package/lib/cjs/presentation-common/Utils.js +43 -43
  54. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  55. package/lib/cjs/presentation-common/content/Category.js +48 -48
  56. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  57. package/lib/cjs/presentation-common/content/Content.js +56 -56
  58. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  59. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -437
  60. package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
  61. package/lib/cjs/presentation-common/content/Descriptor.js +191 -191
  62. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  63. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  64. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  65. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  66. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -298
  67. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  68. package/lib/cjs/presentation-common/content/Fields.js +393 -393
  69. package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
  70. package/lib/cjs/presentation-common/content/Item.js +84 -84
  71. package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
  72. package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
  73. package/lib/cjs/presentation-common/content/Property.js +40 -40
  74. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  75. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  76. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  77. package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
  78. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  79. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  80. package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
  81. package/lib/cjs/presentation-common/content/Value.js +273 -273
  82. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  83. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
  84. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  85. package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
  86. package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
  87. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
  88. package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
  89. package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
  90. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  91. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
  92. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  93. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  94. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  95. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  96. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  97. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  98. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  99. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  100. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  101. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  102. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  103. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  104. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  105. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  106. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  107. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  108. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  109. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  110. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  111. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  112. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  113. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  114. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  115. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  116. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  117. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  118. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  119. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  120. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  121. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  122. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  123. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  124. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  125. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  126. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  127. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  128. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  129. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  130. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  131. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  132. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  133. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  134. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  135. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  136. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  137. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  138. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  139. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  140. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  141. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  142. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  143. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  144. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  145. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  146. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  147. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  148. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  149. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  150. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  151. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  152. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  153. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  154. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  155. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  156. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  157. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  158. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  159. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  160. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  161. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  162. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  163. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  164. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  165. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  166. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  167. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  168. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  169. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  170. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  171. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  172. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  173. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  174. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  175. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  176. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  177. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  178. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  179. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  180. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  181. package/lib/cjs/presentation-common.d.ts +113 -113
  182. package/lib/cjs/presentation-common.js +133 -129
  183. package/lib/cjs/presentation-common.js.map +1 -1
  184. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  185. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  186. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  187. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  188. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  189. package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
  190. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  191. package/lib/esm/presentation-common/EC.d.ts +350 -350
  192. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  193. package/lib/esm/presentation-common/EC.js +287 -287
  194. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  195. package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
  196. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  197. package/lib/esm/presentation-common/Error.d.ts +47 -47
  198. package/lib/esm/presentation-common/Error.js +60 -60
  199. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  200. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  201. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  202. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  203. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  204. package/lib/esm/presentation-common/KeySet.js +424 -424
  205. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -93
  206. package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
  207. package/lib/esm/presentation-common/LabelDefinition.js +75 -75
  208. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  209. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  210. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  211. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  212. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -273
  213. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  214. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  215. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  216. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  217. package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
  218. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  219. package/lib/esm/presentation-common/PropertyFormatter.d.ts +30 -30
  220. package/lib/esm/presentation-common/PropertyFormatter.js +193 -193
  221. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  222. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  223. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  224. package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -162
  225. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  226. package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
  227. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  228. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  229. package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
  230. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  231. package/lib/esm/presentation-common/Update.d.ts +213 -213
  232. package/lib/esm/presentation-common/Update.d.ts.map +1 -1
  233. package/lib/esm/presentation-common/Update.js +223 -223
  234. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  235. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  236. package/lib/esm/presentation-common/Utils.js +39 -39
  237. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  238. package/lib/esm/presentation-common/content/Category.js +45 -45
  239. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  240. package/lib/esm/presentation-common/content/Content.js +52 -52
  241. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  242. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -427
  243. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  244. package/lib/esm/presentation-common/content/Descriptor.js +187 -187
  245. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  246. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  247. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  248. package/lib/esm/presentation-common/content/Editor.js +8 -8
  249. package/lib/esm/presentation-common/content/Fields.d.ts +298 -298
  250. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  251. package/lib/esm/presentation-common/content/Fields.js +386 -386
  252. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  253. package/lib/esm/presentation-common/content/Item.js +80 -80
  254. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  255. package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
  256. package/lib/esm/presentation-common/content/Property.js +37 -37
  257. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  258. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  259. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  260. package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
  261. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  262. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  263. package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
  264. package/lib/esm/presentation-common/content/Value.js +270 -270
  265. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  266. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  267. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  268. package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
  269. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  270. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  271. package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
  272. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  273. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  274. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  275. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  276. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  277. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  278. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  279. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  280. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  281. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  282. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  283. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  284. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  285. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  286. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  287. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  288. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  289. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  290. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  291. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  292. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  293. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  294. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  295. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  296. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  297. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  298. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  299. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  300. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  301. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  302. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  303. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  304. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  305. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  306. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  307. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  308. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  309. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  310. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  311. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  312. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  313. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  314. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  315. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  316. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  317. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  318. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  319. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  320. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  321. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  322. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  323. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  324. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  325. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  326. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  327. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  328. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  329. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  330. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  331. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  332. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  333. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  334. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  335. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  336. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  337. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  338. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  339. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  340. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  341. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  342. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  343. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  344. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  345. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  346. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  347. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  348. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  349. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  350. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  351. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  352. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  353. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  354. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  355. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  356. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  357. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  358. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  359. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  360. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  361. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  362. package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  363. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  364. package/lib/esm/presentation-common.d.ts +113 -113
  365. package/lib/esm/presentation-common.js +117 -117
  366. package/package.json +12 -12
@@ -1,52 +1,52 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module PresentationRules
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.PropertyGroupingValue = exports.SameLabelInstanceGroupApplicationStage = exports.GroupingSpecificationTypes = void 0;
11
- /**
12
- * Available types of [[GroupingSpecification]].
13
- * @public
14
- */
15
- var GroupingSpecificationTypes;
16
- (function (GroupingSpecificationTypes) {
17
- GroupingSpecificationTypes["Class"] = "Class";
18
- GroupingSpecificationTypes["Property"] = "Property";
19
- GroupingSpecificationTypes["SameLabelInstance"] = "SameLabelInstance";
20
- })(GroupingSpecificationTypes = exports.GroupingSpecificationTypes || (exports.GroupingSpecificationTypes = {}));
21
- /**
22
- * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.
23
- * @public
24
- */
25
- var SameLabelInstanceGroupApplicationStage;
26
- (function (SameLabelInstanceGroupApplicationStage) {
27
- /** Apply grouping at query stage. */
28
- SameLabelInstanceGroupApplicationStage["Query"] = "Query";
29
- /**
30
- * Apply grouping at post-processing stage.
31
- *
32
- * This allows grouping nodes created by different hierarchy specifications at
33
- * a higher performance cost as it requires loading the whole hierarchy level before
34
- * returning even the first node - avoid using with large numbers of nodes.
35
- */
36
- SameLabelInstanceGroupApplicationStage["PostProcess"] = "PostProcess";
37
- })(SameLabelInstanceGroupApplicationStage = exports.SameLabelInstanceGroupApplicationStage || (exports.SameLabelInstanceGroupApplicationStage = {}));
38
- /**
39
- * Used in [[PropertyGroup]] to specify the type of value to use
40
- * for grouping and sorting
41
- *
42
- * @public
43
- * @deprecated in 3.x. The attributes using this enum are deprecated.
44
- */
45
- var PropertyGroupingValue;
46
- (function (PropertyGroupingValue) {
47
- /** By property value */
48
- PropertyGroupingValue["PropertyValue"] = "PropertyValue";
49
- /** By display label */
50
- PropertyGroupingValue["DisplayLabel"] = "DisplayLabel";
51
- })(PropertyGroupingValue = exports.PropertyGroupingValue || (exports.PropertyGroupingValue = {}));
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module PresentationRules
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.PropertyGroupingValue = exports.SameLabelInstanceGroupApplicationStage = exports.GroupingSpecificationTypes = void 0;
11
+ /**
12
+ * Available types of [[GroupingSpecification]].
13
+ * @public
14
+ */
15
+ var GroupingSpecificationTypes;
16
+ (function (GroupingSpecificationTypes) {
17
+ GroupingSpecificationTypes["Class"] = "Class";
18
+ GroupingSpecificationTypes["Property"] = "Property";
19
+ GroupingSpecificationTypes["SameLabelInstance"] = "SameLabelInstance";
20
+ })(GroupingSpecificationTypes = exports.GroupingSpecificationTypes || (exports.GroupingSpecificationTypes = {}));
21
+ /**
22
+ * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.
23
+ * @public
24
+ */
25
+ var SameLabelInstanceGroupApplicationStage;
26
+ (function (SameLabelInstanceGroupApplicationStage) {
27
+ /** Apply grouping at query stage. */
28
+ SameLabelInstanceGroupApplicationStage["Query"] = "Query";
29
+ /**
30
+ * Apply grouping at post-processing stage.
31
+ *
32
+ * This allows grouping nodes created by different hierarchy specifications at
33
+ * a higher performance cost as it requires loading the whole hierarchy level before
34
+ * returning even the first node - avoid using with large numbers of nodes.
35
+ */
36
+ SameLabelInstanceGroupApplicationStage["PostProcess"] = "PostProcess";
37
+ })(SameLabelInstanceGroupApplicationStage = exports.SameLabelInstanceGroupApplicationStage || (exports.SameLabelInstanceGroupApplicationStage = {}));
38
+ /**
39
+ * Used in [[PropertyGroup]] to specify the type of value to use
40
+ * for grouping and sorting
41
+ *
42
+ * @public
43
+ * @deprecated in 3.x. The attributes using this enum are deprecated.
44
+ */
45
+ var PropertyGroupingValue;
46
+ (function (PropertyGroupingValue) {
47
+ /** By property value */
48
+ PropertyGroupingValue["PropertyValue"] = "PropertyValue";
49
+ /** By display label */
50
+ PropertyGroupingValue["DisplayLabel"] = "DisplayLabel";
51
+ })(PropertyGroupingValue = exports.PropertyGroupingValue || (exports.PropertyGroupingValue = {}));
52
52
  //# sourceMappingURL=GroupingRule.js.map
@@ -1,30 +1,30 @@
1
- /** @packageDocumentation
2
- * @module PresentationRules
3
- */
4
- import { RuleBase } from "../Rule";
5
- /**
6
- * ImageId override rules allow setting an image ID to specific types of ECInstances.
7
- *
8
- * @see [Image ID override reference documentation page]($docs/presentation/customization/ImageIdOverride.md)
9
- * @public
10
- * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
11
- */
12
- export interface ImageIdOverride extends RuleBase {
13
- /** Used for serializing to JSON. */
14
- ruleType: "ImageIdOverride";
15
- /**
16
- * Defines a condition for the rule, which needs to be met in order to execute it. Condition
17
- * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
18
- * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
19
- */
20
- condition?: string;
21
- /**
22
- * An expression whose result becomes the image ID. This is
23
- * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so ID can be
24
- * defined/formatted dynamically based on the context - for example ECInstance property value.
25
- *
26
- * @minLength 1
27
- */
28
- imageIdExpression: string;
29
- }
1
+ /** @packageDocumentation
2
+ * @module PresentationRules
3
+ */
4
+ import { RuleBase } from "../Rule";
5
+ /**
6
+ * ImageId override rules allow setting an image ID to specific types of ECInstances.
7
+ *
8
+ * @see [Image ID override reference documentation page]($docs/presentation/customization/ImageIdOverride.md)
9
+ * @public
10
+ * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
11
+ */
12
+ export interface ImageIdOverride extends RuleBase {
13
+ /** Used for serializing to JSON. */
14
+ ruleType: "ImageIdOverride";
15
+ /**
16
+ * Defines a condition for the rule, which needs to be met in order to execute it. Condition
17
+ * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
18
+ * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
19
+ */
20
+ condition?: string;
21
+ /**
22
+ * An expression whose result becomes the image ID. This is
23
+ * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so ID can be
24
+ * defined/formatted dynamically based on the context - for example ECInstance property value.
25
+ *
26
+ * @minLength 1
27
+ */
28
+ imageIdExpression: string;
29
+ }
30
30
  //# sourceMappingURL=ImageIdOverride.d.ts.map
@@ -1,10 +1,10 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module PresentationRules
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module PresentationRules
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
10
  //# sourceMappingURL=ImageIdOverride.js.map
@@ -1,159 +1,159 @@
1
- /** @packageDocumentation
2
- * @module PresentationRules
3
- */
4
- import { SingleSchemaClassSpecification } from "../ClassSpecifications";
5
- import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
6
- import { RuleBase } from "../Rule";
7
- /**
8
- * Instance label override rule provides a way to set instance label to one of its property values,
9
- * other attributes and/or combination of them.
10
- *
11
- * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
12
- * @public
13
- */
14
- export interface InstanceLabelOverride extends RuleBase {
15
- /** Used for serializing to JSON. */
16
- ruleType: "InstanceLabelOverride";
17
- /**
18
- * Specifies the ECClass to apply this rule to.
19
- */
20
- class: SingleSchemaClassSpecification;
21
- /**
22
- * Specifications of values used to override label. The first non-empty value is used as the actual label.
23
- */
24
- values: InstanceLabelOverrideValueSpecification[];
25
- }
26
- /**
27
- * Types of possible [[InstanceLabelOverride]] label values.
28
- * @public
29
- */
30
- export declare enum InstanceLabelOverrideValueSpecificationType {
31
- Composite = "Composite",
32
- Property = "Property",
33
- ClassName = "ClassName",
34
- ClassLabel = "ClassLabel",
35
- BriefcaseId = "BriefcaseId",
36
- LocalId = "LocalId",
37
- String = "String",
38
- RelatedInstanceLabel = "RelatedInstanceLabel"
39
- }
40
- /**
41
- * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
42
- * @public
43
- */
44
- export interface InstanceLabelOverrideValueSpecificationBase {
45
- /**
46
- * Type of the specification
47
- * @see InstanceLabelOverrideValueSpecificationType
48
- */
49
- specType: `${InstanceLabelOverrideValueSpecificationType}`;
50
- }
51
- /**
52
- * Specification allows creating a label value composited using multiple other specifications.
53
- *
54
- * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
55
- * @public
56
- */
57
- export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
58
- specType: "Composite";
59
- /**
60
- * Parts of the value.
61
- *
62
- * If any of the parts with `isRequired` flag evaluate to an empty string, the
63
- * result of this specification is also an empty string.
64
- */
65
- parts: Array<{
66
- spec: InstanceLabelOverrideValueSpecification;
67
- isRequired?: boolean;
68
- }>;
69
- /** Separator to use when joining the parts. Defaults to a space character. */
70
- separator?: string;
71
- }
72
- /**
73
- * Specification uses property value as the label content.
74
- *
75
- * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
76
- * @public
77
- */
78
- export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
79
- specType: "Property";
80
- /**
81
- * Name of the property whose value should be used.
82
- * @note A property with this name must exist on the property class (see [[propertySource]]).
83
- */
84
- propertyName: string;
85
- /**
86
- * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]
87
- * to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.
88
- */
89
- propertySource?: RelationshipPathSpecification;
90
- }
91
- /**
92
- * Specification uses ECClass name as the label content.
93
- *
94
- * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
95
- * @public
96
- */
97
- export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
98
- specType: "ClassName";
99
- /** Should full (`{schemaName}.{className}`) class name be used */
100
- full?: boolean;
101
- }
102
- /**
103
- * Specification uses ECClass display label as the label content.
104
- *
105
- * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
106
- * @public
107
- */
108
- export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
109
- specType: "ClassLabel";
110
- }
111
- /**
112
- * Specification returns ECInstance's briefcase ID in base36 format.
113
- *
114
- * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
115
- * @public
116
- */
117
- export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
118
- specType: "BriefcaseId";
119
- }
120
- /**
121
- * Specification returns ECInstance's local ID in base36 format.
122
- *
123
- * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
124
- * @public
125
- */
126
- export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
127
- specType: "LocalId";
128
- }
129
- /**
130
- * Specification uses the specified value as the label content.
131
- *
132
- * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
133
- * @public
134
- */
135
- export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
136
- specType: "String";
137
- /** The value to use as the label content. */
138
- value: string;
139
- }
140
- /**
141
- * Specification uses label of another related instance as the label content.
142
- *
143
- * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
144
- * @public
145
- */
146
- export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
147
- specType: "RelatedInstanceLabel";
148
- /**
149
- * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
150
- * to class of the related instance.
151
- */
152
- pathToRelatedInstance: RelationshipPathSpecification;
153
- }
154
- /**
155
- * Specification to define how the label for [[InstanceLabelOverride]] should be created.
156
- * @public
157
- */
158
- export declare type InstanceLabelOverrideValueSpecification = InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification | InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification | InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification | InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;
1
+ /** @packageDocumentation
2
+ * @module PresentationRules
3
+ */
4
+ import { SingleSchemaClassSpecification } from "../ClassSpecifications";
5
+ import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
6
+ import { RuleBase } from "../Rule";
7
+ /**
8
+ * Instance label override rule provides a way to set instance label to one of its property values,
9
+ * other attributes and/or combination of them.
10
+ *
11
+ * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
12
+ * @public
13
+ */
14
+ export interface InstanceLabelOverride extends RuleBase {
15
+ /** Used for serializing to JSON. */
16
+ ruleType: "InstanceLabelOverride";
17
+ /**
18
+ * Specifies the ECClass to apply this rule to.
19
+ */
20
+ class: SingleSchemaClassSpecification;
21
+ /**
22
+ * Specifications of values used to override label. The first non-empty value is used as the actual label.
23
+ */
24
+ values: InstanceLabelOverrideValueSpecification[];
25
+ }
26
+ /**
27
+ * Types of possible [[InstanceLabelOverride]] label values.
28
+ * @public
29
+ */
30
+ export declare enum InstanceLabelOverrideValueSpecificationType {
31
+ Composite = "Composite",
32
+ Property = "Property",
33
+ ClassName = "ClassName",
34
+ ClassLabel = "ClassLabel",
35
+ BriefcaseId = "BriefcaseId",
36
+ LocalId = "LocalId",
37
+ String = "String",
38
+ RelatedInstanceLabel = "RelatedInstanceLabel"
39
+ }
40
+ /**
41
+ * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
42
+ * @public
43
+ */
44
+ export interface InstanceLabelOverrideValueSpecificationBase {
45
+ /**
46
+ * Type of the specification
47
+ * @see InstanceLabelOverrideValueSpecificationType
48
+ */
49
+ specType: `${InstanceLabelOverrideValueSpecificationType}`;
50
+ }
51
+ /**
52
+ * Specification allows creating a label value composited using multiple other specifications.
53
+ *
54
+ * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
55
+ * @public
56
+ */
57
+ export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
58
+ specType: "Composite";
59
+ /**
60
+ * Parts of the value.
61
+ *
62
+ * If any of the parts with `isRequired` flag evaluate to an empty string, the
63
+ * result of this specification is also an empty string.
64
+ */
65
+ parts: Array<{
66
+ spec: InstanceLabelOverrideValueSpecification;
67
+ isRequired?: boolean;
68
+ }>;
69
+ /** Separator to use when joining the parts. Defaults to a space character. */
70
+ separator?: string;
71
+ }
72
+ /**
73
+ * Specification uses property value as the label content.
74
+ *
75
+ * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
76
+ * @public
77
+ */
78
+ export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
79
+ specType: "Property";
80
+ /**
81
+ * Name of the property whose value should be used.
82
+ * @note A property with this name must exist on the property class (see [[propertySource]]).
83
+ */
84
+ propertyName: string;
85
+ /**
86
+ * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]
87
+ * to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.
88
+ */
89
+ propertySource?: RelationshipPathSpecification;
90
+ }
91
+ /**
92
+ * Specification uses ECClass name as the label content.
93
+ *
94
+ * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
95
+ * @public
96
+ */
97
+ export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
98
+ specType: "ClassName";
99
+ /** Should full (`{schemaName}.{className}`) class name be used */
100
+ full?: boolean;
101
+ }
102
+ /**
103
+ * Specification uses ECClass display label as the label content.
104
+ *
105
+ * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
106
+ * @public
107
+ */
108
+ export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
109
+ specType: "ClassLabel";
110
+ }
111
+ /**
112
+ * Specification returns ECInstance's briefcase ID in base36 format.
113
+ *
114
+ * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
115
+ * @public
116
+ */
117
+ export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
118
+ specType: "BriefcaseId";
119
+ }
120
+ /**
121
+ * Specification returns ECInstance's local ID in base36 format.
122
+ *
123
+ * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
124
+ * @public
125
+ */
126
+ export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
127
+ specType: "LocalId";
128
+ }
129
+ /**
130
+ * Specification uses the specified value as the label content.
131
+ *
132
+ * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
133
+ * @public
134
+ */
135
+ export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
136
+ specType: "String";
137
+ /** The value to use as the label content. */
138
+ value: string;
139
+ }
140
+ /**
141
+ * Specification uses label of another related instance as the label content.
142
+ *
143
+ * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
144
+ * @public
145
+ */
146
+ export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
147
+ specType: "RelatedInstanceLabel";
148
+ /**
149
+ * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
150
+ * to class of the related instance.
151
+ */
152
+ pathToRelatedInstance: RelationshipPathSpecification;
153
+ }
154
+ /**
155
+ * Specification to define how the label for [[InstanceLabelOverride]] should be created.
156
+ * @public
157
+ */
158
+ export type InstanceLabelOverrideValueSpecification = InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification | InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification | InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification | InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;
159
159
  //# sourceMappingURL=InstanceLabelOverride.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;;OAGG;IACH,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,oBAAY,uCAAuC,GACjD,gDAAgD,GAAG,+CAA+C,GAClG,6CAA6C,GAAG,2CAA2C,GAC3F,4CAA4C,GAAG,6CAA6C,GAC5F,yCAAyC,GAAG,sDAAsD,CAAC"}
1
+ {"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;;OAGG;IACH,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,gDAAgD,GAAG,+CAA+C,GAClG,6CAA6C,GAAG,2CAA2C,GAC3F,4CAA4C,GAAG,6CAA6C,GAC5F,yCAAyC,GAAG,sDAAsD,CAAC"}
@@ -1,26 +1,26 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module PresentationRules
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.InstanceLabelOverrideValueSpecificationType = void 0;
11
- /**
12
- * Types of possible [[InstanceLabelOverride]] label values.
13
- * @public
14
- */
15
- var InstanceLabelOverrideValueSpecificationType;
16
- (function (InstanceLabelOverrideValueSpecificationType) {
17
- InstanceLabelOverrideValueSpecificationType["Composite"] = "Composite";
18
- InstanceLabelOverrideValueSpecificationType["Property"] = "Property";
19
- InstanceLabelOverrideValueSpecificationType["ClassName"] = "ClassName";
20
- InstanceLabelOverrideValueSpecificationType["ClassLabel"] = "ClassLabel";
21
- InstanceLabelOverrideValueSpecificationType["BriefcaseId"] = "BriefcaseId";
22
- InstanceLabelOverrideValueSpecificationType["LocalId"] = "LocalId";
23
- InstanceLabelOverrideValueSpecificationType["String"] = "String";
24
- InstanceLabelOverrideValueSpecificationType["RelatedInstanceLabel"] = "RelatedInstanceLabel";
25
- })(InstanceLabelOverrideValueSpecificationType = exports.InstanceLabelOverrideValueSpecificationType || (exports.InstanceLabelOverrideValueSpecificationType = {}));
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module PresentationRules
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.InstanceLabelOverrideValueSpecificationType = void 0;
11
+ /**
12
+ * Types of possible [[InstanceLabelOverride]] label values.
13
+ * @public
14
+ */
15
+ var InstanceLabelOverrideValueSpecificationType;
16
+ (function (InstanceLabelOverrideValueSpecificationType) {
17
+ InstanceLabelOverrideValueSpecificationType["Composite"] = "Composite";
18
+ InstanceLabelOverrideValueSpecificationType["Property"] = "Property";
19
+ InstanceLabelOverrideValueSpecificationType["ClassName"] = "ClassName";
20
+ InstanceLabelOverrideValueSpecificationType["ClassLabel"] = "ClassLabel";
21
+ InstanceLabelOverrideValueSpecificationType["BriefcaseId"] = "BriefcaseId";
22
+ InstanceLabelOverrideValueSpecificationType["LocalId"] = "LocalId";
23
+ InstanceLabelOverrideValueSpecificationType["String"] = "String";
24
+ InstanceLabelOverrideValueSpecificationType["RelatedInstanceLabel"] = "RelatedInstanceLabel";
25
+ })(InstanceLabelOverrideValueSpecificationType = exports.InstanceLabelOverrideValueSpecificationType || (exports.InstanceLabelOverrideValueSpecificationType = {}));
26
26
  //# sourceMappingURL=InstanceLabelOverride.js.map