You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/python/static-image-export.md
+35-6
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ jupyter:
6
6
extension: .md
7
7
format_name: markdown
8
8
format_version: '1.3'
9
-
jupytext_version: 1.17.0
9
+
jupytext_version: 1.17.1
10
10
kernelspec:
11
11
display_name: Python 3 (ipykernel)
12
12
language: python
@@ -20,7 +20,7 @@ jupyter:
20
20
name: python
21
21
nbconvert_exporter: python
22
22
pygments_lexer: ipython3
23
-
version: 3.13.2
23
+
version: 3.13.3
24
24
plotly:
25
25
description: Plotly allows you to save static images of your plots. Save the image
26
26
to your local computer, or embed it inside your Jupyter notebooks as a static
@@ -56,7 +56,7 @@ It's also possible to generate static images using [Orca](https://github.com/plo
56
56
57
57
### Chrome
58
58
59
-
Kaleido uses Chrome for static image generation. Versions of Kaleido prior to v1 included Chrome. Kaleido v1 and later uses the Chrome that's available on the machine on which it's running. If you need to install Chrome for static image generation, Plotly provides a CLI.
59
+
Kaleido uses Chrome for static image generation. Versions of Kaleido prior to v1 included Chrome. Kaleido v1 and later uses Chrome (or Chromium) if it can find a compatible version on the machine on which it's running. If you need to install Chrome for static image generation, Plotly provides a CLI.
60
60
61
61
Run `plotly_get_chrome` to install Chrome.
62
62
@@ -67,6 +67,9 @@ import plotly.io as pio
67
67
68
68
pio.install_chrome()
69
69
```
70
+
71
+
See the **Additional Information on Browsers with Kaleido** section below for more details on browser compatibility for Kaleido.
72
+
70
73
<!-- #endregion -->
71
74
72
75
## Write Image to a File
@@ -216,7 +219,7 @@ As well as configuring height, width, and other settings by passing arguments wh
216
219
217
220
### Available Settings
218
221
219
-
The following settings are availble.
222
+
The following settings are available.
220
223
221
224
`default_width`: The default pixel width to use on image export.
222
225
@@ -258,8 +261,34 @@ import plotly.io as pio
258
261
pio.kaleido.scope.default_format ="jpeg"
259
262
~~~
260
263
264
+
### Additional Information on Browsers with Kaleido
265
+
266
+
When you export images from Plotly.py, Kaleido will attempt to find a version of [Chrome](https://www.google.com/chrome/index.html) or [Chromium](https://www.chromium.org/getting-involved/download-chromium/) that it can use for the export. It checks in the operating system's PATH for the executables with the following names: "chromium", "chromium-browser", "chrome", "Chrome", "google-chrome" "google-chrome-stable", "Chrome.app", "Google Chrome", "Google Chrome.app", and "Google Chrome for Testing".
See the [Orca Management section](https://plotly.com/python/orca-management/) for information on how to specify image export settings when using Orca. Support for Orca will be removed after September 2025.
Most recent versions of Chrome or Chromium should work with Kaleido. When you run `plotly_get_chrome`, [the following Chrome version](https://github.com/plotly/choreographer/blob/main/choreographer/resources/last_known_good_chrome.json#L2C17-L2C30) is installed.
289
+
290
+
Other Chromium-based browsers may also work, though Kaleido won't discover them automatically. You can set a browser to use by setting the path to search using an environment variable called `BROWSER_PATH`. For example:
0 commit comments