VIAMICHELIN JAVASCRIPT API


La méthode VMLaunch

A quoi sert-elle ?

La méthode VMLaunch est le point de départ pour utiliser les différentes fonctionnalités de l'API. (carte, géocodage, itinéraire...)

Pour chacune de ces fonctionnalités, nous vous proposons un composant spécifique qui pourra être chargé avec la fonction VMLaunch.

 

L'appel à VMLaunch

La méthode VMLaunch prend 3 paramètres : nom du composant, configuration, callbacks.

Seul le nom du composant est obligatoire.

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

Configuration du composant

La variable de configuration, à spécifier en 2ème paramètre de VMLaunch, permet de passer au composant des paramètres en fonction de votre besoin d'utilisation. 
C'est un objet, dont ses propriétés sont les paramètres attendus par le composant. 
Chaque composant à ses propres propriétés qui sont listées dans la documentation qui lui est propre.

Exemple
var conf = {
  prop1 : "value1",
  bool1 : true
};		

Déclaration des callbacks

Les callbacks sont des méthodes qui vont être liés à des événements déclenchés par le composant.

Tous les composants chargés avec VMLaunch déclencheront toujours 1 événement suite à leur initialisation :

  • onInit si le chargement s'est bien passé
  • onInitError si ce n'est pas le cas
var callbacks = {
  onInit : function (component) {
    console.log("Le composant a été correctement initialisé !");
    console.log("Référence du composant : ", component);
  },
  onInitError : function (component, error) {
    console.error(error);
  }
};		

La méthode liée à l'événement onInit sera appelée avec 1 paramètre, correspondant à l'instance du composant. 
La méthode liée à l'événement onInitError sera appelée avec 2 paramètres, le premier correspondant à l'instance du composant et le second à l'erreur qui a été relevée.