ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / MappingExtensions Class / AddOverlay Method / AddOverlay(MapView,CIMGraphic,Double) Method
The view to add the overlay.
The graphic to be added to the overlay.
Map reference scale or -1
Example

In This Topic
    AddOverlay(MapView,CIMGraphic,Double) Method
    In This Topic
    Add an overlay graphic to the map view.
    Syntax
    Public Overloads Shared Function AddOverlay( _
       ByVal mapView As MapView, _
       ByVal graphic As CIMGraphic, _
       Optional ByVal referenceScale As Double _
    ) As IDisposable

    Parameters

    mapView
    The view to add the overlay.
    graphic
    The graphic 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 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.
    Example
    Graphic Overlay
    {
      // get the current MapView and point
      var myextent = mapView.Extent;
      var point = myextent.Center;
      IDisposable _graphic = null;
    
      // add point graphic to the overlay at the center of the mapView
      // Note: Needs QueuedTask to run
      _graphic = mapView.AddOverlay(point,
          SymbolFactory.Instance.ConstructPointSymbol(
                  ColorFactory.Instance.RedRGB, 30.0, SimpleMarkerStyle.Star).MakeSymbolReference());
    
      // update the overlay with new point graphic symbol
      MessageBox.Show("Now to update the overlay...");
      // Note: Needs QueuedTask to run
      {
        mapView.UpdateOverlay(_graphic, point, SymbolFactory.Instance.ConstructPointSymbol(
                                      ColorFactory.Instance.BlueRGB, 20.0, SimpleMarkerStyle.Circle).MakeSymbolReference());
      }
    
      // clear the overlay display by disposing of the graphic
      MessageBox.Show("Now to clear the overlay...");
      _graphic.Dispose();
    }
    Graphic Overlay with CIMPictureGraphic
    {
      // Use SourceURL for the URL to the image content. For
      // a local file, use a file path. For a web/internet file
      // location, use its URL
      //
      // Supported image types are:
      // png, jpg, tiff, bmp, gif, svg
    
      var pictureGraphic = new CIMPictureGraphic
      {
        SourceURL = @"C:\Images\MyImage.png",
        Shape = envelope
      };
    
      IDisposable _graphic = mapView.AddOverlay(pictureGraphic);
    }
    Add overlay graphic with text
    {
      IDisposable _graphic = null;
    
      //define the text symbol
      var textSymbol = new CIMTextSymbol();
      //define the text graphic
      var textGraphic = new CIMTextGraphic();
    
      // Note: Needs QueuedTask to run
      {
        //Create a simple text symbol
        textSymbol = SymbolFactory.Instance.ConstructTextSymbol(ColorFactory.Instance.BlackRGB, 8.5, "Corbel", "Regular");
        //Sets the geometry of the text graphic
        textGraphic.Shape = geometry;
        //Sets the text string to use in the text graphic
        textGraphic.Text = "This is my line";
        //Sets symbol to use to draw the text graphic
        textGraphic.Symbol = textSymbol.MakeSymbolReference();
        //Draw the overlay text graphic
        _graphic = MapView.Active.AddOverlay(textGraphic);
      }
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also