Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for .NET

Map image layer sublayer visibility

This code sample is available for these platforms:
View Sample on GitHub

Change the visibility of sublayers.

screenshot

Use case

A map image layer may contain many sublayers such as different types of roads in a road network or city, county, and state borders in a US map. The user may only be interested in a subset of these sublayers. Or, perhaps showing all of the sublayers would show too much detail. In these cases, you can hide certain sublayers by changing their visibility.

How to use the sample

Click the button to see a list of sublayers. Each sublayer has a check box which can be used to toggle the visibility of the sublayer.

How it works

  1. Create an ArcGISMapImageLayer object with the URL to a map image service.
  2. Get the list of sublayers with mapImageLayer.Sublayers.
  3. For each layer in the sublayer list, set its visible property to true or false.

Relevant API

  • ArcGISMapImageLayer

Tags

layers, sublayers, visibility

Sample Code

<UserControl
    x:Class="ArcGISRuntime.UWP.Samples.ChangeSublayerVisibility.ChangeSublayerVisibility"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:esri="using:Esri.ArcGISRuntime"
    xmlns:esriUI="using:Esri.ArcGISRuntime.UI.Controls"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    d:DesignHeight="300"
    d:DesignWidth="300"
    mc:Ignorable="d">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="auto" />
            <RowDefinition Height="*" />
        </Grid.RowDefinitions>
        <CommandBar OverflowButtonVisibility="Collapsed">
            <AppBarButton
                Name="Sublayers"
                Click="OnSublayersButtonClicked"
                Content="Sublayers" />
        </CommandBar>
        <esriUI:MapView x:Name="MyMapView" Grid.Row="1" />
    </Grid>
</UserControl>
// Copyright 2016 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 Esri.ArcGISRuntime.Mapping;
using System;
using System.Linq;
using Windows.UI.Popups;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;

namespace ArcGISRuntime.UWP.Samples.ChangeSublayerVisibility
{
    [ArcGISRuntime.Samples.Shared.Attributes.Sample(
        "Change sublayer visibility",
        "Layers",
        "This sample demonstrates how to show or hide sublayers of a map image layer.",
        "")]
    public partial class ChangeSublayerVisibility
    {
        private ArcGISMapImageLayer _imageLayer;

        public ChangeSublayerVisibility()
        {
            InitializeComponent();

            // Setup the control references and execute initialization.
            Initialize();
        }

        private void Initialize()
        {
            // Create new Map.
            Map myMap = new Map();

            // Create uri to the map image layer.
            Uri serviceUri = new Uri(
               "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SampleWorldCities/MapServer");

            // Create new image layer from the url.
            _imageLayer = new ArcGISMapImageLayer(serviceUri)
            {
                Name = "World Cities Population"
            };

            // Add created layer to the basemaps collection.
            myMap.Basemap.BaseLayers.Add(_imageLayer);

            // Assign the map to the MapView.
            MyMapView.Map = myMap;
        }

        private async void OnSublayersButtonClicked(object sender, RoutedEventArgs e)
        {
            try
            {
                // Make sure that layer and it's sublayers are loaded.
                // If layer is already loaded, this returns directly.
                await _imageLayer.LoadAsync();

                ContentDialog dialog = new ContentDialog()
                {
                    Title = "Sublayers",
                    FullSizeDesired = true
                };

                // Create list for layers.
                ListView sublayersListView = new ListView();

                // Create cells for each of the sublayers.
                foreach (ArcGISSublayer sublayer in _imageLayer.Sublayers)
                {
                    // Generate a toggle that provides on/off functionality.
                    ToggleSwitch toggle = new ToggleSwitch()
                    {
                        Header = sublayer.Name,
                        IsOn = sublayer.IsVisible,
                        Margin = new Thickness(5)
                    };

                    // Hook into the On/Off changed event.
                    toggle.Toggled += OnSublayerToggled;

                    // Add cell into the table view.
                    sublayersListView.Items.Add(toggle);
                }

                // Set listview to the dialog.
                dialog.Content = sublayersListView;

                // Add a close button for the dialog.
                dialog.PrimaryButtonText = "Close";
                dialog.PrimaryButtonClick += (s, a) => dialog.Hide();

                // Show dialog as a full screen overlay.
                await dialog.ShowAsync();
            }
            catch (Exception ex)
            {
                await new MessageDialog(ex.ToString(), "Error").ShowAsync();
            }
        }

        private void OnSublayerToggled(object sender, RoutedEventArgs e)
        {
            ToggleSwitch toggle = (ToggleSwitch)sender;

            // Find the layer from the image layer.
            ArcGISSublayer sublayer = _imageLayer.Sublayers.First(x => x.Name == toggle.Header.ToString());

            // Change sublayers visibility.
            sublayer.IsVisible = toggle.IsOn;
        }
    }
}