Skip to content

Figure.legend: Add parameters position/width/height/line_spacing to specify legend position and properties #4046

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

Jump to bottom
Open
seisman wants to merge 83 commits into
base: main
Choose a base branch
from
Open

Figure.legend: Add parameters position/width/height/line_spacing to specify legend position and properties #4046

seisman wants to merge 83 commits into from

Conversation

@seisman
Copy link
Member

@seisman seisman commented Aug 10, 2025 •
edited
Loading

This PR provides a Pythonic interface for the -D option:

The full syntax is:

-D[g|j|J|n|x]<refpoint>[+w<width>[/<height>]][+j<justify>][+l<spacing>][+o<dx>[/<dy>]]
  • [g|j|J|n|x]<refpoint>[+j<justify>][+o<dx>[/<dy>]]: position and Position class
  • +w: width and height
  • +l: line_spacing. GMT uses spacing, but I feel line_spacing is better.

Preview:

Related to #4249.

@seisman seisman added the enhancement Improving an existing feature label Sep 18, 2025
@seisman seisman added this to the 0.18.0 milestone Sep 18, 2025
@seisman seisman mentioned this pull request Oct 16, 2025
Open
9 tasks
@seisman seisman mentioned this pull request Nov 10, 2025
Open
19 tasks
seisman added 25 commits November 16, 2025 11:56
@seisman
Initial implemention of the Position class
eec0fb7
@seisman
Merge branch 'main' into params/position
69d4d42
@seisman
Fix styling
539f66f
@seisman
Add tests and improve docstrings
97f015f
@seisman
Add to API doc
854804e
@seisman
Add an inline doctest
6b55dde
@seisman
position is not required
3d629cb
@seisman
Default to plotcoords
576b822
@seisman
Updates
f54bec9
@seisman
Merge branch 'main' into params/position
5a2e20b
@seisman
Improve the checking in Figure.logo
2c59b7f
@seisman
Merge branch 'main' into params/position
d0b62ec
@seisman
Improve docstrings
fe18c87
@seisman
Improve docstrings
038161b
@seisman
Improve docstrings
a6e75bc
@seisman
Improve docstrings
3ec8c06
@seisman
Improve docstrings
339ce00
@seisman
Revert changes in logo.py
4d616de
@seisman
Simplify tests
ad9e0aa
@seisman
Validate values
b084e5f
@seisman
type will be validated in the Alias System
d4ad6e0
@seisman
Use the image from the GMT docs
7dc37bd
@seisman
Fix width and alignment
bfecb2d
@seisman
Improve docstrings
18b90b3
@seisman
Remove unneeded blank lines
6b1b5bc
@seisman seisman changed the title Figure.legend: Add parameters position/width/height/spacing to specify legend position and properties Figure.legend: Add parameters position/width/height/line_spacing to specify legend position and properties Dec 10, 2025
@seisman seisman mentioned this pull request Dec 11, 2025
Draft
Base automatically changed from params/position to main December 11, 2025 01:54
seisman
seisman commented Dec 11, 2025
View reviewed changes
@seisman seisman marked this pull request as ready for review December 11, 2025 03:48
@seisman seisman added the needs review This PR has higher priority and needs review. label Dec 11, 2025
@seisman seisman requested a review from a team December 11, 2025 03:58
@seisman seisman mentioned this pull request Dec 11, 2025
Closed
19 tasks
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 18, 2025
@seisman
Copy link
Member Author

seisman commented Dec 18, 2025 •
edited
Loading

@GenericMappingTools/pygmt-maintainers Please give this PR a final review.

I think the key points we need to reach agreement on are:

  • The parameter name line_spacing for the +l modifier. Although GMT uses spacing, this term is commonly associated with x– and y–spacings (e.g., in xyz2grd), which could be confusing in this context.
  • The default behavior when position is not specified. In PyGMT, the legend is placed in the top-left corner with a 0.2 cm offset by default, whereas GMT itself does not define a default legend position.

seisman
seisman commented Dec 18, 2025
View reviewed changes
pygmt/tests/test_legend.py
Path(specfile.name).write_text(legend_spec, encoding="utf-8")
fig = Figure()
fig.basemap(projection="x6i", region=[0, 1, 0, 1], frame=True)
fig.legend(specfile.name, position="JMC+jMC+w5i")
Copy link
Member Author

@seisman seisman Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JMC+jMC is equivalent to jMC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement Improving an existing feature final review call This PR requires final review and approval from a second reviewer

Projects

PyGMT paper
Status: No status

Milestone

0.18.0

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman