Alias ax (c) for subplot

Used to advance to the selected subplot panel. Technically only allowed when in subplot mode. See https://docs.generic-mapping-tools.org/latest/gmt.html#c-full.

Author: weiji14

pygmt/base_plotting.py

@@ -68,6 +68,7 @@ def _preprocess(self, **kwargs):  # pylint: disable=no-self-use
         G="land",
         S="water",
         U="timestamp",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence")
@@ -146,6 +147,7 @@ def coast(self, **kwargs):
         F="box",
         G="truncate",
         W="scale",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence", G="sequence")
@@ -228,6 +230,7 @@ def colorbar(self, **kwargs):
         S="resample",
         U="timestamp",
         W="pen",
+        c="ax",
         l="label",
         t="transparency",
     )
@@ -309,6 +312,7 @@ def grdcontour(self, grid, **kwargs):
         B="frame",
         I="shading",
         C="cmap",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence")
@@ -358,6 +362,7 @@ def grdimage(self, grid, **kwargs):
         Wf="facadepen",
         p="perspective",
         I="shading",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence", p="sequence")
@@ -476,6 +481,7 @@ def grdview(self, grid, **kwargs):
         l="label",
         C="cmap",
         U="timestamp",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence", i="sequence_comma")
@@ -597,6 +603,7 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
         i="columns",
         l="label",
         C="levels",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence", i="sequence_comma")
@@ -686,6 +693,7 @@ def contour(self, x=None, y=None, z=None, data=None, **kwargs):
         Td="rose",
         Tm="compass",
         U="timestamp",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence")
@@ -736,6 +744,7 @@ def basemap(self, **kwargs):
         U="timestamp",
         D="position",
         F="box",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence")
@@ -779,6 +788,7 @@ def logo(self, **kwargs):
         D="position",
         F="box",
         M="monochrome",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(R="sequence")
@@ -823,11 +833,7 @@ def image(self, imagefile, **kwargs):
 
     @fmt_docstring
     @use_alias(
-        R="region",
-        J="projection",
-        D="position",
-        F="box",
-        t="transparency",
+        R="region", J="projection", D="position", F="box", c="ax", t="transparency"
     )
     @kwargs_to_strings(R="sequence")
     def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwargs):
@@ -893,6 +899,7 @@ def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwarg
         D="offset",
         G="fill",
         W="pen",
+        c="ax",
         t="transparency",
     )
     @kwargs_to_strings(
@@ -1050,11 +1057,7 @@ def text(
 
     @fmt_docstring
     @use_alias(
-        R="region",
-        J="projection",
-        B="frame",
-        C="offset",
-        t="transparency",
+        R="region", J="projection", B="frame", C="offset", c="ax", t="transparency"
     )
     @kwargs_to_strings(R="sequence")
     def meca(

pygmt/figure.py

@@ -430,7 +430,7 @@ def sca(self, ax=None, **kwargs):
         """
         arg_str = " ".join(["set", f"{ax}", build_arg_string(kwargs)])
         with Session() as lib:
-            lib.call_module(module=f"subplot", args=arg_str)
+            lib.call_module(module="subplot", args=arg_str)
 
     @fmt_docstring
     @use_alias(V="verbose")

pygmt/tests/baseline/test_subplot_direct.png

@@ -32,3 +32,15 @@ def test_subplot_frame():
     fig.basemap(region=[0, 3, 0, 3], frame="+tplot1")
     fig.end_subplot()
     return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_subplot_direct():
+    """
+    Plot map elements to subplots directly using ax argument
+    """
+    fig, axs = subplots(nrows=2, ncols=1, figsize=("3c", "6c"))
+    fig.basemap(region=[0, 3, 0, 3], frame=True, ax=axs[0, 0])
+    fig.basemap(region=[0, 3, 0, 3], frame=True, ax=axs[1, 0])
+    fig.end_subplot()
+    return fig