JSDoc: Class

Constructor

new Route()

Since:

1.10.0

Members summary

Name	Description
accessible	Whether the future route should be accessible to people with disabilities.
computeNavigation	Whether navigation data should be computed along with the future route.
isValid	Whether a route is currently available or not.

Methods summary

Name	Description
setFrom	Sets the starting point for the upcoming route. It can be provided as a place ID or a position. Triggers the route computation if both starting and ending points are set.
addWaypoint	Adds a waypoint for the upcoming route. It can be provided as a place ID or a position.
setTo	Sets the ending point for the upcoming route. It can be provided as a place ID or a position. Triggers the route computation if both starting and ending points are set or if a location is defined in VisioWebEssential's parameters.
hasFrom	Tells whether a starting point was set for the upcoming route.
hasTo	Tells whether an ending point was set for the upcoming route.
clear	Clears the route and navigation data and resets internal properties.

Members detail

accessible :boolean

Whether the future route should be accessible to people with disabilities.

Since:

1.10.0

computeNavigation :boolean

Whether navigation data should be computed along with the future route.

Since:

1.10.0

isValid :boolean

Whether a route is currently available or not.

Since:

1.10.0

Methods detail

setFrom(arguments)

Sets the starting point for the upcoming route. It can be provided as a place ID or a position. Triggers the route computation if both starting and ending points are set.

Parameters:

Name Type Description

arguments

Object

Properties

Name	Type	Description
`from`	string	the input place ID or position {lat, lon, floor}

Since:

1.10.0

addWaypoint(arguments)

Adds a waypoint for the upcoming route. It can be provided as a place ID or a position.

Parameters:

Name Type Description

arguments

Object

Properties

Name	Type	Description
`waypoint`	string	the input place ID or position {lat, lon, floor}

Since:

1.10.0

setTo(arguments)

Sets the ending point for the upcoming route. It can be provided as a place ID or a position. Triggers the route computation if both starting and ending points are set or if a location is defined in VisioWebEssential's parameters.

Parameters:

Name Type Description

arguments

Object

Properties

Name	Type	Description
`to`	string	the input place ID or position {lat, lon, floor}

Since:

1.10.0

See:

VisioWebEssential#location

hasFrom() → {boolean}

Tells whether a starting point was set for the upcoming route.

Since:

1.10.0

Returns:

Type: boolean

hasTo() → {boolean}

Tells whether an ending point was set for the upcoming route.

Since:

1.10.0

Returns:

Type: boolean

clear()

Clears the route and navigation data and resets internal properties.

Since:

1.10.0