Packagecom.afcomponents.umap.events
Classpublic class MapEvent
InheritanceMapEvent Inheritance flash.events.Event

The MapEvent class defines events that are fired by core.UMap class when user interacts with the map. It includes the following events:

  • MapEvent.READY: dispatched when the map has entered ready state.
  • MapEvent.PAN: dispatched when the map view is panning.
  • MapEvent.PAN_START: dispatched when the map view starts panning.
  • MapEvent.PAN_STOP: dispatched when the map view stops panning.
  • MapEvent.ZOOM: dispatched when the map zoom is changing.
  • MapEvent.ZOOM_START: dispatched when the map zoom starts changing.
  • MapEvent.ZOOM_STOP: dispatched when the map zoom stops changing.
  • MapEvent.CLICK: dispatched when the map has been clicked.
  • MapEvent.DOUBLE_CLICK: dispatched when the map has been double clicked.
  • MapEvent.DRAG: dispatched when user drags the map.
  • MapEvent.DRAG_START: dispatched when user starts dragging the map.
  • MapEvent.DRAG_STOP: dispatched when user stops dragging the map.
  • MapEvent.MOVE_END: dispatched when automatic panning of the map has been finished.
  • MapEvent.PROPERTY_CHANGED: dispatched when map property has changed.
  • MapEvent.INFO_WINDOW_OPEN: dispatched when info window has been opened.
  • MapEvent.INFO_WINDOW_CLOSE: dispatched when info window has been closed.
  • MapEvent.VIEW_CHANGED: dispatched when map view has been changed.


  • Public Properties
     PropertyDefined by
      latlng : LatLng
    [read-only] Returns map position in geogrpahical coordinates.
    MapEvent
      param : *
    [read-only] Returns object with additional event information.
    MapEvent
    Public Methods
     MethodDefined by
      
    MapEvent(type:String, latlng:LatLng = null, param:Boolean = null, bubbles:Boolean = false, cancelable:* = false)
    Creates a MapEvent object that contains information about map display change events.
    MapEvent
    Public Constants
     ConstantDefined by
      CLICK : String = "mapClick"
    [static] The MapEvent.CLICK constant defines the value of the type property of an mapClick event object.
    MapEvent
      DOUBLE_CLICK : String = "mapDoubleClick"
    [static] The MapEvent.DOUBLE_CLICK constant defines the value of the type property of an mapDoubleClick event object.
    MapEvent
      DRAG : String = "drag"
    [static] The MapEvent.DRAG constant defines the value of the type property of an drag event object.
    MapEvent
      DRAG_START : String = "dragStart"
    [static] The MapEvent.DRAG_START constant defines the value of the type property of an dragStart event object.
    MapEvent
      DRAG_STOP : String = "dragStop"
    [static] The MapEvent.DRAG_STOP constant defines the value of the type property of an dragStop event object.
    MapEvent
      INFO_WINDOW_CLOSE : String = "infoWindowClose"
    [static] The MapEvent.INFO_WINDOW_CLOSE constant defines the value of the type property of an infoWindowClose event object.
    MapEvent
      INFO_WINDOW_OPEN : String = "infoWindowOpen"
    [static] The MapEvent.INFO_WINDOW_OPEN constant defines the value of the type property of an infoWindowOpen event object.
    MapEvent
      MOVE_END : String = "moveEnd"
    [static] The MapEvent.MOVE_END constant defines the value of the type property of an moveEnd event object.
    MapEvent
      PAN : String = "pan"
    [static] The MapEvent.PAN constant defines the value of the type property of a pan event object.
    MapEvent
      PAN_START : String = "panStart"
    [static] The MapEvent.PAN_START constant defines the value of the type property of a panStart event object.
    MapEvent
      PAN_STOP : String = "panStop"
    [static] The MapEvent.PAN_STOP constant defines the value of the type property of a panStop event object.
    MapEvent
      PROPERTY_CHANGED : String = "propertyChanged"
    [static] The MapEvent.PROPERTY_CHANGED constant defines the value of the type property of an propertyChanged event object.
    MapEvent
      READY : String = "mapReady"
    [static] The MapEvent.READY constant defines the value of the type property of a ready event object.
    MapEvent
      VIEW_CHANGED : String = "viewChanged"
    [static] The MapEvent.VIEW_CHANGED constant defines the value of the type property of an viewChanged event object.
    MapEvent
      ZOOM : String = "zoom"
    [static] The MapEvent.ZOOM constant defines the value of the type property of a zoom event object.
    MapEvent
      ZOOM_START : String = "zoomStart"
    [static] The MapEvent.ZOOM_START constant defines the value of the type property of an zoomStart event object.
    MapEvent
      ZOOM_STOP : String = "zoomStop"
    [static] The MapEvent.ZOOM_STOP constant defines the value of the type property of an zoomStop event object.
    MapEvent
    Property detail
    latlngproperty
    latlng:LatLng  [read-only]

    Returns map position in geogrpahical coordinates.

    Implementation
        public function get latlng():LatLng
    paramproperty 
    param:*  [read-only]

    Returns object with additional event information.

    Implementation
        public function get param():*
    Constructor detail
    MapEvent()constructor
    public function MapEvent(type:String, latlng:LatLng = null, param:Boolean = null, bubbles:Boolean = false, cancelable:* = false)

    Creates a MapEvent object that contains information about map display change events. Event objects are passed as parameters to event listeners.

    Parameters
    type:String — The type of the event. Event listeners can access this information through the inherited type property.
     
    latlng:LatLng (default = null) — Specifies the position of the map center.
     
    param:Boolean (default = null) — Specifies an Object with additional event information.
     
    bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property.
     
    cancelable:* (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
    Constant detail
    CLICKconstant
    public static const CLICK:String = "mapClick"

    The MapEvent.CLICK constant defines the value of the type property of an mapClick event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the click.
    paramnull
    DOUBLE_CLICKconstant 
    public static const DOUBLE_CLICK:String = "mapDoubleClick"

    The MapEvent.DOUBLE_CLICK constant defines the value of the type property of an mapDoubleClick event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the double click.
    paramnull
    DRAGconstant 
    public static const DRAG:String = "drag"

    The MapEvent.DRAG constant defines the value of the type property of an drag event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    DRAG_STARTconstant 
    public static const DRAG_START:String = "dragStart"

    The MapEvent.DRAG_START constant defines the value of the type property of an dragStart event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    DRAG_STOPconstant 
    public static const DRAG_STOP:String = "dragStop"

    The MapEvent.DRAG_STOP constant defines the value of the type property of an dragStop event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    INFO_WINDOW_CLOSEconstant 
    public static const INFO_WINDOW_CLOSE:String = "infoWindowClose"

    The MapEvent.INFO_WINDOW_CLOSE constant defines the value of the type property of an infoWindowClose event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramReference to the closed info window.
    INFO_WINDOW_OPENconstant 
    public static const INFO_WINDOW_OPEN:String = "infoWindowOpen"

    The MapEvent.INFO_WINDOW_OPEN constant defines the value of the type property of an infoWindowOpen event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramReference to the opened info window.
    MOVE_ENDconstant 
    public static const MOVE_END:String = "moveEnd"

    The MapEvent.MOVE_END constant defines the value of the type property of an moveEnd event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    PANconstant 
    public static const PAN:String = "pan"

    The MapEvent.PAN constant defines the value of the type property of a pan event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    PAN_STARTconstant 
    public static const PAN_START:String = "panStart"

    The MapEvent.PAN_START constant defines the value of the type property of a panStart event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    PAN_STOPconstant 
    public static const PAN_STOP:String = "panStop"

    The MapEvent.PAN_STOP constant defines the value of the type property of a panStop event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramnull
    PROPERTY_CHANGEDconstant 
    public static const PROPERTY_CHANGED:String = "propertyChanged"

    The MapEvent.PROPERTY_CHANGED constant defines the value of the type property of an propertyChanged event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramName of the parameter that has been changed.
    READYconstant 
    public static const READY:String = "mapReady"

    The MapEvent.READY constant defines the value of the type property of a ready event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngnull
    paramnull
    VIEW_CHANGEDconstant 
    public static const VIEW_CHANGED:String = "viewChanged"

    The MapEvent.VIEW_CHANGED constant defines the value of the type property of an viewChanged event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramReference to the closed info window.
    ZOOMconstant 
    public static const ZOOM:String = "zoom"

    The MapEvent.ZOOM constant defines the value of the type property of a zoom event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramObject which describes zoom animation: startZoom, targetZoom, currentZoom
    ZOOM_STARTconstant 
    public static const ZOOM_START:String = "zoomStart"

    The MapEvent.ZOOM_START constant defines the value of the type property of an zoomStart event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramObject which describes zoom animation: startZoom, targetZoom, currentZoom
    ZOOM_STOPconstant 
    public static const ZOOM_STOP:String = "zoomStop"

    The MapEvent.ZOOM_STOP constant defines the value of the type property of an zoomStop event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTarget The object that is actively processing the OverlayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographical coordinates of the map center point.
    paramObject which describes zoom animation: startZoom, targetZoom, currentZoom