Display Name: Layer To KML
Description: Converts a feature or raster layer to KML format (.kmz or .kml file). The output KML will contain a translation of Esri feature geometries, raster cells, layer symbology, and other properties.
Category:
Help URL: https://ocgis.com/arcpub/rest/directories/arcgisoutput/OM_NewGen/LayerToKMLTool_GPServer/OM_NewGen_LayerToKMLTool/LayerToKML.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: layer
Data Type: GPString
Display Name Input Layer
Description: The feature or raster layer or group layer that will be converted to KML format.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: LayerToKMLTool\MIP Projects
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ CIP Projects, MIP Projects ]
Parameter: out_kmz_file
Data Type: GPDataFile
Display Name Output File (KML or KMZ)
Description: The output .kml or .kmz file. The output file can use the .kmz extension to produce an archive or zipped file, or the .kml extension to produce a basic KML format file. An output .kmz file is the default.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.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:
Parameter: layer_output_scale
Data Type: GPDouble
Display Name Layer Output Scale
Description: 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 0
Parameter Type: esriGPParameterTypeOptional
Category: Additional Output Settings
Parameter: is_composite
Data Type: GPBoolean
Display Name Return single composite image
Description: Specifies whether the output will be a single composite image. This parameter only applies if you specify the output KML as a .kmz file, 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Additional Output Settings
Parameter: boundary_box_extent
Data Type: GPString
Display Name Extent
Description: The geographic extent of the layer to be converted. Only features or raster cells in this extent will be included in the output KML.Current Display Extent—The extent will be based on the active map or scene. This option is only available when there is an active map.Draw Extent—The extent will be based on a rectangle drawn on the map or scene. This option will create a feature class in the project geodatabase and add a layer to the map. The feature class will have the same coordinate system as the map.This option is not available in the Environments dialog box. It is only available from a tool parameter with an extent data type or from the Environments tab on a tool dialog box.When the Enable and disable editing from the Edit tab editing option is checked, you must enable editing on the Edit ribbon tab to draw the extent.Extent of a Layer—The extent will be based on an active map layer. Use the drop-down list to choose an available layer or use the Extent of data in all layers option to get the combined extent of all active map layers, excluding the basemap. This option is only available when there is an active map with layers.Each map layer has the following options:All Features—The extent of all features in the layer.Selected Features —The extent of the selected features in the layer.Visible Features—The extent of the visible features in the layer.The extents from the Selected Features and Visible Features options are only available for feature layers.Browse—The extent will be based on an existing dataset.Clipboard—The extent can be copied to and pasted from the clipboard.Copy Extent—Copies the extent coordinates and coordinate system to the clipboard.Use Paste Extent—Pastes the extent coordinates and, optionally, the coordinate system from the clipboard. If the clipboard values do not include a coordinate system, the extent will use the map’s coordinate system.The extent coordinates are copied to and pasted from the clipboard using the same formatting and order as the ArcPy Extent object: x-min, y-min, x-max, y-max, and the spatial reference.Reset Extent—The extent will be reset to the default value.Manually entered coordinates—The coordinates must be numeric values and in the active map's coordinate system.The map may use different display units than the entered coordinates. The use of a cardinal direction (N, S, E, W) is not supported. Use a negative value sign for south and west coordinates.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 5814531.89476447 2072722.31680931 6315343.80882105 2351730.58556332 PROJCS["NAD_1983_StatePlane_California_VI_FIPS_0406_Feet",GEOGCS["GCS_North_American_1983",DATUM["D_North_American_1983",SPHEROID["GRS_1980",6378137.0,298.257222101]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Lambert_Conformal_Conic"],PARAMETER["False_Easting",6561666.666666666],PARAMETER["False_Northing",1640416.666666667],PARAMETER["Central_Meridian",-116.25],PARAMETER["Standard_Parallel_1",32.78333333333333],PARAMETER["Standard_Parallel_2",33.88333333333333],PARAMETER["Latitude_Of_Origin",32.16666666666666],UNIT["Foot_US",0.3048006096012192]]
Parameter Type: esriGPParameterTypeOptional
Category: Processing Extent
Parameter: image_size
Data Type: GPLong
Display Name Size of Returned Image (Pixels)
Description: The size of the tiles for raster layers if the Layer Output Scale parameter value is greater than or equal to 1. This parameter has no effect on layers that are not raster layers.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1024
Parameter Type: esriGPParameterTypeOptional
Category: Additional Output Settings
Parameter: dpi_of_client
Data Type: GPLong
Display Name Output Image DPI
Description: The device resolution for KML output when the Return single composite image parameter is checked. Use this parameter 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 96
Parameter Type: esriGPParameterTypeOptional
Category: Additional Output Settings
Parameter: ignore_zvalue
Data Type: GPBoolean
Display Name Clamp features to ground
Description: Specifies whether the z-values of the input features will be ignored and all features will be located, or clamped, at the ground elevation.Checked—The z-values of the input features will be ignored and all features will be located, or clamped, at the ground elevation. If the input features do not have z-values, they will always be clamped to the ground. This is the default.Unchecked—The z-values of the features will be maintained in the output KML. The features will be drawn in KML clients relative to sea level.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category: Additional Output Settings
Supported Operations:
Submit Job
Child Resources:
Metadata