Skip to content

Commit 1785246

Browse files
committed
docstring
1 parent dda6884 commit 1785246

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

folium/plugins/time_slider_choropleth.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# -*- coding: utf-8 -*-
2+
3+
from __future__ import (absolute_import, division, print_function)
4+
15
import json
26

37
from branca.element import Figure, JavascriptLink
@@ -8,6 +12,18 @@
812

913

1014
class TimeSliderChoropleth(GeoJson):
15+
"""
16+
Creates a TimeSliderChoropleth plugin to append into a map with Map.add_child.
17+
18+
Parameters
19+
----------
20+
data: str
21+
geojson string
22+
styledict: dict
23+
A dictionary where the keys are the geojson feature ids and the values are
24+
dicts of `{time: style_options_dict}`
25+
26+
"""
1127
def __init__(self, data, styledict, name=None, overlay=True, control=True, **kwargs):
1228
super(TimeSliderChoropleth, self).__init__(data, name=name, overlay=overlay, control=control)
1329
if not isinstance(styledict, dict):

0 commit comments

Comments
 (0)