Packagecom.esri.aws.awx.map
Interfacepublic interface IMap extends flash.events.IEventDispatcher, IProjectionModel, IGroupLayer, ILayer, flash.events.IEventDispatcher
ImplementorsMap

IMap defines the basic map methods and events.



Public Properties
 PropertyDefined by
 Inheritedalpha : Number
The transparency value of the layer.
ILayer
 Inheritedcenter : GeoPoint
The geographic center of the map.
IProjectionModel
 Inheritededitable : Boolean
If true, the group layer is editable so all of the manipulation methods with throw an error.
IGroupLayer
 Inheritedextent : Extent
The bounding box (minX, minY, maxX, maxY) of the current map.
IProjectionModel
 Inheritedicon : Class
The icon that represents this layer.
ILayer
 Inheritedid : String
The layer identifier.
ILayer
  keyboardHandler : IKeyboardHandler
The keyboard handler that should handle all keyboard interactions with the map.
IMap
 Inheritedlabel : String
The label of the layer.
ILayer
 Inheritedlayers : Array
The layers in this group layer.
IGroupLayer
 InheritedlayerStyle : IStyle
The style of the layer.
ILayer
 Inheritedmap : IMap
The reference to the parent map container.
ILayer
  mapHeight : Number
[read-only] The map height in pixels.
IMap
 InheritedmapRotation : Number
The rotation of the map.
IProjectionModel
  mapType : String
The name of the map type.
IMap
  mapWidth : Number
[read-only] The map width in pixels.
IMap
  maxScale : Number
The maximum allowed scale.
IMap
  minScale : Number
The minimum allowed scale.
IMap
  mouseHandler : IMouseHandler
The mouse handler that should handle all mouse interactions with the map.
IMap
 InheritednumLayers : int
The number of layers in the group.
IGroupLayer
 InheritedprojectionID : int
The current projectionID of the map.
IProjectionModel
  rotatedHeight : Number
[read-only] The rotated map height in pixels.
IMap
  rotatedWidth : Number
[read-only] The rotated map width in pixels.
IMap
 Inheritedscale : Number
The current scale of the map.
IProjectionModel
  staticLayer : IStaticLayer
[read-only] The main Static Layer (an IStaticLayer) onto which Static objects can be placed.
IMap
 Inheritedstyle : IStyle
DEPRECATED
ILayer
 InheritedsupportedProjections : Array
The array of supported projections for this groupLayer.
ILayer
 Inheritedvisible : Boolean
If true, the layer is visible.
ILayer
Public Methods
 MethodDefined by
 Inherited
addLayer(layer:ILayer):void
Adds a layer to the group layer.
IGroupLayer
 Inherited
addLayerAt(layer:ILayer, index:int):void
Adds a layer at a specific index.
IGroupLayer
  
Returns a scale to ensure that an entire extent is visible.
IMap
 Inherited
Converts decimal degree values to pixel.
IProjectionModel
 Inherited
Converts pixel values to decimal degrees.
IProjectionModel
 Inherited
getLayer(layerID:String):ILayer
Gets a layer based on its identifier.
IGroupLayer
 Inherited
getUIComponent():UIComponent
The layer's UIComponent.
ILayer
 Inherited
moveLayerAbove(layer1ID:String, layer2ID:String):void
Moves the first layer above the the second layer in the z-order.
IGroupLayer
 Inherited
moveLayerBelow(layer1ID:String, layer2ID:String):void
Moves the first layer below the the second layer in the z-order.
IGroupLayer
 Inherited
moveLayerToBottom(layerID:String):void
Moves the layer to the bottom of the z-order.
IGroupLayer
 Inherited
moveLayerToTop(layerID:String):void
Moves the layer to the top of the z-order.
IGroupLayer
 Inherited
Removes all the layers.
IGroupLayer
 Inherited
removeLayer(layerID:String):void
Removes a layer.
IGroupLayer
 Inherited
If the current projection is 'Automatic', returns the projectionID for which automatic projection is currently selected.
IProjectionModel
  
showWorld():void
Shows the world based on the height and width of the map.
IMap
 Inherited
swapLayers(layer1ID:String, layer2ID:String):void
Swaps the z-order of two layers.
IGroupLayer
Events
 EventSummaryDefined by
   Dispatched after a child has been added to a container.IMap
   Dispatched before a child of a container is removed.IMap
   A layer has been moved within a GroupLayer.IMap
   Used to detect when the map model has been changed.IMap
   Used to detect when the mapType has been changed.IMap
   The map is starting to pan.IMap
   The map is finished panning.IMap
Property detail
keyboardHandlerproperty
keyboardHandler:IKeyboardHandler  [read-write]

The keyboard handler that should handle all keyboard interactions with the map.

Implementation
    public function get keyboardHandler():IKeyboardHandler
    public function set keyboardHandler(value:IKeyboardHandler):void
mapHeightproperty 
mapHeight:Number  [read-only]

The map height in pixels.

Implementation
    public function get mapHeight():Number
mapTypeproperty 
mapType:String  [read-write]

The name of the map type.

Implementation
    public function get mapType():String
    public function set mapType(value:String):void
mapWidthproperty 
mapWidth:Number  [read-only]

The map width in pixels.

Implementation
    public function get mapWidth():Number
maxScaleproperty 
maxScale:Number  [read-write]

The maximum allowed scale. Only used if greater than 1.0.

The default value is 0.0.

Implementation
    public function get maxScale():Number
    public function set maxScale(value:Number):void
minScaleproperty 
minScale:Number  [read-write]

The minimum allowed scale. Can not be lower than 1.0.

The default value is 1.0.

Implementation
    public function get minScale():Number
    public function set minScale(value:Number):void
mouseHandlerproperty 
mouseHandler:IMouseHandler  [read-write]

The mouse handler that should handle all mouse interactions with the map.

Implementation
    public function get mouseHandler():IMouseHandler
    public function set mouseHandler(value:IMouseHandler):void
rotatedHeightproperty 
rotatedHeight:Number  [read-only]

The rotated map height in pixels.

Implementation
    public function get rotatedHeight():Number
rotatedWidthproperty 
rotatedWidth:Number  [read-only]

The rotated map width in pixels.

Implementation
    public function get rotatedWidth():Number
staticLayerproperty 
staticLayer:IStaticLayer  [read-only]

The main Static Layer (an IStaticLayer) onto which Static objects can be placed.

Implementation
    public function get staticLayer():IStaticLayer
Method detail
convertExtentToScale()method
public function convertExtentToScale(extent:Extent):Number

Returns a scale to ensure that an entire extent is visible.

Parameters
extent:Extent — the extent to get a scale for.

Returns
Number — The scale factor.
showWorld()method 
public function showWorld():void

Shows the world based on the height and width of the map.

Event detail
childAddevent 
Event object type: mx.events.ChildExistenceChangedEvent

Dispatched after a child has been added to a container.

The childAdd event is dispatched when the addChild() or addChildAt() method is called. When a container is first created, the addChild() method is automatically called for each child component declared in the MXML file. The addChildAt() method is automatically called whenever a Repeater object adds or removes child objects. The application developer may also manually call these methods to add new children.

At the time when this event is sent, the child object has been initialized, but its width and height have not yet been calculated, and the child has not been drawn on the screen. If you want to be notified when the child has been fully initialized and rendered, then register as a listener for the child's creationComplete event.

childRemoveevent  
Event object type: mx.events.ChildExistenceChangedEvent

Dispatched before a child of a container is removed.

This event is delivered when any of the following methods are called: removeChild(), removeChildAt(), or removeAllChildren().

groupLayerChangeevent  
Event object type: com.esri.aws.awx.events.GroupLayerEvent
GroupLayerEvent.type property = com.esri.aws.awx.events.GroupLayerEvent.GROUPLAYER_CHANGE

A layer has been moved within a GroupLayer.

mapChangeevent  
Event object type: com.esri.aws.awx.events.MapChangeEvent
MapChangeEvent.type property = com.esri.aws.awx.events.MapChangeEvent.MAP_CHANGE

Used to detect when the map model has been changed.

mapTypeChangeevent  
Event object type: com.esri.aws.awx.events.MapTypeChangeEvent
MapTypeChangeEvent.type property = com.esri.aws.awx.events.MapTypeChangeEvent.MAP_TYPE_CHANGE

Used to detect when the mapType has been changed.

panStartevent  
Event object type: com.esri.aws.awx.events.PanEvent
PanEvent.type property = com.esri.aws.awx.events.PanEvent.PAN_START

The map is starting to pan.

panStopevent  
Event object type: com.esri.aws.awx.events.PanEvent
PanEvent.type property = com.esri.aws.awx.events.PanEvent.PAN_STOP

The map is finished panning.