python-visualization / python-visualization/folium

Request Adding Leaflet.TileLayer.MBTiles Plugin Support

Offen
#1,318 4 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

  • #1341 von @and-viceversa — ohne Merge geschlossen
enhancement plugin
Vorherrschende Sprache
Python
Sterne
7.4k
Forks
2.3k
Ø Merge
17 Std. 22 Min.
Gemergte PRs (30 T.)
11

Beschreibung

Is your feature request related to a problem? Please describe.
No. This feature request adds support for displaying raster tile base maps in .mbtiles format.

Describe the solution you'd like

  1. Make Leaflet.TileLayer.MBTiles it's own Folium plugin.
  2. Put the above plugin on a CDN so users aren't forced to store it locally. The original author's CDN link is broken I think.

Currently, you can use Folium and Leaflet.TileLayer.MBTiles to display .mbtiles format, but it's a bit hacky.

I used roughly the following snippet to override TileLayer._template

    # override defaults to use the plugin
    folium.raster_layers.TileLayer._template = Template(u"""
        {% macro script(this, kwargs) %}
            var {{ this.get_name() }} = L.tileLayer.mbTiles(         <--------
                {{ this.tiles|tojson }},
                {{ this.options|tojson }}
            ).addTo({{ this._parent.get_name() }});
        {% endmacro %}
        """)

   # make a Map with .mbtile basemap 
   m = folium.Map(
        location=[35.650787, -117.661728], 
        tiles='my_tiles.mbtiles', 
        attr=attr
    )

    # add open street map
    layer = folium.TileLayer(
        tiles='https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
        name='OpenStreetMap Online',
        attr='&copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> '
             'contributors',
        overlay=True,
        control=True,
        show=False
    ).add_to(m)

    # function to return _template back to default after the fact.
    set_tile_layer_default(layer)

Even then, you have to override TileLayer._template back to it's default before m.save('index.html') for each additional (non-mbtiles) basemap you add.

It would be really nice to:

from folium.plugins import MBTiles

m = MBTiles.Map(
    location = [14.0, 15.0],
    tiles = 'your_tiles_url.mbtiles',
    attr = 'attr text'
)

Describe alternatives you've considered
The only alternative I can see is something like the above snippet. There was some discussion in #351.

Additional context
For those unfamiliar, one open source way to make your own tiles is by using TileMill. TileMill exports the usual {z}{x}{y} directory structure, as well as the Mapbox raster .mbtiles format. Mbtiles are preferable in some cases, because you only have to manage 1 file instead of (no joke) millions of .png files.

Also, it's great when one open source project ties cleanly into another.

Implementation
folium is maintained by volunteers. Can you help make a PR if we want to implement this feature?

I would be happy to write this PR. I have working code which accomplishes the task, just not sure how to best turn it into a plugin.

If somebody could please comment:

  1. Is this idea acceptable and feasible?
  2. A general best practices and implementation list.

Thanks.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die bestehende Plugin-Struktur von Folium und das im Issue gezeigte Überschreiben von TileLayer._template zu prüfen, und vergleiche anschließend den geschlossenen Pull Request 1341. Die Arbeit ist abgeschlossen, wenn Leaflet.TileLayer.MBTiles als Folium-Plugin verwendet werden kann, ohne TileLayer._template manuell zu überschreiben, und der clientseitige Code über einen funktionierenden CDN-Link verfügbar ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, python
Bereich
data-visualization, frontend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.