Skip to content

Commit 496127f

Browse files
authored
Use a supported shape in the BeautifyIcon example (#2297)
1 parent ce1f335 commit 496127f

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

‎docs/user_guide/plugins/beautify_icon.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@ import folium.plugins
88

99
## BeautifyIcon
1010

11+
Use one of the supported icon shapes: `circle`, `circle-dot`, `doughnut`,
12+
`rectangle-dot`, or `marker`. The default is `circle`.
13+
1114
```{code-cell} ipython3
1215
m = folium.Map([45.5, -122], zoom_start=3)
1316
1417
icon_plane = folium.plugins.BeautifyIcon(
15-
icon="plane", border_color="#b3334f", text_color="#b3334f", icon_shape="triangle"
18+
icon="plane", border_color="#b3334f", text_color="#b3334f", icon_shape="circle"
1619
)
1720
1821
icon_number = folium.plugins.BeautifyIcon(

‎folium/plugins/beautify_icon.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ class BeautifyIcon(JSCSSMixin, MacroElement):
1414
icon: string, default None
1515
the Font-Awesome icon name to use to render the marker.
1616
icon_shape: string, default None
17-
the icon shape
17+
One of "circle", "circle-dot", "doughnut", "rectangle-dot", or "marker".
18+
If None, the plugin uses its default "circle" shape.
1819
border_width: integer, default 3
1920
the border width of the icon
2021
border_color: string with hexadecimal RGB, default '#000'

0 commit comments

Comments
 (0)