Skip to content

Commit 212735f

Browse files
PaulWesselseisman
authored andcommitted
Add missing descriptions for -D -F in classic psbasemap docs (#517)
1 parent 9e4cbfa commit 212735f

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

doc/rst/source/psbasemap.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,55 @@ Synopsis
3939

4040
.. include:: common_classic.rst_
4141

42+
.. _-D:
43+
44+
**-D**\ [*unit*]\ *xmin/xmax/ymin/ymax*\ [**r**][**+s**\ *file*][**+t**] \| **-D**\ [**g**\ \|\ **j**\ \|\ **J**\ \|\ **n**\ \|\ **x**]\ *refpoint*\ **+w**\ *width*\ [/*height*][**+j**\ *justify*][**+o**\ *dx*\ [/*dy*]][**+s**\ *file*][**+t**]
45+
Draw a simple map insert box on the map. Requires **-F**. Specify the box in one of three ways:
46+
(a) Give *west/east/south/north* of geographic rectangle bounded by parallels
47+
and meridians; append **r** if the coordinates instead are the lower left and
48+
upper right corners of the desired rectangle. (b) Give **u**\ *xmin/xmax/ymin/ymax*
49+
of bounding rectangle in projected coordinates (here, **u** is the coordinate unit).
50+
(c) Give the reference point on the map for the insert using one of four coordinate systems:
51+
(1) Use **-Dg** for map (user) coordinates, (2) use **-Dj** or **-DJ** for setting *refpoint* via
52+
a 2-char justification code that refers to the (invisible) map domain rectangle,
53+
(3) use **-Dn** for normalized (0-1) coordinates, or (4) use **-Dx** for plot coordinates
54+
(inches, cm, etc.).
55+
Append **+w**\ *width*\ [/*height*] of bounding rectangle or box in plot coordinates (inches, cm, etc.).
56+
By default, the anchor point on the scale is assumed to be the bottom left corner (BL), but this
57+
can be changed by appending **+j** followed by a 2-char justification code *justify* (see :doc:`pstext`).
58+
Note: If **-Dj** is used then *justify* defaults to the same as *refpoint*,
59+
if **-DJ** is used then *justify* defaults to the mirror opposite of *refpoint*.
60+
Add **+o** to offset the inset fig by *dx*/*dy* away from the *refpoint* point in
61+
the direction implied by *justify* (or the direction implied by **-Dj** or **-DJ**).
62+
If you need access to the placement of the lower left corner of the map insert and
63+
its dimensions in the current map unit, use **+s**\ *file* to write this information
64+
to *file*. Alternatively, you may append **+t** to translate the plot origin to
65+
the lower left corner of the map insert.
66+
Specify insert box attributes via the **-F** option [outline only].
67+
68+
.. _-F:
69+
70+
**-F**\ [**d**\ \|\ **l**\ \|\ **t**][\ **+c**\ *clearances*][\ **+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]][\ **+p**\ [*pen*]][\ **+r**\ [*radius*\ ]][\ **+s**\ [[*dx*/*dy*/][*shade*\ ]]]
71+
Without further options, draws a rectangular border around any map insert (**-D**),
72+
map scale (**-L**) or map rose (**-T**) using
73+
:ref:`MAP_FRAME_PEN <MAP_FRAME_PEN>`; specify a different pen with **+p**\ *pen*.
74+
Add **+g**\ *fill* to fill the logo box [no fill].
75+
Append **+c**\ *clearance* where *clearance* is either *gap*, *xgap*\ /\ *ygap*,
76+
or *lgap*\ /\ *rgap*\ /\ *bgap*\ /\ *tgap* where these items are uniform, separate in
77+
x- and y-direction, or individual side spacings between logo and border.
78+
Append **+i** to draw a secondary, inner border as well. We use a uniform
79+
*gap* between borders of 2\ **p** and the :ref:`MAP_DEFAULT_PEN <MAP_DEFAULT_PEN>`
80+
unless other values are specified. Append **+r** to draw rounded
81+
rectangular borders instead, with a 6\ **p** corner radius. You can
82+
override this radius by appending another value. Finally, append
83+
**+s** to draw an offset background shaded region. Here, *dx*/*dy*
84+
indicates the shift relative to the foreground frame
85+
[4\ **p**/-4\ **p**] and *shade* sets the fill style to use for shading [gray50].
86+
Used in combination with **-D**, **-L** or **-T**. To specify separate parameters
87+
for the various map features, append **d**\ \|\ **l**\ \|\ **t** to **-F**
88+
to specify panel parameters for just that panel [Default uses the same panel
89+
parameters for all selected map features].
90+
4291
Examples
4392
--------
4493

0 commit comments

Comments
 (0)