mpl_toolkits.axisartist.axis_artist.TickLabels#
- class mpl_toolkits.axisartist.axis_artist.TickLabels(*, axis_direction='bottom', **kwargs)[source]#
Bases:
AxisLabel
Tick labels. While derived from
Text
, this single artist draws all ticklabels. As inAxisLabel
, 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 normalText
. Unlike the ticklabels of the mainline Matplotlib, properties of a single ticklabel alone cannot be modified.To change the pad between ticks and ticklabels, use
set_pad
.- 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_visible
returns False).- Parameters:
- renderer
RendererBase
subclass.
- renderer
Notes
This method is overridden in the Artist subclasses.
- get_ref_artist()[source]#
Return the underlying artist that actually defines some properties (e.g., color) of this artist.
- get_texts_widths_heights_descents(renderer)[source]#
Return a list of
(width, height, descent)
tuples for ticklabels.Empty labels are left out.
- 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>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, locs_angles_labels=<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>)[source]#
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 and two offsets from the bottom left corner of the image
scalar or None
bool
bool
{"left", "bottom", "right", "top"}
color
dict with properties for
patches.FancyBboxPatch
BboxBase
or Nonebool
Patch or (Path, Transform) or None
color
or ccolor
{"left", "bottom", "right", "top"}
{"left", "bottom", "right", "top"}
fontfamily
or family or fontname{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties
or font or font_propertiesfontsize
or sizefloat 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'}
str
horizontalalignment
or ha{'left', 'center', 'right'}
bool
object
float (multiple of font size)
unknown
str
bool
multialignment
or ma{'left', 'right', 'center'}
float
bool
list of
AbstractPathEffect
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
verticalalignment
or va{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
bool
bool
float
float
float
- set_axis_direction(label_direction)[source]#
Adjust the text angle and text alignment of ticklabels according to the Matplotlib convention.
The label_direction must be one of [left, right, bottom, top].
Property
left
bottom
right
top
ticklabel angle
90
0
-90
180
ticklabel va
center
baseline
center
baseline
ticklabel 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:
- label_direction{"left", "bottom", "right", "top"}