pyvista.AxesAssemblySymmetric.labels#

property AxesAssemblySymmetric.labels: tuple[str, str, str, str, str, str][source]#

Return or set the axes labels.

Specify three strings, one for each axis, or six strings, one for each +/- axis. If three strings, plus '+' and minus '-' characters are added. This property may be used as an alternative to using x_label, y_label, and z_label separately.

Examples

>>> import pyvista as pv
>>> axes_assembly = pv.AxesAssemblySymmetric()

Use three strings to set the labels. Plus '+' and minus '-' characters are added automatically.

>>> axes_assembly.labels = ['U', 'V', 'W']
>>> axes_assembly.labels
('+U', '-U', '+V', '-V', '+W', '-W')

Alternatively, use six strings to set the labels explicitly.

>>> axes_assembly.labels = [
...     'east',
...     'west',
...     'north',
...     'south',
...     'up',
...     'down',
... ]
>>> axes_assembly.labels
('east', 'west', 'north', 'south', 'up', 'down')