mpl_toolkits.mplot3d.art3d.Text3D
- class mpl_toolkits.mplot3d.art3d. Text3D ( x=0, y=0, z=0, text='', zdir='z', **kwargs ) [source]
-
Bases:
matplotlib.text.Text
Text object with 3D position and direction.
- Parameters
-
- x, y, z
-
The position of the text.
- text str
-
The text string to display.
- zdir {'x', 'y', 'z', None, 3-tuple}
-
The direction of the text. See
get_dir_vector
for a description of the values.
- Other Parameters
-
- **kwargs
-
All other parameters are passed on to
Text
.
Create a
Text
instance at x, y with string text.Valid keyword arguments are:
Property
Description
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
scalar or None
bool
color
dict with properties for
patches.FancyBboxPatch
unknown
unknown
unknown
color
or ccolor
fontfamily
or family{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties
or font or font_propertiesfontsize
or sizefloat or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch
or stretch{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle
or style{'normal', 'italic', 'oblique'}
fontvariant
or variant{'normal', 'small-caps'}
fontweight
or weight{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
str
horizontalalignment
or ha{'center', 'right', 'left'}
bool
object
float (multiple of font size)
str
multialignment
or ma{'left', 'right', 'center'}
bool
None or bool or float or callable
(float, float)
bool
float or {'vertical', 'horizontal'}
{None, 'default', 'anchor'}
(scale: float, length: float, randomness: float)
bool or None
object
bool
str
bool or None
verticalalignment
or va{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
bool
bool
float
float
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_visible
returns False).- Parameters
-
-
renderer
RendererBase
subclass.
-
renderer
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 ) [source]
-
Like
Artist.get_window_extent
, but includes any clipping.- Parameters
-
-
renderer
RendererBase
subclass -
renderer that will be used to draw the figures (i.e.
fig.canvas.get_renderer()
)
-
renderer
- Returns
-
-
Bbox
-
The enclosing bounding box (in figure pixel coordinates).
-
- set ( *, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, 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
unknown
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
scalar or None
bool
color
dict with properties for
patches.FancyBboxPatch
bool
Patch or (Path, Transform) or None
color
or ccolor
fontfamily
or family{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties
or font or font_propertiesfontsize
or sizefloat or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch
or stretch{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle
or style{'normal', 'italic', 'oblique'}
fontvariant
or variant{'normal', 'small-caps'}
fontweight
or weight{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
str
horizontalalignment
or ha{'center', 'right', 'left'}
bool
object
float (multiple of font size)
str
multialignment
or ma{'left', 'right', 'center'}
bool
None or bool or float or callable
(float, float)
(float, float, float)
bool
float or {'vertical', 'horizontal'}
{None, 'default', 'anchor'}
(scale: float, length: float, randomness: float)
bool or None
object
bool
str
bool or None
verticalalignment
or va{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
bool
bool
float
float
float
float
- set_3d_properties ( z=0, zdir='z' ) [source]
- 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, the zdir will not be changed.
- set_z ( z ) [source]
-
Set the z position of the text.
- Parameters
-
- z float
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/mpl_toolkits.mplot3d.art3d.Text3D.html