Packagecom.yahoo.maps.api.markers
Classpublic class Marker
InheritanceMarker Inheritance flash.display.Sprite
ImplementsIMarker
SubclassesLoaderMarker, SearchMarker, SimpleMarker

This object, a subclass of Sprite, forms the core marker in which you can extend to create custom markers. On its own, it does not have a visible UI.

See also

LoaderMarker
SimpleMarker
SearchMarker


Public Properties
 PropertyDefined by
  address : Address
The markers location as an Address
Marker
  container : Sprite
The container in which all markers are children of.
Marker
  dragEnabled : Boolean
Determines whether the marker is draggable.
Marker
  groupId : String
An ID which you can assign to the marker, to enable you to fetch a group of markers using the MarkerManager.
Marker
  latlon : LatLon
The markers location as a latitude and longitude.
Marker
  manager : MarkerManager
Marker
  map : IYahooMap
A reference to the owning YahooMap instance.
Marker
  maxZoom : int
The maximum zoom level this marker should be shown at.
Marker
  minZoom : int
The minimum zoom level this marker should be shown at.
Marker
Public Methods
 MethodDefined by
  
Creates a new Marker object.
Marker
  
Returns the markers current position as a LatLon object by converting the markers local XY point.
Marker
  
destroy():void
Frees the markers resources in preparation for garbage collection.
Marker
  
Converts a LatLon object to a local XY point.
Marker
  
Converts a local XY point to a LatLon object.
Marker
  
promoteToTop():void
Sets the marker child index (its depth) to the top in the marker container.
Marker
Events
 EventSummaryDefined by
    Marker
    Marker
    Marker
    Marker
    Marker
    Marker
    Marker
Property detail
addressproperty
address:Address  [read-write]

The markers location as an Address

Implementation
    public function get address():Address
    public function set address(value:Address):void

See also

Address
containerproperty 
container:Sprite  [read-write]

The container in which all markers are children of.

Implementation
    public function get container():Sprite
    public function set container(value:Sprite):void
dragEnabledproperty 
dragEnabled:Boolean  [read-write]

Determines whether the marker is draggable.

Implementation
    public function get dragEnabled():Boolean
    public function set dragEnabled(value:Boolean):void
groupIdproperty 
public var groupId:String

An ID which you can assign to the marker, to enable you to fetch a group of markers using the MarkerManager.

latlonproperty 
latlon:LatLon  [read-write]

The markers location as a latitude and longitude.

Implementation
    public function get latlon():LatLon
    public function set latlon(value:LatLon):void

See also

LatLon
managerproperty 
manager:MarkerManager  [read-write]Implementation
    public function get manager():MarkerManager
    public function set manager(value:MarkerManager):void
mapproperty 
map:IYahooMap  [read-write]

A reference to the owning YahooMap instance.

Implementation
    public function get map():IYahooMap
    public function set map(value:IYahooMap):void
maxZoomproperty 
public var maxZoom:int

The maximum zoom level this marker should be shown at.

minZoomproperty 
public var minZoom:int

The minimum zoom level this marker should be shown at.

Constructor detail
Marker()constructor
public function Marker()

Creates a new Marker object.

Method detail
calcLatLon()method
public function calcLatLon():LatLon

Returns the markers current position as a LatLon object by converting the markers local XY point.

Returns
LatLon
destroy()method 
public function destroy():void

Frees the markers resources in preparation for garbage collection.

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

Converts a LatLon object to a local XY point.

Parameters
latlon:LatLon

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

Converts a local XY point to a LatLon object.

Parameters
point:Point

Returns
LatLon
promoteToTop()method 
public function promoteToTop():void

Sets the marker child index (its depth) to the top in the marker container.

Event detail
markerAddedevent 
Event object type: MarkerEvent

markerDragevent  
Event object type: MarkerEvent

markerDragStartevent  
Event object type: MarkerEvent

markerDragStopevent  
Event object type: MarkerEvent

markerGeocodeErrorevent  
Event object type: MarkerEvent

markerGeocodeSuccessevent  
Event object type: MarkerEvent

markerRemovedevent  
Event object type: MarkerEvent