Learning > presentation > hierarchies > Related Instance Nodes

RelatedInstanceNodes

Based on RelatedInstanceNodesSpecification interface.

Returns nodes for instances related to parent instance node.

Precondition: can be used only if parent node is ECInstance node. If there is no immediate parent instance node, the rules engine walks up the hierarchy until it finds one. If that fails, this specification has no effect.

Attributes

Name	Required?	Type	Default	Meaning	Performance Notes
Filtering
`relationshipPaths`	Yes	`RelationshipPathSpecification[]`		List of relationship path specifications to follow when looking for related class instances.
`instanceFilter`	No	ECExpression	`""`	Condition for filtering instances
`hideNodesInHierarchy`	No	`boolean`	`false`	Hide instance nodes provided by this specification and directly show their children.	Expensive
`hideIfNoChildren`	No	`boolean`	`false`	Hide nodes if they don't have children.	Expensive
`hideExpression`	No	ECExpression	`""`	An ECExpression that indicates whether a node should be hidden or not.	Expensive
`suppressSimilarAncestorsCheck`	No	`boolean`	`false`	Suppress similar ancestor nodes' checking when creating nodes based on this specification. See more
Ordering
`priority`	No	`number`	`1000`	Changes the order of specifications used to create nodes for specific branch.
`doNotSort`	No	`boolean`	`false`	Suppress default sorting of nodes returned by this specification.	Improves
Grouping
`groupByClass`	No	`boolean`	`true`	Group instances by ECClass
`groupByLabel`	No	`boolean`	`true`	Group instances by label	Expensive
Misc.
`hasChildren`	No	`"Always" \| "Never" \| "Unknown"`	`"Unknown"`	Tells the rules engine that nodes produced using this specification always or never have children.	Improves
`relatedInstances`	No	`RelatedInstanceSpecification[]`	`[]`	Specifications of related instances that can be used in nodes' creation.
`nestedRules`	No	`ChildNodeRule[]`	`[]`	Specifications of nested child node rules.

Example

{
  "specType": "RelatedInstanceNodes",
  "groupByClass": false,
  "groupByLabel": false,
  "relationshipPaths": [{
    "relationship": { "schemaName": "BisCore", "className": "ModelContainsElements" },
    "direction": "Forward",
    "targetClass": { "schemaName": "BisCore", "className": "PhysicalElement" }
  }]
}

Last Updated: 12 June, 2024