ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / Map Class
Properties Methods Events


In This Topic
    Map Class Members
    In This Topic

    The following tables list the members exposed by Map.

    Public Properties
     NameDescription
    Public Property Gets the animation for the map.  
    Public Property Gets the flag indicating if the feature cache is automatically filled for layers in the map.  
    Public Property Gets the current color model  
    Public Property Gets the map's default viewing mode.  
    Public Property Gets whether the map is of type scene.  
    Public Property Gets a read-only collection of layers from the layer container.  
    Public Property Gets the collection of layer template packages installed with Pro for use with maps  
    Public Property Gets the map type.  
    Public Property Gets the name of the map.  
    Public Property Gets the clip distance for the map  
    Public Property Gets the clipping mode for the map  
    Public Property Gets the OperationManager.  
    Public Property Gets the reference scale of the map.  
    Public Property Gets the number of rows and features selected in the map.  
    Public Property Gets if simulate overprint is set  
    Public Property Gets the spatial reference of the map.  
    Public Property Gets all standalone tables of the map.  
    Public Property Gets or sets the graphics layer that acts as a target for interactive drawing tools.  
    Public Property Gets the unique URI of this dataset.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded.   
    Public Method Returns the full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Methodstatic (Shared in Visual Basic) Indicates whether or not an item can be added to the map.  
    Public Method Cancels any existing feature cache requests.  
    Public Method Determines whether a fill feature cache operation can be executed. Only one fill feature cache operation can be exxecuted at any one time.  
    Public Method Change GeoDatabase version of layers and standalone tables of fromVersionBase. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Clear the current map clip geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Will remove all elevation surfaces from the map with the exception of Ground. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public Method Clear the selection in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Export bookmarks from the active map or scene to a BKMX file. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public Method Performs a find and replace of workspace paths for all layers and tables in the map that share that workspace path. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Finds an elevation surface layer using a URI.  
    Public Method Finds a layer using a URI.  
    Public Method Finds layers by name.  
    Public Method Finds a StandaloneTable using a URI. Group layers within the map are also searched.  
    Public Method Finds StandaloneTables by name. Group layers within the map are also searched.  
    Public Method Gets the list of available elevation unit formats for the given scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the list of available map location unit formats for the given map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the map's collection of bookmarks. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets whether the Map metadata can be edited or not. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Get the current map clipping geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the custom full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the default full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the map definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the number of elements in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the storage size of all the elements in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the list of elevation surface layers for the map.  
    Public Method Gets the current scene elevation unit format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the general label placement properties of the map. This method must be called on the MCT. Use QueuedTask.Run .  
    Public Method Gets the ground elevation surface layer from the map.  
    Public Method Get the highlight selection for the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the label engine type of the map. This method must be called on the MCT. Use QueuedTask.Run .  
    Public Method Returns a read only flat list of layers where nested groups are not preserved.  
    Public Method Gets the current map location unit format for the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns a read only flat list of mapMembers where nested groups are not preserved.  
    Public Method Get the collection of map panes for the map  
    Public Method Gets the Map metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Get the selection for the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets a readonly snapshot of the layers  
    Public Method Returns a read only flat list of StandaloneTables where nested groups are not preserved.  
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Method Import bookmarks from ArcMap, ArcGlobe, and ArcScene bookmark files (*.dat) or ArcGIS Pro bookmark files (*.bmkx). This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Moves the bookmark to a new index in the map's collection of bookmarks. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Method Open a new view for this map.  
    Public Method Removes the bookmark from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Removes a specified layer from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Removes the specified layers from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Removes the specified StandaloneTable from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Removes the specified StandaloneTables from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Performs a find and replace of workspace paths for all layers and tables in the map that share that workspace path. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Saves the map as a mapx file. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Save the current map to webmap file format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the flag indicating if the feature cache is automatically filled for layers in the map.  
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Method Updates the custom full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the map definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the current scene elevation unit format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Updates the general label placement properties of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Updates the label engine type of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the current map location unit format for the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the Map metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Updates the name of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Updates the reference scale of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Set the selection in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Updates the spatial reference of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the name of the map.  
    Top
    Protected Methods
    Extension Methods
     NameDescription
    Public Extension Method Add a diagram layer to a diagram map.
    Public Extension Method Add a diagram layer to a diagram map.
    Public Extension MethodOverloaded. 
    Public Extension Method Gets if the active topology can be cleared. That is; the active topology cam be set to "No Topology".
    Public Extension MethodOverloaded. 
    Public Extension Method Gets if the active topology can be set to a MapTopology. Map topologies are only supprted for 2D non-stereo maps.
    Public Extension Method Clears the active topology. That is; sets the active topology to "No Topology".
    Public Extension Method Compute the combined scale factor using two points and using a z elevation at the mid-point between them.
    Public Extension Method Gets the active topology properties from the map.
    Public Extension Method Gets the list of available topologies for the map. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Gets the GroundToGridCorrection for the given map.
    Public Extension Method Gets the set of topology properties for the specified topology name.
    Public Extension MethodOverloaded. 
    Public Extension Method Sets the GroundToGridCorrection for the given map.
    Public Extension Method Sets the active topology to the map topolgoy.
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also