Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for Qt

Display KML

Sample Viewer View Sample on GitHub

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 drop-down menu to select a source. A KML file from that source will be loaded and displayed in the map.

How it works

  1. 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.
  2. 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.
  3. 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.
  4. Add the layer as an operational layer to the map with map.operationalLayers.append(kmlLayer).

Relevant API

  • KmlDataset
  • KmlLayer

Offline data

Read more about how to set up the sample's offline data here.

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.

Tags

keyhole, KML, KMZ, OGC

Sample Code

import QtQuick 2.6
import QtQuick.Controls 2.2
import QtQuick.Window 2.3
import Esri.ArcGISRuntime 100.9
import Esri.ArcGISExtras 1.1

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    

    SceneView {
        id: sceneView
        anchors.fill: parent

        Scene {
            id: scene
            BasemapImageryWithLabels{}

            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
        }

        property int modelWidth: 0
        width: modelWidth + leftPadding + rightPadding + indicator.width

        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
        const kmlDataset = ArcGISRuntimeEnvironment.createObject("KmlDataset", {
                                                                     url: System.userHomePath + "/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;
    }
}