Added gradient to HeatMapWithTime. (#925)

Add `gradient` argument to the `HeatMapWithTime` class. With it users can provide a custom color scheme.

Author: jtbaker

CHANGES.txt

@@ -20,6 +20,7 @@
 - Added `duration` option to `TimestampedGeoJson` (andy23512 #894)
 - Added `zoom_control` to `Map` to toggle zoom controls as per enhancement (#795) (okomarov #899)
 - Change default `date_options` in TimestampedGeoJson (andy23512 #914)
+- Added gradient argument to HeatMapWithTime (jtbaker #925)
 
 API changes
 

folium/plugins/heat_map_withtime.py

@@ -29,6 +29,9 @@ class HeatMapWithTime(Layer):
         The maximum opacity for the heatmap.
     scale_radius: default False
         Scale the radius of the points based on the zoom level.
+    gradient: dict, default None
+        Match point density values to colors. Color can be a name ('red'),
+        RGB values ('rgb(255,0,0)') or a hex number ('#FF0000').
     use_local_extrema: default False
         Defines whether the heatmap uses a global extrema set found from the input data
         OR a local extrema (the maximum and minimum of the currently displayed view).
@@ -92,7 +95,8 @@ class HeatMapWithTime(Layer):
                         maxOpacity: {{this.max_opacity}},
                         scaleRadius: {{this.scale_radius}},
                         useLocalExtrema: {{this.use_local_extrema}},
-                        defaultWeight: 1 ,
+                        defaultWeight: 1,
+                        {% if this.gradient %}gradient: {{ this.gradient }}{% endif %}
                     }
                 })
                 .addTo({{this._parent.get_name()}});
@@ -101,10 +105,11 @@ class HeatMapWithTime(Layer):
         """)
 
     def __init__(self, data, index=None, name=None, radius=15, min_opacity=0,
-                 max_opacity=0.6, scale_radius=False, use_local_extrema=False,
-                 auto_play=False, display_index=True, index_steps=1,
-                 min_speed=0.1, max_speed=10, speed_step=0.1,
-                 position='bottomleft', overlay=True, control=True, show=True):
+                 max_opacity=0.6, scale_radius=False, gradient=None,
+                 use_local_extrema=False, auto_play=False,
+                 display_index=True, index_steps=1, min_speed=0.1,
+                 max_speed=10, speed_step=0.1, position='bottomleft',
+                 overlay=True, control=True, show=True):
         super(HeatMapWithTime, self).__init__(name=name, overlay=overlay,
                                               control=control, show=show)
         self._name = 'HeatMap'
@@ -124,6 +129,7 @@ def __init__(self, data, index=None, name=None, radius=15, min_opacity=0,
         self.max_opacity = max_opacity
         self.scale_radius = 'true' if scale_radius else 'false'
         self.use_local_extrema = 'true' if use_local_extrema else 'false'
+        self.gradient = gradient
 
         # Time dimension settings.
         self.auto_play = 'true' if auto_play else 'false'

tests/plugins/test_heat_map_withtime.py

@@ -16,6 +16,10 @@
 import numpy as np
 
 
+def _normalize(rendered):
+    return ''.join(rendered.split())
+
+
 def test_heat_map_with_time():
     np.random.seed(3141592)
     initial_data = (np.random.normal(size=(100, 2)) * np.array([[1, 1]]) +
@@ -41,45 +45,46 @@ def test_heat_map_with_time():
 
     # We verify that the script part is correct.
     tmpl = Template("""
-            var times = {{this.times}};
-
-            {{this._parent.get_name()}}.timeDimension = L.timeDimension(
-                {times : times, currentTime: new Date(1)}
-            );
-
-            var {{this._control_name}} = new L.Control.TimeDimensionCustom({{this.index}}, {
-                autoPlay: {{this.auto_play}},
-                backwardButton: {{this.backward_button}},
-                displayDate: {{this.display_index}},
-                forwardButton: {{this.forward_button}},
-                limitMinimumRange: {{this.limit_minimum_range}},
-                limitSliders: {{this.limit_sliders}},
-                loopButton: {{this.loop_button}},
-                maxSpeed: {{this.max_speed}},
-                minSpeed: {{this.min_speed}},
-                playButton: {{this.play_button}},
-                playReverseButton: {{this.play_reverse_button}},
-                position: "{{this.position}}",
-                speedSlider: {{this.speed_slider}},
-                speedStep: {{this.speed_step}},
-                styleNS: "{{this.style_NS}}",
-                timeSlider: {{this.time_slider}},
-                timeSliderDrapUpdate: {{this.time_slider_drap_update}},
-                timeSteps: {{this.index_steps}}
-                })
-                .addTo({{this._parent.get_name()}});
-
-                var {{this.get_name()}} = new TDHeatmap({{this.data}},
-                {heatmapOptions: {
-                        radius: {{this.radius}},
-                        minOpacity: {{this.min_opacity}},
-                        maxOpacity: {{this.max_opacity}},
-                        scaleRadius: {{this.scale_radius}},
-                        useLocalExtrema: {{this.use_local_extrema}},
-                        defaultWeight: 1 ,
-                    }
-                })
-                .addTo({{this._parent.get_name()}});
+        var times = {{this.times}};
+
+        {{this._parent.get_name()}}.timeDimension = L.timeDimension(
+            {times : times, currentTime: new Date(1)}
+        );
+
+        var {{this._control_name}} = new L.Control.TimeDimensionCustom({{this.index}}, {
+            autoPlay: {{this.auto_play}},
+            backwardButton: {{this.backward_button}},
+            displayDate: {{this.display_index}},
+            forwardButton: {{this.forward_button}},
+            limitMinimumRange: {{this.limit_minimum_range}},
+            limitSliders: {{this.limit_sliders}},
+            loopButton: {{this.loop_button}},
+            maxSpeed: {{this.max_speed}},
+            minSpeed: {{this.min_speed}},
+            playButton: {{this.play_button}},
+            playReverseButton: {{this.play_reverse_button}},
+            position: "{{this.position}}",
+            speedSlider: {{this.speed_slider}},
+            speedStep: {{this.speed_step}},
+            styleNS: "{{this.style_NS}}",
+            timeSlider: {{this.time_slider}},
+            timeSliderDrapUpdate: {{this.time_slider_drap_update}},
+            timeSteps: {{this.index_steps}}
+            })
+            .addTo({{this._parent.get_name()}});
+
+            var {{this.get_name()}} = new TDHeatmap({{this.data}},
+            {heatmapOptions: {
+                    radius: {{this.radius}},
+                    minOpacity: {{this.min_opacity}},
+                    maxOpacity: {{this.max_opacity}},
+                    scaleRadius: {{this.scale_radius}},
+                    useLocalExtrema: {{this.use_local_extrema}},
+                    defaultWeight: 1,
+                    {% if this.gradient %}gradient: {{ this.gradient }}{% endif %}
+                }
+            })
+            .addTo({{this._parent.get_name()}});
     """)
 
-    assert tmpl.render(this=hm)
+    assert _normalize(tmpl.render(this=hm)) in _normalize(out)