Packagecom.mapquest.tilemap.overlays
Classpublic class ShapeOverlay
InheritanceShapeOverlay Inheritance flash.display.Sprite
SubclassesDisplayObjectOverlay, EllipseOverlay, ImageOverlay, LineOverlay, PolygonOverlay, RectangleOverlay



Public Properties
 PropertyDefined by
  visible : Boolean
ShapeOverlay
Protected Properties
 PropertyDefined by
  altBorderWidth : Number = 3
ShapeOverlay
  altColor : Number = -1
ShapeOverlay
  altColorAlpha : Number = 1
ShapeOverlay
  altFillColor : Number = -1
ShapeOverlay
  altFillColorAlpha : Number = 1
ShapeOverlay
  altStateFlag : Boolean = false
ShapeOverlay
  borderWidth : Number = 3
ShapeOverlay
  color : Number = 0x000000
ShapeOverlay
  colorAlpha : Number = 1
ShapeOverlay
  fillColor : Number = 0x000000
ShapeOverlay
  fillColorAlpha : Number = 1
ShapeOverlay
  hasDrawn : Boolean = false
ShapeOverlay
  key : String = ""
ShapeOverlay
  map : TileMap
ShapeOverlay
  maxZoomLevel : int = 16
ShapeOverlay
  minZoomLevel : int = 1
ShapeOverlay
  shapePoints : IPointLLCollection
ShapeOverlay
  visibleFlag : Boolean = true
ShapeOverlay
Public Methods
 MethodDefined by
  
ShapeOverlay(overlayToClone:ShapeOverlay = null)
Base shape class Constructs a new MQShapeOverlay object
ShapeOverlay
  
clone(overlayToClone:ShapeOverlay):void
Clones the specified overlay.
ShapeOverlay
  
Returns the alternate border width for this overlay object.
ShapeOverlay
  
getAltColor():Number
Returns the alt border color for this overlay object.
ShapeOverlay
  
Returns the altColorAlpha for this overlay object.
ShapeOverlay
  
getAltFillColor():Number
Returns the alt fill color for this overlay object.
ShapeOverlay
  
Returns the alt fill color alpha (transparency) for this overlay object.
ShapeOverlay
  
getAltStateFlag():Boolean
Returns the alternate state for this overlay object.
ShapeOverlay
  
getBorderWidth():Number
Returns the border width for this overlay object.
ShapeOverlay
  
getColor():Number
Returns the border color for this overlay object.
ShapeOverlay
  
getColorAlpha():Number
Returns the color alpha (transparency) for this overlay object.
ShapeOverlay
  
getFillColor():Number
Returns the fill color for this overlay object.
ShapeOverlay
  
Returns the fill color alpha (transparency) for this overlay object.
ShapeOverlay
  
getKey():String
Returns the key for this overlay object.
ShapeOverlay
  
Returns the max zoom for this overlay object.
ShapeOverlay
  
Returns the min zoom for this overlay object.
ShapeOverlay
  
Gets the shape points of the overlay.
ShapeOverlay
  
getVisible():Boolean
Gets the visible property of the overlay.
ShapeOverlay
  
redraw():void
Redraws an existing overlay.
ShapeOverlay
  
setAll(params:Object):void
Sets all the properties of the overlay.
ShapeOverlay
  
setAltBorderWidth(lineWidth:Number):void
Sets the altBorderWidth for this overlay object.
ShapeOverlay
  
setAltColor(altColor:Number):void
Sets the altColor for this overlay object.
ShapeOverlay
  
setAltColorAlpha(altColorAlpha:Number):void
Sets the altColorAlpha for this overlay object.
ShapeOverlay
  
setAltFillColor(altFillColor:Number):void
Sets the altFillColor for this overlay object.
ShapeOverlay
  
setAltFillColorAlpha(altFillColorAlpha:Number):void
Sets the altFillColorAlpha for this overlay object.
ShapeOverlay
  
setAltStateFlag(altStateFlag:Boolean):void
Sets the altStateFlag for this overlay object.
ShapeOverlay
  
setBorderWidth(lineWidth:Number):void
Sets the borderWidth for this overlay object.
ShapeOverlay
  
setColor(color:Number):void
Sets the color for this overlay object.
ShapeOverlay
  
setColorAlpha(colorAlpha:Number):void
Sets the alpha (transparency) for this overlay object.
ShapeOverlay
  
setFillColor(fillColor:Number):void
Sets the fillColor for this overlay object.
ShapeOverlay
  
setFillColorAlpha(fillColorAlpha:Number):void
Sets the fillColorAlpha for this overlay object.
ShapeOverlay
  
setKey(key:String):void
Sets the key for this overlay object.
ShapeOverlay
  
setMap(map:TileMap):void
ShapeOverlay
  
setMaxZoomLevel(maxZoomLevel:int):void
Sets the max Zoom for this overlay object.
ShapeOverlay
  
setMinZoomLevel(minZoomLevel:int):void
Sets the min Zoom for this overlay object.
ShapeOverlay
  
setShapePoints(shapePoints:Object):void
Sets the shape points for the overlay.
ShapeOverlay
  
setVisible(bVisible:Boolean):void
Sets the Visible property for this overlay object.
ShapeOverlay
Protected Methods
 MethodDefined by
  
drawShape():void
ShapeOverlay
Property detail
altBorderWidthproperty
protected var altBorderWidth:Number = 3
altColorproperty 
protected var altColor:Number = -1
altColorAlphaproperty 
protected var altColorAlpha:Number = 1
altFillColorproperty 
protected var altFillColor:Number = -1
altFillColorAlphaproperty 
protected var altFillColorAlpha:Number = 1
altStateFlagproperty 
protected var altStateFlag:Boolean = false
borderWidthproperty 
protected var borderWidth:Number = 3
colorproperty 
protected var color:Number = 0x000000
colorAlphaproperty 
protected var colorAlpha:Number = 1
fillColorproperty 
protected var fillColor:Number = 0x000000
fillColorAlphaproperty 
protected var fillColorAlpha:Number = 1
hasDrawnproperty 
protected var hasDrawn:Boolean = false
keyproperty 
protected var key:String = ""
mapproperty 
protected var map:TileMap
maxZoomLevelproperty 
protected var maxZoomLevel:int = 16
minZoomLevelproperty 
protected var minZoomLevel:int = 1
shapePointsproperty 
protected var shapePoints:IPointLLCollection
visibleproperty 
visible:Boolean  [read-write]Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
visibleFlagproperty 
protected var visibleFlag:Boolean = true
Constructor detail
ShapeOverlay()constructor
public function ShapeOverlay(overlayToClone:ShapeOverlay = null)

Base shape class Constructs a new MQShapeOverlay object

Parameters
overlayToClone:ShapeOverlay (default = null)
Method detail
clone()method
public function clone(overlayToClone:ShapeOverlay):void

Clones the specified overlay.

Parameters
overlayToClone:ShapeOverlay
drawShape()method 
protected function drawShape():void
getAltBorderWidth()method 
public function getAltBorderWidth():Number

Returns the alternate border width for this overlay object.

Returns
Number

See also

getAltColor()method 
public function getAltColor():Number

Returns the alt border color for this overlay object.

Returns
Number

See also

getAltColorAlpha()method 
public function getAltColorAlpha():Number

Returns the altColorAlpha for this overlay object.

Returns
Number

See also

getAltFillColor()method 
public function getAltFillColor():Number

Returns the alt fill color for this overlay object.

Returns
Number

See also

getAltFillColorAlpha()method 
public function getAltFillColorAlpha():Number

Returns the alt fill color alpha (transparency) for this overlay object.

Returns
Number

See also

getAltStateFlag()method 
public function getAltStateFlag():Boolean

Returns the alternate state for this overlay object.

Returns
Boolean

See also

getBorderWidth()method 
public function getBorderWidth():Number

Returns the border width for this overlay object.

Returns
Number

See also

getColor()method 
public function getColor():Number

Returns the border color for this overlay object.

Returns
Number

See also

getColorAlpha()method 
public function getColorAlpha():Number

Returns the color alpha (transparency) for this overlay object.

Returns
Number

See also

getFillColor()method 
public function getFillColor():Number

Returns the fill color for this overlay object.

Returns
Number

See also

getFillColorAlpha()method 
public function getFillColorAlpha():Number

Returns the fill color alpha (transparency) for this overlay object.

Returns
Number

See also

getKey()method 
public function getKey():String

Returns the key for this overlay object.

Returns
String

See also

getMaxZoomLevel()method 
public function getMaxZoomLevel():int

Returns the max zoom for this overlay object.

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

Returns the min zoom for this overlay object.

Returns
int
getShapePoints()method 
public function getShapePoints():IPointLLCollection

Gets the shape points of the overlay.

Returns
IPointLLCollection — The shape points for the overlay.
getVisible()method 
public function getVisible():Boolean

Gets the visible property of the overlay.

Returns
Boolean — The visible property for the overlay.
redraw()method 
public function redraw():void

Redraws an existing overlay.

setAll()method 
public function setAll(params:Object):void

Sets all the properties of the overlay.

Parameters
params:Object — (MQRectLL or MQLatLngCollection) shape points for the overlay.
setAltBorderWidth()method 
public function setAltBorderWidth(lineWidth:Number):void

Sets the altBorderWidth for this overlay object.

Parameters
lineWidth:Number — overlay object alternate border size

See also

setAltColor()method 
public function setAltColor(altColor:Number):void

Sets the altColor for this overlay object.

Parameters
altColor:Number — overlay object (border) altColor

See also

setAltColorAlpha()method 
public function setAltColorAlpha(altColorAlpha:Number):void

Sets the altColorAlpha for this overlay object.

Parameters
altColorAlpha:Number — for alpha transparency (ex: 0.9)

See also

setAltFillColor()method 
public function setAltFillColor(altFillColor:Number):void

Sets the altFillColor for this overlay object.

Parameters
altFillColor:Number — overlay object (interior) altFillColor

See also

setAltFillColorAlpha()method 
public function setAltFillColorAlpha(altFillColorAlpha:Number):void

Sets the altFillColorAlpha for this overlay object.

Parameters
altFillColorAlpha:Number — for alpha transparency (ex: 0.9)

See also

setAltStateFlag()method 
public function setAltStateFlag(altStateFlag:Boolean):void

Sets the altStateFlag for this overlay object.

Parameters
altStateFlag:Boolean — boolean The overlay object alternate state -- 'true' if in alternate state.

See also

setBorderWidth()method 
public function setBorderWidth(lineWidth:Number):void

Sets the borderWidth for this overlay object.

Parameters
lineWidth:Number — int The overlay object border size

See also

setColor()method 
public function setColor(color:Number):void

Sets the color for this overlay object.

Parameters
color:Number — mixed String in hex format or 3-element array of R,G,B values. The overlay object (border) color

See also

setColorAlpha()method 
public function setColorAlpha(colorAlpha:Number):void

Sets the alpha (transparency) for this overlay object.

Parameters
colorAlpha:Number — Double value for alpha transpaency (ex: 0.9)

See also

setFillColor()method 
public function setFillColor(fillColor:Number):void

Sets the fillColor for this overlay object.

Parameters
fillColor:Number — overlay object (interior) fillColor

See also

setFillColorAlpha()method 
public function setFillColorAlpha(fillColorAlpha:Number):void

Sets the fillColorAlpha for this overlay object.

Parameters
fillColorAlpha:Number — for alpha transparency (ex: 0.9)

See also

setKey()method 
public function setKey(key:String):void

Sets the key for this overlay object.

Parameters
key:String — overlay object key

See also

setMap()method 
public function setMap(map:TileMap):voidParameters
map:TileMap
setMaxZoomLevel()method 
public function setMaxZoomLevel(maxZoomLevel:int):void

Sets the max Zoom for this overlay object.

Parameters
maxZoomLevel:int
setMinZoomLevel()method 
public function setMinZoomLevel(minZoomLevel:int):void

Sets the min Zoom for this overlay object.

Parameters
minZoomLevel:int
setShapePoints()method 
public function setShapePoints(shapePoints:Object):void

Sets the shape points for the overlay.

Parameters
shapePoints:Object — shape points for the overlay. MQPolygonOverlay must take an MQLatLngCollection of at least 3 points. If MQRectLL is passed in, it is automatically converted to MQLatLngCollection.
setVisible()method 
public function setVisible(bVisible:Boolean):void

Sets the Visible property for this overlay object.

Parameters
bVisible:Boolean — overlay object visible flag.