AxesAssembly.get_actor_prop

AxesAssembly.get_actor_prop(name: str)

Get Property attributes for the axes shaft and/or tip actors.

This is a generalized getter method which returns the value of a specific pyvista.Property attribute for all shafts and tips.

Parameters:

namestr

Name of the Property attribute to get.

Returns:

tuple

Named tuple with attribute values for the axes shafts and tips. The values are ordered (x_shaft, y_shaft, z_shaft, x_tip, y_tip, z_tip).

Examples

Download Python source code | Download Jupyter notebook

Get the ambient property of the axes shafts and tips.

>>> import pyvista as pv
>>> axes_assembly = pv.AxesAssembly()
>>> axes_assembly.get_actor_prop('ambient')
_AxesPropTuple(x_shaft=0.0, y_shaft=0.0, z_shaft=0.0, x_tip=0.0, y_tip=0.0, z_tip=0.0)