ThreeAxes

class ThreeAxes(*args, **kwargs)

Bases: _SharedAxes, Axes, Axes3D

Simple mix-in of ultraplot.axes.Axes with Axes3D.

Important

Note that this subclass does not implement the PlotAxes plotting overrides. This axes subclass can be used by passing proj='3d' or proj='three' to axes-creation commands like add_axes, add_subplot, and subplots.

Attributes Summary

name

Methods Summary

set(*[, adjustable, agg_filter, alpha, ...])

Set multiple properties at once.

Attributes Documentation

name = '3d'

Methods Documentation

set(*, adjustable=<UNSET>, agg_filter=<UNSET>, alpha=<UNSET>, anchor=<UNSET>, animated=<UNSET>, aspect=<UNSET>, autoscale_on=<UNSET>, autoscalex_on=<UNSET>, autoscaley_on=<UNSET>, autoscalez_on=<UNSET>, axes_locator=<UNSET>, axisbelow=<UNSET>, box_aspect=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, external=<UNSET>, facecolor=<UNSET>, forward_navigation_events=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, proj_type=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, subplotspec=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<UNSET>, ylabel=<UNSET>, ylim=<UNSET>, ymargin=<UNSET>, yscale=<UNSET>, yticklabels=<UNSET>, yticks=<UNSET>, zbound=<UNSET>, zlabel=<UNSET>, zlim=<UNSET>, zmargin=<UNSET>, zorder=<UNSET>, zscale=<UNSET>, zticklabels=<UNSET>, zticks=<UNSET>)

Set multiple properties at once.

Supported properties are

Property	Description
adjustable	{‘box’, ‘datalim’}
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	float or None
anchor	(float, float) or {‘C’, ‘SW’, ‘S’, ‘SE’, ‘E’, ‘NE’, …}
animated	bool
aspect	{‘auto’, ‘equal’, ‘equalxy’, ‘equalxz’, ‘equalyz’}
autoscale_on	bool
autoscalex_on	unknown
autoscaley_on	unknown
autoscalez_on	unknown
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	bool or ‘line’
box_aspect	3-tuple of floats or None
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
external	unknown
facecolor or fc	:mpltype:`color`
figure	Figure or SubFigure
forward_navigation_events	bool or “auto”
gid	str
in_layout	bool
label	object
mouseover	bool
navigate	bool
navigate_mode	unknown
path_effects	list of AbstractPathEffect
picker	None or bool or float or callable
position	[left, bottom, width, height] or Bbox
proj_type	{‘persp’, ‘ortho’}
prop_cycle	Cycler
rasterization_zorder	float or None
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
subplotspec	unknown
title	str
transform	Transform
url	str
visible	bool
xbound	unknown
xlabel	str
xlim or xlim3d	(left: float, right: float)
xmargin	float greater than -0.5
xscale	unknown
xticklabels	unknown
xticks	unknown
ybound	unknown
ylabel	str
ylim or ylim3d	(bottom: float, top: float)
ymargin	float greater than -0.5
yscale	unknown
yticklabels	unknown
yticks	unknown
zbound	unknown
zlabel	unknown
zlim or zlim3d	(bottom: float, top: float)
zmargin	float greater than -0.5
zorder	float
zscale	unknown
zticklabels	unknown
zticks	unknown