GetMapStaticImageOptions Class

Definition

Namespace:

Azure.Maps.Rendering

Assembly:

Azure.Maps.Rendering.dll

Package:

Azure.Maps.Rendering v1.0.0-beta.2

Source:

GetMapStaticImageOptions.cs

Options for rendering static images.

public class GetMapStaticImageOptions

type GetMapStaticImageOptions = class

Public Class GetMapStaticImageOptions

Inheritance

Object

GetMapStaticImageOptions

Constructors

GetMapStaticImageOptions(GeoBoundingBox, IList<ImagePushpinStyle>, IList<ImagePathStyle>)	Render static image options with bounding box.
GetMapStaticImageOptions(GeoPosition, Int32, Int32, IList<ImagePushpinStyle>, IList<ImagePathStyle>)	Render static image options with center coordinate and the width and height of the image.

Properties

BoundingBox	Bounding box. Note: Either BoundingBox or CenterCoordinate are required parameters. They are mutually exclusive. It shouldn't be used with HeightInPixels or WidthInPixels. The maximum allowed ranges for Lat and Lon are defined for each zoom level in the table at the top of this page.
CenterCoordinate	Coordinates of the center point. Format: 'lon,lat'. Longitude range: -180 to 180. Latitude range: -85 to 85. Note: Either Center or BoundingBox are required parameters. They are mutually exclusive.
HeightInPixels	Height of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn't be used with BoundingBox.
ImagePathStyles	Path style and locations. Use this parameter to optionally add lines, polygons or circles to the image. The path style describes the appearance of the line and fill.
ImagePushpinStyles	Pushpin style and instances. Use this parameter to optionally add pushpins to the image. The pushpin style describes the appearance of the pushpins, and the instances specify the coordinates of the pushpins and optional labels for each pin.
Language	Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.
LocalizedMapView	The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to Supported Views for details and to see the available Views.
MapImageLayer	Map layer requested. Possible value: StaticMapLayer.Basic, StaticMapLayer.Labels or StaticMapLayer.Hybrid If layer is set to StaticMapLayer.Labels or StaticMapLayer.Hybrid, the format should be png.
MapImageStyle	Map style to be returned. Possible values are Main and Dark.
WidthInPixels	Width of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn't be used with BoundingBox.
ZoomLevel	Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12. Please see Zoom Levels and Tile Grid for details.