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 ---------- arg : { None, 4-tuple, Axes } The exact behavior of this func
(arg=None, **kwargs)
| 778 | |
| 779 | @docstring.dedent_interpd |
| 780 | def axes(arg=None, **kwargs): |
| 781 | """ |
| 782 | Add an axes to the current figure and make it the current axes. |
| 783 | |
| 784 | Call signatures:: |
| 785 | |
| 786 | plt.axes() |
| 787 | plt.axes(rect, projection=None, polar=False, **kwargs) |
| 788 | plt.axes(ax) |
| 789 | |
| 790 | Parameters |
| 791 | ---------- |
| 792 | arg : { None, 4-tuple, Axes } |
| 793 | The exact behavior of this function depends on the type: |
| 794 | |
| 795 | - *None*: A new full window axes is added using |
| 796 | ``subplot(111, **kwargs)`` |
| 797 | - 4-tuple of floats *rect* = ``[left, bottom, width, height]``. |
| 798 | A new axes is added with dimensions *rect* in normalized |
| 799 | (0, 1) units using `~.Figure.add_axes` on the current figure. |
| 800 | - `~.axes.Axes`: This is equivalent to `.pyplot.sca`. |
| 801 | It sets the current axes to *arg*. Note: This implicitly |
| 802 | changes the current figure to the parent of *arg*. |
| 803 | |
| 804 | .. note:: The use of an `.axes.Axes` as an argument is deprecated |
| 805 | and will be removed in v3.0. Please use `.pyplot.sca` |
| 806 | instead. |
| 807 | |
| 808 | projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', \ |
| 809 | 'polar', 'rectilinear', str}, optional |
| 810 | The projection type of the `~.axes.Axes`. *str* is the name of |
| 811 | a costum projection, see `~matplotlib.projections`. The default |
| 812 | None results in a 'rectilinear' projection. |
| 813 | |
| 814 | polar : boolean, optional |
| 815 | If True, equivalent to projection='polar'. |
| 816 | |
| 817 | sharex, sharey : `~.axes.Axes`, optional |
| 818 | Share the x or y `~matplotlib.axis` with sharex and/or sharey. |
| 819 | The axis will have the same limits, ticks, and scale as the axis |
| 820 | of the shared axes. |
| 821 | |
| 822 | |
| 823 | label : str |
| 824 | A label for the returned axes. |
| 825 | |
| 826 | Other Parameters |
| 827 | ---------------- |
| 828 | **kwargs |
| 829 | This method also takes the keyword arguments for |
| 830 | the returned axes class. The keyword arguments for the |
| 831 | rectilinear axes class `~.axes.Axes` can be found in |
| 832 | the following table but there might also be other keyword |
| 833 | arguments if another projection is used, see the actual axes |
| 834 | class. |
| 835 | %(Axes)s |
| 836 | |
| 837 | Returns |
nothing calls this directly
no test coverage detected