pyvista.DataSetFilters.outline#

DataSetFilters.outline(generate_faces=False, progress_bar=False)[source]#

Produce an outline of the full extent for the input dataset.

Parameters:
generate_facesbool, default: False

Generate solid faces for the box. This is disabled by default.

progress_barbool, default: False

Display a progress bar to indicate progress.

Returns:
pyvista.PolyData

Mesh containing an outline of the original dataset.

Examples

Generate and plot the outline of a sphere. This is effectively the (x, y, z) bounds of the mesh.

>>> import pyvista as pv
>>> sphere = pv.Sphere()
>>> outline = sphere.outline()
>>> pv.plot([sphere, outline], line_width=5)
https://d33wubrfki0l68.cloudfront.net/b9c48560ea13a1a6d7e4f9c51fa636d526919450/36c1e/_images/pyvista-datasetfilters-outline-1_00_00.png

See Using Common Filters for more examples using this filter.