mpl_toolkits.axisartist.axis_artist.AxisArtist¶
- class mpl_toolkits.axisartist.axis_artist.AxisArtist(axes, helper, offset=None, axis_direction='bottom', **kwargs)[source]¶
Bases:
matplotlib.artist.Artist
An artist which draws axis (a line along which the n-th axes coord is constant) line, ticks, ticklabels, and axis label.
- Parameters
- property LABELPAD¶
- ZORDER = 2.5¶
- 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_tightbbox(renderer)[source]¶
Like
Artist.get_window_extent
, but includes any clipping.- Parameters
- renderer
RendererBase
subclass renderer that will be used to draw the figures (i.e.
fig.canvas.get_renderer()
)
- renderer
- Returns
Bbox
The enclosing bounding box (in figure pixel coordinates).
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, axis_direction=<UNSET>, axislabel_direction=<UNSET>, axisline_style=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, ticklabel_direction=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<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
scalar or None
bool
unknown
{"+", "-"}
str or None
bool
Patch or (Path, Transform) or None
str
bool
unknown
None or bool or float or callable
bool
(scale: float, length: float, randomness: float)
bool or None
{"+", "-"}
str
bool
float
- set_axis_direction(axis_direction)[source]¶
Adjust the direction, text angle, text alignment of ticklabels, labels following the matplotlib convention for the rectangle axes.
The axis_direction must be one of [left, right, bottom, top].
property
left
bottom
right
top
ticklabels location
"-"
"+"
"+"
"-"
axislabel location
"-"
"+"
"+"
"-"
ticklabels angle
90
0
-90
180
ticklabel va
center
baseline
center
baseline
ticklabel ha
right
center
right
center
axislabel angle
180
0
0
180
axislabel va
center
top
center
bottom
axislabel ha
right
center
right
center
Note that the direction "+" and "-" are relative to the direction of the increasing coordinate. Also, the text angles are actually relative to (90 + angle of the direction to the ticklabel), which gives 0 for bottom axis.
- set_axislabel_direction(label_direction)[source]¶
Adjust the direction of the axislabel.
Note that the label_directions '+' and '-' are relative to the direction of the increasing coordinate.
- Parameters
- label_direction{"+", "-"}
- set_axisline_style(axisline_style=None, **kwargs)[source]¶
Set the axisline style.
The new style is completely defined by the passed attributes. Existing style attributes are forgotten.
- Parameters
- axisline_stylestr or None
The line style, e.g. '->', optionally followed by a comma-separated list of attributes. Alternatively, the attributes can be provided as keywords.
If None this returns a string containing the available styles.
Examples
The following two commands are equal: >>> set_axisline_style("->,size=1.5") >>> set_axisline_style("->", size=1.5)
- set_label(s)[source]¶
Set a label that will be displayed in the legend.
- Parameters
- sobject
s will be converted to a string by calling
str
.
- set_ticklabel_direction(tick_direction)[source]¶
Adjust the direction of the ticklabel.
Note that the label_directions '+' and '-' are relative to the direction of the increasing coordinate.
- Parameters
- tick_direction{"+", "-"}
- toggle(all=None, ticks=None, ticklabels=None, label=None)[source]¶
Toggle visibility of ticks, ticklabels, and (axis) label. To turn all off,
axis.toggle(all=False)
To turn all off but ticks on
axis.toggle(all=False, ticks=True)
To turn all on but (axis) label off
axis.toggle(all=True, label=False))
- zorder = 2.5¶