pyvista.DataSetFilters.outline

DataSetFilters.outline(generate_faces: bool = False, progress_bar: bool = False)

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.

See also

bounding_box

Similar filter with additional options.

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)

Static Scene

Interactive Scene

See Using Common Filters for more examples using this filter.