streamlit-folium

Render Folium objects in Streamlit


Keywords
folium, folium-maps, geospatial, geospatial-visualization, python, streamlit, streamlit-component, visualization
License
MIT
Install
pip install streamlit-folium==0.18.0

Documentation

streamlit-folium: geospatial made easy in Streamlit!

Run tests each PR

Open in Streamlit

streamlit-folium integrates two great open-source projects in the Python ecosystem: Streamlit and Folium!

Installation

pip install streamlit-folium

or

conda install -c conda-forge streamlit-folium

Usage

Currently, there are two functions defined:

  • st_folium(): a bi-directional Component, taking a Folium/Branca object and plotting to the Streamlit app. Upon mount/interaction with the Streamlit app, st_folium() returns a Dict with selected information including the bounding box and items clicked on

  • folium_static(): takes a folium.Map, folium.Figure, or branca.element.Figure object and displays it in a Streamlit app.

    Note: folium_static() is based on the _repr_html() representation created in Folium. This function should be a strict subset the of functionality of the newer st_folium() function. It is recommended that users switch to st_folium() as soon as possible, as folium_static() will likely be deprecated.

    If there is a reason why folium_static() needs to remain, please leave a GitHub issue describing your use case.

Example

streamlit_folium example