Elevation
LocationElevationRequest interface
google.maps.LocationElevationRequest
interface
An elevation request sent by the ElevationService containing the list of discrete coordinates (LatLngs) for which to return elevation data.
Properties | |
|---|---|
locations optional |
Type: The discrete locations for which to retrieve elevations. |
PathElevationRequest interface
google.maps.PathElevationRequest
interface
An elevation query sent by the ElevationService containing the path along which to return sampled data. This request defines a continuous path along the earth along which elevation samples should be taken at evenly-spaced distances. All paths from vertex to vertex use segments of the great circle between those two points.
Properties | |
|---|---|
samples |
Type: Required. The number of equidistant points along the given path for which to retrieve elevation data, including the endpoints. The number of samples must be a value between 2 and 512 inclusive. |
path optional |
Type: The path along which to collect elevation values. |
ElevationResult interface
google.maps.ElevationResult
interface
The result of an ElevationService request, consisting of the set of elevation coordinates and their elevation values. Note that a single request may produce multiple ElevationResults.
Properties | |
|---|---|
elevation |
Type: The elevation of this point on Earth, in meters above sea level. |
resolution |
Type: The distance, in meters, between sample points from which the elevation was interpolated. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger |
location optional |
Type: The location of this elevation result. |
ElevationStatus constants
google.maps.ElevationStatus
constants
The status returned by the ElevationService upon completion of an elevation request. Specify these by value, or by using the constant's name. For example, 'OK' or google.maps.ElevationStatus.OK.
Access by calling const {ElevationStatus} = await google.maps.importLibrary("elevation").
See Libraries in the Maps JavaScript API.
Constants | |
|---|---|
INVALID_REQUEST |
The request was invalid. |
OK |
The request did not encounter any errors. |
OVER_QUERY_LIMIT |
The webpage has gone over the requests limit in too short a period of time. |
REQUEST_DENIED |
The webpage is not allowed to use the elevation service. |
UNKNOWN_ERROR |
The elevation request could not be successfully processed, yet the exact reason for the failure is not known. |