AddOverlayAsync(CIMGraphic,Double,Double) Method

In This Topic

Add an overlay graphic to the map view.

Syntax

C#
Visual Basic (Declaration)

protected Task<IDisposable> AddOverlayAsync( 
   CIMGraphic graphic,
   double referenceScale,
   double showThrough
)

Protected Overloads Function AddOverlayAsync( _
   ByVal graphic As CIMGraphic, _
   ByVal referenceScale As Double, _
   ByVal showThrough As Double _
) As Task(Of IDisposable)

Parameters

graphic: The graphic to be added to the overlay.
referenceScale: Map reference scale or -1
showThrough: Visibility factor for showing the overlay through other objects when obscured in 3D.
Valid range is [0..1], any other value will be treated as 0 (not visible).

Return Value

An object that when disposed will remove the overlay.

Remarks

When the tool is deactivated all overlay graphics will be removed.When the referenceScale is not equal to -1, the overlay will be created in real world units relative to the provided map reference scale (referenceScale). Otherwise, the overlay will be created in units of points. This is only supported in 2D.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

MapTool Class
MapTool Members
Overload List

Send feedback