pygmt.Figure.scalebar

Figure.scalebar(position, length, position_type='g', label_alignment=None, scale_position=None, fancy=None, justify=None, label=None, offset=None, unit=None, vertical=None, box=None)

Add a scale bar.

Parameters:

TODO

Examples

>>> import pygmt
>>> from pygmt.params import Box
>>> fig = pygmt.Figure()
>>> fig.basemap(region=[0, 80, -30, 30], projection="M10c", frame=True)
>>> fig.scalebar(
...     position=(10, 10),
...     position_type="g",
...     length=1000,
...     fancy=True,
...     label="Scale",
...     unit=True,
...     box=Box(pen=0.5, fill="lightblue"),
... )
>>> fig.show()