| Package | com.yahoo.maps.api.config |
| Class | public class MapConfig |
| Inheritance | MapConfig  flash.events.EventDispatcher |
| Property | Defined by | ||
|---|---|---|---|
| appid : String
The Application ID
| MapConfig | ||
| configLoaded : Boolean [read-only]
Returns true if the configation XML has loaded and parsed.
| MapConfig | ||
| copyrightURL : String [read-only]
The URL to the copyright server.
| MapConfig | ||
| copyrightYear : String [read-only]
The year to display in the copyright widget
| MapConfig | ||
| defaultZoom : Number [read-only]
The default zoom level.
| MapConfig | ||
| hybTileURL : String [read-only]
The URL to the hybrid tile servers.
| MapConfig | ||
| hybVersion : String [read-only]
The current version number of the hybrid tiles.
| MapConfig | ||
| lastUpdateDate : String [read-only]
The UNIX timestamp of the latest update to the map configuration.
| MapConfig | ||
| localeCode : String
The locale code.
| MapConfig | ||
| localSearchURL : String [read-only]
The URL to the Local Search API.
| MapConfig | ||
| mapTileURL : Array [read-only]
The URL to the map tile servers.
| MapConfig | ||
| mapVersion : String [read-only]
The current version number of the map tiles.
| MapConfig | ||
| maxZoom : Number [read-only]
The maximum zoom supported.
| MapConfig | ||
| minZoom : Number [read-only]
The minimum zoom supported.
| MapConfig | ||
| satTileURL : String [read-only]
The URL to the aerial tile servers.
| MapConfig | ||
| satVersion : String [read-only]
The current version number of the aerial tiles.
| MapConfig | ||
| servicesURL : String [read-only]
The URL to the GWS server.
| MapConfig | ||
| tileSize : Number [read-only]
The size of the tiles in px.
| MapConfig | ||
| trackURL : String [read-only]
The URL to the tracking server.
| MapConfig | ||
| yahooLogoURL : String [read-only]
The URL to the Yahoo! logo to display in the copyright widget.
| MapConfig | ||
| zoomRange : Array
An array of supported zoom levels.
| MapConfig | ||
| Method | Defined by | ||
|---|---|---|---|
|
Creates a new MapConfig object.
| MapConfig | ||
|
getConfig():void
Sends a request to retrieve the map configuration.
| MapConfig | ||
|
getInstance(appid:String = null, localeCode:String = "en"):MapConfig
[static]
Returns the sole instance of this singleton class, creating it if it does not already exist.
| MapConfig | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| MapConfig | ||||
| MapConfig | ||||
| Constant | Defined by | ||
|---|---|---|---|
| DEFAULT_ZOOM : int = 13 [static]
The default zoom level of the map.
| MapConfig | ||
| KEY_PIXEL_SHIFT : int = 75 [static]
The amount of pixels to shift on navigation key press.
| MapConfig | ||
| KEY_TIME_SHIFT : int = 350 [static]
The time to run the pixel shift tween
| MapConfig | ||
| TILE_BUFFER : Number = 1.5 [static]
The buffer of tiles to draw around the edges of the map.
| MapConfig | ||
| TILE_SIZE : Number = 256 [static]
The size of the tiles.
| MapConfig | ||
| VERSION : String = "0.9.4" [static]
The version of the API.
| MapConfig | ||
| appid | property |
appid:String [read-write]The Application ID
Implementation public function get appid():String
public function set appid(value:String):void
| configLoaded | property |
configLoaded:Boolean [read-only]Returns true if the configation XML has loaded and parsed.
Implementation public function get configLoaded():Boolean
| copyrightURL | property |
copyrightURL:String [read-only]The URL to the copyright server.
Implementation public function get copyrightURL():String
| copyrightYear | property |
copyrightYear:String [read-only]The year to display in the copyright widget
Implementation public function get copyrightYear():String
| defaultZoom | property |
defaultZoom:Number [read-only]The default zoom level.
Implementation public function get defaultZoom():Number
| hybTileURL | property |
hybTileURL:String [read-only]The URL to the hybrid tile servers.
Implementation public function get hybTileURL():String
| hybVersion | property |
hybVersion:String [read-only]The current version number of the hybrid tiles.
Implementation public function get hybVersion():String
| lastUpdateDate | property |
lastUpdateDate:String [read-only]The UNIX timestamp of the latest update to the map configuration.
Implementation public function get lastUpdateDate():String
| localeCode | property |
localeCode:String [read-write]The locale code.
Implementation public function get localeCode():String
public function set localeCode(value:String):void
| localSearchURL | property |
localSearchURL:String [read-only]The URL to the Local Search API.
Implementation public function get localSearchURL():String
| mapTileURL | property |
mapTileURL:Array [read-only]The URL to the map tile servers.
Implementation public function get mapTileURL():Array
| mapVersion | property |
mapVersion:String [read-only]The current version number of the map tiles.
Implementation public function get mapVersion():String
| maxZoom | property |
maxZoom:Number [read-only]The maximum zoom supported.
Implementation public function get maxZoom():Number
| minZoom | property |
minZoom:Number [read-only]The minimum zoom supported.
Implementation public function get minZoom():Number
| satTileURL | property |
satTileURL:String [read-only]The URL to the aerial tile servers.
Implementation public function get satTileURL():String
| satVersion | property |
satVersion:String [read-only]The current version number of the aerial tiles.
Implementation public function get satVersion():String
| servicesURL | property |
servicesURL:String [read-only]The URL to the GWS server.
Implementation public function get servicesURL():String
| tileSize | property |
tileSize:Number [read-only]The size of the tiles in px.
Implementation public function get tileSize():Number
| trackURL | property |
trackURL:String [read-only]The URL to the tracking server.
Implementation public function get trackURL():String
| yahooLogoURL | property |
yahooLogoURL:String [read-only]The URL to the Yahoo! logo to display in the copyright widget.
Implementation public function get yahooLogoURL():String
| zoomRange | property |
zoomRange:Array [read-write]An array of supported zoom levels.
Implementation public function get zoomRange():Array
public function set zoomRange(value:Array):void
| MapConfig | () | constructor |
public function MapConfig()Creates a new MapConfig object.
| getConfig | () | method |
public function getConfig():voidSends a request to retrieve the map configuration.
| getInstance | () | method |
public static function getInstance(appid:String = null, localeCode:String = "en"):MapConfigReturns the sole instance of this singleton class, creating it if it does not already exist.
Parametersappid:String (default = null) |
|
localeCode:String (default = "en") |
MapConfig |
| configFailure | event |
| configSuccess | event |
| DEFAULT_ZOOM | constant |
public static const DEFAULT_ZOOM:int = 13The default zoom level of the map.
| KEY_PIXEL_SHIFT | constant |
public static const KEY_PIXEL_SHIFT:int = 75The amount of pixels to shift on navigation key press.
| KEY_TIME_SHIFT | constant |
public static const KEY_TIME_SHIFT:int = 350The time to run the pixel shift tween
| TILE_BUFFER | constant |
public static const TILE_BUFFER:Number = 1.5The buffer of tiles to draw around the edges of the map.
| TILE_SIZE | constant |
public static const TILE_SIZE:Number = 256The size of the tiles.
| VERSION | constant |
public static const VERSION:String = "0.9.4"The version of the API.