Packagecom.esri.ags.webmap
Classpublic class WebMapUtil
InheritanceWebMapUtil Inheritance flash.events.EventDispatcher

Since : ArcGIS API for Flex 2.2

Utility methods to work with "Web maps" from ArcGIS.com or any ArcGIS Portal. To use with ArcGIS Portal, set the arcgisSharingURL property.

See also

http://www.arcgis.com
ArcGIS.com Help

Public Properties
 PropertyDefined By
  arcgisSharingURL : String
The base URL to the item and item data.
WebMapUtil
  bingMapsKey : String
The Bing Maps Key, required if working with Microsoft Bing Maps.
WebMapUtil
  geometryService : GeometryService
The GeometryService to used to project the extent with when necessary.
WebMapUtil
  ignorePopUps : Boolean = false
If true, any popups defined in the Web map will be ignored when creating a map from an ArcGIS.com Web map.
WebMapUtil
  proxyURL : String
The URL to proxy the requests through when necessary.
WebMapUtil
Public Methods
 MethodDefined By
  
WebMapUtil()
Creates a new WebMapUtil object.
WebMapUtil
  
createMapById(itemId:String, responder:IResponder = null):AsyncToken
Create a map using information from an ArcGIS.com item.
WebMapUtil
  
createMapByItem(item:Object, itemData:Object, responder:IResponder = null):AsyncToken
Create a map using information from an ArcGIS.com item.
WebMapUtil
  
getItem(itemId:String, responder:IResponder = null):AsyncToken
Gets details about the input ArcGIS.com item.
WebMapUtil
Events
 Event Summary Defined By
  
createMapByIdComplete
Dispatched when an createMapById operation successfully completes.WebMapUtil
  
createMapByItemComplete
Dispatched when an createMapByItem operation successfully completes.WebMapUtil
  
fault
Dispatched when a WebMapUtil fails.WebMapUtil
  
getItemComplete
Dispatched when an getItem operation successfully completes.WebMapUtil
Property Detail
arcgisSharingURLproperty
arcgisSharingURL:String

The base URL to the item and item data. Defaults to the ArcGIS.com base URL, but can be set to any ArcGIS Portal.

The default value is http://www.arcgis.com/sharing/content/items.


Implementation
    public function get arcgisSharingURL():String
    public function set arcgisSharingURL(value:String):void
bingMapsKeyproperty 
public var bingMapsKey:String

The Bing Maps Key, required if working with Microsoft Bing Maps.

geometryServiceproperty 
public var geometryService:GeometryService

The GeometryService to used to project the extent with when necessary. The item's extent will not be used if this is not set and the item's extent needs to be projected.

ignorePopUpsproperty 
public var ignorePopUps:Boolean = false

Since : ArcGIS API for Flex 2.3

If true, any popups defined in the Web map will be ignored when creating a map from an ArcGIS.com Web map.

The default value is false.

proxyURLproperty 
proxyURL:String

The URL to proxy the requests through when necessary. If this is not set, layers that require a proxy will not be loaded.


Implementation
    public function get proxyURL():String
    public function set proxyURL(value:String):void
Constructor Detail
WebMapUtil()Constructor
public function WebMapUtil()

Creates a new WebMapUtil object.

Method Detail
createMapById()method
public function createMapById(itemId:String, responder:IResponder = null):AsyncToken

Create a map using information from an ArcGIS.com item.

Parameters

itemId:String — The item id.
 
responder:IResponder (default = null) — The responder to call on result or fault with either a WebMapEvent or a Fault passed as an argument.

Returns
AsyncToken
createMapByItem()method 
public function createMapByItem(item:Object, itemData:Object, responder:IResponder = null):AsyncToken

Create a map using information from an ArcGIS.com item.

Parameters

item:Object — The item metadata.
 
itemData:Object — The item data.
 
responder:IResponder (default = null) — The responder to call on result or fault with either a WebMapEvent or a Fault passed as an argument.

Returns
AsyncToken
getItem()method 
public function getItem(itemId:String, responder:IResponder = null):AsyncToken

Gets details about the input ArcGIS.com item.

Parameters

itemId:String — The item id.
 
responder:IResponder (default = null) — The responder to call on result or fault with either a WebMapEvent or a Fault passed as an argument.

Returns
AsyncToken
Event Detail
createMapByIdComplete Event
Event Object Type: com.esri.ags.events.WebMapEvent
WebMapEvent.type property = com.esri.ags.events.WebMapEvent.CREATE_MAP_BY_ID_COMPLETE

Dispatched when an createMapById operation successfully completes.

Defines the value of the type property of an createMapByIdComplete event object.
createMapByItemComplete Event  
Event Object Type: com.esri.ags.events.WebMapEvent
WebMapEvent.type property = com.esri.ags.events.WebMapEvent.CREATE_MAP_BY_ITEM_COMPLETE

Dispatched when an createMapByItem operation successfully completes.

Defines the value of the type property of an createMapByItemComplete event object.
fault Event  
Event Object Type: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

Dispatched when a WebMapUtil fails.

getItemComplete Event  
Event Object Type: com.esri.ags.events.WebMapEvent
WebMapEvent.type property = com.esri.ags.events.WebMapEvent.GET_ITEM_COMPLETE

Dispatched when an getItem operation successfully completes.

Defines the value of the type property of an getItemComplete event object.



© 2008-2011 Esri, Inc. All rights reserved.

Wed Nov 30 2011, 04:19 PM -08:00