IFClite TypeScript API
    Preparing search index...

    Class QueryNamespace

    bim.query — Chainable entity queries + entity data access

    Index
    • Entities matching the host's active advanced filter, or null when no filter is active. Use for "export only the current filtered view" flows.

      Returns EntityData[] | null

    • Get a single property value. psetName / propName accept Bonsai-style /regex/ patterns (e.g. /Pset_.*Common/), so one call can read across several matching property sets; a plain name is an exact match. Returns the first match in set/property order.

      Parameters

      • ref: EntityRef
      • psetName: string
      • propName: string

      Returns string | number | boolean | null

    • Get a single quantity value. Supports 2-arg (ref, quantityName) or 3-arg (ref, qsetName, quantityName). Qset / quantity names accept Bonsai-style /regex/ patterns (e.g. /Qto_.*BaseQuantities/), so one call can read a quantity across several matching sets; a plain name is an exact match. Returns the first match in set/quantity order.

      Parameters

      • ref: EntityRef
      • qsetNameOrQuantityName: string
      • OptionalquantityName: string

      Returns number | null

    • Get related entities by IFC relationship type

      Parameters

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

      Returns EntityData[]