A layer that can visualize annotation text data. Annotation can be used to symbolize text on your maps as described here in "Annotation". It is defined using a text string, geographical location, and display properties including font, size, and color. This information is stored together in an annotation feature class within a geodatabase. More...
| Header: | #include <AnnotationLayer.h> |
| Since: | Esri::ArcGISRuntime 100.5 |
| Inherits: | Esri::ArcGISRuntime::Layer and Esri::ArcGISRuntime::RemoteResource |
This class was introduced in Esri::ArcGISRuntime 100.5.
Public Functions
| AnnotationLayer(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr) | |
| AnnotationLayer(const QUrl &url, QObject *parent = nullptr) | |
| AnnotationLayer(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr) | |
| AnnotationLayer(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, QObject *parent = nullptr) | |
| AnnotationLayer(Esri::ArcGISRuntime::Item *item, qint64 serviceLayerId, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr) | |
| AnnotationLayer(Esri::ArcGISRuntime::Item *item, qint64 serviceLayerId, QObject *parent = nullptr) | |
| virtual | ~AnnotationLayer() override |
| Esri::ArcGISRuntime::LabelBarrierWeight | barrierWeight() const |
| void | clearSelection() |
| QString | definitionExpression() const |
| Esri::ArcGISRuntime::ArcGISFeatureTable * | featureTable() const |
| double | referenceScale() const |
| void | resetFeaturesVisible() |
| void | selectFeature(Esri::ArcGISRuntime::Feature *feature) |
| void | selectFeatures(const QList<Esri::ArcGISRuntime::Feature *> &features) |
| Esri::ArcGISRuntime::TaskWatcher | selectFeatures(const Esri::ArcGISRuntime::QueryParameters ¶meters, Esri::ArcGISRuntime::SelectionMode mode) |
| Esri::ArcGISRuntime::TaskWatcher | selectedFeatures() |
| qint64 | serviceLayerId() const |
| void | setBarrierWeight(Esri::ArcGISRuntime::LabelBarrierWeight barrierWeight) |
| void | setDefinitionExpression(const QString &definitionExpression) |
| void | setFeatureVisible(Esri::ArcGISRuntime::Feature *feature, bool visible) |
| void | setFeaturesVisible(const QList<Esri::ArcGISRuntime::Feature *> &features, bool visible) |
| void | unselectFeature(Esri::ArcGISRuntime::Feature *feature) |
| void | unselectFeatures(const QList<Esri::ArcGISRuntime::Feature *> &features) |
Reimplemented Public Functions
| virtual Esri::ArcGISRuntime::Credential * | credential() const override |
| virtual Esri::ArcGISRuntime::RequestConfiguration | requestConfiguration() const override |
| virtual void | setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override |
| virtual QUrl | url() const override |
Signals
| void | selectFeaturesCompleted(QUuid taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult) |
| void | selectedFeaturesCompleted(QUuid taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult) |
Detailed Description
There are two kinds of annotation:
- 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:
- URL or portal item of an online annotation feature class
- Feature table containing annotation features: - An online ServiceFeatureTable that has a feature layer service type of ArcGISFeatureLayerInfoServiceType::AnnotationLayer - An offline GeodatabaseFeatureTable returned by the Geodatabase::geodatabaseAnnotationTables collection when a GenerateGeodatabaseJob has completed
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.
Member Function Documentation
AnnotationLayer::AnnotationLayer (const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
Creates a new annotation layer from a feature service URL.
- url - The URL to the feature service layer.
- credential - The credential used to access the remote resource.
- parent - An optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 100.13.
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 , Esri::ArcGISRuntime::Credential *credential, 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.
- featureTable - a feature table ArcGISFeatureTable.
- credential - The credential used to access the remote resource.
- parent - An optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 100.13.
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.
- featureTable - a feature table ArcGISFeatureTable.
- parent - An optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 100.6.
AnnotationLayer::AnnotationLayer (Esri::ArcGISRuntime::Item *item, qint64 serviceLayerId , Esri::ArcGISRuntime::Credential *credential, 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.
- credential - The credential used to access the remote resource.
- parent - An optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 100.13.
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.
[signal] void AnnotationLayer::selectFeaturesCompleted (QUuid taskId , Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult )
Signal emitted when the selectFeatures(QueryParameters, SelectionMode) operation completes.
- taskId - The task ID of the asynchronous operation.
- featureQueryResult - A feature query result containing an iterator pointing to the selected features from the query.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also Returned QObjects Parenting.
[signal] void AnnotationLayer::selectedFeaturesCompleted (QUuid taskId , Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult )
Signal emitted when the selectedFeatures operation completes.
- taskId - The task ID of the asynchronous operation.
- featureQueryResult - A feature query result containing an iterator pointing to the selected features.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also Returned QObjects Parenting.
[override virtual] AnnotationLayer::~AnnotationLayer ()
Destructor.
Esri::ArcGISRuntime::LabelBarrierWeight AnnotationLayer::barrierWeight () const
Returns the weight of annotation features when considered as barriers to labeling. The default is LabelBarrierWeight::High.
This function was introduced in Esri::ArcGISRuntime 100.14.
See also setBarrierWeight().
void AnnotationLayer::clearSelection ()
Sets all selected features in the layer to the unselected state.
This function was introduced in Esri::ArcGISRuntime 100.12.
[override virtual] Esri::ArcGISRuntime::Credential *AnnotationLayer::credential() const
Reimplements: RemoteResource::credential() const.
Returns security credentials to access the remote resource.
Only applicable if the resource is secured.
This function was introduced in Esri::ArcGISRuntime 100.13.
QString AnnotationLayer::definitionExpression () const
Returns an SQL statement WHERE clause to specify the subset of features to be displayed. The definition expression string uses the SQL-92 WHERE clause syntax: (https://en.wikipedia.org/wiki/SQL-92). The default value is an empty string, which will allow all annotation features in the data source to be used by the AnnotationLayer.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also setDefinitionExpression().
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.
[override virtual] Esri::ArcGISRuntime::RequestConfiguration AnnotationLayer::requestConfiguration () const
Reimplements: RemoteResource::requestConfiguration() const.
Returns the RequestConfiguration used to customize the request to this RemoteResource.
This function was introduced in Esri::ArcGISRuntime 100.13.
See also setRequestConfiguration().
void AnnotationLayer::resetFeaturesVisible ()
Resets the visibility of the layer's features to the original visibility loaded from the data source.
This function was introduced in Esri::ArcGISRuntime 100.12.
void AnnotationLayer::selectFeature (Esri::ArcGISRuntime::Feature *feature)
Selects the given feature and adds it to the current list of selected features.
- feature - The feature.
This function was introduced in Esri::ArcGISRuntime 100.12.
void AnnotationLayer::selectFeatures (const QList<Esri::ArcGISRuntime::Feature *> &features)
Selects the features in the list and adds them to the current list of selected features.
This function was introduced in Esri::ArcGISRuntime 100.12.
Esri::ArcGISRuntime::TaskWatcher AnnotationLayer::selectFeatures (const Esri::ArcGISRuntime::QueryParameters ¶meters, Esri::ArcGISRuntime::SelectionMode mode)
Selects all features that match the criteria in the QueryParameters object and adds them to the current list of selected features.
- parameters - The definition of the query to submit to the feature table.
- mode - Defines how the list of currently selected features will be updated with the features returned from the query.
This method returns a TaskWatcher for the asynchronous operation.
This function was introduced in Esri::ArcGISRuntime 100.12.
Esri::ArcGISRuntime::TaskWatcher AnnotationLayer::selectedFeatures ()
Returns a list of the currently selected features. This method returns a TaskWatcher for the asynchronous operation.
This function was introduced in Esri::ArcGISRuntime 100.12.
qint64 AnnotationLayer::serviceLayerId () const
Returns the layer ID for the layer.
void AnnotationLayer::setBarrierWeight (Esri::ArcGISRuntime::LabelBarrierWeight barrierWeight )
Sets the barrierWeight to barrierWeight.
This function was introduced in Esri::ArcGISRuntime 100.14.
See also barrierWeight.
void AnnotationLayer::setDefinitionExpression (const QString &definitionExpression )
Sets the definitionExpression to definitionExpression.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also definitionExpression.
void AnnotationLayer::setFeatureVisible (Esri::ArcGISRuntime::Feature *feature, bool visible)
Sets the visibility of the given feature.
- feature - The feature.
- visible -
trueto show,falseto hide.
This function was introduced in Esri::ArcGISRuntime 100.12.
void AnnotationLayer::setFeaturesVisible (const QList<Esri::ArcGISRuntime::Feature *> &features, bool visible)
Sets the visibility of the features in the QList.
- features - A QList of Feature. Contents of the QList are copied.
- visible -
trueto show,falseto hide.
This function was introduced in Esri::ArcGISRuntime 100.12.
[override virtual] void AnnotationLayer::setRequestConfiguration (const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration )
Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).
Sets the RequestConfiguration, which is used to customize the request to this RemoteResource, to requestConfiguration.
This function was introduced in Esri::ArcGISRuntime 100.13.
See also requestConfiguration().
void AnnotationLayer::unselectFeature (Esri::ArcGISRuntime::Feature *feature)
Removes the given feature from the list of selected features.
- feature - The feature.
This function was introduced in Esri::ArcGISRuntime 100.12.
void AnnotationLayer::unselectFeatures (const QList<Esri::ArcGISRuntime::Feature *> &features)
Removes the features specified in the given list from the list of selected features.
This function was introduced in Esri::ArcGISRuntime 100.12.
[override virtual] QUrl AnnotationLayer::url() const
Reimplements: RemoteResource::url() const.
Returns the Feature Service URL for the layer.