Share via

MapOptions Class

  • Article

MapOptions Class

Contains the map rendering options used with the RenderServiceSoap.GetMap method. Specifies the image format, whether the image or a URL to a cached image should be returned, panning and zooming factors, identification of the requested map as an overview map, route highlight colors, font size, and map style.

Public Class MapOptions
    Member of [Namespace]
[C#]
public class MapOptions : System.Object
    Member of [Namespace]

Public Properties

public propertyConstructionClosureHighlightColor The highlight color (RouteHighlightColor enumeration) to use for parts of a route that are closed due to construction. Default is Red.
public propertyConstructionDelayHighlightColor The highlight color (RouteHighlightColor enumeration) to use for parts of a route where delays due to construction can be expected. Default is DefaultColor.
public propertyFontSize The relative font size (MapFontSize enumeration) to use for map labeling. Default is Medium.
public propertyFormat The format (ImageFormat object) of the map image to return.
public propertyIsOverviewMap Identifies whether the requested map should be rendered as an overview map. Boolean.
public propertyPanHorizontal A positive or negative number reflecting the percentage of the map image to pan west (negative) or east (positive). Double.
public propertyPanVertical A positive or negative number reflecting the percentage of the map image to pan south (negative) or north (positive). Double.
public propertyReturnType Identifies whether the RenderServiceSoap.GetMap method should return a map image or a standard or secure URL to a cached map image. MapReturnType enumeration. Optional.
public propertyRouteHighlightColor The highlight color (RouteHighlightColor enumeration) to use for a route (other than construction areas). Default is Green.
public propertyStyle The map style (MapStyle enumeration) to use.
public propertyZoom Identifies the factor by which the map image is magnified; a fractional percentage. Double.

Remarks

  • The MapOptions class is passed in the MapSpecification.Options property.
  • If both pan (PanHorizontal and/or PanVertical) and zoom (Zoom) navigation properties are sent in the same call, the order of implementation is pan and then zoom.

See Also

RenderServiceSoap.GetMap Method | RouteHighlightColor Enumeration | MapFontSize Enumeration | ImageFormat Class | MapReturnType Enumeration | MapStyle Enumeration | MapSpecification.Options Property