Geoportal Resources Access API Reference

Class: Route

Gp.Services.Route

Appel du service d'itinéraire 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 Route(options)

Services/Route/Route.js, line 107
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. Ce paramètre devrait être obligatoire car il l'est dans l'appel au service. Mais il ne l'est pas pour des raisons de rétrocompatibilité.
outputFormat String

Le format de la réponse du service itineraire : 'json' uniquement et par défaut.
routePreference String "fastest" optional

Mode de calcul à utiliser :

  • le plus rapide « fastest »
  • le plus court « shortest »
    Par défaut : « fastest ».
startPoint 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'itinéraire.
y Float

Ordonnée du point de départ du calcul d'itinéraire.
endPoint Object

Point d'arrivée du calcul. Coordonnées exprimées en longitudes, latitudes (EPSG:4326)

Name Type Description
x Float

Abcisse du point d'arrivée du calcul d'itinéraire.
y Float

Ordonnée du point d'arrivée du calcul d'itinéraire.
viaPoints Array.<Object> optional

Liste de point ({x:Float,y:Float}) intermédaires que l'itinéraire doit emprunter dans l'ordre du tableau.
Coordonnées exprimées en longitudes, latitudes (EPSG:4326) :{x:float, y:float}
graph String "voiture" optional

Type de graphe utilisé : "Voiture" ou "Pieton".
Détermine le profil de vitesses utilisé pour le calcul ainsi que les tronçons autorisés ou non.
Par défaut, c'est la valeur "Voiture" qui sera utilisée.
exclusions Array.<String> optional

DEPRECATED: Critères d'exclusions à appliquer pour le calcul. (correspond au paramètre "avoidFeature" d'OpenLS)
On précise ici le type de tronçons que l'on ne veut pas que l'itinéraire emprunte
(valeurs possibles : « toll » (éviter les péages), « bridge », « tunnel »).
Ce paramètre est conservé pour une rétrocompatibilité de l'api. Le nouveau paramètre à utiliser est options.constraints
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".
geometryInInstructions Boolean false optional

Indique si la géométrie de l'itinéraire doit être reprise morceau par morceau dans les instructions.
(correspond au paramètre "provideGeometry" d'OpenLS) Par défaut : false.
provideBbox Boolean true optional

Indique si les instructions doivent être localisées par une bbox dans la réponse.
Par défaut : true.
distanceUnit String "m" optional

Indique si la distance doit être exprimée en km ou m dans la réponse.
Par défaut : m.
timeUnit String "second" optional

Indique si la durée doit être exprimée en seconde, minute ou heure dans la réponse. Il peut-être formatté hh:mm::ss avec la valeur standard.
Les valeurs possibles sont "standard", "second", "minute" ou "hour".
Par défaut : "standard".
srs String optional

Système de coordonnées dans lequel les paramètres géographiques en entrée et la réponse du service sont exprimés.
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 : 'EPSG:4326'.
waysAttributes Array.<String> optional

Nom des attributs des voies. Les valeurs disponibles dépendent de la ressource utilisée. Il est donc utile de regarder le getCapabilities.
Example
var options = {
     // options communes aux services
     apiKey : null,
     serverUrl : 'http://localhost/service/',
     protocol : '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
     resource : 'bdtopo'
     outputFormat : 'json',
     startPoint : {
         x : 42.1121,
         y : 1.5557
     },
     endPoint : {
         x : 42.1121,
         y : 1.5557
     },
     provideBbox : true,
     exclusions : ["Bridge", "Tunnel", "Toll"],
     distanceUnit : "km",
     graph : "Voiture",
     geometryInInstructions : true,
     routePreference : "fastest"
 };

Extends

Namespaces

RouteInstruction

Members

CLASSNAME

Nom de la classe (heritage)

optionsObject

Options du service

request

Requête envoyée au service

response

Reponse du service

innerconstraintTunnel

Gestion de l'ancien paramètre exclusion

Methods

analyzeResponse(error, success)

Services/Route/Route.js, line 299

(overwrite)
Analyse de la reponse

Name Type Description
error function

callback des erreurs
success function

callback

buildRequest(error, success)

Services/Route/Route.js, line 264

(overwrite)
Création de la requête

Name Type Description
error function

callback des erreurs
success function

callback