Annotate Selected Features (Cartography Tools)

Summary

Creates annotation for the selected features of a layer. The labeling properties defined in the annotation class properties of the specified related annotation feature classes are used.

Usage

Features to be annotated are determined by a selection applied to a layer. The selection must be determined in a previous step using Select Layer by Attribute or Select Layer by Location or by querying a map layer in ArcGIS Pro.
The map determines which feature-linked annotation classes are listed. There can be many feature-linked annotation classes, but only those in the map will be listed. Check the annotation classes in which you want to store the annotation.
The Input Layer must include a selection; otherwise, Annotate Selected Features will fail.
The Input Layer must have feature-linked annotation; otherwise, Annotate Selected Features will fail.
Some labels may not currently display on the map because there is no room for them. To convert these labels, check the Convert unplaced labels to annotation check box. This saves the unplaced labels in the annotation feature class, allowing you to position them later in an ArcGIS Pro edit session.

Label	Explanation	Data type
Input Map	The input map.	Map
Input Features	The layer for which the selected features will have annotation created.	Feature Layer
Annotation Layers	The feature-linked annotation layers and the specified sublayers that will have annotation converted into them. Value table columns: Annotation Layer—The annotation layers that will have annotation converted into them. Sublayers—The specified sublayers of the annotation layers that will have annotation converted into them.	Value Table
Convert unplaced labels to unplaced annotation (Optional)	Specifies whether to create unplaced annotation from unplaced labels. Checked—Unplaced annotation are stored in the annotation feature class. The status field for these annotation is set to Unplaced. Unchecked—Annotation will only be created for features that are currently labeled. This is the default.	Boolean

Derived output

Label	Explanation	Data type
Output Annotation Layers	The output annotation layers.	Annotation Layer

arcpy.cartography.AnnotateSelectedFeatures(in_map, in_layer, anno_layers, {generate_unplaced})

Name	Explanation	Data type
in_map	The input map.	Map
in_layer	The layer for which the selected features will have annotation created.	Feature Layer
anno_layers [[annotation_layer, sublayer;sublayer],...]	The feature-linked annotation layers and the specified sublayers that will have annotation converted into them. Value table columns: `Annotation Layer`—The annotation layers that will have annotation converted into them. `Sublayers`—The specified sublayers of the annotation layers that will have annotation converted into them.	Value Table
generate_unplaced (Optional)	Specifies whether to create unplaced annotation from unplaced labels. `GENERATE_UNPLACED`—Unplaced annotation are stored in the annotation feature class. The status field for these annotation is set to Unplaced. `ONLY_PLACED`—Annotation will only be created for features that are currently labeled. This is the default.	Boolean

Derived output

Name	Explanation	Data type
out_anno_layers	The output annotation layers.	Annotation Layer

Code sample

AnnotateSelectedFeatures example 1 (Python window)

The following Python window script demonstrates how to use the AnnotateSelectedFeatures tool in immediate mode.

import arcpy
arcpy.env.workspace = "c:/data/Canada.gdb"
arcpy.management.SelectLayerByAttribute("cities", 'NEW_SELECTION',
                                        "County = 'Northumberland'")
arcpy.cartography.AnnotateSelectedFeatures("Map", 'cities',
                                           "citiesAnno 'Class 1;Class 2'; citiesAltAnno 'Class 1'",
                                           "GENERATE_UNPLACED")

AnnotateSelectedFeatures example 2 (stand-alone script)

Stand-alone script that annotates selected features for the layer using the AnnotateSelectedFeatures function.

# Name: AnnotateSelectedFeatures.py
# Description: Annotate features based on a selection in a map

# Import system modules
import arcpy

# Set environment settings
arcpy.env.workspace = "C:\\data\\Northumberland.gdb"

# Run Annotate Selected Features
p = arcpy.mp.ArcGISProject("C:\\data\\Northumberland.aprx")
for m in p.listMaps():
    arcpy.cartography.AnnotateSelectedFeatures(m, 'Wells', "WellsAnno 'Class 1'",
                                               'GENERATE_UNPLACED')

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes

Annotate Selected Features (Cartography Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics