pyvista.CubeAxesActor

class CubeAxesActor(

camera,

minor_ticks: bool = False,

tick_location=None,

x_title='X Axis',

y_title='Y Axis',

z_title='Z Axis',

x_axis_visibility: bool = True,

y_axis_visibility: bool = True,

z_axis_visibility: bool = True,

x_label_format=None,

y_label_format=None,

z_label_format=None,

x_label_visibility: bool = True,

y_label_visibility: bool = True,

z_label_visibility: bool = True,

n_xlabels=5,

n_ylabels=5,

n_zlabels=5,

)

Wrap vtkCubeAxesActor.

This class is created to wrap vtkCubeAxesActor, which is used to draw axes and labels for the input data bounds. This wrapping aims to provide a user-friendly interface to use vtkCubeAxesActor.

Parameters:

camerapyvista.Camera

Camera to link to the axes actor.

minor_ticksbool, default: False

If True, also plot minor ticks on all axes.

tick_locationstr, optional

Set how the ticks are drawn on the axes grid. Options include: 'inside', 'outside', 'both'.

x_titlestr, default: “X Axis”

Title of the x-axis.

y_titlestr, default: “Y Axis”

Title of the y-axis.

z_titlestr, default: “Z Axis”

Title of the z-axis.

x_axis_visibilitybool, default: True

Visibility of the x-axis.

y_axis_visibilitybool, default: True

Visibility of the y-axis.

z_axis_visibilitybool, default: True

Visibility of the z-axis.

x_label_formatstr, optional

A format string defining how tick labels are generated from tick positions for the x-axis. Defaults to the theme format if set, otherwise '%.1f'.

y_label_formatstr, optional

A format string defining how tick labels are generated from tick positions for the y-axis. Defaults to the theme format if set, otherwise '%.1f'.

z_label_formatstr, optional

A format string defining how tick labels are generated from tick positions for the z-axis. Defaults to the theme format if set, otherwise '%.1f'.

x_label_visibilitybool, default: True

The visibility of the x-axis labels.

y_label_visibilitybool, default: True

The visibility of the y-axis labels.

z_label_visibilitybool, default: True

The visibility of the z-axis labels.

n_xlabelsint, default: 5

Number of labels along the x-axis.

n_ylabelsint, default: 5

Number of labels along the y-axis.

n_zlabelsint, default: 5

Number of labels along the z-axis.

Examples

Create a 3D plotter and add a CubeAxesActor to it.

>>> import pyvista as pv
>>> mesh = pv.Cube()
>>> pl = pv.Plotter()
>>> actor = pl.add_mesh(mesh)
>>> cube_axes_actor = pv.CubeAxesActor(pl.camera)
>>> cube_axes_actor.bounds = mesh.bounds
>>> actor, property = pl.add_actor(cube_axes_actor)
>>> pl.show()

Static Scene

Interactive Scene

Methods

CubeAxesActor.update_bounds(bounds)

Update the bounds of this actor.

Attributes

CubeAxesActor.bounds	Return or set the bounding box.
CubeAxesActor.camera	Return or set the camera that performs scaling and translation.
CubeAxesActor.label_offset	Return or set the distance between labels and the axis.
CubeAxesActor.n_xlabels	Number of labels on the x-axis.
CubeAxesActor.n_ylabels	Number of labels on the y-axis.
CubeAxesActor.n_zlabels	Number of labels on the z-axis.
CubeAxesActor.tick_location	Return or set how the ticks are drawn on the axes grid.
CubeAxesActor.title_offset	Return or set the distance between title and labels.
CubeAxesActor.use_2d_mode	Use the 2d render mode.
CubeAxesActor.x_axis_minor_tick_visibility	Return or set visibility of the x-axis minior tick.
CubeAxesActor.x_axis_range	Return or set the x-axis range.
CubeAxesActor.x_axis_visibility	Return or set the visibility of the x-axis.
CubeAxesActor.x_label_format	Return or set the label of the x-axis.
CubeAxesActor.x_label_visibility	Return or set the visibility of the x-axis labels.
CubeAxesActor.x_labels	Return the x-axis labels.
CubeAxesActor.x_title	Return or set the title of the x-axis.
CubeAxesActor.y_axis_minor_tick_visibility	Return or set visibility of the y-axis minior tick.
CubeAxesActor.y_axis_range	Return or set the y-axis range.
CubeAxesActor.y_axis_visibility	Return or set the visibility of the y-axis.
CubeAxesActor.y_label_format	Return or set the label of the y-axis.
CubeAxesActor.y_label_visibility	Return or set the visibility of the y-axis labels.
CubeAxesActor.y_labels	Return the y-axis labels.
CubeAxesActor.y_title	Return or set the title of the y-axis.
CubeAxesActor.z_axis_minor_tick_visibility	Return or set visibility of the z-axis minior tick.
CubeAxesActor.z_axis_range	Return or set the z-axis range.
CubeAxesActor.z_axis_visibility	Return or set the visibility of the y-axis.
CubeAxesActor.z_label_format	Return or set the label of the z-axis.
CubeAxesActor.z_label_visibility	Return or set the visibility of the z-axis labels.
CubeAxesActor.z_labels	Return the z-axis labels.
CubeAxesActor.z_title	Return or set the title of the z-axis.