KML Layer (KML)

Keyhole Markup Language (KML) is an XML-based format for storing geographic data and associated content and is an official Open Geospatial Consortium (OGC) standard. KML is a common format for sharing geographic data with non-GIS users as it can be easily delivered on the Internet.

Referenced by: operationalLayers

Properties

Property	Details
blendMode	Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default. Valid values: average, color, color-burn, color-dodge, darken, destination-atop, destination-in, destination-out, destination-over, difference, exclusion, hard-light, hue, invert, lighten, lighter, luminosity, minus, multiply, normal, overlay, plus, reflect, saturation, screen, soft-light, source-atop, source-in, source-out, vivid-light, xor
effect	Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
id	A unique identifying string for the layer.
itemId	Optional string containing the item ID if it's registered on ArcGIS Online or your organization's portal.
layerType	String indicating the layer type. Valid value of this property KML
maxScale	A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
minScale	A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
opacity	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval	Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
showLegend	Boolean value indicating whether to display the layer in the legend. Default value is true.
title	A user-friendly string title for the layer that can be used in a table of contents.
type	Deprecated. Use layerType instead.
url	The URL to the layer.
visibility	Boolean property determining whether the layer is initially visible in the web map.
visibilityTimeExtent	Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.
visibleFolders[]	Array of numeric IDs of folders that will be made visible.

Example

Live sample web maps showing the KML layer as an operationalLayer

{
  "id": "kml_9012",
  "url": "http://rmgsc.cr.usgs.gov/outgoing/geomac/ActiveFirePerimeters.kml",
  "visibility": true,
  "opacity": 1,
  "title": "ActiveFirePerimeters",
  "type": "KML",
  "layerType": "KML",
  "visibleFolders": [
    0,
    1
  ]
}