Figure.histogram: Add parameters to annote bars and deprecate parameter 'annotate'

examples/tutorials/advanced/cartesian_histograms.py

@@ -202,7 +202,7 @@
 # To create a histogram showing the cumulative values set ``cumulative=True``. Here, the
 # bars of the cumulative histogram are filled with a :class:`pygmt.params.Pattern` via
 # the ``fill`` parameter. Annotate each bar with the counts it represents using the
-# ``annotate`` parameter.
+# ``annot`` parameter.
 
 fig = pygmt.Figure()
 
@@ -220,8 +220,7 @@
     fill="red3",
     pen="1p,darkgray,solid",
     histtype=0,
-    # Annotate each bar with the counts it represents
-    annotate=True,
+    annot=True,
 )
 
 fig.shift_origin(xshift="w+1c")
@@ -241,10 +240,9 @@
     fill=Pattern(8, bgcolor="white", fgcolor="black"),
     pen="1p,darkgray,solid",
     histtype=0,
-    # Show cumulative counts
-    cumulative=True,
-    # Offset ("+o") the label by 10 points in negative y-direction
-    annotate="+o-10p",
+    cumulative=True,  # Show cumulative counts
+    annot=True,
+    annot_offset="-10p",  # Offset the annotations by 10 points in negative y-direction
 )
 
 fig.show()

pygmt/src/histogram.py

@@ -21,11 +21,61 @@
 __doctest_skip__ = ["histogram"]
 
 
+def _alias_option_D(  # ruff: ignore[invalid-function-name]
+    annot: bool = False,
+    annot_position: Literal["start", "end"] = "end",
+    annot_font: str | None = None,
+    annot_offset: float | str | None = None,
+    annot_orientation: Literal["horizontal", "vertical"] = "horizontal",
+):
+    """
+    Helper function to build the -D option for the histogram module.
+
+    >>> def parse(**kwargs):
+    ...     return AliasSystem(D=_alias_option_D(**kwargs)).get("D")
+
+    >>> parse(annot=False)
+    >>> parse(annot=True)
+    ''
+    >>> parse(
+    ...     annot=True,
+    ...     annot_position="start",
+    ...     annot_font="12p,Helvetica-Bold",
+    ...     annot_offset="6p",
+    ...     annot_orientation="vertical",
+    ... )
+    '+b+f12p,Helvetica-Bold+o6p+r'
+
+    >>> # annot_* parameters are ignored if annot is not set
+    >>> parse(annot_position="start")
+    """
+    # Ignore any annot_* parameter if annot is not set.
+    if not annot:
+        return Alias(False, name="annot")
+
+    # If annot is set, return a list of Alias objects for the annot_* parameters.
+    return [
+        Alias(
+            annot_position,
+            name="annot_position",
+            mapping={"start": "+b", "end": ""},
+        ),
+        Alias(annot_font, name="annot_font", prefix="+f"),
+        Alias(annot_offset, name="annot_offset", prefix="+o"),
+        Alias(
+            annot_orientation,
+            name="annot_orientation",
+            mapping={"horizontal": "", "vertical": "+r"},
+        ),
+    ]
+
+
 @fmt_docstring
 # TODO(PyGMT>=0.22.0): Remove the deprecated "extreme" parameter.
+# TODO(PyGMT>=0.22.0): Remove the deprecated "annotate" parameter.
 @deprecate_parameter("extreme", "out_range", "0.20.0", remove_version="0.22.0")
+@deprecate_parameter("annotate", "annot", "0.20.0", remove_version="0.22.0")
 @use_alias(
-    D="annotate",
     N="distribution",
     T="series",
     Z="histtype",
@@ -45,6 +95,11 @@ def histogram(
     cmap: str | bool = False,
     pen: str | None = None,
     fill: str | Pattern | None = None,
+    annot: bool = False,
+    annot_position: Literal["start", "end"] = "end",
+    annot_font: str | None = None,
+    annot_offset: float | str | None = None,
+    annot_orientation: Literal["horizontal", "vertical"] = "horizontal",
     horizontal: bool = False,
     center: bool = False,
     out_range: Literal["first", "last", "both"] | None = None,
@@ -70,6 +125,8 @@ def histogram(
        - A = horizontal
        - B = frame
        - C = cmap
+       - D = annot, **+b**: annot_position, **+f**: annot_font, **+o**: annot_offset,
+         **+r**: annot_orientation
        - E = bar_width, **+o**: bar_offset
        - G = fill
        - J = projection
@@ -95,14 +152,21 @@ def histogram(
         [Default is no outline].
     fill
          Set color or pattern for filling bars [Default is no fill].
-    annotate : bool or str
-        [**+b**][**+f**\ *font*][**+o**\ *off*][**+r**].
-        Annotate each bar with the count it represents. Append any of the
-        following modifiers: Use **+b** to place the labels beneath the bars
-        instead of above; use **+f** to change to another font than the default
-        annotation font; use **+o** to change the offset between bar and
-        label [Default is ``"6p"``]; use **+r** to rotate the labels from
-        horizontal to vertical.
+    annot
+        If ``True``, annotate each bar with the value it represents. The remaining
+        ``annot_*`` parameters control how the annotations look and are ignored if
+        ``annot`` is not set.
+    annot_position
+        Position of the annotations relative to the bars. Valid values are ``"start"``
+        and ``"end"``.
+    annot_font
+        Font of the annotations [Default is :gmt-term:`FONT_ANNOT_PRIMARY`].
+    annot_offset
+        Offset between a bar and its annotation, with an optional
+        :ref:`dimension unit <dimension-units>` [Default is ``"6p"``].
+    annot_orientation
+        Orientation of the annotations. Valid values are ``"horizontal"`` and
+        ``"vertical"``.
     bar_width
         Use an alternative histogram bar width than the default set via ``series``. Give
         either an alternative width in data units, or the user may append a
@@ -190,6 +254,13 @@ def histogram(
     aliasdict = AliasSystem(
         A=Alias(horizontal, name="horizontal"),
         C=Alias(cmap, name="cmap"),
+        D=_alias_option_D(
+            annot=annot,
+            annot_position=annot_position,
+            annot_font=annot_font,
+            annot_offset=annot_offset,
+            annot_orientation=annot_orientation,
+        ),
         E=[
             Alias(bar_width, name="bar_width"),
             Alias(bar_offset, name="bar_offset", prefix="+o"),