[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Return Types ]
Returned in response to a viewport request. Defines the precise bounds returned by an equivalent map request. In addition to the bounds, the definition includes distance in metres north to south and east to west, and resolution.
Maps are not available at all resolutions. The service calculates the resolution that best-fits the request. The returned (actual) bounds of a map - as expressed in its viewport - is likely to cover a larger area than that requested.
Parameters
Name | Type | Description |
bounds | <bounds> | Specifies the precise extent of a map that would be returned by the equivalent map request, typically larger than the bounds requested. |
centre | <point> | Centre point of the viewport |
resolution | double | In degrees per pixel. |
x-distance | double | Specifies the extent of the viewport east to west in meters. |
y-distance | double | Specifies the extent of the viewport north to south in meters. |
zoom | int | Specifies the calculated zoom level to be used for generating the equivalent encoded graphic. |
Example
{
"bounds": {
"left": 138.408203,
"top": -34.351602,
"right": 151.591797,
"bottom": -41.285239
},
"centre": {
"lon": 145.0,
"lat": -37.81842
},
"resolution": 2445.98490478515623181010596454143524169921875,
"x_distance": 1208605.324493,
"y_distance": 770465.745552,
"zoom": 4
}