plot_compare_four

plot_compare_four#

plot_compare_four(
data_a: DataSet,
data_b: DataSet,
data_c: DataSet,
data_d: DataSet,
*,
display_kwargs: dict[str, Any] | None = None,
plotter_kwargs: dict[str, Any] | None = None,
show_kwargs: dict[str, Any] | None = None,
screenshot: str | bool = False,
camera_position: Any = None,
outline: DataSet | None = None,
outline_color: ColorLike = 'k',
labels: Sequence[str] = ('A', 'B', 'C', 'D'),
link: bool = True,
notebook: bool | None = None,
) → Any[source]#

Plot a 2 by 2 comparison of data objects.

Deprecated since version 0.49: Use plot_compare() instead, which supports any number of data objects::

plot_compare([data_a, data_b, data_c, data_d])

Parameters:
data_apyvista.DataSet

The data object to display in the top-left corner.

data_bpyvista.DataSet

The data object to display in the top-right corner.

data_cpyvista.DataSet

The data object to display in the bottom-left corner.

data_dpyvista.DataSet

The data object to display in the bottom-right corner.

display_kwargsdict, default: None

Additional keyword arguments to pass to the add_mesh method.

plotter_kwargsdict, default: None

Additional keyword arguments to pass to the Plotter constructor.

show_kwargsdict, default: None

Additional keyword arguments to pass to the show method.

screenshotstr | bool, default: False

File name or path to save screenshot of the plot, or True to return a screenshot array.

camera_positionlist, default: None

The camera position to use in the plot.

outlinepyvista.DataSet, default: None

An outline to plot around the data objects.

outline_colorstr, default: ‘k’

The color of the outline.

labelstuple[str, str, str, str], default: (‘A’, ‘B’, ‘C’, ‘D’)

The labels to display for each data object.

linkbool, default: True

If True, link the views of the subplots.

notebookbool, default: None

If True, display the plot in a Jupyter notebook.

Returns:
tuple

See the returns of pyvista.Plotter.show().

See Also#

pyvista.plot_compare
pyvista.plot
pyvista.Plotter