Figure.legend: Plot a legend

[seisman]

This issue serves as the central place for discussing and tracking the implementation of the legend method in PyGMT. The issue will be closed when the initial implementation is complete. Progress is tracked at PyGMT: Wrapping GMT modules.

Documentation

• GMT: https://docs.generic-mapping-tools.org/dev/legend.html
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/legend
• PyGMT: https://www.pygmt.org/dev/api/generated/pygmt.Figure.legend.html

GMT Option Flags and Modifiers

☑️: Implemented; ⬜: To be implemented/discussed; Strikethrough: Won't implement.

• specfile
• -B: frame Figure.legend: Add aliases for -S (scale) and -B (frame) #4254
• -D: position/width/height/line_spacing Figure.legend: Add parameters position/width/height/line_spacing to specify legend position and properties #4046
• -F: box
• -J: projection
• -M
• -R: region
• -S: scale Figure.legend: Add aliases for -S (scale) and -B (frame) #4254
• -T
• -U: Use Figure.timestamp instead.
• -V: verbose
• -X/-Y: Use Figure.shift_origin instead.
• -c: panel
• -p: perspective
• -qi:
• -t: transparency
• --PAR=value: Use pygmt.config instead.

Notes on Input Formats

Add any notes on the input formats, especially the meaning of columns.

Linked Pull Requests

• Initial feature implementation
• Add a tutorial or gallery example

Related Issues and Discussions

Add links to related wrapper discussions, API design threads, or upstream GMT changes here.