Skip to content

Commit a3c02a2

Browse files
authored
Figure.colorbar: Add alias 'monochrome' for option '-M' (#4499)
1 parent 9dd17ae commit a3c02a2

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

pygmt/src/colorbar.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ def colorbar( # noqa: PLR0913
239239
shading: float | Sequence[float] | bool = False,
240240
log: bool = False,
241241
scale: float | None = None,
242+
monochrome: bool = False,
242243
projection: str | None = None,
243244
region: Sequence[float | str] | str | None = None,
244245
frame: str | Sequence[str] | Literal["none"] | bool = False,
@@ -278,6 +279,7 @@ def colorbar( # noqa: PLR0913
278279
- G = truncate
279280
- I = shading
280281
- J = projection
282+
- M = monochrome
281283
- Q = log
282284
- R = region
283285
- V = verbose
@@ -410,6 +412,8 @@ def colorbar( # noqa: PLR0913
410412
may be in plot distance units or given as relative fractions and will
411413
be automatically scaled so that the sum of the widths equals the
412414
requested colorbar length.
415+
monochrome
416+
Force a monochrome graybar using the (television) YIQ transformation.
413417
$projection
414418
$region
415419
$verbose
@@ -467,6 +471,7 @@ def colorbar( # noqa: PLR0913
467471
F=Alias(box, name="box"),
468472
G=Alias(truncate, name="truncate", sep="/", size=2),
469473
I=Alias(shading, name="shading", sep="/", size=2),
474+
M=Alias(monochrome, name="monochrome"),
470475
Q=Alias(log, name="log"),
471476
W=Alias(scale, name="scale"),
472477
).add_common(

0 commit comments

Comments
 (0)