matplotlib.pyplot.axes¶
-
matplotlib.pyplot.axes(arg=None, **kwargs)[source]¶ Add an axes to the current figure and make it the current axes.
Call signatures:
plt.axes() plt.axes(rect, projection=None, polar=False, **kwargs) plt.axes(ax)
Parameters: - argNone or 4-tuple
The exact behavior of this function depends on the type:
- None: A new full window axes is added using
subplot(111, **kwargs). - 4-tuple of floats rect =
[left, bottom, width, height]. A new axes is added with dimensions rect in normalized (0, 1) units usingadd_axeson the current figure.
- None: A new full window axes is added using
- projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional
The projection type of the
Axes. str is the name of a custom projection, seeprojections. The default None results in a 'rectilinear' projection.- polarbool, default: False
If True, equivalent to projection='polar'.
- sharex, sharey
Axes, optional Share the x or y
axiswith sharex and/or sharey. The axis will have the same limits, ticks, and scale as the axis of the shared axes.- labelstr
A label for the returned axes.
Returns: Axes, or a subclass ofAxesThe returned axes class depends on the projection used. It is
Axesif rectilinear projection is used andprojections.polar.PolarAxesif polar projection is used.
Other Parameters: - **kwargs
This method also takes the keyword arguments for the returned axes class. The keyword arguments for the rectilinear axes class
Axescan be found in the following table but there might also be other keyword arguments if another projection is used, see the actual axes class.Property Description adjustable{'box', 'datalim'} agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat or None anchor2-tuple of floats or {'C', 'SW', 'S', 'SE', ...} animatedbool aspect{'auto'} or num autoscale_onbool autoscalex_onbool autoscaley_onbool axes_locatorCallable[[Axes, Renderer], Bbox] axisbelowbool or 'line' box_aspectNone, or a number clip_boxBboxclip_onbool clip_pathPatch or (Path, Transform) or None containsunknown facecoloror fccolor figureFigureframe_onbool gidstr in_layoutbool labelobject navigatebool navigate_modeunknown path_effectsAbstractPathEffectpickerNone or bool or callable position[left, bottom, width, height] or Bboxprop_cycleunknown rasterization_zorderfloat or None rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None titlestr transformTransformurlstr visiblebool xboundunknown xlabelstr xlim(bottom: float, top: float) xmarginfloat greater than -0.5 xscale{"linear", "log", "symlog", "logit", ...} xticklabelsunknown xticksunknown yboundunknown ylabelstr ylim(bottom: float, top: float) ymarginfloat greater than -0.5 yscale{"linear", "log", "symlog", "logit", ...} yticklabelsunknown yticksunknown zorderfloat
Notes
If the figure already has a axes with key (args, kwargs) then it will simply make that axes current and return it. This behavior is deprecated. Meanwhile, if you do not want this behavior (i.e., you want to force the creation of a new axes), you must use a unique set of args and kwargs. The axes label attribute has been exposed for this purpose: if you want two axes that are otherwise identical to be added to the figure, make sure you give them unique labels.
Examples
# Creating a new full window axes plt.axes() # Creating a new axes with specified dimensions and some kwargs plt.axes((left, bottom, width, height), facecolor='w')