AddOverlayAsync(IEnumerable<CIMGraphic>,Double) Method

In This Topic

Add a set of overlay graphics to the map view.

Syntax

C#
Visual Basic (Declaration)

protected Task<IDisposable> AddOverlayAsync( 
   IEnumerable<CIMGraphic> graphics,
   double referenceScale
)

Protected Overloads Function AddOverlayAsync( _
   ByVal graphics As IEnumerable(Of CIMGraphic), _
   Optional ByVal referenceScale As Double _
) As Task(Of IDisposable)

Parameters

graphics: The graphics to be added to the overlay.
referenceScale: Map reference scale or -1

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.5 or higher.

Reference

MapTool Class
MapTool Members
Overload List

Send feedback