Figure.colorbar: Add parameters position/width/height and more to specify colorbar position and properties

Author: seisman

pygmt/src/colorbar.py

@@ -8,7 +8,7 @@
 from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
-from pygmt.params import Box
+from pygmt.params import Box, Position
 
 __doctest_skip__ = ["colorbar"]
 
@@ -17,19 +17,27 @@
 @use_alias(C="cmap", D="position", L="equalsize", Z="zfile")
 def colorbar(  # noqa: PLR0913
     self,
+    position: Position | None = None,
+    length: float | None = None,
+    width: float | None = None,
+    orientation: Literal["horizontal", "vertical"] = "vertical",
+    reverse: bool = False,
+    nan_rectangle=False,
+    sidebar_triangles=None,
+    move_annots=None,
+    box: Box | bool = False,
     truncate: Sequence[float] | None = None,
     shading: float | Sequence[float] | bool = False,
     log: bool = False,
     scale: float | None = None,
     projection: str | None = None,
-    box: Box | bool = False,
-    frame: str | Sequence[str] | bool = False,
     region: Sequence[float | str] | str | None = None,
+    frame: str | Sequence[str] | bool = False,
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | Sequence[int] | bool = False,
-    transparency: float | None = None,
     perspective: float | Sequence[float] | str | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -162,7 +170,22 @@ def colorbar(  # noqa: PLR0913
     """
     self._activate_figure()
 
+    _dimension = (length, width) if width is not None else length
+
     aliasdict = AliasSystem(
+        D=[
+            Alias(position, name="position"),
+            Alias(_dimension, name="width/height", prefix="+w", sep="/", size=2),
+            Alias(
+                orientation,
+                name="orientation",
+                mapping={"horizontal": "+h", "vertical": "+v"},
+            ),
+            Alias(reverse, name="reverse", prefix="+r"),
+            Alias(nan_rectangle, name="nan_rectangle", prefix="+n"),
+            Alias(sidebar_triangles, name="sidebar_triangles", prefix="+e"),
+            Alias(move_annots, name="move_annots", prefix="+m"),
+        ],
         F=Alias(box, name="box"),
         G=Alias(truncate, name="truncate", sep="/", size=2),
         I=Alias(shading, name="shading", sep="/", size=2),