Manual Reference Source

Typedef

Static Public Summary
public
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
public

Static Public

public Asset: Object source

Properties:

NameTypeAttributeDescription
id number

The asset id.

name string

The asset name.

downloadUrl string

The asset download url. The download URL is only effective in a short period of time.

createdAt string

Asset creation time in ISO date format.

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

The model ID of original models which is merged into this model.

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, e.g., 'cm' and 'feet'.

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. If it is a merged BIM model or a Revit file with multiple links, it contains a number of model objects. The model here is a conceptually equavilent to model before merge or single Revit link. Most of time, there is one model object in BIMTree object.

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
id number

The comment id.

renderData Object

The data used in rendering engine.

extData Object

The custom user-defined data.

public InitConfig: Object source

Properties:

NameTypeAttributeDescription
endpoint string

The backend endpoint. For applications that use Modelo public cloud, it is always https://build.modeloapp.com.

token string

The application token.

public Model: Object source

Properties:

NameTypeAttributeDescription
id string

The model id.

name string

The model name.

status string

The current model status. For example, it is 'converting' when model is getting converted.

downloadUrl string

The model file download url.

convertedUrls { filename: string, url: string }[]

The converted file urls.

createdAt string

The model creation time in ISO date string.

public ModelViewerConfig: Object source

Properties:

NameTypeAttributeDescription
modelId string

The id of model to load.

containerId string

An HTML div DOM that embodies this viewer. Viewer may create additional HTML DOMs inside this container.

useDefaultFavicon boolean

If use the default Modelo build icon.

onReady function(viewer: Object): void

The callback when the viewer is created. It takes a parameter of the internal Viewer3D object.

onError function(error: Error): void

The callback when any errors happen.

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.