The main mapping component of the ArcGIS API for Flex.
Default map navigation includes both mouse and keyboard interaction.
You can also turn on and off the crosshair symbol (which marks the center of the map),
the pan arrows around the edge of the map and the zoom slider bar.
Map navigation using mouse:
Map navigation using keyboard:
layers
Example
MXML to display a map of Africa showing where Kilimanjaro is located:
<esri:Map>
<esri:ArcGISTiledMapServiceLayer
url="http://server.arcgisonline.com/ArcGIS/rest/services/ESRI_StreetMap_World_2D/MapServer" />
<esri:GraphicsLayer>
<esri:Graphic toolTip="Kilimanjaro - 5,895 metres (19,341 ft)">
<esri:geometry>
<esri:MapPoint x="37.229" y="-3.107"/>
</esri:geometry>
</esri:Graphic>
</esri:GraphicsLayer>
<esri:extent>
<esri:Extent xmin="-17" ymin="-35" xmax="51" ymax="38"/>
</esri:extent>
</esri:Map>
clickRecenterEnabled:Boolean [read-write]
Enables recenter by click - press Shift and click the map to recenter on the clicked location.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get clickRecenterEnabled():Boolean
public function set clickRecenterEnabled(value:Boolean):void
crosshairVisible:Boolean [read-write]
Shows a crosshair at the center of the map.
The default value is false.
This property can be used as the source for data binding.
Implementation
public function get crosshairVisible():Boolean
public function set crosshairVisible(value:Boolean):void
doubleClickZoomEnabled:Boolean [read-write]
Enables double-click zoom - double-click the map to zoom in and recenter it at the clicked location.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get doubleClickZoomEnabled():Boolean
public function set doubleClickZoomEnabled(value:Boolean):void
extent:Extent [read-write]
Extent of the map.
This is determined from an initial map extent (if it exists)
or from the initial extent of the first layer added to the map.
This property can be used as the source for data binding.
Implementation
public function get extent():Extent
public function set extent(value:Extent):void
See also
Example
Specifying the extent of a Map:
<esri:Extent id="myExtent" xmin="15" ymin="54" xmax="40" ymax="71" spatialReference="{new SpatialReference(4326)}"/>
<esri:Map extent="{myExtent}"/>
infoWindow:InfoWindow [read-only]
The info window.
This property can be used as the source for data binding.
Implementation
public function get infoWindow():InfoWindow
See also
infoWindowContent:UIComponent [read-write]
The info window content [added in version 1.3].
Using this property, the content structure of the info window can be specified in mxml.
This property can be used as the source for data binding.
Implementation
public function get infoWindowContent():UIComponent
public function set infoWindowContent(value:UIComponent):void
Example
Basic use of infoWindowContent:
<esri:Map>
<esri:infoWindowContent>
<mx:VBox label="Title">
<mx:Label id="myLabel"/>
</mx:VBox>
</esri:infoWindowContent>
</esri:Map>
keyboardNavigationEnabled:Boolean [read-write]
Enables panning and zooming via the keyboard.
- Pan using the four arrow keys.
- Press the + key to zoom in at center of map.
- Press the - key to zoom out at center of map.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get keyboardNavigationEnabled():Boolean
public function set keyboardNavigationEnabled(value:Boolean):void
layerIds:Array [read-only]
Array of current layers (IDs) in the map.
This property can be used as the source for data binding.
Implementation
public function get layerIds():Array
layers:Object [read-write]
Set of layers to be viewed.
This property lets you use either an Array, an ArrayCollection, or a single Layer.
If you set the layers property to an Array, it will be converted to an ArrayCollection.
If you set the property to an ArrayCollection, it will be used directly.
If you set the property to a single Layer, it will be wrapped in a new ArrayCollection.
Note: the layers property was added in version 1.1 of the ArcGIS API for Flex.
The default value is an empty ArrayCollection.
This property can be used as the source for data binding.
Implementation
public function get layers():Object
public function set layers(value:Object):void
See also
level:Number [read-write]
The level of detail ID for the map. When updated, zooms to the new level based on the current map centerpoint.
Valid only when the map has lods.
This property can be used as the source for data binding.
Implementation
public function get level():Number
public function set level(value:Number):void
loaded:Boolean [read-only]
After the first layer is loaded, the value is set to true.
The load event is also fired.
This property can be used as the source for data binding.
Implementation
public function get loaded():Boolean
lods:Array [read-write]
Array of LOD's defining the map's levels.
This array will be null unless the base layer was a tiled layer or the lods property has been set.
This property can be used as the source for data binding.
Implementation
public function get lods():Array
public function set lods(value:Array):void
See also
Example
ActionScript code to set map levels to a specific tiled service:
myMap.lods = myTiledLayer.tileInfo.lods;
ActionScript code to add map levels (note: tiled layers will only show at scales they were created for):
var lods:Array = myMap.lods;
lods.push( new LOD( NaN, 0.00000713838288433451000000, 3000) );
lods.push( new LOD( NaN, 0.00000356919144216726000000, 1500) );
myMap.lods = lods;
logoVisible:Boolean [read-write]
Logo visibility.
Turning off the logo is only possible if you connect to your own ArcGIS Server (not counting ArcGIS Online).
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get logoVisible():Boolean
public function set logoVisible(value:Boolean):void
mapNavigationEnabled:Boolean [read-write]
Enables all map navigation - using mouse as well as keyboard interaction.
Map navigation using mouse:
Map navigation using keyboard:
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get mapNavigationEnabled():Boolean
public function set mapNavigationEnabled(value:Boolean):void
navigationClass:Class [read-write]
A reference to the class to use for the navigation control.
The default value is com.esri.ags.controls.Navigation.
This property can be used as the source for data binding.
Implementation
public function get navigationClass():Class
public function set navigationClass(value:Class):void
See also
openHandCursorVisible:Boolean [read-write]
When set to false, the open hand cursor is not shown over the map.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get openHandCursorVisible():Boolean
public function set openHandCursorVisible(value:Boolean):void
panArrowsVisible:Boolean [read-write]
Displays eight pan arrows around the edge of the map.
The default value is false.
This property can be used as the source for data binding.
Implementation
public function get panArrowsVisible():Boolean
public function set panArrowsVisible(value:Boolean):void
panDuration:Number [read-write]
The length of time in milliseconds that the map will take to pan from one extent to another [added in version 1.3].
The minimum allowed value is 1.
The default value is 300 milliseconds.
This property can be used as the source for data binding.
Implementation
public function get panDuration():Number
public function set panDuration(value:Number):void
panEnabled:Boolean [read-write]
Enables mouse panning.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get panEnabled():Boolean
public function set panEnabled(value:Boolean):void
rubberbandZoomEnabled:Boolean [read-write]
Enables rubberband zoom - press Shift, click, then drag to draw a bounding box zoom area.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get rubberbandZoomEnabled():Boolean
public function set rubberbandZoomEnabled(value:Boolean):void
See also
scale:Number [read-write]
The map scale. This is calculated based on the units value, so make sure the units value is set correctly.
This property can be used as the source for data binding.
Implementation
public function get scale():Number
public function set scale(value:Number):void
See also
scaleBarClass:Class [read-write]
A reference to the class to use for the scale bar.
The default value is com.esri.ags.controls.ScaleBar.
This property can be used as the source for data binding.
Implementation
public function get scaleBarClass():Class
public function set scaleBarClass(value:Class):void
See also
scaleBarVisible:Boolean [read-write]
Displays the scale bar on the map.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get scaleBarVisible():Boolean
public function set scaleBarVisible(value:Boolean):void
See also
scrollWheelZoomEnabled:Boolean [read-write]
Enables zooming with the mouse scroll wheel.
- Use mouse scroll forward to zoom in at current mouse location.
- Use mouse scroll backward to zoom out at current mouse location.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get scrollWheelZoomEnabled():Boolean
public function set scrollWheelZoomEnabled(value:Boolean):void
spatialReference:SpatialReference [read-only]
The spatial reference of the map.
This is determined from an initial map extent with a spatial reference (if it exists)
or from the spatial reference of the first layer added to the map.
This property can be used as the source for data binding.
Implementation
public function get spatialReference():SpatialReference
units:String [read-write]
The units of the Map. These units are used for calculating the map scale.
The default value is the units of the first layer added to the map.
This property can be used as the source for data binding.
Implementation
public function get units():String
public function set units(value:String):void
See also
zoomDuration:Number [read-write]
The length of time in milliseconds that the map will take to zoom from one extent to another [added in version 1.3].
The minimum allowed value is 1.
The default value is 300 milliseconds.
This property can be used as the source for data binding.
Implementation
public function get zoomDuration():Number
public function set zoomDuration(value:Number):void
zoomSliderVisible:Boolean [read-write]
Displays the zoom slider of the map.
If the Map has lods, the zoom slider will contain the actual scale levels of the lods.
If the map doesn't have lods, the zoom slider will only have the zoom in and zoom out icons.
The zoom slider can be styled using CSS for Navigation.
The default value is true.
This property can be used as the source for data binding.
Implementation
public function get zoomSliderVisible():Boolean
public function set zoomSliderVisible(value:Boolean):void
See also
public function Map()
Creates a new Map.
public function addLayer(layer:Layer, index:int = -1):String
Adds a layer to the map.
If an ID was not defined, a unique name will be created and assigned to the layer.
The unique name is created using NameUtil.createUniqueName,
which will combine the unqualified class name with an incrementing counter to create something like "Layer2".
Note: the second property, index, was added in version 1.1 of the ArcGIS API for Flex.
Parameters
| layer:Layer — The layer to add.
|
| |
| index:int (default = -1) |
Returns
| String — The ID of the layer.
|
See also
Example
Adding a layer to a map using ActionScript:
var myGraphicsLayer:GraphicsLayer = new GraphicsLayer();
myMap.addLayer(myGraphicsLayer);
public function centerAt(mapPoint:MapPoint):void
Recenters the map at the specified location.
Parameters
| mapPoint:MapPoint — The point to center at.
|
See also
Example
ActionScript to center map:
myMap.centerAt( addressCandidate.location );
public function getLayer(layerId:String):Layer
Returns an individual layer of a map.
Parameters
| layerId:String — The layer identifier.
|
Returns
| Layer —
The layer associated with ID. If not found, null is returned.
|
public function panDown():void
Pans the map south.
public function panLeft():void
Pans the map west.
public function panLowerLeft():void
Pans the map southwest.
public function panLowerRight():void
Pans the map southeast.
public function panRight():void
Pans the map east.
public function panUp():void
Pans the map north.
public function panUpperLeft():void
Pans the map northwest.
public function panUpperRight():void
Pans the map northeast.
public function removeAllLayers():void
Removes all layers.
public function removeLayer(layer:Layer):void
Removes the specified layer.
Parameters
public function reorderLayer(layerId:String, index:int):void
Changes the layer order in the map.
Note that the first layer added is always the base layer, even if the order is changed later (or the first layer removed).
Parameters
| layerId:String — The ID of the layer to be moved. This ID is assigned in Layer.id.
|
| |
| index:int — Refers to the location for placing the layer. The bottommost layer has an index of 0.
|
Example
ActionScript code to move a layer to the bottom of all layers:
myMap.reorderLayer("myGraphicsLayer", 0);ActionScript code to move a layer to the top of all other layers:
myMap.reorderLayer("myTiledLayer", myMap.layers.length);
public function toMap(screenPoint:Point):MapPoint
Converts a screen point to a map point.
See toMapFromStage() for how to easily convert the coordinates of an event click to map coordinates.
Parameters
| screenPoint:Point — The screen point.
|
Returns
See also
Example
Convert pixel coordinates to map coordinates
var mapLocalPixelPoint:Point = map.globalToLocal( new Point(event.stageX, event.stageY) );
var mapPoint:MapPoint = map.toMap( mapLocalPixelPoint );
public function toMapFromStage(stageX:Number, stageY:Number):MapPoint
Converts the global stage coordinates to a map point.
Parameters
| stageX:Number — The horizontal coordinate in global stage coordinates.
|
| |
| stageY:Number — The vertical coordinate in global stage coordinates.
|
Returns
Example
Easily get the geographic location of a mouse click.
var mapPoint:MapPoint = map.toMapFromStage( event.stageX, event.stageY );
public function toScreen(mapPoint:MapPoint):Point
Converts a map point to a screen point.
Parameters
| mapPoint:MapPoint — The map point to convert.
|
Returns
| Point — Point in screen coordinates.
|
public function zoomIn():void
Make the map zoom in.
public function zoomOut():void
Make the map zoom out.
Event object type: com.esri.ags.events.ExtentEvent
ExtentEvent.type property = com.esri.ags.events.ExtentEvent.EXTENT_CHANGE
Fires when the extent of the map has changed.
Defines the value of the type property of an extentChange event object.
Event object type: com.esri.ags.events.MapEvent
MapEvent.type property = com.esri.ags.events.MapEvent.LAYER_ADD
Fires when a layer is added.
Defines the value of the type property of a layerAdd event object.
Event object type: com.esri.ags.events.MapEvent
MapEvent.type property = com.esri.ags.events.MapEvent.LAYER_REMOVE
Fires when a layer is removed.
Defines the value of the type property of a layerRemove event object.
Event object type: com.esri.ags.events.MapEvent
MapEvent.type property = com.esri.ags.events.MapEvent.LAYER_REMOVE_ALL
Fires when all layers are removed.
Defines the value of the type property of a layerRemoveAll event object.
Event object type: com.esri.ags.events.MapEvent
MapEvent.type property = com.esri.ags.events.MapEvent.LAYER_REORDER
Fires when the map layer order has been changed.
Defines the value of the type property of a layerReorder event object.
Event object type: com.esri.ags.events.MapEvent
MapEvent.type property = com.esri.ags.events.MapEvent.LOAD
Fires when the first layer has been successfully added to the map.
Defines the value of the type property of a load event object.
Event object type: com.esri.ags.events.MapMouseEvent
MapMouseEvent.type property = com.esri.ags.events.MapMouseEvent.MAP_CLICK
Fires when user clicks on the map. Unlike the flash click event,
this won't fire if the user pans the map.
Note: the mapClick event was added in version 1.1 of the ArcGIS API for Flex.
Defines the value of the type property of a mapClick event object.
Event object type: com.esri.ags.events.PanEvent
PanEvent.type property = com.esri.ags.events.PanEvent.PAN_END
Fires when the pan is complete.
Defines the value of the type property of a panEnd event object.
Event object type: com.esri.ags.events.PanEvent
PanEvent.type property = com.esri.ags.events.PanEvent.PAN_START
Fires when a user commences panning.
Defines the value of the type property of a panStart event object.
Event object type: com.esri.ags.events.PanEvent
PanEvent.type property = com.esri.ags.events.PanEvent.PAN_UPDATE
Fires during the pan process.
Defines the value of the type property of a panUpdate event object.
Event object type: com.esri.ags.events.ZoomEvent
ZoomEvent.type property = com.esri.ags.events.ZoomEvent.ZOOM_END
Fires when the zoom is complete.
Defines the value of the type property of a zoomEnd event object.
Event object type: com.esri.ags.events.ZoomEvent
ZoomEvent.type property = com.esri.ags.events.ZoomEvent.ZOOM_START
Fires when a user commences zooming.
Defines the value of the type property of a zoomStart event object.
Event object type: com.esri.ags.events.ZoomEvent
ZoomEvent.type property = com.esri.ags.events.ZoomEvent.ZOOM_UPDATE
Fires during the zoom process.
Defines the value of the type property of a zoomUpdate event object.
(c) 2009 ESRI. All rights reserved.
mx.containers.Canvas