Geoportal Resources Access API Reference

Class: AutoComplete

Gp.Services.AutoComplete

Appel du service d'autocomplétion du Géoportail :
envoi de la requête construite selon les paramètres en options,
éventuellement parsing et analyse de la réponse,
retour d'une réponse en paramètre de la fonction onSuccess.

new AutoComplete(options)

Services/AutoComplete/AutoComplete.js, line 61
Name Type Description
options Object

options spécifiques au service (+ les options heritées)

Name Type Default Description
text String

La chaîne de caractère à compléter.
Cette chaîne n'est pas "URL encodée".
C'est l'API qui s'occupe de l'encoder pour l'inclure dans la requête.
type Array.<String> ["StreetAddress"] optional

Type de l'objet recherché.
Le service d'autocomplétion du Géoportail permet de rechercher des toponymes 'PositionOfInterest' et/ou des adresses postales 'StreetAddress'.
D'autres types pourront être rajoutés selon l'évolution du service.
Par défaut, type = ['StreetAddress'].
territory String optional

Limitation de la zone de recherche de localisants.
Le service d'autocomplétion du Géoportail permet de limiter la recherche à la métropole et la Corse : options.territory = 'METROPOLE',
DOMS TOMS : options.territory = 'DOMTOM', ou à un département : options.territory = '31'
Pas de valeur par défaut.
La valeur par défaut est donc celle du service.
Le service d'autocomplétion du Géoportail renvoie toutes les informations quand aucun territoire n'est spécifié.
maximumResponses Number 10 optional

Nombre de réponses maximal que l'on souhaite recevoir.
Pas de valeur par défaut.
La valeur par défaut sera donc celle du service : 10.
Example
var options = {
     // options communes aux services
     apiKey : null,
     serverUrl : 'http://localhost/service/',
     protocol : 'JSONP', // JSONP|XHR
     proxyURL : null,
     httpMethod : 'GET', // GET|POST
     timeOut : 10000, // ms
     rawResponse : false, // true|false
     scope : null, // this
     onSuccess : function (response) {},
     onFailure : function (error) {},
     // spécifique au service
     text : "",
     type : "StreetAddress",
     territory : 'METROPOLE',
     maximumResponses : 10
  };

Extends

Namespaces

SuggestedLocation

Members

CLASSNAME

Nom de la classe (heritage)
FIXME instance ou classe ?

optionsObject

Options du service

request

Requête envoyée au service

response

Reponse du service

Methods

analyzeResponse(error, success)

Services/AutoComplete/AutoComplete.js, line 208

(overwrite)
Analyse de la reponse

Name Type Description
error function

callback des erreurs
success function

callback de succès de l'analyse de la réponse

buildRequest(error, success)

Services/AutoComplete/AutoComplete.js, line 169

(overwrite)
Création de la requête

Name Type Description
error function

callback des erreurs
success function

callback

patchOptionConvertor(options_){Object}

Services/AutoComplete/AutoComplete.js, line 136

Patch pour la convertion des options vers le nouveau formalisme.

Name Type Description
options_ Object

options du service