mpl_toolkits.mplot3d.axis3d.Axis#

class mpl_toolkits.mplot3d.axis3d.Axis(axes, *, rotate_label=None, **kwargs)[source]#

Bases: XAxis

An Axis class for the 3D plots.

Parameters:

axesAxes: The Axes to which the created Axis belongs.
pickradiusfloat: The acceptance radius for containment tests. See also Axis.contains.

property adir[source]#

property d_interval[source]#

draw(renderer)[source]#

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visible returns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

draw_pane(renderer)[source]#

Draw pane.

Parameters:

rendererRendererBase subclass

get_major_ticks(numticks=None)[source]#: Return the list of major Ticks.

Warning

Ticks are not guaranteed to be persistent. Various operations can create, delete and modify the Tick instances. There is an imminent risk that changes to individual ticks will not survive if you work on the figure further (including also panning/zooming on a displayed figure).

Working on the individual ticks is a method of last resort. Use set_tick_params instead if possible.

get_minor_ticks(numticks=None)[source]#: Return the list of minor Ticks.

Warning

Ticks are not guaranteed to be persistent. Various operations can create, delete and modify the Tick instances. There is an imminent risk that changes to individual ticks will not survive if you work on the figure further (including also panning/zooming on a displayed figure).

Working on the individual ticks is a method of last resort. Use set_tick_params instead if possible.

get_rotate_label(text)[source]#

get_tightbbox(renderer=None, *, for_layout_only=False)[source]#

Return a bounding box that encloses the axis. It only accounts tick labels, axis label, and offsetText.

If for_layout_only is True, then the width of the label (if this is an x-axis) or the height of the label (if this is a y-axis) is collapsed to near zero. This allows tight/constrained_layout to ignore too-long labels when doing their layout.

init3d()[source]#

[Deprecated]

Notes

Deprecated since version 3.6:

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, data_interval=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, inverted=<UNSET>, label=<UNSET>, label_coords=<UNSET>, label_position=<UNSET>, label_text=<UNSET>, major_formatter=<UNSET>, major_locator=<UNSET>, minor_formatter=<UNSET>, minor_locator=<UNSET>, mouseover=<UNSET>, pane_color=<UNSET>, pane_pos=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, remove_overlapping_locs=<UNSET>, rotate_label=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, tick_params=<UNSET>, ticklabels=<UNSET>, ticks=<UNSET>, ticks_position=<UNSET>, transform=<UNSET>, units=<UNSET>, url=<UNSET>, view_interval=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

scalar or None

animated

bool

clip_box

Bbox

clip_on

bool

clip_path

Patch or (Path, Transform) or None

data_interval

unknown

figure

Figure

gid

str

in_layout

bool

inverted

unknown

label

object

label_coords

unknown

label_position

{'top', 'bottom'}

label_text

str

major_formatter

Formatter, str, or function

major_locator

Locator

minor_formatter

Formatter, str, or function

minor_locator

Locator

mouseover

bool

pane_color

color

pane_pos

unknown

path_effects

AbstractPathEffect

picker

None or bool or float or callable

pickradius

float

rasterized

bool

remove_overlapping_locs

unknown

rotate_label

unknown

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

tick_params

unknown

ticklabels

unknown

ticks

list of floats

ticks_position

{'top', 'bottom', 'both', 'default', 'none'}

transform

Transform

units

units tag

url

str

view_interval

unknown

visible

bool

zorder

float

Property	Description
`agg_filter`	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
`alpha`	scalar or None
`animated`	bool
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`data_interval`	unknown
`figure`	`Figure`
`gid`	str
`in_layout`	bool
`inverted`	unknown
`label`	object
`label_coords`	unknown
`label_position`	{'top', 'bottom'}
`label_text`	str
`major_formatter`	`Formatter`, `str`, or function
`major_locator`	`Locator`
`minor_formatter`	`Formatter`, `str`, or function
`minor_locator`	`Locator`
`mouseover`	bool
`pane_color`	color
`pane_pos`	unknown
`path_effects`	`AbstractPathEffect`
`picker`	None or bool or float or callable
`pickradius`	float
`rasterized`	bool
`remove_overlapping_locs`	unknown
`rotate_label`	unknown
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`tick_params`	unknown
`ticklabels`	unknown
`ticks`	list of floats
`ticks_position`	{'top', 'bottom', 'both', 'default', 'none'}
`transform`	`Transform`
`units`	units tag
`url`	str
`view_interval`	unknown
`visible`	bool
`zorder`	float

set_pane_color(color, alpha=None)[source]#

Set pane color.

Parameters:

colorcolor: Color for axis pane.
alphafloat, optional: Alpha value for axis pane. If None, base it on color.

set_pane_pos(xys)[source]#

[Deprecated] Set pane position.

Notes

Deprecated since version 3.6.

set_rotate_label(val)[source]#: Whether to rotate the axis label: True, False or None. If set to None the label will be rotated if longer than 4 chars.

property v_interval[source]#