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


In This Topic
    MapView Class Members
    In This Topic

    The following tables list the members exposed by MapView.

    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic)Active Gets the active map view. Returns null if there is no active map view.  
    Public PropertyActiveRangeName Gets the name of the active range definition in the map view.  
    Public PropertyAnimation Gets the animation for the view.  
    Public PropertyCamera Gets the current Camera of the view.  
    Public PropertyCanPrint Gets whether the mapview can be printed  
    Public PropertyDrawingPaused Gets or sets the paused state on the map view.  
    Public PropertyExtent Gets the current extent of the view.  
    Public PropertyFieldOfView Gets the field of view angle of the scene view.  
    Public PropertyFloorFilter Gets or sets the floor filter settings which determine which floor-aware data is visible in the map view.  
    Public PropertyIsReadyGets a value that indicates whether the MapView can be accessed. This property is false while the map view processes major operations like initializing or when a 3D view changes between SceneLocal and SceneGlobal.  
    Public Propertystatic (Shared in Visual Basic)LinkMode Gets or sets the method used to link views.  
    Public PropertyLocatorManager Gets the locator manager attached to this mapview.  
    Public PropertyLookAtCamera Gets the current look at Camera of the view.  
    Public PropertyMap Gets the map or scene associated with the view.  
    Public PropertyRange Gets or sets the range extent visible in the map view.  
    Public PropertyRangeNames Gets the range names defined on layers in the map view.  
    Public PropertySceneDrawingMode Gets the current drawing mode of the scene view.  
    Public PropertyTime Gets or sets the time range visible in the map view.  
    Public PropertyViewingMode Gets the perspective of the view.  
    Top
    Public Methods
     NameDescription
    Public MethodAddExploratoryAnalysisAsync An asynchronous function to add an ExploratoryAnalysisBase subclass instance to the MapView. Calling this method activates the Exploratory Analysis object and presents it on the view.  
    Public MethodAddOverlayControl Add a control over the view.  
    Public MethodCancelDrawing Stop the current drawing of the MapView.  
    Public MethodCanSetViewingModeGets a value indicating if the view can be changed to the provided ArcGIS.Core.CIM.MapViewingMode.  
    Public MethodCaptureThumbnail Capture a bitmap of the MapView content.  
    Public MethodClearTOCSelection Clears the selection from the TOC.  
    Public MethodClientToMap Converts a point in client coordinates relative to the top-left corner of the view to a point in the coordinates of the map or scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodClientToScreen Converts a screen point to a point in client coordinates relative to the top-left corner of the view.  
    Public MethodCloseActivePopup Closes the active popup window. You must be on the UI thread to call this function  
    Public MethodClosePopupsOverloaded.   
    Public MethodExportOverloaded.   
    Public MethodFlashFeatureOverloaded.   
    Public MethodGetCameraEffect Returns the CIMCameraEffect object for the active 3D View.  
    Public MethodGetExploratoryAnalysisCollection Get a list of the Exploratory Analysis objects that exist for this MapView. You can check each object's type to identify which subclass it is.  
    Public MethodGetFeatures Return features that intersect a geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetFeaturesEx Return features that intersect a geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetOverlayControls Get all the current overlay controls.  
    Public MethodGetPostprocessingEffects Returns an array of active CIMPostprocessingEffect objects for the active 3D View.  
    Public MethodGetSelectedDataSourceMember Returns the selected DataSourceMember.  
    Public MethodGetSelectedElevationSourceLayers Returns the collection of elevation source layers selected in the TOC.  
    Public MethodGetSelectedElevationSurfaceLayers Returns the collection of elevation surface layers selected in the TOC.  
    Public MethodGetSelectedIsosurfaces Returns the collection of voxel isosurfaces selected in the TOC.  
    Public MethodGetSelectedLayers Returns the collection of layers selected in the TOC.  
    Public MethodGetSelectedLegendClasses Returns the collection of legend classes selected in the TOC.  
    Public MethodGetSelectedLockedSections Returns the collection of voxel locked sections selected in the TOC.  
    Public MethodGetSelectedSections Returns the collection of voxel sections selected in the TOC.  
    Public MethodGetSelectedSlices Returns the collection of voxel slices selected in the TOC.  
    Public MethodGetSelectedStandaloneTables Returns the collection of tables selected in the TOC.  
    Public MethodGetViewSize Returns the current size of the view.  
    Public MethodGetVisualEffect Returns the CIMVisualEffect object for the active 3D View.  
    Public MethodHasNextCamera Indicates whether the map view has a next camera position.  
    Public MethodHasPreviousCamera Indicates whether the map view has a previous camera position.  
    Public MethodInvalidateOverloaded.   
    Public MethodLookAt Center the view at a given point. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodLookAtAsync Center the view at a given point.  
    Public MethodMapToClient Converts a point in the coordinates of the map or scene to a point in client coordinates relative to the top-left corner of the view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodMapToScreen Converts a point in the coordinates of the map or scene to a point in screen coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodNextCamera Go to the next camera position. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodNextCameraAsync Go to the next camera position.  
    Public MethodPanToOverloaded.   
    Public MethodPanToAsyncOverloaded.   
    Public MethodPanToSelected Pan the view to the extent of the selected features in the map or scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodPanToSelectedAsync Pan the view to the extent of the selected features in the map or scene.  
    Public MethodPreviousCamera Go to the previous camera position. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodPreviousCameraAsync Go to the previous camera position.  
    Public MethodPrintOverloaded.   
    Public MethodRedraw Force a redraw of the map view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRedrawAsync Force a redraw of the map view  
    Public MethodRemoveExploratoryAnalysisAsync Removes the provided ExploratoryAnalysisBase instance from the MapView. It will no longer be tracked or drawn in the view. The parameter provided should be destroyed after it has been removed to avoid errors or confusion.  
    Public MethodRemoveOverlayControl Remove a control from over the view.  
    Public MethodScreenToClient Converts a point in client coordinates relative to the top-left corner of the view to a screen point.  
    Public MethodScreenToMap Converts a point in screen coordinates to a point in the coordinates of the map or scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectDataSourceMember Selects the DataSourceMember in the TOC.  
    Public MethodSelectElements Select elements that visually intersect a geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectElevationSourceLayers Selects elevation source layers in the TOC.  
    Public MethodSelectElevationSurfaceLayers Selects elevation surface layers in the TOC.  
    Public MethodSelectFeatures Select features that intersect a geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectFeaturesEx Select features that intersect a geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectLayers Selects layers in the TOC.  
    Public MethodSelectLegendClasses Selects legend classes in the TOC.  
    Public MethodSelectStandaloneTables Selects standalone tables in the TOC.  
    Public MethodSelectVoxelIsosurface Selects the voxel isosurface in the TOC.  
    Public MethodSelectVoxelLockedSection Selects the voxel locked section in the TOC.  
    Public MethodSelectVoxelSection Selects the voxel section in the TOC.  
    Public MethodSelectVoxelSlice Selects the voxel slice in the TOC.  
    Public MethodSetActiveRangeName Sets the active range name for the map view.  
    Public MethodSetCameraEffect Sets the Camera Effect for the active 3D View. Only works on 3D Views.  
    Public MethodSetFieldOfView Sets the field of view angle of the scene view.  
    Public MethodSetPostprocessingEffects Set the Postprocessing Effects for the active 3D View. Only works on 3D Views. Can set multiple effects simultaneously by adding them to the array being passed in.  
    Public MethodSetSceneDrawingMode Sets the perspective of the scene view.  
    Public MethodSetViewingMode Set the perspective of the map view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetViewingModeAsync Set the perspective of the map view..  
    Public MethodSetVisualEffect Sets the Visual Effect for the active 3D View. Only works on 3D Views.  
    Public MethodShowCustomPopupOverloaded.   
    Public MethodShowPopupOverloaded.   
    Public MethodZoomInFixed Zoom the Camera in by a fixed amount. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomInFixedAsync Zoom the Camera in by a fixed amount.  
    Public MethodZoomOutFixed Zoom the Camera out by a fixed amount. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomOutFixedAsync Zoom the Camera out by a fixed amount.  
    Public MethodZoomToOverloaded.   
    Public MethodZoomToAsyncOverloaded.   
    Public MethodZoomToFullExtent Zoom the view to the full extent of the map or scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToFullExtentAsync Zoom the view to the full extent of the map or scene.  
    Public MethodZoomToSelected Zoom the view to the extent of the selected features in the map or scene. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToSelectedAsync Zoom the view to the extent of the selected features in the map or scene.  
    Top
    Extension Methods
     NameDescription
    Public Extension MethodAddOverlayOverloaded. 
    Public Extension MethodAddOverlayAsyncOverloaded. 
    Public Extension MethodBuildMapTopologyGraphOverloaded. 
    Public Extension MethodClearSketchAsync Clears the current sketch in the view.
    Public Extension MethodGetCurrentSketchAsync Gets the current geometry of the sketch without finishing it.
    Public Extension MethodGetSketchType Gets the type of geometry for the current sketch.
    Public Extension MethodSelectElementsOverloaded. 
    Public Extension MethodSetCurrentSketchAsync Sets the current geometry of the sketch without finishing it.
    Public Extension MethodUpdateOverlayOverloaded. 
    Top
    Public Events
     NameDescription
    Public EventViewSizeChangedOccurs when the view size changed. Use GetViewSize to get the size.  
    Top
    See Also

    Reference

    MapView Class
    ArcGIS.Desktop.Mapping Namespace

     

     

    ©2023 Esri Inc., All Rights Reserved. Generated on Wednesday, October 25, 2023

    Send feedback