VIAMICHELIN JAVASCRIPT API


Référence

 

Le composant de calcul d'itinéraire se nomme ViaMichelin.Api.Itinerary. Il s'utilise avec la méthode VMLaunch à qui on fournit 2 paramètres supplémentaires : conf et callbacks.

conf : configuration du composant 
callbacks : écouteurs d'événements sur le composant

VMLaunch("ViaMichelin.Api.Itinerary", conf, callbacks);
		

Configuration

Configuration commune

(array) steps

Ce paramètre est obligatoire. 
Ce paramètre permet de spécifier les étapes de l'itinéraire. La première étape est le point de départ, et la dernière étape le point d'arrivée. Un itinéraire doit donc comporter au minimum 2 étapes. 
Les étapes supplémentaires (si vous en définissez plus de 2), sont des lieux par lesquels doit passer l'itinéraire. 
Un itinéraire ne peut avoir plus de 8 étapes. 

Chaque étape est un objet qui peut être défini de plusieurs façons :

{locId : string} Contient un locId. Voir les références du géocodage.
{coords : {lon : number, lat : number}} Contient des coordonnées de latitude et de longitude.
{poi : {db : number, id : number}} Contient les informations permettant d'identifier un POI dans la base.
{address : GeocodingConfig} Contient une configuration de géocodage utile pour déterminer le lieu de l'étape. 
Un géocodage sera fait pour chaque étape définie de cette façon.

(object) map

Permet d'afficher l'itinéraire sur une carte. Voir détails ci-dessous.

(HTML Element) map.container

Permet d'afficher l'itinéraire sur la carte dont le conteneur est spécifié.

(boolean) map.focus

Indique si la carte doit-être redessinée en s'ajustant aux limites de tous les objets graphiques de l'itinéraire qu'elle contient.

(HTML Element) roadsheet

Permet d'afficher la feuille de route dans l'élément DOM spécifié.

(number) veht

Permet de spécifier le type de véhicule utilisé pour l'itinéraire. 

Les différentes valeurs possibles sont les constantes suivantes :

ViaMichelin.Api.Constants.Itinerary.VEHICULE_TYPE. CAR Voiture
TRUCK Camion
ON_FOOT Piéton
CYCLE Vélo
MOTO Moto


Par défaut la valeur est ViaMichelin.Api.Constants.Itinerary.VEHICULE_TYPE.CAR.

(number) itit

Type d'itinéraire à calculer. 

Les différentes valeurs possibles sont les constantes suivantes :

ViaMichelin.Api.Constants.Itinerary.ITINERARY_TYPE. RECOMMENDED Recommandé par Michelin
QUICK Le plus rapide
SHORT Le plus court
DISCOVERY Itinéraire découverte
ECONOMIC Le moins cher


Par défaut la valeur est ViaMichelin.Api.Constants.Itinerary.ITINERARY_TYPE.RECOMMENDED.

(boolean) favMotorways

Indique si l'itinéraire doit favoriser ou non les autoroutes. 
Par défaut : false.

(boolean) avoidBorders

Indique si l'itinéraire doit éviter ou non les passages de frontières. 
Par défaut : false.

(boolean) avoidTolls

Indique si l'itinéraire doit éviter ou non les péages. 
Par défaut : false.

(boolean) avoidCCZ

Indique si l'itinéraire doit éviter zones payantes (Congestion Charge Zones). 
Par défaut : false.

(boolean) avoidORC

Indique si l'itinéraire doit éviter les zones non routières comme les ferrys ou le ferroutage (Off-Road Connections). 
Par défaut : false.

(boolean) multipleIti

Spécifie si l'on souhaite obtenir les itinéraires alternatifs si ils existent. L'ensemble des résumés des itinéraires est disponible dans la section header de l'objet de réponse. 
Par défaut : false.

(number) itiIdx

Index de l'itinéraire pour lequel on souhaite obtenir les données. N'a de sens que si multipleIti vaut true.

(string) distUnit

L'unité de distance utilisée dans la réponse. 

Les différentes valeurs possibles sont les constantes suivantes :

ViaMichelin.Api.Constants.Itinerary.DIST_UNIT. METERS Distances en mètres.
MILES Distances en miles.

Par défaut la valeur est ViaMichelin.Api.Constants.Itinerary.DIST_UNIT.METERS.

(object) fuelConsump

Contient les consommations moyennes du véhicule en litres au 100km à 50km/h, 90km/h et 120km/h. 

Par défaut, la valeur est {city:7.9, road:6.9, hwy:7}

(number) fuelConsump.city

Contient la consommation moyenne du véhicule en litres au 100km, à 50km/h. 

Par défaut, la valeur est 7.9

(number) fuelConsump.road

Contient la consommation moyenne du véhicule en litres au 100km, à 90km/h. 

Par défaut, la valeur est 6.9

(number) fuelConsump.hwy

Contient la consommation moyenne du véhicule en litres au 100km, à 120km/h. 

Par défaut, la valeur est 7

(number) fuelCost

Coût du carburant (le choix de la monnaie est implicite). 

Par défaut, la valeur est 1.3

(object) traffic

Spécifie si le calcul prend en considération l'impact traffic sur un ou plusieurs pays. 
Il est désactivé par défaut.

(array) traffic.country

Permet de spécifier les pays concernés par l'impact traffic. 
C'est une liste de code ISO pays 3 lettres. Exemple : ['FRA', 'GBR'] 
Si tous les pays doivent être pris en compte, la liste sera ['ALL'].

(boolean) wCaravan

Spécifie si le calcul doit prendre en compte la présence d'une caravane, cela aura une influence sur le coût du péage. 

Par défaut, la valeur est false.

(boolean) withSecurityAdv

Spécifie si le calcul doit prendre en considération les informations de sécurité. 

Par défaut, la valeur est false.

(string) date

Date de départ de l'itinéraire. Cela permet de tenir compte de l'ouverture ou fermeture de routes (cols, etc). 
La date doit être écrite sous la forme aaaa-mm-jj. 

Par défaut, la date du jour est utilisée.

(string) currency

Monnaie utilisée pour obtenir le coût des péages. 
currency peut prendre les valeurs suivantes:

ViaMichelin.Api.Constants.Itinerary.CURRENCY. EUR Euro
CHF Franc suisse
CZK Couronne tchèque
DKK Couronne danoise
GBP Livre sterling
HRK Kuna croate
HUF Forint hongrois
NOK Couronne norvégienne
PLN Zloty polonais
SEK Couronne suèdoise
SIT Tolar slovène
SKK Couronne slovaque
UAH Hryvnia ukrainienne
USD Dollar américain

Par défaut la valeur est ViaMichelin.Api.Constants.Itinerary.CURRENCY.EUR.

(boolean) distanceByCountry

Permet d'avoir le calcul de la distance par pays en plus de la distance globale. 

Par défaut, la valeur est false.

Configuration spécifique aux camions

(object) truckOpts

Options pour les camions.

(number) truckOpts.axels

Nombre d'essieux (6, 8, ...)

(number) truckOpts.width

Largeur en décimètres.

(number) truckOpts.height

Hauteur en décimètres.

(number) truckOpts.weight

Poids en quintal (dixième de tonne).

(number) truckOpts.category

  • 0 : toute catégorie de véhicule
  • 4 : transport en commun
  • 5 : transport de marchandise
  • 6 : transport de produits explosifs
  • 7 : transport de produits polluants
  • 8 : transport de produits dangereux

(number) truckOpts.euro

StandardNorme européenne d'émission.

Configuration des pois

(object) pois

Paramétrage complémentaire pour lancer une recherche de POIs le long de d'itinéraire trouvé. 
Si le paramètre map est valorisé, les POIs sont affichés automatiquement sur la carte. 
L'événement onSuccess transmettra 2 valeurs, la première sera la réponse du calcul d'itinéraire, la seconde la liste des POIs trouvés.

(string) pois.db

Identifiant unique de la base de données (fourni par ViaMichelin).

(number) pois.dist

Distance maximale en mètres de l'itinéraire à laquelle rechercher les POIs. 
Elle doit être comprise entre 0 et 200.000. 

Par défaut, la valeur est 10.000.

(number) pois.nb

Nombre maximal de POIs à afficher le long de l'itinéraire 
Il doit être compris entre 1 et 100. 

Par défaut, la valeur est 20.

(string) pois.dir

Direction dans laquelle la recherche doit être effectuée. 

Le paramètre peut prendre les valeurs suivantes :

ViaMichelin.Api.Constants.Poi.DIRECTION. TO Seuls les POIs dans la direction de l'itinéraire seront affichés. Aller vers l'un d'entre eux ne vous fera pas revenir sur vos pas.
FROM Tous les POIs correspondant à la recherche seront affichés, même si cela fait revenir en arrière.

Valeur par défaut : ViaMichelin.Api.Constants.Poi.DIRECTION.TO.

(number) pois.time

Temps maximal pour atteindre les POI depuis de l'itinéraire en secondes (valeur comprise entre 60 à 7200).

(array) pois.criteria

Critères de restriction de la recherche sur les valeurs des métadonnées numériques. 
Chaque entrée est un objet sous la forme {id:number, value:number}.

Evénements

Des écouteurs peuvent être crées pour les événements ci-dessous. 
Les paramètres associés aux événements sont ceux reçus par l'écouteur.

onInit

Déclenché lorsque le composant de calcul d'itinéraire est correctement chargé.

Paramètres

  • component : référence au composant

onInitError

    Déclenché lorsqu'une erreur se produit lors du chargement du composant.

Paramètres

  • component : référence au composant
  • error : l'erreur qui s'est produite

onSuccess

    Déclenché lorsque le calcul s'est déroulé avec succès.

Paramètres

  • result : le résultat de la recherche de POIs

onError

    Déclenché lorsqu'une erreur se produit lors du calcul d'itinéraire.

Paramètres

  • error : l'erreur qui s'est produite