Skip to content

Use a supported shape in the BeautifyIcon example #2297

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

Open
ac1982 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −2
Open

Use a supported shape in the BeautifyIcon example #2297

Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion docs/user_guide/plugins/beautify_icon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ import folium.plugins

## BeautifyIcon

Use one of the supported icon shapes: `circle`, `circle-dot`, `doughnut`,
`rectangle-dot`, or `marker`. The default is `circle`.

```{code-cell} ipython3
m = folium.Map([45.5, -122], zoom_start=3)

icon_plane = folium.plugins.BeautifyIcon(
icon="plane", border_color="#b3334f", text_color="#b3334f", icon_shape="triangle"
icon="plane", border_color="#b3334f", text_color="#b3334f", icon_shape="circle"
)

icon_number = folium.plugins.BeautifyIcon(
Expand Down
3 changes: 2 additions & 1 deletion folium/plugins/beautify_icon.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ class BeautifyIcon(JSCSSMixin, MacroElement):
icon: string, default None
the Font-Awesome icon name to use to render the marker.
icon_shape: string, default None
the icon shape
One of "circle", "circle-dot", "doughnut", "rectangle-dot", or "marker".
If None, the plugin uses its default "circle" shape.
border_width: integer, default 3
the border width of the icon
border_color: string with hexadecimal RGB, default '#000'
Expand Down
Loading