Display annotation

View inAndroidFormsUWPWPFWinUIiOSView on GitHub

Display annotation from a feature service URL.

Image of display annotation

Use case

Annotation is useful for displaying text that you don't want to move or resize when the map is panned or zoomed (unlike labels which will move and resize). You can use annotation to place text at a fixed size, position, orientation, font, and so on. You may choose to do this for cartographic reasons or because the exact placement of the text is important.

How to use the sample

Pan and zoom to see names of waters and burns in a small region of Scotland.

How it works

  1. Create a Map with a light gray canvas and a viewpoint near the data.
  2. Create an AnnotationLayer from a feature service URL.
  3. Add both layers to the operational layers of the map and add it to a MapView.

Relevant API

  • AnnotationLayer
  • FeatureLayer

About the data

Data derived from the OS Open Rivers dataset from Ordnance Survey . Contains OS data © Crown copyright and database right 2018.

The annotation layer contains two sublayers of rivers in East Lothian, Scotland, which were set by the author to only be visible within the following scale ranges:

  • Water (1:50,000 - 1:100,000) - A large stream, as defined in the Scots language
  • Burn (1:25,000 - 1:75,000) - A brook or small stream, as defined in the Scots language

Additional information

Annotation is only supported from feature services hosted on ArcGIS Enterprise.

Tags

annotation, cartography, labels, placement, reference scale, text, utility

Sample Code

DisplayAnnotation.cs
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
// Copyright 2019 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 ArcGISRuntime;
using Esri.ArcGISRuntime.Data;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.UI.Controls;
using Foundation;
using System;
using UIKit;

namespace ArcGISRuntimeXamarin.Samples.DisplayAnnotation
{
    [Register("DisplayAnnotation")]
    [ArcGISRuntime.Samples.Shared.Attributes.Sample(
        name: "Display annotation",
        category: "Layers",
        description: "Display annotation from a feature service URL.",
        instructions: "Pan and zoom to see names of waters and burns in a small region of Scotland.",
        tags: new[] { "annotation", "cartography", "labels", "placement", "reference scale", "text", "utility" })]
    public class DisplayAnnotation : UIViewController
    {
        // Hold references to UI controls.
        private MapView _myMapView;

        public DisplayAnnotation()
        {
            Title = "Display annotation";
        }

        private void Initialize()
        {
            // Uris for the river data.
            Uri riverFeatureServiceUri = new Uri("https://services1.arcgis.com/6677msI40mnLuuLr/arcgis/rest/services/East_Lothian_Rivers/FeatureServer/0");
            Uri riverFeatureLayerUri = new Uri("https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0");

            // Create a map.
            Map map = new Map(BasemapStyle.ArcGISLightGray);
            map.InitialViewpoint = new Viewpoint(55.882436, -2.725610, 50000);

            // Create a feature layer from a feature service.
            FeatureLayer riverFeatureLayer = new FeatureLayer(new ServiceFeatureTable(riverFeatureServiceUri));

            // Add the feature layer to the map.
            map.OperationalLayers.Add(riverFeatureLayer);

            // Create an annotation layer from a feature service.
            AnnotationLayer annotationLayer = new AnnotationLayer(riverFeatureLayerUri);

            // Add the annotation layer to the map.
            map.OperationalLayers.Add(annotationLayer);

            // Set the map to the map view.
            _myMapView.Map = map;
        }

        public override void LoadView()
        {
            // Create the views.
            View = new UIView() { BackgroundColor = ApplicationTheme.BackgroundColor };

            _myMapView = new MapView();
            _myMapView.TranslatesAutoresizingMaskIntoConstraints = false;

            // Add the views.
            View.AddSubviews(_myMapView);

            // Lay out the views.
            NSLayoutConstraint.ActivateConstraints(new[]{
                _myMapView.TopAnchor.ConstraintEqualTo(View.SafeAreaLayoutGuide.TopAnchor),
                _myMapView.BottomAnchor.ConstraintEqualTo(View.BottomAnchor),
                _myMapView.LeadingAnchor.ConstraintEqualTo(View.LeadingAnchor),
                _myMapView.TrailingAnchor.ConstraintEqualTo(View.TrailingAnchor)
            });
        }

        public override void ViewDidLoad()
        {
            base.ViewDidLoad();
            Initialize();
        }
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.