API Reference > presentation-common > PresentationRules > DEPRECATED_AllRelatedInstanceNodesSpecification

DEPRECATED_AllRelatedInstanceNodesSpecification Interface

Deprecated  Use RelatedInstanceNodesSpecification. Will be removed in iModel.js 3.0

Creates nodes for all related instances for parent ECInstance node.

Precondition: can be used only if parent node is ECInstance node. If there is no immediate parent instance node it will go up until it finds one.

Extends

Properties

Name Type Description
requiredDirection undefined | RelationshipDirection Direction that will be followed in the relationship select criteria.  
skipRelatedLevel undefined | number Skips defined level of related items and shows next level related items.  
specType DEPRECATED_AllRelatedInstanceNodes Used for serializing to JSON.  
supportedSchemas undefined | SchemasSpecification Specification of schemas whose instances should be returned.  

Inherited properties

Name Type Inherited from Description
doNotSort undefined | boolean ChildNodeSpecificationBase Set this flag to true to suppress default sorting of ECInstances returned by this specification.
groupByClass undefined | boolean DefaultGroupingPropertiesContainer Group instances by ECClass.
groupByLabel undefined | boolean DefaultGroupingPropertiesContainer Group instances by label.
hasChildren "Always" | "Never" | "Unknown" ChildNodeSpecificationBase This tells the rules engine that nodes produced using this
hideExpression undefined | string ChildNodeSpecificationBase An ECExpression which
hideIfNoChildren undefined | boolean ChildNodeSpecificationBase Hide nodes if they don't have children.
hideNodesInHierarchy undefined | boolean ChildNodeSpecificationBase Hide instance nodes provided by this specification and directly show nodes of its children.
nestedRules undefined | ChildNodeRule[] ChildNodeSpecificationBase Nested rule specifications.
priority undefined | number ChildNodeSpecificationBase Defines the order in which specifications are evaluated and executed.
relatedInstances undefined | RelatedInstanceSpecification[] ChildNodeSpecificationBase Specifications of related instances that can be used in nodes' creation.
suppressSimilarAncestorsCheck undefined | boolean ChildNodeSpecificationBase Suppress similar ancestor nodes' checking when creating nodes based on this specification.

Defined in

Last Updated: 12 June, 2024