Class: ReverseGeocode

new ReverseGeocode(options)

Services/Geocode/ReverseGeocode.js, line 76

Name

Type

Description

options

Object

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

Name

Type

Default

Description

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

filters

Object

optional

Les propriétés possibles de cet objet.

Name	Type	Description
[proprietes du filtre]	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".

searchGeometry

Object

optional

Emprise dans laquelle on souhaite effectuer la recherche.
Les propriétés possibles de cet objet sont décrites ci-après.

Name	Type	Description
type	String	Type de géometrie (Point\|Circle\|Linestring\|Polygon)
coordinates	Array.<Float> \| Array.Array.<Float>	Coordonnées des points constituant la géométrie.
radius	Float	Rayon. Paramètre applicable uniquement pour le type 'Circle'.

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' permet une recherche
multi-indexes en regroupant les indexes 'PositionOfInterest' et 'StreetAddress'.
D'autres types pourront être rajoutés selon l'évolution du service.
Par défaut, index = 'StreetAddress'.

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 : 20s.

returnTrueGeometry

Boolean

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
     index : 'StreetAddress',
     searchGeometry : {
         type : Circle,
         coordinates : [48, 2],
         radius : 100
     },
     position : {lon:2 , lat:48.5},
     maximumResponses : 25,
  };

Extends

Gp.Services.CommonService

Members

staticGp.Services.ReverseGeocode.geoEPSG

Codes EPSG géographiques (lat/lon). Utiles car les coordonnées doivent être inversées.

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/ReverseGeocode.js, line 265

(overwrite)
Analyse de la reponse

Name	Type	Description
error	function	callback des erreurs
success	function	callback

bbox2Json(bbox){Object} Services/Geocode/ReverseGeocode.js, line 287

Patch pour la convertion des options vers le nouveau formalisme.

Name	Type	Description
bbox	Array	bbox

Returns:

au format json

buildRequest(error, success) Services/Geocode/ReverseGeocode.js, line 237

(overwrite)
Création de la requête

Name	Type	Description
error	function	callback des erreurs
success	function	callback

circle2Json(circle){Object} Services/Geocode/ReverseGeocode.js, line 306

Patch pour la convertion des options vers le nouveau formalisme.

Name	Type	Description
circle	Object	circle

Returns:

au format json

patchOptionConvertor(options_){Object} Services/Geocode/ReverseGeocode.js, line 150

Patch pour la convertion des options vers le nouveau formalisme.

Name	Type	Description
options_	Object	options du service

polygon2Json(polygon){Object} Services/Geocode/ReverseGeocode.js, line 320

Patch pour la convertion des options vers le nouveau formalisme.

Name	Type	Description
polygon	Array	polygon

Returns:

au format json