Skip to content

Commit

Permalink
show_plane replaced by plane
Browse files Browse the repository at this point in the history
  • Loading branch information
anslpa committed Jul 18, 2023
1 parent d70bb68 commit 625337f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion examples/06-plotting/09_plot_surface_streamlines.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@
n_points=10,
surface_streamlines=True,
)
pl_multiple.show_figure(show_plane="xy", show_axes=True)
pl_multiple.show_figure(plane="xy", show_axes=True)
10 changes: 5 additions & 5 deletions src/ansys/dpf/core/plotter.py
Original file line number Diff line number Diff line change
Expand Up @@ -406,9 +406,9 @@ def show_figure(self, **kwargs):
self._plotter.camera_position = cpos

# Show depending on return_cpos option
show_plane = kwargs.pop("show_plane", None)
if show_plane is not None:
plane_str = "view_" + show_plane
plane = kwargs.pop("plane", None)
if plane is not None:
plane_str = "view_" + plane
view_method = getattr(self._plotter, plane_str)
view_method()

Check warning on line 413 in src/ansys/dpf/core/plotter.py

View check run for this annotation

Codecov / codecov/patch

src/ansys/dpf/core/plotter.py#L411-L413

Added lines #L411 - L413 were not covered by tests
kwargs_in = _sort_supported_kwargs(bound_method=self._plotter.show, **kwargs)
Expand Down Expand Up @@ -690,8 +690,8 @@ def show_figure(self, **kwargs):
**kwargs : optional
Additional keyword arguments for the plotter. More information
are available at :func:`pyvista.plot`.
"show_plane" argument can be used to specify the plan to view. For
example, add show_plane="xy" to display (XY) plan.
"plane" argument can be used to specify the plan to view. For
example, add plane="xy" to display (XY) plan.
Examples
--------
Expand Down

0 comments on commit 625337f

Please sign in to comment.