Merge pull request #627 from soymsk/add-style-for-timestamped-geojson

Add style for timestamped geojson

Author: ocefpaf

CHANGES.txt

@@ -1,6 +1,7 @@
 0.3.0
 ~~~~~
 
+- Added style option to 'Timestamped geojson' plugin (soymsk #627)
 - Switched to `leaflet 1.0.1` (juoceano #531 and ocefpaf #535)
 - Added `continuous_world`, `world_copy_jump`, and `no_wrap` options (ocefpaf #508)
 - Update font-awesome to 4.6.3 (ocefpaf #478)

examples/Plugins.ipynb

@@ -277,6 +277,104 @@
     "\n",
     "m  # Click on the top right button."
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "##  Timestamped GeoJSON"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "from folium import plugins\n",
+    "\n",
+    "m = folium.Map(location=[35.68159659061569, 139.76451516151428], zoom_start=16)\n",
+    "\n",
+    "lines = [\n",
+    "    {\n",
+    "        \"coordinates\": [\n",
+    "            [139.76451516151428, 35.68159659061569], # Lon, Lat\n",
+    "            [139.75964426994324, 35.682590062684206],\n",
+    "        ],\n",
+    "        \"dates\": [\n",
+    "            \"2017-06-02T00:00:00\",\n",
+    "            \"2017-06-02T00:10:00\"\n",
+    "        ],\n",
+    "        \"color\": \"red\"\n",
+    "    },\n",
+    "    {\n",
+    "        \"coordinates\": [\n",
+    "            [139.75964426994324, 35.682590062684206],\n",
+    "            [139.7575843334198, 35.679505030038506],\n",
+    "        ],\n",
+    "        \"dates\": [\n",
+    "            \"2017-06-02T00:10:00\",\n",
+    "            \"2017-06-02T00:20:00\"\n",
+    "        ],\n",
+    "        \"color\": \"blue\"\n",
+    "    },\n",
+    "    {\n",
+    "        \"coordinates\": [\n",
+    "            [139.7575843334198, 35.679505030038506],\n",
+    "            [139.76337790489197, 35.678040905014065],\n",
+    "        ],\n",
+    "        \"dates\": [\n",
+    "            \"2017-06-02T00:20:00\",\n",
+    "            \"2017-06-02T00:30:00\"\n",
+    "        ],\n",
+    "        \"color\": \"green\",\n",
+    "        \"weight\": 15,\n",
+    "    },\n",
+    "    {\n",
+    "        \"coordinates\": [\n",
+    "            [139.76337790489197, 35.678040905014065],\n",
+    "            [139.76451516151428, 35.68159659061569],\n",
+    "        ],\n",
+    "        \"dates\": [\n",
+    "            \"2017-06-02T00:30:00\",\n",
+    "            \"2017-06-02T00:40:00\"\n",
+    "        ],\n",
+    "        \"color\": \"#FFFFFF\",\n",
+    "    },\n",
+    "    \n",
+    "]\n",
+    "\n",
+    "\n",
+    "features = [\n",
+    "    {\n",
+    "        \"type\": \"Feature\",\n",
+    "        \"geometry\": {\n",
+    "            \"type\": \"LineString\",\n",
+    "            \"coordinates\": line[\"coordinates\"],\n",
+    "        },\n",
+    "        \"properties\": {\n",
+    "            \"times\": line[\"dates\"],\n",
+    "            \"style\": {\n",
+    "                \"color\":  line[\"color\"],\n",
+    "                \"weight\": line[\"weight\"] if \"weight\" in line else 5\n",
+    "            }\n",
+    "        }\n",
+    "    }\n",
+    "for line in lines]\n",
+    "\n",
+    "\n",
+    "plugins.TimestampedGeoJson({\n",
+    "    \"type\": \"FeatureCollection\",\n",
+    "    \"features\": features,\n",
+    "}, period=\"PT1M\", add_last_point=True).add_to(m)\n",
+    "\n",
+    "\n",
+    "m.save(os.path.join('results', 'Plugins_5.html'))\n",
+    "\n",
+    "m"
+   ]
   }
  ],
  "metadata": {

folium/plugins/timestamped_geo_json.py

@@ -27,7 +27,7 @@
 
 
 class TimestampedGeoJson(MacroElement):
-    def __init__(self, data, transition_time=200, loop=True, auto_play=True,
+    def __init__(self, data, transition_time=200, loop=True, auto_play=True, add_last_point=True,
                  period="P1D"):
         """Creates a TimestampedGeoJson plugin to append into a map with
         Map.add_child.
@@ -82,6 +82,8 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True,
             Whether the animation shall loop.
         auto_play : bool, default True
             Whether the animation shall start automatically at startup.
+        add_last_point: bool, default True
+            Whether a point is added at the last valid coordinate of a LineString.
         period : str, default "P1D"
             Used to construct the array of available times starting
             from the first available time. Format: ISO8601 Duration
@@ -106,6 +108,7 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True,
         self.transition_time = int(transition_time)
         self.loop = bool(loop)
         self.auto_play = bool(auto_play)
+        self.add_last_point = bool(add_last_point)
         self.period = period
 
         self._template = Template("""
@@ -121,8 +124,10 @@ def __init__(self, data, transition_time=200, loop=True, auto_play=True,
             {{this._parent.get_name()}}.addControl({{this._parent.get_name()}}.timeDimensionControl);
 
             var {{this.get_name()}} = L.timeDimension.layer.geoJson(
-                L.geoJson({{this.data}}),
-                {updateTimeDimension: true,addlastPoint: true}
+                L.geoJson({{this.data}}, {'style': function (feature) {
+                    return feature.properties.style
+                }}),
+                {updateTimeDimension: true,addlastPoint: {{'true' if this.add_last_point else 'false'}}}
                 ).addTo({{this._parent.get_name()}});
         {% endmacro %}
         """)  # noqa

tests/plugins/test_timestamped_geo_json.py

@@ -50,8 +50,11 @@ def test_timestamped_geo_json():
                         },
                     "properties": {
                         "times": [1435708800000+i*86400000 for
-                                  i in np.linspace(0, 25, 25)]
-                        }
+                                  i in np.linspace(0, 25, 25)],
+                        "style": {
+                            "color": "red"
+                            },
+                        },
                     },
                 {
                     "type": "Feature",
@@ -123,8 +126,10 @@ def test_timestamped_geo_json():
         {{this._parent.get_name()}}.addControl({{this._parent.get_name()}}.timeDimensionControl);
 
         var {{this.get_name()}} = L.timeDimension.layer.geoJson(
-            L.geoJson({{this.data}}),
-            {updateTimeDimension: true,addlastPoint: true}
+            L.geoJson({{this.data}}, {'style': function (feature) {
+                return feature.properties.style
+            }}),
+            {updateTimeDimension: true,addlastPoint: {{'true' if this.add_last_point else 'false'}}}
             ).addTo({{this._parent.get_name()}});
     """)  # noqa