| Package | com.afcomponents.umap.interfaces |
| Interface | public interface IProvider extends flash.events.IEventDispatcher |
| Implementors | DefaultProvider, MicrosoftProvider, OpenStreetProvider, XMLProvider, YahooProvider |
| Property | Defined by | ||
|---|---|---|---|
| logo : DisplayObject [read-only]
Returns a display object with the provider's logo.
| IProvider | ||
| mapTypes : Array [read-only]
Array which holds map types supported by this Provider.
| IProvider | ||
| Method | Defined by | ||
|---|---|---|---|
|
addMapType(type:IMapType):Boolean
Adds new map type to the map types Array.
| IProvider | ||
|
dispose():void
Frees the resources accuired by the Provider.
| IProvider | ||
|
getDefaultCopyright():String
Returns default copyright string.
| IProvider | ||
|
getMapTypeByName(mapTypeName:String):IMapType
Returns map type reference by it's name.
| IProvider | ||
|
Initializes the provider and starts the loading process.
| IProvider | ||
|
Loads copyrights for the specified center, bounds, zoom and event.
| IProvider | ||
| logo | property |
logo:DisplayObject [read-only]Returns a display object with the provider's logo. Override it for custom logo.
Implementation public function get logo():DisplayObject
| mapTypes | property |
mapTypes:Array [read-only]Array which holds map types supported by this Provider.
Implementation public function get mapTypes():Array
| addMapType | () | method |
public function addMapType(type:IMapType):BooleanAdds new map type to the map types Array.
Parameterstype:IMapType — Valid map type object.
|
Boolean — A value of true if the map type was sucessfully added to the map types array; false if it was not.
|
| dispose | () | method |
public function dispose():voidFrees the resources accuired by the Provider.
| getDefaultCopyright | () | method |
public function getDefaultCopyright():StringReturns default copyright string.
ReturnsString |
| getMapTypeByName | () | method |
public function getMapTypeByName(mapTypeName:String):IMapTypeReturns map type reference by it's name.
ParametersmapTypeName:String — Name of the map type to search.
|
IMapType —
Reference to the found map type; null if it wasn't found.
|
| init | () | method |
public function init(core:UMap):voidInitializes the provider and starts the loading process.
Parameterscore:UMap — Reference to the core object.
|
| loadCopyright | () | method |
public function loadCopyright(center:LatLng, bounds:LatLngBounds, zoom:Number, event:String = ""):void
Loads copyrights for the specified center, bounds, zoom and event.
After the copyright data has been loaded, class should dispatch
ControlEvent.COPYRIGHT_CHANGED event with the new copyright information.
center:LatLng — The coordinates of the map center.
|
|
bounds:LatLngBounds — The bounds of the map view.
|
|
zoom:Number — Current map zoom level.
|
|
event:String (default = " |