Skip to content
Merged
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
17 changes: 10 additions & 7 deletions pygmt/src/logo.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@


@fmt_docstring
@use_alias(R="region", D="position", S="style")
@use_alias(R="region", D="position")
@kwargs_to_strings(R="sequence", p="sequence")
def logo(
self,
projection=None,
style: Literal["standard", "url", "no_label"] = "standard",
box: Box | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
Expand All @@ -36,6 +37,7 @@ def logo(
{aliases}
- F = box
- J = projection
- S = style
- V = verbose
- c = panel
- t = transparency
Expand All @@ -53,14 +55,12 @@ def logo(
box is drawn using :gmt-term:`MAP_FRAME_PEN`. To customize the box appearance,
pass a :class:`pygmt.params.Box` object to control style, fill, pen, and other
box properties.
style : str
[**l**\|\ **n**\|\ **u**].
style
Control what is written beneath the map portion of the logo.

- **l** to plot the text label "The Generic Mapping Tools"
[Default]
- **n** to skip the label placement
- **u** to place the URL to the GMT site
- ``"standard"``: The text label "The Generic Mapping Tools".
- ``"no_label"``: Skip the text label.
- ``"url"``: The URL to the GMT website.
{verbose}
{panel}
{transparency}
Expand All @@ -69,6 +69,9 @@ def logo(

aliasdict = AliasSystem(
F=Alias(box, name="box"),
S=Alias(
style, name="style", mapping={"standard": "l", "url": "u", "no_label": "n"}
),
).add_common(
J=projection,
V=verbose,
Expand Down
Loading