GetElevationProfileFromSurface(MapPoint,MapPoint,Int32) 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. The Z values of the calculated polyline are populated from the Ground Surface Layer. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function GetElevationProfileFromSurface( _
   ByVal startPoint As MapPoint, _
   ByVal endPoint As MapPoint, _
   ByVal numPoints As Integer _
) As ElevationProfileResult

public ElevationProfileResult GetElevationProfileFromSurface( 
   MapPoint startPoint,
   MapPoint endPoint,
   int numPoints
)

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.

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 a visible Ground Surface Layer.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

Interpolate a line between two points and calculate the elevation profile

{
    int numPoints = 20;//Or any number of points you want to interpolate
                       // use a specific elevation surface
    var eleLayer = MapView.Active.Map.GetElevationSurfaceLayers().FirstOrDefault(l => l.Name == "TIN");
    // use the default ground elevation surface
    MapPoint startPt = MapPointBuilderEx.CreateMapPoint(-130, 20, SpatialReferences.WGS84);

    MapPoint endPt = MapPointBuilderEx.CreateMapPoint(-100, 50, SpatialReferences.WGS84);
    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
    result = await MapView.Active.Map.GetElevationProfileFromSurfaceAsync(startPt, endPt, numPoints, eleLayer);
    if (result.Status == SurfaceZsResultStatus.Ok)
    {
        var polylineZ = result.Polyline;

        // process the polylineZ
    }
}

Show Elevation profile graph using an ElevationProfileResult

{
    MapPoint startPt = MapPointBuilderEx.CreateMapPoint(-130, 20, SpatialReferences.WGS84);
    MapPoint endPt = MapPointBuilderEx.CreateMapPoint(-100, 50, SpatialReferences.WGS84);
    var elevProfileResult = await MapView.Active.Map.GetElevationProfileFromSurfaceAsync(startPt, endPt, 10);
    if (elevProfileResult.Status != SurfaceZsResultStatus.Ok)
        return;

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

    // show the elevation profile using the result
    MapView.Active.ShowElevationProfileGraph(elevProfileResult);
}

Requirements

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

ArcGIS Pro version: 3.4 or higher.

Reference

Map Class
Map Members
Overload List

Send feedback