@itwin/presentation-common/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts

Common pieces for iModel.js presentation packages

/** @packageDocumentation
 * @module PresentationRules
 */
import { Id64String } from "@itwin/core-bentley";
import { SingleSchemaClassSpecification } from "./ClassSpecifications.js";
import { RelationshipPathSpecification } from "./RelationshipPathSpecification.js";
/**
 * Defines base attributes for [[RelatedInstanceByPathSpecification]] and [[RelatedInstanceByTargetInstancesSpecification]].
 * @public
 */
export interface RelatedInstanceSpecificationBase {
    /**
     * Specifies an an alias that given to the related instance. The alias can be used to reference the
     * instance in instance filter and customization rules.
     *
     * @pattern ^\w[\w\d]*$
     */
    alias: string;
    /**
     * Specifies whether to omit the primary instance from the result if the other end of [[relationshipPath]]
     * does not yield any related instances.
     */
    isRequired?: boolean;
}
/**
 * A type of [[RelatedInstanceSpecification]] that joins related instances by a relationship path.
 * @public
 */
export interface RelatedInstanceByPathSpecification extends RelatedInstanceSpecificationBase {
    /**
     * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md)
     * that forms a path from the primary instance to the related instances.
     */
    relationshipPath: RelationshipPathSpecification;
}
/**
 * A type of [[RelatedInstanceSpecification]] that joins related instances by target class and instance IDs.
 * @public
 */
export interface RelatedInstanceByTargetInstancesSpecification extends RelatedInstanceSpecificationBase {
    /**
     * Specifies target class and a list of target ECInstance IDs.
     */
    targetInstances: {
        /** Specification for the target class to join. */
        class: SingleSchemaClassSpecification;
        /** Ids of the target instances to join. */
        instanceIds: Id64String[];
    };
}
/**
 * Related instance specification is used in [content]($docs/presentation/content/ContentRule.md#attribute-specifications)
 * and [hierarchy]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications) specifications to "join" the
 * primary instance with its related instance and allow using the related instance for filtering, customization and grouping.
 *
 * @see [Related instance specification reference documentation page]($docs/presentation/RelatedInstanceSpecification.md)
 * @public
 */
export type RelatedInstanceSpecification = RelatedInstanceByPathSpecification | RelatedInstanceByTargetInstancesSpecification;
//# sourceMappingURL=RelatedInstanceSpecification.d.ts.map