pyvista.AxesAssemblySymmetric.z_label

pyvista.AxesAssemblySymmetric.z_label#

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

Return or set the labels for the positive and negative z-axis.

The labels may be set with a single string or two strings. If a single string, plus '+' and minus '-' characters are added. Alternatively, set the labels with labels.

Examples

Set the labels with a single string. Plus '+' and minus '-' characters are added automatically.

>>> import pyvista as pv
>>> axes_assembly = pv.AxesAssemblySymmetric()
>>> axes_assembly.z_label = 'Axis'
>>> axes_assembly.z_label
('+Axis', '-Axis')

Set the labels explicitly with two strings.

>>> axes_assembly.z_label = 'superior', 'inferior'
>>> axes_assembly.z_label
('superior', 'inferior')