| Package | com.afcomponents.umap.providers.arcgis |
| Class | public class ArcGISMapProvider |
| Inheritance | ArcGISMapProvider  XMLProvider DefaultProvider flash.events.EventDispatcher |
| Subclasses | ArcGISTiledMapProvider |
| Property | Defined by | ||
|---|---|---|---|
| baseURL : String [read-only]
| ArcGISMapProvider | ||
 | copyrightURL : URLRequest
Gets or sets the URL Request object that will be used to download copyright data.
| XMLProvider | |
| DEFAULT_MAPTYPE_CLASS : Class [static]
Defines the class that will be used by settings parser to create new map type.
| XMLProvider | |
| DEFAULT_PROJECTION_CLASS : Class [static]
Defines the class that will be used by settings parser as the default map type projection.
| XMLProvider | |
| DEFAULT_TILELAYER_CLASS : Class [static]
Defines the class that will be used by settings parser to create new tile layer.
| XMLProvider | |
| languageURL : URLRequest
Gets or sets the URL Request object that will be used to download language data.
| XMLProvider | |
| loadingState : String
Indicates current loading state.
| XMLProvider | |
| logo : DisplayObject
Returns a display object with the provider's logo.
| DefaultProvider | |
| mapTypes : Array
Array which holds map types supported by this Provider.
| DefaultProvider | |
| settingsURL : URLRequest
Gets or sets the URL Request object that will be used to download settings data.
| XMLProvider | |
| Property | Defined by | ||
|---|---|---|---|
| _copyright : URLRequest
Copyright URL.
| XMLProvider | |
| _core : UMap
Reference to the core UMap class.
| DefaultProvider | |
| _default : Boolean
Flag that, indicates whether to use default language & settings data without loading it from the server.
| XMLProvider | |
| _description : String
Map description as defined by the map service provider.
| ArcGISMapProvider | ||
| _fullExtent : Bounds
Full extent as defined by the map service provider.
| ArcGISMapProvider | ||
| _initialExtent : Bounds
Initial extent as defined by the map service provider.
| ArcGISMapProvider | ||
| _language : URLRequest
Language URL.
| XMLProvider | |
| _loader : URLLoader
Reference to the
URLLoader object that is used for loading data. | XMLProvider | |
| _logo : DisplayObject
Display object which containes the provider logo.
| DefaultProvider | |
| _logoURL : URLRequest
URI of the provider logo.
| DefaultProvider | |
| _mapTypes : Array
Array of map types.
| DefaultProvider | |
| _proxyURL : String
The URL to proxy the request through.
| ArcGISMapProvider | ||
| _settings : *
Settings URL.
| XMLProvider | |
| _spatialReference : Number
The spatial reference of the map service.
| ArcGISMapProvider | ||
| _token : String
ArcGIS security token.
| ArcGISMapProvider | ||
| _units : String
Default units of the layer as defined by the service.
| ArcGISMapProvider | ||
| Method | Defined by | ||
|---|---|---|---|
|
ArcGISMapProvider(url:String)
Defines new ArcGIS provider.
| ArcGISMapProvider | ||
|
addMapType(type:IMapType):Boolean
Adds new map type to the map types Array.
| DefaultProvider | |
|
clearLogo():void
Clears the logo.
| DefaultProvider | |
|
dispose():void
Frees the resources accuired by the Provider.
| XMLProvider | |
|
getDefaultCopyright():String
Returns default copyright string.
| XMLProvider | |
|
getDefaultCopyrightURL():URLRequest
Abstract function.
| XMLProvider | |
|
getDefaultLanguage():String
Abstract function.
| XMLProvider | |
|
getDefaultLanguageURL():URLRequest
Abstract function.
| XMLProvider | |
|
getDefaultSettings():String
| ArcGISMapProvider | ||
|
getDefaultSettingsURL():URLRequest
Abstract function.
| XMLProvider | |
|
getMapTypeByName(mapTypeName:String):IMapType
Returns map type reference by it's name.
| DefaultProvider | |
|
Initializes the provider and starts the loading process.
| XMLProvider | |
|
Loads copyright information for the specified area from the url defined by the
copyrightURL property. | XMLProvider | |
|
setLogo(logo:*):void
Setups the logo for the provider, loads it if necessary.
| DefaultProvider | |
| Method | Defined by | ||
|---|---|---|---|
|
fromJSON(obj:Object):Boolean
Loads params from JSON object.
| ArcGISMapProvider | ||
|
Queries specified map type for copyright string and generates COPYRIGHT_CHANGED event.
| DefaultProvider | |
|
initMapTypes():void
Override this function to define map types.
| DefaultProvider | |
|
loadNextCopyright(url:URLRequest = null):void
Loads the queued copyright request.
| XMLProvider | |
|
parseCopyright(data:String):void
Abstract method.
| XMLProvider | |
|
parseLanguage(data:String):Boolean
Abstract method.
| XMLProvider | |
|
parseSettings(data:String):Boolean
Parses the XML data with the provider settings.
| ArcGISMapProvider | ||
| baseURL | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbaseURL:String [read-only]Implementation
public function get baseURL():String
| _description | property |
protected var _description:StringMap description as defined by the map service provider.
| _fullExtent | property |
protected var _fullExtent:BoundsFull extent as defined by the map service provider.
| _initialExtent | property |
protected var _initialExtent:BoundsInitial extent as defined by the map service provider.
| _proxyURL | property |
protected var _proxyURL:StringThe URL to proxy the request through. Unsupported.
| _spatialReference | property |
protected var _spatialReference:NumberThe spatial reference of the map service.
| _token | property |
protected var _token:StringArcGIS security token.
| _units | property |
protected var _units:StringDefault units of the layer as defined by the service.
| ArcGISMapProvider | () | constructor |
public function ArcGISMapProvider(url:String)Defines new ArcGIS provider.
Parametersurl:String — URL endpoint of a service.
To obtain the URL, use ArcGIS Services Directory.
An example URL for the Street Map service on ArcGIS Online is:
http://server.arcgisonline.com/ArcGIS/rest/services/ESRI_StreetMap_World_2D/MapServer
|
| fromJSON | () | method |
protected function fromJSON(obj:Object):BooleanLoads params from JSON object.
Parametersobj:Object |
Boolean |
| getDefaultSettings | () | method |
public override function getDefaultSettings():String
Returns
String |
| parseSettings | () | method |
protected override function parseSettings(data:String):BooleanParses the XML data with the provider settings. Override it for custom settings data parser.
This method has a default implementation. It will define map types out of a XML data. Parameters
data:String — Textual data that needs to be parsed.
|
Boolean — A value of true if parsing was successfull; false if it was not.
|