Commit 971d6240 authored by Kris Vanneste's avatar Kris Vanneste
Browse files

Improved docstring of ScalebarStyle.

git-svn-id: https://svn.seismo.oma.be/svn/seismo/mapping/layeredbasemap/trunk@7646 40b490c5-b4d9-47cb-8714-9bef99b524d5
parent 88d717e0
......@@ -231,17 +231,20 @@ class ScalebarStyle(BasemapStyle):
Style defining how to plot scale bar
:param center:
(lon, lat) tuple: position of scale bar in geographic coordinates
(lon, lat) tuple: position of scale bar in geographic coordinates (floats)
or in axis coordinates [0-1] (strings)
:param length:
float, distance represented by scale bar
:param units:
str, units of :param:`length` (default: 'km')
str, units of :param:`length`, either 'km', 'm', 'mi', 'nmi' or 'ft'
(default: 'km')
:param bar_style:
str, style of scale bar, either "simple" or "fancy"
(default: "simple")
:param yoffset:
float, controls how tall the scale bar is, and how far the
annotations are offset from the scale bar.
If value < 1, it is taken as a fraction of the height of the map.
(default: None, corresponds to 0.02 times the height of the map)
:param label_style:
str, either "simple" or "fancy", or False. If False, label
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment