Geoportal Resources Access API Reference

Class: Alti

Gp.Services.Alti

Appel du service d'altimétrie du Géoportail

new Alti(options)

Services/Alti/Alti.js, line 75
Name Type Description
options Object

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

Name Type Description
positions Array.<Object>

Tableau ({lon:float,lat:float}) contenant les coordonnées des points (CRS:84)
dont on veut connaître les altitudes (ou à partir desquelles on va calculer le profil).
Chaque élément du tableau est un objet JavaScript avec deux attributs : lon et lat, qui sont des flottants.
Minimum 2 éléments si on souhaite calculer un profil altimétrique (ElevationLine).
Maximum 50 éléments.
outputFormat String

Le format de la réponse du service alti : 'xml' ou 'json'.
Ce paramètre déterminera l'extension '.xml' ou '.json' du service dans le cas de l'API REST,
ou la valeur du paramètre 'format' dans le cas de la norme WPS.
Nécessaire si serverUrl est renseigné, et qu'on souhaite passer par l'API REST,
pour connaître le format dans lequel sera fournie la réponse (pour son traitement).
Non nécessaire pour la norme WPS. Par défaut, ce paramètre vaut 'json'.
sampling Number optional

Nombre de points à utiliser pour déterminer le tracé d'un profil altimétrique, compris entre 2 et 5000.
A spécifier lorsqu'on souhaite accéder à cette fonctionnalité.
Dans ce cas, les points fournis en entrée (au minimum de deux) servent à déterminer l'axe planimétrique
le long duquel le profil doit être calculé.
Si le paramètre sampling n'est pas spécifié ou moins de deux points sont fournis,
c'est le service Elevation qui sera interrogé (altitudes simples calculées pour les points fournis).
Une valeur de sampling strictement inférieure à 2 déclenchera un échantillonnage avec la valeur par défaut du service (3 points).
api String optional

Manière d'accéder au service : 'REST' (via l'API REST) ou 'WPS' (via la norme WPS).
Par défaut, on utilise l'API REST.
zonly Boolean optional

Permet de ne récupérer que les altitudes en sortie s'il vaut 'true'.
Vaut 'false' par défaut.
resource String optional

Resource utilisée pour réaliser le calcul.
TODO
  • gestion du parma. output et callback
  • outputFormat (REST) et format (WPS)
  • La reponse JSON peut encapsuler un XML !
Example
var options = {
     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
     positions : [{lon:, lat:}, {lon:, lat:}],
     outputFormat : 'json' // json|xml
     sampling : 3,
     api : 'REST', // REST|WPS
     zonly : false // false|true,
     resource : "resource-par-defaut"
  };

Extends

Namespaces

Elevation
Measure

Members

CLASSNAME

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

constructor

Constructeur (alias)

optionsObject

Options du service

request

Requête envoyée au service

response

Reponse du service

Methods

analyzeResponse(error, success)

Services/Alti/Alti.js, line 225

Analyse de la reponse (overwrite)

Name Type Description
error function

callback des erreurs
success function

callback

buildRequest(error, success)

Services/Alti/Alti.js, line 194

Création de la requête (overwrite)

Name Type Description
error function

callback des erreurs
success function

callback