pyvista.AxesGeometrySource.shaft_type

property AxesGeometrySource.shaft_type: str

Shaft type for all axes.

Must be a string, e.g. 'cylinder' or 'cube' or any other supported geometry. Alternatively, any arbitrary 3-dimensional pyvista.DataSet may also be specified. In this case, the dataset must be oriented such that it “points” in the positive z direction.

Examples

Show a list of all shaft type options.

>>> import pyvista as pv
>>> pv.AxesGeometrySource.GEOMETRY_TYPES
('cylinder', 'sphere', 'hemisphere', 'cone', 'pyramid', 'cube', 'octahedron')

Show the default shaft type and modify it.

>>> axes_geometry_source = pv.AxesGeometrySource()
>>> axes_geometry_source.shaft_type
'cylinder'
>>> axes_geometry_source.shaft_type = 'cube'
>>> axes_geometry_source.shaft_type
'cube'

Set the shaft type to any 3-dimensional dataset.

>>> axes_geometry_source.shaft_type = pv.Superquadric()
>>> axes_geometry_source.shaft_type
'custom'