Display KML from a URL, portal item, or local KML file.
Use case
Keyhole Markup Language (KML) is a data format used by Google Earth. KML is popular as a transmission format for consumer use and for sharing geographic data between apps. You can use Runtime to display KML files, with full support for a variety of features, including network links, 3D models, screen overlays, and tours.
How to use the sample
Use the UI to select a source. A KML file from that source will be loaded and displayed in the scene.
How it works
To create a KML layer from a URL, create a KmlDataset using the URL to the KML file. Then pass the dataset to the KmlLayer constructor.
To create a KML layer from a portal item, construct a PortalItem with a Portal and the KML portal item ID. Pass the portal item to the KmlLayer constructor.
To create a KML layer from a local file, create a KmlDataset using the absolute file path to the local KML file. Then pass the dataset to the KmlLayer constructor.
Add the layer as an operational layer to the scene with scene.OperationalLayers.Add(kmlLayer).
Relevant API
KmlDataset
KmlLayer
Offline data
This sample uses US state capitals KML file. It is downloaded from ArcGIS Online automatically.
About the data
This sample displays three different KML files:
From URL - this is a map of the significant weather outlook produced by NOAA/NWS. It uses KML network links to always show the latest data.
From local file - this is a map of U.S. state capitals. It doesn't define an icon, so the default pushpin is used for the points.
From portal item - this is a map of U.S. states.
Tags
keyhole, KML, KMZ, OGC
Sample Code
DisplayKml.cs
Use dark colors for code blocks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
// Copyright 2018 Esri.//// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.// You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific// language governing permissions and limitations under the License.using System;
using Android.App;
using Android.OS;
using Android.Views;
using Android.Widget;
using ArcGISRuntime.Samples.Managers;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Portal;
using Esri.ArcGISRuntime.UI.Controls;
namespaceArcGISRuntimeXamarin.Samples.DisplayKml{
[Activity (ConfigurationChanges=Android.Content.PM.ConfigChanges.Orientation | Android.Content.PM.ConfigChanges.ScreenSize)]
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Display KML",
category: "Layers",
description: "Display KML from a URL, portal item, or local KML file.",
instructions: "Use the UI to select a source. A KML file from that source will be loaded and displayed in the scene.",
tags: new[] { "KML", "KMZ", "OGC", "keyhole" })]
[ArcGISRuntime.Samples.Shared.Attributes.OfflineData("324e4742820e46cfbe5029ff2c32cb1f")]
publicclassDisplayKml : Activity {
// Hold references to UI controls.private SceneView _mySceneView;
private Button _dataChoiceButton;
privatereadonly Envelope _usEnvelope = new Envelope(-144.619561355187, 18.0328662832097, -66.0903762761083, 67.6390975806745, SpatialReferences.Wgs84);
privatereadonlystring[] _sources = {"URL", "Local file", "Portal item"};
protectedoverridevoidOnCreate(Bundle bundle) {
base.OnCreate(bundle);
Title = "Display KML";
CreateLayout();
Initialize();
}
privatevoidInitialize() {
// Set up the basemap. _mySceneView.Scene = new Scene(Basemap.CreateImageryWithLabels());
}
privatevoidCreateLayout() {
// Create a new vertical layout for the app. LinearLayout layout = new LinearLayout(this) {Orientation = Orientation.Vertical};
// Create button to show data choices _dataChoiceButton = new Button(this)
{
Text = "Choose a KML data source" };
_dataChoiceButton.Click += DataChoiceButtonOnClick;
// Add button layout.AddView(_dataChoiceButton);
// Add the scene view to the layout _mySceneView = new SceneView(this);
layout.AddView(_mySceneView);
// Show the layout in the app SetContentView(layout);
}
protectedoverridevoidOnDestroy() {
base.OnDestroy();
// Remove the sceneview (_mySceneView.Parent as ViewGroup).RemoveView(_mySceneView);
_mySceneView.Dispose();
_mySceneView = null;
}
privatevoidDataChoiceButtonOnClick(object sender, EventArgs e) {
// Create menu to show the rendering rule options PopupMenu sourceMenu = new PopupMenu(this, _dataChoiceButton);
sourceMenu.MenuItemClick += DataChoiceButton_Clicked;
// Create menu optionsforeach (string option in _sources)
{
sourceMenu.Menu.Add(option);
}
// Show menu in the view sourceMenu.Show();
}
privateasyncvoidDataChoiceButton_Clicked(object sender, PopupMenu.MenuItemClickEventArgs e) {
// Clear existing layers. _mySceneView.Scene.OperationalLayers.Clear();
// Get the name of the selected layer.string name = e.Item.TitleCondensedFormatted.ToString();
try {
// Create the layer using the chosen constructor. KmlLayer layer;
switch (name)
{
case"URL":
default:
layer = new KmlLayer(new Uri("https://www.wpc.ncep.noaa.gov/kml/noaa_chart/WPC_Day1_SigWx_latest.kml"));
break;
case"Local file":
string filePath = DataManager.GetDataFolder("324e4742820e46cfbe5029ff2c32cb1f", "US_State_Capitals.kml");
layer = new KmlLayer(new Uri(filePath));
break;
case"Portal item":
ArcGISPortal portal = await ArcGISPortal.CreateAsync();
PortalItem item = await PortalItem.CreateAsync(portal, "9fe0b1bfdcd64c83bd77ea0452c76253");
layer = new KmlLayer(item);
break;
}
// Add the selected layer to the map. _mySceneView.Scene.OperationalLayers.Add(layer);
// Zoom to the extent of the United States.await _mySceneView.SetViewpointAsync(new Viewpoint(_usEnvelope));
}
catch (Exception ex)
{
new AlertDialog.Builder(this).SetMessage(ex.ToString()).SetTitle("Error").Show();
}
}
}
}