Version 3.0.2
matplotlib
Fork me on GitHub

mpl_toolkits.axisartist.axis_artist.AxisLabel

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

Bases: mpl_toolkits.axisartist.axis_artist.LabelBase, mpl_toolkits.axisartist.axis_artist.AttributeCopier

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(renderer)[source]

Draws the Text object to the given renderer.

get_color()[source]

Return the color of the text

get_pad()[source]

return pad in points. See set_pad for more details.

get_ref_artist()[source]
get_text()[source]

Get the text as string

get_window_extent(renderer)[source]

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:
renderer : Renderer, 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 saving the figure).

dpi : float, optional

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_axis_direction(d)[source]

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_default_alignment(d)[source]
set_default_angle(d)[source]
set_pad(pad)[source]

Set the pad in points. Note that the actual pad will be the sum of the internal pad and the external pad (that are set automatically by the AxisArtist), and it only set the internal pad