pygmt.params.Frame

class pygmt.params.Frame(axis=None, x=None, y=None, z=None, xp=None, yp=None, zp=None, xs=None, ys=None, zs=None, axes=None, fill=None, title=None, subtitle=None, box=False, pen=False, yzfill=None, xzfill=None, xyfill=None, pole=None)[source]

Class for setting up the frame of a plot.

axis: Axis | None = None

Specify the attributes for each axis.

axis means specifying the same attributes for all axes. x, y, z mean specifying attributes for the x-, y-, and z-axes, respectively, while xp, yp, zp mean specifying attributes for the x-, y-, and z-axes’ primary axes, and xs, ys, zs mean specifying attributes for the x-, y-, and z-axes’ secondary axes.

axes: str | None = None: Specify which axes to draw and their attributes.

fill: 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.

title: str | None = None: The title string centered above the plot frame [Default is no title].

subtitle: str | None = None: The subtitle string beneath the title [Default is no subtitle]. This requires title to be set.

box: bool = False: [For 3-D plots only] Draw the foreground lines of the 3-D cube .

pen: str | bool = False: [For 3-D plots only] If True, draw the outlines of the x-z and y-z planes. Set pen to specify different pen attributes [default is MAP_GRID_PEN_PRIMARY].

yzfill: str | None = None: Fill the y-z plane with specified color/pattern.

xzfill: str | None = None: Fill the x-z plane with specified color/pattern.

xyfill: str | None = None: Fill the x-y plane with specified color/pattern.

pole: Sequence[float | str] | None = None: Specify another pole (lon, lat) to produce oblique gridlines about the specified pole rather than the default [default references to the North pole]. Ignored if no gridlines are requested. Note: One cannot specify oblique gridlines for non-geographic projections as well as the oblique Mercator projection.