ArcGIS Pro 3.1 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 PropertyAnimation Gets the animation for the map.  
    Public PropertyAutoFillFeatureCache Gets the flag indicating if the feature cache is automatically filled for layers in the map.  
    Public PropertyColorModel Gets the current color model  
    Public PropertyDefaultViewingMode Gets the map's default viewing mode.  
    Public PropertyIsScene Gets whether the map is of type scene.  
    Public PropertyLayers Gets a read-only collection of layers from the layer container.  
    Public PropertyLayerTemplatePackages Gets the collection of layer template packages installed with Pro for use with maps  
    Public PropertyMapType Gets the map type.  
    Public PropertyName Gets the name of the map.  
    Public PropertyNearPlaneClipDistance Gets the clip distance for the map  
    Public PropertyNearPlaneClipDistanceMode Gets the clipping mode for the map  
    Public PropertyOperationManager Gets the OperationManager.  
    Public PropertyReferenceScale Gets the reference scale of the map.  
    Public PropertySelectionCount Gets the number of rows and features selected in the map.  
    Public PropertySimulateOverprint Gets if simulate overprint is set  
    Public PropertySpatialReference Gets the spatial reference of the map.  
    Public PropertyStandaloneTables Gets all standalone tables of the map.  
    Public PropertyTargetGraphicsLayer Gets or sets the graphics layer that acts as a target for interactive drawing tools.  
    Public PropertyURI Gets the unique URI of this dataset.  
    Top
    Public Methods
     NameDescription
    Public MethodAddBookmarkOverloaded.   
    Public MethodCalculateFullExtent Returns the full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Methodstatic (Shared in Visual Basic)CanAdd Indicates whether or not an item can be added to the map.  
    Public MethodCancelFeatureCacheRequestsAsync Cancels any existing feature cache requests.  
    Public MethodCanFillFeatureCache Determines whether a fill feature cache operation can be executed. Only one fill feature cache operation can be exxecuted at any one time.  
    Public MethodChangeVersion Change GeoDatabase version of layers and standalone tables of fromVersionBase. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodClearClipGeometry Clear the current map clip geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodClearElevationSurfaceLayers 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 MethodClearFeatureCacheAsyncOverloaded.   
    Public MethodClearSelection Clear the selection in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodExportBookmarks Export bookmarks from the active map or scene to a BKMX file. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodFillFeatureCacheAsyncOverloaded.   
    Public MethodFindAndReplaceWorkspacePath 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 MethodFindElevationSurfaceLayer Finds an elevation surface layer using a URI.  
    Public MethodFindLayer Finds a layer using a URI.  
    Public MethodFindLayers Finds layers by name.  
    Public MethodFindStandaloneTable Finds a StandaloneTable using a URI. Group layers within the map are also searched.  
    Public MethodFindStandaloneTables Finds StandaloneTables by name. Group layers within the map are also searched.  
    Public MethodGetAvailableElevationUnitFormats Gets the list of available elevation unit formats for the given scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetAvailableLocationUnitFormats 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 MethodGetBookmarks Returns the map's collection of bookmarks. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetCanEditMetadata Gets whether the Map metadata can be edited or not. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetClipGeometry Get the current map clipping geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetCustomFullExtent Returns the custom full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetDefaultExtent Returns the default full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetDefinition Returns the map definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetElementCount Gets the number of elements in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetElementStorageSize Gets the storage size of all the elements in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetElevationSurfaceLayers Gets the list of elevation surface layers for the map.  
    Public MethodGetElevationUnitFormat Gets the current scene elevation unit format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetGeneralPlacementProperties Returns the general label placement properties of the map. This method must be called on the MCT. Use QueuedTask.Run .  
    Public MethodGetGroundElevationSurfaceLayer Gets the ground elevation surface layer from the map.  
    Public MethodGetHighlightSelection Get the highlight selection for the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetLabelEngine Returns the label engine type of the map. This method must be called on the MCT. Use QueuedTask.Run .  
    Public MethodGetLayersAsFlattenedList Returns a read only flat list of layers where nested groups are not preserved.  
    Public MethodGetLocationUnitFormat Gets the current map location unit format for the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetMapPanes Get the collection of map panes for the map  
    Public MethodGetMetadata Gets the Map metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetSelection Get the selection for the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetSnapshot Gets a readonly snapshot of the layers  
    Public MethodGetStandaloneTablesAsFlattenedList Returns a read only flat list of StandaloneTables where nested groups are not preserved.  
    Public MethodGetZsFromSurfaceAsyncOverloaded.   
    Public MethodImportBookmarks 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 MethodMoveBookmark 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 MethodMoveLayerOverloaded.   
    Public MethodMoveStandaloneTableOverloaded.   
    Public MethodOpenViewAsync Open a new view for this map.  
    Public MethodRemoveBookmark Removes the bookmark from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveLayer Removes a specified layer from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveLayers Removes the specified layers from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveStandaloneTable Removes the specified StandaloneTable from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveStandaloneTables Removes the specified StandaloneTables from the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodReplaceDatasource 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 MethodSaveAsFile Saves the map as a mapx file. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSaveAsWebMapFile Save the current map to webmap file format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetAutoFillFeatureCache Sets the flag indicating if the feature cache is automatically filled for layers in the map.  
    Public MethodSetBasemapLayersOverloaded.   
    Public MethodSetClipGeometryOverloaded.   
    Public MethodSetCustomFullExtent Updates the custom full extent of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetDefinition Sets the map definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetElevationUnitFormat Sets the current scene elevation unit format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetGeneralPlacementProperties Updates the general label placement properties of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetLabelEngine Updates the label engine type of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetLocationUnitFormat Sets the current map location unit format for the current project. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetMetadata Sets the Map metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetName Updates the name of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetReferenceScale Updates the reference scale of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetSelection Set the selection in the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetSpatialReference Updates the spatial reference of the map. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodToString Returns the name of the map.  
    Top
    Protected Methods
     NameDescription
    Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    Extension Methods
     NameDescription
    Public Extension MethodAddDiagramLayer Add a diagram layer to a diagram map.
    Public Extension MethodAddDiagramLayerAsync Add a diagram layer to a diagram map.
    Public Extension MethodBuildMapTopologyGraphOverloaded. 
    Public Extension MethodCanClearTopology Gets if the active topology can be cleared. That is; the active topology cam be set to "No Topology".
    Public Extension MethodCanSetActiveTopologyOverloaded. 
    Public Extension MethodCanSetMapTopology Gets if the active topology can be set to a MapTopology. Map topologies are only supprted for 2D non-stereo maps.
    Public Extension MethodClearTopologyAsync Clears the active topology. That is; sets the active topology to "No Topology".
    Public Extension MethodComputeCombinedScaleFactor Compute the combined scale factor using two points and using a z elevation at the mid-point between them.
    Public Extension MethodGetActiveTopologyAsync Gets the active topology properties from the map.
    Public Extension MethodGetAvailableTopologiesAsync Gets the list of available topologies for the map. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodGetGroundToGridCorrection Gets the GroundToGridCorrection for the given map.
    Public Extension MethodGetTopologyAsync Gets the set of topology properties for the specified topology name.
    Public Extension MethodSetActiveTopologyAsyncOverloaded. 
    Public Extension MethodSetGroundToGridCorrection Sets the GroundToGridCorrection for the given map.
    Public Extension MethodSetMapTopologyAsync Sets the active topology to the map topolgoy.
    Top
    Public Events
     NameDescription
    Public EventPropertyChanged Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also

    Reference

    Map Class
    ArcGIS.Desktop.Mapping Namespace

     

     

    ©2023 Esri Inc., All Rights Reserved. Generated on Friday, February 17, 2023

    Send feedback