Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.32 KB

layer_control.md

File metadata and controls

60 lines (40 loc) · 1.32 KB
Raw
---
nbsphinx: hidden
---
import folium

LayerControl

Add a control to the map to show or hide layers.

m = folium.Map(tiles=None)

folium.TileLayer("OpenStreetMap").add_to(m)
folium.TileLayer(show=False).add_to(m)

folium.LayerControl().add_to(m)

m

Common layer arguments

Every layer element in Folium has a couple common arguments:

  • name: how the layer will be named in the layer control.
  • overlay: True if the layer is an overlay, False if the layer is a base layer.
    • base layer: only one of them can be active at a time. Mostly used for tile layers.
    • overlay: multiple can be active at the same time. Used for anything else than tile layers.
  • control: Whether the layer can be controlled in the layer control.
  • show: Whether the layer will be shown when opening the map.

Next we'll give some examples using a FeatureGroup.

Remove from control

m = folium.Map()

fg = folium.FeatureGroup(name="Icon collection", control=False).add_to(m)
folium.Marker(location=(0, 0)).add_to(fg)

folium.LayerControl().add_to(m)

m

Show manually

m = folium.Map()

fg = folium.FeatureGroup(name="Icon collection", show=False).add_to(m)
folium.Marker(location=(0, 0)).add_to(fg)

folium.LayerControl().add_to(m)

m