CustomQueryInstanceNodesSpecification Interface

Creates nodes for instances which are returned by an ECSQL query.

Note: this specification is formerly known as SearchResultInstanceNodesSpecification.

Extends

Properties

Name Type Description
queries undefined | QuerySpecification[] Specifications of queries used to create the content.  
specType CustomQueryInstanceNodes Used for serializing to JSON.  

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" = undefined | "Never" = undefined | "Unknown" = undefined ChildNodeSpecificationBase This tells the rules engine that nodes produced using this
specification always or never have children.
hideExpression undefined | string ChildNodeSpecificationBase An ECExpression which
indicates whether a node should be hidden or not.
hideIfNoChildren undefined | boolean ChildNodeSpecificationBase Hide nodes if they don't have children.
hideNodesInHierarchy undefined | boolean ChildNodeSpecificationBase Hide 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 content creation.

Defined in

Last Updated: 10 September, 2019