Class Bim

API Namespace BIM is used for BIM related API calls.

Index

Constructors

Methods

listAvailableDisciplines listBuildingStoreys query queryQids setDiscipline validateQuery

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:483

listBuildingStoreys

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

query

query(
    models: Iterable<string>,
    query: string,
    useCache?: boolean,
    forceGetQid?: boolean,
): Promise<unknown>
Query one or models
Parameters
- models: Iterable<string>
  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
- OptionalforceGetQid: boolean
  Queries without a GET statement will automatically returns Qids only, but BQL with a GET statement does not. Setting this parameter to true (default: false) forces Qids to be returned even when not included in the GET statement
Returns Promise<unknown>
A Promise that resolves to the query results, currently untyped.
- Defined in BimWorksJsSdk/jssdk.d.ts:463

queryQids

queryQids(
    models: Iterable<string>,
    query: string,
    useCache?: boolean,
): Promise<QidSet>
Specialized (and optimized) call to execute a query and get the results as a QidSet. Regardless of any GET statements that are included in the BQL query, only Qids will be retrieved
Parameters
- models: Iterable<string>
  The Vids of the models that you want to query
- query: string
  The query 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<QidSet>
A Promise that resolves to a QidSet
- Defined in BimWorksJsSdk/jssdk.d.ts:472

setDiscipline

setDiscipline(versionUuid: string, discipline: 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:490

validateQuery

validateQuery(query: string): Promise<boolean>
Validate a BQL query
Parameters
- query: string
Returns Promise<boolean>
A Promise that resolves to true when the query was valid, otherwise the promise fails with the appropriate error message
- Defined in BimWorksJsSdk/jssdk.d.ts:478