Add loadevent parameter to control map initialization

CHANGES

@@ -28,13 +28,11 @@ CHANGELOG
 **Features**
 
 * Add ability to associate layers attributions from settings
-
 * Add ``auto-include`` key for entries in ``PLUGINS`` setting, in order
   to implicity load plugins with ``leaflet_css`` and ``leaflet_js`` tags.
-
 * Rewrote map initialization, into less flexible and obstruvise way.
-
 * Use plugin system for Leaflet.MiniMap.
+* Add ``loadevent`` parameter to ``leaflet_map`` tag.
 
 
 0.6.0 (2013-08-08)

README.rst

@@ -226,6 +226,11 @@ Advanced usage
   Useful to put the javascript code in the header or footer instead of the
   body of the html document. If used, do not forget to create the div manually.
 
+* ``loadevent``: One or more space-separated *window* events that trigger map initialization.
+  (Default: ``load``, i.e. all page resources loaded).
+  If empty values is provided, then map initialization is immediate.
+  And with a wrong value, the map is never initialized. :)
+
 
 Projection
 ----------

leaflet/templates/leaflet/map_fragment.html

@@ -9,8 +9,10 @@
                        globals: {{ NO_GLOBALS|yesno:"false,true"}}, callback: {{ callback}}};
         L.Map.djangoMap('{{ name }}', options);
     }
-    if (window.addEventListener) window.addEventListener("load", loadmap, false);
-    else if (window.jQuery) jQuery(window).on("load", loadmap);
+    var loadevents = {% autoescape off %}{{ loadevents }}{% endautoescape %};
+    if (loadevents.length === 0) loadmap();
+    else if (window.addEventListener) for (var i=0; i<loadevents.length; i++) window.addEventListener(loadevents[i], loadmap, false);
+    else if (window.jQuery) jQuery(window).on(loadevents.join(' '), loadmap);
     {% if not NO_GLOBALS %}
     // Put initialization function in global scope (like django-leaflet < 0.7)
     window['loadmap' + '{{ name }}'] = loadmap;

leaflet/templatetags/leaflet_tags.py

@@ -40,7 +40,7 @@ def leaflet_js(plugins=None):
 
 
 @register.inclusion_tag('leaflet/map_fragment.html')
-def leaflet_map(name, callback=None, fitextent=True, creatediv=True):
+def leaflet_map(name, callback=None, fitextent=True, creatediv=True, loadevent='load'):
     """
 
     :param name:
@@ -75,6 +75,7 @@ def leaflet_map(name, callback=None, fitextent=True, creatediv=True):
     return {
         # templatetag options
         'name': name,
+        'loadevents': json.dumps(loadevent.split()),
         'creatediv': creatediv,
         'callback': callback,
         # initialization options