VIAMICHELIN JAVASCRIPT API


Objets communs de l'API

 

Fonction VMLaunch

Tous les objets de services disponibles dans ViaMichelin JavaScript API v2 sont instanciés par l'intermédiaire de la fonction VMLaunch.

FonctionDescription
VMLaunch(serviceName:string, serviceConfig:object, serviceCallbacks:object) Lance le service demandé en instanciant l'objet de service associé.

 

Paramètres

ParamètreTypeDescription
serviceName string Nom du service à lancer. La liste est disponible dans la section sur les services exposés ci-dessous.
serviceConfig object Objet de spécification des paramètres propre au service lancé. Voir les sections propres à chaque service.
serviceCallbacks object Objet de spécification des fonctions de callbacks. Les callbacks communes à tous les services sont:
onSuccess(obj:serviceObject), appelée au retour normal de l'exécution du service,
onError(response:Error), appelée en cas d'erreur
onInitError(obj), appelée en cas d'erreur dinitialisation de l'objet de service,
onInit(obj:serviceObject), appelée après l'initialisation pour récupérer l'objet de service pour des manipulations ultérieures (utile avec ViaMichelin.Api.Map).

 

Méthodes communes aux objets de service

FonctionDescription
addEventListener(eventName:string, method:function, thisObj:object) Attache un gestionnaire d'événement à un objet.
removeEventListener(eventName:string, method:function, thisObj:object) Détache un gestionnaire d'événement d'un objet.
removeEventListeners() Détache tous les gestionnaires d'événement d'un objet.

 

Classe Error

PropriétésTypeDescription
errorCode ERRORCODE Code erreur. ERRORCODE peut prendre les valeurs suivantes:
ViaMichelin.Api.Constants.Exception.BAD_REQUEST
...ACCESS_DENIED
...SERVICE_ACCESS_DENIED
...INVALID_PARAMETER
...ABNORMAL_SERVICE_TERMINATION
...REQUIRED_PARAMETER
errorMsg string Message d'erreur.

 

Objets transverses à l'API

 

GeoPoint

PropriétésTypeDescription
lon float Longitude WGS84 en degrés décimaux (de -180.0 à +180.0)
lat float Latitude WGS84 en degrés décimaux (de -90.0 à +90.0)

 

Point

PropriétésTypeDescription
x int Coordonnée horizontale en pixels (axe de gauche é droite)
y int Coordonnée verticale en pixels (axe de haut é bas)

 

POIId

PropriétésTypeDescription
db int Identifiant unique de la base de données (fourni par ViaMichelin)
id int Identifiant unique du POI dans la base

 

Size

PropriétésTypeDescription
width int Largeur dans l'unité du contexte d'utilisation (principalement en pixels)
height int Hauteur dans l'unité du contexte d'utilisation (principalement en pixels)

 

Retour haut de page