Skip to content

Commit

Permalink
Figure.colorbar: Add aliases for L and Z (#2357)
Browse files Browse the repository at this point in the history
  • Loading branch information
yvonnefroehlich authored Mar 4, 2023
1 parent 04924ef commit 24f9639
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions pygmt/src/colorbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,18 @@

@fmt_docstring
@use_alias(
R="region",
J="projection",
B="frame",
C="cmap",
D="position",
F="box",
G="truncate",
I="shading",
W="scale",
J="projection",
L="equalsize",
R="region",
V="verbose",
W="scale",
Z="zfile",
c="panel",
p="perspective",
t="transparency",
Expand Down Expand Up @@ -97,6 +99,22 @@ def colorbar(self, **kwargs):
used. Alternatively, set ``shading=[low, high]`` to specify an
asymmetric intensity range from *low* to *high*. [Default is no
illumination].
equalsize : int or float or str
[**i**]\ [*gap*].
Equal-sized color rectangles. By default, the rectangles are scaled
according to the z-range in the CPT (see also ``zfile``). If *gap* is
appended and the CPT is discrete each annotation is centered on each
rectangle, using the lower boundary z-value for the annotation. If
**i** is prepended the interval range is annotated instead. If
``shading`` is used each rectangle will have its constant color
modified by the specified intensity.
zfile : str
File with colorbar-width per color entry. By default, the width of the
entry is scaled to the color range, i.e., z = 0-100 gives twice the
width as z = 100-150 (see also ``equalsize``). **Note**: The widths
may be in plot distance units or given as relative fractions and will
be automatically scaled so that the sum of the widths equals the
requested colorbar length.
{verbose}
{panel}
{perspective}
Expand Down

0 comments on commit 24f9639

Please sign in to comment.