Skip To Content ArcGIS for Developers Sign In Dashboard

AnnotationLayer QML Type

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

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

Layer

Properties

Signals

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

You can create an annotation layer by providing the URL or portal item of an annotation feature class or from a feature table containing annotation. Annotation layers are also supported in mobile map packages created in ArcGIS Pro 2.3 or later. Currently, ArcGIS Runtime supports read-only standard annotation.

An annotation layer may contain annotation sublayers (known as annotation classes in ArcGIS Pro). Annotation sublayers offer finer control over your annotation, allowing the author to set different visual properties from the parent annotation layer. These visual properties include font, size, color, or different minimum and maximum scale ranges. Within ArcGIS Runtime, the annotation sublayer allows you to do the following:

  • Access the annotation sublayer's metadata information, including legend information.
  • Set the visibility of each annotation sublayer.

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.

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

An annotation layer can be instantiated with either:

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
ArcGISItemitem
ArcGISFeatureTablefeatureTable (since Esri.ArcGISRuntime 100.6)

The url and item properties are mutually exclusive, so you must set only one for the layer before calling load().

See also Layer.

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?