ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMAnnotationLayer Class
Properties Methods Events


In This Topic
    CIMAnnotationLayer Class Members
    In This Topic

    The following tables list the members exposed by CIMAnnotationLayer.

    Public Constructors
     NameDescription
    Public Constructor  
    Top
    Public Properties
     NameDescription
    Public Property Gets or sets a value indicating whether layer can be draped on integrated mesh. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the attribution text that appears on a map that draws this layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether to automatically generate feature templates from the renderer. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the weight of features in this layer when considered as barriers to labeling.  
    Public Property Gets or sets the blending mode for the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets identifier the layer's charts. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the description. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the display cache type. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the current set of display filters. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the active display filter. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the current set of scale based display filters. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets DisplayFiltersType value. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets a value indicating whether the geometry of the text graphics should be drawn.  
    Public Property Gets or sets the line symbol used to draw text graphic line geometries when the DrawGeometry option is true.  
    Public Property Gets or sets the point symbol used to draw text graphic line geometries when the DrawGeometry option is true.  
    Public Property Gets or sets a value indicating whether unplaced annotation should be drawn.  
    Public Property Gets or sets a value indicating whether the current set of display filters are honored during drawing. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets a value indicating whether this layer is expanded in the contents pane. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the feature extrusion. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the feature cache type. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the feature elevation expression. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the expression for setting the feature elevation. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the collection of field names and sort directions used to sort features during draw. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the feature table. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the feature templates. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets a value indicating whether HTML pop-ups are enabled. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the HTML pop-ups format. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the in-line color. When using the SymbolSubstitutionIndividualSubordinate or SymbolSubstitutionIndividualDominant substitution types this is the color that all text graphics that are stored in-line (bloated) will be overridden with.  
    Public Property Gets or sets a value indicating whether the layer is flattened. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the 3D layer properties. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the layer elevation. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the URIs of the layers used as masks. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the layer template. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the map layer type. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the mass color substitute. When using the SymbolSubstitutionColor substitution type this is the color that all text graphics will be overridden with.  
    Public Property Gets or sets the maximum display cache age. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the maximum scale for layer draw (set as the denominator of the scale's representative fraction). (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the metadata URI. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the minimum scale for layer draw (set as the denominator of the scale's representative fraction). (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the name. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the page definition which allows for using current map series page to filter features. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the selection fill color. Only used for polygons. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the pop-up info. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether layer should be rasterized when exporting. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the amount of time to wait between refreshing the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the units for the amount of time to wait between refreshing the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether the layer is selectable. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the selection color. For polygons, this is used as the outline color. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets the selection symbol. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets identifier that will be used to identify the layer in server. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not to show legends. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not the display value is shown when hovering over a layer in the view. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not to show pop-ups. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the time the source was last modified, as of the last sync. Used to detect when another sync is needed. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the source portal URI of the item. Set if sourced from an external item such as an item on a portal. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the source URI of the item. Set if sourced from an external item such as an item on a portal. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets a collection of AnnotationSubLayers, corresponding to the annotation subclasses defined by the annotation feature class.  
    Public Property Gets or sets a symbol substitution collection.  
    Public Property Gets or sets the type of symbol substitution this layer uses.  
    Public Property Gets or sets the transparency of the layer. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the color that unplaced text graphics will be drawn with when Unplaced Annotation is drawn.  
    Public Property Gets or sets the URI of the definition. Typically set by the system and used as an identifier. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets a value indicating whether to use the selection symbol. (Inherited from ArcGIS.Core.CIM.CIMBasicFeatureLayer)
    Public Property Gets or sets a value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets a value indicating whether or not to use the visibility time extent. When true the map time must overlap the visibility time extent for the layer to be visible. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets a value indicating whether or not this layer is visible. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets the visibility time extent. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Public Property Gets or sets an identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map. (Inherited from ArcGIS.Core.CIM.CIMBaseLayer)
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMAnnotationLayer.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMAnnotationLayer with a specified state from a JSON encoding.  
    Public Method Not implemented, reserved for future use. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public Method Reads the element inside the reader. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public MethodOverridden.  Creates a JSON encoding of the CIMAnnotationLayer and its current state.  
    Public Method Writes the element inside the writer. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    Protected Methods
     NameDescription
    Protected Method Called from a property setter to notify the framework that an Object member has changed. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Protected MethodOverridden.  Reads the child element inside the reader.  
    Protected MethodOverridden.  Writes a child element to the writer.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    See Also