Skip to content

Figure.logo: Add parameters position/width/height to specify logo position and dimensions - #4014

Merged
seisman merged 136 commits into
mainfrom
refactor/logo
Dec 18, 2025
Merged

Figure.logo: Add parameters position/width/height to specify logo position and dimensions#4014
seisman merged 136 commits into
mainfrom
refactor/logo

Conversation

@seisman

@seismanseisman commented Jul 26, 2025•
edited
Loading

Copy link
Copy Markdown
Member

The logo module's -D option has the following syntax:

-D[g|j|J|n|x]refpoint[+hheight|+wwidth][+jjustify][+odx[/dy]]
  • [g|j|J|n|x]refpoint[+jjustify][+odx[/dy]] is common to GMT embellishments and use the Position class
  • +h: height
  • +w: width

Preview: https://pygmt-dev--4014.org.readthedocs.build/en/4014/api/generated/pygmt.Figure.logo.html

Related to #4165.

@seismanseisman changed the title Figure.logo: Refactor using the new alias systemWIP: Figure.logo: Refactor using the new alias systemJul 26, 2025
@seismanseisman mentioned this pull request Jul 26, 2025
Closed
Base automatically changed from AliasSystem/aliassystem to mainJuly 29, 2025 04:09
@seismanseisman changed the title WIP: Figure.logo: Refactor using the new alias systemFigure.logo: Refactor using the new alias systemSep 9, 2025
@seismanseisman added the enhancement Improving an existing feature label Sep 12, 2025
@seismanseisman added this to the 0.17.0 milestone Sep 12, 2025
@seismanseisman changed the title Figure.logo: Refactor using the new alias systemFigure.logo: More Pythonic syntax to specify its location and sizeSep 12, 2025
@seismanseisman changed the title Figure.logo: More Pythonic syntax to specify its location and sizeFigure.logo: Add parameters to specify its location and sizeSep 12, 2025
@seismanseisman changed the title Figure.logo: Add parameters to specify its location and sizeFigure.logo: Add parameters to specify the location and sizeSep 12, 2025
@seisman
seisman marked this pull request as ready for review September 12, 2025 04:45
@seismanseisman added the needs review This PR has higher priority and needs review. label Sep 12, 2025
@seismanseisman changed the title Figure.logo: Add parameters to specify the location and sizeFigure.logo: Add Pythonic parameters to specify the location and sizeSep 12, 2025
@seismanseisman added needs review This PR has higher priority and needs review. and removed final review call This PR requires final review and approval from a second reviewer labels Dec 15, 2025
seisman
seisman commented Dec 16, 2025
View reviewed changes
Comment threadpygmt/src/logo.py Outdated
raise GMTInvalidInput(msg)

# Default position at the plot origin.
if position is None:

@seismanseismanDec 16, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Force the default position to x0/0 if position is not given.

Comment threadpygmt/src/logo.py
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
**+w**\ *width*\ [**+j**\ *justify*]\ [**+o**\ *dx*\ [/*dy*]].
Set reference point on the map for the image.
position

@seismanseismanDec 16, 2025•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Currently, position accept a Position object. I'm debating if we should support a tuple or an anchor code:

  • position=(0, 2): equivalent to position=Position((0, 2)) and is converted to "x0/2"
  • position="BL": equivalent to position=Position("BL") and is converted to "jBL".

@seismanseismanDec 16, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Implemented in 9b7f0f5.

@seismanseisman 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 17, 2025
@seisman

seisman commented Dec 17, 2025

Copy link
Copy Markdown
MemberAuthor

@GenericMappingTools/pygmt-maintainers Please give this PR a final review. Plan to merge in 24 hours if no further comments.

michaelgrund
michaelgrund approved these changes Dec 17, 2025
View reviewed changes
Comment threadpygmt/src/logo.py
Comment threadpygmt/src/logo.py Outdated
@seisman@michaelgrund
Fix a typo [skip ci]
ef750b5
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
This was referenced Dec 17, 2025
Merged
Merged
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 18, 2025
@seisman
seisman merged commit 938e8ec into mainDec 18, 2025
23 of 24 checks passed
@seisman
seisman deleted the refactor/logo branch December 18, 2025 02:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michaelgrundmichaelgrundmichaelgrund approved these changes

Assignees

No one assigned

Labels

enhancementImproving an existing feature

Projects

No open projects
PyGMT paper
Status: Done

Milestone

0.18.0

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman@michaelgrund