Skip to content

docs: add entry on Search plugin with FeatureGroup #2115

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 16, 2025
Merged

docs: add entry on Search plugin with FeatureGroup #2115

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
28 changes: 26 additions & 2 deletions docs/user_guide/plugins/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

The `Search` plugin allows you to search in your `GeoJson`, `TopoJson`, `FeatureGroup` or `MarkerCluster` objects.

## Data
## Search in GeoJSON

### Data

Let's get some JSON data from the web - both a point layer and a polygon GeoJson dataset with some population data.

Expand Down Expand Up @@ -89,7 +91,7 @@ Ok, now we have a new GeoDataFrame with our top 20 populated cities. Let's see t
pop_ranked_cities.head(5)
```

## Map with Search plugin
### Map with Search plugin and GeoJSON data

Alright, let's build a map!

Expand Down Expand Up @@ -149,3 +151,25 @@ colormap.add_to(m)

m
```

## Search in FeatureGroup

Here's an example how to search `Marker`s in a `FeatureGroup`. Note how we
add an extra field to each `Marker` that is then used to search on.


```{code-cell} ipython3
from folium import Map, FeatureGroup, Marker, Icon
from folium.plugins import Search

m = Map((45.5236, -122.5), tiles="carto db positron")

fg = FeatureGroup().add_to(m)
Marker([45.5236, -122.7], icon=Icon(color="red"), title="red").add_to(fg)
Marker([45.5236, -122.5], icon=Icon(color="blue"), title="blue").add_to(fg)
Marker([45.5236, -122.3], icon=Icon(color="green"), title="green").add_to(fg)

Search(fg, search_label="title").add_to(m)

m
```