Skip to content

Consistent parameters for GMT embellishment placement #4168

@seisman

Description

@seisman

Currently, GMT provides 9 different embellishments

  • Map scale by basemap -L or coast -L
  • Directional rose by basemap -Td or coast -Td
  • Magnetic rose by basemap -Tm or coast -Tm
  • Colorbar by colorbar
  • Legend by legend
  • Raster images by image
  • GMT logo by logo
  • Map inset by inset
  • Vertical scale of wiggles in wiggle

Refer to https://docs.generic-mapping-tools.org/6.5/reference/features.html#plot-embellishments for details.

These embellishments have different properties thus different option flags/modifiers, but they all share the same syntax for positioning, as shown below:

The common syntax is

[g|j|J|n|x]refpoint[+jjustify][+odx[/dy]
  • g|j|J|n|x specify the coordinate system
  • refpoint specifies the reference point
  • +j specifies the anchor on the embellishment
  • +o set the extra offset of the anchor.

In PR #4014, I propose four parameters: position_type/position/anchor/anchor_offset for such syntax. Since the four parameters will be used in several wrappers, discussions are necessary.

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionsNeed more discussion before taking further actions

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions