Skip to content

Commit b109eeb

Browse files
committed
minor - add info on clipping to m.add_gridlines
1 parent 7c5ed90 commit b109eeb

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

eomaps/grid.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1018,6 +1018,15 @@ def add_grid(
10181018
10191019
The default is: (ec="0.2", lw=0.5, zorder=100)
10201020
1021+
Other Parameters
1022+
----------------
1023+
clip_on: bool, optional
1024+
If True, clip the gridlines at the map-boundary.
1025+
If False, clip the gridliens at the figure-boundary.
1026+
This is useful if you want gridlines to extend beyond custom map-boundaries
1027+
set with :py:meth:`Maps.set_frame`.
1028+
Note: This has to be set for the grid-labels as well!
1029+
10211030
Returns
10221031
-------
10231032
g : GridLines

0 commit comments

Comments
 (0)