API Reference > presentation-common > PresentationRules > DEPRECATED_RelatedInstanceNodesSpecification

DEPRECATED_RelatedInstanceNodesSpecification Interface

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

Extends

Properties

Name Type Description
instanceFilter undefined | string Condition for filtering instances of defined classes.  
relatedClasses MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[] Related classes whose instances should be returned as content.  
relationships MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[] Relationships that should be followed when gathering content.  
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 RelatedInstanceNodes Used for serializing to JSON.  
supportedSchemas undefined | string[] Names of ECSchemas used to look up relationships and classes when DEPRECATED_RelatedInstanceNodesSpecification.relationships  

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