matplotlib.axes.Axes — Matplotlib 3.10.1 documentation (original) (raw)
class matplotlib.axes.Axes(fig, *args, facecolor=None, frameon=True, sharex=None, sharey=None, label='', xscale=None, yscale=None, box_aspect=None, forward_navigation_events='auto', **kwargs)[source]#
An Axes object encapsulates all the elements of an individual (sub-)plot in a figure.
It contains most of the (sub-)plot elements: Axis,Tick, Line2D, Text, Polygon, etc., and sets the coordinate system.
Like all visible elements in a figure, Axes is an Artist subclass.
The Axes instance supports callbacks through a callbacks attribute which is a CallbackRegistry instance. The events you can connect to are 'xlim_changed' and 'ylim_changed' and the callback will be called with func(ax) where ax is the Axes instance.
Build an Axes in a figure.
Parameters:
figFigure
The Axes is built in the Figure fig.
*args
*args can be a single (left, bottom, width, height)rectangle or a single Bbox. This specifies the rectangle (in figure coordinates) where the Axes is positioned.
*args can also consist of three numbers or a single three-digit number; in the latter case, the digits are considered as independent numbers. The numbers are interpreted as (nrows, ncols, index): (nrows, ncols) specifies the size of an array of subplots, and index is the 1-based index of the subplot being created. Finally, *args can also directly be aSubplotSpec instance.
sharex, shareyAxes, optional
The x- or y-axis is shared with the x- or y-axis in the input Axes. Note that it is not possible to unshare axes.
frameonbool, default: True
Whether the Axes frame is visible.
box_aspectfloat, optional
Set a fixed aspect for the Axes box, i.e. the ratio of height to width. See set_box_aspect for details.
forward_navigation_eventsbool or "auto", default: "auto"
Control whether pan/zoom events are passed through to Axes below this one. "auto" is True for axes with an invisible patch and_False_ otherwise.
**kwargs
Other optional keyword arguments:
Returns:
The new Axes object.