ws_placemark

../../_images/WS_PLACEMARK.png

Defines a placemark Weather Symbol Object that can be visualised with plot().

New in Metview version 5.15.0.

Warning

The script-based Weather Symbol Object visualisation is currently restricted to the ‘screen’ output target (i.e. when the output is Metview’s plot window). On the one hand this requires the Metview GUI to be installed, on the other hand it limits the script-based visualisation to these cases:

  • execute the code in Metview’s Code Editor (the default output target here is already ‘screen’)

  • execute the code as a Jupyter notebook with the output target set to ‘screen’ (see setoutput()):

In any other cases, e.g. in batch mode, plot() does not work.

Note

This function performs the same task as the Ws Placemark icon in Metview’s user interface. It accepts its parameters as keyword arguments, described below.

ws_placemark(**kwargs)

Defines a placemark Weather Symbol Object.

Parameters

  • line ({"on", "off"}, default: "on") – Enable to draw the outline.

  • line_colour (str, default: "black") – Colour of the outline. Enabled when line is “on”.

  • line_thickness (number, default: 1) – Thickness of the outline. Enabled when line is “on”.

  • line_style ({"solid", "dash", "dot", "dash_dot", "dash_dot_dot"}, default: "solid") – Style of the outline. Enabled when line is “on”.

  • fill ({"on", "off"}, default: "on") – Enable to fill the placemark.

  • fill_colour (str, default: "rgb(0.9524,0.7171,0.01494)") – Fill colour of the placemark. Enabled when fill is “on”.

  • inner_fill ({"on", "off"}, default: "on") – Enable to fill the hole in the placemark.

  • inner_fill_colour (str, default: "rgb(0,0,0)") – Fill colour of the hole in the placemark. Enabled when inner_fill is “on”.

  • width (str, default: "25") – the width of the placemark (height is determined automatically).

  • x (number, default: 0) – The x coordinate of the bottom-centre point of the symbol.

  • y (number, default: 0) – The y coordinate of the bottom-centre point of the symbol.

  • geolock (on_off, default: off) – Sets the geolock on the item for interactive editing in the plot window.

  • tooltip (str) – Text that appears as a tooltip when the visualised object is hovered over in Metview’s plot window.

Return type

Request