Skip to content

Commit

Permalink
Figure.coast: Add alias "box" for "-F" (#2823)
Browse files Browse the repository at this point in the history
  • Loading branch information
yvonnefroehlich authored Dec 8, 2023
1 parent 6527a56 commit 1e48282
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions pygmt/src/coast.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,21 @@

@fmt_docstring
@use_alias(
R="region",
J="projection",
A="area_thresh",
C="lakes",
B="frame",
C="lakes",
D="resolution",
E="dcw",
F="box",
G="land",
I="rivers",
J="projection",
L="map_scale",
N="borders",
W="shorelines",
G="land",
R="region",
S="water",
V="verbose",
W="shorelines",
c="panel",
p="perspective",
t="transparency",
Expand Down Expand Up @@ -128,6 +129,24 @@ def coast(self, **kwargs):
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
**+w**\ *length*.
Draw a simple map scale centered on the reference point specified.
box : bool or str
[**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]]\
[**+p**\ [*pen*]][**+r**\ [*radius*]][**+s**\ [[*dx*/*dy*/][*shade*]]].
If set to ``True``, draw a rectangular border around the
map scale or rose. Alternatively, specify a different pen with
**+p**\ *pen*. Add **+g**\ *fill* to fill the scale panel [Default is
no fill]. Append **+c**\ *clearance* where *clearance* is either gap,
xgap/ygap, or lgap/rgap/bgap/tgap where these items are uniform,
separate in x- and y-direction, or individual side spacings between
scale and border. Append **+i** to draw a secondary, inner border as
well. We use a uniform gap between borders of 2p and the
:gmt-term:`MAP_DEFAULTS_PEN` unless other values are specified. Append
**+r** to draw rounded rectangular borders instead, with a 6p corner
radius. You can override this radius by appending another value.
Finally, append **+s** to draw an offset background shaded region.
Here, *dx/dy* indicates the shift relative to the foreground frame
[Default is ``"4p/-4p"``] and shade sets the fill style to use for
shading [Default is ``"gray50"``].
borders : int, str, or list
*border*\ [/*pen*].
Draw political boundaries. Specify the type of boundary and
Expand Down

0 comments on commit 1e48282

Please sign in to comment.