https://github.com/iwpnd/folium-vectorgrid
L.VectorGrid.protobuf plugin for folium to allow vector tile layers to be added to your map.
https://github.com/iwpnd/folium-vectorgrid
folium folium-python mvt vector-tiles
Last synced: 7 months ago
JSON representation
L.VectorGrid.protobuf plugin for folium to allow vector tile layers to be added to your map.
- Host: GitHub
- URL: https://github.com/iwpnd/folium-vectorgrid
- Owner: iwpnd
- License: mit
- Created: 2022-02-23T20:13:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-12T08:29:12.000Z (7 months ago)
- Last Synced: 2025-03-15T15:39:39.415Z (7 months ago)
- Topics: folium, folium-python, mvt, vector-tiles
- Language: Python
- Homepage:
- Size: 528 KB
- Stars: 22
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Folium-VectorGrid
VectorGrid.protobuf plugin for Folium
Report Bug
·
Request Feature
Table of Contents
## About The Project
Now part of folium plugins as of [v0.13.0](https://github.com/python-visualization/folium/releases/tag/v0.13.0).
This library fills a hole in foliums plugin eco-system. Wrapping [Leaflet.VectorGrid](https://github.com/Leaflet/Leaflet.VectorGrid/) into a folium plugin, users can now add vector tile layers (e.g. Mapbox, OpenMapTiles) to their folium maps.
### Built With
- [folium](https://github.com/python-visualization/folium)
- [Leaflet.VectorGrid](https://github.com/Leaflet/Leaflet.VectorGrid)## Getting Started
### Prerequisite
Install [Poetry](https://python-poetry.org/docs/#installation).
### Installation
#### as dependency
```
poetry add git+https://github.com/iwpnd/folium-vectorgrid.git
``````
pip install folium-vectorgrid
```#### local development
1. Clone and install
```sh
git clone https://github.com/iwpnd/folium-vectorgrid.git
poetry install
```
2. Test it!
```sh
poe test # or poetry run pytest .
```## Usage
```python
from folium_vectorgrid import VectorGridProtobuf
import foliumurl = "https://free-{s}.tilehosting.com/data/v3/{z}/{x}/{y}.pbf?token={token}"
m = folium.Map()
options = {
"subdomain": "my_subdomain",
"token": "my_token",
"vectorTileLayerStyles": {
"my_layer":{
"fill": True,
"weight": 1,
"fillColor": 'green',
"color": 'black',
"fillOpacity":0.6,
"opacity":0.6
},
}
}vc = VectorGridProtobuf(url, "folium_layer_name", options)
m.add_child(vc)
m
```Or with conditional styling
```python
import folium
from folium_vectorgrid import VectorGridProtobufm = folium.Map()
url = "https://free-{s}.tilehosting.com/data/v3/{z}/{x}/{y}.pbf?token={token}"options = '''{
"subdomain": "tilehosting",
"token": "af6P2G9dztAt1F75x7KYt0Hx2DJR052G",
"vectorTileLayerStyles": {
"my_layer": function(f) {
if (f.type === 'parks') {
return {
"fill": true,
"weight": 1,
"fillColor": 'green',
"color": 'black',
"fillOpacity":0.6,
"opacity":0.6
};
}if (f.type === 'water') {
return {
"fill": true,
"weight": 1,
"fillColor": 'purple',
"color": 'black',
"fillOpacity":0.6,
"opacity":0.6
};
}
}
}
}'''VectorGridProtobuf(url,"layer_name",options).add_to(m)
m
```## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Benjamin Ramser - [@imwithpanda](https://twitter.com/imwithpanda) - ahoi@iwpnd.pw
Project Link: [https://github.com/iwpnd/folium-vector](https://github.com/iwpnd/folium-vectorgrid)