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

Closes a marker that is expanded.

Return value: void

Opens or expands the marker to the state it would be in if the user rolled over it.

Return value: void

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

Returns the URL of the image as a string

Return value: string

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

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).

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).

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

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

Return value: void

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

Clear the currently active search

Return value: void

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

addEventListener, removeAllEventListeners, removeEventListener

This event dispatches when the search() method encounters an error.

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

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

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

Add a widget to the map. Possible widget types include NavigatorWidget, ToolBarWidget and SatelliteControlWidget.

Parameters:

• widget - An instance of an Widget object.

Return value: void

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

Returns a string specifying the current Yahoo! Maps application id.

Return value: a string specifying the current Yahoo! Maps application id

Get the LatLonRect object that specifies the current map bounds.

Return value: A LatLonRect object.

Get the latitude and longitude for the center point of the map.

Return value: A LatLon object.

Returns a String specifying the current Map View Type.

Returns the height of the map object.

Returns an array of instantiated tool objects.

Returns the width of the map object.

Returns an array of all valid Map View Types. (“map”, “hybrid”, “satellite”)

Gets zoom level as a number between 1 and 17.

Return value: A number from 1 to 17.

Moves the Map object to the requested position.

Return value: void

Removes all markers from the map.

Return value: void

Removes all overlays from the map.

Return value: void

Removes the specified marker from the map.

Parameters:

• marker - Removes the Marker object specified by tool from the map.

Return value: void

Removes the specified overlay from the map.

Parameters:

• overlay - Removes the Overlay object specified by tool from the map.

Return value: void

Removes the specified tool from the map.

Parameters:

• tool - Removes the Tool object specified by tool from the map.

Return value: void

Removes the specified widget from the map.

Parameters:

• widget - Removes the Widget object specified by tool from the map.

Return value: void

Set the currently active tool.

Parameters:

• tool - A Tool object to set as the active tool.

Return value: void

Sets a new Yahoo! Maps application ID.

Parameters:

• appid - A valid application ID.

Return value: void

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

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

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. The zoom levels ranges from 1 to 17, with 1 being the lowest, or closest, level and 17 being the highest, or farthest, level. If duration is greater than 0, map will pan first and then zoom.

Parameters:

• address - A string that specifies the street address, city, state and zip code on which to center the map.
• zoomLevel - A number from 1 to 17 that specifies the zoom level at which to view the map.
• duration - The number of milliseconds in which to pan (or slide) the map to the specified location. A duration of null or 0 represents no panning and the map moves immediately to the new location.

Return value: void

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

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. If duration is greater than 0, map will pan first and then zoom.

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.
• 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

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 coordinates 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

Changes the Map View between Satellite, Hybrid, and regular Maps.

Parameters:

• mapViewType - A string that specifies type of map that should be shown. The three valid values for this function are stored as variables of the MapViews class. Valid values are MapViews.SATELLITE, MapViews.HYBRID, and MapViews.MAP.

Return value: void

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

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

This event dispatches when the custom SWF marker has been successfully placed and is loaded using the addMarkerByAddress() or addMarkerByLatLon() methods. The event object contains two properties:

• marker - A Marker object which refers to the newly added marker on the map.
• ref - A reference (number) passed when the marker was added. This allows you to identify each custom SWF marker you have added.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Hides this marker on a map.

Return value: void

Returns boolean value that determines whether the object has been created.

Return value: boolean

Returns boolean value that indicates whether the marker is currently visible.

Return value: boolean

Makes the marker visible on the map.

Return value: void

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

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

Return value: void

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

Return value: void

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

Makes the overlay invisible.

Return value: void

Returns boolean value that determines whether the overlay has been created.

Return value: boolean

Returns boolean value that indicates whether the overlay is currently visible.

Return value: boolean

Removes all markers.

Return value: void

ActionScript only:
removeMarker(
marker
)

Removes the Marker object.

Parameters:

• marker - A Marker object

Return value: void

Makes the overlay visible on the map.

Return value: void

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

This event dispatches when the pan tool starts dragging the map.

The url (string) specifies the URL of the XML file containing the LatLon points.

[JavaScript only] - An absolute URL to the .swf file must be used.

Clears the specified overlay

Return value: void

addEventListener, removeAllEventListeners, removeEventListener

hide, isInitialized, isVisible, show

This event dispatches when the plotPoints() method or validateFeed() method encounters an error.

Returns a properly formatted address string representing the suggested address.

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

Return value: boolean

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

Closes the toolbar

Return value: void

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

Return value: void

Updates the index that is displayed on the marker.

Parameters:

• waypointIndex - A string that is the desired index.

Return value: void

Returns the current index for this waypoint.

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

Hide this widget

Return value: void

Returns a boolean telling whether the representative ActionScript object has been created.

Return value: boolean

Returns a boolean telling whether the widget is visible

Return value: boolean

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

Make this widget visible

Return Value: void