.. _ws_convergence_line_icon:


ws_convergence_line
===============================================

.. container::
    
    .. container:: leftside

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

    .. container:: rightside

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


.. py:function:: ws_convergence_line(**kwargs)
  
    Defines a convergence line :ref:`Weather Symbol Object <weather_symbols>`.


    :param colour: Colour of the convergence line.
    :type colour: str, default: "orange"

    :param line_thickness: Thickness of the curve and ticks.
    :type line_thickness: number, default: 1

    :param symbol_width: Size of the ticks projected onto the curve.
    :type symbol_width: number, default: 5

    :param symbol_gap: Width of the gap between the ticks.
    :type symbol_gap: number, default: 5

    :param symbol_orientation: Orientation of the first tick.
    :type symbol_orientation: {"left", "right"}, default: "right"

    :param x: The x coordinates of the control points of the curve. At least two points must be specified.
    :type x: ndarray or list of numbers, default: 0

    :param y: The y coordinates of the control points of the curve. At least two points must be specified.
    :type y: ndarray or list of numbers, 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_convergence_line