Skip to content

POC: WIP: Figure.inset: Set the default position to the top right #4721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
yvonnefroehlich wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

POC: WIP: Figure.inset: Set the default position to the top right #4721

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f0af43
Account for inset default addition in GMT and by this (breaking) chan…
yvonnefroehlich Jul 7, 2026
279c103
Merge branch 'main' into update-default-inset
yvonnefroehlich Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions pygmt/src/inset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
from collections.abc import Sequence
from typing import Literal

from packaging.version import Version
from pygmt._typing import AnchorCode
from pygmt.alias import Alias, AliasSystem
from pygmt.clib import Session
from pygmt.clib import Session, __gmt_version__
from pygmt.exceptions import GMTParameterError
from pygmt.helpers import (
build_arg_list,
Expand Down Expand Up @@ -45,7 +46,6 @@ def inset(
r"""
Manage figure inset setup and completion.


This method carves out a sub-region of the current plot canvas and restrict further
plotting to that section of the canvas. Plotting methods that are called within the
context manager are added to the inset figure.
Expand All @@ -72,7 +72,8 @@ def inset(
- A :doc:`2-character justification code </techref/justification_codes>` for a
position inside the plot, e.g., ``"TL"`` for Top Left corner inside the plot.

If not specified, defaults to the Bottom Left corner of the plot.
If not specified, defaults to ``Position((0, 0), cstype="plotcoords")``, but to
the Top Right corner of the plot for GMT > 6.6.0.
width
height
Width and height of the inset. Width must be specified unless ``projection`` and
Expand Down Expand Up @@ -127,9 +128,14 @@ def inset(
"""
self._activate_figure()

# The default position is set to "TR" since GMT 6.7.0, which has no default value
# in GMT 6.6.0 and earlier versions, but (0,0) in plotcoords as default in PyGMT
# TODO(GMT>6.6.0): Set 'default=None' after GMT 6.7.0.
position = _parse_position(
position,
default=Position((0, 0), cstype="plotcoords"), # Default to (0,0) in plotcoords
default=None
if Version(__gmt_version__) > Version("6.6.0")
else Position((0, 0), cstype="plotcoords"), # old PyGMT default
kwdict={"width": width, "height": height},
)

Expand Down