Manual Reference Source

Typedef

Static Public Summary
public
public
public
public
public
public
public
public
public
public
public
public
public

BIMTreeNodeType: 'level' | 'category' | 'family' | 'type' | 'element'

public
public
public
public
public
public

Static Public

public BIMCategories: Object<string, BIMCategory> source

public BIMCategory: Object source

Properties:

NameTypeAttributeDescription
type BIMTreeNodeType
id string
levelId string
families string[]

public BIMElement: Object source

Properties:

NameTypeAttributeDescription
type BIMTreeNodeType
id string
name string
docAndCatId number
modelId string
elementId string
typeId string

public BIMElements: Object<string, BIMElement> source

public BIMFamilies: Object<string, BIMFamily> source

public BIMFamily: Object source

Properties:

NameTypeAttributeDescription
type BIMTreeNodeType
id string
levelId string
categoryId string
types string[]

public BIMLevel: Object source

Properties:

NameTypeAttributeDescription
type BIMTreeNodeType
id string
modelId string
families string[]
categories string[]

public BIMLevels: Object<string, BIMLevel> source

public BIMModel: Object source

Properties:

NameTypeAttributeDescription
type BIMTreeNodeType
id string
originModelId string
  • optional
levels string[]

public BIMModels: Object<string, BIMModel> source

public BIMProperty: Object source

Properties:

NameTypeAttributeDescription
name string

property name

group string

property group name

groupKey number

key of property group

strValue string
  • optional

property value if its a string

numValue number
  • optional

property value if its a number

unit string
  • optional

property unit

public BIMTree: Object source

Properties:

NameTypeAttributeDescription
elements BIMElements

elements in BIM tree

types BIMTypes

types in BIM tree

families BIMFamilies

families in BIM tree

categories BIMCategories

categories in BIM tree

levels BIMLevels

levels in BIM tree

models BIMModels

models in BIM tree

public BIMTreeNodeType: 'level' | 'category' | 'family' | 'type' | 'element' source

public BIMType: Object source

Properties:

NameTypeAttributeDescription
type BIMTreeNodeType
id string
familyId string
elements string[]

public BIMTypes: Object<string, BIMType> source

public Comment: Object source

Properties:

NameTypeAttributeDescription
subject string

The title of the comment.

text string

The body text of the comment.

userData string

The user's customized data in string.

public Model: Object source

Properties:

NameTypeAttributeDescription
id string

model id

name string

model name

createdAt string

model creation time ISO date string

public Viewer3DConfig: Object source

Properties:

NameTypeAttributeDescription
isMobile boolean

If it is on mobile platform. By default it is false.

alpha boolean

If viewer has alpha channel so DOM behind it can be visible. By default it is false.

stencil boolean

If viewer provides stencil test. By default it is false.

samples number

If viewer provide anti-aliasing with given sample number. By default it is 4.

public ViewerConfig: Object source

Properties:

NameTypeAttributeDescription
isMobile boolean

If it is on mobile platform. By default it is false.