mark

ClickCallbacks.mark(radius=None, radius_crs=None, shape=None, buffer=1, permanent=False, n=20, zorder=10, layer=None, **kwargs)

Draw markers at the location where the map was clicked.

If permanent = True, the generated annotations are stored in a list which is accessible via m.cb.[click/pick].get.permanent_markers

Removing the callback will remove ALL markers that have been added to the map.

Parameters:
  • radius (float, string or None, optional) –

    • If float: The radius of the marker in units of the β€œradius_crs”.

    • If β€œpixel” the pixel dimensions of the clicked pixel are used

    • If None: The radius of the data used for plotting (if available), otherwise 1/10 of the width and height

    The default is None.

  • radius_crs (any) –

    (only relevant if radius is NOT specified as β€œpixel”)

    The crs specification in which the radius is provided. - use β€œin” for input-crs, β€œout” for plot-crs - or use any other crs-specification (e.g. wkt-string, epsg-code etc.)

    If None, the radius_crs of the assigned plot-shape is used if possible (e.g. m.shape.radius_crs) and otherwise the input-crs is used (e.g. β€œin”).

    The default is None.

  • shape (str, optional) –

    Indicator which shape to draw. Currently supported shapes are: - ellipses - rectangles - geod_circles

    The default is None which defaults to the used shape for plotting if possible and else β€œellipses”.

  • buffer (float, optional) – A factor to scale the size of the shape. The default is 1.

  • permanent (bool or None) –

    Indicator if the markers should be temporary (False) or permanent (True).

    If True, the generated markers are stored in a list which is accessible via m.cb.[click/pick].get.permanent_markers

    If None, the artists will be permanent but NOT added to the permanent_markers list!

    The default is False

  • n (int) – The number of points to calculate for the shape. The default is 20.

  • zorder (int or float) –

    The zorder of the artist. (e.g. the drawing-order) For details, have a look at:

    The default is 10

  • layer (str or None, optional) – The layer to put the marker on. If None, the layer associated with the used Maps-object (e.g. m.layer) The default is None

  • kwargs – kwargs passed to the matplotlib patch. (e.g. facecolor, edgecolor, linewidth, alpha etc.)