View on GitHub Sample 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 basemap and a viewpoint near the data.
  2. Create a FeatureLayer from a feature service URL.
  3. Create an AnnotationLayer from a feature service URL.
  4. Add both layers to the operational layers of the map and display it in 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

MainActivity.kt MainActivity.kt DisplayAnnotationViewModel.kt DisplayAnnotationScreen.kt
/* Copyright 2025 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.arcgismaps.sample.displayannotation
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
import com.esri.arcgismaps.sample.displayannotation.screens.DisplayAnnotationScreen
class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// authentication with an API key or named user is
// required to access basemaps and other location services
ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.ACCESS_TOKEN)
enableEdgeToEdge()
setContent {
SampleAppTheme {
DisplayAnnotationApp()
}
}
}
@Composable
private fun DisplayAnnotationApp() {
Surface(color = MaterialTheme.colorScheme.background) {
DisplayAnnotationScreen(
sampleName = getString(R.string.display_annotation_app_name)
)
}
}
}