mimport

../../_images/MIMPORT.png

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 user interface. It accepts its parameters as keyword arguments, described below.

mimport(**kwargs)

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

Parameters

  • import_file_name (str) – Specifies the path to the image file to be imported.

  • import_file (Request) – Specifies the image file as a Metview file object (result of read()). If both an object and a path are specified the object takes precedence.

  • import_format ({"png", "jpeg", "gif"}, default: "png") – Specifies the image format.

  • import_x_position (number, default: 0) – Specifies the x coordinate of the bottom left corner of the image in the plot. The units are in cm.

  • import_y_position (number, default: 0) – Specifies the y coordinate of the bottom left corner of the image in the plot. The units are in cm.

  • import_width (number, default: -1) – 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.

  • import_height (number, default: -1) – 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.

Return type

Request