jsdoc

$.ui.simplicityYahooMapBoundsCoordinator

Namespace $.ui.simplicityYahooMapBoundsCoordinator

A Yahoo! map.

An invisible jquery ui widget which coordinates the updating of a Yahoo Map's bounds after a discovery search response is parsed and dispatched (the simplicitySearchResponseHandled event from the simplicityDiscoverySearch widget. Triggers a simplicityyahoomapboundscoordinatorcalculatebounds event which other components can use to modify the map bounds.
Defined in: ui.simplicityYahooMapBoundsCoordinator.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityYahooMapBoundsCoordinator.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityYahooMapBoundsCoordinator.map()
Return the actual map object.
<static>  
$.ui.simplicityYahooMapBoundsCoordinator.updateBounds()
Triggers a simplicityyahoomapboundscoordinatorcalculatebounds event.
Namespace Detail
$.ui.simplicityYahooMapBoundsCoordinator
  <div id="map" style="width: 300px; height: 300px;"></div>
  <script type="text/javascript">
    $('#map').simplicityYahooMap();
  </script>
See:
Yahoo! Maps Web Services - AJAX API documentation.
Field Detail
<static> $.ui.simplicityYahooMapBoundsCoordinator.options
Widget options.
searchElement
The simplicityDiscoverySearch widget that this widget binds it's events to. Defaults to 'body'.
map
Optional map instance, if not provided one will be created. Defaults to ''.
Method Detail
<static> $.ui.simplicityYahooMapBoundsCoordinator.map()
Return the actual map object.

<static> $.ui.simplicityYahooMapBoundsCoordinator.updateBounds()
Triggers a simplicityyahoomapboundscoordinatorcalculatebounds event. Handlers for that event receive a ui object with a locations member. They can update, replace or delete that variable. ui.locations is defined and non-empty after the event is handled, then this component will update the Yahoo map to fit the locations.

Documentation generated by JsDoc Toolkit 2.4.0