jsdoc

$.ui.simplicityGoogleMapBoundsCoordinator

Namespace $.ui.simplicityGoogleMapBoundsCoordinator

A Google map.

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

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityGoogleMapBoundsCoordinator.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityGoogleMapBoundsCoordinator.map()
Return the actual map object.
<static>  
$.ui.simplicityGoogleMapBoundsCoordinator.updateBounds()
Triggers a simplicitygooglemapboundscoordinatorcalculatebounds event.
Namespace Detail
$.ui.simplicityGoogleMapBoundsCoordinator
  <div id="map" style="width: 300px; height: 300px;"></div>
  <script type="text/javascript">
    $('#map').simplicityGoogleMapBoundsCoordinator();
  </script>
See:
Google Maps JavaScript API V3 documentation.
Field Detail
<static> $.ui.simplicityGoogleMapBoundsCoordinator.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.simplicityGoogleMapBoundsCoordinator.map()
Return the actual map object.

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

Documentation generated by JsDoc Toolkit 2.4.0