Update Annotation Reference Scale (Cartography)

Summary

Updates the reference scale of an existing annotation or dimension feature class.

Usage

  • Before a feature class can have its reference scale updated, it must be upgraded to the current release using the Upgrade Dataset tool.

  • Caution:

    This tool modifies the input data. See Tools that modify or update the input data for more information and strategies to avoid undesired data changes.

  • Versioned feature classes cannot have their reference scale updated.

  • Changing the reference scale of a feature class is an intensive operation that requires an update of every feature's bounding box geometry.

  • An ArcGIS Desktop Standard or ArcGIS Desktop Advanced license is required to update the reference scale of a feature-linked annotation feature class.

Parameters

LabelExplanationData Type
Input Annotation Features

The input annotation or dimension features.

Annotation Layer; Dimension Layer
Reference Scale

The feature class reference scale to be updated.

Double

Derived Output

LabelExplanationData Type
Updated Annotation

The updated annotation or dimensions.

Annotation Layer; Dimension Layer

arcpy.cartography.UpdateAnnotationReferenceScale(in_anno_features, reference_scale)
NameExplanationData Type
in_anno_features

The input annotation or dimension features.

Annotation Layer; Dimension Layer
reference_scale

The feature class reference scale to be updated.

Double

Derived Output

NameExplanationData Type
updated_annotation

The updated annotation or dimensions.

Annotation Layer; Dimension Layer

Code sample

UpdateAnnotationReferenceScale example (Python window)

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


import arcpy
arcpy.cartography.UpdateAnnotationReferenceScale("C:/data/Canada.gdb/cities", 
                                                 4000000)

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

Related topics