Skip to content

Commit d3183e4

Browse files
jackbeagleyseismanweiji14
authored
Added alias for F in basemap (#1894)
Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Wei Ji <[email protected]>
1 parent 555cd31 commit d3183e4

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

pygmt/src/basemap.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
JZ="zsize",
2222
B="frame",
2323
L="map_scale",
24+
F="box",
2425
Td="rose",
2526
Tm="compass",
2627
U="timestamp",
@@ -61,6 +62,24 @@ def basemap(self, **kwargs):
6162
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
6263
**+w**\ *length*.
6364
Draws a simple map scale centered on the reference point specified.
65+
box : bool or str
66+
[**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]]\
67+
[**+p**\ [*pen*]][**+r**\ [*radius*]][**+s**\ [[*dx*/*dy*/][*shade*]]].
68+
If set to ``True``, draws a rectangular border around the
69+
map scale or rose. Alternatively, specify a different pen with
70+
**+p**\ *pen*. Add **+g**\ *fill* to fill the scale panel [default is
71+
no fill]. Append **+c**\ *clearance* where *clearance* is either gap,
72+
xgap/ygap, or lgap/rgap/bgap/tgap where these items are uniform,
73+
separate in x- and y-direction, or individual side spacings between
74+
scale and border. Append **+i** to draw a secondary, inner border as
75+
well. We use a uniform gap between borders of 2p and the
76+
:gmt-term:`MAP_DEFAULTS_PEN` unless other values are specified. Append
77+
**+r** to draw rounded rectangular borders instead, with a 6p corner
78+
radius. You can override this radius by appending another value.
79+
Finally, append **+s** to draw an offset background shaded region.
80+
Here, *dx/dy* indicates the shift relative to the foreground frame
81+
[Default is 4p/-4p] and shade sets the fill style to use for shading
82+
[default is gray50].
6483
rose : str
6584
Draws a map directional rose on the map at the location defined by
6685
the reference and anchor points.

0 commit comments

Comments
 (0)