| Package | com.gestureworks.cml.element |
| Class | public class ModestMap |
| Inheritance | ModestMap  Container ContainerFactory ElementFactory flash.display.Sprite |
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";
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| blur : Boolean
Sets the drop shadow effect
| ElementFactory | |
| bottom : Number
sets the bottom value
| ElementFactory | |
| childList : ChildList [read-only]
store the child list
| ContainerFactory | |
| class_ : String
Object's css class;
| ElementFactory | |
| className : String
sets the class name of displayobject
| ElementFactory | |
| cmlIndex : int
sets the cml index
| ElementFactory | |
| debugStyle : *
sets the debug style
| ElementFactory | |
| dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | |
| displayEvents : String
Use for dispatch completes. | ElementFactory | |
| draggable : Boolean
Sets the draggable property of the map. | ModestMap | ||
| dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | |
| height : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| heightPercent : String
sets the height percent of display object
| ElementFactory | |
| horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | |
| id : String
sets the id of child
| ElementFactory | |
| index : int
sets the index of display object
| ElementFactory | |
| infoSource : String
sets info source
| ContainerFactory | |
| latitude : Number
Sets and retrives the latitude of the starting location. | ModestMap | ||
| layout : *
Sets the layout of the container
| Container | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| Container | |
| layoutList : Dictionary
Defines the layoutlist
| Container | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| Container | |
| left : Number
sets left value
| ElementFactory | |
| 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 | ||
| mapprovider : String
This sets and retrieves the type of map the user will see. | ModestMap | ||
| paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | Container | |
| paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | |
| paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | |
| paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | Container | |
| position : String
Sets the position
| Container | |
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| right : Number
sets the right value
| ElementFactory | |
| scale : Number
Sets both the x and y scale values
| ElementFactory | |
| scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| scaleY : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| state : Array
property states array
| ElementFactory | |
| top : Number
sets top value
| ElementFactory | |
| verticalCenter : Number
sets the vertical center of display object
| ElementFactory | |
| width : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| zoom : Number
Sets and retrieves the Zoom at which the map will start. | ModestMap | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor
| ModestMap | ||
| addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
TODO: This mechanism should be abstracted to better syncrhonize child and display lists
| Container | |
| applyLayout(value:* = null):void
Apply the containers layout
| Container | |
| childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | |
| clone():*
Returns clone of self
| ElementFactory | |
displayComplete():void [override]
CML callbcak Initialisation
| ModestMap | ||
dispose():void [override]
Dispose method
| ModestMap | ||
| getIndex(index:int):*
returns childlist index
| Container | |
| getKey(key:String):*
returns the childlist key
| Container | |
| hideIndex(index:int):void
hides the childlist index
| Container | |
| hideKey(key:String):void
hides the childlist key
| Container | |
init():void [override]
Initialisation method
| ModestMap | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | |
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | |
| setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | |
| showIndex(index:int):void
shows the childlist index
| Container | |
| showKey(key:String):void
shows the childlist key
| Container | |
switchMapProvider(e:*):void
Sets the current index value
| ModestMap | ||
updateFrame():void
Updates the frame of Modest Map
| ModestMap | ||
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| draggable | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesdraggable:BooleanSets the draggable property of the map.
The default value is true.
public function get draggable():Boolean public function set draggable(value:Boolean):void| latitude | property |
latitude:NumberSets 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.
public function get latitude():Number public function set latitude(value:Number):void| loaded | property |
loaded:String [read-only] Read-only property indicating if the element is loaded or not.
public function get loaded():String| longitude | property |
longitude:NumberSets 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.
public function get longitude():Number public function set longitude(value:Number):void| mapprovider | property |
mapprovider:StringThis 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.
public function get mapprovider():String public function set mapprovider(value:String):void| zoom | property |
zoom:NumberSets 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.
public function get zoom():Number public function set zoom(value:Number):void| ModestMap | () | Constructor |
public function ModestMap()Constructor
| displayComplete | () | method |
override public function displayComplete():voidCML callbcak Initialisation
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidInitialisation method
| switchMapProvider | () | method |
public function switchMapProvider(e:*):voidSets the current index value
Parameters
e:* |
| updateFrame | () | method |
public function updateFrame():voidUpdates the frame of Modest Map