Skip to content

Commit ca80cdd

Browse files
committed
Add info on changes in Plotly.py 6.1
1 parent 97168bf commit ca80cdd

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

doc/python/static-image-generation-migration.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,26 @@ jupyter:
3333
thumbnail: thumbnail/static-image-export.png
3434
---
3535

36+
<!-- #region -->
3637
# Static Image Generation Changes in Plotly.py 6.1
38+
39+
Plotly.py 6.1 introduces support for Kaleido v1, which [improves static image generation](https://plotly.com/blog/kaleido-the-next-generation/) for Plotly figures.
40+
41+
While adding support for Kaleido v1, we are deprecating support for earlier versions of Kaleido and support for orca, another static image generation library. Support for earlier verisons of Kaleido and orca will be removed after September 2025, and we recommend updating to the latest Kaleido. This page documents how to migrate to Kaleido v1 and outlines any changes in functionality.
42+
43+
## Installing Kaleido
44+
45+
Install the latest kaleido with:
46+
47+
```bash
48+
pip install -U kaleido
49+
```
50+
51+
## Updating Existing Code
52+
53+
After September 2025, Kaleido v1 will be the sole supported static image generator for Plotly.py.
54+
With this change, the `engine` parameter on Plotly figure methods and functions that generate static images will be removed. For example, `fig.to_image(format="png", engine="orca")` or `fig.to_image(format="png", engine="kaleido")` needs to be updted to `fig.to_image(format="png")`.
55+
56+
This change applies to: `fig.to_image`, `fig.write_image`, `plotly.io.to_image`, and `plotly.io.write_image`.
57+
58+
<!-- #endregion -->

0 commit comments

Comments
 (0)