Yahoo! Maps Web Services - Flash® APIs Reference Manual

Classes

Class	Description
CustomImageMarker	Lets you add a marker with a custom image to the map surface at a specific position.
CustomPOIMarker	An expandable marker that expands when the user clicks on the marker.
CustomSWFMarker	Lets you load your own custom SWF marker.
CustomSWFOverlay	Loads your own custom SWF overlay routines.
CustomSWFTool	Loads your own custom SWF tool that can be used to manipulate the map.
EventManager	[JavaScript Only] Classes that extend EventManager have the ability to dispatch custom events specified by an event type string.
GeoRSSOverlay	Loads and plots a GeoRSS feed on the map.
LatLon	An X-Y representation of a specific point on the map using latitude and longitude.
LatLonRect	A representation of a distinct rectangle of space on a map using latitude and longitude.
LocalSearchFilter	Each time a successful search is performed when using LocalSearchOverlay, 0 to n filters are returned.
LocalSearchOverlay	Plots the results of text searches on the map using a large database of business descriptions, ratings, and locations.
LocalSearchResults	An object representing a successful search performed using the LocalSearchOverlay
Map	Instantiate a map object
Marker	Instantiate a marker object
NavigatorWidget	Adds a specialized navigation tool to the map.
Overlay	Creates a distinct surface on top of the map that moves along with the map as it pans.
PanTool	The PanTool allows the user to drag the map around for panning.
Point	Lets you create a Point object which can be passed to the Map.setCenterByPointDelta() method.
SuggestedAddress	Returned when a geocode error occurs. Suggested addresses can help narrow down possible values for the address that was originally entered.
Tool	The parent class of various tools (such as the PanTool) that let users interact with the map.
ToolBarWidget	A widget that shows all the tools that have been added to the map by using Map.addTool().
TrafficOverlay	Shows the auto traffic incidents reported for the currently viewable map area.
WaypointMarker	A small black marker that displays a single index.
Widget	A widget represents a distinct object on the top layer of the map that usually displays information or allows users to interact with the map.

Class Details

CustomImageMarker (url)

Lets you to add a custom image to the map surface at a specific position. Currently, images may only be SWF files or non-progressive JPEGs.

Constructor

Parameter	Description
url	The url (string) parameter specifies the URL of the image file to use for the custom marker.

Methods

Method	Description
getURL()	Returns a string that is the URL of the customized marker image. This is the URL that was specified by the constructor. Return value: string

Method

Description

getURL()

Returns a string that is the URL of the customized marker image. This is the URL that was specified by the constructor.

Return value: string

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener
Marker	hide, isInitialized, isVisible, show

CustomPOIMarker (index, title, description, markerColor, strokeColor)

An expandable marker that expands when the user clicks on the marker. When the mouse is not over the marker, only the index is shown. When rolled over, the index and title are shown. Once clicked on, the marker shows the index, title, and description.

Constructor

Parameter	Description
index	The index (string) is the marker's index, or label. It is usually a single character string such as "A" or "B".
title	The title parameter (string) that is a title that appears when you roll the mouse cursor over the marker.
description	The description (string) describes the marker when you click it. This parameter supports Flash textfield HTML formatting (a sub.
markerColor	The markerColor is a hexadecimal number that specifies the marker's body color when the mouse is not over the marker. It also specifies the stroke when the marker expands to display the title or the description.
strokeColor	The strokeColor (string) specifies the hexadecimal number that represents the marker's stroke color (or outline color) when the mouse is over the marker. It becomes the body color when you roll the mouse over the marker to display the title or click the marker to display the description.

Methods

Method	Description
close()	Closes a marker that is expanded. Return value: void
open()	Opens or expands the marker to the state it would be in if the user clicked on it. Return value: void

Method

Description

close()

Closes a marker that is expanded.

Return value: void

open()

Opens or expands the marker to the state it would be in if the user clicked on it.

Return value: void

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllListeners, removeEventListener
Marker	hide, isInitialized, isVisible, show

Properties

Property	Description
strokeColor	Specifies the hexadecimal number that represents the marker's stroke (or outline) color.

CustomSWFMarker (url)

The CustomSWFMarker class allows you to load a marker SWF that conforms to a specific interface. By implementing specific methods in the SWF, you can interact on a much richer level with the marker.

Constructor

Parameter	Description
url	The url (string) location of the SWF file.

Methods

Method	Description
callCustomMethod (methodNames, methodArgs )	Call a custom method on the SWF. If the user has implemented a custom method outside the specific interface, you can access that method by calling this. Parameters: methodNames- string, the name of the custom method. methodArgs - array, an array of arguments to be passed to the custom method . Return value: void
getURL()	Returns the URL of the image as a string Return value: string

Method

Description

callCustomMethod
(methodNames, methodArgs )

Call a custom method on the SWF. If the user has implemented a custom method outside the specific interface, you can access that method by calling this.

Parameters:

methodNames- string, the name of the custom method.
methodArgs - array, an array of arguments to be passed to the custom method .

Return value: void

getURL()

Returns the URL of the image as a string

Return value: string

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener
Marker	hide, isInitialized, isVisible, show

CustomSWFOverlay (url)

Similar to CustomSWFMarker, a custom overlay SWF component can be loaded by creating a new CustomSWFOverlay.

Constructor

Parameter	Description
url	The url (string) specifies the URL of the SWF file containing the custom overlay.

Methods

Method	Description
callCustomMethod (methodNames, methodArgs )	Call a custom method on the SWF. If the user has implemented a custom method outside the specific interface, you can access that method by calling this. Parameters: methodNames- string, the name of the method to call. methodArgs - array, contains the arguments to pass to the custom method. Return value: void
isLoaded()	Checks whether a custom SWF overlay has finished loading. Return value: A Boolean value stating whether an overlay has finished loading (true) or not (false).

Method

Description

callCustomMethod
(methodNames, methodArgs )

Call a custom method on the SWF. If the user has implemented a custom method outside the specific interface, you can access that method by calling this.

Parameters:

methodNames- string, the name of the method to call.
methodArgs - array, contains the arguments to pass to the custom method.

Return value: void

isLoaded()

Checks whether a custom SWF overlay has finished loading.

Return value: A Boolean value stating whether an overlay has finished loading (true) or not (false).

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListeners
Marker	hide, isInitialized, isVisible, show

CustomSWFTool (url, iconUrl)

A CustomSWFTool represents a SWF file that contains the proper methods for creating custom interactions with the map.

Constructor

Parameter	Description
url	The url (string) of the SWF that contains the tool methods.
iconUrl	The iconUrl (string) specifies the URL of the image file or SWF file containing the icon that will appear in the toolbar widget.

Methods

Method	Description
isLoaded()	Checks whether a custom SWF tool has finished loading. Return value: A Boolean value stating whether a tool has finished loading (true) or not (false).

Method

Description

isLoaded()

Checks whether a custom SWF tool has finished loading.

Return value: A Boolean value stating whether a tool has finished loading (true) or not (false).

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListeners
Tool	isInitialized

Properties

Property	Description
EVENT_LOADED	Static property that contains the name of the loaded event

EventManager ()

Lets you listen for specified events.

Methods

Method	Description
addEventListener (eventType, functionName, scope )	Listen for an event of eventType and call the specified function in the specified scope. Parameters: eventType - string, the event type you want to listen for functionName - string, the function to be called when the event occurs . scope [JavaScript only] - An object that specifies the scope in which to call the listener function. Return value: void
JavaScript only: removeAllEventListeners()	Remove all event listeners for this object that have been subscribed by using addEventListener(). Return value: void
removeEventListener (eventType, functionName, scope )	Removes the specified event listener for this object that have been subscribed by using addEventListener(). Parameters: eventType - string, the event type which is being listened for functionName - string, the listener function scope [JavaScript only] - object, the scope the listener function is to be called in Return value: void

Method

Description

addEventListener
(eventType, functionName, scope )

Listen for an event of eventType and call the specified function in the specified scope.

Parameters:

eventType - string, the event type you want to listen for
functionName - string, the function to be called when the event occurs .
scope [JavaScript only] - An object that specifies the scope in which to call the listener function.

Return value: void

JavaScript only:
removeAllEventListeners()

Remove all event listeners for this object that have been subscribed by using addEventListener().

Return value: void

removeEventListener
(eventType, functionName, scope )

Removes the specified event listener for this object that have been subscribed by using addEventListener().

Parameters:

eventType - string, the event type which is being listened for
functionName - string, the listener function
scope [JavaScript only] - object, the scope the listener function is to be called in

Return value: void

GeoRSSOverlay (url)

The GeoRSSOverlay class allows you to load a document and plot a feed of GeoRSS items on the map.

Constructor

Parameter	Description
url	The url (string) specifies the URL of the RSS feed to load

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListeners
Overlay	hide, isInitialized, isVisible, show

LatLon (latitude, longitude)

Represents a point on the map through the intersection of latitude and longitude coordinates.

Constructor

Parameter	Description
latitude	The latitude (float) that represents a measure of latitude, or location north or south of the equator.
longitude	The longitude (float) that represents a measure of longitude, or location east or west of the prime meridian.

Properties

Parameter	Description
lat	A floating-point number that represents a measure of latitude, or location north or south of the equator.
lon	A floating-point number that represents a measure of longitude, or location east or west of the prime meridian.

LatLonRect (minLat, minLon, maxLat, maxLon)

A distinct rectangle of space on a map defined by two sets of latitude and longitude coordinates.

Constructor

Parameter	Description
minLat	A floating-point number that represents the measure of latitude on the map for the rectangle's starting point, or upper left-hand corner
minLon	A floating-point number that represents the measure of longitude on the map for the rectangle's starting point, or upper left-hand corner.
maxLat	A floating-point number that represents the measure of latitude on the map for the rectangle's ending point, or lower right-hand corner.
maxLon	A floating-point number that represents the measure of longitude on the map for the rectangle's ending point, or lower right-hand corner.

Properties

Property	Description
minLat	A floating-point number that represents the measure of latitude on the map for the rectangle’s starting point, or upper left-hand corner.
minLon	A floating-point number that represents the measure of longitude on the map for the rectangle’s starting point, or upper left-hand corner.
maxLat	A floating-point number that represents the measure of latitude on the map for the rectangle’s ending point, or lower right-hand corner.
maxLon	A floating-point number that represents the measure of longitude on the map for the rectangle’s ending point, or lower right-hand corner.

LocalSearchFilter()

Each time a successful search is performed when using the LocalSearchOverlay class, 0 to n filters are returned. Each filter represents a possible refinement of the search results. By using the key attribute of the filter, the same search terms will return refined results as described by the name attribute.

Properties

Property	Description
count	The number of results, out of the total search results returned, that comply with this filter.
key	A string that specifies the key that needs to be passed back to LocalSearchOverlay.search() method to retrieve the refined results.
name	A string that provides a readable description of the filter.
type	A string that specifies the filter type, of which there are two, represented by LocalSearchFilter.TYPE_RATING and LocalSearchFilter.TYPE_CATEGORY. Rating filters allow the user to refine the search by the rating of the search results usually from one to five stars. Category filters filter by a specific category of results. For example, a search for food might return category filters with names such as "grocery", "fast food", "cafes", etc.
TYPE_CATEGORY	Possible value for the LocalSearchFilter.type property. If the type property is equal to the LocalSearchFilter.TYPE_CATEGORY constant, the search() method of the LocalSearchOverlay class can use the key attribute as its categoryFilter parameter.
TYPE_RATING	Possible value for the LocalSearchFilter.type property. If the type property is equal to the LocalSearchFilter.TYPE_RATING constant, the search() method of the LocalSearchOverlay class can use the key attribute as its ratingFilter parameter.

LocalSearchOverlay ()

The LocalSearchOverlay class allows developers to access the large database of business descriptions, ratings, and locations and plot them on a map.

Methods

Method	Description
clear()	Clear the currently active search Return value: void
search ( searchTerms, latlon, startIndex, results, radius, categoryFilter, ratingFilter )	Search for businesses using the specified criteria. Parameters: searchTerms - A string. The search terms used to search for businesses latLon - The latitude and longitude of a point on the map you would like base this search on startIndex - A number The index of the first result out of the total search results available that you would like to retrieve results - A number. The number of results that you would like to retrieve radius - A number. The radius in miles that you would like apply to search results. If null, the radius of the current viewable map is used. categoryFilter - A string. The category filter key used to filter search results ratingFilter - A string. The rating filter key used to filter search results Return value: void

Method

Description

clear()

Clear the currently active search

Return value: void

search (
searchTerms, latlon, startIndex, results, radius, categoryFilter, ratingFilter )

Search for businesses using the specified criteria.

Parameters:

searchTerms - A string. The search terms used to search for businesses
latLon - The latitude and longitude of a point on the map you would like base this search on
startIndex - A number The index of the first result out of the total search results available that you would like to retrieve
results - A number. The number of results that you would like to retrieve
radius - A number. The radius in miles that you would like apply to search results. If null, the radius of the current viewable map is used.
categoryFilter - A string. The category filter key used to filter search results
ratingFilter - A string. The rating filter key used to filter search results

Return value: void

Properities

Property	Description
EVENT_SEARCH_ERROR	Static property that contains the name of the searchError event
EVENT_SEARCH_SUCCESS	Static property that contains the name of the searchSuccess event
localSearchResults	A LocalSearchResults object. An instance of LocalSearchResults that contains information about the currently active search.

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener
Overlay	hide, isInitialized, isVisible, show

Event Summary

Event	Description
searchError	This event dispatches when the search() method encounters an error.
searchSuccess	This event dispatches when the search() method completes successfully.

LocalSearchResults ()

An object representing a successful search performed using the LocalSearchOverlay

Properties

Property	Description
resultsCount	The number of results returned by this search.
searchFilters	An array of LocalSearchFilter objects that represent possible filters that could be applied to this search.
totalResultsCount	The total number of possible results that could be returned applying the current search criteria.

Map (container, appid, location, zoom)

An object that defines a map.

Constructor

Parameter	Description
container	The ID of the map in the HTML page, Flash document, or Flex document. For HTML, this is the usually the CSS "id" name of the tag containing the map.
appid	Your Yahoo! application ID. If you don't have one, get one here.
location	A LatLon object or string (address) that specifies the map’s initial position. If the string cannot be converted to a LatLon object, an EVENT_MAP_GEOCODE_ERROR event will be dispatched.
zoom	The zoom level of the map -- a number between 1 and 17. The default zoom level is 14.

Methods

Method	Description
JavaScript: addMarkerByAddress(marker, address) ActionScript: addMarkerByAddress(markerClass, address, data)	Add a marker at the specified address. If the map is unable to geocode the given address, an EVENT_MARKER_GEOCODE_ERROR event will be thrown with possible address suggestions. If successful, an EVENT_MARKER_GEOCODE_SUCCESS event will be thrown. Parameters: marker - An instance of the marker to be added. address - A string that specifies the postal address at which to place the marker on the map. markerClass- A function that specifies the type of marker to place on the Map. This could be a reference to the CustomImageMarker class, CustomPOIMarker class, CustomSWFMarker class, or a WaypointMarker class. data - [ActionScript only] An object which contains the parameters to pass to the markerClass’s constructor function. Return value: void
JavaScript: addMarkerByLatLon(marker, latlon) ActionScript: addMarkerByLatLon(markerClass, latlon, data)	Add a marker at the location specified by the latlon parameter. Parameters: marker - An instance of the marker to be added. latlon - A LatLon object that specifies the latitude and longitude coordinates on the map at which to place the marker. markerClass - A function that specifies the type of marker to place on the Map. This could be a reference to the CustomImageMarker class, CustomPOIMarker class, CustomSWFMarker class, WaypointMarker class, or a custom class. data - [ActionScript only] An object which contains the parameters to pass to the markerClass’s constructor function. Return value: void
addOverlay(overlay)	Add an overlay to the map. Overlays are images that are laid over the map to show driving directions, traffic conditions and so on. Parameters: overlay - An instance of an Overlay object: CustomSWFOverlay, GeoRSSOverlay, LocalSearchOverlay, or Traffic Overlay Return value: void
addTool(tool, isActive)	Add a tool to the map. Parameters: tool - An instance of an Tool object. isActive - A Boolean value stating whether the current tool is active. Return value: void
addWidget(widget)	Add a widget to the map. Possible widget types include NavigatorWidget and ToolBarWidget. Parameters: widget - An instance of an Widget object. Return value: void
enableKeyboardShortcuts(enabled)	Enables or disables the ability to use the keyboard to pan and zoom the map. Supported keyboard shortcuts are: Left Arrow key - Pan the map west. Right Arrow key - Pan the map east. Up Arrow key - Pan the map north. Down Arrow key - Pan the map south. Page Up - Zoom the map in. Page Down - Zoom the map out. Parameters: enabled - A Boolean value that specifies whether the keyboard can be used to pan and zoom the map. Passing a value of false disables keyboard navigation. Return value: void
ActionScript only: getActiveTool()	Returns the currently active tool. Return value: a Tool object
getAppID()	Returns a string specifying the current Yahoo! Maps application id. Return value: a string specifying the current Yahoo! Maps application id
getBounds()	Get the LatLonRect object that specifies the current map bounds. Return value: A LatLonRect object.
getCenter()	Get the latitude and longitude for the center point of the map. Return value: A LatLon object.
ActionScript only: getHeight()	Returns the height of the map object.
getTools()	Returns an array of instantiated tool objects.
ActionScript only: getWidth()	Returns the width of the map object.
getZoomLevel()	Gets zoom level as a number between 1 and 17. Return value: A number from 1 to 17.
ActionScript only: move()	Moves the Map object to the requested position. Return value: void
removeAllMarkers()	Removes all markers from the map. Return value: void
JavaScript only: removeAllOverlays()	Removes all overlays from the map. Return value: void
removeMarker(marker)	Removes the specified marker from the map. Parameters: marker - Removes the Marker object specified by tool from the map. Return value: void
removeOverlay(overlay)	Removes the specified overlay from the map. Parameters: overlay - Removes the Overlay object specified by tool from the map. Return value: void
removeTool(tool)	Removes the specified tool from the map. Parameters: tool - Removes the Tool object specified by tool from the map. Return value: void
removeWidget(widget)	Removes the specified widget from the map. Parameters: widget - Removes the Widget object specified by tool from the map. Return value: void
ActionScript only: setActiveTool(tool)	Set the currently active tool. Parameters: tool - A Tool object to set as the active tool. Return value: void
JavaScript only: setAppID(appid)	Sets a new Yahoo! Maps application ID. Parameters: appid - A valid application ID. Return value: void
setBounds(bounds)	Sets the map to the center of a rectangle specified by a LatLonRect object. Parameters: bounds - A LatLonRect object that specifies the desired bounds for the viewable map surface. Return value: void
setCenterByAddress(address, duration)	Set the center position of the map to the specified address. If duration is greater than 0, the map will pan for the specified number of milliseconds. If the application is unable to geocode the address, it dispatches an EVENT_MAP_GEOCODE_ERROR event that contains an array of suggested addresses. If the geocode is successful, the map pans to that position and dispatches an EVENT_MAP_GEOCODE_SUCCESS event. Parameters: address - A string that specifies the street address, city, state and zip code on which to center the map. duration - The number of milliseconds in which to pan (or slide) the map to the specified location. A duration of 0 represents no panning and the map moves immediately to the new location. Return value: void
setCenterByLatLon(latlon, duration)	Center the map on the coordinates of latitude and longitude specified by latlon. If duration is greater than 0, the map pans (or slides to the new location) for the specified number of milliseconds. Parameters: latlon - A LatLon object that specifies the desired latitude and longitude values. duration - The number of milliseconds in which to pan (or slide) the map to the specified location. A duration of 0 represents no panning and the map moves immediately to the new location. Return value: void
setCenterByLatLonAndZoom(latlon, zoomLevel)	Center the map on the coordinates of latitude and longitude specified by latlon. The zoom levels ranges from 1 to 17, with 1 being the lowest, or closest, level and 17 being the highest, or farthest, level. Parameters: latlon - A LatLon object that specifies the desired latitude and longitude values. zoomLevel - A number from 1 to 17 that specifies the zoom level at which to view the map. Return value: void
setCenterByPointDelta( point, duration )	Set the center point of the map based on a relative number of pixels from its current location. For example, calling the setCenterByPointDelta() method and passing a Point object of (5,5) moves the map’s current coordinates left 5 pixels and up 5 pixels. Passing negative values for x and y coodinates cause the map to pan right and down. Parameters: point - A Point object duration - The number of milliseconds in which to pan (or slide) the map to the specified location. A duration of 0 represents no panning and the map moves immediately to the new location. Return value: void
ActionScript only: setSize(width, height)	Resizes the Map object to the requested size. Parameters: width - A number that indicates the width of the Map object, in pixels. height - A number that indicates the height of the Map object, in pixels. Return value: void
setZoomLevel(zoomLevel)	Sets the zoom level for viewing the map. Parameters: zoomLevel - A number from 1 to 17 that specifies the zoom level at which to view the map. Return value: void

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Properties

Property	Description
EVENT_INITIALIZE	Static property that contains the name of the initialize event.
EVENT_MAP_GEOCODE_ERROR	Static property that contains the name of the mapGeocodeError event.
EVENT_MAP_GEOCODE_SUCCESS	Static property that contains the name of the mapGeocodeSuccess event.
EVENT_MARKER_GEOCODE_ERROR	Static property that contains the name of the markerGeocodeError event.
EVENT_MARKER_GEOCODE_SUCCESS	Static property that contains the name of the markerGeocodeSuccess event.
EVENT_MOVE	Static property that contains the name of the move event.
EVENT_PAN_START	Static property that contains the name of the panStart event.
EVENT_PAN_STOP	Static property that contains the name of the panStop event.
EVENT_TOOL_ADDED	Static property that containsthat contains the name of the toolAdded event.
EVENT_TOOL_CHANGE	Static property that contains the name of the toolChange event.
EVENT_TOOL_REMOVED	Static property that contains the name of the toolRemoved event.
EVENT_ZOOM	Static property that contains the name of the zoom event.
EVENT_ZOOM_STOP	Static property that contains the name of the zoomStop event. (Deprecated alias is property EVENT_ZOOM_END and zoomEnd event)
EVENT_ZOOM_START	Static property that contains the name of the zoomStart event

Event Summary

Event	Description
initialize	This event dispatches after the Flash SWF file that contains the map engine has loaded and is ready for interaction. The event object contains three properties: center - A LatLon object which contains the center coordinates of the map. bounds - A LatLonRect object which contains a distinct rectangle of space on a map defined by two sets of latitude and longitude coordinates. zoomLevel - A number which contains the current zoom level the of the map.
mapGeocodeError	This event dispatches when a geocoding error occurs when you call the setCenterByAddress() method. The event object contains two properties: originalAddress - A string representing the originally specified address. suggestedAddresses - An array of SuggestedAddress objects that geocoding service has determined as possible alternatives to the entered address.
markerGeocodeError	This event dispatches when there has been a geocoding error when calling the addMarkerByAddress() method. The event object contains three properties: hash [ActionScript only] - A string which contains a unique hash returned by the Map.addMarkerByAddress() method. originalAddress - A string representing the originally specified address. suggestedAddresses - An array of SuggestedAddress objects that geocoding service has determined as possible alternatives to the entered address.
markerGeocodeSuccess	This event dispatches when the marker has been successfully placed using the addMarkerByAddress() method. The event object contains two properties: hash [ActionScript only] - A string which contains a unique hash returned by the Map.addMarkerByAddress() method. marker - A Marker object which refers to the newly added marker on the map.
move	This event dispatches whenever the map changes its latitude or longitude. The event object contains two properties: center - A LatLon object which contains the center coordinates of the map. bounds - A LatLonRect object which contains a distinct rectangle of space on a map defined by two sets of latitude and longitude coordinates.
panStart	This event dispatches whenever the map starts to pan. Panning is initiated whenever the duration is set to be greater than 0 in the Map.setCenterByAddress(), Map.setCenterByLatLon(), or Map.setCenterByPointDelta() methods.
panStop	This event dispatches when panning has stopped.
toolAdded	This event dispatches when new tool has been added to the map. The event object contains a single property: tool - A reference to the tool that was added to the map.
toolChange	This event dispatches when the currently active tool has changed. The event object contains a single property: tool - A reference to the tool that is currently active.
toolRemoved	This event dispatches when a tool has been removed from the map. The event object contains a single property: tool - A reference to the tool that was removed from the map.
zoom	This event dispatches during when the map zooms. This event is thrown multiple times when the map zooms. The event object contains three properties: currentZoomLevel - This is the current zoom level the map is scaled to. startZoomLevel - The initial zoom level of the map before zooming started. endZoomLevel - The target zoom level the map is scaling to.
zoomEnd	This event dispatches when the map has zoomed to the target zoom level. The event object contains two properties: startZoomLevel - The initial zoom level of the map before zooming started. endZoomLevel - The target zoom level the map is scaling to.
zoomStart	This event dispatches when zooming starts. The event object contains two properties: startZoomLevel - The initial zoom level of the map before zooming started. endZoomLevel - The target zoom level the map is scaling to.

Marker ()

The Marker class allows you to define map markers and toggle the visibility of markers on a map. There are several types of markers supported including: image markers ( CustomImageMarker class ), point of interest markers ( CustomPOIMarker class), SWF markers ( CustomSWFMarker class), and waypoint markers ( WaypointMarker class ).

Methods

Method	Description
hide()	Hides this marker on a map. Return value: void
isInitialized()	Returns boolean value that determines whether the object has been created. Return value: boolean
isVisible()	Returns boolean value that indicates whether the marker is currently visible. Return value: boolean
show()	Makes the marker visible on the map. Return value: void

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Properties

Property	Description
EVENT_INITIALIZE	Static property that contains the name of the initialize event.

Event Summary

Event	Description
initialize	This event dispatches when the representative Marker object has been created.

NavigatorWidget ()

The NavigatorWidget class lets users zoom and pan the map based on a small mini-map that appears on the map surface. NavigatorWidget instances can be added to the map using Map.addWidget()

Methods

Method	Description
close()	Close the navigator widget so that only the zoom-bar appears. Return value: void
open()	Open the navigator widget so that the mini-map appears. Return value: void

Method

Description

close()

Close the navigator widget so that only the zoom-bar appears.

Return value: void

open()

Open the navigator widget so that the mini-map appears.

Return value: void

Inherited Methods

Class	Inherited Methods
Widget	hide , isInitialized , isVisible , show
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Overlay ()

The Overlay class represents a distinct surface on top of the map that moves along with the map as it pans. An overlay is like a transparent layer that can contain information, such as local businesses or traffic conditions.

Methods

Method	Description
ActionScript only: addMarkerByAddress( markerClass, address, data )	Adds a Marker object at the requested address. Parameters: markerClass- A function that specifies the type of marker to place on the Map. This could be a reference to the CustomImageMarker class, CustomPOIMarker class, CustomSWFMarker class, or WaypointMarker class address - A string that specifies the postal address at which to place the marker on the map. data - An object which contains the parameters to pass to the markerClass’s constructor function. Return value: a string representing the hash of the current marker.
ActionScript only: addMarkerByLatLon( markerClass, latlon, data )	Adds a Marker object at the requested latitude/longitude. Parameters: markerClass- A function that specifies the type of marker to place on the Map. This could be a reference to the CustomImageMarker class, CustomPOIMarker class, CustomSWFMarker class, or WaypointMarker class. • latlon - A LatLon object that specifies the latitude and longitude coordinates on the map at which to place the marker. latlon - A LatLon object that specifies the latitude and longitude coordinates on the map at which to place the marker. data - An object which contains the parameters to pass to the markerClass’s constructor function Return value: a string
hide()	Makes the overlay invisible. Return value: void
isInitialized()	Returns boolean value that determines whether the overlay has been created. Return value: boolean
isVisible()	Returns boolean value that indicates whether the overlay is currently visible. Return value: boolean
ActionScript only: removeAllMarkers()	Removes all markers. Return value: void
ActionScript only: removeMarker( marker )	Removes the Marker object. Parameters: marker - A Marker object Return value: void
show()	Makes the overlay visible on the map. Return value: void

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Properties

Property	Description
EVENT_INITIALIZE	A static property with the value "initialize".

Event Summary

Event	Description
initialize	The event dispatches when the representative Overlay object has been created.

PanTool ()

The PanTool allows the user to drag the map around for panning. It also allows the user to double click on a position on the map and pan to that location.

Inherited Methods

Class	Inherited Methods
Tool	isInitialized
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Properties

Property	Description
EVENT_DRAG_STOP	A static property with the value “dragStop”
EVENT_DRAG_START	A static property containing the name of the dragStart event.

Event Summary

Event	Description
dragStart	This event dispatches when the pan tool starts dragging the map.
dragStop	This event dispatches when the pan tool stops dragging the map.

Point (x, y)

Lets you create a Point object which can be passed to the Map.setCenterByPointDelta() method.

Constructor

Parameter	Description
x	The number of pixels to move the map horizontally. Passing a negative number for x causes the map to pan to the right.
y	The number of pixels to move the map vertically. Passing a negative number for y causes the map to pan down.

Properties

Property	Description
x	The number of pixels to move the map horizontally.
y	The number of pixels to move the map vertically.

SuggestedAddress ()

Returned when a geocode error has happened, suggested addresses can help narrow down possible values for the address that was originally entered.

Methods

Method	Description
toString()	Returns a properly formatted address string representing the suggested address.

Properties

Property	Description
city	The city for the suggested address
country	The country for the suggested address
latlon	The latitude and longitude for the suggested address.
state	The state for the suggested address.
street	The street address for the suggested address.
zip	The zip for the suggested address.
zoomLevel	The zoom level for the suggested address.

Tool ()

Tools allow the user to use the mouse to interact with the map. For example, the PanTool allows the user to pan the map by clicking and dragging the map.

Methods

Method

Description

isInitialized()

A Boolean value stating whether the representative ActionScript object been created.

Return value: boolean

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Properties

Property	Description
EVENT_INITIALIZE	A static property containing the name of the initialize event

Event Summary

Event	Description
initialize	This event dispatches when the representative Tool object has been created.

ToolBarWidget()

A widget that shows all the tools that have been added to the map by using Map.addTool() . It also allows users to select a tool and have that tool be set as the currently active tool.

Methods

Method

Description

close()

Closes the toolbar

Return value: void

open()

Opens the widget so that the user can see all the possible tools.

Return value: void

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener
Widget	hide, isInitialized, isVisible, show

TrafficOverlay()

Shows the traffic incedents reported for the currently viewable map area. This overlay is updated automatically whenever the map moves.

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener
Overlay	hide, isInitialized, isVisible, show

WaypointMarker(waypointIndex)

A small black marker that displays a single index. Can be used for plotting distinct points on a map that need no description.

Constructor

Parameter	Description
waypointIndex	String that represents the current index for this waypoint.

Methods

Method

Description

setWaypointIndex(waypointIndex)

Updates the index that is displayed on the marker.

Parameters:

waypointIndex - A string that is the desired index.

Return value: void

getWaypointIndex()

Returns the current index for this waypoint.

Return value: a string that represents the current index for this waypoint

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener
Marker	hide, isInitialized , isVisible, show

Widget()

A widget represents a distinct object on the top layer of the map that usually displays information or allows users to interact with the map.

Methods

Method	Description
hide()	Hide this widget Return value: void
isInitialized()	Returns a boolean telling whether the representative ActionScript object has been created. Return value: boolean
isVisible()	Returns a boolean telling whether the widget is visible Return value: boolean
ActionScript only: move(x,y)	Moves the Widget object's location to the (x,y) coordinate location . Parameters: x - A number representing the x-coordinate. y - A number representing the y-coordinate. Return value: void
show()	Make this widget visible Return Value: void

Inherited Methods

Class	Inherited Methods
EventManager	addEventListener, removeAllEventListeners, removeEventListener

Properties

Property	Description
EVENT_INITIALIZE	A static property containing the name of the initialize event.

Attribution

For all web sites and applications that present data from the Yahoo! Maps Beta APIs, you must make attribution. Either copy one of our image banners or present the attribution text "Web Services by Yahoo!" with your web site or application.

Rate Limit

The Yahoo! Flash Maps APIs are limited to 50,000 queries per IP per day and to non-commercial use. See information on rate limiting.

Yahoo! Maps Web Services - Flash® APIs Reference Manual

Version 2 - BetaReference Manual for the Yahoo! Maps Flash APIs

Classes

Class Details

CustomImageMarker (url)

Inheritance: EventManager > Marker > CustomImageMarker

ActionScript package name: com.yahoo.maps.markers.CustomImageMarker

Constructor

Methods

Inherited Methods

CustomPOIMarker (index, title, description, markerColor, strokeColor)

Inheritance: EventManager > Marker > CustomPOIMarker

ActionScript package name: com.yahoo.maps.markers.CustomPOIMarker

Constructor

Methods

Inherited Methods

Properties

CustomSWFMarker (url)

Inheritance: EventManager > Marker > CustomSWFMarker

ActionScript package name: com.yahoo.maps.markers.CustomSWFMarker

Constructor

Methods

Inherited Methods

CustomSWFOverlay (url)

Inheritance: EventManager > Overlay > CustomSWFOverlay

ActionScript package name: com.yahoo.maps.overlays.CustomSWFOverlay

Constructor

Methods

Inherited Methods

CustomSWFTool (url, iconUrl)

Inheritance: EventManager > Tool > CustomSWFTool

ActionScript package name: com.yahoo.maps.tools.CustomSWFTool

Constructor

Methods

Inherited Methods

Properties

EventManager ()

NOTE: This class is JavaScript only. For ActionScript, the event management methods are built into each class.

Inheritance: EventManager

Methods

GeoRSSOverlay (url)

Inheritance: EventManager > Overlay > GeoRSSOverlay

ActionScript package name: com.yahoo.maps.overlays.GeoRSSOverlay

Constructor

Inherited Methods

LatLon (latitude, longitude)

Inheritance: LatLon

ActionScript package name: com.yahoo.maps.LatLon

Constructor

Properties

LatLonRect (minLat, minLon, maxLat, maxLon)

Inheritance: LatLongRect

ActionScript package name: com.yahoo.maps.LatLonRect

Constructor

Properties

LocalSearchFilter()

Inheritance: LocalSearchFilter

ActionScript package name: com.yahoo.maps.overlays.data.LocalSearchFilter

Properties

LocalSearchOverlay ()

Inheritance: EventManager > Overlay > LocalSearchOverlay

ActionScript package name: com.yahoo.maps.overlays.LocalSearchOverlay

Methods

Properities

Inherited Methods

Event Summary

LocalSearchResults ()

Inheritance: LocalSearchResults

ActionScript package name: com.yahoo.maps.overlays.data.LocalSearchResults

Properties

Map (container, appid, location, zoom)

Inheritance: EventManager > Map

ActionScript package name: com.yahoo.maps.api.flash.YahooMap

Flex package name: com.yahoo.maps.api.flex.YahooMap

Constructor

Methods

Inherited Methods

Properties

Event Summary

Marker ()