Manual Reference Source

References

summary
public

F init(config: InitConfig)

Initialize and configure Modelo API.

public

Asset

summary
public

F get(assetId: string): Promise<Asset, Error>

Get information of an asset.

public

F remove(assetId: string): Promise<string, Error>

Remove an asset.

public

F update(assetId: string, name: string): Promise<string, Error>

Rename the asset.

public

F upload(file: File, onProgress: function(progress: number): void): Promise<Asset, Error>

Upload an asset to cloud.

public

BIM

summary
public

Get all BIM properties of a single element.

public

F getElementsProperties(modelId: string, elementIds: string[]): Promise<BIMProperty[], Error>

Get common BIM properties of some elements.

public

Get the BIM structure of a model.

public

F updateElementProperty(modelId: string, elementId: string, property: {name: string, groupKey: number, strValue: ?string, numValue: ?number}): Promise<BIMProperty, Error>

Update the value of one BIM property of a single element.

public

F updateElementsProperty(modelId: string, elementIds: number, property: {name: string, groupKey: number, strValue: ?string, numValue: ?number}): Promise<BIMProperty, Error>

Update the value of a common property of some elements.

public
public
public
public
public
public
public
public
public
public
public
public
public

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

public
public

Comment

summary
public

F activate(commentId: number): *

Make a model comment in current viewer to be the current comment.

public

F create(modelId: string, extData: Object): Promise<Comment, Error>

Create a model comment with model id and extData.

public

F get(modelId: string): Pormise<Comment[], Error>

Get all model comments with model id.

public

F remove(commentId: number): Promise<number, Error>

Remove a model comment.

public

F update(commentId: number, extData: Object): Promise<number, Error>

Update user-defined data in a model comment.

public

Model

summary
public

F compare(modelId1: string, modelId2: string): Promise<newElements1, newElements2, updatedElements1, updatedElements2, Error>

Compare two models.

public

Generate a 3D PDF file from a model.

public

F get(modelId: string): Promise<Model, Error>

Get information of a model.

public

Get url of a 3D PDF.

public

F merge(name: string, modelIds: string[]): Promise<string, Error>

Merge several models together into one model.

public

F remove(modelId: string): Promise<string, Error>

Remove a model.

public

F update(modelId: string, name: string): Promise<string, Error>

Rename the model.

public

F upload(file: File, onProgress: function(progress: number): void): Promise<Model, Error>

Upload a model.

public

UI

summary
public

A model compare viewer will open two models and show the difference of them.

public

A model viewer is for displaying and manipulating single model.

public

View

summary
public
public

C Viewer

public

A Viewer3D object takes in a HTML5

DOM and draw 3D models over this DOM.

public

View/Input

summary
public
public

C Mouse

View/Tool

summary
public
public
public
public

The base class for mersure tools.

public

A used to measure the angles on the model surface.

public

A tool use to measure the area on model surface.

public

A tool to measure the distance between two points.

public

A tool the measure distance between a fixed point to other points on the model surface.

public

A tool to measure the total length of several un-connected lines.

public

A tool to measure the total length of several un-connected lines.

public
public
public

C Tool

Tool is an abstract base class for all the tools in Modelo3d