Packagecom.afcomponents.umap.events
Classpublic class DisplayEvent
InheritanceDisplayEvent Inheritance flash.events.Event

The DisplayEvent class defines events that are fired by core.UMap class when the map display changes. It includes the following events:

  • DisplayEvent.UPDATE_POSITION: dispatched when map view has been updated.
  • DisplayEvent.UPDATE_ZOOM: dispatched when map zoom has been updated.
  • DisplayEvent.UPDATE_MAP_TYPE: dispatched when map type has been updated.


  • Public Properties
     PropertyDefined by
      lat : Number
    [read-only] Returns latitude of the map position.
    DisplayEvent
      latlng : LatLng
    [read-only] Returns map position in geogrpahical coordinates.
    DisplayEvent
      lng : Number
    [read-only] Returns logitude of the map position.
    DisplayEvent
      mapType : String
    [read-only] Returns the name of the map type currently selected.
    DisplayEvent
      prevLat : Number
    [read-only] Returns latitude of the previous map position.
    DisplayEvent
      prevLatlng : LatLng
    [read-only] Returns previous map position in geogrpahical coordinates.
    DisplayEvent
      prevLng : Number
    [read-only] Returns logitude of the previous map position.
    DisplayEvent
      prevZoom : Number
    [read-only] Returns previous map zoom level.
    DisplayEvent
      zoom : Number
    [read-only] Returns map zoom level.
    DisplayEvent
    Public Methods
     MethodDefined by
      
    DisplayEvent(type:String, latlng:LatLng = null, prevLatlng:LatLng = null, zoom:Number, prevZoom:Number, mapType:String = null, bubbles:Boolean = false, cancelable:Boolean = false)
    Creates a DisplayEvent object that contains information about events that are fired by core.UMap class when user interacts with the map.
    DisplayEvent
    Public Constants
     ConstantDefined by
      UPDATE_MAP_TYPE : String = "updateMapType"
    [static] The DisplayEvent.UPDATE_MAP_TYPE constant defines the value of the type property of an updateMapType event object.
    DisplayEvent
      UPDATE_POSITION : String = "updatePosition"
    [static] The DisplayEvent.UPDATE_POSITION constant defines the value of the type property of an updatePosition event object.
    DisplayEvent
      UPDATE_ZOOM : String = "updateZoom"
    [static] The DisplayEvent.UPDATE_ZOOM constant defines the value of the type property of an updateZoom event object.
    DisplayEvent
    Property detail
    latproperty
    lat:Number  [read-only]

    Returns latitude of the map position.

    Implementation
        public function get lat():Number
    latlngproperty 
    latlng:LatLng  [read-only]

    Returns map position in geogrpahical coordinates.

    Implementation
        public function get latlng():LatLng
    lngproperty 
    lng:Number  [read-only]

    Returns logitude of the map position.

    Implementation
        public function get lng():Number
    mapTypeproperty 
    mapType:String  [read-only]

    Returns the name of the map type currently selected.

    Implementation
        public function get mapType():String
    prevLatproperty 
    prevLat:Number  [read-only]

    Returns latitude of the previous map position.

    Implementation
        public function get prevLat():Number
    prevLatlngproperty 
    prevLatlng:LatLng  [read-only]

    Returns previous map position in geogrpahical coordinates.

    Implementation
        public function get prevLatlng():LatLng
    prevLngproperty 
    prevLng:Number  [read-only]

    Returns logitude of the previous map position.

    Implementation
        public function get prevLng():Number
    prevZoomproperty 
    prevZoom:Number  [read-only]

    Returns previous map zoom level.

    Implementation
        public function get prevZoom():Number
    zoomproperty 
    zoom:Number  [read-only]

    Returns map zoom level.

    Implementation
        public function get zoom():Number
    Constructor detail
    DisplayEvent()constructor
    public function DisplayEvent(type:String, latlng:LatLng = null, prevLatlng:LatLng = null, zoom:Number, prevZoom:Number, mapType:String = null, bubbles:Boolean = false, cancelable:Boolean = false)

    Creates a DisplayEvent object that contains information about events that are fired by core.UMap class when user interacts with the map. 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.
     
    prevLatlng:LatLng (default = null) — Specifies previous position of the map center.
     
    zoom:Number — Specifies map zoom level.
     
    prevZoom:Number — Specifies previous map zoom level.
     
    mapType:String (default = null) — Specifies the name of the map type selected.
     
    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:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
    Constant detail
    UPDATE_MAP_TYPEconstant
    public static const UPDATE_MAP_TYPE:String = "updateMapType"

    The DisplayEvent.UPDATE_MAP_TYPE constant defines the value of the type property of an updateMapType 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 DisplayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographic coordinates of the map's center.
    prevLatlngPreviously defined geographic coordinates of the map's center.
    zoomZoom level of the map view.
    prevZoomPreviously defined zoom level of the map view.
    mapTypeName of the map type currently used with the map.
    UPDATE_POSITIONconstant 
    public static const UPDATE_POSITION:String = "updatePosition"

    The DisplayEvent.UPDATE_POSITION constant defines the value of the type property of an updatePosition 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 DisplayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographic coordinates of the map's center.
    prevLatlngPreviously defined geographic coordinates of the map's center.
    zoomZoom level of the map view.
    prevZoomPreviously defined zoom level of the map view.
    mapTypeName of the map type currently used with the map.
    UPDATE_ZOOMconstant 
    public static const UPDATE_ZOOM:String = "updateZoom"

    The DisplayEvent.UPDATE_ZOOM constant defines the value of the type property of an updateZoom 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 DisplayEvent object with an event listener.
    targetReference to the core.UMap instance.
    latlngGeographic coordinates of the map's center.
    prevLatlngPreviously defined geographic coordinates of the map's center.
    zoomZoom level of the map view.
    prevZoomPreviously defined zoom level of the map view.
    mapTypeName of the map type currently used with the map.