MapAddItinerary (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Map functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

MapAddItinerary (Function)

In french: CarteAjouteItinéraire

Adds an itinerary onto a Map control.

Example

// Affiche un itinéraire automobile entre les deux adresses spécifiées
MapAddItinerary(CARTE_ChampCarte, ["Place de la comédie, Montpellier", ...
		"Avenue des Champs Elysées, Paris"], itineraryCar)

// Affiche un itinéraire correspondant à la liste de positions géographiques spécifiées
posDépart is geoPosition
posDépart.Latitude = XXX
posDépart.Longitude = XXX

posArrivée is geoPosition
posArrivée.Latitude = XXX
posArrivée.Longitude = XXX

MapAddItinerary(CARTE_ChampCarte, [posDépart, posArrivée])

// Il est également possible d'utiliser le code suivant :  
// tabPositions est un tableau de géoPosition
// Ajoute(tabPositions, posDépart)
// Ajoute(tabPositions, posArrivée)
// CarteAjouteItinéraire(CARTE_ChampCarte, tabPositions)

Syntax

<Result> = MapAddItinerary(<Map control> , <Positions> [, <Mode> [, <Color> [, <Opacity> [, <Thickness>]]]])

<Result>: Character string

Identifier of added itinerary,
Empty string ("") if an error occurred. To get more details on the error, use ErrorInfo.
This function is asynchronous: it is not possible to know whether the function has returned an error.

<Map control>: Control name

Name of the Map control to be used. If this parameter corresponds to an empty string (""), the Map control to which the current event belongs will be used.

<Positions>: Array

Name of Array variable containing the different positions:
The first element corresponds to the departure point of itinerary.
The last element corresponds to the arrival point.
The other array elements represent the intermediate steps of itinerary. This array must contain at least two elements (departure position and arrival position). If you are using the default Google Map license, this array can contain up to 8 intermediate positions (steps). If you are using a "Google Maps API" license key, the number of intermediate positions is unlimited.
This array must contain two elements (departure position and arrival position). You cannot specify the different steps of the itinerary.
This array can be:
an array of character strings, describing the address corresponding to each itinerary position. For example: avenue des Champs Elysée, Paris, France.
an array of Address variables, describing the address corresponding to each position of the itinerary.
an array of geoPosition variables, indicating the geographical position corresponding to each itinerary position.
an array of Marker variables, representing each itinerary position on the map (the markers will be automatically added to the Map control if not already added).

<Mode>: Optional Integer constant

Mode for calculating the itinerary. This parameter can take one of the following values:
itineraryCar
(Default value) The itinerary will be drawn taking into account the roads accessible to cars.
Characteristics of this mode:
This mode uses Google's geolocation mode. An Internet access is required.
You can rearrange the order of the stops get the best possible route.
itineraryCarNotOptimized The itinerary will be drawn taking into account the roads accessible to cars.
Characteristics of this mode:
This mode uses Google's geolocation mode. An Internet access is required.
The order of the stops will not be changed.
itineraryCyclist The itinerary will be drawn by respecting the ways accessible to the bicycles. The itineraries for cyclists are not available in all the countries. For more information, please consult the Google geolocation service documentation.
Characteristics of this mode:
This mode uses Google's geolocation mode. An Internet access is required.
You can rearrange the order of the stops get the best possible route.
This constant is not available.
itineraryManual The itinerary will be drawn in a straight line between each specified position while ignoring the roads.
This mode avoids the use of Google's geolocation mode.. In this case, <Positions> must correspond to an array of geoPosition variables or to an array of Marker variables.
In this mode, the intermediate steps are taken into account according to the addition order in the array.
Please note: If you're using Internet Explorer 4, parameter <Positions> parameter must correspond to an array of variables of type geoPosition.
itineraryPedestrian The itinerary will be drawn by respecting the ways accessible to the pedestrians.
Characteristics of this mode:
This mode uses Google's geolocation mode. An Internet access is required.
You can rearrange the order of the stops get the best possible route.
This constant is not available.

<Color>: Optional integer

Color for drawing the itinerary. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.

<Opacity>: Optional integer

Percentage of opacity for drawing the itinerary.
0: transparent trace,
100: no opacity.
This parameter is set to 60 by default.

<Thickness>: Optional integer

Thickness (in pixels) for drawing the itinerary. The thickness is set to 8 pixels by default.

Remarks

Using Google maps: the "Directions" API must be activated in your Google Maps key.
Caution: The order of intermediate stages can be automatically modified to display an optimized route.
To customize the image of the itinerary markers, all you have to do is add the markers beforehand with MapAddMarker on the same itinerary positions.
To delete an itinerary from a map, use MapDeleteItinerary.
To delete all the itineraries from a map, use MapDeleteAll.
Warning Creating routes between two distant positions may require a very large number of points to be stored in memory for route design (particularly for cycle and pedestrian routes). Therefore, we advise you to limit the number of itineraries simultaneously displayed on the Map control.
To manage specific features regarding the management of itineraries, use MapExecuteJS.

Related Examples:

Unit examples (WEBDEV): The Map control

[ + ] This example explains how to use the Map control of WEBDEV.
It can be used to display a map that includes markers as well as an itinerary.

Unit examples (WINDEV): The Map control

[ + ] Using the Map control of WINDEV.
It is used to display a map that includes markers as well as an itinerary.

Cross-platform examples (WINDEV Mobile): WM Sports

[ + ] This example is a sport application used to save your performances.
The application calculates the distance, the time, the average speed and the number of calories spent according to the sport.
The run is displayed on a map control via markers and an itinerary.

The example also includes a server part used to synchronize the user data.
This webservice is available in the WEBDEV "WW_Sports" example.

Component: wd300obj.dll