Display Name: Map To KML
Description: Converts a map to a KML file containing geometries and symbology. The output file is compressed using ZIP compression, has a .kmz extension, and can be read by any KML client including ArcGIS Earth and Google Earth.
Category:
Help URL: https://mcgdplgis.com/server/rest/directories/arcgisoutput/MapToKML_GPServer/MapToKML/MapToKML.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: in_map
Data Type: GPString
Display Name Input Map
Description: The map, scene or basemap to convert to KML.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: parent
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ parent, Map, Map1, Light Grey Base, CNG Public Map, Map2, FeatureMap ]
Parameter: out_kmz_file
Data Type: GPDataFile
Display Name Output File
Description: The output KML file. This file is compressed and has a .kmz extension. The file can be read by any KML client including ArcGIS Earth and Google Earth.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:
Parameter: map_output_scale
Data Type: GPDouble
Display Name Map Output Scale
Description: The scale at which each layer in the map will be exported.This parameter is important with any scale dependency, such as layer visibility or scale-dependent rendering. If the layer is not visible at the output scale, it is not included in the output KML. Any value, such as 1, can be used if there are no scale dependencies.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 determines the output resolution of the raster. This parameter has no effect on layers that are not raster layers.Only numeric characters are accepted; for example, enter 20000 as the scale, not 1:20000. In languages that use commas as the decimal point, 20,000 is also acceptable.If you're exporting a layer that is to be displayed as 3D vectors and the Return single composite image parameter is checked, you can set this parameter to any value as long as the features do not have any scale-dependent rendering.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 0
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: is_composite
Data Type: GPBoolean
Display Name Return single composite image
Description: Specifies whether the output KML will contain a single composite image or separate layers.Checked—The output KML will contain a single image that composites all the features in the map into a single raster image. The raster is draped over the terrain as a KML GroundOverlay. This option reduces the size of the output KML. Individual features and layers in the KML are not selectable.Unchecked—The output KML will contain separate, individual layers. This is the default. Whether the layers are returned as rasters or as a combination of vectors and rasters is determined by the Convert Vector to Raster parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Data Content Properties
Parameter: is_vector_to_raster
Data Type: GPBoolean
Display Name Convert Vector to Raster
Description: Specifies whether each vector layer in the map will be converted to a separate raster image or preserved as vector layers.This parameter is inactive if the Return single composite image parameter is checked.Checked—Vector layers will be converted to a separate raster image in the KML output. Normal raster layers are also added to the KML output. Each output KML raster layer is selectable, and its transparency can be adjusted in certain KML clients.Unchecked—Vector layers will be preserved as KML vectors. This is the default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Data Content Properties
Parameter: extent_to_export
Data Type: GPString
Display Name Extent to Export
Description: 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 left lower right upper (x-min, y-min, x-max, y-max).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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: DEFAULT
Parameter Type: esriGPParameterTypeOptional
Category: Extent Properties
Parameter: image_size
Data Type: GPLong
Display Name Size of returned image (pixels)
Description: The size of the tiles for raster layers if the Map Output Scale parameter value is set to a value greater than or equal to 1. This parameter only has an effect on raster layers.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1024
Parameter Type: esriGPParameterTypeOptional
Category: Output Image Properties
Parameter: dpi_of_client
Data Type: GPLong
Display Name DPI of output image
Description: The device resolution for any rasters in the output KML document. Typical screen resolution is 96 dpi. If the data in the map supports a high resolution and the KML requires it, consider increasing the value. Use this parameter with the Size of returned image (pixels) parameter to control output image resolution. The default value is 96.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 96
Parameter Type: esriGPParameterTypeOptional
Category: Output Image Properties
Parameter: ignore_zvalue
Data Type: GPBoolean
Display Name Clamped features to ground
Description: Specifies whether features will be clamped to the ground.Checked—The z-values of the input features will be ignored and the KML output will be created with the features clamped to the ground. The features will be draped over the terrain. Use this option when features that do not have z-values. This is the default.Unchecked—The z-values of the input features will be used when creating the KML output. The features will be drawn in KML clients relative to sea level.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: layout
Data Type: GPString
Display Name Legend Layout Source
Description: The name of a layout that contains legend elements that will be included in the KML output as screen overlays.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Legend Screen Overlay
Choice List: [ Summary Letter Landscape ]
Supported Operations:
Submit Job
Child Resources:
Metadata