Layer To KML (Conversion)

License Level:BasicStandardAdvanced

Summary

This tool converts a feature or raster layer into a KML file containing a translation of Esri geometries and symbology. This file is compressed using ZIP compression, has a .kmz extension, and can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

Learn more about KML support in ArcGIS

Usage

Syntax

LayerToKML_conversion (layer, out_kmz_file, {layer_output_scale}, {is_composite}, {boundary_box_extent}, {image_size}, {dpi_of_client}, {ignore_zvalue})
ParameterExplanationData Type
layer

The feature or raster layer or layer file (.lyr) to be converted to KML.

Layer
out_kmz_file

The KML file to write. This file is compressed and has a .kmz extension. It can be read by any KML client including ArcGIS Explorer, ArcGlobe, and Google Earth.

File
layer_output_scale
(Optional)

The scale at which to export the layer. This parameter is used with any scale dependency, such as layer visibility or scale-dependent rendering. If the layer is not visible at the export scale, it will not be included in the created KML file. Any value, such as 0, can be used if there are no scale dependencies.

If exporting a layer that is to be displayed as 3D vectors and the is_composite parameter is set to NO_COMPOSITE you can set this parameter to any value, as long as your features do not have any scale-dependent rendering.

Only numeric characters should be entered; for example, enter 20000 as the scale, not 1:20000 or 20,000.

Double
is_composite
(Optional)
  • COMPOSITEThe output KML file 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 KML GroundOverlay. Select this option to reduce the size of the output KMZ file. When you check this box, individual features and layers in the KML are not selectable.
  • NO_COMPOSITEIf your layer has vector features, they are preserved as KML vectors. (If your layer is a raster, you can choose either option for this parameter without any visual difference.)
Boolean
boundary_box_extent
(Optional)

The geographic extent of the area to be exported. The extent rectangle bounds should be specified as a space-delimited string of WGS84 geographic coordinates in the form left lower right upper (xmin, ymin, xmax, ymax).

Extent
image_size
(Optional)

Defines the vertical and horizontal resolution of any rasters in the output KML document. Use this parameter with the DPI parameter to control output image resolution.

Long
dpi_of_client
(Optional)

Defines the device resolution for any rasters in the output KML document. Use this parameter with the Image Size parameter to control output image resolution.

Long
ignore_zvalue
(Optional)
  • ABSOLUTEUse the Z-values of features when creating KML. The features will be drawn inside KML clients relative to sea level.
  • CLAMPED_TO_GROUNDOverride Z-values in your features and create KML with the features clamped to the ground. The features will be 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.env.workspace = "C:/data"
arcpy.LayerToKML_conversion("bldg.lyr", "bldg.kmz")
LayerToKML example 2 (stand-alone script)

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

# Name: LayerToKML Example
# 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.
# Author: ESRI

import arcpy

# Set environment settings
arcpy.env.workspace = "C:/data"

# Use the ListFiles method to identify all layer files in workspace
if len(arcpy.ListFiles("*.lyr")) > 0:
    for layer in arcpy.ListFiles("*.lyr"):
        # Set Local Variables
        composite = 'NO_COMPOSITE'
        pixels = 2048
        dpi = 96
        clamped = 'CLAMPED_TO_GROUND'
        # Strips the '.lyr' part of the name and appends '.kmz'
        outKML = file[:4] + ".kmz"
        for scale in range(10000, 30001, 10000):
            #Execute LayerToKML
            arcpy.LayerToKML_conversion(layer, outKML, scale, composite, 
                                        '', pixels, dpi, clamped)
else:
    arcpy.AddMessage('There are no layer files in '+env.workspace+'.')

Environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Yes
ArcGIS for Desktop Standard: Yes
ArcGIS for Desktop Advanced: Yes
3/3/2014