Packagecom.yahoo.maps.api.overlays
Classpublic class Overlay
InheritanceOverlay Inheritance flash.display.Sprite
ImplementsIOverlay
SubclassesCircleOverlay, PolylineOverlay

The core Overlay class contains a set of methods that you can use to create a vector shape over the map, in which you can extend to create your own overlays on the map.



Public Properties
 PropertyDefined by
  container : Sprite
A reference to the maps overlay container.
Overlay
  map : IYahooMap
A reference to the YahooMap class.
Overlay
Public Methods
 MethodDefined by
  
Creates a new Overlay object
Overlay
  
destroy():void
Frees the overlays resources in preparation for garbage collection.
Overlay
  
Converts a LatLon point to a local XY Point
Overlay
  
Converts a local XY point to a LatLon object.
Overlay
  
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
  
moveToLatLon(latlon:LatLon):void
Moves the current drawing position to the specified latitude and longitude point.
Overlay
  
Map move event handler.
Overlay
  
Map resize event handler.
Overlay
  
Map zoom event handler.
Overlay
  
Map type change event handler.
Overlay
Property detail
containerproperty
container:Sprite  [read-write]

A reference to the maps overlay container.

Implementation
    public function get container():Sprite
    public function set container(value:Sprite):void
mapproperty 
map:IYahooMap  [read-write]

A reference to the YahooMap class.

Implementation
    public function get map():IYahooMap
    public function set map(value:IYahooMap):void

See also

IYahooMap
YahooMap
Constructor detail
Overlay()constructor
public function Overlay()

Creates a new Overlay object

Method detail
destroy()method
public function destroy():void

Frees the overlays resources in preparation for garbage collection.

getLatLonToLocalPoint()method 
public function getLatLonToLocalPoint(latlon:LatLon):Point

Converts a LatLon point to a local XY Point

Parameters
latlon:LatLon — A LatLon object.

Returns
Point — A Point object.

See also

LatLon
getLocalPointToLatLon()method 
public function getLocalPointToLatLon(point:Point):LatLon

Converts a local XY point to a LatLon object.

Parameters
point:Point — A point object.

Returns
LatLon — A LatLon object

See also

LatLon
lineToLatLon()method 
public function 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.

Parameters
latlon:LatLon

See also

LatLon
moveToLatLon()method 
public function moveToLatLon(latlon:LatLon):void

Moves the current drawing position to the specified latitude and longitude point.

Parameters
latlon:LatLon

See also

LatLon
onMapMove()method 
public function onMapMove(event:YahooMapEvent):void

Map move event handler. You should override this function if needed

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

Map resize event handler. You should override this function if needed

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

Map zoom event handler. You should override this function if needed.

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

Map type change event handler. You should override this function if needed

Parameters
event:YahooMapEvent