ArcMap

Convert Labels To Annotation

Summary

ArcGIS Defense Mapping cartographic production tool that converts labels to annotation based on an input map document, annotation feature class, and optional data frame.

Usage

  • This tool attempts to match label classes on a layer with an annotation class in the target annotation feature class. If it finds a match, it will create annotation for that label class.

  • If the map has a reference scale set and it does not match the reference scale of the annotation feature class, you will get a warning. If the map does not have reference scale, it checks the map scale, and if it is different than the annotation feature class reference scale, you will get a warning.

  • If a layer's visibility is turned off, that layer will be skipped.

  • If the property Label Features is not selected on a layer, that layer will be skipped.

  • If the property Label features in the class is not checked in a label class, that label class will be skipped.

  • If the min/max scale properties in the label class indicate the labels should not be drawn based on the current map scale, the label class will be skipped.

  • Generating annotation is a resource-intensive process. Processing a map document that will result in large numbers of annotations created can consume a lot of memory.

  • Labeling in the .mxd will be turned off after running this tool so the labels and annotation do not conflict.

Syntax

arcpy.defense.ConvertLabelsToAnnotation(in_mapdocument, in_annotation, {in_dataframe})
ParameterExplanationData Type
in_mapdocument

The map document file that will be updated.

ArcMap Document
in_annotation

Existing annotation feature class where the labels will be converted to annotation. The annotation class names must match the label class names in the input map document layers. Annotation will not be created for label classes when a corresponding annotation class does not exist.

Feature Class; Feature Layer
in_dataframe
(Optional)

The data frame to apply the labels to annotation conversion. If not selected, the tool will process all data frames in the input map document.

String

Code sample

ConvertLabelsToAnnotation example (Python window)

The following code example demonstrates how to execute the ConvertLabelsToAnnotation function.

# Script variables
mxd = 'C:/Example/Untitled.mxd'
annoFeatures = 'C:/Example/example.gdb/CARTO/MTM50_Anno'

# Run Convert Labels to Annotation tool
arcpy.ConvertLabelsToAnnotation_defense(mxd, annoFeatures)

Environments

Licensing information

  • Basic: No
  • Standard: Requires Defense Mapping
  • Advanced: Requires Defense Mapping

Related topics