pyvista.Plotter.image_scale

pyvista.Plotter.image_scale#

property Plotter.image_scale: int[source]#

Get or set the scale factor when saving a screenshot.

This will scale up the screenshots taken of the render window to save a higher resolution image than what is rendered on screen.

Image sizes will be the window_size multiplied by this scale factor.

Returns:
int

Image scale factor.

Examples

Double the resolution of a screenshot.

>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> _ = pl.add_mesh(pv.Sphere())
>>> pl.image_scale = 2
>>> pl.screenshot('screenshot.png')  

Set the image scale from Plotter.

>>> import pyvista as pv
>>> pl = pv.Plotter(image_scale=2)
>>> _ = pl.add_mesh(pv.Sphere())
>>> pl.screenshot('screenshot.png')