pygmt.params.Frame

class pygmt.params.Frame(axes=None, xaxis=None, yaxis=None, zaxis=None)

Class for setting up the frame of a plot.

>>> from pygmt.alias import AliasSystem, Alias
>>> from pygmt.params import Frame, Axes, Axis
>>> frame = Frame(
...     axes=Axes("WSen", title="My Plot Title", fill="lightred"),
...     xaxis=Axis(10, angle=30, label="X axis", unit="km"),
... )
>>> def func(frame):
...     alias = AliasSystem(B=Alias(frame))
...     return alias.kwdict
>>> dict(func(frame))
{'B': ['WSen+glightred+tMy Plot Title', 'x10+a30+lX axis+ukm']}

Attributes