MapRouteFinder MapRouteFinder MapRouteFinder MapRouteFinder Class

Definition

Gets a route.

public : static class MapRouteFinderpublic static class MapRouteFinderPublic Static Class MapRouteFinder// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Your Universal Windows app must be authenticated before it can use the MapControl and map services in the Windows.Services.Maps namespace. To authenticate your app, you must specify a maps authentication key.

See Request a maps authentication key.

Methods

GetDrivingRouteAsync(Geopoint, Geopoint) GetDrivingRouteAsync(Geopoint, Geopoint) GetDrivingRouteAsync(Geopoint, Geopoint) GetDrivingRouteAsync(Geopoint, Geopoint)

Gets a driving route for the specified start and end coordinates.

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint)Public Static Function GetDrivingRouteAsync(startPoint As Geopoint, endPoint As Geopoint) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
startPoint
Geopoint Geopoint Geopoint Geopoint

The starting point of the driving route.

endPoint
Geopoint Geopoint Geopoint Geopoint

The ending point of the driving route.

Returns
See Also

GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteDrivingOptions) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteDrivingOptions) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteDrivingOptions) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteDrivingOptions)

Gets a driving route for the specified start and end coordinates (using MapRouteDrivingOptions ).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteDrivingOptions options)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteDrivingOptions options)Public Static Function GetDrivingRouteAsync(startPoint As Geopoint, endPoint As Geopoint, options As MapRouteDrivingOptions) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
startPoint
Geopoint Geopoint Geopoint Geopoint

The starting point of the driving route.

endPoint
Geopoint Geopoint Geopoint Geopoint

The ending point of the driving route.

options
MapRouteDrivingOptions MapRouteDrivingOptions MapRouteDrivingOptions MapRouteDrivingOptions

The advanced routing options to be applied to this route.

Returns
See Also

GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization)

Gets a driving route for the specified start and end coordinates (using optimizations).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteOptimization optimization)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteOptimization optimization)Public Static Function GetDrivingRouteAsync(startPoint As Geopoint, endPoint As Geopoint, optimization As MapRouteOptimization) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
startPoint
Geopoint Geopoint Geopoint Geopoint

The starting point of the driving route.

endPoint
Geopoint Geopoint Geopoint Geopoint

The ending point of the driving route.

optimization
MapRouteOptimization MapRouteOptimization MapRouteOptimization MapRouteOptimization

The optimizations to apply when calculating the driving route.

Returns
See Also

GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions)

Gets a driving route for the specified start and end coordinates (using optimizations and restrictions).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteOptimization optimization, MapRouteRestrictions restrictions)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteOptimization optimization, MapRouteRestrictions restrictions)Public Static Function GetDrivingRouteAsync(startPoint As Geopoint, endPoint As Geopoint, optimization As MapRouteOptimization, restrictions As MapRouteRestrictions) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
startPoint
Geopoint Geopoint Geopoint Geopoint

The starting point of the driving route.

endPoint
Geopoint Geopoint Geopoint Geopoint

The ending point of the driving route.

optimization
MapRouteOptimization MapRouteOptimization MapRouteOptimization MapRouteOptimization

The optimizations to apply when calculating the driving route.

restrictions
MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions

The restrictions to apply when calculating the driving route.

Returns
See Also

GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions, Double) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions, Double) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions, Double) GetDrivingRouteAsync(Geopoint, Geopoint, MapRouteOptimization, MapRouteRestrictions, Double)

Gets a driving route for the specified start and end coordinates (using optimizations, restrictions, and heading).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteOptimization optimization, MapRouteRestrictions restrictions, double headingInDegrees)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteAsync(Geopoint startPoint, Geopoint endPoint, MapRouteOptimization optimization, MapRouteRestrictions restrictions, Double headingInDegrees)Public Static Function GetDrivingRouteAsync(startPoint As Geopoint, endPoint As Geopoint, optimization As MapRouteOptimization, restrictions As MapRouteRestrictions, headingInDegrees As Double) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
startPoint
Geopoint Geopoint Geopoint Geopoint

The starting point of the driving route.

endPoint
Geopoint Geopoint Geopoint Geopoint

The ending point of the driving route.

optimization
MapRouteOptimization MapRouteOptimization MapRouteOptimization MapRouteOptimization

The optimizations to apply when calculating the driving route.

restrictions
MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions

The restrictions to apply when calculating the driving route.

headingInDegrees
double Double Double Double

The preferred start direction from the current location for the driving route.

Returns
See Also

GetDrivingRouteFromEnhancedWaypointsAsync(IIterable) GetDrivingRouteFromEnhancedWaypointsAsync(IIterable) GetDrivingRouteFromEnhancedWaypointsAsync(IIterable) GetDrivingRouteFromEnhancedWaypointsAsync(IIterable)

Gets a driving route for the specified waypoints (using optimizations).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromEnhancedWaypointsAsync(IIterable<EnhancedWaypoint> waypoints)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromEnhancedWaypointsAsync(IEnumerable<EnhancedWaypoint> waypoints)Public Static Function GetDrivingRouteFromEnhancedWaypointsAsync(waypoints As IEnumerable<EnhancedWaypoint>) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
waypoints
IIterable<EnhancedWaypoint> IEnumerable<EnhancedWaypoint> IEnumerable<EnhancedWaypoint> IEnumerable<EnhancedWaypoint>

A collection of stop, start, or intermediate waypoint that a route must pass through.

Returns
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

GetDrivingRouteFromEnhancedWaypointsAsync(IIterable, MapRouteDrivingOptions) GetDrivingRouteFromEnhancedWaypointsAsync(IIterable, MapRouteDrivingOptions) GetDrivingRouteFromEnhancedWaypointsAsync(IIterable, MapRouteDrivingOptions) GetDrivingRouteFromEnhancedWaypointsAsync(IIterable, MapRouteDrivingOptions)

Gets a driving route for the specified waypoints (using optimizations).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromEnhancedWaypointsAsync(IIterable<EnhancedWaypoint> waypoints, MapRouteDrivingOptions options)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromEnhancedWaypointsAsync(IEnumerable<EnhancedWaypoint> waypoints, MapRouteDrivingOptions options)Public Static Function GetDrivingRouteFromEnhancedWaypointsAsync(waypoints As IEnumerable<EnhancedWaypoint>, options As MapRouteDrivingOptions) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
waypoints
IIterable<EnhancedWaypoint> IEnumerable<EnhancedWaypoint> IEnumerable<EnhancedWaypoint> IEnumerable<EnhancedWaypoint>

A collection of stop, start, or intermediate waypoint that a route must pass through.

options
MapRouteDrivingOptions MapRouteDrivingOptions MapRouteDrivingOptions MapRouteDrivingOptions

The advanced routing options to be applied to this route.

Returns
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

GetDrivingRouteFromWaypointsAsync(IIterable) GetDrivingRouteFromWaypointsAsync(IIterable) GetDrivingRouteFromWaypointsAsync(IIterable) GetDrivingRouteFromWaypointsAsync(IIterable)

Gets a driving route for the specified waypoints (using optimizations).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IIterable<Geopoint> wayPoints)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IEnumerable<Geopoint> wayPoints)Public Static Function GetDrivingRouteFromWaypointsAsync(wayPoints As IEnumerable<Geopoint>) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
wayPoints
IIterable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint>

The start and end coordinates and optional waypoints of the driving route.

Returns
See Also

GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization)

Gets a driving route for the specified waypoints.

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IIterable<Geopoint> wayPoints, MapRouteOptimization optimization)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IEnumerable<Geopoint> wayPoints, MapRouteOptimization optimization)Public Static Function GetDrivingRouteFromWaypointsAsync(wayPoints As IEnumerable<Geopoint>, optimization As MapRouteOptimization) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
wayPoints
IIterable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint>

The start and end coordinates and optional waypoints of the driving route.

optimization
MapRouteOptimization MapRouteOptimization MapRouteOptimization MapRouteOptimization

The optimizations to apply when calculating the driving route.

Returns
See Also

GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions)

Gets a driving route for the specified waypoints (using optimizations and restrictions).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IIterable<Geopoint> wayPoints, MapRouteOptimization optimization, MapRouteRestrictions restrictions)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IEnumerable<Geopoint> wayPoints, MapRouteOptimization optimization, MapRouteRestrictions restrictions)Public Static Function GetDrivingRouteFromWaypointsAsync(wayPoints As IEnumerable<Geopoint>, optimization As MapRouteOptimization, restrictions As MapRouteRestrictions) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
wayPoints
IIterable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint>

The start and end coordinates and optional waypoints of the driving route.

optimization
MapRouteOptimization MapRouteOptimization MapRouteOptimization MapRouteOptimization

The optimizations to apply when calculating the driving route.

restrictions
MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions

The restrictions to apply when calculating the driving route.

Returns
See Also

GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions, Double) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions, Double) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions, Double) GetDrivingRouteFromWaypointsAsync(IIterable, MapRouteOptimization, MapRouteRestrictions, Double)

Gets a driving route for the specified waypoints (using optimizations, restrictions, and heading).

public : static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IIterable<Geopoint> wayPoints, MapRouteOptimization optimization, MapRouteRestrictions restrictions, double headingInDegrees)public static IAsyncOperation<MapRouteFinderResult> GetDrivingRouteFromWaypointsAsync(IEnumerable<Geopoint> wayPoints, MapRouteOptimization optimization, MapRouteRestrictions restrictions, Double headingInDegrees)Public Static Function GetDrivingRouteFromWaypointsAsync(wayPoints As IEnumerable<Geopoint>, optimization As MapRouteOptimization, restrictions As MapRouteRestrictions, headingInDegrees As Double) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
wayPoints
IIterable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint>

The start and end coordinates and optional waypoints of the driving route.

optimization
MapRouteOptimization MapRouteOptimization MapRouteOptimization MapRouteOptimization

The optimizations to apply when calculating the driving route.

restrictions
MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions MapRouteRestrictions

The restrictions to apply when calculating the driving route.

headingInDegrees
double Double Double Double

The preferred start direction from the current location for the driving route.

Returns
See Also

GetWalkingRouteAsync(Geopoint, Geopoint) GetWalkingRouteAsync(Geopoint, Geopoint) GetWalkingRouteAsync(Geopoint, Geopoint) GetWalkingRouteAsync(Geopoint, Geopoint)

Gets a walking route using the specified start and end coordinates.

public : static IAsyncOperation<MapRouteFinderResult> GetWalkingRouteAsync(Geopoint startPoint, Geopoint endPoint)public static IAsyncOperation<MapRouteFinderResult> GetWalkingRouteAsync(Geopoint startPoint, Geopoint endPoint)Public Static Function GetWalkingRouteAsync(startPoint As Geopoint, endPoint As Geopoint) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
startPoint
Geopoint Geopoint Geopoint Geopoint

The starting point of the walking route.

endPoint
Geopoint Geopoint Geopoint Geopoint

The ending point of the walking route.

Returns
See Also

GetWalkingRouteFromWaypointsAsync(IIterable) GetWalkingRouteFromWaypointsAsync(IIterable) GetWalkingRouteFromWaypointsAsync(IIterable) GetWalkingRouteFromWaypointsAsync(IIterable)

Gets a walking route using the specified waypoints.

public : static IAsyncOperation<MapRouteFinderResult> GetWalkingRouteFromWaypointsAsync(IIterable<Geopoint> wayPoints)public static IAsyncOperation<MapRouteFinderResult> GetWalkingRouteFromWaypointsAsync(IEnumerable<Geopoint> wayPoints)Public Static Function GetWalkingRouteFromWaypointsAsync(wayPoints As IEnumerable<Geopoint>) As IAsyncOperation( Of MapRouteFinderResult )// This API is not available in Javascript.
Parameters
wayPoints
IIterable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint> IEnumerable<Geopoint>

The start and end coordinates and optional waypoints of the walking route.

Returns
See Also

See Also