Skip to content

Docs: explain which layer kinds are base layer / overlay by default #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 15, 2025
Merged

Docs: explain which layer kinds are base layer / overlay by default #2108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/user_guide/ui_elements/layer_control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ 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.
- base layer: only one can be active at a time. Tile layers are base layers by default.
- overlay: multiple can be active at the same time. `FeatureGroup`s and most non-tile layers are overlays by default.
- `control`: Whether the layer can be controlled in the layer control.
- `show`: Whether the layer will be shown when opening the map.

Expand Down