Bases: mpl_toolkits.axisartist.axis_artist.AttributeCopier
, mpl_toolkits.axisartist.axis_artist.LabelBase
Axis Label. Derived from Text. The position of the text is updated in the fly, so changing text position has no effect. Otherwise, the properties can be changed as a normal Text.
To change the pad between ticklabels and axis label, use set_pad.
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 color of the text.
Return the underlying artist that actually defines some properties (e.g., color) of this artist.
Return the text string.
Return the Bbox
bounding the text, in display units.
In addition to being used internally, this is useful for specifying clickable regions in a png file on a web page.
A renderer is needed to compute the bounding box. If the artist has already been drawn, the renderer is cached; thus, it is only necessary to pass this argument when calling get_window_extent
before the first draw
. In practice, it is usually easier to trigger a draw first (e.g. by saving the figure).
The dpi value for computing the bbox, defaults to self.figure.dpi
(not the renderer dpi); should be set e.g. if to match regions with a figure saved with a custom dpi value.
Set multiple properties at once.
Supported properties 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 | |
unknown | |
color | |
dict with properties for | |
bool | |
Patch or (Path, Transform) or None | |
| color |
unknown | |
unknown | |
| {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'} |
unknown | |
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 |
Adjust the text angle and text alignment of axis label according to the matplotlib convention.
property | left | bottom | right | top |
---|---|---|---|---|
axislabel angle | 180 | 0 | 0 | 180 |
axislabel va | center | top | center | bottom |
axislabel ha | right | center | right | center |
Note that the text angles are actually relative to (90 + angle of the direction to the ticklabel), which gives 0 for bottom axis.
Set the internal pad in points.
The actual pad will be the sum of the internal pad and the external pad (the latter is set automatically by the AxisArtist).
© 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.axisartist.axis_artist.AxisLabel.html