Display annotation

View on GitHubSample viewer app

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 an ArcGISMap 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 OS OpenRivers. 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 an ArcGIS Enterprise server.

Tags

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

Sample Code

MainActivity.kt
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
/*
 *  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.
 */

package com.esri.arcgisruntime.sample.displayannotation

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.data.ServiceFeatureTable
import com.esri.arcgisruntime.layers.AnnotationLayer
import com.esri.arcgisruntime.layers.FeatureLayer
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.Viewpoint
import com.esri.arcgisruntime.mapping.view.MapView
import com.esri.arcgisruntime.sample.displayannotation.databinding.ActivityMainBinding

class MainActivity : AppCompatActivity() {

    private val activityMainBinding by lazy {
        ActivityMainBinding.inflate(layoutInflater)
    }

    private val mapView: MapView by lazy {
        activityMainBinding.mapView
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(activityMainBinding.root)

        // authentication with an API key or named user is required to access basemaps and other
        // location services
        ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)

        // create a map with a light gray basemap
        mapView.map = ArcGISMap(BasemapStyle.ARCGIS_LIGHT_GRAY_BASE).apply {
            // add a feature layer from a feature service
            operationalLayers.add(
                FeatureLayer(ServiceFeatureTable(getString(R.string.river_feature_service_url)))
            )
            // add an annotation layer from a feature service
            operationalLayers.add(
                AnnotationLayer(getString(R.string.river_annotation_feature_service_url))
            )
        }

        // set the map view's initial view point
        mapView.setViewpoint(Viewpoint(55.882436, -2.725610, 75000.0))
    }

    override fun onPause() {
        mapView.pause()
        super.onPause()
    }

    override fun onResume() {
        super.onResume()
        mapView.resume()
    }

    override fun onDestroy() {
        mapView.dispose()
        super.onDestroy()
    }
}

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