File tree Expand file tree Collapse file tree 3 files changed +23
-18
lines changed Expand file tree Collapse file tree 3 files changed +23
-18
lines changed Original file line number Diff line number Diff line change @@ -1862,13 +1862,13 @@ class CustomIcon(Icon):
18621862
18631863 Parameters
18641864 ----------
1865- icon_image : string, file or array-like object
1866- The data you want to use as an icon.
1867- * If string, it will be written directly in the output file.
1868- * If file, it's content will be converted as embedded in the
1869- output file .
1870- * If array-like, it will be converted to PNG base64 string
1871- and embedded in the output .
1865+ icon_image : string or array-like object
1866+ The data to use as an icon.
1867+ * If string is a path to an image file, its content will be converted and
1868+ embedded.
1869+ * If string is a URL, it will be linked .
1870+ * Otherwise a string will be assumed to be JSON and embedded.
1871+ * If array-like, it will be converted to PNG base64 string and embedded .
18721872
18731873 icon_size : tuple of 2 int, optional
18741874 Size of the icon image in pixels.
Original file line number Diff line number Diff line change @@ -243,11 +243,13 @@ class ImageOverlay(Layer):
243243
244244 Parameters
245245 ----------
246- image: string, file or array-like object
247- The data you want to draw on the map.
248- * If string, it will be written directly in the output file.
249- * If file, it's content will be converted as embedded in the output file.
250- * If array-like, it will be converted to PNG base64 string and embedded in the output.
246+ image: string or array-like object
247+ The data to overlay as an image.
248+ * If string is a path to an image file, its content will be converted and
249+ embedded.
250+ * If string is a URL, it will be linked.
251+ * Otherwise a string will be assumed to be JSON and embedded.
252+ * If array-like, it will be converted to PNG base64 string and embedded.
251253 bounds: list/tuple of list/tuple of float
252254 Image bounds on the map in the form
253255 [[lat_min, lon_min], [lat_max, lon_max]]
Original file line number Diff line number Diff line change @@ -169,12 +169,15 @@ def image_to_url(
169169
170170 Parameters
171171 ----------
172- image: string, file or array-like object
173- * If string, it will be written directly in the output file.
174- * If file, it's content will be converted as embedded in the
175- output file.
176- * If array-like, it will be converted to PNG base64 string and
177- embedded in the output.
172+ image: string or array-like object
173+ * If string is a path to an image file, its content will be converted and
174+ embedded in the output URL.
175+ * If string is a URL, it will be linked in the output URL.
176+ * Otherwise a string will be assumed to be JSON and embedded in the
177+ output URL.
178+ * If array-like, it will be converted to PNG base64 string and embedded in the
179+ output URL.
180+
178181 origin: ['upper' | 'lower'], optional, default 'upper'
179182 Place the [0, 0] index of the array in the upper left or
180183 lower left corner of the axes.
You can’t perform that action at this time.
0 commit comments