Display a file with a KML network link, including displaying any network link control messages at launch.

Use case
KML files can reference other KML files on the network and support automatically refreshing content. For example, survey workers will benefit from KML data shown on their devices automatically refreshing to show the most up-to-date state. Additionally, discovering KML files linked to the data they are currently viewing provides additional information to make better decisions in the field.
How to use the sample
The sample will load the KML file automatically. The data shown should refresh automatically every few seconds. Pan and zoom to explore the map.
The message button will show the last message received from the KML network resource.
How it works
- Create a
KmlDatasetfrom a KML source which has network links. - Construct a
KmlLayerwith the dataset and add the layer as an operational layer. - To listen for network messages by connecting to the signal,
KmlDataset::kmlNetworkLinkMessageReceived.
Relevant API
- KmlDataset(Url)
- KmlLayer(KmlDataset)
- KmlNetworkLink
- kmlNetworkLinkMessageReceived
Offline data
This sample uses the radar.kmz file, which can be found on ArcGIS Online.
About the data
This map shows the current air traffic in parts of Europe with heading, altitude, and ground speed. Additionally, noise levels from ground monitoring stations are shown.
Tags
Keyhole, KML, KMZ, Network Link, Network Link Control, OGC
Sample Code
// [WriteFile Name=DisplayKmlNetworkLinks, 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]
#ifdef PCH_BUILD#include "pch.hpp"#endif // PCH_BUILD
// sample headers#include "DisplayKmlNetworkLinks.h"
// ArcGIS Maps SDK headers#include "KmlDataset.h"#include "KmlLayer.h"#include "KmlNetworkLink.h"#include "LayerListModel.h"#include "MapTypes.h"#include "Point.h"#include "Scene.h"#include "SceneQuickView.h"#include "SpatialReference.h"#include "Viewpoint.h"
// Qt headers#include <QFuture>
using namespace Esri::ArcGISRuntime;
DisplayKmlNetworkLinks::DisplayKmlNetworkLinks(QQuickItem* parent /* = nullptr */): QQuickItem(parent){}
DisplayKmlNetworkLinks::~DisplayKmlNetworkLinks() = default;
void DisplayKmlNetworkLinks::init(){ // Register classes for QML qmlRegisterType<SceneQuickView>("Esri.Samples", 1, 0, "SceneView"); qmlRegisterType<DisplayKmlNetworkLinks>("Esri.Samples", 1, 0, "DisplayKmlNetworkLinksSample");}
QString DisplayKmlNetworkLinks::currentKmlNetworkMessage() const{ return m_currentKmlNetworkMessage;}
void DisplayKmlNetworkLinks::setCurrentKmlNetworkMessage(const QString& message){ m_currentKmlNetworkMessage = message; emit kmlMessageRecieved(message);}
void DisplayKmlNetworkLinks::componentComplete(){ QQuickItem::componentComplete();
// Create a scene and give it to the SceneView m_sceneView = findChild<SceneQuickView*>("sceneView"); Scene* scene = new Scene(BasemapStyle::ArcGISImageryStandard, this);
// Create a KML dataset from the given resource. // This is a KML resource that references other KML resources over a network. KmlDataset* dataset = new KmlDataset(QUrl("https://www.arcgis.com/sharing/rest/content/items/600748d4464442288f6db8a4ba27dc95/data"), this); connect(dataset, &KmlDataset::kmlNetworkLinkMessageReceived, this, [this](KmlNetworkLink* /*link*/, const QString& message) { setCurrentKmlNetworkMessage(message); });
// Now that we have the data, we need a layer to interpret it. KmlLayer* fileLayer = new KmlLayer(dataset, this); scene->operationalLayers()->append(fileLayer);
// Take a look at continental Europe, where we'll see most of the data. m_sceneView->setViewpointAsync(Viewpoint { Point { 8.150526, 50.472421, SpatialReference::wgs84() }, 20000000 } ); m_sceneView->setArcGISScene(scene);}// [WriteFile Name=DisplayKmlNetworkLinks, 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]
#ifndef DISPLAYKMLNETWORKLINKS_H#define DISPLAYKMLNETWORKLINKS_H
// Qt headers#include <QQuickItem>
namespace Esri::ArcGISRuntime{class SceneQuickView;}
class DisplayKmlNetworkLinks : public QQuickItem{ Q_PROPERTY(QString currentKmlNetworkMessage READ currentKmlNetworkMessage WRITE setCurrentKmlNetworkMessage NOTIFY kmlMessageRecieved) Q_OBJECT
public: explicit DisplayKmlNetworkLinks(QQuickItem* parent = nullptr); ~DisplayKmlNetworkLinks() override;
void componentComplete() override; static void init();
QString currentKmlNetworkMessage() const;
signals: void kmlMessageRecieved(const QString& message);
private: void setCurrentKmlNetworkMessage(const QString& message);
Esri::ArcGISRuntime::SceneQuickView* m_sceneView = nullptr; QString m_currentKmlNetworkMessage;};
#endif // DISPLAYKMLNETWORKLINKS_H// [WriteFile Name=DisplayKmlNetworkLinks, 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 QtQuickimport QtQuick.Controlsimport QtQuick.Windowimport Esri.Samples
DisplayKmlNetworkLinksSample { id: rootRectangle clip: true width: 800 height: 600
Dialog { id: messageDialog modal: true x: Math.round(parent.width - width) / 2 y: Math.round(parent.height - height) / 2 width: parent.width * 0.75 standardButtons: Dialog.Ok title: "KML layer message" property alias text : textLabel.text Text { width: parent.width id: textLabel text: currentKmlNetworkMessage wrapMode: Text.WordWrap } onAccepted: { currentKmlNetworkMessage = ""; // Clear the message } onRejected: onAccepted() }
SceneView { id: sceneView objectName: "sceneView" anchors.fill: parent
Component.onCompleted: { // Set the focus on SceneView to initially enable keyboard navigation forceActiveFocus(); }
MessageButton { visible: currentKmlNetworkMessage.length > 0 anchors { bottom: sceneView.attributionTop horizontalCenter: parent.horizontalCenter margins: 10 } onClicked: { messageDialog.open(); } } }}// [WriteFile Name=DisplayKmlNetworkLinks, 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 QtQuickimport QtQuick.Controls
Item { id: messageButton signal clicked()
Rectangle { anchors.fill: messageContents radius: 4
border { color: "darkgray" width: 1 }
MouseArea { anchors.fill: parent onClicked: messageButton.clicked() } }
Row { id: messageContents leftPadding: 5 rightPadding: leftPadding spacing: 5 anchors { horizontalCenter: messageButton.horizontalCenter bottom: messageButton.bottom }
Image { anchors.verticalCenter: parent.verticalCenter id: messageImage width: 32 height: 32 source: "qrc:/Samples/Layers/DisplayKmlNetworkLinks/iOS8_TabBar_Email90.png" anchors.margins: 5
SequentialAnimation on opacity { running: messageContents.visible loops: Animation.Infinite
PropertyAnimation { to: 1; duration: 1000; easing.type: Easing.InOutQuad } PropertyAnimation { to: 0; duration: 1000; easing.type: Easing.InOutQuad } } }
Text{ id: messageText anchors { verticalCenter: messageImage.verticalCenter margins: 5 }
text: "Message Received" color: "#2f2f2f" font.pixelSize: 13 } }}// [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]
// sample headers#include "DisplayKmlNetworkLinks.h"
// ArcGIS Maps SDK headers#include "ArcGISRuntimeEnvironment.h"
// Qt headers#include <QCommandLineParser>#include <QDir>#include <QGuiApplication>#include <QQmlEngine>#include <QQuickView>#include <QSurfaceFormat>
// Platform specific headers#ifdef Q_OS_WIN#include <Windows.h>#endif
#define STRINGIZE(x) #x#define QUOTE(x) STRINGIZE(x)
int main(int argc, char *argv[]){ Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setUseLegacyAuthentication(false);#if defined(Q_OS_LINUX) && !defined(Q_OS_ANDROID) // Linux requires 3.2 OpenGL Context // in order to instance 3D symbols QSurfaceFormat fmt = QSurfaceFormat::defaultFormat(); fmt.setVersion(3, 2); QSurfaceFormat::setDefaultFormat(fmt);#endif
QGuiApplication app(argc, argv); app.setApplicationName(QString("DisplayKmlNetworkLinks"));
// Use of ArcGIS location services, such as basemap styles, geocoding, and routing services, // requires an access token. For more information see // https://links.esri.com/arcgis-runtime-security-auth.
// The following methods grant an access token:
// 1. User authentication: Grants a temporary access token associated with a user's ArcGIS account. // To generate a token, a user logs in to the app with an ArcGIS account that is part of an // organization in ArcGIS Online or ArcGIS Enterprise.
// 2. API key authentication: Get a long-lived access token that gives your application access to // ArcGIS location services. Go to the tutorial at https://links.esri.com/create-an-api-key. // Copy the API Key access token.
const QString accessToken = QString("");
if (accessToken.isEmpty()) { qWarning() << "Use of ArcGIS location services, such as the basemap styles service, requires" << "you to authenticate with an ArcGIS account or set the API Key property."; } else { Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setApiKey(accessToken); }
// Initialize the sample DisplayKmlNetworkLinks::init();
// Initialize application view QQuickView view; view.setResizeMode(QQuickView::SizeRootObjectToView);
QString arcGISRuntimeImportPath = QUOTE(ARCGIS_RUNTIME_IMPORT_PATH);
#if defined(LINUX_PLATFORM_REPLACEMENT) // on some linux platforms the string 'linux' is replaced with 1 // fix the replacement paths which were created QString replaceString = QUOTE(LINUX_PLATFORM_REPLACEMENT); arcGISRuntimeImportPath = arcGISRuntimeImportPath.replace(replaceString, "linux", Qt::CaseSensitive);#endif
// Add the import Path view.engine()->addImportPath(QDir(QCoreApplication::applicationDirPath()).filePath("qml")); // Add the Runtime and Extras path view.engine()->addImportPath(arcGISRuntimeImportPath);
// Set the source view.setSource(QUrl("qrc:/Samples/Layers/DisplayKmlNetworkLinks/DisplayKmlNetworkLinks.qml"));
view.show();
return app.exec();}