Class BimContext

constructor

• new BimContext(options: BimContextOptions): BimContext

  Parameters

  • options: BimContextOptions

  Returns BimContext

Readonlybcf

Readonlybsdd

Readonlyclash

Readonlycost

Readonlycreate

Readonlydrawing

Readonlyevents

Readonlyexport

Readonlyfiles

Readonlyids

Readonlylens

Readonlylist

Readonlymodel

Readonlymutate

Readonlysandbox

Readonlyschedule

Readonlyspaces

Readonlyspatial

Readonlystore

Readonlystructural

Readonlystyle

Readonlyviewer

on

• get on(): <T extends BimEventType>(
      event: T,
      handler: BimEventHandler<T>,
  ) => () => void

  Subscribe to an event.

  Usage: bim.on('selection:changed', ({ refs }) => console.log(refs))

  Returns <T extends BimEventType>(event: T, handler: BimEventHandler<T>) => () => void

  • • <T extends BimEventType>(event: T, handler: BimEventHandler<T>): () => void

    • Subscribe to an event. Returns unsubscribe function.

      Type Parameters

      • T extends BimEventType

      Parameters

      • event: T
      • handler: BimEventHandler<T>

      Returns () => void

attributes

• attributes(ref: EntityRef): EntityAttributeData[]

  Get all named string/enum attributes for an entity.

  Parameters

  • ref: EntityRef

  Returns EntityAttributeData[]

classifications

• classifications(ref: EntityRef): ClassificationData[]

  Get all classifications for an entity.

  Parameters

  • ref: EntityRef

  Returns ClassificationData[]

containedIn

• containedIn(ref: EntityRef): EntityData | null

  Get the spatial container of an entity.

  Parameters

  • ref: EntityRef

  Returns EntityData | null

contains

• contains(ref: EntityRef): EntityData[]

  Get entities contained in a spatial container.

  Parameters

  • ref: EntityRef

  Returns EntityData[]

decomposedBy

• decomposedBy(ref: EntityRef): EntityData | null

  Get the parent aggregate of an entity.

  Parameters

  • ref: EntityRef

  Returns EntityData | null

decomposes

• decomposes(ref: EntityRef): EntityData[]

  Get aggregated children of an entity.

  Parameters

  • ref: EntityRef

  Returns EntityData[]

documents

• documents(ref: EntityRef): DocumentData[]

  Get linked documents for an entity.

  Parameters

  • ref: EntityRef

  Returns DocumentData[]

entity

• entity(ref: EntityRef): EntityData | null

  Get a single entity by reference.

  Parameters

  • ref: EntityRef

  Returns EntityData | null

matchingActiveFilter

• matchingActiveFilter(): EntityData[] | null

  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

materials

• materials(ref: EntityRef): MaterialData | null

  Get material assignment for an entity.

  Parameters

  • ref: EntityRef

  Returns MaterialData | null

path

• path(ref: EntityRef): EntityData[]

  Get the spatial/aggregation path from project to entity.

  Parameters

  • ref: EntityRef

  Returns EntityData[]

properties

• properties(ref: EntityRef): PropertySetData[]

  Get all property sets for an entity.

  Parameters

  • ref: EntityRef

  Returns PropertySetData[]

property

• property(
      ref: EntityRef,
      psetName: string,
      propName: string,
  ): string | number | boolean | null

  Get a single property value for an entity.

  Parameters

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

  Returns string | number | boolean | null

quantities

• quantities(ref: EntityRef): QuantitySetData[]

  Get all quantity sets for an entity.

  Parameters

  • ref: EntityRef

  Returns QuantitySetData[]

quantity

• quantity(
      ref: EntityRef,
      qsetNameOrQuantityName: string,
      quantityName?: string,
  ): number | null

  Get a single quantity value. Supports 2-arg (ref, quantityName) or 3-arg (ref, qsetName, quantityName).

  Parameters

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

  Returns number | null

query

• query(): QueryBuilder

  Start a new query chain.

  Usage: bim.query().byType('IfcWall').where('Pset_WallCommon', 'IsExternal', '=', true).toArray()

  Returns QueryBuilder

related

• related(
      ref: EntityRef,
      relType: string,
      direction: "forward" | "inverse",
  ): EntityData[]

  Get related entities by IFC relationship type.

  Parameters

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

  Returns EntityData[]

relationships

• relationships(ref: EntityRef): EntityRelationshipsData

  Get structural relationship summary for an entity.

  Parameters

  • ref: EntityRef

  Returns EntityRelationshipsData

storey

• storey(ref: EntityRef): EntityData | null

  Get the containing building storey of an entity.

  Parameters

  • ref: EntityRef

  Returns EntityData | null

storeys

• storeys(): EntityData[]

  Get all storeys across the current model scope.

  Returns EntityData[]

typeProperties

• typeProperties(ref: EntityRef): TypePropertiesData | null

  Get type-level property sets for an entity.

  Parameters

  • ref: EntityRef

  Returns TypePropertiesData | null