Share via

RenderGetMapStaticImage200Response interface

Package:
@azure-rest/maps-render

This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications.

This API includes parameters for basic data visualization:

  • Labeled pushpins in multiple styles.
  • Render circle, path, and polygon geometry types.

For more information and detailed examples, see Render custom data on a raster map.

The dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.

Zoom Level Min Lon Range Max Lon Range Min Lat Range Max Lat Range
0 56.25 360.0 30.1105585173 180.0
1 28.125 360.0 14.87468995 180.0
2 14.063 351.5625 7.4130741851 137.9576312246
3 7.03125 175.78125 3.7034501005 73.6354071932
4 3.515625 87.890625 1.8513375155 35.4776115315
5 1.7578125 43.9453125 0.925620264 17.4589959239
6 0.87890625 21.97265625 0.4628040687 8.6907788223
7 0.439453125 10.986328125 0.2314012764 4.3404320789
8 0.2197265625 5.4931640625 0.1157005434 2.1695927024
9 0.1098632812 2.7465820312 0.0578502599 1.0847183194
10 0.0549316406 1.3732910156 0.0289251285 0.5423494021
11 0.0274658203 0.6866455078 0.014462564 0.2711734813
12 0.0137329102 0.3433227539 0.007231282 0.1355865882
13 0.0068664551 0.171661377 0.003615641 0.067793275
14 0.0034332275 0.0858306885 0.0018078205 0.0338966351
15 0.0017166138 0.0429153442 0.0009039102 0.0169483173
16 0.0008583069 0.0214576721 0.0004519551 0.0084741586
17 0.0004291534 0.0107288361 0.0002259776 0.0042370793
18 0.0002145767 0.005364418 0.0001129888 0.0021185396
19 0.0001072884 0.002682209 5.64944E-05 0.0010592698
20 5.36442E-05 0.0013411045 2.82472E-05 0.0005296349

Note : Either center or bbox parameter must be supplied to the API.

Extends
HttpResponse

Properties

body

Value may contain any sequence of octets
headers
status

Inherited Properties

request

The request that generated this response.

Property Details

body

Value may contain any sequence of octets

body: Uint8Array

Property Value

Uint8Array

headers 

headers: RawHttpHeaders & RenderGetMapStaticImage200Headers

Property Value

RawHttpHeaders & RenderGetMapStaticImage200Headers

status 

status: "200"

Property Value

"200"

Inherited Property Details

request

The request that generated this response.

request: PipelineRequest

Property Value

PipelineRequest

Inherited From HttpResponse.request