MapOptions.IsOverviewMap Property

  • Article

Identifies whether the requested map should be rendered as an overview map. Boolean. 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 Dim IsOverviewMap As Boolean = False
    Member of [Namespace].MapOptions
[C#]
public System.Boolean IsOverviewMap
    Member of [Namespace].MapOptions

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.
  • Besides allowing you to provide context for a larger map, an overview map can be used for thumbnail images or turn-by-turn route maps.

Example

 
[Visual Basic] 
'This example assumes that the service instance 
''renderService' has already been created and that 
'the MapPoint Web Service namespace has been imported 

'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#]
//This example assumes that the service instance 
//'renderService' has already been created and that 
//the MapPoint Web Service namespace has been imported 

//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