Skip to content
Open
Changes from all commits
Commits
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
30 changes: 19 additions & 11 deletions pygmt/src/colorbar.py
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 @@ -293,23 +294,13 @@ def colorbar(
linear scale, all be equal size, or by providing a file with individual
tile widths.

.. 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
:math:`\sqrt{colorbar\_width / 15}`. To set a desired fontsize via 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(...):``.

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 +454,22 @@ 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
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].

.. note::
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 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`). For GMT >=6.7.0, users can 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.

$projection
$region
$verbose

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 @@ -516,6 +523,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