pygmt.params.Box

class pygmt.params.Box(clearance=None, fill=None, inner_gap=None, inner_pen=None, pen=None, radius=False, shading_offset=None, shading_fill=None)[source]

Class for specifying the box around GMT embellishments.

Variables:

clearance –
Set clearances between the embellishment and the box border. It can be either a scalar value or a sequence of two/four values.
- a scalar value means a uniform clearance in all four directions.
- a sequence of two values means separate clearances in x- and y-directions.
- a sequence of four values means separate clearances for left/right/bottom/top.
fill – Fill for the box [Default is no fill].
pen – Pen attributes for the box outline.
radius – Draw a rounded rectangular border instead of sharp. Passing a value with unit to control the corner radius [Default is "6p"].
inner_gap – Gap between the outer and inner borders [Default is "2p"].
inner_pen – Pen attributes for the inner border. Default to MAP_DEFAULT_PEN.
shading_offset – Place an offset background shaded region behind the box. A sequence of two values (dx, dy) indicates the shift relative to the foreground frame [Default is ("4p", "-4p")].
shading_fill – Fill for the shading region [Default is "gray50"].

Examples

>>> from pygmt.params import Box
>>> str(Box(fill="red@20"))
'+gred@20'
>>> str(Box(clearance=(0.2, 0.2), fill="red@20", pen="blue"))
'+c0.2/0.2+gred@20+pblue'
>>> str(Box(clearance=(0.2, 0.2), pen="blue", radius=True))
'+c0.2/0.2+pblue+r'
>>> str(Box(clearance=(0.1, 0.2, 0.3, 0.4), pen="blue", radius="10p"))
'+c0.1/0.2/0.3/0.4+pblue+r10p'
>>> str(
...     Box(
...         clearance=0.2,
...         pen="blue",
...         radius="10p",
...         shading_offset=("5p", "5p"),
...         shading_fill="lightred",
...     )
... )
'+c0.2+pblue+r10p+s5p/5p/lightred'
>>> str(Box(clearance=0.2, inner_gap="2p", inner_pen="1p,red", pen="blue"))
'+c0.2+i2p/1p,red+pblue'
>>> str(Box(clearance=0.2, shading_offset=("5p", "5p"), shading_fill="lightred"))
'+c0.2+s5p/5p/lightred'