GetElevationProfileFromSurfaceAsync(MapPoint,MapPoint,Int32,ElevationSurfaceLayer) Method

In This Topic

Gets an elevation profile calculated between and . Intermediate points are calculated at equal distances between the end points according to the specified. All Z values of the calculated polyline are populated from the Ground Surface Layer.

Syntax

C#
Visual Basic (Declaration)

public Task<ElevationProfileResult> GetElevationProfileFromSurfaceAsync( 
   MapPoint startPoint,
   MapPoint endPoint,
   int numPoints,
   ElevationSurfaceLayer surfaceLayer
)

Public Overloads Function GetElevationProfileFromSurfaceAsync( _
   ByVal startPoint As MapPoint, _
   ByVal endPoint As MapPoint, _
   ByVal numPoints As Integer, _
   ByVal surfaceLayer As ElevationSurfaceLayer _
) As Task(Of ElevationProfileResult)

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.
surfaceLayer: Identifies the surface to be used. If null is specified, then the default Ground Surface will be used.

Return Value

An ElevationProfileResult. If successful, this contains the generated polyline.

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	This Map does not have the specified surfaceLayer.
System.ArgumentException	This Map does not have a visible Ground Surface Layer.

Example

Interpolate a line between two points and calculate the elevation profile

int numPoints = 20;

// use the default ground elevation surface
var result = await MapView.Active.Map.GetElevationProfileFromSurfaceAsync(startPt, endPt, numPoints);
if (result.Status == SurfaceZsResultStatus.Ok)
{
  var polylineZ = result.Polyline;

  // process the polylineZ
}

// use a specific elevation surface
var eleLayer = MapView.Active.Map.GetElevationSurfaceLayers().FirstOrDefault(l => l.Name == "TIN");
result = await MapView.Active.Map.GetElevationProfileFromSurfaceAsync(startPt, endPt, numPoints, eleLayer);
if (result.Status == SurfaceZsResultStatus.Ok)
{
  var polylineZ = result.Polyline;

  // process the polylineZ
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

Map Class
Map Members
Overload List

Send feedback