matplotlib.axes.Axes#

classmatplotlib.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 ina 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 anArtist subclass.

TheAxes instance supports callbacks through a callbacks attribute whichis aCallbackRegistry instance. The events you can connect toare 'xlim_changed' and 'ylim_changed' and the callback will be called withfunc(ax) whereax is theAxes instance.

Note

As a user, you do not instantiate Axes directly, but use Axes creationmethods instead; e.g. frompyplot orFigure:subplots,subplot_mosaic orFigure.add_axes.

Build an Axes in a figure.

Parameters:

figFigure

The Axes is built in theFigurefig.

*args

*args can be a single(left,bottom,width,height)rectangle or a singleBbox. This specifies the rectangle (infigure coordinates) where the Axes is positioned.

*args can also consist of three numbers or a single three-digitnumber; in the latter case, the digits are considered asindependent numbers. The numbers are interpreted as(nrows,ncols,index):(nrows,ncols) specifies the size of an arrayof subplots, andindex is the 1-based index of the subplotbeing 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 inthe inputAxes. Note that it is not possible to unshareaxes.

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 towidth. Seeset_box_aspect for details.

forward_navigation_eventsbool or "auto", default: "auto"

Control whether pan/zoom events are passed through to Axes belowthis one. "auto" isTrue for axes with an invisible patch andFalse otherwise.

**kwargs

Other optional keyword arguments:

Property	Description
adjustable	{'box', 'datalim'}
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
anchor	(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated	bool
aspect	{'auto', 'equal'} or float
autoscale_on	bool
autoscalex_on	unknown
autoscaley_on	unknown
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	bool or 'line'
box_aspect	float or None
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
facecolor orfc	color
figure	Figure orSubFigure
forward_navigation_events	bool or "auto"
frame_on	bool
gid	str
in_layout	bool
label	object
mouseover	bool
navigate	bool
navigate_mode	unknown
path_effects	list ofAbstractPathEffect
picker	None or bool or float or callable
position	[left, bottom, width, height] orBbox
prop_cycle	Cycler
rasterization_zorder	float or None
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
subplotspec	unknown
title	str
transform	Transform
url	str
visible	bool
xbound	(lower: float, upper: float)
xinverted	unknown
xlabel	str
xlim	(left: float, right: float)
xmargin	float greater than -0.5
xscale	unknown
xticklabels	unknown
xticks	unknown
ybound	(lower: float, upper: float)
yinverted	unknown
ylabel	str
ylim	(bottom: float, top: float)
ymargin	float greater than -0.5
yscale	unknown
yticklabels	unknown
yticks	unknown
zorder	float

Returns:

Axes

The newAxes object.