VIAMICHELIN JAVASCRIPT API


Référence

Le composant de géocodage se nomme ViaMichelin.Api.Geocoding. Il s'utilise avec la méthode VMLaunch. On lui fournit 2 paramètres supplémentaires : conf et callbacks.

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

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

Configuration

1 champ

(string) singleFieldSearch 

                    Ce paramètre permet de spécifier une adresse complète comme champ de recherche pour le  géocodage.

(string) favoriteCountry

                Ce paramètre permet de spécifier un pays dont les résultats seront favorisés. Sa valeur doit être un code ISO 3 lettres.

3 champs

(string) address

Permet de spécifier une adresse (rue, village, ...) comme champ de recherche pour le géocodage.

(string) cityZip

               Permet de spécifier une ville avec code postal comme champ de recherche pour le géocodage.

(string) countryISOCode

               Ce paramètre permet de spécifier un pays comme champ de recherche.

4 champs

(string) address

               Permet de spécifier une adresse (rue, village, ...) comme champ de recherche pour le géocodage.

(string) city

               Permet de spécifier une ville comme champ de recherche pour le géocodage.

(string) zip

               Permet de spécifier un code postal comme champ de recherche pour le géocodage.

(string) countryISOCode

               Ce paramètre permet de spécifier un pays comme champ de recherche.

Par location ID

(string) id

              Ce paramètre permet de spécifier un id de GeoLocation comme critère de recherche.

Inverse

(object) coords

               Permet de spécifier des coordonnées géographiques comme donnée de recherche pour le géocodage. 
               C'est un objet avec les propriétés lon et lat, respectivement longitude et latitude.

(number) coords.lon

               Permet de spécifier la longitude du lieu.

(number) coords.lat

                Permet de spécifier la latitude du lieu.

Evénements

Des écouteurs peuvent être créés 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 géocoding est correctement chargé.

Paramètres

  • component : référence au composant

onInitError

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

Paramètres

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

onSuccess

Déclenché lors de la réponse du service de recherche de géocodage.

Paramètres

  • results : les résultats de la recherche de geocoding

onError

Déclenché lors de la réponse du service de recherche de géocodage, lorsqu'une erreur est retournée. 
onError est déclenché à la place de onSuccess. Si aucune correspondance n'a été trouvée, mais qu'il n'y a pas d'erreur, c'est l'événement onSuccess qui est déclenché avec en paramètre un tableau vide.

Paramètres

  • response : la réponse du service, contenant l'erreur