ArcGIS Developers
Dashboard

AnnotationLayer QML Type

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

Import Statement: import Esri.ArcGISRuntime 100.11
Since: Esri.ArcGISRuntime 100.5
Inherits:

Layer

Properties

Signals

Detailed Description

Annotation can be used to symbolize text on your maps as described here in "Annotation". It is defined using a text string, geographic location, and display properties including font, size, and color. This information is 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 geographic 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.

See also Layer, Layer, https://developers.arcgis.com/qt/qml/sample-code/display-annotation/, and https://developers.arcgis.com/qt/qml/sample-code/control-annotation-sublayer-visibility/.

Property Documentation

[default] featureTable : ArcGISFeatureTable

The featureTable, containing annotation features, used as the source of the annotation layer.

This property can be set only during instantiation. 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 property was introduced in Esri.ArcGISRuntime 100.6.


[default] item : ArcGISItem

A feature service PortalItem used to create the annotation layer.

AnnotationLayer can be created with an item or a url.

This may only be set once to initialize the layer.


referenceScale : double

The reference scale for the layer (read-only).

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.


serviceLayerId : string

The service layer ID being used by the annotation layer.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This property must be set along with the item property. Failure to set both properties will result in the layer failing to load.

The service layer ID cannot be changed after the layer is loaded.

See also serviceLayerIdAsInt.


serviceLayerIdAsInt : int

The same as serviceLayerId but represented as an integer type.

The service layer ID cannot be changed after the layer is loaded.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.


[default] url : url

The Feature Service URL for the layer.

AnnotationLayer can be created with an item or a url.

This may only be set once to initialize the layer.


Signal Documentation

featureTableChanged()

Emitted when the featureTable property changed.

Note: The corresponding handler is onFeatureTableChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.


referenceScaleChanged()

Emitted when the referenceScale property changes.

Note: The corresponding handler is onReferenceScaleChanged.


serviceLayerIdAsIntChanged()

Emitted when the serviceLayerIdAsInt property changes.

Note: The corresponding handler is onServiceLayerIdAsIntChanged.


serviceLayerIdChanged()

Emitted when the serviceLayerId property changes.

Note: The corresponding handler is onServiceLayerIdChanged.


urlChanged()

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.



Feedback on this topic?