IFClite TypeScript API
    Preparing search index...

    Interface QueryBackendMethods

    interface QueryBackendMethods {
        attributes(ref: EntityRef): EntityAttributeData[];
        classifications(ref: EntityRef): ClassificationData[];
        documents(ref: EntityRef): DocumentData[];
        entities(descriptor: QueryDescriptor): EntityData[];
        entitiesMatchingActiveFilter(): EntityData[] | null;
        entityData(ref: EntityRef): EntityData | null;
        materials(ref: EntityRef): MaterialData | null;
        properties(ref: EntityRef): PropertySetData[];
        quantities(ref: EntityRef): QuantitySetData[];
        related(
            ref: EntityRef,
            relType: string,
            direction: "forward" | "inverse",
        ): EntityRef[];
        relationships(ref: EntityRef): EntityRelationshipsData;
        typeProperties(ref: EntityRef): TypePropertiesData | null;
    }
    Index
    attributes classifications documents entities entitiesMatchingActiveFilter entityData materials properties quantities related relationships typeProperties

    • Entities matching the host's active advanced filter, or null when no filter is active (distinguishes "no filter" from "filter with zero matches"). Host-specific.

      Returns EntityData[] | null

    • Parameters

      • ref: EntityRef
      • relType: string
      • direction: "forward" | "inverse"

      Returns EntityRef[]

    Settings
    Member Visibility

    On This Page
    Methods