mpl_toolkits.axisartist.axis_artist.AxisLabel

class mpl_toolkits.axisartist.axis_artist.AxisLabel(*args, axis_direction='bottom', axis=None, **kwargs)

Bases: AttributeCopier, 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 tick labels and axis label, use set_pad.

draw(renderer)

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:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_color()

Return the color of the text.

get_pad()

Return the internal pad in points.

See set_pad for more details.

get_ref_artist()

Return the underlying artist that actually defines some properties (e.g., color) of this artist.

get_text()

Return the text string.

get_window_extent(renderer=None)

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.

Parameters:

rendererRenderer, optional

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 calling draw_without_rendering or plt.show().

dpifloat, optional

The dpi value for computing the bbox, defaults to self.get_figure(root=True).dpi (not the renderer dpi); should be set e.g. if to match regions with a figure saved with a custom dpi value.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, axis_direction=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, default_alignment=<UNSET>, default_angle=<UNSET>, fontfamily=<UNSET>, fontfeatures=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, language=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, pad=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<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>, zorder=<UNSET>)

Set multiple properties at once.

a.set(a=A, b=B, c=C)

is equivalent to

a.set_a(A)
a.set_b(B)
a.set_c(C)

In addition to the full property names, aliases are also supported, e.g. set(lw=2) is equivalent to set(linewidth=2), but it is an error to pass both simultaneously.

The order of the individual setter calls matches the order of parameters in set(). However, most properties do not depend on each other so that order is rarely relevant.

Supported properties 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
axis_direction	{"left", "bottom", "right", "top"}
backgroundcolor	color
bbox	dict with properties for FancyBboxPatch or None
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color or c	color
default_alignment	{"left", "bottom", "right", "top"}
default_angle	{"left", "bottom", "right", "top"}
figure	Figure or SubFigure
fontfamily or family or fontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontfeatures	list of str, or tuple of str, or None
fontproperties or font or font_properties	font_manager.FontProperties or str or pathlib.Path
fontsize or size	float 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'}
gid	str
horizontalalignment or ha	{'left', 'center', 'right'}
in_layout	bool
label	object
language	str or None
linespacing	'normal' or float, default: 'normal'
math_fontfamily	str
mouseover	bool
multialignment or ma	{'left', 'right', 'center'}
pad	float
parse_math	bool
path_effects	list of AbstractPathEffect
picker	None or bool or float or callable
position	(float, float)
rasterized	bool
rotation	float or {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor', 'xtick', 'ytick'}
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 or va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool
x	float
y	float
zorder	float

set_axis_direction(d)

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.

Parameters:

d{"left", "bottom", "right", "top"}

set_default_alignment(d)

Set the default alignment. See set_axis_direction for details.

Parameters:

d{"left", "bottom", "right", "top"}

set_default_angle(d)

Set the default angle. See set_axis_direction for details.

Parameters:

d{"left", "bottom", "right", "top"}

set_pad(pad)

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

Parameters:

padfloat

The internal pad in points.