Changeset 7841 for django/branches/gis/django/contrib/gis/maps

Timestamp:

07/05/08 17:10:33 (5 months ago)

Author:

jbronn

Message:

gis: Fixed #7619. Added support Google Maps markers (GMarker) and events (GEvent). Thanks, Ludwig Brinckmann.

Files:

• django/branches/gis/django/contrib/gis/maps/google/gmap.py (modified) (5 diffs)
• django/branches/gis/django/contrib/gis/maps/google/__init__.py (modified) (1 diff)
• django/branches/gis/django/contrib/gis/maps/google/overlays.py (modified) (7 diffs)

django/branches/gis/django/contrib/gis/maps/google/gmap.py

@@ -5 +5 @@
-
-class GoogleMapException(Exception): pass
-
+, GMarker
-
-# The default Google Maps URL (for the API javascript)
@@ -21 +21 @@
-    def __init__(self, key=None, api_url=None, version=None, 
-                 center=None, zoom=None, dom_id='map', load_func='gmap_load', 
-
+ markers=[],
-                 template='gis/google/js/google-map.js',
-                 extra_context={}):
@@ -56 +56 @@
-        self.kml_urls = kml_urls
-        
-
-
+
+
+
+
+
+
+
+
-        if polygons:
-            for poly in polygons:
@@ -71 +77 @@
-                    self.polylines.append(GPolyline(pline))
-       
-
+
+
-        # calculated via the Google Maps API.  If both a zoom level and a
-        # center coordinate are provided with polygons/polylines, no automatic
-        # determination will occur.
-        self.calc_zoom = False
-
+  or self.markers
-            if center is None or zoom is None:
-                self.calc_zoom = True
@@ -96 +103 @@
-                  'polygons' : self.polygons,
-                  'polylines' : self.polylines,
+                  'markers' : self.markers,
-                  }
-        params.update(extra_context)

django/branches/gis/django/contrib/gis/maps/google/__init__.py

@@ -58 +58 @@
-"""
-from django.contrib.gis.maps.google.gmap import GoogleMap
-
+Event, GMarker, G
-from django.contrib.gis.maps.google.zoom import GoogleZoom

django/branches/gis/django/contrib/gis/maps/google/overlays.py

@@ -1 @@
-from django.contrib.gis.geos import LineString, LinearRing, Polygon
-from django.utils.safestring import mark_safe
+from django.contrib.gis.geos import fromstr, Point, LineString, LinearRing, Polygon
+
+class GEvent(object):
+    """
+    A Python wrapper for the Google GEvent object.
+
+    Events can be attached to any object derived from GOverlayBase with the
+    add_event() call.
+
+    For more information please see the Google Maps API Reference:
+     http://code.google.com/apis/maps/documentation/reference.html#GEvent
+
+    Example:
+
+      from django.shortcuts import render_to_response
+      from django.contrib.gis.maps.google import GoogleMap, GEvent, GPolyline
+
+      def sample_request(request):
+          polyline = GPolyline('LINESTRING(101 26, 112 26, 102 31)')
+          event = GEvent('click', 
+            'function() { location.href = "http://www.google.com"}')
+          polyline.add_event(event)
+          return render_to_response('mytemplate.html', 
+          {'google' : GoogleMap(polylines=[polyline])})
+    """
+
+    def __init__(self, event, action):
+        """
+        Initializes a GEvent object. 
+        
+        Parameters:
+
+        event: 
+          string for the event, such as 'click'. The event must be a valid
+          event for the object in the Google Maps API. 
+          There is no validation of the event type within Django.
+
+        action:
+          string containing a Javascript function, such as 
+          'function() { location.href = "newurl";}'
+          The string must be a valid Javascript function. Again there is no 
+          validation fo the function within Django.
+        """
+        self.event = event
+        self.action = action
+
+    def __unicode__(self):
+        "Returns the parameter part of a GEvent."
+        return mark_safe('"%s", %s' %(self.event, self.action))
-
-class GOverlayBase(object):
+    def __init__(self):
+        self.events = []
+
-    def latlng_from_coords(self, coords):
+        "Generates a JavaScript array of GLatLng objects for the given coordinates."
-        return '[%s]' % ','.join(['new GLatLng(%s,%s)' % (y, x) for x, y in coords])
+
+    def add_event(self, event):
+        "Attaches a GEvent to the overlay object."
+        self.events.append(event)
-
-    def __unicode__(self):
@@ -20 +76 @@
-                 fill_color='#0000ff', fill_opacity=0.4):
-        """
-
-
+
+
+
-
-        Keyword Options:
@@ -40 +97 @@
-            The opacity of the polygon fill.  Defaults to 0.4.
-        """
-
-# TODO: Take other types of geometries.
+
+if isinstance(poly, (tuple, list)): poly = Polygon(poly)
-        if not isinstance(poly, Polygon): 
-            raise TypeError('GPolygon may only initialize on GEOS Polygons.')
@@ -58 +115 @@
-        # Fill settings.
-        self.fill_color, self.fill_opacity = fill_color, fill_opacity
-
+
+
+
-    @property
-    def js_params(self):
@@ -72 +131 @@
-    def __init__(self, geom, color='#0000ff', weight=2, opacity=1):
-        """
-
-
+
+
+
-
-        Keyword Options:
@@ -86 +146 @@
-            The opacity of the polyline, between 0 and 1.  Defaults to 1.
-        """
+        # If a GEOS geometry isn't passed in, try to contsruct one.
+        if isinstance(geom, basestring): geom = fromstr(geom)
+        if isinstance(geom, (tuple, list)): geom = Polygon(geom)
+        # Generating the lat/lng coordinate pairs.
-        if isinstance(geom, (LineString, LinearRing)):
-            self.latlngs = self.latlng_from_coords(geom.coords)
@@ -96 +160 @@
-        self.envelope = geom.envelope
-        self.color, self.weight, self.opacity = color, weight, opacity
+        super(GPolyline, self).__init__()
-        
-    @property
-    def js_params(self):
-        return '%s, "%s", %s, %s' % (self.latlngs, self.color, self.weight, self.opacity)
+
+class GMarker(GOverlayBase):
+    """
+    A Python wrapper for the Google GMarker object.  For more information
+    please see the Google Maps API Reference:
+     http://code.google.com/apis/maps/documentation/reference.html#GMarker
+
+    Example:
+
+      from django.shortcuts import render_to_response
+      from django.contrib.gis.maps.google.overlays import GMarker, GEvent
+     
+      def sample_request(request):
+          marker = GMarker('POINT(101 26)')
+          event = GEvent('click', 
+                         'function() { location.href = "http://www.google.com"}')
+          marker.add_event(event)
+          return render_to_response('mytemplate.html', 
+                 {'google' : GoogleMap(markers=[marker])})
+    """
+    def __init__(self, geom, title=None):
+        """
+        The GMarker object may initialize on GEOS Points or a parameter
+        that may be instantiated into a GEOS point.  Keyword options map to
+        GMarkerOptions -- so far only the title option is supported.
+
+        Keyword Options:
+         title: 
+           Title option for GMarker, will be displayed as a tooltip.
+        """
+        # If a GEOS geometry isn't passed in, try to construct one.
+        if isinstance(geom, basestring): geom = fromstr(geom)
+        if isinstance(geom, (tuple, list)): geom = Point(geom)
+        if isinstance(geom, Point):
+            self.latlng = self.latlng_from_coords(geom.coords)
+        else:
+            raise TypeError('GMarker may only initialize on GEOS Point geometry.')
+        # Getting the envelope for automatic zoom determination.
+        self.envelope = geom.envelope
+        # TODO: Add support for more GMarkerOptions
+        self.title = title
+        super(GMarker, self).__init__()
+
+    def latlng_from_coords(self, coords):
+        return 'new GLatLng(%s,%s)' %(coords[1], coords[0])
+    
+    def options(self):
+        result = []
+        if self.title: result.append('title: "%s"' % self.title) 
+        return '{%s}' % ','.join(result)
+
+    @property
+    def js_params(self):
+        return '%s, %s' % (self.latlng, self.options())