matplotlib.pyplot.gca#

matplotlib.pyplot.gca(**kwargs)[source]#

Get the current Axes.

If there is currently no Axes on this Figure, a new one is createdusingFigure.add_subplot. (To test whether there is currently anAxes on a Figure, check whetherfigure.axes is empty. To testwhether there is currently a Figure on the pyplot figure stack, checkwhetherpyplot.get_fignums() is empty.)

The following kwargs are supported for ensuring the returned Axesadheres to the given projection etc., and for Axes creation ifthe active Axes does not exist:

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
scalar or None
anchor
(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated
bool
aspect
{'auto', 'equal'} or float
autoscale_on
bool
autoscalex_on
bool
autoscaley_on
bool
axes_locator
Callable[[Axes, Renderer], Bbox]
axisbelow
bool or 'line'
box_aspect
float or None
clip_box
Bbox
clip_on
bool
clip_path
Patch or (Path, Transform) or None
facecolor or fc
color
figure
Figure
frame_on
bool
gid
str
in_layout
bool
label
object
navigate
bool
navigate_mode
unknown
path_effects
AbstractPathEffect
picker
None or bool or float or callable
position
[left, bottom, width, height] orBbox
prop_cycle
unknown
rasterization_zorder
float or None
rasterized
bool
sketch_params
(scale: float, length: float, randomness: float)
snap
bool or None
title
str
transform
Transform
url
str
visible
bool
xbound
unknown
xlabel
str
xlim
(bottom: float, top: float)
xmargin
float greater than -0.5
xscale
{"linear", "log", "symlog", "logit", ...} orScaleBase
xticklabels
unknown
xticks
unknown
ybound
unknown
ylabel
str
ylim
(bottom: float, top: float)
ymargin
float greater than -0.5
yscale
{"linear", "log", "symlog", "logit", ...} orScaleBase
yticklabels
unknown
yticks
unknown
zorder
float

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`	scalar or None
`anchor`	(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} or float
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool or 'line'
`box_aspect`	float or None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`facecolor` or fc	color
`figure`	`Figure`
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	object
`navigate`	bool
`navigate_mode`	unknown
`path_effects`	`AbstractPathEffect`
`picker`	None or bool or float or callable
`position`	[left, bottom, width, height] or`Bbox`
`prop_cycle`	unknown
`rasterization_zorder`	float or None
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	unknown
`xlabel`	str
`xlim`	(bottom: float, top: float)
`xmargin`	float greater than -0.5
`xscale`	{"linear", "log", "symlog", "logit", ...} or`ScaleBase`
`xticklabels`	unknown
`xticks`	unknown
`ybound`	unknown
`ylabel`	str
`ylim`	(bottom: float, top: float)
`ymargin`	float greater than -0.5
`yscale`	{"linear", "log", "symlog", "logit", ...} or`ScaleBase`
`yticklabels`	unknown
`yticks`	unknown
`zorder`	float