Class Bim

API Namespace BIM is used for BIM related API calls.

Index

Constructors

Methods

listAvailableDisciplines listBuildingStoreys query queryQids setDiscipline

Constructors

constructor

new Bim(): Bim
Returns Bim

Methods

listAvailableDisciplines

listAvailableDisciplines(): Promise<Discipline[]>
List all available Discipline

Returns Promise<Discipline[]>
- Defined in BimWorksJsSdk/jssdk.d.ts:427

listBuildingStoreys

listBuildingStoreys(models): Promise<unknown>
Using "any" on purpose here, otherwise crazy casting required
Parameters
- models: Iterable<string, any, any>
Returns Promise<unknown>
- Defined in BimWorksJsSdk/jssdk.d.ts:387

query

query(models, query, useCache?): Promise<unknown>
Query one or models
Parameters
- models: Iterable<string, any, any>
  One ore more Vid
- query: string
  The query (BQL) to execute
- OptionaluseCache: boolean
  Whether the results should internally be cached so that future calls to the same query+models are faster. Defaults to false. Use this judiciously as the results are cached in memory until the BimWorksClient is closed
Returns Promise<unknown>
A Promise that resolved to the query results, currently untyped.
- Defined in BimWorksJsSdk/jssdk.d.ts:413

queryQids

queryQids(models, query, useCache?): Promise<QidSet>
Specialized (and optimized) call to query directly to a QidSet.
Parameters
- models: Iterable<string, any, any>
  The Vids of the models that you want to query
- query: string
  The query to execute, make sure it will only return Qids (e.a. omit the GET part)
- OptionaluseCache: boolean
  Whether the results should internally be cached so that future calls to the same query+models are faster. Defaults to false. Use this judiciously as the results are cached in memory until the BimWorksClient is closed
Returns Promise<QidSet>
A Promise that resolves to a QidSet
- Defined in BimWorksJsSdk/jssdk.d.ts:422

setDiscipline

setDiscipline(versionUuid, discipline): Promise<void>
Set the discipline of the given Version
Parameters
- versionUuid: string
  the Vid of the Version
- discipline: Discipline
  The new discipline
Returns Promise<void>
- Defined in BimWorksJsSdk/jssdk.d.ts:434