Skip to content

Commit 077a356

Browse files
committed
Add note on browsers
1 parent fded494 commit 077a356

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

doc/python/static-image-export.md

+35-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jupyter:
66
extension: .md
77
format_name: markdown
88
format_version: '1.3'
9-
jupytext_version: 1.17.0
9+
jupytext_version: 1.17.1
1010
kernelspec:
1111
display_name: Python 3 (ipykernel)
1212
language: python
@@ -20,7 +20,7 @@ jupyter:
2020
name: python
2121
nbconvert_exporter: python
2222
pygments_lexer: ipython3
23-
version: 3.13.2
23+
version: 3.13.3
2424
plotly:
2525
description: Plotly allows you to save static images of your plots. Save the image
2626
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
5656

5757
### Chrome
5858

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.
6060

6161
Run `plotly_get_chrome` to install Chrome.
6262

@@ -67,6 +67,9 @@ import plotly.io as pio
6767

6868
pio.install_chrome()
6969
```
70+
71+
See the **Additional Information on Browsers with Kaleido** section below for more details on browser compatibility for Kaleido.
72+
7073
<!-- #endregion -->
7174

7275
## Write Image to a File
@@ -216,7 +219,7 @@ As well as configuring height, width, and other settings by passing arguments wh
216219

217220
### Available Settings
218221

219-
The following settings are availble.
222+
The following settings are available.
220223

221224
`default_width`: The default pixel width to use on image export.
222225

@@ -258,8 +261,34 @@ import plotly.io as pio
258261
pio.kaleido.scope.default_format = "jpeg"
259262
~~~
260263

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".
267+
268+
Kaleido will also check the following locations:
269+
270+
**Windows**
271+
272+
- r"c:\Program Files\Google\Chrome\Application\chrome.exe"
273+
- f"c:\\Users\\{os.environ.get('USER', 'default')}\\AppData\\"
274+
- "Local\\Google\\Chrome\\Application\\chrome.exe"
275+
276+
**Linux"**
261277

278+
- "/usr/bin/google-chrome-stable"
279+
- "/usr/bin/google-chrome"
280+
- "/usr/bin/chrome"
262281

263-
**Image Export Settings (Orca)**
282+
**Mac OS**
264283

265-
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.
284+
- "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
285+
286+
---
287+
288+
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:
291+
292+
```
293+
BROWSER_PATH=/Applications/Microsoft\ Edge.app/Contents/MacOS/Microsoft\ Edge
294+
```

0 commit comments

Comments
 (0)