diff --git a/doc/api/index.rst b/doc/api/index.rst index 3656bba286e..5c4c4cc0ed6 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -213,6 +213,7 @@ Class-style Parameters :template: autosummary/params.rst Box + Frame Pattern Enums diff --git a/pygmt/params/__init__.py b/pygmt/params/__init__.py index b80b921407a..12a788e3352 100644 --- a/pygmt/params/__init__.py +++ b/pygmt/params/__init__.py @@ -3,4 +3,5 @@ """ from pygmt.params.box import Box +from pygmt.params.frame import Axes, Axis, Frame from pygmt.params.pattern import Pattern diff --git a/pygmt/params/frame.py b/pygmt/params/frame.py new file mode 100644 index 00000000000..6c4c2969cfa --- /dev/null +++ b/pygmt/params/frame.py @@ -0,0 +1,139 @@ +""" +The Axes, Axis, and Frame classes for specifying the frame. +""" + +import dataclasses +from typing import Any, Literal + +from pygmt.alias import Alias +from pygmt.params.base import BaseParam + + +@dataclasses.dataclass(repr=False) +class Axis(BaseParam): + """ + Class for setting up one axis of a plot. + """ + + #: Intervals for annotations and major tick spacing, minor tick spacing, and/or + #: grid line spacing. + interval: float | str + + #: Plot slanted annotations (for Cartesian plots only), where *angle* is measured + #: with respect to the horizontal and must be in the -90 <= *angle* <= 90 range. + #: Default is normal (i.e., ``angle=90``) for y-axis and parallel (i.e., + #: ``angle=0``) for x-axis annotations. These defaults can be changed via + #: :gmt-term:`MAP_ANNOT_ORTHO`. + angle: float | None = None + + #: Skip annotations that fall exactly at the ends of the axis. Choose from ``left`` + #: or ``right`` to skip only the lower or upper annotation, respectively, or + #: ``True`` to skip both. + skip_edge: Literal["left", "right"] | bool = False + + #: Give fancy annotations with W|E|S|N suffixes encoding the sign (for geographic + #: axes only). + fancy: bool = False + + #: Add a label to the axis (for Cartesian plots only). The label is placed parallel + #: to the axis by default; use **hlabel** to force a horizontal label for y-axis, + #: which is useful for very short labels. + label: str | None = None + hlabel: str | None = None + + #: Add an alternate label for the right or upper axes. The label is placed parallel + #: to the axis by default; use **alt_hlabel** to force a horizontal label for + #: y-axis, which is useful for very short labels. [For Cartesian plots only]. + alt_label: str | None = None + alt_hlabel: str | None = None + + #: Add a leading text prefix for axis annotation (e.g., dollar sign for plots + #: related to money) (for Cartesian plots only). For geographic maps the addition + #: of degree symbols, etc. is automatic and controlled by + #: :gmt-term:`FORMAT_GEO_MAP`. + prefix: str | None = None + + #: Append a unit to the annotations (for Cartesian plots only). For geographic maps + #: the addition of degree symbols, etc. is automatic and controlled by + #: :gmt-term:`FORMAT_GEO_MAP`. + unit: str | None = None + + @property + def _aliases(self): + return [ + Alias(self.interval, name="interval"), + Alias(self.angle, name="angle", prefix="+a"), + Alias( + self.skip_edge, + name="skip_edge", + prefix="+e", + mapping={True: True, "left": "l", "right": "r"}, + ), + Alias(self.fancy, name="fancy", prefix="+f"), + Alias(self.label, name="label", prefix="+l"), + Alias(self.hlabel, name="hlabel", prefix="+L"), + Alias(self.alt_label, name="alt_label", prefix="+s"), + Alias(self.alt_hlabel, name="alt_hlabel", prefix="+S"), + Alias(self.unit, name="unit", prefix="+u"), + ] + + +@dataclasses.dataclass(repr=False) +class Axes(BaseParam): + """ + Class for specifying the frame of a plot. + """ + + #: Specify which axes to draw and their attributes. + axes: str | None = None + + #: Fill for the interior of the canvas [Default is no fill]. This also sets fill + #: for the two back-walls in 3-D plots. + fill: str | None = None + + #: The title string centered above the plot frame [Default is no title]. + title: str | None = None + + #: The subtitle string beneath the title [Default is no subtitle]. This requires + #: ``title`` to be set. + subtitle: str | None = None + + @property + def _aliases(self): + return [ + Alias(self.axes, name="axes"), + Alias(self.fill, name="fill", prefix="+g"), + Alias(self.title, name="title", prefix="+t"), + Alias(self.subtitle, name="subtitle", prefix="+s"), + ] + + +@dataclasses.dataclass(repr=False) +class Frame(BaseParam): + """ + Class for setting up the frame of a plot. + """ + + axes: Any = None + xaxis: Any = None + yaxis: Any = None + zaxis: Any = None + + @property + def _aliases(self): + return [ + Alias(self.axes), + Alias(self.xaxis, prefix="x"), + Alias(self.yaxis, prefix="y"), + Alias(self.zaxis, prefix="z"), + ] + + def __iter__(self): + """ + Iterate over the aliases of the class. + + Yields + ------ + The value of each alias in the class. None are excluded. + """ + yield from (alias._value for alias in self._aliases if alias._value is not None) diff --git a/pygmt/tests/test_params_frame.py b/pygmt/tests/test_params_frame.py new file mode 100644 index 00000000000..85de1bb406b --- /dev/null +++ b/pygmt/tests/test_params_frame.py @@ -0,0 +1,30 @@ +""" +Test the Frame/Axes/Axis classes. +""" + +from pygmt.params import Axes, Axis + + +def test_params_axis(): + """ + Test the Axis class. + """ + assert str(Axis(interval="a1f0.5")) == "a1f0.5" + assert str(Axis(interval="a1f0.5", angle=30)) == "a1f0.5+a30" + assert str(Axis(interval="a1f0.5", angle=30, skip_edge="left")) == "a1f0.5+a30+el" + assert str(Axis(interval="a1f0.5", fancy=True)) == "a1f0.5+f" + assert str(Axis(interval="a1f0.5", label="My Label")) == "a1f0.5+lMy Label" + assert str(Axis(interval="a1f0.5", hlabel="My HLabel")) == "a1f0.5+LMy HLabel" + assert str(Axis(interval="a1f0.5", alt_label="Alt Label")) == "a1f0.5+sAlt Label" + assert str(Axis(interval="a1f0.5", alt_hlabel="Alt HLabel")) == "a1f0.5+SAlt HLabel" + assert str(Axis(interval="a1f0.5", unit="km")) == "a1f0.5+ukm" + + +def test_params_axes(): + """ + Test the Axes class. + """ + assert ( + str(Axes("WSen", title="My Plot Title", fill="lightred")) + == "WSen+glightred+tMy Plot Title" + )