polartoolkit.Figure.add_coast

Contents

polartoolkit.Figure.add_coast#

Figure.add_coast(no_coast=False, pen=None, version=None, label=None)[source]#

add coastline and or groundingline to figure.

Parameters:
  • no_coast (bool) โ€“ If True, only plot groundingline, not coastline, by default is False

  • pen (str | None) โ€“ GMT pen string, by default โ€œ0.6p,blackโ€

  • version (str | None) โ€“ version of coastline to plot, by default is โ€˜BASโ€™ for north hemisphere, โ€˜measures-v2โ€™ for south hemisphere, and โ€˜gmtโ€™ (GSHHG from GMT) if a different EPSG projection is set (other than 3031 or 3413).

  • label (str | None) โ€“ label to add to the legend, by default is None

Return type:

None