View on GitHub Sample viewer app

Display a WMS layer using a WMS service URL.

Use case

WMS is an OGC standard for displaying maps from images that are dynamically-generated on a web server. WMS is particularly useful for data that changes frequently, contains cartographically complex detail, or requires an open source data standard.

How to use the sample

The map will load automatically when the sample starts.

How it works

  1. Create a WmsLayer specifying the URL of the service and the names of layers you want to display.
    • Note: The name comes from the Name property, not the Title property. On many services, the title is human-readable while the name is a numeric identifier.
  2. Add the layer to the map as an operational layer.

Relevant API

  • Map
  • MapView
  • WmsLayer

About the data

This sample uses the WMS service behind the U.S. National Weather Service radar map. Because WMS services generate map images on-the-fly, this layer is always up-to-date with the latest NOAA nowCOAST real-time coastal observations, forecasts, and warnings.

Tags

OGC, web map service

Sample Code

WmsLayerUrl.cpp WmsLayerUrl.cpp WmsLayerUrl.h WmsLayerUrl.qml main.cpp
// [WriteFile Name=WmsLayerUrl, Category=Layers]
// [Legal]
// Copyright 2017 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 "WmsLayerUrl.h"
// ArcGIS Maps SDK headers
#include "Envelope.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "SpatialReference.h"
#include "WmsLayer.h"
// Qt headers
#include <QFuture>
#include <QStringList>
#include <QUrl>
using namespace Esri::ArcGISRuntime;
WmsLayerUrl::WmsLayerUrl(QQuickItem* parent /* = nullptr */):
QQuickItem(parent)
{
}
void WmsLayerUrl::init()
{
// Register the map view for QML
qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
qmlRegisterType<WmsLayerUrl>("Esri.Samples", 1, 0, "WmsLayerUrlSample");
}
void WmsLayerUrl::componentComplete()
{
QQuickItem::componentComplete();
// find QML MapView component
m_mapView = findChild<MapQuickView*>("mapView");
// Create a map using the light gray canvas basemap
m_map = new Map(BasemapStyle::ArcGISLightGray, this);
// Add a WMS Layer by specifying the URL and layer name
const QUrl wmsServiceUrl("https://nowcoast.noaa.gov/geoserver/observations/weather_radar/wms");
const QStringList layerNames{"conus_base_reflectivity_mosaic"};
WmsLayer* wmsLayer = new WmsLayer(wmsServiceUrl, layerNames, this);
m_map->operationalLayers()->append(wmsLayer);
// Set map to map view
m_mapView->setMap(m_map);
// start zoomed in over the US
m_mapView->setViewpointGeometryAsync(Envelope(-19195297.778679, 512343.939994, -3620418.579987, 8658913.035426, SpatialReference::webMercator()));
}