@itwin/presentation-common/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts

Common pieces for iModel.js presentation packages

/** @packageDocumentation
 * @module PresentationRules
 */
import { RepeatableRelationshipPathSpecification } from "../RelationshipPathSpecification.js";
import { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification.js";
/**
 * Produces ECInstance nodes that are related to some source ECInstance. The source instance is determined
 * by traversing the hierarchy upwards until an ECInstance node is encountered.
 *
 * @see [Related instance nodes specification reference documentation page]($docs/presentation/hierarchies/RelatedInstanceNodes.md)
 * @public
 * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
 * package for creating hierarchies.
 */
export interface RelatedInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {
    /** Used for serializing to JSON. */
    specType: "RelatedInstanceNodes";
    /**
     * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md)
     * that forms a path from a source instance to the output instances. When this array is empty, the specification produces
     * no results.
     */
    relationshipPaths: RepeatableRelationshipPathSpecification[];
    /**
     * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering
     * instances of ECClasses targeted through the [[relationshipPaths]] attribute.
     */
    instanceFilter?: string;
}
//# sourceMappingURL=RelatedInstanceNodesSpecification.d.ts.map