mpl_toolkits.mplot3d.art3d.Text3D#

classmpl_toolkits.mplot3d.art3d.Text3D(x=0,y=0,z=0,text='',zdir='z',axlim_clip=False,**kwargs)[source]#

Bases:Text

Text object with 3D position and direction.

Parameters:

x, y, zfloat

The position of the text.

textstr

The text string to display.

zdir{'x', 'y', 'z', None, 3-tuple}

The direction of the text. Seeget_dir_vector for a description ofthe values.

axlim_clipbool, default: False

Whether to hide text outside the axes view limits.

Other Parameters:

**kwargs

All other parameters are passed on toText.

Create aText instance atx,y with stringtext.

The text is aligned relative to the anchor point (x,y) accordingtohorizontalalignment (default: 'left') andverticalalignment(default: 'baseline'). See alsoText alignment.

While Text accepts the 'label' keyword argument, by default it is notadded to the handles of a legend.

Valid keyword arguments 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	float or None
animated	bool
antialiased	bool
backgroundcolor	color
bbox	dict with properties forpatches.FancyBboxPatch
clip_box	unknown
clip_on	unknown
clip_path	unknown
color orc	color
figure	Figure orSubFigure
fontfamily orfamily orfontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties orfont orfont_properties	font_manager.FontProperties orstr orpathlib.Path
fontsize orsize	float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch orstretch	{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle orstyle	{'normal', 'italic', 'oblique'}
fontvariant orvariant	{'normal', 'small-caps'}
fontweight orweight	{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
gid	str
horizontalalignment orha	{'left', 'center', 'right'}
in_layout	bool
label	object
linespacing	float (multiple of font size)
math_fontfamily	str
mouseover	bool
multialignment orma	{'left', 'right', 'center'}
parse_math	bool
path_effects	list ofAbstractPathEffect
picker	None or bool or float or callable
position	(float, float)
rasterized	bool
rotation	float or {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
text	object
transform	Transform
transform_rotates_text	bool
url	str
usetex	bool, default:rcParams["text.usetex"] (default:False)
verticalalignment orva	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool
x	float
y	float
zorder	float

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_visiblereturns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_position_3d()[source]#

Return the (x, y, z) position of the text.

get_tightbbox(renderer=None)[source]#

LikeArtist.get_window_extent, but includes any clipping.

Parameters:

rendererRendererBase subclass, optional

renderer that will be used to draw the figures (i.e.fig.canvas.get_renderer())

Returns:

Bbox or None

The enclosing bounding box (in figure pixel coordinates).Returns None if clipping results in no intersection.

set(*,agg_filter=<UNSET>,alpha=<UNSET>,animated=<UNSET>,antialiased=<UNSET>,backgroundcolor=<UNSET>,bbox=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,color=<UNSET>,fontfamily=<UNSET>,fontproperties=<UNSET>,fontsize=<UNSET>,fontstretch=<UNSET>,fontstyle=<UNSET>,fontvariant=<UNSET>,fontweight=<UNSET>,gid=<UNSET>,horizontalalignment=<UNSET>,in_layout=<UNSET>,label=<UNSET>,linespacing=<UNSET>,math_fontfamily=<UNSET>,mouseover=<UNSET>,multialignment=<UNSET>,parse_math=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,position_3d=<UNSET>,rasterized=<UNSET>,rotation=<UNSET>,rotation_mode=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,text=<UNSET>,transform=<UNSET>,transform_rotates_text=<UNSET>,url=<UNSET>,usetex=<UNSET>,verticalalignment=<UNSET>,visible=<UNSET>,wrap=<UNSET>,x=<UNSET>,y=<UNSET>,z=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property	Description
3d_properties	float
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
animated	bool
antialiased	bool
backgroundcolor	color
bbox	dict with properties forpatches.FancyBboxPatch
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color orc	color
figure	Figure orSubFigure
fontfamily orfamily orfontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties orfont orfont_properties	font_manager.FontProperties orstr orpathlib.Path
fontsize orsize	float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch orstretch	{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle orstyle	{'normal', 'italic', 'oblique'}
fontvariant orvariant	{'normal', 'small-caps'}
fontweight orweight	{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
gid	str
horizontalalignment orha	{'left', 'center', 'right'}
in_layout	bool
label	object
linespacing	float (multiple of font size)
math_fontfamily	str
mouseover	bool
multialignment orma	{'left', 'right', 'center'}
parse_math	bool
path_effects	list ofAbstractPathEffect
picker	None or bool or float or callable
position	(float, float)
position_3d	(float, float, float)
rasterized	bool
rotation	float or {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
text	object
transform	Transform
transform_rotates_text	bool
url	str
usetex	bool, default:rcParams["text.usetex"] (default:False)
verticalalignment orva	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool
x	float
y	float
z	float
zorder	float

set_3d_properties(z=0,zdir='z',axlim_clip=False)[source]#

Set thez position and direction of the text.

Parameters:

zfloat

The z-position in 3D space.

zdir{'x', 'y', 'z', 3-tuple}

The direction of the text. Default: 'z'.Seeget_dir_vector for a description of the values.

axlim_clipbool, default: False

Whether to hide text outside the axes view limits.

set_position_3d(xyz,zdir=None)[source]#

Set the (x,y,z) position of the text.

Parameters:

xyz(float, float, float)

The position in 3D space.

zdir{'x', 'y', 'z', None, 3-tuple}

The direction of the text. If unspecified, thezdir will not bechanged. Seeget_dir_vector for a description of the values.

set_z(z)[source]#

Set thez position of the text.

Parameters:

zfloat