Control annotation sublayer visibility

View in

MAUI

UWP

WPF

WinUI

View on GitHub

Use annotation sublayers to gain finer control of annotation layer subtypes.

Image of control annotation sublayer visibility

Use case

Annotation, which differs from labels by having a fixed place and size, is typically only relevant at particular scales. Annotation sublayers allow for finer control of annotation by allowing properties (like visibility in the map and legend) to be set and others to be read (like name) on subtypes of an annotation layer.

An annotation dataset which marks valves as "Opened" or "Closed", might be set to display the "Closed" valves over a broader range of scales than the "Opened" valves, if the "Closed" data is considered more relevant by the map's author. Regardless, the user can be given a manual option to set visibility of annotation sublayers on and off, if required.

How to use the sample

Start the sample and take note of the visibility of the annotation. Zoom in and out to see the annotation turn on and off based on scale ranges set on the data.

Use the checkboxes to manually set "Open" and "Closed" annotation sublayers visibility to on or off.

How it works

Load a MobileMapPackage that contains AnnotationSublayer.
Get the sublayers from the map package's layers by calling Sublayer.SublayerContents.
You can toggle the visibility of each sublayer manually using the Sublayer.IsVisible property.
To determine if a sublayer is visible at the current scale of the MapView, use Sublayer.IsVisibleAtScale(MapView.Scale), by passing in the map's current scale.

Relevant API

AnnotationLayer
AnnotationSublayer
LayerContent

Offline data

This sample uses Gas Device Anno Mobile Map Package. It is downloaded from ArcGIS Online automatically before the sample runs.

About the data

The scale ranges were set by the map's author using ArcGIS Pro:

The "Open" annotation sublayer has its maximum scale set to 1:500 and its minimum scale set to 1:2000.
The "Closed" annotation sublayer has no minimum or maximum scales set, so will be drawn at all scales.

Sample Code

ControlAnnotationSublayerVisibility.xaml

ControlAnnotationSublayerVisibility.xaml.cs

Use dark colors for code blocksCopy
﻿<UserControl
    x:Class="ArcGIS.UWP.Samples.ControlAnnotationSublayerVisibility.ControlAnnotationSublayerVisibility"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:esriUI="using:Esri.ArcGISRuntime.UI.Controls">
    <Grid>
        <esriUI:MapView x:Name="MyMapView" />
        <Border Style="{StaticResource BorderStyle}">
            <Grid>
                <Grid.RowDefinitions>
                    <RowDefinition />
                    <RowDefinition />
                    <RowDefinition />
                </Grid.RowDefinitions>
                <CheckBox
                    x:Name="OpenCheckBox"
                    Grid.Row="0"
                    HorizontalAlignment="Left"
                    VerticalAlignment="Center"
                    Checked="OpenCheckBoxChanged"
                    IsChecked="True"
                    IsEnabled="False"
                    Unchecked="OpenCheckBoxChanged">
                    <TextBlock x:Name="OpenLabel" Text="Open" />
                </CheckBox>
                <CheckBox
                    x:Name="ClosedCheckBox"
                    Grid.Row="1"
                    HorizontalAlignment="Left"
                    VerticalAlignment="Center"
                    Checked="ClosedCheckBoxChanged"
                    IsChecked="True"
                    IsEnabled="False"
                    Unchecked="ClosedCheckBoxChanged">
                    <TextBlock x:Name="ClosedLabel" Text="Closed" />
                </CheckBox>
                <TextBlock
                    x:Name="ScaleLabel"
                    Grid.Row="2"
                    HorizontalAlignment="Center"
                    Text="Current map scale: 1:" />
            </Grid>
        </Border>
    </Grid>
</UserControl>