VIAMICHELIN JAVASCRIPT API


Référence

Le composant de recherche de points d'intérêt se nomme ViaMichelin.Api.Poi. 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.Poi", conf, callbacks);
		

(string) db

     Spécifie l'identifiant de base de données de POIs à utiliser pour la recherche. 
     Cet identifiant est fourni par ViaMichelin. 
     Ce paramètre est obligatoire, sauf pour les    services FIND_INPUT_POI et FIND_INPUT_POI_BY_ROAD.Voir service ci dessous.

(string) service

     Ce paramètre permet de spécifier le service à utiliser pour effectuer la recherche de POIs. 
    La plupart des services effectueront leur recherche sur la base de données spécifiée avec le paramètre db, mais tous n'ont pas le même comportement. 

Les différentes valeurs possibles sont les constantes suivantes : 

ViaMichelin.Api.Constants.Poi.SERVICE_TYPE. + l' ajout des éléments suivants


POI Accès à un POI

FIND_POI Recherche les POIs à proximité d'un lieu. Retourne une liste de POIs statiques ordonnée par distance croissante du point central spécifié en paramètre. 
Note : Le calcul s'effectue à vol d'oiseau.
FIND_POI_BY_ROAD Recherche les POIs à proximité d'un lieu. Retourne une liste de POIs statiques ordonnée par distance croissante d'un point central spécifié en paramètre. 
Note : Le calcul s'effectue par la route.
FIND_POI_NEAR_ROUTE Recherche les POIs à proximité d'un itinéraire. Retourne une liste de POIs statiques ordonnée par distance croissante de leur point de raccrochement à l'itinéraire avec le point de départ. 
Note : Le calcul s'effectue par la route.
FIND_POI_BY_CRITERIA Recherche des POIs. Retourne une liste de POIs statiques satisfaisant les critères passés en paramètre. Les critères peuvent-être géographiques et/ou liés au contenu informatif du POI (metanum, text).
FIND_INPUT_POI Permet d'ordonner les POIs passés en paramètre en fonction de leur distante du centre spécifié. 
Note : Le calcul s'effectue à vol d'oiseau.
FIND_INPUT_POI_BY_ROAD Permet d'ordonner les POIs passés en paramètre en fonction de leur distante du centre spécifié. 
Note : Le calcul s'effectue par la route.

Par défaut : ViaMichelin.Api.Constants.Poi.SERVICE_TYPE.POI

(string) poiid

     Identifiant unique du POI dans la base.

(object) center

     Centre de la recherche de proximité. Peut être :

  • Un objet de coordonnées {coords:{lat : number, lon : number}}
  • un objet avec une propriété address contenant une configuration de géocodage {address : GeocodingConfig}

Si une adresse est saisie, une opération de géocodage est effectuée.

(array) inputpoi

     Liste de 1 à 30 POIs. Chaque POI est saisi avec un nom et ses coordonnées. 
     [{name:string, {coords{lon:number, lat:number}}]

(number) dist

     Rayon de recherche autour du centre en mètres (de 0 à 200.000). 
     Par défaut : 10.000

(number) time

     Temps maximal pour atteindre par la route les POI. Il est exprimé en secondes (de 60 à 7,200).

(number) nb

      Le nombre de POIs attendus (de 1 à 100). 

      Par défaut : 20

(string) name

     Critère de recherche textuelle sur le nom des POIs. 
     Voir aussi le paramètre textMode.

(string) text

     Critères de recherche textuelle globale (full text). 
     Voir aussi le paramètre textMode.

(string) textMode

     Mode de recherche appliqué aux paramètres name et text multivalués. 
     Peut prendre les valeurs suivantes :

ViaMichelin.Api.Constants.Poi.TEXT_MODE. OR Seuls les POIs contenant au moins un des mots sont retournés.
AND Seuls les POIs contenant tous les mots sont retournés.

Par défaut : ViaMichelin.Api.Constants.Poi.TEXT_MODE.AND.

(array) 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|string}. 
     Il est possible de multivaluer un critère en séparant chaque valeur par un ;. Exemple : {id:2, value:"5;6"}

(number) sidx

     Ce paramètre permet la pagination en spécifiant l'index du premier POI retourné dans l'ensemble des POIs trouvés. Par exemple, sisidx=2 et nb=3, la réponse contient uniquement les POIs de rang 3 à 5. 
     Par défaut : -1 (non paginé).

(string) countryLst

     Critère de restriction de la recherche sur des codes pays (code ISO sur 3 caractères). 
     Ce paramètre peut-être multivalué (séparateur ;).

(string) zipLst

     Critère de restriction de la recherche sur des codes postaux. 
     Ce paramètre peut-être multivalué (séparateur ;).

(number) orderBy

     Identifiant du metanum servant de critère de tri pour les POIs. 
     Voir aussi le paramètre orderDir.

(orderDir) orderDir

     Sens du tri (ascendant ou descendant) sur le critère positionné dans le paramètre orderBy. 
     Ce paramètre peut prendre les valeurs suivantes :

ViaMichelin.Api.Constants.Poi.ORDER_DIR. ASC Tri ascendant
DESC Tri descendant

Par défaut : ViaMichelin.Api.Constants.Poi.ORDER_DIR.ASC

(object) geobounds

     Filtre sur les POIs contenus dans une emprise géographique.

(object) geobounds.min

     Prend la forme de coordonnées : {lon:number, lat:number}.

(object) geobounds.max

     Prend la forme de coordonnées : {lon:number, lat:number}.

Paramètres pour la carte

(object) map

     Objet descriptif de la carte à utiliser pour afficher les POIs.

(HTMLElement) map.container

     Elément DOM du conteneur de la carte utilisée pour afficher les POIs.

(boolean) map.focus

     Ce paramètre spécifie si la carte doit-être redessinée en s'ajustant aux limites de tous les objets graphiques qu'elle contient.

(object) map.offset

     Positionne l'index (de la liste de POIs) par rapport au coin haut-gauche du marqueur du POI.

(string) map.iconPath

     Contient l'URL générique vers les icônes. 
    Elle doit contenir la sous-chaîne {ICON_ID} qui est automatiquement remplacée par la valeur appropriée pour chaque marqueur suivant le contenu en BD. 
    Si la variable n'est pas valorisée, l'API tente de récupérer les icônes dans le Client Data hébergé chez ViaMichelin.

Paramètres de l'itinéraire

Ces paramètres de la configuration du composant ne sont à utiliser qu'avec le serviceViaMichelin.Api.Constants.Poi.SERVICE_TYPE.FIND_POI_NEAR_ROUTE. 


Ce sont les mêmes que ceux que l'on retrouve dans le composant de calcul d'itinéraire. 
Pour plus d'informations, n'hésitez pas à consultez les références de l'itinéraire.

(array) steps

     Liste des étapes (8 maximum, y compris départ et arrivée). Si des adresses sont saisies, des opérations de géocodage sont effectuées. 
Formats possibles pour chaque étape :

{locId:string} Utilise le location ID du lieu.
{coords: {lat:number, lon:number} Utilise les coordonnées géographiques du lieu.
{poi:string} Utilise l'identifiant d'un poi.
{address: {GeocodingConfig}} Utilise une configuration de géocoding pour identifier le lieu.

(string) 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.

(string) dir

     Type d'itinéraire à calculer. 

Direction dans laquelle la recherche doit être effectuée. DIR peut prendre les valeurs suivantes :

ViaMichelin.Api.Constants.Itinerary.DIRECTION. TO Seuls les POIs dans le sens de la route seront affichés.
FROM Tous les POIs correspondant à la recherche seront affichés, même dans le sens inverse.

Par défaut la valeur est ViaMichelin.Api.Constants.Itinerary.DIRECTION.TO.

Les paramètres suivants de l'itinéraire sont aussi disponibles lors de la recherche de POIs :

  • favMotorways
  • avoidBorders
  • avoidCCZ
  • avoidORC
  • avoidTolls

Pour les utiliser, consulter les références du calcul d'itinéraire.

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 recherche de POIs 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 la recherche s'est déroulée avec succès.

Paramètres

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

onError

Déclenché lorsqu'une erreur se produit lors de la recherche de POIs.

Paramètres

  • error : l'erreur qui s'est produite