Geoportal Resources Access API Reference

Class: Geocode

Gp.Services.Geocode

Appel du service de géocodage direct 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 Geocode(options)

Services/Geocode/Geocode.js, line 71
Name Type Description
options Object

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

Name Type Default Description
query String | Object

Nom de l'adresse, du toponyme, de l'unité administrative ou de la parcelle cadastrale recherchée.
filters Object optional

Les propriétés possibles de cet objet sont décrites ci-après.

Name Type Description
[prop] String optional

Critère supplémentaire pour filtrer la recherche sous la forme
d'un couple clé/valeur à définir selon les possibilités du serveur ajouté à la requête.
Le service de géocodage du Géoportail permet de filtrer les adresses postales avec les propriétés :
"postalCode", "inseeCode", "city".
Il permet également de filtrer les toponymes avec les propriétés :
"postalCode", "inseeCode", "type".
Enfin, il permet de filtrer les parcelles cadastrales avec les propriétés :
"codeDepartement", "codeCommune", "nomCommune", "codeCommuneAbs", "codeArrondissement", "section", "numero", "feuille".
index String "StreetAddress" optional

Type de l'objet recherché.
Le service de géocodage du Géoportail permet de rechercher des 'PositionOfInterest' pour des toponymes, des 'StreetAddress'
pour des adresses postales ou des 'CadastralParcel' pour des parcelles cadastrales.
L'index 'location' regroupe les indexes 'StreetAddress' et 'PositionOfInterest'.
D'autres types pourront être rajoutés selon l'évolution du service.
Par défaut, index = 'StreetAddress'.
position Object

Position du point de référence pour le calcul de proximité exprimée dans le système de référence spécifié par le srs.

Name Type Description
lon Float

Longitude du point de référence pour le calcul de proximité.
lat Float

Latitude du point de référence pour le calcul de proximité.
maximumResponses Number optional

Nombre de réponses maximal que l'on souhaite recevoir.
Pas de valeur par défaut.
Si le serveur consulté est celui du Géoportail, la valeur par défaut sera donc celle du service : 20.
returnTrueGeometry Boolean false optional

Booléen indiquant si l'on souhaite récupérer la géométrie vraie des objects géolocalisés.
false par défaut.
Example
var options = {
     apiKey : null,
     serverUrl : 'http://localhost/service/',
     proxyURL : null,
     timeOut : 10000, // ms
     rawResponse : false, // true|false
     scope : null, // this
     onSuccess : function (response) {},
     onFailure : function (error) {},
     // spécifique au service
     position : {lon:, lat:},
     index : 'StreetAddress',
     query : '10 rue du pont Machin-ville'
     (...)
  };

Extends

Namespaces

GeocodedLocation

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/Geocode/Geocode.js, line 247

Analyse de la reponse (overwrite)

Name Type Description
error function

callback des erreurs
success function

callback

buildRequest(error, success)

Services/Geocode/Geocode.js, line 220

Création de la requête (overwrite)

Name Type Description
error function

callback des erreurs
success function

callback

patchOptionConvertor(options_){Object}

Services/Geocode/Geocode.js, line 143

Patch pour la convertion des options vers le nouveau formalisme.

Name Type Description
options_ Object

options du service