polartoolkit.Figure.add_inset#
- Figure.add_inset(inset_pos=None, inset_position='jTL+jTL+o0/0', inset_width=0.25, inset_reg=None, inset_region=None, inset_width_factor=None, inset_offset=None, inset_box=False, inset_coast_pen='0.2p,black', inset_box_pen='1p,red')[source]#
add an inset map showing the figure region relative to a larger region. The larger region can be set with inset_region parameter, or by default is chosen based on the projection of the figure. For EPSG:3031 the region is all of Antarctica. For EPSG:3031 the region is all Greenland and for other EPSG code the region is 10x with widest dimension of the figure region.
- Parameters:
inset_pos (str, optional) – Deprecated, use inset_position instead.
inset_position (str, optional) – GMT location string for inset map, by default ‘jTL+jTL+o0/0’ (top left)
inset_width (float, optional) – Inset width as percentage of the smallest figure dimension, by default is 25% (0.25)
inset_reg (tuple[float, float, float, float], optional) – Deprecated, use inset_region instead.
inset_region (tuple[float, float, float, float], optional) – Regional extent of the inset map.
inset_width_factor (float, optional) – If provided, the inset region will be scaled to be inset_width_factor times the narrowest dimension of the figure region, while keeping the same center as the figure region. This overrides the inset_region parameter.
inset_offset (str, optional) – Deprecated, add offset via ‘+o0c/0c’ to inset_position instead.
inset_box (bool | str, optional) – whether to plot a box bordering the inset map showing the figure region, by default False
inset_coast_pen (str, optional) – GMT pen string for the coastline in the inset map, by default “0.2p,black”
inset_box_pen (str, optional) – GMT pen string for the box showing the figure region in the inset map, by default “1p,red”
- Return type: