Plotter.show

Plotter.show#

Plotter.show(
title: str | None = None,
window_size: Sequence[int] | None = None,
interactive: bool = True,
auto_close: bool | None = None,
interactive_update: bool = False,
full_screen: bool | None = None,
screenshot: str | Path | BytesIO | bool = False,
return_img: bool = False,
cpos: CameraPositionOptions | None = None,
jupyter_backend: JupyterBackendOptions | str | None = None,
return_viewer: bool = False,
return_cpos: bool | None = None,
before_close_callback: Callable[[Plotter], None] | None = None,
store_image_depth: bool = False,
**kwargs,
) → CameraPosition | pyvista_ndarray | EmbeddableWidget | Widget | IFrame | Image | tuple[CameraPosition | EmbeddableWidget | Widget | pyvista_ndarray | IFrame | Image, ...] | None[source]#

Display the plotting window.

Changed in version 0.47: The last image depth is no longer automatically stored. You must enable store_image_depth=True within show() to obtain the image depth after the pyvista.Plotter has been closed.

Added in version 0.47: Added the store_image_depth parameter to allow storing image depth for use with get_image_depth().

Parameters:
titlestr, optional

Title of plotting window. Defaults to pyvista.global_theme.title.

window_sizelist[int], optional

Window size in pixels. Defaults to pyvista.global_theme.window_size.

interactivebool, optional

Enabled by default. Allows user to pan and move figure. Defaults to pyvista.global_theme.interactive.

auto_closebool, optional

Exits plotting session when user closes the window when interactive is True. Defaults to pyvista.global_theme.auto_close.

interactive_updatebool, default: False

Allows user to non-blocking draw, user should call Plotter.update() in each iteration.

full_screenbool, optional

Opens window in full screen. When enabled, ignores window_size. Defaults to pyvista.global_theme.full_screen.

screenshotstr | Path | io.BytesIO | bool, default: False

Take a screenshot of the initial state of the plot. If a string, it specifies the path to which the screenshot is saved. If True, the screenshot is returned as an array. For interactive screenshots it’s recommended to first call show() with auto_close=False to set the scene, then save the screenshot in a separate call to show() or Plotter.screenshot(). See also the before_close_callback parameter for an alternative.

return_imgbool, default: False

Returns a NumPy array representing the last image along with the camera position.

cpossequence[sequence[float]], optional

The camera position. You can also set this with Plotter.camera_position.

jupyter_backendstr, optional

Jupyter notebook plotting backend to use. One of the following:

  • 'none' : Do not display in the notebook.

  • 'static' : Display a static figure.

  • 'trame' : Display a dynamic figure with Trame.

  • 'html' : Use an embeddable HTML scene.

This can also be set globally with pyvista.set_jupyter_backend().

A dictionary jupyter_kwargs can also be passed to further configure how the backend displays.

return_viewerbool, default: False

Return the jupyterlab viewer, scene, or display object when plotting with Jupyter notebook. When False and within a Jupyter environment, the scene will be immediately shown within the notebook. Set this to True to return the scene instead.

return_cposbool, optional

Return the last camera position from the render window when enabled. Default based on theme setting. See pyvista.plotting.themes.Theme.return_cpos.

before_close_callbackCallable, optional

Callback that is called before the plotter is closed. The function takes a single parameter, which is the plotter object before it closes. An example of use is to capture a screenshot after interaction:

def fun(plotter):
    plotter.screenshot('file.png')
store_image_depthbool, default: False

Store image depth before closing. Necessary when calling get_image_depth() after rendering.

**kwargsdict, optional

Developer keyword arguments.

Returns:
cposCameraPosition

List of camera position, focal point, and view up. Returned only when return_cpos=True or set in the default global or plot theme.

imagenp.ndarray

NumPy array of the last image when either return_img=True or screenshot=True is set. Optionally contains alpha values. Sized:

  • [Window height x Window width x 3] if the theme sets transparent_background=False.

  • [Window height x Window width x 4] if the theme sets transparent_background=True.

widgetWidget | EmbeddableWidget | IFrame | Image

IPython widget when return_viewer=True.

Notes#

Please use the q-key to close the plotter as some operating systems (namely Windows) will experience issues saving a screenshot if the exit button in the GUI is pressed.

Examples#

Download Python source code | Download Jupyter notebook

Simply show the plot of a mesh.

>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> _ = pl.add_mesh(pv.Cube())
>>> pl.show()
../../../_images/pyvista-Plotter-show-167e9c03b86cd74c_00_00.png

Take a screenshot interactively. Screenshot will be of the first image shown, so use the first call with auto_close=False to set the scene before taking the screenshot.

>>> pl = pv.Plotter()
>>> _ = pl.add_mesh(pv.Cube())
>>> pl.show(auto_close=False)
>>> pl.show(screenshot='my_image.png')

Obtain the camera position when using show.

>>> pl = pv.Plotter()

>>> _ = pl.add_mesh(pv.Sphere())
>>> pl.show(return_cpos=True)
CameraPosition(position=(1.926, 1.926, 1.926),
               focal_point=(0.0, 0.0, 0.0),
               viewup=(0.0, 0.0, 1.0))
Contents
Backed by CoDimensional PBC