Geoportal Resources Access API Reference

Class: ProcessIsoCurve

Gp.Services.ProcessIsoCurve

Appel du service d'isochrone/distance 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 ProcessIsoCurve(options)

Services/ProcessIsoCurve/ProcessIsoCurve.js, line 101
Name Type Description
options Object

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

Name Type Default Description
resource String

La ressource utilisée pour le calcul : bdtopo-valhalla (par défaut) ou bdtopo-pgr.
outputFormat String

Le format de la réponse du service iso : 'json' uniquement et par défaut.
position Object

Point de départ du calcul.
Coordonnées exprimées en longitudes, latitudes (EPSG:4326)

Name Type Description
x Float

Abcisse du point de départ du calcul d'isochrone/distance.
y Float

Ordonnée du point de départ du calcul d'isochrone/distance.
srs String

Projection.
Système de coordonnées dans lequel les coordonnées du point « location » sont exprimées et
dans lequel la géométrie de la courbe résultante sera exprimée.
Par défaut, le système de coordonnées utilisé sera « EPSG:4326 ».
graph String "voiture" optional

Nom du graphe à utiliser pour le calcul (« Pieton » ou « Voiture »).
La valeur par défaut est : «voiture»
exclusions Array.<String> optional

DEPRECATED: Ce paramètre est conservé pour une rétrocompatibilité de l'api. Le nouveau paramètre à utiliser est options.constraints.
Critères d'exclusions à appliquer pour le calcul.
On précise ici le type de tronçons que l'on ne veut pas que l'isochrone/distance emprunte
(valeurs possibles : « toll » (éviter les péages), « bridge », « tunnel »).
constraints Array.<Object> optional

Critères de contraintes à appliquer sur un itinéraire. Les valeurs disponibles dépendent de la ressource utilisée. Il est donc utile de regarder le getCapabilities.

Name Type Description
constraintType String optional

Type de la contrainte. Généralement "banned".
key String optional

Clé de la contrainte. Généralement "wayType".
operator String optional

Opérateur de la contrainte. Généralement "=".
value String optional

Valeur de la contrainte. Généralement "autoroute".
method String "time" optional

Méthode utilisée pour le calcul de la courbe iso.
Les valeurs possible sont "time" pour un calcul d'isochrone, "distance" pour un calcul d'isodistance.
Pas de valeur spécifié équivaut à un calcul d'isochrone.
distanceUnit String "m" optional

Indique si la distance doit être exprimée en km ou m dans la réponse ("m" or "km").
timeUnit String "second" optional

Indique si la durée doit être exprimée en seconde, minute ou heure dans la réponse ("standard", "second", "minute", "hour"). Il peut-être formatté hh:mm::ss avec la valeur standard.
time Float

Durée maximum (exprimée en secondes) à utiliser pour le calcul de la courbe à partir du ou jusqu'au point « location ».
Ce paramètre doit être renseigné si l'option "méthod" a la valeur "time".
Si l'option method n'est pas renseignée, ce paramètre doit être renseigné.
distance Float

Distance maximum (exprimée en metres) à utiliser pour le calcul de la courbe à partir du ou j'usqu'au point « location ».
Ce paramètre doit être renseigné si l'option "méthod" a la valeur "DISTANCE".
Si l'option "method" n'est pas renseignée, ce paramètre sera ignoré.
reverse Boolean false optional

Indique si la géométrie résultante doit être lissée (« true ») pour ne pas avoir d'effet d'escalier.
Par défaut, la valeur « false » est appliquée.
smoothing Boolean false optional

Indique si la géométrie résultante doit être lissée (« true ») pour ne pas avoir d'effet d'escalier.
Par défaut, la valeur « false » est appliquée.
holes Boolean false optional

Indique si la géométrie résultante (surface) doit être retournée avec des trous (« true »).
Par défaut, la valeur « false » est appliquée.
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
     position : {
          x : 2.3242664298058053,
          y : 48.86118017324745
     },
     resource : bdtopo-valhalla,
     distance : 200,
     [time : ]
     method : "distance",
     graph : "voiture",
     reverse : false
 };

Extends

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(onError, onSuccess)

Services/ProcessIsoCurve/ProcessIsoCurve.js, line 301

(overwrite)
Analyse de la reponse

Name Type Description
onError function

callback des erreurs
onSuccess function

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

buildRequest(error, success)

Services/ProcessIsoCurve/ProcessIsoCurve.js, line 278

Création de la requête (overwrite)

Name Type Description
error function

callback des erreurs
success function

callback