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.
How it works
- Create a
KmlDataset
from a KML source which has network links. - Construct a
KmlLayer
with the dataset and add the layer as an operational layer. - To listen for network messages, add an event handler to the
NetworkLinkControlMessage
event on the dataset.
Relevant API
- KmlDataset
- KmlDataset.NetworkLinkControlMessage
- KmlLayer
- KmlNetworkLinkControlMessageEventArgs
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
// 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 ArcGISRuntime;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Ogc;
using Esri.ArcGISRuntime.UI.Controls;
using Foundation;
using UIKit;
namespace ArcGISRuntimeXamarin.Samples.DisplayKmlNetworkLinks
{
[Register("DisplayKmlNetworkLinks")]
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Display KML network links",
category: "Layers",
description: "Display a file with a KML network link, including displaying any network link control messages at launch.",
instructions: "The sample will load the KML file automatically. The data shown should refresh automatically every few seconds. Pan and zoom to explore the map.",
tags: new[] { "KML", "KMZ", "Keyhole", "Network Link", "Network Link Control", "OGC" })]
public class DisplayKmlNetworkLinks : UIViewController
{
// Hold references to UI controls.
private SceneView _mySceneView;
// Hold a reference to the KML data set.
private KmlDataset _dataset;
public DisplayKmlNetworkLinks()
{
Title = "Display KML network links";
}
private void Initialize()
{
// Set up the basemap.
_mySceneView.Scene = new Scene(BasemapStyle.ArcGISImagery);
// Create the dataset.
_dataset = new KmlDataset(new Uri("https://www.arcgis.com/sharing/rest/content/items/600748d4464442288f6db8a4ba27dc95/data"));
// Listen for network link control messages.
// These should be shown to the user.
_dataset.NetworkLinkControlMessage += Dataset_NetworkLinkControlMessage;
// Create the layer from the dataset.
KmlLayer fileLayer = new KmlLayer(_dataset);
// Add the layer to the map.
_mySceneView.Scene.OperationalLayers.Add(fileLayer);
// Zoom in to center the map on Germany.
_mySceneView.SetViewpoint(new Viewpoint(new MapPoint(8.150526, 50.472421, SpatialReferences.Wgs84), 20000000));
}
private void Dataset_NetworkLinkControlMessage(object sender, KmlNetworkLinkControlMessageEventArgs e)
{
// Due to the nature of the threading implementation,
// the dispatcher needs to be used to interact with the UI.
// The dispatcher takes an Action, provided here as a lambda function.
InvokeOnMainThread(() =>
{
// Display the message to the user.
UIAlertView alertView = new UIAlertView("KML layer message", e.Message, (IUIAlertViewDelegate) null, "OK", null);
alertView.Show();
});
}
public override void ViewDidLoad()
{
base.ViewDidLoad();
Initialize();
}
public override void LoadView()
{
// Create the views.
View = new UIView() { BackgroundColor = ApplicationTheme.BackgroundColor };
_mySceneView = new SceneView();
_mySceneView.TranslatesAutoresizingMaskIntoConstraints = false;
// Add the views.
View.AddSubviews(_mySceneView);
// Lay out the views.
NSLayoutConstraint.ActivateConstraints(new[]
{
_mySceneView.TopAnchor.ConstraintEqualTo(View.SafeAreaLayoutGuide.TopAnchor),
_mySceneView.BottomAnchor.ConstraintEqualTo(View.BottomAnchor),
_mySceneView.LeadingAnchor.ConstraintEqualTo(View.LeadingAnchor),
_mySceneView.TrailingAnchor.ConstraintEqualTo(View.TrailingAnchor)
});
}
public override void ViewWillAppear(bool animated)
{
base.ViewWillAppear(animated);
// Subscribe to events, removing any existing subscriptions.
if (_dataset != null)
{
_dataset.NetworkLinkControlMessage -= Dataset_NetworkLinkControlMessage;
_dataset.NetworkLinkControlMessage += Dataset_NetworkLinkControlMessage;
}
}
public override void ViewDidDisappear(bool animated)
{
base.ViewDidDisappear(animated);
// Unsubscribe from events, per best practice.
if (_dataset != null) _dataset.NetworkLinkControlMessage -= Dataset_NetworkLinkControlMessage;
}
}
}