Skip to content

Commit 6edfa8a

Browse files
authored
Merge pull request #5202 from plotly/update-kaleido-doc
Change deprecation version
2 parents 7bc7ce5 + 305ab9b commit 6edfa8a

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

doc/python/static-image-export.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ fig2 = go.Figure(
175175
)
176176

177177
fig3 = px.pie(
178-
values=[30, 20, 10, 40],
178+
values=[30, 20, 10, 40],
179179
names=['A', 'B', 'C', 'D'],
180180
title='Pie Chart'
181181
)
@@ -217,7 +217,7 @@ Image(img_bytes)
217217

218218
## Specify Image Export Engine
219219

220-
> The `engine` parameter, as well as Orca support, is deprecated in Plotly.py 6.1.0 and will be removed after September 2025.
220+
> The `engine` parameter, as well as Orca support, is deprecated in Plotly.py 6.2.0 and will be removed after September 2025.
221221
222222
If `kaleido` is installed, it will automatically be used to perform image export. If it is not installed, plotly.py will attempt to use `orca` instead. The `engine` argument to the `to_image` and `write_image` functions can be used to override this default behavior.
223223

@@ -295,7 +295,7 @@ import plotly.io as pio
295295
pio.defaults.default_height
296296
~~~
297297

298-
In earlier versions of Plotly.py, these settings are available on `plotly.io.kaleido.scope`. This is deprecated since version 6.1. Use `plotly.io.defaults` instead.
298+
In earlier versions of Plotly.py, these settings are available on `plotly.io.kaleido.scope`. This is deprecated since version 6.2. Use `plotly.io.defaults` instead.
299299

300300
~~~python
301301
import plotly.io as pio

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ To migrate from either Orca or Kaleido v0, first install the latest Kaleido with
4646
pip install --upgrade kaleido
4747
```
4848

49-
## Chrome
49+
## Chrome
5050

5151
Kaleido uses Chrome for static image generation. Versions of Kaleido prior to v1 included Chrome as part of the Kaleido package. Kaleido v1 does not include Chrome; instead, it looks for a compatible version of Chrome (or Chromium) already installed on the machine on which it's running.
5252

5353
See the [Chrome section](/python/static-image-export#chrome) on the Static Image Export page for more details on Chome and Kaleido.
5454

5555
## Engine Parameter
5656

57-
The `engine` parameter on static image export methods and functions is deprecated in Plotly.py 6.1 and will be removed after September 2025. Once the `engine` parameter is removed, static image generation will use Kaleido v1 if it's installed, or raise an error if it isn't.
57+
The `engine` parameter on static image export methods and functions is deprecated in Plotly.py 6.2 and will be removed after September 2025. Once the `engine` parameter is removed, static image generation will use Kaleido v1 if it's installed, or raise an error if it isn't.
5858

5959
You'll need to update your code to remove references to `engine`. For example, `fig.to_image(format="png", engine="orca")` or `fig.to_image(format="png", engine="kaleido")` needs to be updated to `fig.to_image(format="png")`. This change applies to: `fig.to_image`, `fig.write_image`, `plotly.io.to_image`, and `plotly.io.write_image`.
6060

@@ -69,7 +69,7 @@ Accessing Kaleido defaults and config settings via `plotly.io.kaleido.scope` is
6969
~~~python
7070
import plotly.io as pio
7171
pio.defaults.default_format = "jpeg"
72-
# Instead of:
72+
# Instead of:
7373
# pio.kaleido.scope.default_format = "jpeg"
7474
~~~
7575

0 commit comments

Comments
 (0)