ArcGIS Pro 3.1 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / MapTool Class / AddOverlayAsync Method / AddOverlayAsync(Geometry,CIMSymbolReference,Double) Method
The geometry of the overlay.
The symbol to use for the overlay.
Map reference scale or -1

In This Topic
    AddOverlayAsync(Geometry,CIMSymbolReference,Double) Method
    In This Topic
    Add an overlay graphic to the map view.
    Syntax
    Protected Overloads Function AddOverlayAsync( _
       ByVal geometry As Geometry, _
       Optional ByVal symbol As CIMSymbolReference, _
       Optional ByVal referenceScale As Double _
    ) As Task(Of IDisposable)

    Parameters

    geometry
    The geometry of the overlay.
    symbol
    The symbol to use for 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.0 or higher.
    See Also