SideBySideLayers plugin minor updates

Author: Lo Conti Francesco

examples/SideBySideLayers.ipynb

@@ -0,0 +1,121 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# SideBySideLayers Demo"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import folium\n",
+    "from folium.plugins import SideBySideLayers"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "create a map and two layers"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m = folium.Map(location=(30, 20), zoom_start=4)\n",
+    "\n",
+    "layer_right = folium.TileLayer('openstreetmap')\n",
+    "layer_left = folium.TileLayer('cartodbpositron')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "create an instance of `SideBySideLayers` based on two"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "sbs = SideBySideLayers(layer_left=layer_left, layer_right=layer_right)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "add layers and SideBySideLayers instance to the map"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "layer_left.add_to(m)\n",
+    "layer_right.add_to(m)\n",
+    "sbs.add_to(m)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m.save(os.path.join('results', 'SideBySide.html'))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

folium/plugins/__init__.py

@@ -29,6 +29,7 @@
 from folium.plugins.polyline_text_path import PolyLineTextPath
 from folium.plugins.scroll_zoom_toggler import ScrollZoomToggler
 from folium.plugins.search import Search
+from folium.plugins.side_by_side import SideBySideLayers
 from folium.plugins.terminator import Terminator
 from folium.plugins.time_slider_choropleth import TimeSliderChoropleth
 from folium.plugins.timestamped_geo_json import TimestampedGeoJson
@@ -56,6 +57,7 @@
     'PolyLineOffset',
     'ScrollZoomToggler',
     'Search',
+    'SideBySideLayers',
     'StripePattern',
     'Terminator',
     'TimeSliderChoropleth',

folium/plugins/side_by_side.py

@@ -11,6 +11,9 @@ class SideBySideLayers(Layer):
     """
     Creates a SideBySideLayers that takes two Layers and adds a sliding
     control with the leaflet-side-by-side plugin.
+
+    Uses the Leaflet leaflet-side-by-side plugin https://github.com/digidem/leaflet-side-by-side
+
     Parameters
     ----------
     layer_left: Layer.
@@ -29,30 +32,8 @@ class SideBySideLayers(Layer):
         Whether the layer will be shown on opening (only for overlays).
     Examples
     --------
-    >>> layer_left = WmsTileLayer(
-    ...          'http://this.wms.server/ncWMS/wms',
-    ...          name='Test WMS Data',
-    ...          styles='',
-    ...          fmt='image/png',
-    ...          transparent=True,
-    ...          layers='test_data',
-    ...          COLORSCALERANGE='0,10',
-    ...)
-    >>> layer_left.add_to(m)
-    >>> layer_right = WmsTileLayer(
-    ...          'http://this.wms.server/ncWMS/wms',
-    ...          name='Test WMS Data',
-    ...          styles='',
-    ...          fmt='image/png',
-    ...          transparent=True,
-    ...          layers='test_data_2',
-    ...          COLORSCALERANGE='0,5',
-    ...)
-    >>> layer_right.add_to(m)
-    >>> # Add layers to sidebyside control.
     >>> sidebyside = SideBySideLayers(layer_left, layer_right)
     >>> sidebyside.add_to(m)
-    See https://github.com/digidem/leaflet-side-by-side for more information.
     """
 
     _template = Template(u"""
@@ -80,5 +61,5 @@ def render(self, **kwargs):
                                             'if it is not in a Figure.')
 
         figure.header.add_child(
-            JavascriptLink('http://lab.digital-democracy.org/leaflet-side-by-side/leaflet-side-by-side.js'),  # noqa
+            JavascriptLink('https://raw.githack.com/digidem/leaflet-side-by-side/gh-pages/leaflet-side-by-side.js'),  # noqa
             name='leaflet.sidebyside')