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
Create an ArcGISMap with a light gray canvas and a viewpoint near the data.
Create an AnnotationLayer from a feature service URL.
Add both layers to the operational layers of the map and add it to a MapView.
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.
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
* Copyright 2020 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.samples.display_annotation;
import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;
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.loadable.LoadStatus;
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;
publicclassDisplayAnnotationSampleextendsApplication{
private MapView mapView;
@Overridepublicvoidstart(Stage stage){
try {
// create stack pane and application scene StackPane stackPane = new StackPane();
Scene scene = new Scene(stackPane);
// set title, size, and add scene to stage stage.setTitle("Display Annotation Sample");
stage.setWidth(800);
stage.setHeight(700);
stage.setScene(scene);
stage.show();
// authentication with an API key or named user is required to access basemaps and other location services String yourAPIKey = System.getProperty("apiKey");
ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);
// create a map with the light gray basemap style ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_LIGHT_GRAY);
// create a map view and set the map to it mapView = new MapView();
mapView.setMap(map);
// set a viewpoint on the map view mapView.setViewpoint(new Viewpoint(55.882436, -2.725610, 72223));
// create a feature layer from a feature service FeatureLayer riverFeatureLayer = new FeatureLayer(new ServiceFeatureTable("https://services1.arcgis.com/6677msI40mnLuuLr/arcgis/rest/services/East_Lothian_Rivers/FeatureServer/0"));
// add the feature layer to the map map.getOperationalLayers().add(riverFeatureLayer);
// create an annotation layer from a feature service AnnotationLayer annotationLayer = new AnnotationLayer("https://sampleserver6.arcgisonline.com/arcgis/rest/services/RiversAnnotation/FeatureServer/0");
// add the annotation layer to the map map.getOperationalLayers().add(annotationLayer);
// show alert if layer fails to load riverFeatureLayer.addDoneLoadingListener(() -> {
if (riverFeatureLayer.getLoadStatus() != LoadStatus.LOADED) {
new Alert(Alert.AlertType.ERROR, "Error loading Feature Layer.").show();
}
});
// add a done loading listener, with a runnable that gets triggered asynchronously when the feature layer has loaded// check for the load status of the layer and if it hasn't loaded, report an error annotationLayer.addDoneLoadingListener(() -> {
if (annotationLayer.getLoadStatus() != LoadStatus.LOADED) {
new Alert(Alert.AlertType.ERROR, "Error loading Annotation Layer.").show();
}
});
// add the map view to stack pane stackPane.getChildren().add(mapView);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* Stops and releases all resources used in application.
*/@Overridepublicvoidstop(){
if (mapView != null) {
mapView.dispose();
}
}
/**
* Opens and runs application.
*
* @param args arguments passed to this application
*/publicstaticvoidmain(String[] args){
Application.launch(args);
}
}