Skip to content

Commit 0ab9d8d

Browse files
acrosbyacrosby
committed
add example ipynb, fix quoted kwarg constructor style
1 parent a32370c commit 0ab9d8d

3 files changed

Lines changed: 116 additions & 2 deletions

File tree

‎examples/WmsTimeDimension.ipynb‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "code",
5+
"execution_count": 2,
6+
"metadata": {
7+
"collapsed": false,
8+
"deletable": true,
9+
"editable": true
10+
},
11+
"outputs": [
12+
{
13+
"name": "stdout",
14+
"output_type": "stream",
15+
"text": [
16+
"0.4.0.dev0\n"
17+
]
18+
}
19+
],
20+
"source": [
21+
"import os\n",
22+
"import folium\n",
23+
"from folium import features, plugins\n",
24+
"import datetime\n",
25+
"print(folium.__version__)"
26+
]
27+
},
28+
{
29+
"cell_type": "code",
30+
"execution_count": 14,
31+
"metadata": {
32+
"collapsed": false,
33+
"deletable": true,
34+
"editable": true
35+
},
36+
"outputs": [
37+
{
38+
"data": {
39+
"text/html": [
40+
"<div style=\"width:100%;\"><div style=\"position:relative;width:100%;height:0;padding-bottom:60%;\"><iframe src=\"data:text/html;charset=utf-8;base64,<!DOCTYPE html>
<head>    
    <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
    <script>L_PREFER_CANVAS = false; L_NO_TOUCH = false; L_DISABLE_3D = false;</script>
    <script src="https://unpkg.com/leaflet@1.0.1/dist/leaflet.js"></script>
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/Leaflet.awesome-markers/2.0.2/leaflet.awesome-markers.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/1.0.0/leaflet.markercluster-src.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/1.0.0/leaflet.markercluster.js"></script>
    <link rel="stylesheet" href="https://unpkg.com/leaflet@1.0.1/dist/leaflet.css" />
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" />
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap-theme.min.css" />
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" />
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/Leaflet.awesome-markers/2.0.2/leaflet.awesome-markers.css" />
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/1.0.0/MarkerCluster.Default.css" />
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet.markercluster/1.0.0/MarkerCluster.css" />
    <link rel="stylesheet" href="https://rawgit.com/python-visualization/folium/master/folium/templates/leaflet.awesome.rotate.css" />
    <style>html, body {width: 100%;height: 100%;margin: 0;padding: 0;}</style>
    <style>#map {position:absolute;top:0;bottom:0;right:0;left:0;}</style>
    
            <style> #map_32b71949700e4f6585a637e8a4993f34 {
                position : relative;
                width : 100.0%;
                height: 100.0%;
                left: 0.0%;
                top: 0.0%;
                }
            </style>
        
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.10.2/jquery-ui.min.js"></script>
    <script src="https://rawgit.com/nezasa/iso8601-js-period/master/iso8601.min.js"></script>
    <script src="https://rawgit.com/socib/Leaflet.TimeDimension/master/dist/leaflet.timedimension.min.js"></script>
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/default.min.css" />
    <link rel="stylesheet" href="http://apps.socib.es/Leaflet.TimeDimension/dist/leaflet.timedimension.control.min.css" />
</head>
<body>    
    
            <div class="folium-map" id="map_32b71949700e4f6585a637e8a4993f34" ></div>
        
</body>
<script>    
    

            
                var southWest = L.latLng(-90, -180);
                var northEast = L.latLng(90, 180);
                var bounds = L.latLngBounds(southWest, northEast);
            

            var map_32b71949700e4f6585a637e8a4993f34 = L.map(
                                  'map_32b71949700e4f6585a637e8a4993f34',
                                  {center: [60,-145],
                                  zoom: 6,
                                  maxBounds: bounds,
                                  layers: [],
                                  worldCopyJump: false,
                                  crs: L.CRS.EPSG3857
                                 });
            L.control.scale().addTo(map_32b71949700e4f6585a637e8a4993f34);
        
    
            var tile_layer_6922d963a1f14dd9bf821191639e9b45 = L.tileLayer(
                'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
                {
                    maxZoom: 18,
                    minZoom: 1,
                    continuousWorld: false,
                    noWrap: false,
                    attribution: 'Data by <a href="http://openstreetmap.org">OpenStreetMap</a>, under <a href="http://www.openstreetmap.org/copyright">ODbL</a>.',
                    detectRetina: false,
                    subdomains: 'abc'
                    }
                ).addTo(map_32b71949700e4f6585a637e8a4993f34);

        
    
            var macro_element_f772e54698bd41efa04d8240cb0da26d = L.tileLayer.wms(
                'https://data.axds.co/ncWMS/wms',
                {
                    
                    COLORSCALERANGE: '0,2',
                    
                    layers: 'TAMU_SWAN_PWS/Hs',
                    styles: 'boxfill/rainbow',
                    format: 'image/png',
                    transparent: true,
                    version: '1.1.1',
                    
                    }
                ).addTo(map_32b71949700e4f6585a637e8a4993f34);

        
    
            map_32b71949700e4f6585a637e8a4993f34.timeDimension = L.timeDimension({
                period:"PT3H",
                
                timeInterval: "2011-12-16T19:00/2013-09-13T08:00",
                
                });
            map_32b71949700e4f6585a637e8a4993f34.timeDimensionControl = L.control.timeDimension({
                position: 'bottomleft',
                autoPlay: false,
                playerOptions: {
                    transitionTime: 200,
                    loop: false}
                    });
            map_32b71949700e4f6585a637e8a4993f34.addControl(map_32b71949700e4f6585a637e8a4993f34.timeDimensionControl);

            
            var macro_element_f772e54698bd41efa04d8240cb0da26d = L.timeDimension.layer.wms(macro_element_f772e54698bd41efa04d8240cb0da26d,
                {updateTimeDimension: false,
                 wmsVersion: '1.1.1',
                }
                ).addTo(map_32b71949700e4f6585a637e8a4993f34);
            
        
    
            var layer_control_73f0c0329a894ce681badafe02fc8661 = {
                base_layers : { "openstreetmap" : tile_layer_6922d963a1f14dd9bf821191639e9b45, },
                overlays : { "AOOS HS" : macro_element_f772e54698bd41efa04d8240cb0da26d, }
                };
            L.control.layers(
                layer_control_73f0c0329a894ce681badafe02fc8661.base_layers,
                layer_control_73f0c0329a894ce681badafe02fc8661.overlays,
                {position: 'topright',
                 collapsed: true,
                 autoZIndex: true
                }).addTo(map_32b71949700e4f6585a637e8a4993f34);
        
</script>\" style=\"position:absolute;width:100%;height:100%;left:0;top:0;border:none !important;\" allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe></div></div>"
41+
],
42+
"text/plain": [
43+
"<folium.folium.Map at 0x7fad6d926a50>"
44+
]
45+
},
46+
"execution_count": 14,
47+
"metadata": {},
48+
"output_type": "execute_result"
49+
}
50+
],
51+
"source": [
52+
"m = folium.Map([60, -145],\n",
53+
" zoom_start=6, \n",
54+
" control_scale=True)\n",
55+
"\n",
56+
"server = \"https://data.axds.co/ncWMS/wms\"\n",
57+
"w = []\n",
58+
"\n",
59+
"w.append(features.WmsTileLayer(\n",
60+
" server,\n",
61+
" name=\"AOOS HS\",\n",
62+
" styles=\"boxfill/rainbow\",\n",
63+
" format=\"image/png\",\n",
64+
" transparent=True,\n",
65+
" layers=\"TAMU_SWAN_PWS/Hs\",\n",
66+
" COLORSCALERANGE=\"0,2\",\n",
67+
"))\n",
68+
"\n",
69+
"for wi in w:\n",
70+
" wi.add_to(m)\n",
71+
"\n",
72+
"time = plugins.TimestampedWmsTileLayers(w, period=\"PT3H\", time_interval=\"2011-12-16T19:00/2013-09-13T08:00\")\n",
73+
"time.add_to(m)\n",
74+
"\n",
75+
"\n",
76+
"folium.LayerControl().add_to(m)\n",
77+
"\n",
78+
"\n",
79+
"m\n",
80+
"\n"
81+
]
82+
},
83+
{
84+
"cell_type": "code",
85+
"execution_count": null,
86+
"metadata": {
87+
"collapsed": true
88+
},
89+
"outputs": [],
90+
"source": []
91+
}
92+
],
93+
"metadata": {
94+
"kernelspec": {
95+
"display_name": "Python 2",
96+
"language": "python",
97+
"name": "python2"
98+
},
99+
"language_info": {
100+
"codemirror_mode": {
101+
"name": "ipython",
102+
"version": 2
103+
},
104+
"file_extension": ".py",
105+
"mimetype": "text/x-python",
106+
"name": "python",
107+
"nbconvert_exporter": "python",
108+
"pygments_lexer": "ipython2",
109+
"version": "2.7.12"
110+
}
111+
},
112+
"nbformat": 4,
113+
"nbformat_minor": 2
114+
}

‎folium/plugins/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@
2929
'Fullscreen',
3030
'PolyLineTextPath',
3131
'FloatImage',
32-
'TimestampedWmsTileLayer'
32+
'TimestampedWmsTileLayers'
3333
]

‎folium/plugins/timestamped_wmstilelayer.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
class TimestampedWmsTileLayers(Layer):
3030
def __init__(self, data, transition_time=200, loop=False, auto_play=False,
31-
period="P1D", time_interval=False):
31+
period='P1D', time_interval=False):
3232
"""Creates a TimestampedWmsTileLayer subclass of Layer that takes a
3333
WmsTileLayer and adds time control with the Leaflet.TimeDimension
3434
plugin.

0 commit comments

Comments
 (0)