pygmt.Figure.inset_begin

Figure.inset_begin(**kwargs)

Create an inset within a figure to plot an additional figure.

This function create the location, frame, and margins for an inset figure. This function can only be called once the original figure is created. Additional plotting functions are called afterwards to add to the inset figure. To stop adding to the inset figure and add to the original figure, use pygmt.Figure.inset_end.

Full option list at https://docs.generic-mapping-tools.org/latest/inset.html

Aliases:

  • D = location

  • F = border

  • M = margin

  • V = verbose

Parameters

location (str or list) –

xmin/xmax/ymin/ymax[+r][+uunit]] | [g|j|J|n|x]refpoint+wwidth[/height][+jjustify][+odx[/dy]] Define the map inset rectangle on the map. Specify the rectangle in one of three ways:

Append glon/lat for map (user) coordinates, jcode or Jcode for setting the refpoint via a 2-char justification code that refers to the (invisible) projected map bounding box, nxn/yn for normalized (0-1) bounding box coordinates, or xx/y for plot coordinates (inches, cm, points, append unit). All but x requires both region and projection to be specified. You can offset the reference point via +odx/dy in the direction implied by code or +jjustify.

Alternatively, Give west/east/south/north of geographic rectangle bounded by parallels and meridians; append +r if the coordinates instead are the lower left and upper right corners of the desired rectangle. (Or, give xmin/xmax/ymin/ymax of bounding rectangle in projected coordinates and optionally append +uunit [Default coordinate unit is meter (e)]. Append +wwidth[/height] of bounding rectangle or box in plot coordinates (inches, cm, etc.). By default, the anchor point on the scale is assumed to be the bottom left corner (BL), but this can be changed by appending +j followed by a 2-char justification code justify (see text). Note: If j is used then justify defaults to the same as refpoint, if J is used then justify defaults to the mirror opposite of refpoint. Specify inset box attributes via the border option [outline only].