jsdoc

$.ui.simplicityBingMapBoundsCoordinator

Namespace $.ui.simplicityBingMapBoundsCoordinator

A Bing map.

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

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityBingMapBoundsCoordinator.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityBingMapBoundsCoordinator.map()
Return the actual map object.
<static>  
$.ui.simplicityBingMapBoundsCoordinator.updateBounds()
Triggers a simplicitybingmapboundscoordinatorcalculatebounds event.
Namespace Detail
$.ui.simplicityBingMapBoundsCoordinator
  <div id="map" style="position: absolute; width: 300px; height: 300px;"></div>
  <script type="text/javascript">
    $('#map').simplicityBingMapBoundsCoordinator({
      credentials: 'Your credentials go here'
    });
  </script>
See:
Bing Maps AJAX Control v7 documentation.
Field Detail
<static> $.ui.simplicityBingMapBoundsCoordinator.options
Widget options.
map
Optional map instance, if not provided one will be looked up. Defaults to ''.
searchElement
The simplicityDiscoverySearch widget that this widget binds it's events to. Defaults to 'body'.
Method Detail
<static> $.ui.simplicityBingMapBoundsCoordinator.map()
Return the actual map object.

<static> $.ui.simplicityBingMapBoundsCoordinator.updateBounds()
Triggers a simplicitybingmapboundscoordinatorcalculatebounds 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 bing map to fit the locations.

Documentation generated by JsDoc Toolkit 2.4.0