.. _ws_image_icon:


ws_image
===============================================

.. container::
    
    .. container:: leftside

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

    .. container:: rightside

		Defines an image :ref:`Weather Symbol Object <weather_symbols>` that can be visualised with :func:`plot`. Only SVG or PNG images are supported, which must be located in one of the directories described :ref:`here <ws_add_your_symbol>`.
		
		.. include:: /api/icon_desc/include/ws.rst


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


.. py:function:: ws_image(**kwargs)
  
    Defines an image :ref:`Weather Symbol Object <weather_symbols>`.


    :param name: The image file name. Only SVG or PNG images are supported. It is also possible to specify the name without the image suffix. In this case if multiple images match ``name`` the format is selected in this order: SVG, PNG. The image file must be located in one of the directories described :ref:`here <ws_add_your_symbol>`.
    :type name: str

    :param width: The width of the image (height is determined automatically).
    :type width: number, default: 30

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

    :param y: The y coordinate of the centre of the image.
    :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_image