plotly.io
.to_image¶
-
plotly.io.
to_image
(fig, format=None, width=None, height=None, scale=None, validate=True, engine='auto')¶ Convert a figure to a static image bytes string
- Parameters
fig – Figure object or dict representing a figure
- The desired image format. One of
’png’
’jpg’ or ‘jpeg’
’webp’
’svg’
’pdf’
’eps’ (Requires the poppler library to be installed and on the PATH)
- If not specified, will default to:
plotly.io.kaleido.scope.default_format
if engine is “kaleido”plotly.io.orca.config.default_format
if engine is “orca”
The width of the exported image in layout pixels. If the
scale
property is 1.0, this will also be the width of the exported image in physical pixels.- If not specified, will default to:
plotly.io.kaleido.scope.default_width
if engine is “kaleido”plotly.io.orca.config.default_width
if engine is “orca”
The height of the exported image in layout pixels. If the
scale
property is 1.0, this will also be the height of the exported image in physical pixels.- If not specified, will default to:
plotly.io.kaleido.scope.default_height
if engine is “kaleido”plotly.io.orca.config.default_height
if engine is “orca”
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”
- validate: bool
True if the figure should be validated before being converted to an image, False otherwise.
- engine: str
- Image export engine to use:
“kaleido”: Use Kaleido for image export
“orca”: Use Orca for image export
“auto” (default): Use Kaleido if installed, otherwise use orca
- Returns
The image data
- Return type