Layer To KML (Conversion)—ArcGIS Pro

Summary

Converts a feature or raster layer to KML format (.kmz or .kml file) containing a translation of Esri geometries and symbology.

Learn more about KML support in ArcGIS

Usage

The default output of the tool has a .kmz extension, which is an archive or .zip file containing a .kml file and other supplemental files. A .kmz file can be read by many applications including ArcGIS Earth and Google Earth.
You can control the appearance of KML in the following two ways:
- By default, the pop-up display is composed of all visible fields from the layer. Pop-up displays can also be set using the layer's customized pop-ups. If the layer pop-ups have not been customized, the values in the feature layer's PopupInfo field are shown in the pop-up when a KML feature is clicked. These values can be numeric or text attributes as well as HTML code stored in a text field.
- When the layer properties are not set and the feature class contains certain attributes (fields), the field properties are used in creating the KML layers that were originally created using the KML To Layer tool including attributes that define how KML is created. See KML conversion for more information about creating KML from attributes.
If the input has scale-dependent display properties, reduce the size of the output .kmz file by choosing an appropriate Layer Output Scale parameter value.
All .kml and .kmz files are created in the WGS84 coordinate system. Ensure that the input layer will properly project if it isn't in WGS84. Use the Project tool to re-project data prior to KML conversion if the input's projection requires a transformation.
Input features with attachments will be included in the output .kmz file. Be aware of the following conditions for attachments in .kmz files:
- Attachments can significantly increase the output file size.
- When using the .kml file in a KML client, attachments are available from the KML pop-up.
- Attachments can be excluded by disabling the Maintain Attachments environment setting before running the tool.
- Not all KML clients support displaying attachments equally. Some KML client applications have better support for attachments such as images and PDF documents.
Attachments will not be included if the output is a .kml file.
The Layer Output Scale and Size of returned image (pixels) parameters are used together to create tiled output. For example, for an image with a size of 7000 by 5000 pixels, and a Size of returned image (pixels) parameter value of 1000 pixels, the output image will be composed of 7 x 5, or 35, subimages. If the Layer Output Scale parameter value is set to 1, each subimage will be 1000 by 1000 pixels. If the Layer Output Scale parameter value is set to 10, each subimage will be 100 by 100 pixels.

Parameters

Label	Explanation	Data Type
Input Layer	The feature, raster layer, or layer file (.lyrx) that will be converted to KML format.	Feature Layer; Raster Layer; Mosaic Layer; Group Layer; Layer File
Output File (.kmz or .kml)	The output .kmz or .kml file. The output file can use a .kmz extension to produce an archive or zipped file, or a .kml extension to produce a basic KML format file. Output .kmz files support raster layers, symbology and other layer properties, attachments, and other advanced features. Output .kml files will use basic KML symbols and properties.	File
Layer Output Scale (Optional)	The scale of the output file. For raster layers, a value of 0 can be used to create one untiled output image. If a value greater than or equal to 1 is used, it will determine the output resolution of the raster. This parameter has no effect on layers that are not raster layers.	Double
Return single composite image (Optional)	Specifies whether the output will be a single composite image. This parameter only applies if you specify the output KML format file with a .kmz extension, as output .kml files do not support ground overlay images or rasters. Checked—The output will be a single composite image representing the raster or vector features in the source layer. The raster is draped over the terrain as a GroundOverlay. Use this option to reduce the size of the output file. When this option is used, individual features and layers in the .kml file cannot be selected. Only output .kmz files support images. Unchecked—If the input layer has vector features, they will be preserved as KML vectors.	Boolean
Extent to Export (Optional)	The geographic extent of the area to be exported. Define the extent box (in the WGS84 coordinate system) or choose a layer or dataset that defines an extent. Default—The extent will be based on the maximum extent of all participating inputs. This is the default. Current Display Extent—The extent is equal to the data frame or visible display. The option is not available when there is no active map. As Specified Below—The extent will be based on the minimum and maximum extent values specified. Browse—The extent will be based on an existing dataset.	Extent
Size of returned image (pixels) (Optional)	The size of the tiles for raster layers if the Layer Output Scale parameter value is set to a value greater than or equal to 1. This parameter has no effect on layers that are not raster layers.	Long
DPI of output image (Optional)	The device resolution for KML output when the Return single composite image parameter is checked. This parameter is used with the Size of returned image (pixels) parameter to control output image resolution. This parameter does not resample source rasters. Input rasters will have a snapshot taken and included in the KML output as a simple .png image.	Long
Clamped features to ground (Optional)	Specifies whether the z-values of the input features will be overridden. Checked—The z-values of the features will be overridden and draped over the terrain. This setting is used for features that do not have z-values. This is the default. Unchecked—The z-values of the features will be respected. The features will be drawn in KML clients relative to sea level.	Boolean

arcpy.conversion.LayerToKML(layer, out_kmz_file, {layer_output_scale}, {is_composite}, {boundary_box_extent}, {image_size}, {dpi_of_client}, {ignore_zvalue})

Name	Explanation	Data Type
layer	The feature, raster layer, or layer file (.lyrx) that will be converted to KML format.	Feature Layer; Raster Layer; Mosaic Layer; Group Layer; Layer File
out_kmz_file	The output .kmz or .kml file. The output file can use a .kmz extension to produce an archive or zipped file, or a .kml extension to produce a basic KML format file. Output .kmz files support raster layers, symbology and other layer properties, attachments, and other advanced features. Output .kml files will use basic KML symbols and properties.	File
layer_output_scale (Optional)	The scale of the output file. For raster layers, a value of 0 can be used to create one untiled output image. If a value greater than or equal to 1 is used, it will determine the output resolution of the raster. This parameter has no effect on layers that are not raster layers.	Double
is_composite (Optional)	Specifies whether the output will be a single composite image. This parameter only applies if you specify the output KML format file with a .kmz extension, as output .kml files do not support ground overlay images or rasters. COMPOSITE—The output will be a single composite image representing the raster or vector features in the source layer. The raster is draped over the terrain as a GroundOverlay. Use this option to reduce the size of the output file. When this option is used, individual features and layers in the .kml file cannot be selected. Only output .kmz files support images. NO_COMPOSITE—If the input has vector features, they will be preserved as KML vectors.	Boolean
boundary_box_extent (Optional)	The geographic extent of the area to be exported. Specify the extent rectangle bounds as a space-delimited string of WGS84 geographic coordinates in the form lower left and upper right (x-min, y-min, x-max, y-max). MAXOF—The maximum extent of all inputs will be used. MINOF—The minimum area common to all inputs will be used. DISPLAY—The extent is equal to the visible display. Layer name—The extent of the specified layer will be used. Extent object—The extent of the specified object will be used. Space delimited string of coordinates—The extent of the specified string will be used. Coordinates are expressed in the order of x-min, y-min, x-max, y-max.	Extent
image_size (Optional)	The size of the tiles for raster layers if the layer_output_scale parameter value is set to a value greater than or equal to 1. This parameter has no effect on layers that are not raster layers.	Long
dpi_of_client (Optional)	The device resolution for KML output when the is_composite parameter is set to COMPOSITE. This parameter is used with the image_size parameter to control output image resolution. This parameter does not resample source rasters. Input rasters will have a snapshot taken and included in the KML output as a simple .png image.	Long
ignore_zvalue (Optional)	Specifies whether the z-values of the input features will be overridden. ABSOLUTE—The z-values of the features will be respected. The features will be drawn in KML clients relative to sea level. CLAMPED_TO_GROUND—The z-values of the features will be overridden and draped over the terrain. This setting is used for features that do not have z-values. This is the default.	Boolean

Code sample

LayerToKML example 1 (Python window)

The following Python window script demonstrates how to use the LayerToKML function in immediate mode.

import arcpy
arcpy.conversion.LayerToKML("buildings", "c:/outputKMZs/bldg.kmz")

LayerToKML example 2 (stand-alone script)

The following Python script demonstrates how to use the LayerToKML function in a stand-alone script.


# Description: The following stand-alone script demonstrates how to find 
#              all layer files in a given workspace and export each to 
#              a KML at the 1:10,000, 1:20,000, and 1:30,000 scale using
#              the LayerToKML tool.
import arcpy

arcpy.env.workspace = "C:/data"

# Set Local Variables
composite = 'NO_COMPOSITE'
pixels = 2048
dpi = 96
clamped = 'CLAMPED_TO_GROUND'

# Use the ListFiles method to identify all lyr and lyrx files in workspace
layers = arcpy.ListFiles("*.lyr*") 

if len(layers) > 0:
    for layer in layers:        
        # Strips the '.lyr(x)' part of the name and appends '.kmz'
        outKML = os.path.join(os.path.splitext(layer), ".kmz")
        for scale in range(10000, 30001, 10000):
            # Run LayerToKML
            arcpy.conversion.LayerToKML(layer, outKML, scale, composite, 
                                        '', pixels, dpi, clamped)
else:
    arcpy.AddMessage('There are no layer files in {}'.format(arcpy.env.workspace))

Environments

Current Workspace, Extent, Scratch Workspace, Maintain Attachments

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes