Removed ColorScale in favor of colormap

Author: Martin Journois

examples/GeoJSON and choropleth.ipynb

@@ -7,11 +7,13 @@
 from folium.map import (FeatureGroup, FitBounds, Icon, LayerControl, Marker,
                         Popup, TileLayer)
 
-from folium.features import (ClickForMarker, ColorScale, CustomIcon, DivIcon,
+from folium.features import (ClickForMarker, CustomIcon, DivIcon,
                              GeoJson, LatLngPopup,
                              MarkerCluster, MultiPolyLine, PolyLine, Vega,
                              RegularPolygonMarker, TopoJson, WmsTileLayer)
 
+import folium.colormap as colormap
+
 __version__ = '0.2.0.dev'
 
 __all__ = ['Map',
@@ -25,7 +27,7 @@
            'Popup',
            'TileLayer',
            'ClickForMarker',
-           'ColorScale',
+           'colormap',
            'CustomIcon',
            'DivIcon',
            'GeoJson',

folium/__init__.py

@@ -8,7 +8,7 @@
 from jinja2 import Template
 import json
 
-from .utilities import (color_brewer, _parse_size, legend_scaler,
+from .utilities import (_parse_size,
                         _locations_mirror, _locations_tolist, image_to_url,
                         text_type, binary_type,
                         none_min, none_max, iter_points,
@@ -487,36 +487,6 @@ def _get_self_bounds(self):
         ]
 
 
-class ColorScale(MacroElement):
-    def __init__(self, color_domain, color_code, caption=""):
-        """
-        TODO docstring here
-
-        """
-        super(ColorScale, self).__init__()
-        self._name = 'ColorScale'
-
-        self.color_domain = color_domain
-        self.color_range = color_brewer(color_code, n=len(color_domain))
-        self.tick_labels = legend_scaler(self.color_domain)
-
-        self.caption = caption
-        self.fill_color = color_code
-
-        self._template = self._env.get_template('color_scale.js')
-
-    def render(self, **kwargs):
-        super(ColorScale, self).render(**kwargs)
-
-        figure = self.get_root()
-        assert isinstance(figure, Figure), ("You cannot render this Element "
-                                            "if it's not in a Figure.")
-
-        figure.header.add_children(
-            JavascriptLink("https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"),  # noqa
-            name='d3')
-
-
 class MarkerCluster(Layer):
     """Adds a MarkerCluster layer on the map."""
     def __init__(self, name=None, overlay=True, control=True):

folium/features.py

@@ -17,8 +17,9 @@
 from .map import Icon, Marker, Popup, FitBounds
 from .features import (WmsTileLayer, RegularPolygonMarker, Vega, GeoJson,
                        CircleMarker, LatLngPopup,
-                       ClickForMarker, ColorScale, TopoJson, PolyLine,
-                       MultiPolyLine)
+                       ClickForMarker, TopoJson, PolyLine, MultiPolyLine,
+                       )
+from .colormap import StepColormap
 from .utilities import color_brewer
 
 
@@ -422,29 +423,6 @@ def add_plugin(self, plugin):
                       FutureWarning, stacklevel=2)
         self.add_children(plugin)
 
-#    def _auto_bounds(self):
-#        if 'fit_bounds' in self.template_vars:
-#            return
-#        # Get count for each feature type
-#        ft_names = ["marker", "line", "circle", "polygon", "multiline"]
-#        ft_names = [i for i in ft_names if i in self.mark_cnt]
-#
-#        # Make a comprehensive list of all the features we want to fit
-#        feat_str = ["{name}_{count}".format(name=ft_name,
-#                                            count=self.mark_cnt[ft_name])
-#                    for ft_name in ft_names for
-#                    count in range(1, self.mark_cnt[ft_name]+1)]
-#        feat_str = "[" + ', '.join(feat_str) + "]"
-#
-#        fit_bounds = self.env.get_template('fit_bounds.js')
-#        fit_bounds_str = fit_bounds.render({
-#            'autobounds': not self.location,
-#            'features': feat_str,
-#            'fit_bounds_options': json.dumps({'padding': [30, 30]}),
-#        })
-#
-#        self.template_vars.update({'fit_bounds': fit_bounds_str.strip()})
-
     def geo_json(self, *args, **kwargs):
         """This method is deprecated and will be removed in v0.2.1. See
         `Map.choropleth` instead.
@@ -626,10 +604,15 @@ def style_function(x):
 
         self.add_children(geo_json)
 
-        # Create ColorScale.
+        # Create ColorMap.
         if color_domain:
-            color_scale = ColorScale(color_domain, fill_color,
-                                     caption=legend_name)
+            brewed = color_brewer(fill_color, n=len(color_domain))
+            color_scale = StepColormap(
+                brewed[1:len(color_domain)],
+                index=color_domain,
+                vmin=color_domain[0],
+                vmax=color_domain[-1],
+                )
             self.add_children(color_scale)
 
     def image_overlay(self, data, opacity=0.25, min_lat=-90.0, max_lat=90.0,

folium/folium.py

@@ -21,8 +21,8 @@
 import base64
 from folium.six import PY3
 from folium.map import Popup, Marker, FitBounds, FeatureGroup
-from folium.features import (GeoJson, ColorScale, TopoJson, PolyLine,
-                             MultiPolyLine)
+from folium.features import GeoJson, TopoJson, PolyLine, MultiPolyLine
+from folium.colormap import ColorMap
 from folium.plugins import ImageOverlay
 
 rootpath = os.path.abspath(os.path.dirname(__file__))
@@ -450,12 +450,12 @@ def test_geo_json_data_binding(self):
         path = os.path.join(rootpath, 'us-counties.json')
 
         # With DataFrame data binding, default threshold scale.
-        self.map.geo_json(geo_path=path, data=data,
-                          threshold_scale=[4.0, 1000.0, 3000.0,
-                                           5000.0, 9000.0],
-                          columns=['FIPS_Code', 'Unemployed_2011'],
-                          key_on='feature.id', fill_color='YlGnBu',
-                          reset=True)
+        self.map.choropleth(geo_path=path, data=data,
+                            threshold_scale=[4.0, 1000.0, 3000.0,
+                                             5000.0, 9000.0],
+                            columns=['FIPS_Code', 'Unemployed_2011'],
+                            key_on='feature.id', fill_color='YlGnBu',
+                            reset=True)
 
         out = self.map._parent.render()
 
@@ -464,8 +464,8 @@ def test_geo_json_data_binding(self):
         palette = folium.utilities.color_brewer('YlGnBu')
         d3range = palette[0: len(domain) + 2]
         colorscale_obj = [val for key, val in self.map._children.items() if
-                          isinstance(val, ColorScale)][0]
-        colorscale_temp = self.env.get_template('d3_threshold.js')
+                          isinstance(val, ColorMap)][0]
+        colorscale_temp = self.env.get_template('color_scale.js')
         colorscale = colorscale_temp.render({
             'this': colorscale_obj,
             'domain': domain,