mpl_toolkits.axisartist.axis_artist.LabelBase#

classmpl_toolkits.axisartist.axis_artist.LabelBase(*args,**kwargs)[source]#

Bases:Text

A base class forAxisLabel andTickLabels. The position andangle of the text are calculated by the offset_ref_angle,text_ref_angle, and offset_radius attributes.

Create aText instance atx,y with stringtext.

The text is aligned relative to the anchor point (x,y) accordingtohorizontalalignment (default: 'left') andverticalalignment(default: 'baseline'). See alsoText alignment.

While Text accepts the 'label' keyword argument, by default it is notadded to the handles of a legend.

Valid keyword arguments 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
backgroundcolor	color
bbox	dict with properties forFancyBboxPatch or None
clip_box	unknown
clip_on	unknown
clip_path	unknown
color orc	color
figure	Figure orSubFigure
fontfamily orfamily orfontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties orfont orfont_properties	font_manager.FontProperties orstr orpathlib.Path
fontsize orsize	float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch orstretch	{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle orstyle	{'normal', 'italic', 'oblique'}
fontvariant orvariant	{'normal', 'small-caps'}
fontweight orweight	{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 orha	{'left', 'center', 'right'}
in_layout	bool
label	object
linespacing	float (multiple of font size)
math_fontfamily	str
mouseover	bool
multialignment orma	{'left', 'right', 'center'}
parse_math	bool
path_effects	list ofAbstractPathEffect
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 orva	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool
x	float
y	float
zorder	float

draw(renderer)[source]#

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visiblereturns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_window_extent(renderer=None)[source]#

Return theBbox bounding the text, in display units.

In addition to being used internally, this is useful for specifyingclickable regions in a png file on a web page.

Parameters:

rendererRenderer, optional

A renderer is needed to compute the bounding box. If the artisthas already been drawn, the renderer is cached; thus, it is onlynecessary to pass this argument when callingget_window_extentbefore the first draw. In practice, it is usually easier totrigger a draw first, e.g. by callingdraw_without_rendering orplt.show().

dpifloat, optional

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

set(*,agg_filter=<UNSET>,alpha=<UNSET>,animated=<UNSET>,antialiased=<UNSET>,backgroundcolor=<UNSET>,bbox=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,color=<UNSET>,fontfamily=<UNSET>,fontproperties=<UNSET>,fontsize=<UNSET>,fontstretch=<UNSET>,fontstyle=<UNSET>,fontvariant=<UNSET>,fontweight=<UNSET>,gid=<UNSET>,horizontalalignment=<UNSET>,in_layout=<UNSET>,label=<UNSET>,linespacing=<UNSET>,math_fontfamily=<UNSET>,mouseover=<UNSET>,multialignment=<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>)[source]#

Set multiple properties at once.

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
backgroundcolor	color
bbox	dict with properties forFancyBboxPatch or None
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color orc	color
figure	Figure orSubFigure
fontfamily orfamily orfontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties orfont orfont_properties	font_manager.FontProperties orstr orpathlib.Path
fontsize orsize	float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch orstretch	{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle orstyle	{'normal', 'italic', 'oblique'}
fontvariant orvariant	{'normal', 'small-caps'}
fontweight orweight	{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 orha	{'left', 'center', 'right'}
in_layout	bool
label	object
linespacing	float (multiple of font size)
math_fontfamily	str
mouseover	bool
multialignment orma	{'left', 'right', 'center'}
parse_math	bool
path_effects	list ofAbstractPathEffect
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 orva	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool
x	float
y	float
zorder	float