get_position

Compass.get_position(coords='data')

Return the current position of the compass.

Parameters:

coords (str, optional) –

Define what coordinates are returned

• ”data” : coordinates in the plot-crs

• ”axis”: relative [0-1] coordinates with respect to the axis (e.g. (0, 0) = lower left corner, (1, 1) = upper right corner)

The default is “data”.

Returns:

a tuple (x, y) representing the current location of the compass.

Return type:

pos