Method FractionAlong
FractionAlong(Polyline, MapPoint, Double)
Finds the location on the line nearest the input point, expressed as the fraction along the line's total geodesic length, if the point is within the specified distance from the closest location on the line.
Declaration
public static double FractionAlong(this Polyline line, MapPoint point, double tolerance)
Parameters
Type | Name | Description |
---|---|---|
Polyline | line | The line to locate the point's distance along its length. |
MapPoint | point | The point to locate. |
System.Double | tolerance | The maximum distance that a point is allowed to be from the line, in the units of the SpatialReference. If the tolerance is any negative value, the fraction of the closest location on the line is always returned as long as the point lies between the two ends of the polyline. If the distance from the point to the closest location on the line is greater than the tolerance, or the tolerance is -1 and the point does not lie between the two ends of the polyline, System.Double.NaN is returned. |
Returns
Type | Description |
---|---|
System.Double | The length along the line nearest the input point, expressed as the fraction of the line's length between 0.0 and 1.0, or System.Double.NaN if the point is outside the tolerance. |
Remarks
Supports true curves.
Applies to
Platforms and versions
Target | Versions |
---|---|
.NET Standard 2.0 | 100.6 - 200.6 |
.NET | 100.13 - 200.6 |
.NET Windows | 100.13 - 200.6 |
.NET Android | 200.0 - 200.6 |
.NET iOS | 200.0 - 200.6 |
.NET Framework | 100.6 - 200.6 |
Xamarin.Android | 100.6 - 100.15 |
Xamarin.iOS | 100.6 - 100.15 |
UWP | 100.6 - 200.6 |