jsdoc

$.ui.simplicityGoogleMapResults

Namespace $.ui.simplicityGoogleMapResults

A Google map.

Widget that listens for simplicityResultSet events which it uses to add markers to the map for the search results.
Defined in: ui.simplicityGoogleMapResults.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityGoogleMapResults.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<private> <static>  
$.ui.simplicityGoogleMapResults._resultSetHandler()
Event handler for the simplicitySearchResponse event.
<private> <static>  
$.ui.simplicityGoogleMapResults._setOption()
Override of _setOption that is used to ensure that the map is refreshed when the markerCallback changes.
<private> <static>  
$.ui.simplicityGoogleMapResults.addMarkers()
Adds any markers that can be extracted from the given searchResponse.
<static>  
$.ui.simplicityGoogleMapResults.map()
Return the actual map object.
<static>  
$.ui.simplicityGoogleMapResults.refreshMap()
Makes the widget re-handle the last simplicitySearchResponse event to reapply any map markers.
<private> <static>  
$.ui.simplicityGoogleMapResults.removeMarkers()
Removes any markers that were added to the map by addMarkers.
Namespace Detail
$.ui.simplicityGoogleMapResults
  <div id="map" style="width: 300px; height: 300px;"></div>
  <script type="text/javascript">
    $('#map').simplicityGoogleMapResults();
  </script>
See:
Google Maps JavaScript API V3 documentation.
Field Detail
<static> $.ui.simplicityGoogleMapResults.options
Widget options.
searchElement
The simplicityDiscoverySearch widget that this widget binds it's events to. Defaults to 'body'.
latitudeField
Field to find the latitude of the result item in the simplicityResultSet item properties. Defaults to 'latitude'.
longitudeField
Field to find the longitude of the result item in the simplicityResultSet item properties. Defaults to 'longitude'.
map
Optional map instance, if not provided one will be looked up. Defaults to ''.
updateBounds
Whether or not the map bounds should be updated to include the result locations. Defaults to true.
markerCallback
Optional marker callback that can be used to create alternative markers before the marker event is fired. Defaults to ''.
Method Detail
<private> <static> $.ui.simplicityGoogleMapResults._resultSetHandler()
Event handler for the simplicitySearchResponse event. Extracts the coordinates of each result item by using the property fields defined by the latitudeField and longitudeField options of this widget and places a marker on the map for each valid coordinate. The map is then reset to best display the current set of markers.

<private> <static> $.ui.simplicityGoogleMapResults._setOption()
Override of _setOption that is used to ensure that the map is refreshed when the markerCallback changes.

<private> <static> $.ui.simplicityGoogleMapResults.addMarkers()
Adds any markers that can be extracted from the given searchResponse.

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

<static> $.ui.simplicityGoogleMapResults.refreshMap()
Makes the widget re-handle the last simplicitySearchResponse event to reapply any map markers.

<private> <static> $.ui.simplicityGoogleMapResults.removeMarkers()
Removes any markers that were added to the map by addMarkers.

Documentation generated by JsDoc Toolkit 2.4.0