Packagecom.mapquest.tilemap.pois
Classpublic class Poi
InheritancePoi Inheritance flash.events.EventDispatcher
ImplementsIShape


Public Properties
 PropertyDefined by
  x : int
Poi
  y : int
Poi
Public Methods
 MethodDefined by
  
Poi(latLng:IPointLL, mapIcon:MapIcon = null)
Constructs a Poi object.
Poi
  
draw():void
Redraws this poi.
Poi
  
getAltIcon():MapIcon
Returns the alt state icon of this poi.
Poi
  
getAltStateFlag():Boolean
Returns true if this poi's alt state is true, false otherwise.
Poi
  
getDeclutterIcon():MapIcon
Returns the declutter icon of this poi.
Poi
  
getDeclutterStateFlag():Boolean
Returns true if this poi's declutter state is true, false otherwise.
Poi
  
getDraggable():Boolean
Returns the current draggable status of the Poi.
Poi
  
getDragOffset():IPointXY
Poi
  
getGlobalLeaderLineDotIcon():Boolean
[static]
Poi
  
getIcon():MapIcon
Returns the icon of this poi.
Poi
  
getInfoContent():Object
Gets the info window content for this poi.
Poi
  
getInfoTitle():String
Gets the info window title for this poi.
Poi
  
getInfoWindowTitleText():String
Poi
  
getKey():String
Returns the key of this poi.
Poi
  
getLabel():String
Returns the label for this poi.
Poi
  
getLabelFormat():TextFormat
Returns the label style for this poi.
Poi
  
getLatLng():IPointLL
Returns the latitude/longitude coordinate of this poi.
Poi
  
getLeaderLine():Sprite
Poi
  
getLeaderLineColor():Number
Returns the current leader line color of the Poi.
Poi
  
getLeaderLineDotIcon():Sprite
Poi
  
getLeaderLineDotImageURL():String
Poi
  
getMap():TileMap
Poi
  
getMaxInfoWindowWidth():Number
Poi
  
getMaxZoomLevel():int
Poi
  
getMinZoomLevel():int
Poi
  
getParentCollections():Array
Poi
  
getRolloverDrag():Boolean
Returns the drag status of the rollover.
Poi
  
getRolloverTimeout():int
Poi
  
getSnapback():Boolean
Returns a current snapback status of this poi when draggable.
Poi
  
isIconVisible():Boolean
Returns true if this poi icon is visible, false otherwise.
Poi
  
isLabelVisible():Boolean
Returns true if this poi label is visible, false otherwise.
Poi
  
isRolloverEnabled():Boolean
Returns true if a rollover is enabled for this poi, false otherwise.
Poi
  
isVisible():Boolean
Returns true if this poi is visible, false otherwise.
Poi
  
setAltIcon(altMapIcon:MapIcon):void
Sets the icon of this poi.
Poi
  
setAltStateFlag(b:Boolean):void
Sets the poi's alt state flag.
Poi
  
setDeclutterIcon(mapIcon:MapIcon):void
Sets the declutter icon of this poi.
Poi
  
setDeclutterStateFlag(b:Boolean):void
Sets the poi's alt state flag.
Poi
  
setDraggable(isEnabled:Boolean):void
Sets the draggable status of the Poi.
Poi
  
setDragOffset(drag:IPointXY):void
Poi
  
setGlobalLeaderLineDotIcon(b:Boolean):void
[static]
Poi
  
setIcon(mapIcon:MapIcon):void
Sets the icon of this poi.
Poi
  
setIconVisible(b:Boolean):void
Makes this poi icon visible or invisible.
Poi
  
setInfoContent(content:Object):void
Sets the info window content for this poi.
Poi
  
setInfoTitle(title:String):void
Sets the info window title for this poi.
Poi
  
setInfoWindowTitleBackgroundColor(bcolor:Number):void
Poi
  
setInfoWindowTitleText(content:String):void
Poi
  
setKey(key:String):void
Sets the key for this poi.
Poi
  
setLabel(label:String, frmt:TextFormat = null):void
Sets the label for this poi to the specified label string.
Poi
  
setLabelVisible(b:Boolean):void
Makes this poi label visible or invisible.
Poi
  
setLatLng(mqLatLng:IPointLL):void
Sets the latitude/longitude coordinate of this poi.
Poi
  
setLeaderLine(ll:Sprite):void
Poi
  
setLeaderLineColor(c:Number):void
Sets the leaderline color of the Poi.
Poi
  
setLeaderLineDotIcon(s:Sprite, redraw:Boolean = true):void
Poi
  
setLeaderLineDotImageURL(url:String, redraw:Boolean = true):void
Poi
  
setMap(map:TileMap):void
Poi
  
setMaxInfoWindowWidth(n:Number):void
Poi
  
setMaxZoomLevel(maxZoomLevel:int):void
Poi
  
setMinZoomLevel(minZoomLevel:int):void
Poi
  
setParentCollections(parentCollections:Array):void
Poi
  
setRolloverDrag(b:Boolean):void
Sets whether to drag the rollover with the poi.
Poi
  
setRolloverEnabled(benable:Boolean):void
Enables or disables a rollover for this poi.
Poi
  
setRolloverTimeout(i:int):void
sets the time in milliseconds that the rollover will remain after rollout (defaults to 0)
Poi
  
setRolloverWindow(rolloverWindow:RolloverWindow):void
Sets poi's rollover window
Poi
  
setSnapback(snap:Boolean):void
Sets the snapback status of the Poi.
Poi
  
setVisible(b:Boolean):void
Makes this poi visible or invisible.
Poi
  
showInfoWindow():void
Displays map's info window at this location, populated with content for this Poi
Poi
  
showRolloverWindow(e:Event):void
Displays map's rollover window at this location, populated with content for this MQPoi
Poi
Property detail
xproperty
x:int  [read-write]Implementation
    public function get x():int
    public function set x(value:int):void
yproperty 
y:int  [read-write]Implementation
    public function get y():int
    public function set y(value:int):void
Constructor detail
Poi()constructor
public function Poi(latLng:IPointLL, mapIcon:MapIcon = null)

Constructs a Poi object.

Parameters
latLng:IPointLL — specifying the location of the point on the map.
 
mapIcon:MapIcon (default = null) — specified the icon that represents this poi else a default icon will be used.
Method detail
draw()method
public function draw():void

Redraws this poi.

getAltIcon()method 
public function getAltIcon():MapIcon

Returns the alt state icon of this poi.

Returns
MapIcon

See also

setIcon
getAltStateFlag()method 
public function getAltStateFlag():Boolean

Returns true if this poi's alt state is true, false otherwise.

Returns
Boolean

See also

setAltStateFlag
getDeclutterIcon()method 
public function getDeclutterIcon():MapIcon

Returns the declutter icon of this poi.

Returns
MapIcon

See also

setIcon
getDeclutterStateFlag()method 
public function getDeclutterStateFlag():Boolean

Returns true if this poi's declutter state is true, false otherwise.

Returns
Boolean

See also

setDeclutterStateFlag
getDraggable()method 
public function getDraggable():Boolean

Returns the current draggable status of the Poi.

Returns
Boolean
getDragOffset()method 
public function getDragOffset():IPointXY

Returns
IPointXY
getGlobalLeaderLineDotIcon()method 
public static function getGlobalLeaderLineDotIcon():Boolean

Returns
Boolean
getIcon()method 
public function getIcon():MapIcon

Returns the icon of this poi.

Returns
MapIcon

See also

setIcon
getInfoContent()method 
public function getInfoContent():Object

Gets the info window content for this poi.

Returns
Object
getInfoTitle()method 
public function getInfoTitle():String

Gets the info window title for this poi.

Returns
String
getInfoWindowTitleText()method 
public function getInfoWindowTitleText():String

Returns
String
getKey()method 
public function getKey():String

Returns the key of this poi.

Returns
String

See also

setKey
getLabel()method 
public function getLabel():String

Returns the label for this poi.

Returns
String

See also

setLabel
getLabelFormat()method 
public function getLabelFormat():TextFormat

Returns the label style for this poi.

Returns
TextFormat
getLatLng()method 
public function getLatLng():IPointLL

Returns the latitude/longitude coordinate of this poi.

Returns
IPointLL

See also

setLatLng
getLeaderLine()method 
public function getLeaderLine():Sprite

Returns
Sprite
getLeaderLineColor()method 
public function getLeaderLineColor():Number

Returns the current leader line color of the Poi.

Returns
Number
getLeaderLineDotIcon()method 
public function getLeaderLineDotIcon():Sprite

Returns
Sprite
getLeaderLineDotImageURL()method 
public function getLeaderLineDotImageURL():String

Returns
String
getMap()method 
public function getMap():TileMap

Returns
TileMap
getMaxInfoWindowWidth()method 
public function getMaxInfoWindowWidth():Number

Returns
Number
getMaxZoomLevel()method 
public function getMaxZoomLevel():int

Returns
int
getMinZoomLevel()method 
public function getMinZoomLevel():int

Returns
int
getParentCollections()method 
public function getParentCollections():Array

Returns
Array
getRolloverDrag()method 
public function getRolloverDrag():Boolean

Returns the drag status of the rollover.

Returns
Boolean

See also

setRolloverDrag
getRolloverTimeout()method 
public function getRolloverTimeout():int

Returns
int
getSnapback()method 
public function getSnapback():Boolean

Returns a current snapback status of this poi when draggable.

Returns
Boolean
isIconVisible()method 
public function isIconVisible():Boolean

Returns true if this poi icon is visible, false otherwise.

Returns
Boolean

See also

setIconVisible
isLabelVisible()method 
public function isLabelVisible():Boolean

Returns true if this poi label is visible, false otherwise.

Returns
Boolean

See also

setLabelVisible
isRolloverEnabled()method 
public function isRolloverEnabled():Boolean

Returns true if a rollover is enabled for this poi, false otherwise.

Returns
Boolean

See also

setRolloverEnabled
isVisible()method 
public function isVisible():Boolean

Returns true if this poi is visible, false otherwise.

Returns
Boolean

See also

setVisible
setAltIcon()method 
public function setAltIcon(altMapIcon:MapIcon):void

Sets the icon of this poi. The poi is refreshed on the map.

Parameters
altMapIcon:MapIcon — The new icon for this poi.

See also

getIcon
setAltStateFlag()method 
public function setAltStateFlag(b:Boolean):void

Sets the poi's alt state flag.

Parameters
b:Boolean — b true to make the alt icon visible, false to make primary icon visible.

See also

getAltStateFlag
setDeclutterIcon()method 
public function setDeclutterIcon(mapIcon:MapIcon):void

Sets the declutter icon of this poi.

Parameters
mapIcon:MapIcon — new declutter icon for this poi.

See also

getIcon
setDeclutterStateFlag()method 
public function setDeclutterStateFlag(b:Boolean):void

Sets the poi's alt state flag.

Parameters
b:Boolean — b true to make the declutter icon visible, false to make primary icon visible.

See also

getDeclutterStateFlag
setDraggable()method 
public function setDraggable(isEnabled:Boolean):void

Sets the draggable status of the Poi.

Parameters
isEnabled:Boolean — the draggable state is enabled.

See also

getDraggable
setDragOffset()method 
public function setDragOffset(drag:IPointXY):voidParameters
drag:IPointXY
setGlobalLeaderLineDotIcon()method 
public static function setGlobalLeaderLineDotIcon(b:Boolean):voidParameters
b:Boolean
setIcon()method 
public function setIcon(mapIcon:MapIcon):void

Sets the icon of this poi. The poi is refreshed on the map.

Parameters
mapIcon:MapIcon — new icon for this poi.

See also

getIcon
setIconVisible()method 
public function setIconVisible(b:Boolean):void

Makes this poi icon visible or invisible.

Parameters
b:Boolean — b true to make icon visible; false to make invisible.

See also

isIconVisible
setInfoContent()method 
public function setInfoContent(content:Object):void

Sets the info window content for this poi.

Parameters
content:Object — content An HTML string for the info window content.
setInfoTitle()method 
public function setInfoTitle(title:String):void

Sets the info window title for this poi.

Parameters
title:String — title A string for the info window title.
setInfoWindowTitleBackgroundColor()method 
public function setInfoWindowTitleBackgroundColor(bcolor:Number):voidParameters
bcolor:Number
setInfoWindowTitleText()method 
public function setInfoWindowTitleText(content:String):voidParameters
content:String
setKey()method 
public function setKey(key:String):void

Sets the key for this poi. The key is a string identifier for use by the developer.

Parameters
key:String — key The new key for this poi.

See also

getKey
setLabel()method 
public function setLabel(label:String, frmt:TextFormat = null):void

Sets the label for this poi to the specified label string.

Parameters
label:String — new label string.
 
frmt:TextFormat (default = null) — Textformat to usef for the label.

See also

getLabel
setLabelVisible()method 
public function setLabelVisible(b:Boolean):void

Makes this poi label visible or invisible.

Parameters
b:Boolean — b true to make label visible; false to make invisible.

See also

isLabelVisible
setLatLng()method 
public function setLatLng(mqLatLng:IPointLL):void

Sets the latitude/longitude coordinate of this poi. The poi is refreshed on the map.

Parameters
mqLatLng:IPointLL — LatLng The new latitude/longitude coordinate of this poi.

See also

getLatLng
setLeaderLine()method 
public function setLeaderLine(ll:Sprite):voidParameters
ll:Sprite
setLeaderLineColor()method 
public function setLeaderLineColor(c:Number):void

Sets the leaderline color of the Poi.

Parameters
c:Number — value of the color to use for this poi's leaderline..

See also

getLeaderLineColor
setLeaderLineDotIcon()method 
public function setLeaderLineDotIcon(s:Sprite, redraw:Boolean = true):voidParameters
s:Sprite
 
redraw:Boolean (default = true)
setLeaderLineDotImageURL()method 
public function setLeaderLineDotImageURL(url:String, redraw:Boolean = true):voidParameters
url:String
 
redraw:Boolean (default = true)
setMap()method 
public function setMap(map:TileMap):voidParameters
map:TileMap
setMaxInfoWindowWidth()method 
public function setMaxInfoWindowWidth(n:Number):voidParameters
n:Number
setMaxZoomLevel()method 
public function setMaxZoomLevel(maxZoomLevel:int):voidParameters
maxZoomLevel:int
setMinZoomLevel()method 
public function setMinZoomLevel(minZoomLevel:int):voidParameters
minZoomLevel:int
setParentCollections()method 
public function setParentCollections(parentCollections:Array):voidParameters
parentCollections:Array
setRolloverDrag()method 
public function setRolloverDrag(b:Boolean):void

Sets whether to drag the rollover with the poi. Default is true.

Parameters
b:Boolean — b True to include the rollover with the poi drag, false otherwise..

See also

getRolloverDrag
setRolloverEnabled()method 
public function setRolloverEnabled(benable:Boolean):void

Enables or disables a rollover for this poi.

Parameters
benable:Boolean — benable true to enable rollover; false to disable rollover.

See also

isRolloverEnabled
setRolloverTimeout()method 
public function setRolloverTimeout(i:int):void

sets the time in milliseconds that the rollover will remain after rollout (defaults to 0)

Parameters
i:int
setRolloverWindow()method 
public function setRolloverWindow(rolloverWindow:RolloverWindow):void

Sets poi's rollover window

Parameters
rolloverWindow:RolloverWindow
setSnapback()method 
public function setSnapback(snap:Boolean):void

Sets the snapback status of the Poi.

Parameters
snap:Boolean — snapback - Whether the draggable state is enabled.

See also

getDraggable
setVisible()method 
public function setVisible(b:Boolean):void

Makes this poi visible or invisible.

Parameters
b:Boolean — b true to make visible; false to make invisible.

See also

isVisible
showInfoWindow()method 
public function showInfoWindow():void

Displays map's info window at this location, populated with content for this Poi

showRolloverWindow()method 
public function showRolloverWindow(e:Event):void

Displays map's rollover window at this location, populated with content for this MQPoi

Parameters
e:Event