Logo
Developer

VisioWeb Essential 1.16.1

Class

VisioWebEssential

This module is based on VisioWeb and provides simplified high-level APIs to developers
to help them focusing on the user experience and application development.
It is composed of 4 sub-modules: content, venue, route and navigation.

Constructor

new VisioWebEssential(arguments)

Parameters:
Name Type Description
arguments Object
Properties
Name Type Description
element DOMElement | string the DOMElement that will hold the map view. It can be provided as a selector string.
imagePath string the file path where images expected by VisioWeb (various icons) are stored.
Since:
  • 1.10.0
See:
Example
var essential = new VisioWebEssential({element: '#container', imagePath: '../media'});

Members summary


Name Description
visiowebAPIs Direct mapping of some VisioWeb APIs that can be useful for many use cases.
Currently: on, once, off and animateValue.
venue Sub-module dedicated to venue layout and viewpoint management.
content Sub-module dedicated to content and map data management.
route Sub-module dedicated to route computation and display.
navigation Sub-module dedicated to navigation instructions management.
defaultParameters The default set of parameters which configures VisioWeb Essential.
It's available as a read-only, static member to quickly access the default values or to learn how VisioWeb Essential can be configured.
version The SDK version. Must be the same as the VisioWeb library's.
It's available as a read-only, static member.
parameters Compiled set of parameters configuring VisioWeb Essential
location Describes the user location using an ID or a position {lat, lon}. To set it, use setParameters({parameters: location: (...)})

Methods summary


Name Description
setParameters Configure VisioWeb Essential by providing a complete or partial set of parameters that will be merged with the default set.
createMapviewer Initializes VisioWeb's Mapviewer taking into account the parameters
destroyMapviewer Destroys VisioWeb's Mapviewer.
onObjectMouseUp Callback invoked when user interacts with some identified object of the scene. Default implementation calls Content#setActivePlace with the targetElement as input place.
onObjectMouseOver Callback invoked when user hovers some identified object of the scene. Default implementation calls Content#setHighlightedPlace with the targetElement as input place.
onObjectMouseOut Callback invoked when user moves out of some identified object of the scene. Default implementation calls Content#resetHighlightedPlace.
onLoadProgress Callback invoked during VisioWeb's loading process.
Not implemented by default. Can be overloaded to show the progress information to the user.

Members detail

(constant) visiowebAPIs

Direct mapping of some VisioWeb APIs that can be useful for many use cases.
Currently: on, once, off and animateValue.
Since:
  • 1.10.0
See:
Example
essential.on('exploreStateWillChange', event => {
     const targetExploreState = event.args.target;
     const currentExploreState = event.args.current;
     (...)
}

venue

Sub-module dedicated to venue layout and viewpoint management.
Since:
  • 1.10.0
See:

content

Sub-module dedicated to content and map data management.
Since:
  • 1.10.0
See:

route

Sub-module dedicated to route computation and display.
Since:
  • 1.10.0
See:

navigation

Sub-module dedicated to navigation instructions management.
Since:
  • 1.10.0
See:

(constant) defaultParameters

The default set of parameters which configures VisioWeb Essential.
It's available as a read-only, static member to quickly access the default values or to learn how VisioWeb Essential can be configured.
Since:
  • 1.10.0
Example
const defaultParameters = VisioWebEssential.defaultParameters;

(constant) version

The SDK version. Must be the same as the VisioWeb library's.
It's available as a read-only, static member.
Since:
  • 1.10.0
Example
const sdkVersion = VisioWebEssential.version;

(readonly) parameters :Object

Compiled set of parameters configuring VisioWeb Essential
Since:
  • 1.10.0
See:

(readonly) location :string|Object

Describes the user location using an ID or a position {lat, lon}. To set it, use setParameters({parameters: location: (...)})
Since:
  • 1.10.0
See:

Methods detail

setParameters(arguments)

Configure VisioWeb Essential by providing a complete or partial set of parameters that will be merged with the default set.
Parameters:
Name Type Description
arguments Object
Properties
Name Type Description
parameters Object the input set of parameters
Since:
  • 1.10.0
See:

createMapviewer() → {Promise}

Initializes VisioWeb's Mapviewer taking into account the parameters
Since:
  • 1.10.0
Returns:
Type
Promise

destroyMapviewer() → {Promise}

Destroys VisioWeb's Mapviewer.
Since:
  • 1.10.0
See:
Returns:
Type
Promise

onObjectMouseUp(arguments)

Callback invoked when user interacts with some identified object of the scene. Default implementation calls Content#setActivePlace with the targetElement as input place.
Parameters:
Name Type Description
arguments Object
Properties
Name Type Description
targetElement Object the event's target element
Since:
  • 1.10.0

onObjectMouseOver(arguments)

Callback invoked when user hovers some identified object of the scene. Default implementation calls Content#setHighlightedPlace with the targetElement as input place.
Parameters:
Name Type Description
arguments Object
Properties
Name Type Description
targetElement Object the event's target element
Since:
  • 1.10.0

onObjectMouseOut()

Callback invoked when user moves out of some identified object of the scene. Default implementation calls Content#resetHighlightedPlace.
Since:
  • 1.10.0

onLoadProgress(value)

Callback invoked during VisioWeb's loading process.
Not implemented by default. Can be overloaded to show the progress information to the user.
Parameters:
Name Type Description
value number the progress percentage as a number between 0 and 1
Since:
  • 1.10.0