Packagecom.yahoo.maps.api.overlays
Classpublic class CircleOverlay
InheritanceCircleOverlay Inheritance Overlay Inheritance flash.display.Sprite

An overlay that draws a circle on the map over a center location.


Example 
   var centerLatLon:LatLon = _map.centerLatLon.clone();
   var overlay:CircleOverlay = new CircleOverlay(centerLatLon, 5000);
   _map.overlayManager.addOverlay(overlay);


Public Properties
 PropertyDefined by
  centerLatLon : LatLon
The center location of the circle.
CircleOverlay
 Inheritedcontainer : Sprite
A reference to the maps overlay container.
Overlay
  fillAlpha : Number = 1
The alpha value for the fill area.
CircleOverlay
  fillColor : uint
The hexidecimal color value for the fill area.
CircleOverlay
  lineAlpha : Number
The alpha value for the line.
CircleOverlay
  lineColor : uint
The hexidecimal color value for the line.
CircleOverlay
  lineThickness : Number
The thickness of the polyline in pixels
CircleOverlay
  map : IYahooMap
[write-only]
CircleOverlay
  pixelRadius : Number
[read-only] The radius of the circle in pixels given the center latitude and zoom level.
CircleOverlay
  radiusMeters : Number
The radius in meters of the circle.
CircleOverlay
Public Methods
 MethodDefined by
  
CircleOverlay(centerLatLon:LatLon, radiusMeters:Number, fillColor:uint = 0x0000FF, fillAlpha:Number = 1, lineColor:uint = 0x000000, lineAlpha:Number = 1, lineThickness:Number = 1)
Creates a new CircleOverlay object.
CircleOverlay
 Inherited
destroy():void
Frees the overlays resources in preparation for garbage collection.
Overlay
 Inherited
getLatLonToLocalPoint(latlon:LatLon):Point
Converts a LatLon point to a local XY Point
Overlay
 Inherited
getLocalPointToLatLon(point:Point):LatLon
Converts a local XY point to a LatLon object.
Overlay
 Inherited
lineToLatLon(latlon:LatLon):void
Draws a line using the current line style from the current drawing position to the specified LatLon location; the current drawing position is then set to the LatLon location.
Overlay
 Inherited
moveToLatLon(latlon:LatLon):void
Moves the current drawing position to the specified latitude and longitude point.
Overlay
 Inherited
onMapMove(event:YahooMapEvent):void
Map move event handler.
Overlay
 Inherited
onMapResize(event:YahooMapEvent):void
Map resize event handler.
Overlay
  
onMapZoom(event:YahooMapEvent):void
Map zoom event handler.
CircleOverlay
 Inherited
onTypeChanged(event:YahooMapEvent):void
Map type change event handler.
Overlay
  
redraw():void
Redraws the polyline using the assigned location.
CircleOverlay
Property detail
centerLatLonproperty
centerLatLon:LatLon  [read-write]

The center location of the circle.

Implementation
    public function get centerLatLon():LatLon
    public function set centerLatLon(value:LatLon):void
fillAlphaproperty 
public var fillAlpha:Number = 1

The alpha value for the fill area.

fillColorproperty 
public var fillColor:uint

The hexidecimal color value for the fill area.

lineAlphaproperty 
public var lineAlpha:Number

The alpha value for the line.

lineColorproperty 
public var lineColor:uint

The hexidecimal color value for the line.

lineThicknessproperty 
public var lineThickness:Number

The thickness of the polyline in pixels

mapproperty 
map:IYahooMap  [write-only]Implementation
    public function set map(value:IYahooMap):void
pixelRadiusproperty 
pixelRadius:Number  [read-only]

The radius of the circle in pixels given the center latitude and zoom level.

Implementation
    public function get pixelRadius():Number
radiusMetersproperty 
radiusMeters:Number  [read-write]

The radius in meters of the circle.

Implementation
    public function get radiusMeters():Number
    public function set radiusMeters(value:Number):void
Constructor detail
CircleOverlay()constructor
public function CircleOverlay(centerLatLon:LatLon, radiusMeters:Number, fillColor:uint = 0x0000FF, fillAlpha:Number = 1, lineColor:uint = 0x000000, lineAlpha:Number = 1, lineThickness:Number = 1)

Creates a new CircleOverlay object.

Parameters
centerLatLon:LatLon — The center location of the circle.
 
radiusMeters:Number — The radius in meters of the circle.
 
fillColor:uint (default = 0x0000FF) — The hexidecimal color value for the fill area.
 
fillAlpha:Number (default = 1) — The alpha value for the fill area.
 
lineColor:uint (default = 0x000000) — The hexidecimal color value for the line.
 
lineAlpha:Number (default = 1) — The alpha value for the line.
 
lineThickness:Number (default = 1) — The thickness of the polyline in pixels
Method detail
onMapZoom()method
public override function onMapZoom(event:YahooMapEvent):void

Map zoom event handler.

Parameters
event:YahooMapEvent
redraw()method 
public function redraw():void

Redraws the polyline using the assigned location.