Packagecom.yahoo.maps.api.controls
Classpublic class PanControl
InheritancePanControl Inheritance flash.events.EventDispatcher

The PanControl class handles mouse events to move the map when the mouse is dragged and double clicked.


Public Properties
 PropertyDefined by
  isDraggable : Boolean
Returns true if the pan control is enabled and the map can be dragged.
PanControl
  panEnabled : Boolean
Enabled state of the pan control.
PanControl
Public Methods
 MethodDefined by
  
PanControl(map:IYahooMap)
Creates a new PanControl object
PanControl
Protected Methods
 MethodDefined by
  
handleMouseLeave(event:Event):void
PanControl
Events
 EventSummaryDefined by
  
mapClick
Dispatched when the map is clicked on.PanControl
  
mapDoubleClick
Dispatched when the map is double-clicked on.PanControl
  
mapDrag
Dispatched when the map is being dragged.PanControl
  
mapDragStart
Dispatched when the map starts dragging.PanControl
  
mapDragStop
Dispatched when the map stops dragging.PanControl
Property detail
isDraggableproperty
public var isDraggable:Boolean

Returns true if the pan control is enabled and the map can be dragged.

panEnabledproperty 
panEnabled:Boolean  [read-write]

Enabled state of the pan control.

Implementation
    public function get panEnabled():Boolean
    public function set panEnabled(value:Boolean):void
Constructor detail
PanControl()constructor
public function PanControl(map:IYahooMap)

Creates a new PanControl object

Parameters
map:IYahooMap
Method detail
handleMouseLeave()method
protected function handleMouseLeave(event:Event):voidParameters
event:Event
Event detail
mapClickevent 
Event object type: YahooMapEvent

Dispatched when the map is clicked on. Requires that the pan control is enabled.

mapDoubleClickevent  
Event object type: YahooMapEvent

Dispatched when the map is double-clicked on. Requires that the pan control is enabled.

mapDragevent  
Event object type: YahooMapEvent

Dispatched when the map is being dragged. Requires that the pan control is enabled.

mapDragStartevent  
Event object type: YahooMapEvent

Dispatched when the map starts dragging. Requires that the pan control is enabled.

mapDragStopevent  
Event object type: YahooMapEvent

Dispatched when the map stops dragging. Requires that the pan control is enabled.