VIAMICHELIN JAVASCRIPT API


Référence

Le composant de completion d'adresse se nomme ViaMichelin.Api.Completion.Address. Il s'utilise en le branchant sur un champ texte avec la méthode VMLaunch en spécifiant 2 paramètres supplémentaires : conf et callbacks.

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

VMLaunch("ViaMichelin.Api.Completion.Address", conf, callbacks);

Configuration

Le champ de saisie (requis)

(node) input

             Ce paramètre permet de spécifier le champ de saisie sur lequel la completion est branchée.

Paramètres de regroupement

(boolean) grouping

             Ce paramètre doit être défini à true si l'on souhaite que les propositions soient regroupées par type.

(object) groupingOptions

             Ce paramètre est utilisé en cas de regroupement (grouping=true). Ce qu'il contient est défini ci-dessous.

(object) groupingOptions.labels

             Contient les libellés à utiliser pour les entêtes de chaque groupe de propositions.

(string) groupingOptions.labels.COUNTRY

             Le libellé du groupe des propositions de pays.

(string) groupingOptions.labels.ADMIN

             Le libellé du groupe des propositions de zones administratives.

(string) groupingOptions.labels.CITY

             Le libellé du groupe des propositions de villes.

(string) groupingOptions.labels.ADDRESS

             Le libellé du groupe des propositions d'adresses.

Paramètres de la recherche

Les paramètres de la recherche doivent être regroupées dans un objet parameters.

(string) parameters.exclusiveCountry

             Code ISO pays 3 lettres. 
             Permet de spécifier un pays dont seuls les lieux seront pris en compte lors de la recherche. En l'absence de ce paramètre, la completion se fait sur le monde entier.

(string) parameters.favoriteCountry

              Code ISO pays 3 lettres. 
              Permet de spécifier un pays dont les lieux seront favorisés lors de la recherche.

(string) parameters.favoriteCountrySpacial

              Code ISO pays 3 lettres. 
              Permet de spécifier un pays dont les lieux seront favorisés lors de la recherche. Les lieux proches de ce pays seront également favorisés, en fonction de leur proximité.

(string) parameters.lang

              Code ISO langue 3 lettres. 
              Permet de spécifier la langue des libellés de lieux sur lesquels la recherche va s'effectuer.

(number) parameters.maxResults

              Permet de spécifier le nombre maximum de propositions que l'on veut obtenir.

(number) parameters.maxResultsCountry

               Permet de spécifier le nombre maximum de propositions de pays que l'on veut obtenir parmi toutes les propositions.

(number) parameters.maxResultsAdmin

                Permet de spécifier le nombre maximum de propositions de zones administratives que l'on veut obtenir parmi toutes les propositions.

(number) parameters.maxResultsCity

                 Permet de spécifier le nombre maximum de propositions de villes que l'on veut obtenir parmi toutes les propositions.

(number) parameters.maxResultsAddress

                 Permet de spécifier le nombre maximum de propositions d'adresses que l'on veut obtenir parmi toutes les propositions.

Paramètres de mise en forme

(string) wrapperClassName

                 Ce paramètre permet d'ajouter une classe CSS sur le conteneur de plus haut niveau de la liste de propositions.

(string) activeLineClassName

                 Ce paramètre permet de changer la classe utilisée sur la ligne de la proposition sélectionnée.

(string) lineClassName

                 Ce paramètre permet de changer la classe utilisée pour chaque ligne de proposition.

Autres paramètres

(boolean) searchOnFocus

                 Ce paramètre doit être défini à true si l'on souhaite que la recherche se lance quand le champ de saisie gagne le focus.

(boolean) revertMode

                 Ce paramètre doit être défini à true si l'on souhaite que la liste des propositions s'affiche au dessus du champ ordonnée de bas en haut.

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 completion 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 completion.

Paramètres

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

ready

     Déclenché lorsque le composant est complétement chargé et prêt à l'emploi.

Paramètres

Aucun

opened

     Déclenché lorsque la liste des propositions s'affiche.

Paramètres

Aucun

noresult

     Déclenché, lorsque suite à la saisie, le composant n'a aucune proposition cohérente à faire. 
Il prend la place de opened

Paramètres

Aucun

selected

     Déclenché lorsqu'une proposition est sélectionnée par l'utilisateur.

Paramètres

  • line : référence à la ligne sélectionnée

closed

     Déclenché lorsque la liste des propositions se ferme, quelque en soit la raison.

Paramètres

Aucun