Plotter

class ansys.tools.visualization_interface.plotter.Plotter(backend: ansys.tools.visualization_interface.backends._base.BaseBackend = None)

Base plotting class containing common methods and attributes.

This class is responsible for plotting objects using the specified backend.

Parameters:

backendBaseBackend, optional

Plotting backend to use, by default PyVistaBackend.

Overview

Methods

plot	Plots an object using the specified backend.
show	Show the plotted objects.

Import detail

from ansys.tools.visualization_interface.plotter import Plotter

Method detail

Plotter.plot(plottable_object: beartype.typing.Any, **plotting_options)

Plots an object using the specified backend.

Parameters:

plottable_objectAny

Object to plot.

plotting_optionsdict

Additional plotting options.

Plotter.show(plottable_object: beartype.typing.Any = None, screenshot: str = None, name_filter: bool = None, **plotting_options) → None

Show the plotted objects.

Parameters:

plottable_objectAny, optional

Object to show, by default None.

screenshotstr, optional

Path to save a screenshot, by default None.

name_filterbool, optional

Flag to filter the object, by default None.

plotting_optionsdict

Additional plotting options the selected backend accepts.