Appends a custom MapArea object to the end of the MapAreasCollection, allowing for a tooltip, hyperlink, a pre-defined shape and map area attributes to be specified.
Add new map area item into the collection.
Visual Basic (Declaration) | |
---|---|
Public Overloads Function Add( _ ByVal shape As MapAreaShape, _ ByVal toolTip As String, _ ByVal href As String, _ ByVal attr As String, _ ByVal coord() As Single _ ) As Integer |
Visual Basic (Usage) | Copy Code |
---|---|
|
Parameters
- shape
-
A MapAreaShape enumeration value that determines the shape of the map area. Can be a circle, rectangle or polygon. The coord parameter determines its coordinates.
Area shape. - toolTip
-
The tooltip of the map area, which corresponds to the html <AREA> tag's Title attribute. Multi-line tooltips can be used using a carriage return/line feed (e.g. vbCrLf for VB).
Tool tip. - href
-
The destination URL or anchor point of the map area. Corresponds to the html <AREA> tag's HREF attribute.
Jump URL. - attr
-
One or more map area attributes. The entire string expression is appended at the end of the <AREA> tag.
Other area attributes. - coord
-
Coordinates array that determines the location of the circle, rectangle or polygon. The type of shape that is being used determines the type of coordinates required. See below for further details.
Array of coordinates
Return Value
An integer that represents the index where the item was inserted into the collection (0-based).
Index of the newly added item.
The following sample creates a map area in the shape of a circle, with the circle plotted at the center of the chart image.
Visual Basic | Copy Code |
---|---|
'declare and initialize array which defines circle coordinates within chart image |
Appends a custom MapArea object to the end of the collection, using the specified parameters to set the map area properties.
The coord array parameter determines the coordinates of the map area shape, and is dependent on the shape being used:
- Circle. Three coordinates must be provided: "x1,y1,r". "x1" and "y1" determine the center of the circle, and "r" is the radius of the circle.
- Rectangle. Four coordinates must be provided: "x1,y1,x2,y2". "x1,y1" are the coordinates of the upper-left corner of the rectangle, and "x2,y2" are the coordinates of the lower-right corner of the rectangle.
- Polygon. Two or more x,y pairs must be provided: "x1,y1,x2,y2...xn,yn". Each x,y pair determines the coordinates of one vertex of the polygon.
Chart coordinates are used when setting the position of the rectangle. "0,0" represents the top-left corner of the chart image and "100,100" represents the bottom-right corner of the chart image. To find out more about the chart's coordinate system see the Chart Coordinate System topic.
The attr parameter is used for map attributes such as "Target=_Blank", "OnClick="javascript:MyJavaScriptFunction()", etc.
IMPORTANT: To create an image map this way the RenderType property of the Chart object MUST be RenderType.ImageTag. It is possible to create an image map when using binary streaming, but another technique must be used. Refer to the Client-Side Mapping and Binary Streaming topic for further details.
To create a map area that has a custom shape use the definition that takes a GraphicsPath object.
Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family