GDirections(map?:GMap2, panel?:Element)

Créé une nouvelle instance de l'objet Directions pour demander un itinéraire et stocker le résultat.

Cet objet Directions peut alors créer les itinéraires demandés à l'aide d'une requête utilisant la methode GDirections.load().

Le constructeur prend un objet optionnel carte map (affichant la polyline correspondant à l'itinéraire calculé) et / ou un panneau d'affichage panel sous la forme d'une balise <div> (affichant le résultat de l'itinéraire sous une forme textuelle).

Si l'argument carte map est passé, chaque fois qu'un nouvel nouvel itinéraire sera calculé, la polyline et les marqueurs associés au résultat? seront automatiquement ajoutés en tant que couche sur la carte.

De même, lorsque l'argument panel est passé, le texte décrivant l'itinéraire calculé sera inséré dans la balise <div> indiquée, en remplacement du contenu déjà existant.

Si n'importe lequel de ces arguments est null, les éléments associés ne seront pas récupérés sauf si ils sont explicitement demandés dans la méthode GDirections.load().

Voir ci-dessous :

Depuis la version 2.81

load(query:String, queryOpts?:GDirectionsOptions)

Aucune

Cette méthode émet une nouvelle requête pour calculer un itinéraire.

Le paramètre query est une chaîne contenant n'importe quelle requête valables permettant de calculer un itinéraire, comme par exemple "from: Seattle to:San Francisco" ou "from: Toronto to:Ottawa to: New York».

Par défaut, si une carte a été spécifiée lors de la construction de l'objet GDirections, la requête demandera un résultat sous forme de polyline.

De même, si un panneau d'affichage a été spécifié, la requête demandera un résultat sous la forme d'un descriptif textuel.

Sinon, le résultat contiendra des informations succinctes sur les itinéraires trouvés.

Pour ignorer ce comportement (par exemple pour demander des informations sous forme de polyline, même si aucune carte n'a été attachée à cet objet), les appelants peuvent utiliser le paramètre facultatif queryOpts.

Voir la documentation GDirectionsOptions pour les détails.

Lorsque les résultats issus du calcul de l'itinéraire sont reçus, cet objet efface les anciens résultats, puis les remplace par les nouveaux en mettant à jour la carte et / ou le panneau d'affichage.

Le résultat du calcul d'un itinéraire se compose d'une multitude de routes (objets de type GRoute), une par paire consécutives de waypoints / adresses spécifiées dans la requête.

À leur tour, les routes se composent de plusieurs étapes (objets de type GStep).

Si une précédente requête load() n'est pas achevée quand un nouvel appel à load() est invoqué, la requête précédente est annulée.

Ainsi, vous pouvez utiliser un unique objet GDirections afin d'émettre des requêtes de calcul d'itinéraire en série, mais pour générer des requêtes multiples en parallèle, vous devez utiliser plusieurs objets GDirections

Depuis la version 2.81

loadFromWaypoints(waypoints:Array, queryOpts?:GDirectionsOptions)

Aucune

Émet une requête pour calculer un itinéraire en utilisant un tableau de waypoints ( points d'intérêts ) comme entrée, au lieu d'une requête comportant une chaîne unique.

Ce tableau peut contenir un maximum de 25 entrées ( waypoint ).

Chaque entrée du tableau est une chaîne représentant une adresse postale ou une point à l'aide ses coordonnées latitude / longitude.

Voir GDirections.load() pour plus de détails sur le comportement de cette méthode.

Depuis la version 2.81

clear()

Aucune

Nettoie tous les résultats d'itinéraires existants, supprime les couches itinéraire de la carte, le panneau d'affichage, et annule toutes les requêtes load() en attente.

Depuis la version 2.81

getStatus()

Objet

Retourne l'état de la requête de calcul d'itinéraire.

L'objet retourné a la forme suivante :

• code: 200
• request: "directions"

Le code d'état peut prendre l'une des valeurs définies dans GGeoStatusCode.

Depuis la version 2.81

getBounds()

GLatLngBounds

Cette méthode est utilisée afin d'obtenir la boîte englobant le résultat de la requête de calcul d'itinéraire.

Retourne un objet GLatLngBounds ou null si aucun résultat satisfaisant est disponible.

Depuis la version 2.81

getNumRoutes()

Nombre

Retourne le nombre de routes disponibles dans le résultat.

Pour une requête réussie, cela correspond au nombre total de points de passage diminué d'une unité.

Quand aucun résultat n'est disponible (soit parce qu'aucune requête n'a été émise, soit parce que la requête précédente a échoué), cette méthode retourne 0.

Depuis la version 2.81

getRoute(i:Number)

GRoute

Retourne l'objet GRoute correspondant à la route d'indice i contenue dans l'itinéraire.

Depuis la version 2.81

getNumGeocodes()

Nombre

Retourne le nombre d'entrées géocodées disponibles dans le résultat.

Pour une requête réussie, cela devrait être égal au nombre total de waypoints (points de passage) entrés.

Quand résultat n'est disponible (soit parce qu'aucune requête n'a été émise, soit parce que la requête précédente a échoué), cette méthode retourne 0.

Depuis la version 2.81

getGeocode(i:Number)

Objet

Retourne le résultat géocodées pour le waypoint d'indice i.

La structure de cet objet est identique à celle d'un repère unique dans une réponse de l'objet GClientGeocoder.

Depuis la version 2.81

getCopyrightsHtml()

Chaîne

Retourne une chaîne HTML contenant les informations de copyright pour ce résultat.

Depuis la version 2.81

getSummaryHtml()

Chaîne

Retourne un extrait de code HTML contenant en résumé les distance et durée totales de l'itinéraire demandé.

Noter que ce résumé est la seule information retournée par l'objet GDirections construit sans carte associée ou balise <div>.

Depuis la version 2.81

getDistance()

Objet

Retourne un objet littéral représentant la distance totale de la demande des directions (sur toutes les routes).

L'objet contient deux champs :

• "meters" : indique, sous la forme d'une valeur numérique, la distance totale de l'itinéraire (en mètres),
• "html" : indique, sous la forme d'une chaine, la distance totale de l'itinéraire en utilisant l'unité de base de longueur utilisée dans le pays de départ de l'itinéraire.

Depuis la version 2.81

getDuration()

Objet

Retourne un objet littéral représentant la durée totale de l'itinéraire calculé.

L'objet contient deux champs :

• "seconds" : indique, sous la forme d'une valeur numérique, la durée totale de l'itinéraire calculé (en secondes),
• "html" : indique, sous la forme d'une chaine, la durée totale de l'itinéraire calculé.

Depuis la version 2.81

getPolyline()

GPolyline

Retourne l'objet GPolyline associé à la réponse du calcul d'itinéraire.

Note :

Une seule polyline représente l'ensemble des routes contenues dans la réponse.

Cet objet sera défini uniquement après que les résultats de l'itinéraire auront été chargés (c'est à dire lorsque l'événement "load" aura été déclenché).

Depuis la version 2.81

getMarker(i:Number)

GMarker

Retourne le marqueur associé à l'indice i.

Cette méthode va retourner une valeur non null uniquement après que les résultats de l'itinéraire auront été chargés (c'est à dire lorsque l'événement "load" aura été déclenché).

Depuis la version 2.81

load()

Cet événement est déclenché quand les résultats d'une requête émise à l'aide de GDirections.load() pour calculer un itinéraire sont disponibles.

Note :

La méthode load() initie une nouvelle requête, qui à son tour déclenche un événement "load" une fois que la requête a fini de charger.

L'événement "load" est déclenché avant que les éléments overlay ne soient ajoutés à la carte et/ou au panneau d'affichage.

Depuis la version 2.81

addoverlay()

Cet événement est déclenché après que la polyline et / ou panneau d'affichage aient été ajoutés à la carte et / ou la balise <div>.

Note :

L'événement "addoverlay" n'est pas déclenché si aucun de ces éléments ne sont attachés à l'objet GDirections.

Cet événement est déclenché après que la polyline et / ou le panneau d'affichage aient été ajoutés à la carte et / ou la balise <div>.

Depuis la version 2.81

error()

Cet événement est déclenché si une requête destinée à calculer un itinéraire aboutit à une erreur.

Les appelants peuvent utiliser GDirections.getStatus() pour obtenir plus d'informations sur l'origine de l'erreur.

Quand un évènement "error" se produit, aucun événement "load" ou "addoverlay" ne sera déclenché.

Depuis la version 2.81