Skip to content

WIP: Figure.colorbar: Add alias "no_font_scaling" for "-H" #4783

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

Open
yvonnefroehlich wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −5
Open

WIP: Figure.colorbar: Add alias "no_font_scaling" for "-H" #4783

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09750d0
Suggest an alias for '-H' of colorbar
yvonnefroehlich Jul 30, 2026
db74bc2
Merge branch 'main' into add-alias-H-colorbar
yvonnefroehlich Aug 2, 2026
8e8ddc2
Merge branch 'main' into add-alias-H-colorbar
yvonnefroehlich Aug 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
19 changes: 14 additions & 5 deletions pygmt/src/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ def colorbar(
scale: float | None = None,
monochrome: bool = False,
dpi: int | None = None,
no_font_scaling: bool = False,
projection: str | None = None,
region: Sequence[float | str] | str | None = None,
frame: Frame | Axis | Literal["none"] | str | Sequence[str] | bool = False,
Expand All @@ -296,20 +297,23 @@ def colorbar(
.. note::
For GMT >=6.5.0, the fontsizes of the colorbar x-label, x-annotations,
and y-label are scaled based on the width of the colorbar following
Comment on lines 298 to 299

@seisman seisman Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
For GMT >=6.5.0, the fontsizes of the colorbar x-label, x-annotations,
and y-label are scaled based on the width of the colorbar following
By default, the fontsizes of the colorbar annotations, label, and unit
are scaled based on the width of the colorbar following

:math:`\sqrt{colorbar\_width / 15}`. To set a desired fontsize via the
:math:`\sqrt{colorbar\_width / 15}`. To set a desired fontsize use the
GMT default parameters :gmt-term:`FONT_ANNOT_PRIMARY`,
:gmt-term:`FONT_ANNOT_SECONDARY`, and :gmt-term:`FONT_LABEL` (or jointly
:gmt-term:`FONT`) users have to divide the desired fontsize by the value
calculated with the formula given above before passing it to the default
parameters. To only affect fontsizes related to the colorbar, the
defaults can be changed locally only using ``with pygmt.config(...):``.
:gmt-term:`FONT`)
For GMT >=6.7.0, users should use ``no_font_scaling = True`` to turn of

@seisman seisman Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
For GMT >=6.7.0, users should use ``no_font_scaling = True`` to turn of
For GMT >=6.7.0, users should use ``no_font_scaling = True`` to turn off

the automatic fontsize scaling.
For GMT 6.5.0 - 6.6.0, users have to divide the desired fontsize by the
value calculated with the formula given above before passing it to the
default parameters.

Full GMT docs at :gmt-docs:`colorbar.html`.

$aliases
- C = cmap
- F = box
- G = truncate
- H = no_font_scaling
- I = shading
- J = projection
- M = monochrome
Expand Down Expand Up @@ -463,6 +467,10 @@ def colorbar(

If not specified, GMT uses its default encoding behavior, and the default dpi
is 600 if the colorbar is drawn as image.
no_font_scaling
For GMT >=6.5.0, the fontsizes used for the colorbar are scaled automaticly
based on the length of the colorbar. For GMT >= 6.7.0, use this parameter to
turn of the this automatic fontsize scaling.
Comment on lines +470 to +473

@seisman seisman Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since PyGMT requires GMT>=6.5.0, I feel we don't need to mention "GMT>=6.5.0" here.

Suggested change
no_font_scaling
For GMT >=6.5.0, the fontsizes used for the colorbar are scaled automaticly
based on the length of the colorbar. For GMT >= 6.7.0, use this parameter to
turn of the this automatic fontsize scaling.
no_font_scaling
By default, the font sizes used for the colorbar are scaled automatically
based on the length of the colorbar. Set this parameter to ``True`` to
turn off the automatic scaling [Requires GMT>=6.7.0].

$projection
$region
$verbose

@seisman seisman Aug 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The -H option only exists in GMT>=6.7.0, so need to check the current GMT version, and raise an exception if GMT 6.5/6.6 is used and no_font_scaling=True.

Expand Down Expand Up @@ -518,6 +526,7 @@ def colorbar(
),
F=Alias(box, name="box"),
G=Alias(truncate, name="truncate", sep="/", size=2),
H=Alias(no_font_scaling, name="no_font_scaling"),
I=Alias(shading, name="shading", sep="/", size=2),
M=Alias(monochrome, name="monochrome"),
N=_alias_option_N(dpi=dpi),
Expand Down
Loading