MapsRenderingClient.GetMapStaticImage Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The API renders a user-defined, rectangular image containing a map section using a zoom level. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. The service also provides Image Composition functionality to get a static image back with additional data.
public virtual Azure.Response<System.IO.Stream> GetMapStaticImage (Azure.Maps.Rendering.GetMapStaticImageOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMapStaticImage : Azure.Maps.Rendering.GetMapStaticImageOptions * System.Threading.CancellationToken -> Azure.Response<System.IO.Stream>
override this.GetMapStaticImage : Azure.Maps.Rendering.GetMapStaticImageOptions * System.Threading.CancellationToken -> Azure.Response<System.IO.Stream>
Public Overridable Function GetMapStaticImage (options As GetMapStaticImageOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Stream)
Parameters
- options
- GetMapStaticImageOptions
The options for configuring the static image.
- cancellationToken
- CancellationToken
The cancellation token to use.