Share via

HotArea.LabelRectangle Property

  • Article

The pixel rectangle (PixelRectangle object) representing the perimeter of the pushpin label on a rendered map. Allows the creation of a hyperlink in an image map that is identified with that label.

Public Dim LabelRectangle As [Namespace].PixelRectangle
    Member of [Namespace].HotArea
[C#]
public [Namespace].PixelRectangle LabelRectangle
    Member of [Namespace].HotArea

Remarks

  • The LabelRectangle property represents the entire perimeter of the label, even if a portion of the label extends beyond the bounds of the map image (which may happen if a pushpin is very close to the edge). In such a case, the returned pixel positions may include negative numbers, as well as numbers higher than the pixel size of the image.

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 a map and mark the center point with a pushpin
Dim myViews(0) As ViewByHeightWidth
myViews(0) = New ViewByHeightWidth()
myViews(0).CenterPoint = New LatLong()
myViews(0).CenterPoint.Latitude = 40
myViews(0).CenterPoint.Longitude = -120
myViews(0).Height = 200
myViews(0).Width = 300

Dim myPushpins(0) As Pushpin
myPushpins(0) = New Pushpin()
myPushpins(0).PinID = "pin1"
myPushpins(0).IconDataSource = "MapPoint.Icons"
myPushpins(0).IconName = "3"
myPushpins(0).LatLong = myViews(0).CenterPoint
myPushpins(0).Label = "Center"
myPushpins(0).ReturnsHotArea = True

Dim mapSpec As New MapSpecification()
mapSpec.DataSourceName = "MapPoint.NA"
mapSpec.Views = myViews
mapSpec.Pushpins = myPushpins

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

'Output the hot area coordinates of the pushpin icon and 
'label rectangles
Console.WriteLine("PinID:" + mapImages(0).HotAreas(0).PinID)
Console.WriteLine("IconRectangle top coordinate: " + mapImages(0).HotAreas(0).IconRectangle.Top.ToString())
Console.WriteLine("IconRectangle bottom coordinate: " + mapImages(0).HotAreas(0).IconRectangle.Bottom.ToString())
Console.WriteLine("IconRectangle left coordinate: " + mapImages(0).HotAreas(0).IconRectangle.Left.ToString())
Console.WriteLine("IconRectangle right coordinate: " + mapImages(0).HotAreas(0).IconRectangle.Right.ToString())
Console.WriteLine("LabelRectangle top coordinate: " + mapImages(0).HotAreas(0).LabelRectangle.Top.ToString())
Console.WriteLine("LabelRectangle bottom coordinate: " + mapImages(0).HotAreas(0).LabelRectangle.Bottom.ToString())
Console.WriteLine("LabelRectangle left coordinate: " + mapImages(0).HotAreas(0).LabelRectangle.Left.ToString())
Console.WriteLine("LabelRectangle right coordinate: " + mapImages(0).HotAreas(0).LabelRectangle.Right.ToString())

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

//Get a map and mark the center point with a pushpin
ViewByHeightWidth[] myViews = new ViewByHeightWidth[1];
myViews[0] = new ViewByHeightWidth();
myViews[0].CenterPoint = new LatLong();
myViews[0].CenterPoint.Latitude = 40;
myViews[0].CenterPoint.Longitude = -120;
myViews[0].Height = 200;
myViews[0].Width = 300;

Pushpin[] myPushpins = new Pushpin[1];
myPushpins[0] = new Pushpin();
myPushpins[0].PinID = "pin1";
myPushpins[0].IconDataSource = "MapPoint.Icons";
myPushpins[0].IconName = "3";
myPushpins[0].LatLong = myViews[0].CenterPoint;
myPushpins[0].Label = "Center";
myPushpins[0].ReturnsHotArea = true;

MapSpecification mapSpec  = new MapSpecification();
mapSpec.DataSourceName = "MapPoint.NA";
mapSpec.Views = myViews;
mapSpec.Pushpins = myPushpins;

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

//Output the hot area coordinates of the pushpin icon and 
//label rectangles
Console.WriteLine("PinID:" + mapImages[0].HotAreas[0].PinID);
Console.WriteLine("IconRectangle top coordinate: " + mapImages[0].HotAreas[0].IconRectangle.Top.ToString());
Console.WriteLine("IconRectangle bottom coordinate: " + mapImages[0].HotAreas[0].IconRectangle.Bottom.ToString());
Console.WriteLine("IconRectangle left coordinate: " + mapImages[0].HotAreas[0].IconRectangle.Left.ToString());
Console.WriteLine("IconRectangle right coordinate: " + mapImages[0].HotAreas[0].IconRectangle.Right.ToString());
Console.WriteLine("LabelRectangle top coordinate: " + mapImages[0].HotAreas[0].LabelRectangle.Top.ToString());
Console.WriteLine("LabelRectangle bottom coordinate: " + mapImages[0].HotAreas[0].LabelRectangle.Bottom.ToString());
Console.WriteLine("LabelRectangle left coordinate: " + mapImages[0].HotAreas[0].LabelRectangle.Left.ToString());
Console.WriteLine("LabelRectangle right coordinate: " + mapImages[0].HotAreas[0].LabelRectangle.Right.ToString());

 

See Also

HotArea Class | PixelRectangle Class