Share via

MapOptions.IsOverviewMap Property

  • Article

MapOptions.IsOverviewMap Property

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 IsOverviewMap As System.Boolean = False



[C#]

public System.Boolean IsOverviewMap;

Remarks

  • If the IsOverviewMap property is set to True and the dimensions specified in the Format property are larger than 180 x 180 pixels or smaller than 32 x 32 pixels, a SOAP fault is returned.

Example

[Visual Basic]

'Get an overview map
Dim myViews(0) As ViewByScale
myViews(0) = New ViewByScale()
myViews(0).CenterPoint = New LatLong()
myViews(0).CenterPoint.Latitude = 40
myViews(0).CenterPoint.Longitude = -120
myViews(0).MapScale = 5000

Dim mapSpec As New MapSpecification()
mapSpec.DataSourceName = "MapPoint.NA"
mapSpec.Views = myViews
mapSpec.Options = New MapOptions()
mapSpec.Options.IsOverviewMap = True

Dim mapImages() As MapImage
mapImages = renderService.GetMap(mapSpec)



[C#]

//Get an overview map
ViewByScale[] myViews = new ViewByScale[1];
myViews[0] = new ViewByScale();
myViews[0].CenterPoint = new LatLong();
myViews[0].CenterPoint.Latitude = 40;
myViews[0].CenterPoint.Longitude = -120;
myViews[0].MapScale = 5000;

MapSpecification mapSpec  = new MapSpecification();
mapSpec.DataSourceName = "MapPoint.NA";
mapSpec.Views = myViews;
mapSpec.Options = new MapOptions();
mapSpec.Options.IsOverviewMap = true;

MapImage[] mapImages;
mapImages = renderService.GetMap(mapSpec);

See Also

  MapOptions Class   |   MapOptions.Format Property