deploy: 5c46067

Author: hansthen

dev/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 746a5c174d832fe57a33653256ee354d
+config: ee496d47809d0ed0a4a0667bf32939ba
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_images/user_guide_plugins_timeslider_choropleth_12_0.png

@@ -15,3 +15,4 @@ Advanced guide
   advanced_guide/piechart_icons
   advanced_guide/polygons_from_list_of_points
   advanced_guide/customize_javascript_and_css
+  advanced_guide/override_leaflet_class_methods

dev/_sources/advanced_guide.rst.txt

@@ -0,0 +1,46 @@
+# Overriding Leaflet class methods
+
+```{code-cell} ipython3
+---
+nbsphinx: hidden
+---
+import folium
+```
+
+## Customizing Leaflet behavior
+Sometimes you want to override Leaflet's javascript behavior. This can be done using the `Class.include` statement. This mimics Leaflet's
+`L.Class.include` method. See [here](https://leafletjs.com/examples/extending/extending-1-classes.html) for more details.
+
+### Example: adding an authentication header to a TileLayer
+One such use case is if you need to override the `createTile` on `L.TileLayer`, because your tiles are hosted on an oauth2 protected
+server. This can be done like this:
+
+```{code-cell}
+create_tile = folium.JsCode("""
+    function(coords, done) {
+        const url = this.getTileUrl(coords);
+        const img = document.createElement('img');
+        fetch(url, {
+          headers: {
+            "Authorization": "Bearer <Token>"
+          },
+        })
+        .then((response) => {
+            img.src = URL.createObjectURL(response.body);
+            done(null, img);
+        })
+        return img;
+    }
+""")
+
+folium.TileLayer.include(create_tile=create_tile)
+tiles = folium.TileLayer(
+    tiles="OpenStreetMap",
+)
+m = folium.Map(
+    tiles=tiles,
+)
+
+
+m = folium.Map()
+```

dev/_sources/advanced_guide/override_leaflet_class_methods.md.txt

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.19.8.dev11+g2de8ff26',
+    VERSION: '0.19.8.dev12+g5c460674',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

dev/_static/documentation_options.js

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Advanced guide &#8212; Folium 0.19.8.dev11+g2de8ff26 documentation</title>
+    <title>Advanced guide &#8212; Folium 0.19.8.dev12+g5c460674 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
 
-    <script src="_static/documentation_options.js?v=3f4800b0"></script>
+    <script src="_static/documentation_options.js?v=59c9ee81"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -57,7 +57,7 @@
     <link rel="prev" title="TimestampedWmsTileLayers" href="user_guide/plugins/WmsTimeDimension.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.19.8.dev11+g2de8ff26" />
+  <meta name="docsearch:version" content="0.19.8.dev12+g5c460674" />
   </head>
 
 
@@ -373,6 +373,7 @@
 <li class="toctree-l1"><a class="reference internal" href="advanced_guide/piechart_icons.html">Piechart icons</a></li>
 <li class="toctree-l1"><a class="reference internal" href="advanced_guide/polygons_from_list_of_points.html">Creating a polygon from a list of points</a></li>
 <li class="toctree-l1"><a class="reference internal" href="advanced_guide/customize_javascript_and_css.html">Customizing javascript or css resources</a></li>
+<li class="toctree-l1"><a class="reference internal" href="advanced_guide/override_leaflet_class_methods.html">Overriding Leaflet class methods</a></li>
 </ul>
 </div>
 </nav></div>
@@ -445,6 +446,7 @@ <h1>Advanced guide<a class="headerlink" href="#advanced-guide" title="Link to th
 <li class="toctree-l1"><a class="reference internal" href="advanced_guide/piechart_icons.html">Piechart icons</a></li>
 <li class="toctree-l1"><a class="reference internal" href="advanced_guide/polygons_from_list_of_points.html">Creating a polygon from a list of points</a></li>
 <li class="toctree-l1"><a class="reference internal" href="advanced_guide/customize_javascript_and_css.html">Customizing javascript or css resources</a></li>
+<li class="toctree-l1"><a class="reference internal" href="advanced_guide/override_leaflet_class_methods.html">Overriding Leaflet class methods</a></li>
 </ul>
 </div>
 </section>
@@ -519,7 +521,7 @@ <h3>This Page</h3>
     <div class="footer-items__start">
 
         <div class="footer-item"><!-- This will display the version of the docs -->
-Folium version 0.19.8.dev11+g2de8ff26</div>
+Folium version 0.19.8.dev12+g5c460674</div>
 
         <div class="footer-item">