mpl_toolkits.axes_grid1.mpl_axes.Axes#

classmpl_toolkits.axes_grid1.mpl_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]#

Bases: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.

classAxisDict(axes)[source]#

Bases:dict

__call__(*v,**kwargs)[source]#

Call self as a function.

propertyaxis#

Convenience method to get or set some axis properties.

Call signatures:

xmin,xmax,ymin,ymax=axis()xmin,xmax,ymin,ymax=axis([xmin,xmax,ymin,ymax])xmin,xmax,ymin,ymax=axis(option)xmin,xmax,ymin,ymax=axis(**kwargs)

Parameters:

xmin, xmax, ymin, ymaxfloat, optional

The axis limits to be set. This can also be achieved using

ax.set(xlim=(xmin,xmax),ylim=(ymin,ymax))

optionbool or str

If a bool, turns axis lines and labels on or off. If a string,possible values are:

Value	Description
'off' orFalse	Hide all axis decorations, i.e. axis labels, spines,tick marks, tick labels, and grid lines.This is the same asset_axis_off().
'on' orTrue	Do not hide all axis decorations, i.e. axis labels, spines,tick marks, tick labels, and grid lines.This is the same asset_axis_on().
'equal'	Set equal scaling (i.e., make circles circular) bychanging the axis limits. This is the same asax.set_aspect('equal',adjustable='datalim').Explicit data limits may not be respected in this case.
'scaled'	Set equal scaling (i.e., make circles circular) bychanging dimensions of the plot box. This is the same asax.set_aspect('equal',adjustable='box',anchor='C').Additionally, further autoscaling will be disabled.
'tight'	Set limits just large enough to show all data, thendisable further autoscaling.
'auto'	Automatic scaling (fill plot box with data).
'image'	'scaled' with axis limits equal to data limits.
'square'	Square plot; similar to 'scaled', but initially forcingxmax-xmin==ymax-ymin.

emitbool, default: True

Whether observers are notified of the axis limit change.This option is passed on toset_xlim andset_ylim.

Returns:

xmin, xmax, ymin, ymaxfloat

The axis limits.

See also

matplotlib.axes.Axes.set_xlim

matplotlib.axes.Axes.set_ylim

Notes

For 3D Axes, this method additionally takeszmin,zmax asparameters and likewise returns them.

clear()[source]#

Clear the Axes.

set(*,adjustable=<UNSET>,agg_filter=<UNSET>,alpha=<UNSET>,anchor=<UNSET>,animated=<UNSET>,aspect=<UNSET>,autoscale_on=<UNSET>,autoscalex_on=<UNSET>,autoscaley_on=<UNSET>,axes_locator=<UNSET>,axisbelow=<UNSET>,box_aspect=<UNSET>,clip_box=<UNSET>,clip_on=<UNSET>,clip_path=<UNSET>,facecolor=<UNSET>,forward_navigation_events=<UNSET>,frame_on=<UNSET>,gid=<UNSET>,in_layout=<UNSET>,label=<UNSET>,mouseover=<UNSET>,navigate=<UNSET>,path_effects=<UNSET>,picker=<UNSET>,position=<UNSET>,prop_cycle=<UNSET>,rasterization_zorder=<UNSET>,rasterized=<UNSET>,sketch_params=<UNSET>,snap=<UNSET>,subplotspec=<UNSET>,title=<UNSET>,transform=<UNSET>,url=<UNSET>,visible=<UNSET>,xbound=<UNSET>,xinverted=<UNSET>,xlabel=<UNSET>,xlim=<UNSET>,xmargin=<UNSET>,xscale=<UNSET>,xticklabels=<UNSET>,xticks=<UNSET>,ybound=<UNSET>,yinverted=<UNSET>,ylabel=<UNSET>,ylim=<UNSET>,ymargin=<UNSET>,yscale=<UNSET>,yticklabels=<UNSET>,yticks=<UNSET>,zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

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

Examples usingmpl_toolkits.axes_grid1.mpl_axes.Axes#

Demo Axes Grid

Demo Axes Grid

Axes Grid2

Axes Grid2

Parasite Simple2

Parasite Simple2

Simple ImageGrid

Simple ImageGrid

Simple ImageGrid 2

Simple ImageGrid 2

Tight layout guide

Tight layout guide