Packagecom.gestureworks.cml.elements
Classpublic class ModestMap
InheritanceModestMap Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The ModestMap element uses the ModestMaps API to generate an interactive map that can be touched and zoomed. Optionally ModestMapMarkers can be included with it to give points of interest. A ModestMapMarker is primarily a container for graphic objects that attaches itself to a map point, so it is invisible until display objects are added to its display list.

When declaring a map, the important parts are latitude, longitude, zoom, and the mapprovider, which is the style of map that will be seen.

When declaring latitude, negative values are west of the Prime Meridian, and for longitude, negative values are south of the equator.

     
        var map1:ModestMapElement = new ModestMapElement;
        map1.latitude = 51.1789;
        map1.longitude = -1.8624;
        map1.zoom = 7;
        map1.mapprovider = "MicrosoftRoadMapProvider";
     
     



Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
  latitude : Number
Sets and retrives the latitude of the starting location.
ModestMap
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  loaded : String
[read-only] Read-only property indicating if the element is loaded or not.
ModestMap
  longitude : Number
Sets and retrives the longitude of the starting location.
ModestMap
  map : TweenMap
ModestMap
  mapprovider : String
This sets and retrieves the type of map the user will see.
ModestMap
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  scaleable : Boolean
Sets if the map is scaleable
ModestMap
  scaleFactor : Number
Sets how fast the map scales in
ModestMap
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
  zoom : Number
Sets and retrieves the Zoom at which the map will start.
ModestMap
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
ModestMap
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
ModestMap
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialisation method
ModestMap
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
  
Sets the current index value
ModestMap
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
  
Updates the frame of Modest Map
ModestMap
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
latitudeproperty
latitude:Number

Sets and retrives the latitude of the starting location. Negative values are South of the Equator, positive values are North. For example, 1.2345 S would be -1.2345.


Implementation
    public function get latitude():Number
    public function set latitude(value:Number):void
loadedproperty 
loaded:String  [read-only]

Read-only property indicating if the element is loaded or not.


Implementation
    public function get loaded():String
longitudeproperty 
longitude:Number

Sets and retrives the longitude of the starting location. Negative values are West of the Prime Meridian, positive values are East. For example, 1.2345 W would be -1.2345.


Implementation
    public function get longitude():Number
    public function set longitude(value:Number):void
mapproperty 
public var map:TweenMap

mapproviderproperty 
mapprovider:String

This sets and retrieves the type of map the user will see. This is not case-sensitive. Types are: BlueMarbleMapProvider, MicrosoftAerialMapProvider, MicrosoftHybridMapProvder, MicrosoftRoadMapProvider, OpenStreeMapProvider, YahooAerialMapProvider, YahooHybridMapProvider, YahooRoadMapProvider.


Implementation
    public function get mapprovider():String
    public function set mapprovider(value:String):void
scaleableproperty 
scaleable:Boolean

Sets if the map is scaleable

The default value is true.


Implementation
    public function get scaleable():Boolean
    public function set scaleable(value:Boolean):void
scaleFactorproperty 
scaleFactor:Number

Sets how fast the map scales in

The default value is 15.0.


Implementation
    public function get scaleFactor():Number
    public function set scaleFactor(value:Number):void
zoomproperty 
zoom:Number

Sets and retrieves the Zoom at which the map will start. Must be a value of 1 or larger or no map will be seen at runtime.

The default value is 1.


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor Detail
ModestMap()Constructor
public function ModestMap()

Constructor

Method Detail
dispose()method
override public function dispose():void

Destructor

init()method 
override public function init():void

Initialisation method

switchMapProvider()method 
public function switchMapProvider(e:*):void

Sets the current index value

Parameters

e:*

updateFrame()method 
public function updateFrame():void

Updates the frame of Modest Map