.. _mimport_icon:


mimport
===============================================

.. container::
    
    .. container:: leftside

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

    .. container:: rightside

		Adds an image to the plot at the specified position, which is given in plot device coordinates in cm units.


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


.. py:function:: mimport(**kwargs)
  
    Adds an image to the plot at the specified position, which is given in plot device coordinates in cm units.


    :param import_file_name: Specifies the path to the image file to be imported.
    :type import_file_name: str

    :param import_file: Specifies the image file as a Metview file object (result of :ref:`read() <read_fn>`). If both an object and a path are specified the object takes precedence.
    :type import_file: :class:`Request`

    :param import_format: Specifies the image format.
    :type import_format: {"png", "jpeg", "gif"}, default: "png"

    :param import_x_position: Specifies the x coordinate of the bottom left corner of the image in the plot. The units are in cm.
    :type import_x_position: number, default: 0

    :param import_y_position: Specifies the y coordinate of the bottom left corner of the image in the plot. The units are in cm.
    :type import_y_position: number, default: 0

    :param import_width: Specifies the width of the image in the plot. The units are in cm. The default value is -1, which means the width is automatically computed.
    :type import_width: number, default: -1

    :param import_height: Specifies the height of the image in the plot. The units are in cm. The default value is -1, which mean the height is automatically computed.
    :type import_height: number, default: -1

    :rtype: :class:`Request`

.. mv-minigallery:: mimport