Skip to content

Docs: utilities.image_to_url() 'image' and related docstrings #2106

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 2 commits into from
Mar 15, 2025
Merged

Docs: utilities.image_to_url() 'image' and related docstrings #2106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a63ed13
Docs: Fix #2905 `utilities.image_to_url()` image parameter documentat…
elliot-100 Mar 11, 2025
4bbb395
improve docs output
Conengmo Mar 15, 2025
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
16 changes: 8 additions & 8 deletions folium/features.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1862,14 +1862,14 @@ class CustomIcon(Icon):

Parameters
----------
icon_image : string, file or array-like object
The data you want to use as an icon.
* If string, it will be written directly in the output file.
* If file, it's content will be converted as embedded in the
output file.
* If array-like, it will be converted to PNG base64 string
and embedded in the output.

icon_image : string or array-like object
The data to use as an icon.

* If string is a path to an image file, its content will be converted and
embedded.
* If string is a URL, it will be linked.
* Otherwise a string will be assumed to be JSON and embedded.
* If array-like, it will be converted to PNG base64 string and embedded.
icon_size : tuple of 2 int, optional
Size of the icon image in pixels.
icon_anchor : tuple of 2 int, optional
Expand Down
15 changes: 9 additions & 6 deletions folium/raster_layers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,14 +243,17 @@ class ImageOverlay(Layer):

Parameters
----------
image: string, file or array-like object
The data you want to draw on the map.
* If string, it will be written directly in the output file.
* If file, it's content will be converted as embedded in the output file.
* If array-like, it will be converted to PNG base64 string and embedded in the output.
image: string or array-like object
The data to overlay as an image.

* If string is a path to an image file, its content will be converted and
embedded.
* If string is a URL, it will be linked.
* Otherwise a string will be assumed to be JSON and embedded.
* If array-like, it will be converted to PNG base64 string and embedded.
bounds: list/tuple of list/tuple of float
Image bounds on the map in the form
[[lat_min, lon_min], [lat_max, lon_max]]
[[lat_min, lon_min], [lat_max, lon_max]]
opacity: float, default Leaflet's default (1.0)
alt: string, default Leaflet's default ('')
origin: ['upper' | 'lower'], optional, default 'upper'
Expand Down
14 changes: 8 additions & 6 deletions folium/utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,14 @@ def image_to_url(

Parameters
----------
image: string, file or array-like object
* If string, it will be written directly in the output file.
* If file, it's content will be converted as embedded in the
output file.
* If array-like, it will be converted to PNG base64 string and
embedded in the output.
image: string or array-like object
* If string is a path to an image file, its content will be converted and
embedded in the output URL.
* If string is a URL, it will be linked in the output URL.
* Otherwise a string will be assumed to be JSON and embedded in the
output URL.
* If array-like, it will be converted to PNG base64 string and embedded in the
output URL.
origin: ['upper' | 'lower'], optional, default 'upper'
Place the [0, 0] index of the array in the upper left or
lower left corner of the axes.
Expand Down