VCAD DOCUMENTATION
< All Topics
Print

Forge viewer Bindings

ObjectId

The ObjectId field of the objects to render.
The field is used to select geometries in the model.

 

NOTE: This is the only mandatory fields for the custom visual to work.

Floor Filter

Allows the segmentation of the model based on selected Floors / Levels.

The field accepts a single binding which can be either the floor/level name or the levelObjectId

 

NOTE: To filter floors/levels it is also necessary to setup the Floor Filtert options.

Highlight Color

Allows the binding of theme colors to apply themes on the model.

The field accepts a multiple bindings with fields that must describe colors in hex format.

 

NOTE: To apply colors to the model it is also necessary to setup the Theme Colors options.

Marker Style

The Marker Style data binding allows the matching between the marker style defined in the marker settings window of the custom visual and the data fed to Vcad.

For the style to be correctly loaded and applied to the marker, it is important that the Type field in the marker configuration correspond fully (including case) with the values bound to the Marker Style data binding.

 

NOTE: To apply colors to the model it is also necessary to setup the Markers.

Marker Text (Beta)

Allow the rendering of a short text in the location of a marker.

 

NOTE: To apply colors to the model it is also necessary to setup the Markers.

Marker Color

The Marker Color data binding allows the definition of a color to apply to the rendered markers. This data binding works similarly to the Highlight Color data banding as it also accepts a hex color code.

 

NOTE: To apply colors to the model it is also necessary to setup the Markers.

Marker Position

The Marker Position data binding allows the definition of x,y,z coordinates to be used to position the markers in the model space instead of automatically calculating the geometric center of the selected assets.

The coordinates must be in one of the following forms

  • {x: -4.2, y: 41.5, z: -17.5}
  • {‘x’: -4.2, ‘y’: 41.5, ‘z’: -17.5}
  • {“x”: -4.2, “y”: 41.5, “z”: -17.5}

 

NOTE: To apply colors to the model it is also necessary to setup the Markers.

Marker GUID

Allows the unique identification of a marker.

This information is important when using the Marker Filter Mode option.

 

NOTE: To apply colors to the model it is also necessary to setup the Markers.

IoT Timestamp

Allow a definition of a timestamp for markers.

This information is important when using the Marker Filter Mode option.

 

 

NOTE: To apply colors to the model it is also necessary to setup the Markers.

Previous Forge viewer options
Next Open viewer options
Table of Contents