jsdoc

$.ui.simplicityGoogleMapBoundsTracker

Namespace $.ui.simplicityGoogleMapBoundsTracker

A Google map.

An invisible jquery ui widget which tracks changes in a Google Map's bounds. Whenever the map bound change, a simplicitygooglemapboundstrackerbounds event is triggered with ui.bounds being the normalized map bounds.
Defined in: ui.simplicityGoogleMapBoundsTracker.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityGoogleMapBoundsTracker.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityGoogleMapBoundsTracker.bounds()
Returns the normalized bounds for this map.
<private> <static>  
$.ui.simplicityGoogleMapBoundsTracker.hideBounds()
Removes the bounds from the map.
<static>  
$.ui.simplicityGoogleMapBoundsTracker.map()
Return the actual map object.
<private> <static>  
$.ui.simplicityGoogleMapBoundsTracker.normalizeBounds(bounds, center)
Normalizes the bounds for this map.
<private> <static>  
$.ui.simplicityGoogleMapBoundsTracker.showBounds(bounds)
Adds an overlay for the bounds on the map.
Namespace Detail
$.ui.simplicityGoogleMapBoundsTracker
  <div id="map" style="width: 300px; height: 300px;"></div>
  <script type="text/javascript">
    $('#map').simplicityGoogleMapBoundsTracker();
  </script>
See:
Google Maps JavaScript API V3 documentation.
Field Detail
<static> $.ui.simplicityGoogleMapBoundsTracker.options
Widget options.
map
Optional map instance, if not provided one will be looked up. Defaults to ''.
mapMoveEvents
Provides an override of which vendor specific map events are used to determine when the position of the map changes. Expects a comma separated list of event names. Defaults to 'dragstart,idle,dragend' when idleWhileDragging is enabled, otherwise 'idle'.
idleWhileDragging
Provided that option mapMoveEvents targets event 'idle', then this option will enable the idle event to trigger a bounds change even while dragging the map. Defaults to false.
Method Detail
<static> $.ui.simplicityGoogleMapBoundsTracker.bounds()
Returns the normalized bounds for this map.

<private> <static> $.ui.simplicityGoogleMapBoundsTracker.hideBounds()
Removes the bounds from the map.

<static> $.ui.simplicityGoogleMapBoundsTracker.map()
Return the actual map object.

<private> <static> $.ui.simplicityGoogleMapBoundsTracker.normalizeBounds(bounds, center)
Normalizes the bounds for this map.
Parameters:
bounds
in vendor supplied format
center
point in vendor supplied format

<private> <static> $.ui.simplicityGoogleMapBoundsTracker.showBounds(bounds)
Adds an overlay for the bounds on the map.
Parameters:
bounds
Optional bounds to display, if missing the current bounds are used.

Documentation generated by JsDoc Toolkit 2.4.0