ArcGIS Developers

AnnotationLayer Class

class Esri::ArcGISRuntime::AnnotationLayer

A layer that can visualize annotation text data. More...

Header: #include <AnnotationLayer>
Since: Esri::ArcGISRuntime 100.5
Inherits: Esri::ArcGISRuntime::Layer

This class was introduced in Esri::ArcGISRuntime 100.5.

Public Functions

AnnotationLayer(const QUrl &url, QObject *parent = nullptr)
AnnotationLayer(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, QObject *parent = nullptr)
AnnotationLayer(Esri::ArcGISRuntime::Item *item, qint64 serviceLayerId, QObject *parent = nullptr)
virtual ~AnnotationLayer() override
Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable() const
double referenceScale() const
qint64 serviceLayerId() const
QUrl url() const

Detailed Description

Annotation can be used to symbolize text on your maps (in addition to labeling). Annotation is defined by a text string, geographical location, and display properties including font, size, and color. These are stored together in an annotation feature class within a geodatabase.

Functional characteristics

Standard annotation is not formally associated with features in the geodatabase. An example of standard annotation is the text on a map for a mountain range. No specific feature represents the mountain range, but it is an area you want to mark. Standard annotation is read-only.

Feature-linked annotation is associated with a specific feature in another feature class in the geodatabase. The text in feature-linked annotation reflects the value of a field or fields from the feature to which it is linked. For example, the water transmission mains in a water network can be annotated with their names, which are stored in a field in the transmission mains feature class. If you edit the attributes and/or geographical position of the feature associated with the feature-linked annotation, any changes will be applied to the annotation feature table, and visible changes to the annotation will be reflected in the MapView. If the feature-linked annotation is stored in an Enterprise server, its feature and annotation tables must contain global object ids.

You can construct an annotation layer using any of the following:

Annotation layers can be taken offline from a feature service hosted on ArcGIS Enterprise 10.7.1 or later, using the GeodatabaseSyncTask. Annotation layers are also supported in mobile map packages created in ArcGIS Pro 2.3 or later.

Annotation respects the reference scale defined by the map, so annotation will always be presented to the user at the correct size and position, as defined by the annotation author.

Each annotation layer is partitioned into annotation sublayers. Each annotation sublayer corresponds to the label class of the original labels that were used to publish the annotation. In ArcGIS Pro, the annotation sublayers are known as annotation classes.

Annotation sublayers offer greater control over the annotation:

  • An author can set different visual properties on the sublayer compared to the parent annotation layer. For example, font, size, color, or different minimum and maximum scale ranges.
  • You can access the annotation sublayer metadata information, such as the legend information, and set the visibility of each annotation sublayer.

For samples, see Display Annotation and Control annotation sublayer visibility.

See also Layer.

Member Function Documentation

AnnotationLayer::AnnotationLayer(const QUrl &url, QObject *parent = nullptr)

Creates a new annotation layer from a feature service URL.

  • url - the URL to the feature service layer.
  • parent - an optional parent QObject.

AnnotationLayer::AnnotationLayer(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, QObject *parent = nullptr)

Creates a new annotation layer from a feature service table.

If the feature table does not contain annotation data then the AnnotationLayer will fail to load. ArcGISFeatureTable::layerInfo and ArcGISFeatureLayerInfo::serviceType can be checked to verify the feature type, before attempting to create a Layer.

This function was introduced in Esri::ArcGISRuntime 100.6.

AnnotationLayer::AnnotationLayer(Esri::ArcGISRuntime::Item *item, qint64 serviceLayerId, QObject *parent = nullptr)

Creates a new annotation layer from a feature service portal item.

  • item - a feature service PortalItem.
  • serviceLayerId - the layer ID for which to create the layer.
  • parent - an optional parent QObject.

[override virtual] AnnotationLayer::~AnnotationLayer()


Esri::ArcGISRuntime::ArcGISFeatureTable *AnnotationLayer::featureTable() const

Returns the feature table associated with this layer.

This function was introduced in Esri::ArcGISRuntime 100.6.

double AnnotationLayer::referenceScale() const

Returns the reference scale for the layer.

The reference scale of the layer is the scale at which a client should view the layer for the text to appear at its authored size.

If the client changes the viewing scale, then text will grow or shrink to keep a consistent size on the map (not the screen).

For a valid layer, the reference scale will always be a finite value, greater than zero. Until the layer is loaded, the reference scale will be zero.

qint64 AnnotationLayer::serviceLayerId() const

Returns the layer ID for the layer.

QUrl AnnotationLayer::url() const

Returns the Feature Service URL for the layer.

Feedback on this topic?