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

[Deprecated]

Notes

Deprecated since version 3.2:

draw(self, renderer) [source]

Draws the Text object to the given renderer.

get_color(self) [source]

Return the color of the text

get_pad(self) [source]

Return the internal pad in points.

See set_pad for more details.

get_ref_artist(self) [source]

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

get_text(self) [source]

Get the text as string

get_window_extent(self, 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:

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 saving the figure). dpifloat, 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(self, 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(self, d) [source]

set_default_angle(self, d) [source]

set_pad(self, pad) [source]

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