Bases: matplotlib.text.Text
Text object with 3D position and direction.
The position of the text.
The text string to display.
The direction of the text. See get_dir_vector
for a description of the values.
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 | |
unknown | |
unknown | |
unknown | |
| color |
| {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'} |
| |
| float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} |
| {a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'} |
| {'normal', 'italic', 'oblique'} |
| {'normal', 'small-caps'} |
| {a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'} |
str | |
| {'center', 'right', 'left'} |
bool | |
object | |
float (multiple of font size) | |
str | |
| {'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 | |
| {'center', 'top', 'bottom', 'baseline', 'center_baseline'} |
bool | |
bool | |
float | |
float | |
float |
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).
RendererBase
subclass.
This method is overridden in the Artist subclasses.
Return the (x, y, z) position of the text.
Like Artist.get_window_extent
, but includes any clipping.
RendererBase
subclass
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer()
)
Bbox
The enclosing bounding box (in figure pixel coordinates).
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 | |
bool | |
Patch or (Path, Transform) or None | |
| color |
| {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'} |
| |
| float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} |
| {a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'} |
| {'normal', 'italic', 'oblique'} |
| {'normal', 'small-caps'} |
| {a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'} |
str | |
| {'center', 'right', 'left'} |
bool | |
object | |
float (multiple of font size) | |
str | |
| {'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 | |
| {'center', 'top', 'bottom', 'baseline', 'center_baseline'} |
bool | |
bool | |
float | |
float | |
float | |
float |
Set the (x, y, z) position of the text.
The position in 3D space.
The direction of the text. If unspecified, the zdir will not be changed.
Set the z position of the text.
© 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