Repository navigation
to_image documentation incorrect #4454
Copy link
Copy link
Closed
Labels
P3backlogbacklogbugsomething brokensomething brokendocumentationwritten for humanswritten for humans
Description
It currently says:
scale: int or float or None
The scale factor to use when exporting the figure. A scale factor larger than 1.0 will increase the image resolution with respect to the figure's layout pixel dimensions. Whereas as scale factor of less than 1.0 will decrease the image resolution.
If not specified, will default to plotly.io.config.default_scale
plotly.py/packages/python/plotly/plotly/io/_orca.py
Lines 1426 to 1432 in 99e63da
| scale: int or float or None | |
| The scale factor to use when exporting the figure. A scale factor | |
| larger than 1.0 will increase the image resolution with respect | |
| to the figure's layout pixel dimensions. Whereas as scale factor of | |
| less than 1.0 will decrease the image resolution. | |
| If not specified, will default to `plotly.io.config.default_scale` |
plotly.py/packages/python/plotly/plotly/basedatatypes.py
Lines 3753 to 3759 in 99e63da
| scale: int or float or None | |
| The scale factor to use when exporting the figure. A scale factor | |
| larger than 1.0 will increase the image resolution with respect | |
| to the figure's layout pixel dimensions. Whereas as scale factor of | |
| less than 1.0 will decrease the image resolution. | |
| If not specified, will default to `plotly.io.config.default_scale` |
However, something has been changed and these blocks should match the documentation in _kaleido.py
plotly.py/packages/python/plotly/plotly/io/_kaleido.py
Lines 67 to 75 in 99e63da
| scale: int or float or None | |
| The scale factor to use when exporting the figure. A scale factor | |
| larger than 1.0 will increase the image resolution with respect | |
| to the figure's layout pixel dimensions. Whereas as scale factor of | |
| less than 1.0 will decrease the image resolution. | |
| If not specified, will default to: | |
| - `plotly.io.kaleido.scope.default_scale` if engine is "kaleido" | |
| - `plotly.io.orca.config.default_scale` if engine is "orca" |
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
P3backlogbacklogbugsomething brokensomething brokendocumentationwritten for humanswritten for humans
Activity
emilykl commentedon Sep 1, 2026
Closed as part of #5677;
io/_orca.pyhas been removed and the docstrings inio/_kaleido.pyand basedatatypes.py are now the same.