ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMMap Class
Properties Methods Events


In This Topic
    CIMMap Class Members
    In This Topic

    The following tables list the members exposed by CIMMap.

    Public Constructors
     NameDescription
    Public Constructor  
    Top
    Public Properties
     NameDescription
    Public Property Gets or sets the name of the currently active animation track.  
    Public Property Gets or sets the collection of view tracks in the animation.  
    Public Property Gets or sets the attribution text that will appear on the map when it is drawn.  
    Public Property Gets or sets a value indicating whether auto fill mode is enabled or disabled for a map.  
    Public Property Gets or sets the background color.  
    Public Property Gets or sets the bookmarks.  
    Public Property Gets or sets the border symbol used for displaying the clipping area.  
    Public Property Gets or sets the clipping mode for a map.  
    Public Property Gets or sets a value indicating whether or not to clip to full extent.  
    Public Property Gets or sets the name of the CMYK color profile for a map.  
    Public Property Gets or sets the color model for a map.  
    Public Property Gets or sets the URI of the custom clipping shape used when the clipping mode is set to CustomShape.  
    Public Property Gets or sets the URIs of the custom elevation surface layers in the map.  
    Public Property Gets or sets the custom full extent as a polygon.  
    Public Property Gets or sets the custom properties of the map. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.  
    Public Property Gets or sets the set of geographic transformations used by the map for spatial references that do not have vertical coordinate system.  
    Public Property Gets or sets the default camera.  
    Public Property Gets or sets the camera effect that new views of this scene are opened with.  
    Public Property Gets or sets the color vision deficiency mode that new views of this map or scene are opened with.  
    Public Property Gets or sets the extent shown when you open new views of the map. The application automatically updates this property whenever you save a project with an active map view.  
    Public Property Gets or sets the transparency of the spheroid's combined terrain mesh and draped content.  
    Public Property Gets or sets the post-processing effects that new views of this scene are opened with.  
    Public Property Gets or sets the default rotation.  
    Public Property Gets or sets the scale used when you open new views of the map. When set, the application automatically applies this property after DefaultExtent to ensure the view is at the correct scale.  
    Public Property Gets or sets the viewing mode that new views of this map are opened with.  
    Public Property Gets or sets the visual effect that new views of this scene are opened with.  
    Public Property Gets or sets the long description of the map.  
    Public Property Gets or sets the editing elevation mode.  
    Public Property Gets or sets the collection of editing templates for a map.  
    Public Property Gets or sets a value indicating whether or to enable navigation below the ground.  
    Public Property Gets or sets a value indicating whether or to enable wraparound when the coordinate system supports it.  
    Public Property Gets or sets the collection of field mappings for a map.  
    Public Property Gets or sets the floor-aware properties of the map.  
    Public Property Gets or sets the general label placement properties for dynamic labels in the map.  
    Public Property Gets or sets the geotrigger properties of the map.  
    Public Property Gets or sets the URI of the ground elevation surface layer in the map.  
    Public Property Gets or sets the Ground To Grid Correction properties.  
    Public Property Gets or sets the set of geographic transformations used by the map for spatial references with vertical coordinate system.  
    Public Property Gets or sets the illumination properties.  
    Public Property Gets or sets a value indicating whether or not to draw up to and including the maximum scale in scale ranges.  
    Public Property Gets or sets the IPS-aware properties of the map.  
    Public Property Gets or sets the Knowledge Graph Link Chart properties of this map. This property is only applicable if the MapType is LinkChart.  
    Public Property Gets or sets the layers as an array of layer repository paths.  
    Public Property Gets or sets the layers to be excluded from clipping. The layers are defined as an array of layer repository paths.  
    Public Property Gets or sets the link charts as an array of link chart repository paths.  
    Public Property Gets or sets the locators as an ordered array.  
    Public Property Gets or sets an array string values used to provide a hint for the intended context for the map.  
    Public Property Gets or sets the map type.  
    Public Property Gets or sets the metadata URI. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the name. (Inherited from ArcGIS.Core.CIM.CIMDefinition)
    Public Property Gets or sets the near plane clip distance in meters for a scene. This property applies to only local and global viewing modes.  
    Public Property Gets or sets the near plane clipping mode for a scene. This property applies to only local and global viewing modes.  
    Public Property Gets or sets the range slider settings.  
    Public Property Gets or sets the map reference scale.  
    Public Property Gets or sets the name of the RGB color profile for a map.  
    Public Property Gets or sets the display mode for the map's Scales in the user interface.  
    Public Property Gets or sets the scale format describing the formatting of the scale value.  
    Public Property Gets or sets an array of CIMScale objects, describing the full list of named scales for the map.  
    Public Property Gets or sets a value indicating whether to simulate overprint for a map.  
    Public Property Gets or sets the snapping properties of the map.  
    Public Property Gets or sets a value indicating whether to snap only to the map's list of named scales when zooming.  
    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 the map's spatial reference.  
    Public Property Gets or sets the standalone tables as an array of table repository paths.  
    Public Property Gets or sets the standalone videos as an array of video repository paths.  
    Public Property Gets or sets the stereo properties.  
    Public Property Gets or sets the color of the default spheroid.  
    Public Property Gets or sets the surfaces to be excluded from clipping. The surfaces are defined as an array of surface IDs.  
    Public Property Gets or sets the time display properties.  
    Public Property Gets or sets the time slider settings.  
    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 masking established on all layers in the map is turned on or off.  
    Public Property Gets or sets a value indicating whether to allow the use of unique numeric IDs on layers that will be used when publishing services.  
    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 the weather effect.  
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMMap.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMMap 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 CIMMap 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