Annotation
A layer that can visualize annotation text data. Annotation can be used to symbolize text on your maps as described here in https://pro.arcgis.com/en/pro-app/help/data/annotation/annotation.htm. 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.
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.annotationTables 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
Since
200.1.0
Constructors
Creates an annotation layer from a feature table containing annotation features. If the feature table does not contain annotation data then the AnnotationLayer will fail to load. ArcGISFeatureTable.layerInfo and ArcGISFeatureLayerInfo.featureServiceType can be checked, to verify the feature type, before attempting to create a Layer.
Creates a new annotation layer object from a feature service portal item.
Creates a new annotation layer from a feature service URI. If the specified URI is not a valid ArcGIS feature service endpoint, then it will fail to load.
Properties
The weight of annotation features when considered as barriers to labeling. The default is LabelBarrierWeight.High.
A SQL statement where clause that stipulates a 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. Warning: Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. For more information, see the ArcGIS Blog article https://www.esri.com/arcgis-blog/products/api-rest/data-management/querying-feature-services-date-time-queries/.
The feature table associated with this layer.
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.
Inherited properties
The attribution text for the layer.
A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.
The description for the layer.
The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.
The unique identifying string for the layer, as specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
Callback invoked when the visibility of the layer changes.
Functions
Updates any selected features in the layer back to the un-selected state.
Clones the AnnotationLayer.
Returns a list of the currently selected features.
Resets the visibility of the layer's features back to the original visibility when loaded from the data source.
Selects the given feature and adds it to the current list of selected features.
Selects the features in the list and adds them to the current list of selected features.
Selects the features that match the criteria in the QueryParameters object and adds them to the current list of selected features.
Sets the visibility of the given features.
Sets the visibility of the given feature.
Unselects the given feature and removes it from the current list of selected features.
Unselects the features in the given list and removes them from the current list of selected features.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.