View in QML C++ View on GitHub Sample viewer app
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 the ArcGIS Maps SDK for Native Apps 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 drop-down menu to select a source. A KML file from that source will be loaded and displayed in the map.
How it works
To create a KML layer from a URL, create a KmlDataset using the URL to the KML file. Then add the dataset to the KmlLayer.
To create a KML layer from a portal item, create a PortalItem with a Portal and the KML portal item ID. Add the portal item to the KmlLayer.
To create a KML layer from a local file, create a KmlDataset using the absolute file path to the local KML file. Then add the dataset to the KmlLayer.
Add the layer as an operational layer to the map with map.operationalLayers.append(kmlLayer).
Relevant API
Offline data
To set up the sample's offline data, see the Use offline data in the samples section of the Qt Samples repository overview.
Link
Local Location
US State Capitals <userhome>/ArcGIS/Runtime/Data/kml/US_State_Capitals.kml
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.
keyhole, KML, KMZ, OGC
DisplayKml.qml
Use dark colors for code blocks Copy
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// [WriteFile Name=DisplayKml, Category=Layers]
// [Legal]
// 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.
// [Legal]
import QtQuick
import QtQuick.Controls
import QtQuick.Window
import Esri.ArcGISRuntime
import Esri.ArcGISExtras
Rectangle {
id: rootRectangle
clip : true
width : 800
height : 600
SceneView {
id: sceneView
anchors.fill : parent
Component.onCompleted : {
// Set the focus on SceneView to initially enable keyboard navigation
forceActiveFocus();
}
Scene {
id: scene
Basemap {
initStyle : Enums.BasemapStyleArcGISImagery
}
Surface {
ArcGISTiledElevationSource {
url : "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"
}
}
}
}
ViewpointCenter {
id: viewpoint
targetScale : 10000000
center : Point {
x : -98
y : 39
spatialReference : SpatialReference {
wkid : 4326
}
}
Camera {
distance : viewpoint.targetScale
heading : 0
pitch : 0
roll : 0
location : viewpoint.center
}
}
ComboBox {
id: comboBox
anchors {
right : parent .right
top : parent .top
margins : 5
}
// Add a background to the ComboBox
Rectangle {
anchors.fill : parent
radius : 10
// Make the rectangle visible if a dropdown indicator exists
// An indicator only exists if a theme is set
visible : parent .indicator
border.width : 1
}
property int modelWidth : 0
width : modelWidth + leftPadding + rightPadding + (indicator ? indicator.width : 10 )
model : [ "URL" , "Local file" , "Portal Item" ]
onCurrentIndexChanged : {
// clear previous layers
scene.operationalLayers.clear();
// create KML variable
let kmlLayer;
// create the Layer
if (currentIndex === 0 )
kmlLayer = createFromUrl();
else if (currentIndex === 1 )
kmlLayer = createFromFile();
else
kmlLayer = createFromPortalItem();
// add the layer to the scene
scene.operationalLayers.append(kmlLayer);
// zoom to center on the United States
sceneView.setViewpoint(viewpoint)
}
Component.onCompleted : {
for ( let i = 0 ; i < model.length; ++i) {
metrics.text = model[i];
modelWidth = Math .max(modelWidth, metrics.width);
}
currentIndexChanged();
}
TextMetrics {
id: metrics
font : comboBox.font
}
}
function createFromUrl ( ) {
// create the dataset from an online URL
const kmlDataset = ArcGISRuntimeEnvironment.createObject( "KmlDataset" , {
url : "https://www.wpc.ncep.noaa.gov/kml/noaa_chart/WPC_Day1_SigWx.kml"
});
// create the layer
const kmlLayer = ArcGISRuntimeEnvironment.createObject( "KmlLayer" , {
dataset : kmlDataset
});
// return the KML Layer
return kmlLayer;
}
function createFromFile ( ) {
// create the dataset from a local file
let localDataDirPath;
if (Qt.platform.os === "ios" )
localDataDirPath = System.writableLocation(System.StandardPathsDocumentsLocation);
else
localDataDirPath = System.writableLocation(System.StandardPathsHomeLocation);
const kmlDataset = ArcGISRuntimeEnvironment.createObject( "KmlDataset" , {
url : localDataDirPath + "/ArcGIS/Runtime/Data/kml/US_State_Capitals.kml"
});
// create the layer
const kmlLayer = ArcGISRuntimeEnvironment.createObject( "KmlLayer" , {
dataset : kmlDataset
});
// return the KML Layer
return kmlLayer;
}
function createFromPortalItem ( ) {
// create the portal item with an item ID
const portalItem = ArcGISRuntimeEnvironment.createObject( "PortalItem" , {
itemId : "9fe0b1bfdcd64c83bd77ea0452c76253"
});
// create the layer
const kmlLayer = ArcGISRuntimeEnvironment.createObject( "KmlLayer" , {
item : portalItem
});
// return the KML Layer
return kmlLayer;
}
}
