Name

JS Data Type

Description

projectId

string

The ID of the project

streamingUrl

string

The URL of the streaming server

restUrl

string

The URL of rest server

viewId

string

The ID of the view

viewJSON

JSON Object

A JSON Object containing description of layers

project

JSON Object

The project entities associated to this view

zoomToExtent

Boolean

Show/Hide zoom to extent button

fullscreen

Boolean

Show/Hide full screen button

home

Boolean

Show/Hide Home button

options

Boolean

Show/Hide options button

showControlsInView

Boolean

Show the controls inside/outside of the view

onRegionChange

function

Event Notification is triggered when a change in a region occurs.

The event includes the following properties:

 - voxelfarmPoints: the position of the region in Voxel Farm coordinates.

 - voxelfarmMinY: min Y in Voxel Farm coordinates.

 - voxelfarmMaxY: max Y in Voxel Farm coordinates.

 - worldPoints: the position of the region in World coordinates.

 - worldMinZ: min Z in world coordinates.

 - worldMaxZ: max Z in world coordinates.

onLayerClick

function

Event Notification is triggered when clicking on a layer.

The event includes the following properties:

  - eventType: mousedown/mouseup

  - canvasPosition: the position of the canvas.

  - layerId: the layer Id where the click occurred.

  - Position: the position of the click in the screen.

  - voxelfarmPosition: the position of the layer in Voxel Farm coordinates.

  - windowPosition: the position of the window.

  - worldPosition: the position of the layer in world coordinates.

onCameraChange

function

Event Notification is triggered when the camera of the viewer change.

onCameraRotate

function

Event Notification is triggered when the camera of the viewer rotates.

onCrossSectionChange

function

Event Notification is triggered when the cross section of the viewer change.

onBusy

function

Event Notification is triggered when the viewer is busy.

onNewScene

function

Event Notification is triggered when the new scene is loaded.

onError

function

Event Notification is triggered when the viewer is throwing an error.

requestAuthToken

function

Optional Function if authentication is required, it returns the authorization token