UpdateOverlay(IDisposable,CIMGraphic,Double,Double) Method

In This Topic

Updates the graphic for an overlay graphic on the map view.

Syntax

C#
Visual Basic (Declaration)

protected bool UpdateOverlay( 
   IDisposable overlay,
   CIMGraphic graphic,
   double referenceScale,
   double showThrough
)

Protected Overloads Function UpdateOverlay( _
   ByVal overlay As IDisposable, _
   ByVal graphic As CIMGraphic, _
   Optional ByVal referenceScale As Double, _
   Optional ByVal showThrough As Double _
) As Boolean

Parameters

overlay: The IDisposable instance returned from an AddOverlay method call.
graphic: The graphic to be used for the update
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

True if the overlay was updated. False otherwise.

Remarks

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

Reference

MapTool Class
MapTool Members
Overload List

Send feedback