.. _ws_storm_icon:


ws_storm
===============================================

.. container::
    
    .. container:: leftside

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

    .. container:: rightside

		Defines a storm :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 Storm** icon in Metview’s :ref:`user interface <user_interface>`. It accepts its parameters as keyword arguments, described below.


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


    :param type: Type of the storm symbol.
    :type type: {"hurricane_nh", "hurricane_sh", "tropical_storm_nh", "tropical_storm_sh"}, default: "hurricane_nh"

    :param colour: Colour of the symbol.
    :type colour: str, default: "rgb(0.9412,0,0)"

    :param width: the width of the symbol (height is determined automatically).
    :type width: str, 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_storm