\n",
- "\n",
"
\n",
" \n",
@@ -505,28 +505,28 @@
" \n",
" \n",
" 1454205600 \n",
- " #f1eef6 \n",
- " 0.355321 \n",
+ " #e3d8eb \n",
+ " 0.341257 \n",
" \n",
" \n",
" 1456714800 \n",
- " #f1eef6 \n",
- " 0.274207 \n",
+ " #ede8f3 \n",
+ " 0.340823 \n",
" \n",
" \n",
" 1459393200 \n",
- " #f1eef6 \n",
- " 0.129953 \n",
+ " #e9e4f1 \n",
+ " 0.294992 \n",
" \n",
" \n",
" 1461985200 \n",
- " #ebe2f0 \n",
- " 0.263099 \n",
+ " #f0ecf5 \n",
+ " 0.327429 \n",
" \n",
" \n",
" 1464663600 \n",
- " #f0ecf5 \n",
- " 0.520150 \n",
+ " #f2eef6 \n",
+ " 0.265140 \n",
" \n",
" \n",
"
\n",
@@ -534,11 +534,11 @@
],
"text/plain": [
" color opacity\n",
- "1454205600 #f1eef6 0.355321\n",
- "1456714800 #f1eef6 0.274207\n",
- "1459393200 #f1eef6 0.129953\n",
- "1461985200 #ebe2f0 0.263099\n",
- "1464663600 #f0ecf5 0.520150"
+ "1454205600 #e3d8eb 0.341257\n",
+ "1456714800 #ede8f3 0.340823\n",
+ "1459393200 #e9e4f1 0.294992\n",
+ "1461985200 #f0ecf5 0.327429\n",
+ "1464663600 #f2eef6 0.265140"
]
},
"execution_count": 12,
@@ -588,10 +588,10 @@
{
"data": {
"text/html": [
- "
"
+ "
"
],
"text/plain": [
- "
"
+ ""
]
},
"execution_count": 14,
@@ -632,7 +632,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.6.3"
+ "version": "3.6.5"
}
},
"nbformat": 4,
diff --git a/folium/features.py b/folium/features.py
index de8899c6e5..01b4983f2c 100644
--- a/folium/features.py
+++ b/folium/features.py
@@ -57,24 +57,7 @@ class RegularPolygonMarker(Marker):
https://humangeo.github.io/leaflet-dvf/
"""
- def __init__(self, location, color='black', opacity=1, weight=2,
- fill_color='blue', fill_opacity=1,
- number_of_sides=4, rotation=0, radius=15, popup=None):
- super(RegularPolygonMarker, self).__init__(
- _locations_tolist(location),
- popup=popup
- )
- self._name = 'RegularPolygonMarker'
- self.color = color
- self.opacity = opacity
- self.weight = weight
- self.fill_color = fill_color
- self.fill_opacity = fill_opacity
- self.number_of_sides = number_of_sides
- self.rotation = rotation
- self.radius = radius
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = new L.RegularPolygonMarker(
new L.LatLng({{this.location[0]}},{{this.location[1]}}),
@@ -94,6 +77,23 @@ def __init__(self, location, color='black', opacity=1, weight=2,
{% endmacro %}
""")
+ def __init__(self, location, color='black', opacity=1, weight=2,
+ fill_color='blue', fill_opacity=1,
+ number_of_sides=4, rotation=0, radius=15, popup=None):
+ super(RegularPolygonMarker, self).__init__(
+ _locations_tolist(location),
+ popup=popup
+ )
+ self._name = 'RegularPolygonMarker'
+ self.color = color
+ self.opacity = opacity
+ self.weight = weight
+ self.fill_color = fill_color
+ self.fill_opacity = fill_opacity
+ self.number_of_sides = number_of_sides
+ self.rotation = rotation
+ self.radius = radius
+
def render(self, **kwargs):
"""Renders the HTML representation of the element."""
super(RegularPolygonMarker, self).render()
@@ -136,6 +136,8 @@ class Vega(Element):
Ex: 'relative', 'absolute'
"""
+ _template = Template(u'')
+
def __init__(self, data, width=None, height=None,
left='0%', top='0%', position='relative'):
super(Vega, self).__init__()
@@ -152,7 +154,6 @@ def __init__(self, data, width=None, height=None,
self.left = _parse_size(left)
self.top = _parse_size(top)
self.position = position
- self._template = Template(u'')
def render(self, **kwargs):
"""Renders the HTML representation of the element."""
@@ -227,6 +228,8 @@ class VegaLite(Element):
Ex: 'relative', 'absolute'
"""
+ _template = Template(u'')
+
def __init__(self, data, width=None, height=None,
left='0%', top='0%', position='relative'):
super(VegaLite, self).__init__()
@@ -243,7 +246,6 @@ def __init__(self, data, width=None, height=None,
self.left = _parse_size(left)
self.top = _parse_size(top)
self.position = position
- self._template = Template(u'')
def render(self, **kwargs):
"""Renders the HTML representation of the element."""
@@ -313,10 +315,12 @@ class GeoJson(Layer):
Function mapping a GeoJson Feature to a style dict for mouse events.
name : string, default None
The name of the Layer, as it will appear in LayerControls
- overlay : bool, default False
+ overlay : bool, default True
Adds the layer as an optional overlay (True) or the base layer (False).
control : bool, default True
Whether the Layer will be included in LayerControls
+ show: bool, default True
+ Whether the layer will be shown on opening (only for overlays).
smooth_factor: float, default None
How much to simplify the polyline on each zoom level. More means
better performance and smoother look, and less means more accurate
@@ -340,48 +344,7 @@ class GeoJson(Layer):
>>> GeoJson(geojson, style_function=style_function)
"""
- def __init__(self, data, style_function=None, name=None,
- overlay=True, control=True, smooth_factor=None,
- highlight_function=None, tooltip=None):
- super(GeoJson, self).__init__(name=name, overlay=overlay,
- control=control)
- self._name = 'GeoJson'
- self.tooltip = tooltip
- if isinstance(data, dict):
- self.embed = True
- self.data = data
- elif isinstance(data, text_type) or isinstance(data, binary_type):
- self.embed = True
- if data.lower().startswith(('http:', 'ftp:', 'https:')):
- self.data = requests.get(data).json()
- elif data.lstrip()[0] in '[{': # This is a GeoJSON inline string
- self.data = json.loads(data)
- else: # This is a filename
- with open(data) as f:
- self.data = json.loads(f.read())
- elif data.__class__.__name__ in ['GeoDataFrame', 'GeoSeries']:
- self.embed = True
- if hasattr(data, '__geo_interface__'):
- # We have a GeoPandas 0.2 object.
- self.data = json.loads(json.dumps(data.to_crs(epsg='4326').__geo_interface__)) # noqa
- elif hasattr(data, 'columns'):
- # We have a GeoDataFrame 0.1
- self.data = json.loads(data.to_crs(epsg='4326').to_json())
- else:
- msg = 'Unable to transform this object to a GeoJSON.'
- raise ValueError(msg)
- else:
- raise ValueError('Unhandled object {!r}.'.format(data))
-
- self.style_function = style_function or (lambda x: {})
-
- self.highlight = highlight_function is not None
-
- self.highlight_function = highlight_function or (lambda x: {})
-
- self.smooth_factor = smooth_factor
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
{% if this.highlight %}
@@ -421,6 +384,47 @@ def __init__(self, data, style_function=None, name=None,
{% endmacro %}
""") # noqa
+ def __init__(self, data, style_function=None, name=None,
+ overlay=True, control=True, show=True,
+ smooth_factor=None, highlight_function=None, tooltip=None):
+ super(GeoJson, self).__init__(name=name, overlay=overlay,
+ control=control, show=show)
+ self._name = 'GeoJson'
+ self.tooltip = tooltip
+ if isinstance(data, dict):
+ self.embed = True
+ self.data = data
+ elif isinstance(data, text_type) or isinstance(data, binary_type):
+ self.embed = True
+ if data.lower().startswith(('http:', 'ftp:', 'https:')):
+ self.data = requests.get(data).json()
+ elif data.lstrip()[0] in '[{': # This is a GeoJSON inline string
+ self.data = json.loads(data)
+ else: # This is a filename
+ with open(data) as f:
+ self.data = json.loads(f.read())
+ elif data.__class__.__name__ in ['GeoDataFrame', 'GeoSeries']:
+ self.embed = True
+ if hasattr(data, '__geo_interface__'):
+ # We have a GeoPandas 0.2 object.
+ self.data = json.loads(json.dumps(data.to_crs(epsg='4326').__geo_interface__)) # noqa
+ elif hasattr(data, 'columns'):
+ # We have a GeoDataFrame 0.1
+ self.data = json.loads(data.to_crs(epsg='4326').to_json())
+ else:
+ msg = 'Unable to transform this object to a GeoJSON.'
+ raise ValueError(msg)
+ else:
+ raise ValueError('Unhandled object {!r}.'.format(data))
+
+ self.style_function = style_function or (lambda x: {})
+
+ self.highlight = highlight_function is not None
+
+ self.highlight_function = highlight_function or (lambda x: {})
+
+ self.smooth_factor = smooth_factor
+
def style_data(self):
"""
Applies `self.style_function` to each feature of `self.data` and
@@ -471,7 +475,9 @@ class TopoJson(Layer):
overlay : bool, default False
Adds the layer as an optional overlay (True) or the base layer (False).
control : bool, default True
- Whether the Layer will be included in LayerControls
+ Whether the Layer will be included in LayerControls.
+ show: bool, default True
+ Whether the layer will be shown on opening (only for overlays).
smooth_factor: float, default None
How much to simplify the polyline on each zoom level. More means
better performance and smoother look, and less means more accurate
@@ -495,11 +501,28 @@ class TopoJson(Layer):
>>> TopoJson(topo_json, 'object.myobject', style_function=style_function)
"""
+ _template = Template(u"""
+ {% macro script(this, kwargs) %}
+ var {{this.get_name()}}_data = {{this.style_data()}};
+ var {{this.get_name()}} = L.geoJson(topojson.feature(
+ {{this.get_name()}}_data,
+ {{this.get_name()}}_data.{{this.object_path}})
+ {% if this.smooth_factor is not none %}
+ , {smoothFactor: {{this.smooth_factor}}}
+ {% endif %}
+ )
+ {% if this.tooltip %}.bindTooltip("{{this.tooltip.__str__()}}"){% endif %}
+ .addTo({{this._parent.get_name()}});
+ {{this.get_name()}}.setStyle(function(feature) {return feature.properties.style;});
+
+ {% endmacro %}
+ """) # noqa
+
def __init__(self, data, object_path, style_function=None,
- name=None, overlay=True, control=True, smooth_factor=None,
- tooltip=None):
+ name=None, overlay=True, control=True, show=True,
+ smooth_factor=None, tooltip=None):
super(TopoJson, self).__init__(name=name, overlay=overlay,
- control=control)
+ control=control, show=show)
self._name = 'TopoJson'
self.tooltip = tooltip
if 'read' in dir(data):
@@ -521,23 +544,6 @@ def style_function(x):
self.smooth_factor = smooth_factor
- self._template = Template(u"""
- {% macro script(this, kwargs) %}
- var {{this.get_name()}}_data = {{this.style_data()}};
- var {{this.get_name()}} = L.geoJson(topojson.feature(
- {{this.get_name()}}_data,
- {{this.get_name()}}_data.{{this.object_path}})
- {% if this.smooth_factor is not none %}
- , {smoothFactor: {{this.smooth_factor}}}
- {% endif %}
- )
- {% if this.tooltip %}.bindTooltip("{{this.tooltip.__str__()}}"){% endif %}
- .addTo({{this._parent.get_name()}});
- {{this.get_name()}}.setStyle(function(feature) {return feature.properties.style;});
-
- {% endmacro %}
- """) # noqa
-
def style_data(self):
"""
Applies self.style_function to each feature of self.data and returns
@@ -627,17 +633,7 @@ class DivIcon(MacroElement):
http://leafletjs.com/reference-1.2.0.html#divicon
"""
- def __init__(self, html=None, icon_size=None, icon_anchor=None,
- popup_anchor=None, class_name='empty'):
- super(DivIcon, self).__init__()
- self._name = 'DivIcon'
- self.icon_size = icon_size
- self.icon_anchor = icon_anchor
- self.popup_anchor = popup_anchor
- self.html = html
- self.className = class_name
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.divIcon({
@@ -651,6 +647,16 @@ def __init__(self, html=None, icon_size=None, icon_anchor=None,
{% endmacro %}
""") # noqa
+ def __init__(self, html=None, icon_size=None, icon_anchor=None,
+ popup_anchor=None, class_name='empty'):
+ super(DivIcon, self).__init__()
+ self._name = 'DivIcon'
+ self.icon_size = icon_size
+ self.icon_anchor = icon_anchor
+ self.popup_anchor = popup_anchor
+ self.html = html
+ self.className = class_name
+
class LatLngPopup(MacroElement):
"""
@@ -658,11 +664,7 @@ class LatLngPopup(MacroElement):
a popup is shown that displays the latitude and longitude of the pointer.
"""
- def __init__(self):
- super(LatLngPopup, self).__init__()
- self._name = 'LatLngPopup'
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.popup();
function latLngPop(e) {
@@ -676,6 +678,10 @@ def __init__(self):
{% endmacro %}
""") # noqa
+ def __init__(self):
+ super(LatLngPopup, self).__init__()
+ self._name = 'LatLngPopup'
+
class ClickForMarker(MacroElement):
"""
@@ -689,16 +695,7 @@ class ClickForMarker(MacroElement):
If None, the popups will display the marker's latitude and longitude.
"""
- def __init__(self, popup=None):
- super(ClickForMarker, self).__init__()
- self._name = 'ClickForMarker'
-
- if popup:
- self.popup = ''.join(['"', popup, '"'])
- else:
- self.popup = '"Latitude: " + lat + "
+{% endmacro %}
+
+{% macro script(this, kwargs) %}
+ {% if this.max_bounds %}
+ var southWest = L.latLng({{ this.min_lat }}, {{ this.min_lon }});
+ var northEast = L.latLng({{ this.max_lat }}, {{ this.max_lon }});
+ var bounds = L.latLngBounds(southWest, northEast);
+ {% else %}
+ var bounds = null;
+ {% endif %}
+
+ var {{this.get_name()}} = L.map(
+ '{{this.get_name()}}', {
+ center: [{{this.location[0]}}, {{this.location[1]}}],
+ zoom: {{this.zoom_start}},
+ maxBounds: bounds,
+ layers: [],
+ worldCopyJump: {{this.world_copy_jump.__str__().lower()}},
+ crs: L.CRS.{{this.crs}}
+ });
+{% if this.control_scale %}L.control.scale().addTo({{this.get_name()}});{% endif %}
+
+ {% if this.objects_to_stay_in_front %}
+ function objects_in_front() {
+ {% for obj in this.objects_to_stay_in_front %}
+ {{ obj.get_name() }}.bringToFront();
+ {% endfor %}
+ };
+
+{{ this.get_name() }}.on("overlayadd", objects_in_front);
+$(document).ready(objects_in_front);
+{% endif %}
+{% endmacro %}
+""") # noqa
def __init__(self, location=None, width='100%', height='100%',
left='0%', top='0%', position='relative',
- tiles='OpenStreetMap', API_key=None, max_zoom=18, min_zoom=1,
- zoom_start=10, world_copy_jump=False,
+ tiles='OpenStreetMap', API_key=None, max_zoom=18, min_zoom=0,
+ max_native_zoom=None, zoom_start=10, world_copy_jump=False,
no_wrap=False, attr=None, min_lat=-90, max_lat=90,
min_lon=-180, max_lon=180, max_bounds=False,
detect_retina=False, crs='EPSG3857', control_scale=False,
@@ -178,9 +231,9 @@ def __init__(self, location=None, width='100%', height='100%',
self.png_enabled = png_enabled
if not location:
- # If location is not passed we center and ignore zoom.
+ # If location is not passed we center and zoom out.
self.location = [0, 0]
- self.zoom_start = min_zoom
+ self.zoom_start = 1
else:
self.location = _validate_location(location)
self.zoom_start = zoom_start
@@ -211,52 +264,16 @@ def __init__(self, location=None, width='100%', height='100%',
disable_3d
)
+ self.objects_to_stay_in_front = []
+
if tiles:
self.add_tile_layer(
tiles=tiles, min_zoom=min_zoom, max_zoom=max_zoom,
- no_wrap=no_wrap, attr=attr,
+ max_native_zoom=max_native_zoom, no_wrap=no_wrap, attr=attr,
API_key=API_key, detect_retina=detect_retina,
subdomains=subdomains
)
- self._template = Template(u"""
- {% macro header(this, kwargs) %}
-
- {% endmacro %}
- {% macro html(this, kwargs) %}
-
- {% endmacro %}
-
- {% macro script(this, kwargs) %}
-
- {% if this.max_bounds %}
- var southWest = L.latLng({{ this.min_lat }}, {{ this.min_lon }});
- var northEast = L.latLng({{ this.max_lat }}, {{ this.max_lon }});
- var bounds = L.latLngBounds(southWest, northEast);
- {% else %}
- var bounds = null;
- {% endif %}
-
- var {{this.get_name()}} = L.map(
- '{{this.get_name()}}',
- {center: [{{this.location[0]}},{{this.location[1]}}],
- zoom: {{this.zoom_start}},
- maxBounds: bounds,
- layers: [],
- worldCopyJump: {{this.world_copy_jump.__str__().lower()}},
- crs: L.CRS.{{this.crs}}
- });
- {% if this.control_scale %}L.control.scale().addTo({{this.get_name()}});{% endif %}
- {% endmacro %}
- """) # noqa
-
def _repr_html_(self, **kwargs):
"""Displays the HTML Map in a Jupyter notebook."""
if self._parent is None:
@@ -309,8 +326,8 @@ def _repr_png_(self):
return self._to_png()
def add_tile_layer(self, tiles='OpenStreetMap', name=None,
- API_key=None, max_zoom=18, min_zoom=1,
- attr=None, active=False,
+ API_key=None, max_zoom=18, min_zoom=0,
+ max_native_zoom=None, attr=None, active=False,
detect_retina=False, no_wrap=False, subdomains='abc',
**kwargs):
"""
@@ -319,6 +336,7 @@ def add_tile_layer(self, tiles='OpenStreetMap', name=None,
"""
tile_layer = TileLayer(tiles=tiles, name=name,
min_zoom=min_zoom, max_zoom=max_zoom,
+ max_native_zoom=max_native_zoom,
attr=attr, API_key=API_key,
detect_retina=detect_retina,
subdomains=subdomains,
@@ -431,14 +449,15 @@ def choropleth(self, geo_data, data=None, columns=None, key_on=None,
Parameters
----------
geo_data: string/object
- URL, file path, or data (json, dict, geopandas, etc) to your GeoJSON geometries
+ URL, file path, or data (json, dict, geopandas, etc) to your GeoJSON
+ geometries
data: Pandas DataFrame or Series, default None
Data to bind to the GeoJSON.
columns: dict or tuple, default None
If the data is a Pandas DataFrame, the columns of data to be bound.
Must pass column 1 as the key, and column 2 the values.
key_on: string, default None
- Variable in the GeoJSON file to bind the data to. Must always
+ Variable in the `geo_data` GeoJSON file to bind the data to. Must
start with 'feature' and be in JavaScript objection notation.
Ex: 'feature.id' or 'feature.properties.statename'.
threshold_scale: list, default None
@@ -495,8 +514,9 @@ def choropleth(self, geo_data, data=None, columns=None, key_on=None,
... highlight=True)
"""
- if threshold_scale and len(threshold_scale) > 6:
- raise ValueError
+ if threshold_scale is not None and len(threshold_scale) > 6:
+ raise ValueError('The length of threshold_scale is {}, but it may '
+ 'not be longer than 6.'.format(len(threshold_scale))) # noqa
if data is not None and not color_brewer(fill_color):
raise ValueError('Please pass a valid color brewer code to '
'fill_local. See docstring for valid codes.')
@@ -514,7 +534,7 @@ def choropleth(self, geo_data, data=None, columns=None, key_on=None,
color_data = None
# Compute color_domain
- if threshold_scale:
+ if threshold_scale is not None:
color_domain = list(threshold_scale)
elif color_data:
# To avoid explicit pandas dependency ; changed default behavior.
@@ -533,7 +553,7 @@ def choropleth(self, geo_data, data=None, columns=None, key_on=None,
else:
color_domain = None
- if color_domain and key_on:
+ if color_domain and key_on is not None:
key_on = key_on[8:] if key_on.startswith('feature.') else key_on
color_range = color_brewer(fill_color, n=len(color_domain))
@@ -543,10 +563,14 @@ def get_by_key(obj, key):
'.'.join(key.split('.')[1:])))
def color_scale_fun(x):
- return color_range[len(
- [u for u in color_domain if
- get_by_key(x, key_on) in color_data and
- u <= color_data[get_by_key(x, key_on)]])]
+ idx = len(
+ [
+ u for u in color_domain if
+ get_by_key(x, key_on) in color_data and
+ u <= color_data[get_by_key(x, key_on)]
+ ]
+ )
+ return color_range[idx-1]
else:
def color_scale_fun(x):
return fill_color
@@ -594,3 +618,17 @@ def highlight_function(x):
caption=legend_name,
)
self.add_child(color_scale)
+
+ def keep_in_front(self, *args):
+ """Pass one or multiples object that must stay in front.
+
+ The ordering matters, the last one is put on top.
+
+ Parameters
+ ----------
+ *args :
+ Variable length argument list. Any folium object that counts as an
+ overlay. For example FeatureGroup or a vector object such as Marker.
+ """
+ for obj in args:
+ self.objects_to_stay_in_front.append(obj)
diff --git a/folium/map.py b/folium/map.py
index 47099847a6..c2fb726134 100644
--- a/folium/map.py
+++ b/folium/map.py
@@ -33,12 +33,15 @@ class Layer(MacroElement):
Adds the layer as an optional overlay (True) or the base layer (False).
control : bool, default True
Whether the Layer will be included in LayerControls.
+ show: bool, default True
+ Whether the layer will be shown on opening (only for overlays).
"""
- def __init__(self, name=None, overlay=False, control=True):
+ def __init__(self, name=None, overlay=False, control=True, show=True):
super(Layer, self).__init__()
self.layer_name = name if name is not None else self.get_name()
self.overlay = overlay
self.control = control
+ self.show = show
class FeatureGroup(Layer):
@@ -56,20 +59,25 @@ class FeatureGroup(Layer):
overlay : bool, default True
Whether your layer will be an overlay (ticked with a check box in
LayerControls) or a base layer (ticked with a radio button).
+ control: bool, default True
+ Whether the layer will be included in LayerControls.
+ show: bool, default True
+ Whether the layer will be shown on opening (only for overlays).
"""
- def __init__(self, name=None, overlay=True, control=True):
- super(FeatureGroup, self).__init__(overlay=overlay, control=control, name=name) # noqa
- self._name = 'FeatureGroup'
-
- self.tile_name = name if name is not None else self.get_name()
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.featureGroup(
).addTo({{this._parent.get_name()}});
{% endmacro %}
""")
+ def __init__(self, name=None, overlay=True, control=True, show=True):
+ super(FeatureGroup, self).__init__(name=name, overlay=overlay,
+ control=control, show=show)
+ self._name = 'FeatureGroup'
+
+ self.tile_name = name if name is not None else self.get_name()
+
class LayerControl(MacroElement):
"""
@@ -90,16 +98,7 @@ class LayerControl(MacroElement):
its layers so that the order is preserved when switching them on/off.
default: True
"""
- def __init__(self, position='topright', collapsed=True, autoZIndex=True):
- super(LayerControl, self).__init__()
- self._name = 'LayerControl'
- self.position = position
- self.collapsed = str(collapsed).lower()
- self.autoZIndex = str(autoZIndex).lower()
- self.base_layers = OrderedDict()
- self.overlays = OrderedDict()
-
- self._template = Template("""
+ _template = Template("""
{% macro script(this,kwargs) %}
var {{this.get_name()}} = {
base_layers : { {% for key,val in this.base_layers.items() %}"{{key}}" : {{val}},{% endfor %} },
@@ -112,23 +111,37 @@ def __init__(self, position='topright', collapsed=True, autoZIndex=True):
collapsed: {{this.collapsed}},
autoZIndex: {{this.autoZIndex}}
}).addTo({{this._parent.get_name()}});
+ {% for val in this.layers_untoggle %}
+ {{ val }}.remove();{% endfor %}
{% endmacro %}
""") # noqa
+ def __init__(self, position='topright', collapsed=True, autoZIndex=True):
+ super(LayerControl, self).__init__()
+ self._name = 'LayerControl'
+ self.position = position
+ self.collapsed = str(collapsed).lower()
+ self.autoZIndex = str(autoZIndex).lower()
+ self.base_layers = OrderedDict()
+ self.overlays = OrderedDict()
+ self.layers_untoggle = []
+
def render(self, **kwargs):
"""Renders the HTML representation of the element."""
- # We select all Layers for which (control and not overlay).
self.base_layers = OrderedDict(
[(val.layer_name, val.get_name()) for key, val in
- self._parent._children.items() if isinstance(val, Layer) and
- (not hasattr(val, 'overlay') or not val.overlay) and
- (not hasattr(val, 'control') or val.control)])
- # We select all Layers for which (control and overlay).
+ self._parent._children.items() if isinstance(val, Layer)
+ and not val.overlay and val.control])
self.overlays = OrderedDict(
[(val.layer_name, val.get_name()) for key, val in
- self._parent._children.items() if isinstance(val, Layer) and
- (hasattr(val, 'overlay') and val.overlay) and
- (not hasattr(val, 'control') or val.control)])
+ self._parent._children.items() if isinstance(val, Layer)
+ and val.overlay and val.control])
+ self.layers_untoggle = [
+ val.get_name() for val in
+ self._parent._children.values() if isinstance(val, Layer)
+ and val.overlay and val.control and not val.show]
+ for additional_base_layer in list(self.base_layers.values())[1:]:
+ self.layers_untoggle.append(additional_base_layer)
super(LayerControl, self).render()
@@ -165,17 +178,7 @@ class Icon(MacroElement):
https://github.com/lvoogdt/Leaflet.awesome-markers
"""
- def __init__(self, color='blue', icon_color='white', icon='info-sign',
- angle=0, prefix='glyphicon'):
- super(Icon, self).__init__()
- self._name = 'Icon'
- self.color = color
- self.icon = icon
- self.icon_color = icon_color
- self.angle = angle
- self.prefix = prefix
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.AwesomeMarkers.icon({
@@ -189,6 +192,16 @@ def __init__(self, color='blue', icon_color='white', icon='info-sign',
{% endmacro %}
""")
+ def __init__(self, color='blue', icon_color='white', icon='info-sign',
+ angle=0, prefix='glyphicon'):
+ super(Icon, self).__init__()
+ self._name = 'Icon'
+ self.color = color
+ self.icon = icon
+ self.icon_color = icon_color
+ self.angle = angle
+ self.prefix = prefix
+
class Marker(MacroElement):
"""
@@ -200,7 +213,8 @@ class Marker(MacroElement):
location: tuple or list, default None
Latitude and Longitude of Marker (Northing, Easting)
popup: string or folium.Popup, default None
- Input text or visualization for object.
+ Label for the Marker; either an escaped HTML string to initialize
+ folium.Popup or a folium.Popup instance.
icon: Icon plugin
the Icon plugin to use to render the marker.
@@ -212,21 +226,11 @@ class Marker(MacroElement):
--------
>>> Marker(location=[45.5, -122.3], popup='Portland, OR')
>>> Marker(location=[45.5, -122.3], popup=folium.Popup('Portland, OR'))
-
+ # If the popup label has characters that need to be escaped in HTML
+ >>> Marker(location=[45.5, -122.3],
+ popoup=folium.Popup('Mom & Pop Arrow Shop >>', parse_html=True))
"""
- def __init__(self, location, popup=None, tooltip=None, icon=None):
- super(Marker, self).__init__()
- self._name = 'Marker'
- self.tooltip = tooltip
- self.location = _validate_coordinates(location)
- if icon is not None:
- self.add_child(icon)
- if isinstance(popup, text_type) or isinstance(popup, binary_type):
- self.add_child(Popup(popup))
- elif popup is not None:
- self.add_child(popup)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.marker(
@@ -240,6 +244,18 @@ def __init__(self, location, popup=None, tooltip=None, icon=None):
{% endmacro %}
""")
+ def __init__(self, location, popup=None, tooltip=None, icon=None):
+ super(Marker, self).__init__()
+ self._name = 'Marker'
+ self.tooltip = tooltip
+ self.location = _validate_coordinates(location)
+ if icon is not None:
+ self.add_child(icon)
+ if isinstance(popup, text_type) or isinstance(popup, binary_type):
+ self.add_child(Popup(popup))
+ elif popup is not None:
+ self.add_child(popup)
+
def _get_self_bounds(self):
"""
Computes the bounds of the object itself (not including it's children)
@@ -260,8 +276,30 @@ class Popup(Element):
True if the popup is a template that needs to the rendered first.
max_width: int, default 300
The maximal width of the popup.
+ show: bool, default False
+ True renders the popup open on page load.
+ sticky: bool, default False
+ True prevents map and other popup clicks from closing.
"""
- def __init__(self, html=None, parse_html=False, max_width=300):
+ _template = Template(u"""
+ var {{this.get_name()}} = L.popup({maxWidth: '{{this.max_width}}'
+ {% if this.show or this.sticky %}, autoClose: false{% endif %}
+ {% if this.sticky %}, closeOnClick: false{% endif %}});
+
+ {% for name, element in this.html._children.items() %}
+ var {{name}} = $('{{element.render(**kwargs).replace('\\n',' ')}}')[0];
+ {{this.get_name()}}.setContent({{name}});
+ {% endfor %}
+
+ {{this._parent.get_name()}}.bindPopup({{this.get_name()}})
+ {% if this.show %}.openPopup(){% endif %};
+
+ {% for name, element in this.script._children.items() %}
+ {{element.render()}}
+ {% endfor %}
+ """) # noqa
+
+ def __init__(self, html=None, parse_html=False, max_width=300, show=False, sticky=False):
super(Popup, self).__init__()
self._name = 'Popup'
self.header = Element()
@@ -280,21 +318,8 @@ def __init__(self, html=None, parse_html=False, max_width=300):
self.html.add_child(Html(text_type(html), script=script))
self.max_width = max_width
-
- self._template = Template(u"""
- var {{this.get_name()}} = L.popup({maxWidth: '{{this.max_width}}'});
-
- {% for name, element in this.html._children.items() %}
- var {{name}} = $('{{element.render(**kwargs).replace('\\n',' ')}}')[0];
- {{this.get_name()}}.setContent({{name}});
- {% endfor %}
-
- {{this._parent.get_name()}}.bindPopup({{this.get_name()}});
-
- {% for name, element in this.script._children.items() %}
- {{element.render()}}
- {% endfor %}
- """) # noqa
+ self.show = show
+ self.sticky = sticky
def render(self, **kwargs):
"""Renders the HTML representation of the element."""
@@ -330,6 +355,19 @@ class FitBounds(MacroElement):
max_zoom: int, default None
Maximum zoom to be used.
"""
+ _template = Template(u"""
+ {% macro script(this, kwargs) %}
+ {% if this.autobounds %}
+ var autobounds = L.featureGroup({{ this.features }}).getBounds()
+ {% endif %}
+
+ {{this._parent.get_name()}}.fitBounds(
+ {% if this.bounds %}{{ this.bounds }}{% else %}"autobounds"{% endif %},
+ {{ this.fit_bounds_options }}
+ );
+ {% endmacro %}
+ """) # noqa
+
def __init__(self, bounds, padding_top_left=None,
padding_bottom_right=None, padding=None, max_zoom=None):
super(FitBounds, self).__init__()
@@ -344,16 +382,3 @@ def __init__(self, bounds, padding_top_left=None,
self.fit_bounds_options = json.dumps({key: val for key, val in
options.items() if val},
sort_keys=True)
-
- self._template = Template(u"""
- {% macro script(this, kwargs) %}
- {% if this.autobounds %}
- var autobounds = L.featureGroup({{ this.features }}).getBounds()
- {% endif %}
-
- {{this._parent.get_name()}}.fitBounds(
- {% if this.bounds %}{{ this.bounds }}{% else %}"autobounds"{% endif %},
- {{ this.fit_bounds_options }}
- );
- {% endmacro %}
- """) # noqa
diff --git a/folium/plugins/__init__.py b/folium/plugins/__init__.py
index 6f09f78ad7..f34798f6fe 100644
--- a/folium/plugins/__init__.py
+++ b/folium/plugins/__init__.py
@@ -4,12 +4,13 @@
Folium plugins
--------------
-Wrap some of the most populat leaflet external plugins.
+Wrap some of the most popular leaflet external plugins.
"""
from __future__ import (absolute_import, division, print_function)
+from folium.plugins.beautify_icon import BeautifyIcon
from folium.plugins.boat_marker import BoatMarker
from folium.plugins.draw import Draw
from folium.plugins.fast_marker_cluster import FastMarkerCluster
@@ -28,6 +29,7 @@
from folium.plugins.search import Search
__all__ = [
+ 'BeautifyIcon',
'BoatMarker',
'Draw',
'FastMarkerCluster',
diff --git a/folium/plugins/beautify_icon.py b/folium/plugins/beautify_icon.py
new file mode 100644
index 0000000000..0e5243c2c9
--- /dev/null
+++ b/folium/plugins/beautify_icon.py
@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import (absolute_import, division, print_function)
+
+import json
+
+from branca.element import Figure, JavascriptLink, CssLink, MacroElement
+
+from six import iteritems
+
+from jinja2 import Template
+
+
+class BeautifyIcon(MacroElement):
+ """
+ Create a BeautifyIcon that can be added to a Marker
+
+ Parameters
+ ----------
+ icon: string, default None
+ the Font-Awesome icon name to use to render the marker.
+ icon_shape: string, default None
+ the icon shape
+ border_width: integer, default 3
+ the border width of the icon
+ border_color: string with hexadecimal RGB, default '#000'
+ the border color of the icon
+ text_color: string with hexadecimal RGB, default '#000'
+ the text color of the icon
+ background_color: string with hexadecimal RGB, default '#FFF'
+ the background color of the icon
+ inner_icon_style: string with css styles for the icon, default ''
+ the css styles of the icon
+ spin: boolean, default False
+ allow the icon to be spinning.
+ number: integer, default None
+ the number of the icon.
+
+ Examples
+ --------
+ Plugin Website: https://github.com/marslan390/BeautifyMarker
+ >>> BeautifyIcon(text_color='#000', border_color='transparent',
+ background_color='#FFF').add_to(marker)
+ >>> number_icon = BeautifyIcon(text_color='#000', border_color='transparent',
+ background_color='#FFF', number=10,
+ inner_icon_style='font-size:12px;padding-top:-5px;')
+ >>> Marker(location=[45.5, -122.3], popup=folium.Popup('Portland, OR'), icon=number_icon)
+ >>> BeautifyIcon(icon='arrow-down', icon_shape='marker').add_to(marker)
+ """
+ ICON_SHAPE_TYPES = ['circle', 'circle-dot', 'doughnut', 'rectangle-dot',
+ 'marker', None]
+
+ def __init__(self, icon=None, icon_shape=None, border_width=3, border_color='#000', text_color='#000',
+ background_color='#FFF', inner_icon_style='', spin=False,
+ number=None):
+ super(BeautifyIcon, self).__init__()
+ self._name = 'BeautifyIcon'
+
+ options = {
+ 'icon': icon,
+ 'iconShape': icon_shape,
+ 'borderWidth': border_width,
+ 'borderColor': border_color,
+ 'textColor': text_color,
+ 'backgroundColor': background_color,
+ 'innerIconStyle': inner_icon_style,
+ 'spin': spin,
+ 'isAlphaNumericIcon': number is not None,
+ 'text': number
+ }
+ # Must remove key/values where the value is None/undefined
+ options = {k: v for k, v in iteritems(options) if v is not None}
+ self.options = json.dumps(options, sort_keys=True, indent=2)
+
+ self._template = Template(u"""
+ {% macro script(this, kwargs) %}
+ var {{this.get_name()}} = new L.BeautifyIcon.icon({{ this.options }})
+ {{this._parent.get_name()}}.setIcon({{this.get_name()}});
+ {% endmacro %}
+ """)
+
+ def render(self, **kwargs):
+ super(BeautifyIcon, self).render(**kwargs)
+
+ figure = self.get_root()
+ assert isinstance(figure, Figure), ('You cannot render this Element '
+ 'if it is not in a Figure.')
+ figure.header.add_child(
+ CssLink('https://cdn.rawgit.com/marslan390/BeautifyMarker/master/leaflet-beautify-marker-icon.css'), # noqa
+ name='beautify_icon_css')
+
+ figure.header.add_child(
+ JavascriptLink('https://cdn.rawgit.com/marslan390/BeautifyMarker/master/leaflet-beautify-marker-icon.js'), # noqa
+ name='beautify_icon_js')
diff --git a/folium/plugins/boat_marker.py b/folium/plugins/boat_marker.py
index 82cf68c2f3..323d2d2ace 100644
--- a/folium/plugins/boat_marker.py
+++ b/folium/plugins/boat_marker.py
@@ -34,6 +34,19 @@ class BoatMarker(Marker):
Speed of the wind in knots.
"""
+ _template = Template(u"""
+ {% macro script(this, kwargs) %}
+ var {{this.get_name()}} = L.boatMarker(
+ [{{this.location[0]}},{{this.location[1]}}],
+ {{this.kwargs}}).addTo({{this._parent.get_name()}});
+ {% if this.wind_heading is not none -%}
+ {{this.get_name()}}.setHeadingWind({{this.heading}}, {{this.wind_speed}}, {{this.wind_heading}});
+ {% else -%}
+ {{this.get_name()}}.setHeading({{this.heading}});
+ {% endif -%}
+ {% endmacro %}
+ """) # noqa
+
def __init__(self, location, popup=None, icon=None,
heading=0, wind_heading=None, wind_speed=0, **kwargs):
super(BoatMarker, self).__init__(
@@ -47,15 +60,6 @@ def __init__(self, location, popup=None, icon=None,
self.wind_speed = wind_speed
self.kwargs = json.dumps(kwargs)
- self._template = Template(u"""
- {% macro script(this, kwargs) %}
- var {{this.get_name()}} = L.boatMarker(
- [{{this.location[0]}},{{this.location[1]}}],
- {{this.kwargs}}).addTo({{this._parent.get_name()}});
- {{this.get_name()}}.setHeadingWind({{this.heading}}, {{this.wind_speed}}, {{this.wind_heading}});
- {% endmacro %}
- """) # noqa
-
def render(self, **kwargs):
super(BoatMarker, self).render(**kwargs)
diff --git a/folium/plugins/draw.py b/folium/plugins/draw.py
index 1c3b843ec7..403e3daa97 100644
--- a/folium/plugins/draw.py
+++ b/folium/plugins/draw.py
@@ -20,12 +20,7 @@ class Draw(MacroElement):
https://leaflet.github.io/Leaflet.draw/docs/leaflet-draw-latest.html
"""
- def __init__(self, export=False):
- super(Draw, self).__init__()
- self._name = 'DrawControl'
- self.export = export
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
// FeatureGroup is to store editable layers.
var drawnItems = new L.featureGroup().addTo({{this._parent.get_name()}});
@@ -57,6 +52,11 @@ def __init__(self, export=False):
{% endmacro %}
""")
+ def __init__(self, export=False):
+ super(Draw, self).__init__()
+ self._name = 'DrawControl'
+ self.export = export
+
def render(self, **kwargs):
super(Draw, self).render()
diff --git a/folium/plugins/fast_marker_cluster.py b/folium/plugins/fast_marker_cluster.py
index 054eac4c15..b42cd281a6 100644
--- a/folium/plugins/fast_marker_cluster.py
+++ b/folium/plugins/fast_marker_cluster.py
@@ -25,33 +25,21 @@ class FastMarkerCluster(MarkerCluster):
data: list
List of list of shape [[], []]. Data points should be of
the form [[lat, lng]].
-
callback: string, default None
A string representation of a valid Javascript function
that will be passed a lat, lon coordinate pair. See the
FasterMarkerCluster for an example of a custom callback.
+ name : string, default None
+ The name of the Layer, as it will appear in LayerControls.
+ overlay : bool, default True
+ Adds the layer as an optional overlay (True) or the base layer (False).
+ control : bool, default True
+ Whether the Layer will be included in LayerControls.
+ show: bool, default True
+ Whether the layer will be shown on opening (only for overlays).
"""
- def __init__(self, data, callback=None):
- super(FastMarkerCluster, self).__init__([])
- self._name = 'FastMarkerCluster'
- self._data = _validate_coordinates(data)
-
- if callback is None:
- self._callback = ('var callback;\n' +
- 'callback = function (row) {\n' +
- '\tvar icon, marker;\n' +
- '\t// Returns a L.marker object\n' +
- '\ticon = L.AwesomeMarkers.icon();\n' +
- '\tmarker = L.marker(new L.LatLng(row[0], ' +
- 'row[1]));\n' +
- '\tmarker.setIcon(icon);\n' +
- '\treturn marker;\n' +
- '};')
- else:
- self._callback = 'var callback = {};'.format(callback)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
{{this._callback}}
@@ -69,3 +57,24 @@ def __init__(self, data, callback=None):
cluster.addTo(map);
})();
{% endmacro %}""")
+
+ def __init__(self, data, callback=None,
+ name=None, overlay=True, control=True, show=True):
+ super(FastMarkerCluster, self).__init__(name=name, overlay=overlay,
+ control=control, show=show)
+ self._name = 'FastMarkerCluster'
+ self._data = _validate_coordinates(data)
+
+ if callback is None:
+ self._callback = ('var callback;\n' +
+ 'callback = function (row) {\n' +
+ '\tvar icon, marker;\n' +
+ '\t// Returns a L.marker object\n' +
+ '\ticon = L.AwesomeMarkers.icon();\n' +
+ '\tmarker = L.marker(new L.LatLng(row[0], ' +
+ 'row[1]));\n' +
+ '\tmarker.setIcon(icon);\n' +
+ '\treturn marker;\n' +
+ '};')
+ else:
+ self._callback = 'var callback = {};'.format(callback)
diff --git a/folium/plugins/float_image.py b/folium/plugins/float_image.py
index cb9468676b..91c58fb0b0 100644
--- a/folium/plugins/float_image.py
+++ b/folium/plugins/float_image.py
@@ -9,14 +9,7 @@
class FloatImage(MacroElement):
"""Adds a floating image in HTML canvas on top of the map."""
- def __init__(self, image, bottom=75, left=75):
- super(FloatImage, self).__init__()
- self._name = 'FloatImage'
- self.image = image
- self.bottom = bottom
- self.left = left
-
- self._template = Template("""
+ _template = Template("""
{% macro header(this,kwargs) %}
+
-
-
diff --git a/folium/vector_layers.py b/folium/vector_layers.py
index 8c2d979187..70322e9de6 100644
--- a/folium/vector_layers.py
+++ b/folium/vector_layers.py
@@ -153,14 +153,7 @@ class PolyLine(Marker):
http://leafletjs.com/reference-1.2.0.html#polyline
"""
- def __init__(self, locations, popup=None, tooltip=None, **kwargs):
- super(PolyLine, self).__init__(location=locations, popup=popup)
- self._name = 'PolyLine'
- self.tooltip = tooltip
-
- self.options = _parse_options(line=True, **kwargs)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.polyline(
{{this.location}},
@@ -171,6 +164,13 @@ def __init__(self, locations, popup=None, tooltip=None, **kwargs):
{% endmacro %}
""") # noqa
+ def __init__(self, locations, popup=None, tooltip=None, **kwargs):
+ super(PolyLine, self).__init__(location=locations, popup=popup)
+ self._name = 'PolyLine'
+ self.tooltip = tooltip
+
+ self.options = _parse_options(line=True, **kwargs)
+
class Polygon(Marker):
"""
@@ -193,14 +193,7 @@ class Polygon(Marker):
http://leafletjs.com/reference-1.2.0.html#polygon
"""
- def __init__(self, locations, popup=None, tooltip=None, **kwargs):
- super(Polygon, self).__init__(locations, popup=popup)
- self._name = 'Polygon'
- self.tooltip = tooltip
-
- self.options = _parse_options(line=True, **kwargs)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.polygon(
@@ -212,6 +205,13 @@ def __init__(self, locations, popup=None, tooltip=None, **kwargs):
{% endmacro %}
""")
+ def __init__(self, locations, popup=None, tooltip=None, **kwargs):
+ super(Polygon, self).__init__(locations, popup=popup)
+ self._name = 'Polygon'
+ self.tooltip = tooltip
+
+ self.options = _parse_options(line=True, **kwargs)
+
class Rectangle(Marker):
"""
@@ -234,14 +234,7 @@ class Rectangle(Marker):
http://leafletjs.com/reference-1.2.0.html#rectangle
"""
- def __init__(self, bounds, popup=None, tooltip=None, **kwargs):
- super(Rectangle, self).__init__(location=bounds, popup=popup)
- self._name = 'rectangle'
- self.tooltip = tooltip
-
- self.options = _parse_options(line=True, **kwargs)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.rectangle(
@@ -253,6 +246,13 @@ def __init__(self, bounds, popup=None, tooltip=None, **kwargs):
{% endmacro %}
""")
+ def __init__(self, bounds, popup=None, tooltip=None, **kwargs):
+ super(Rectangle, self).__init__(location=bounds, popup=popup)
+ self._name = 'rectangle'
+ self.tooltip = tooltip
+
+ self.options = _parse_options(line=True, **kwargs)
+
class Circle(Marker):
"""
@@ -280,14 +280,7 @@ class Circle(Marker):
http://leafletjs.com/reference-1.2.0.html#circle
"""
- def __init__(self, location, radius, popup=None, tooltip=None, **kwargs):
- super(Circle, self).__init__(location=location, popup=popup)
- self._name = 'circle'
- self.tooltip = tooltip
-
- self.options = _parse_options(line=False, radius=radius, **kwargs)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.circle(
@@ -299,6 +292,13 @@ def __init__(self, location, radius, popup=None, tooltip=None, **kwargs):
{% endmacro %}
""")
+ def __init__(self, location, radius, popup=None, tooltip=None, **kwargs):
+ super(Circle, self).__init__(location=location, popup=popup)
+ self._name = 'circle'
+ self.tooltip = tooltip
+
+ self.options = _parse_options(line=False, radius=radius, **kwargs)
+
class CircleMarker(Marker):
"""
@@ -321,14 +321,7 @@ class CircleMarker(Marker):
http://leafletjs.com/reference-1.2.0.html#circlemarker
"""
- def __init__(self, location, radius=10, popup=None, tooltip=None, **kwargs):
- super(CircleMarker, self).__init__(location=location, popup=popup)
- self._name = 'CircleMarker'
- self.tooltip = tooltip
-
- self.options = _parse_options(line=False, radius=radius, **kwargs)
-
- self._template = Template(u"""
+ _template = Template(u"""
{% macro script(this, kwargs) %}
var {{this.get_name()}} = L.circleMarker(
[{{this.location[0]}}, {{this.location[1]}}],
@@ -338,3 +331,10 @@ def __init__(self, location, radius=10, popup=None, tooltip=None, **kwargs):
.addTo({{this._parent.get_name()}});
{% endmacro %}
""")
+
+ def __init__(self, location, radius=10, popup=None, tooltip=None, **kwargs):
+ super(CircleMarker, self).__init__(location=location, popup=popup)
+ self._name = 'CircleMarker'
+ self.tooltip = tooltip
+
+ self.options = _parse_options(line=False, radius=radius, **kwargs)
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 0acac8c906..ff66d34bff 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -21,4 +21,5 @@ pycodestyle
pytest
selenium
sphinx
+vega_datasets
vincent
diff --git a/tests/plugins/test_beautify_icon.py b/tests/plugins/test_beautify_icon.py
new file mode 100644
index 0000000000..b9ba88b923
--- /dev/null
+++ b/tests/plugins/test_beautify_icon.py
@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+
+"""
+Test BeautifyIcon
+---------------
+
+"""
+
+from __future__ import (absolute_import, division, print_function)
+
+from jinja2 import Template
+
+import folium
+
+from folium import plugins
+
+
+def test_beautify_icon():
+ m = folium.Map([30., 0.], zoom_start=3)
+ # BeautifyIcons
+ ic1 = plugins.BeautifyIcon(
+ icon='plane', border_color='#b3334f', text_color='#b3334f')
+ ic2 = plugins.BeautifyIcon(border_color='#00ABDC',
+ text_color='#00ABDC',
+ number=10,
+ inner_icon_style='margin-top:0;')
+
+ # Markers, add icons as keyword argument
+ bm1 = folium.Marker(location=[46, -122],
+ popup='Portland, OR',
+ icon=ic1
+ ).add_to(m)
+
+ bm2 = folium.Marker(
+ location=[50, -121],
+ icon=ic2
+ ).add_to(m)
+
+ m.add_child(bm1)
+ m.add_child(bm2)
+ m._repr_html_()
+
+ out = m._parent.render()
+
+ # We verify that the script import is present.
+ script = '' # noqa
+ assert script in out
+
+ # We verify that the css import is present.
+ css = 'Some text.
\')[0];
+ {popup_name}.setContent({html_name});
+ {map_name}.bindPopup({popup_name});
+ """.format(popup_name=popup.get_name(),
+ html_name=list(popup.html._children.keys())[0],
+ map_name=m.get_name())
+ assert _normalize(rendered) == _normalize(expected)
+
+
+def test_popup_show():
+ m = Map()
+ popup = Popup('Some text.', show=True).add_to(m)
+ rendered = popup._template.render(this=popup, kwargs={})
+ expected = """
+ var {popup_name} = L.popup({{maxWidth: \'300\' , autoClose: false}});
+ var {html_name} = $(\'Some text.
\')[0];
+ {popup_name}.setContent({html_name});
+ {map_name}.bindPopup({popup_name}).openPopup();
+ """.format(popup_name=popup.get_name(),
+ html_name=list(popup.html._children.keys())[0],
+ map_name=m.get_name())
+ assert _normalize(rendered) == _normalize(expected)
diff --git a/tests/test_raster_layers.py b/tests/test_raster_layers.py
index 631c76a18f..c3813c7a59 100644
--- a/tests/test_raster_layers.py
+++ b/tests/test_raster_layers.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""
-Test ImageOverlay
+Test raster_layers
-----------------
"""
@@ -36,6 +36,15 @@ def test_tile_layer():
assert bounds == [[None, None], [None, None]], bounds
+def _is_working_zoom_level(zoom, tiles, session):
+ """Check if the zoom level works for the given tileset."""
+ url = tiles.format(s='a', x=0, y=0, z=zoom)
+ response = session.get(url, timeout=5)
+ if response.status_code < 400:
+ return True
+ return False
+
+
def test_custom_tile_subdomains():
"""Test custom tile subdomains."""