.. _ws_marker_icon:


ws_marker
===============================================

.. container::
    
    .. container:: leftside

        .. image:: /_static/WS_MARKER.png
           :width: 48px

    .. container:: rightside

		Defines a marker :ref:`Weather Symbol Object <weather_symbols>` that can be visualised with :func:`plot`.
		
		.. include:: /api/icon_desc/include/ws.rst


		.. note:: This function performs the same task as the **Ws Marker** icon in Metview’s :ref:`user interface <user_interface>`. It accepts its parameters as keyword arguments, described below.


.. py:function:: ws_marker(**kwargs)
  
    Defines a marker :ref:`Weather Symbol Object <weather_symbols>`.


    :param type: Marker type.
    :type type: {"rectangle", "ellipse", "triangle", "diamond", "star"}, default: "rectangle"

    :param line: Enable to draw the outline.
    :type line: {"on", "off"}, default: "on"

    :param line_colour: Colour of the outline. Enabled when ``line`` is "on".
    :type line_colour: str, default: "black"

    :param line_thickness: Thickness of the outline. Enabled when ``line`` is "on".
    :type line_thickness: number, default: 1

    :param line_style: Style of the outline. Enabled when ``line`` is "on".
    :type line_style: {"solid", "dash", "dot", "dash_dot", "dash_dot_dot"}, default: "solid"

    :param fill: Enable to fill the marker.
    :type fill: {"on", "off"}, default: "on"

    :param fill_colour: Fill colour of the marker. Enabled when ``fill`` is "on".
    :type fill_colour: str, default: "rgb(0.9524,0.7171,0.01494)"

    :param width: Width of the marker.
    :type width: number, default: 30

    :param height: Height of the marker. When ``type`` is "star" ``height`` is disabled and determined automatically.
    :type height: number, default: 30

    :param x: The x coordinate of the centre of the symbol.
    :type x: number, default: 0

    :param y: The y coordinate of the centre of the symbol.
    :type y: number, default: 0

    :param geolock: Sets the geolock on the item for interactive editing in the plot window.
    :type geolock: on_off, default: off

    :param tooltip: Text that appears as a tooltip when the visualised object is hovered over in Metview's plot window.
    :type tooltip: str

    :rtype: :class:`Request`

.. mv-minigallery:: ws_marker