CustomQueryInstanceNodesSpecification Interface

Returns nodes for instances returned by a provided ECSQL query.

@see Custom query instance nodes specification reference documentation page

Extends

Properties

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

Inherited properties

Name Type Inherited from Description
doNotSort boolean | undefined ChildNodeSpecificationBase Suppress sorting of nodes returned by this specification.
groupByClass boolean | undefined DefaultGroupingPropertiesContainer Controls whether returned instances should be grouped by ECClass.
groupByLabel boolean | undefined DefaultGroupingPropertiesContainer Controls whether returned instances should be grouped by label.
hasChildren "Always" | "Never" | "Unknown" ChildNodeSpecificationBase This attribute allows telling the engine that nodes created by this specification always or never have children.
hideExpression string | undefined ChildNodeSpecificationBase When specified ECExpression evaluates
hideIfNoChildren boolean | undefined ChildNodeSpecificationBase Specifies whether nodes created through this specification should be hidden if they have no child nodes.
hideNodesInHierarchy boolean | undefined ChildNodeSpecificationBase When true, instances nodes produced by this specification are omitted and their children appear one
nestedRules ChildNodeRule[] | undefined ChildNodeSpecificationBase Specifications of nested child node rules that
priority number | undefined ChildNodeSpecificationBase Controls the order in which specifications are handled — specification with higher priority value is
relatedInstances RelatedInstanceSpecification[] | undefined ChildNodeSpecificationBase Specifications of related instances that can be used
suppressSimilarAncestorsCheck boolean | undefined ChildNodeSpecificationBase Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this

Defined in

Last Updated: 20 July, 2024