Skip to content
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.

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

Improve docstring preview readibility in features.py #1833

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions folium/features.py
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,7 @@ class GeoJson(Layer):
* If `__geo_interface__` is available, the `__geo_interface__`
dictionary will be serialized to JSON and
reprojected if `to_crs` is available.

style_function: function, default None
Function mapping a GeoJson Feature to a style dict.
highlight_function: function, default None
Expand Down Expand Up @@ -883,6 +884,7 @@ class TopoJson(JSCSSMixin, Layer):
* If dict, then data will be converted to JSON and embedded
in the JavaScript.
* If str, then data will be passed to the JavaScript as-is.

object_path: str
The path of the desired object into the TopoJson structure.
Ex: 'objects.myobject'.
Expand Down Expand Up @@ -1818,6 +1820,7 @@ class CustomIcon(Icon):
output file.
* If array-like, it will be converted to PNG base64 string
and embedded in the output.

icon_size : tuple of 2 int, optional
Size of the icon image in pixels.
icon_anchor : tuple of 2 int, optional
Expand Down