ShowElevationProfileGraph(MapPoint,MapPoint,Int32,ElevationProfileParameters) Method

In This Topic

Shows an elevation profile of the line calculated between and . Intermediate points are calculated at equal distances between the end points according to the specified. The calculation is performed according to the specified. The allows you to specify the elevation surface layer the calculation is performed against along with whether the generated elevation profile line is densified.

Syntax

C#
Visual Basic (Declaration)

public void ShowElevationProfileGraph( 
   MapPoint startPoint,
   MapPoint endPoint,
   int numPoints,
   ElevationProfileParameters profileParameters
)

Public Overloads Sub ShowElevationProfileGraph( _
   ByVal startPoint As MapPoint, _
   ByVal endPoint As MapPoint, _
   ByVal numPoints As Integer, _
   Optional ByVal profileParameters As ElevationProfileParameters _
)

Parameters

startPoint: The start point.
endPoint: The end point.
numPoints: The number of points required in the resulting polyline. Note this count includes the start and end points. There must be at least 10 points.
profileParameters: The set of profile parameters. If null, the default set of parameters is used.

Exceptions

Exception	Description
System.ArgumentNullException	startPoint or endPoint are null.
System.ArgumentException	startPoint or endPoint cannot be empty.
System.ArgumentException	numPoints cannot be smaller than 10.
System.ArgumentException	An elevation profile cannot be displayed on the current map.
System.ArgumentException	The specified profileParameters are invalid.
System.ArgumentException	The Map does not have a visible Ground Surface Layer.
System.ArgumentException	The Map does not have the specified surfaceLayer.

Remarks

Pass null for the if you want to use the default values; that is the Ground Surface layer is used to calculate the Z values and the generated elevation profile line is densified.

Use the ElevationProfileGraphAdded delegate to determine when the elevation profile graph is added to the mapView. Once this has occurred, MapView.GetElevationProfileGraph will return a non-null ElevationProfileGraph.

Example

Show Elevation profile graph between two points

int numPoints = 20;

if (!MapView.Active.CanShowElevationProfileGraph())
  return;

// show the elevation profile 
// use the default ground elevation surface
MapView.Active.ShowElevationProfileGraph(startPt, endPt, numPoints);

// find a specific elevation surface layer
var tinLayer = MapView.Active.Map.GetElevationSurfaceLayers().FirstOrDefault(l => l.Name == "TIN");

// set up the params
var elevProfileParams = new ElevationProfileParameters();
elevProfileParams.SurfaceLayer = tinLayer;
elevProfileParams.Densify = false;

// show the elevation profile using the params
MapView.Active.ShowElevationProfileGraph(startPt, endPt, numPoints, elevProfileParams);

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.5 or higher.

Reference

MapView Class
MapView Members
Overload List

Send feedback