Skip to content

Commit 2c977f5

Browse files
seismanweiji14
andauthored
Add "no_clip" to plot, text, contour and meca (#661)
Co-authored-by: Wei Ji <[email protected]>
1 parent bbab46e commit 2c977f5

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

pygmt/base_plotting.py

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -611,6 +611,7 @@ def grdview(self, grid, **kwargs):
611611
B="frame",
612612
S="style",
613613
G="color",
614+
N="no_clip",
614615
W="pen",
615616
i="columns",
616617
l="label",
@@ -683,6 +684,18 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
683684
``'[x|y|X|Y][+a][+cl|f][+n][+wcap][+ppen]'``.
684685
Draw symmetrical error bars.
685686
{G}
687+
no_clip : bool or str
688+
``'[c|r]'``.
689+
Do NOT clip symbols that fall outside map border [Default plots
690+
points whose coordinates are strictly inside the map border only].
691+
The option does not apply to lines and polygons which are always
692+
clipped to the map region. For periodic (360-longitude) maps we
693+
must plot all symbols twice in case they are clipped by the
694+
repeating boundary. ``no_clip=True`` will turn off clipping and not
695+
plot repeating symbols. Use ``no_clip="r"`` to turn off clipping
696+
but retain the plotting of such repeating symbols, or use
697+
``no_clip="c"`` to retain clipping but turn off plotting of
698+
repeating symbols.
686699
style : str
687700
Plot symbols (including vectors, pie slices, fronts, decorated or
688701
quoted lines).
@@ -748,6 +761,7 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
748761
G="label_placement",
749762
W="pen",
750763
L="triangular_mesh_pen",
764+
N="no_clip",
751765
i="columns",
752766
l="label",
753767
C="levels",
@@ -798,8 +812,9 @@ def contour(self, x=None, y=None, z=None, data=None, **kwargs):
798812
Color the triangles using CPT
799813
triangular_mesh_pen : str
800814
Pen to draw the underlying triangulation (default none)
801-
N : bool
802-
Do not clip contours
815+
no_clip : bool
816+
Do NOT clip contours or image at the boundaries [Default will clip
817+
to fit inside region].
803818
Q : float or str
804819
Do not draw contours with less than cut number of points.
805820
``'[cut[unit]][+z]'``
@@ -1085,6 +1100,7 @@ def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwarg
10851100
C="clearance",
10861101
D="offset",
10871102
G="fill",
1103+
N="no_clip",
10881104
V="verbose",
10891105
W="pen",
10901106
X="xshift",
@@ -1197,6 +1213,9 @@ def text(
11971213
Sets the pen used to draw a rectangle around the text string
11981214
(see *clearance*) [Default is width = default, color = black,
11991215
style = solid].
1216+
no_clip : bool
1217+
Do NOT clip text at map boundaries [Default is False, i.e. will
1218+
clip].
12001219
{V}
12011220
{XY}
12021221
{p}
@@ -1255,6 +1274,7 @@ def text(
12551274
J="projection",
12561275
B="frame",
12571276
C="offset",
1277+
N="no_clip",
12581278
V="verbose",
12591279
X="xshift",
12601280
Y="yshift",
@@ -1353,6 +1373,10 @@ def meca(
13531373
circle is plotted at the initial location and a line connects
13541374
the beachball to the circle. Specify pen and optionally append
13551375
``+ssize`` to change the line style and/or size of the circle.
1376+
no_clip : bool
1377+
Does NOT skip symbols that fall outside frame boundary specified by
1378+
*region* [Default is False, i.e. plot symbols inside map frame
1379+
only].
13561380
{J}
13571381
{R}
13581382
{B}

0 commit comments

Comments
 (0)