KML Image (for Map Services)

URL	`http://<mapservice-url>/kml/mapImage.kmz`
Parent Resource	Map Service
Required Capability	Map

Description

The KML Image resource represents a KML Region or ground overlay document wrapped in a KMZ file.

KML Regions are returned for map services that are cached and use one of the following supported coordinate systems:

All geographic coordinate systems.
Coordinate systems with the following IDs: 102113, 54001, 54002, 54003, 54004, 54016, 54017, 54034, 53001, 53002, 53003, 53004, 53016, 53017, 53034

Ground overlays are created for map services that are not cached or are not in a coordinate system supported for KML Regions.

For more information about kml as an output option, see KML support.

Resource Hierarchy

Map Tile

Parameters

The following parameters are valid only for ground overlays. They are not valid for KML Regions.

Parameter	Details
dpi	Description: The device resolution of the exported image (dots per inch). If the `dpi` is not specified, an image with a default DPI of 96 will be exported. Example: `dpi=200`
format	Description: The format of the exported image. The default format is png. Values: png \| png8 \| png24 \| jpg \| pdf \| bmp \| gif \| svg
layerDefs	Description: Allows you to filter the features of individual layers in the exported map by specifying definition expressions for those layers. Syntax: `layerId1:layerDef1;layerId2:layerDef2` where `layerId1, layerId2` are the layer ids returned by the map service resource Example: `0:POP2000 > 1000000;5:AREA > 100000`
layers	Description: Determines which layers appear on the exported map. There are four ways to specify which layers are shown: show: Only the layers specified in this list will be exported. hide: All layers except those specified in this list will be exported. include: In addition to the layers exported by default, the layers specified in this list will be exported. exclude: The layers exported by default excluding those specified in this list will be exported. Syntax: [show \| hide \| include \| exclude]:layerId1,layerId2 where `layerId1`, `layerId2`are the layer ids returned by the map service resource Example: layers=show:2,4,7

Example Usage

Example 1: Request a map service that is cached and in a supported projection. In this example, the document is returned as a KML Region.

http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Portland/ESRI_LandBase_WebMercator/MapServer/kml/mapImage.kmz

The above URL would be the same for a map service that is not cached or uses an unsupported projection. The difference is that the returned KML document would include a ground overlay.

http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/kml/mapImage.kmz