Webportal v1

embedded apps

API Reference - Navigation.LaunchGuidance()

Edit

Navigation.LaunchGuidance()

Type Method
Min Privacy Public
wave 2
wave 3

Description Starts the navigation to the specified destination.
Response Boolean True if the final destination and Intermediary destinations were all correctly set, else False if the process failed.

IMPORTANT

Caution: Guidance can not be launched when a popup is displayed. To make sure the guidance have actually been launched please check that References return is True.

Parameter Type Description Required
desc String The destination’s description, Should have a length < 60 characters. Required
destLon Number The destination’s longitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Required
destLat Number The destination’s latitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Required
s1Lon Number The first waypoint’s longitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Optional
s1Lat Number The first waypoint’s latitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Optional
s2Lon Number The second waypoint’s longitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Optional
s2Lat Number The second waypoint’s latitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Optional
s3Lon Number The third waypoint’s longitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Optional
s3Lat Number The third waypoint’s latitude, Should be WGS84 Signed Decimal Degrees and have a length < 4 characters. Optional
shifted Number The coordinate system to use, Should be either 0 or 1 Optional

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

var Description ="Ignored"
var DestinationLongitude = 48.866669
var DestinationLatitude = 2.33333
var Waypoint1Lat = 0
var Waypoint1Lon = 0
var Waypoint2Lat = 0
var Waypoint2Lon = 0
var Waypoint3Lat = 0
var Waypoint3Lon = 0
var Shifted = 0

if ( Navigation.LaunchGuidance(Description, DestinationLongitude, DestinationLatitude, Waypoint1Lat, Waypoint1Lon, Waypoint2Lat, Waypoint2Lon, Waypoint3Lat, Waypoint3Lon, Shifted) === false ) {
	// Error, Itinerary not correctly set
} else {
	// Itinerary started
}

Remark

Note: Only the destLon and destLat parameters are needed, the others will be ignored, so they can be replaced by 0.

Note 2: The old version of the LaunchGuidance will ask for confirmation before overriding the current journey with the one being passed.

Note 3: The Navigation events are triggered only if the Navigation was launched using either LaunchGuidance or LaunchGuidanceWaypoints.

Appeared in Software version 40.03.42.30

Back to Ref List

Related References