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 Inherits System.Object



[C#]

public class MapOptions : System.Object

Public Properties

Name Description
public propertyConstructionClosureHighlightColor

The highlight color (RouteHighlightColor enumeration) to use for parts of a route where stops or closure due to construction can be expected. Default is DefaultColor (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 (yellow).
public propertyFontSize

The relative font size (MapFontSize enumeration) to use for map labeling. Default is Smaller.
public propertyFormat

The format (ImageFormat object) of the map image to return. The default is 8-bit color in GIF format, with a size of 296 x 240 pixels. Optional.
public propertyIsOverviewMap

Identifies whether the requested map should be rendered as an overview map. An overview map can be as small as 32 x 32 pixels and as large as 180 x 180 pixels. It does not include the MapPoint Web Service logo on the image. Default is False.
public propertyPanHorizontal

A positive or negative number reflecting the percentage of the map image to pan west (negative) or east (positive). Double. Default is 0. Optional.
public propertyPanVertical

A positive or negative number reflecting the percentage of the map image to pan south (negative) or north (positive). Default is 0. Optional.
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. Default is ReturnImage.
public propertyRouteHighlightColor

The highlight color (RouteHighlightColor enumeration) to use for a route (other than construction areas). Default is DefaultColor (green).
public propertyStyle

The map style (MapStyle enumeration) to use. Default is DefaultStyle.
public propertyZoom

Identifies the factor by which the map image is magnified; a fractional percentage. Default is 1. Values less than or equal to 0 are invalid.
public propertyPreventIconCollisions

Specifies whether custom point-of-interest icons are displayed on the exact point-of-interest location, or rendered so that they do not overlap. A value of true ensures that icons do not overlap when the map is rendered. The default value is false.

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