com.afcomponents.umap.providers.cloudmade.CloudMadeXMLProvider

Package	com.afcomponents.umap.providers.cloudmade
Class	public class CloudMadeXMLProvider
Inheritance	CloudMadeXMLProvider XMLProvider DefaultProvider flash.events.EventDispatcher
Subclasses	CloudMadeStamenProvider, CloudMadeStandardProvider

Provider for use with cloudmade.com service which is tuned via XML settings file.

To use their service you need to obtain the api-key.

Example
Here is the usage sample:

 import com.afcomponents.umap.core.UMap;
 import com.afcomponents.umap.providers.cloudmade.CloudMadeXMLProvider;
  
 var provider:CloudMadeXMLProvider = new CloudMadeXMLProvider("API KEY");
    map.setProvider(provider);

See also

http://cloudmade.com

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		_apikey : String	CloudMadeXMLProvider
		_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
		_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
		_settings : * Settings URL.	XMLProvider

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		CloudMadeXMLProvider(apikey:String, defaultData:Boolean = false, settings:* = null) ColudMadeProvider constructor.	CloudMadeXMLProvider
		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 Abstract function.	XMLProvider
		getDefaultSettingsURL():URLRequest Abstract function.	XMLProvider
		getMapTypeByName(mapTypeName:String):IMapType Returns map type reference by it's name.	DefaultProvider
		init(core:UMap):void Initializes the provider and starts the loading process.	XMLProvider
		loadCopyright(center:LatLng, bounds:LatLngBounds, zoom:Number, event:String = ""):void 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

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		getMapTypeCopyright(bounds:LatLngBounds, zoom:Number, mapType:IMapType = null):void 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.	XMLProvider

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined by
		LOADING_COPYRIGHT : String = "loadingCopyright" [static] The `Provider.LOADING_COPYRIGHT` constant defines the value of the `loadingState` property of the `Provider` object that indicates that copyright information is being loaded at the moment.	XMLProvider
		LOADING_IDLE : String = "loadingIdle" [static] The `Provider.LOADING_IDLE` constant defines the value of the `loadingState` property of the `Provider` object that indicates that no loading occurs at the moment.	XMLProvider
		LOADING_LANGUAGE : String = "loadingLanguage" [static] The `Provider.LOADING_LANGUAGE` constant defines the value of the `loadingState` property of the `Provider` object that indicates that language file is being loaded at the moment.	XMLProvider
		LOADING_SETTINGS : String = "loadingSettings" [static] The `Provider.LOADING_SETTINGS` constant defines the value of the `loadingState` property of the `Provider` object that indicates that settings file is being loaded at the moment.	XMLProvider

Property detail

_apikey

property

protected var _apikey:String

Constructor detail

CloudMadeXMLProvider

()

constructor

public function CloudMadeXMLProvider(apikey:String, defaultData:Boolean = false, settings:* = null)

ColudMadeProvider constructor. Creates new provider instance. Don't forget to specify the api-key!

Parameters

	`apikey:String` — API key which can be obtained from the CloudMade site.

	`defaultData:Boolean` (default = `false`) — Specifies the image tile's style: use either `CloudMadeProvider.STYLE_STANDARD`, or `CloudMadeProvider.STYLE_MOBILE`.

	`settings:*` (default = `null`) — Specifes the size of the tiles: use either `CloudMadeProvider.SIZE_256`, or `CloudMadeProvider.SIZE_64`.

UMap 1.6.8 - API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class CloudMadeXMLProvider	Properties \| Methods \| Constants