GetElevationProfileFromSurfaceAsync(MapPoint,MapPoint,Int32,ElevationSurfaceLayer,SurfaceZsMissingHandler,CancellationToken) 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 specified Elevation Surface Layer.

Syntax

C#
Visual Basic (Declaration)

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

Public Overloads Function GetElevationProfileFromSurfaceAsync( _
   ByVal startPoint As MapPoint, _
   ByVal endPoint As MapPoint, _
   ByVal numPoints As Integer, _
   ByVal surfaceLayer As ElevationSurfaceLayer, _
   ByVal missingHandler As SurfaceZsMissingHandler, _
   ByVal cancellationToken As CancellationToken _
) 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.
missingHandler: provides options to handle missing Zs in the surface
cancellationToken: provides a way to cancel the operation

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.

Remarks

The missingHandler will be used to determine what to do if the surface has no data at a particular input geometry point. The corresponding output geometry point or vertex Z will be set to the value specified in the provided missingHandler.OutputZ property. The missingHandler.OnlyProcessMissingZs parameter can be used to overwrite all Z values or only those that are designated as missing based on a comparison with the InputZ value.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

Map Class
Map Members
Overload List

Send feedback