Skip to content

Commit

Permalink
com
Browse files Browse the repository at this point in the history
  • Loading branch information
joa-quim committed Jun 16, 2024
1 parent bc31c1a commit 37fe06d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions documentation/modules/inset.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ in a mix mode in _one-liners_ commands. It is mixed because the functioning reli
_modern_ modes (in a way transparent to the user). And, as just said, this mix mode consists in calling the `inset`
function as an option to the `plot`, `basemap` and `grdimage` functions. Since we are doing a nested call, we need
to pass all options as argument to `inset` and this ofc reduces the number of possibilities but still, it offers
quite nice features that allow creating elaborated figures with very short commands. The myreflink{Figure insets}
quite nice features that allow creating elaborated figures with very short commands. The \myreflink{Figure insets}
shows several examples of this usage.

The inset windows are located according to an algorithm that tries to avoid overlapping lines in line plots (with
Expand All @@ -111,7 +111,7 @@ wth **position** option explained above.
- **inset** -- *inset=(data, zoom=(...), coast=(...), position=(...), box=(...), clearance=(...))*\

- **data** An image, a grid a table (GMTdataset) or a file name that can be automatically read by
myreflink{gmtread}. Depending on the data type an _x,y_ plot or an image is displayed inside the inset window.
\myreflink{gmtread}. Depending on the data type an _x,y_ plot or an image is displayed inside the inset window.

- **zoom** This refers to an area of the main window that we wish to make a zoom of. Its arguments depend
on whether we are zooming an _x,y_ plot or an image. In the first case we pass an _x_ location and a half-width.
Expand All @@ -125,8 +125,8 @@ wth **position** option explained above.
in the inset. But since in this case the inset does not have to share the same coordinates with main figure, we
only provide here the point coordinates of the interesting area. The syntax is hence `pzoom=(x0,y0)`.

- **coast** With this argument we can call the myreflink{coast} command with all of its normal arguments. And
furthermore, we can even call the myreflink{plot} (or any of its avatars) to add line/symbol plots over the
- **coast** With this argument we can call the \myreflink{coast} command with all of its normal arguments. And
furthermore, we can even call the \myreflink{plot} (or any of its avatars) to add line/symbol plots over the
inset map. A further option to this form of calling `coast` is the option `rect=?`. If `?` is `true`, it will
plot a 0.75 pt blue rectangle showing the main window limits. Alternatives is `rect=number`, `rect=color` or
`rect=(number, color)`, where `color` is a color name and `number` is the rectangle line thickness in points
Expand Down

0 comments on commit 37fe06d

Please sign in to comment.