squidpy.pl.Interactive.screenshot

Interactive.screenshot(return_result=False, dpi=180, save=None, canvas_only=True, **kwargs)[source]

Plot a screenshot of the viewer’s canvas.

Parameters:

  • return_result (bool) – If True, return the image as an numpy.uint8.

  • dpi (float | None) – Dots per inch.

  • save (Optional[str]) – Whether to save the plot.

  • canvas_only (bool) – Whether to show only the canvas or also the widgets.

  • kwargs (Any) – Keyword arguments for matplotlib.axes.Axes.imshow().

Return type:

ndarray[Any, dtype[Any]] | None

Returns:

: Nothing, if return_result = False, otherwise the image array.