.. _kml_output_icon:


kml_output
=========================

Defines a KML plot output driver.

.. py:function:: kml_output(**kwargs)
  
    Defines a KML plot output driver.


    :param output_title: Defines a title for the output which gets displayed if the format supports it.
    :type output_title: str, default: "magics++ plot"

    :param output_name_first_page_number: Determines whether, for the first page of multipage output, the number is included in the filename.
    :type output_name_first_page_number: {"on", "off"}, default: "on"

    :param output_file_minimal_width: Width of numbering of multi-file outputs (eg, 'plot.1.png' or 'plot.001.png').
    :type output_file_minimal_width: number, default: 1

    :param output_debug: Defines if extra debug information are written in the output file (PS, EPS, SVG) or console (PNG).
    :type output_debug: {"on", "off"}, default: "off"

    :param output_filelist: Defines if a list of all generated files should be written.
    :type output_filelist: {"on", "off"}, default: "off"

    :param output_filelist_name: Defines the name of the file containing the list of generated files.
    :type output_filelist_name: str, default: "magics_outputs.lst"

    :param kml_kmz: Defines if output files will be zipped into a KMZ file.
    :type kml_kmz: {"on", "off"}, default: "on"

    :param kml_description: Short description for the product.
    :type kml_description: str, default: "generated by magics++"

    :param kml_author: Gives the author of the product.
    :type kml_author: str

    :param kml_link: Gives the HTTP link to the product (Example: http://www.ecmwf.int/products).
    :type kml_link: str

    :param kml_height: Default height of all layers! [This is still WORK IN PROGRESS!!!]
    :type kml_height: number, default: 5.0

    :param kml_latitude: Defines the latitude of initial viewpoint.
    :type kml_latitude: number, default: 40.0

    :param kml_longitude: Defines the longitude of initial viewpoint.
    :type kml_longitude: number, default: 0.0

    :param kml_transparency: Defines the transparency in percentage ( 0% = invisible) of the layers saved.
    :type kml_transparency: number, default: 100

    :param kml_tilt: Defines the tilting angle for the default view (0 equals from above).
    :type kml_tilt: number, default: 0

    :param kml_range: Defines the distance (km) to the default view in km.
    :type kml_range: number, default: 6000

    :param kml_coastlines: Determines if coastlines are plotted by Magics or not. Default is "off" because Google Earth and Google Maps have their own coastlines.
    :type kml_coastlines: {"on", "off"}, default: "off"

    :rtype: :class:`Request`

.. mv-minigallery:: kml_output