GuidanceRoute GuidanceRoute GuidanceRoute GuidanceRoute Class

Definition

Represents a route for which navigational guidance is provided.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : sealed class GuidanceRoute : IGuidanceRoutepublic sealed class GuidanceRoute : IGuidanceRoutePublic NotInheritable Class GuidanceRoute Implements IGuidanceRoute// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0) Windows Mobile Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced v1)

Properties

BoundingBox BoundingBox BoundingBox BoundingBox

Gets the geographic area that contains the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : GeoboundingBox BoundingBox { get; }public GeoboundingBox BoundingBox { get; }Public ReadOnly Property BoundingBox As GeoboundingBox// This API is not available in Javascript.
Value
GeoboundingBox GeoboundingBox GeoboundingBox GeoboundingBox

The geographic area that contains the route.

Distance Distance Distance Distance

Gets the total distance of the route in meters.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : int Distance { get; }public int Distance { get; }Public ReadOnly Property Distance As int// This API is not available in Javascript.
Value
int int int int

The total distance of the route in meters.

Duration Duration Duration Duration

Gets the estimated travel time of the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : TimeSpan Duration { get; }public TimeSpan Duration { get; }Public ReadOnly Property Duration As TimeSpan// This API is not available in Javascript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The estimated travel time of the route.

Maneuvers Maneuvers Maneuvers Maneuvers

Gets a list of maneuvers required to navigate the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : IVectorView<GuidanceManeuver> Maneuvers { get; }public IReadOnlyList<GuidanceManeuver> Maneuvers { get; }Public ReadOnly Property Maneuvers As IReadOnlyList<GuidanceManeuver>// This API is not available in Javascript.
Value
IVectorView<GuidanceManeuver> IReadOnlyList<GuidanceManeuver> IReadOnlyList<GuidanceManeuver> IReadOnlyList<GuidanceManeuver>

The maneuvers required to navigate the route.

Path Path Path Path

Gets an ordered series of geographic points along the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : Geopath Path { get; }public Geopath Path { get; }Public ReadOnly Property Path As Geopath// This API is not available in Javascript.
Value
Geopath Geopath Geopath Geopath

An ordered series of geographic points along the route.

RoadSegments RoadSegments RoadSegments RoadSegments

Gets a list of road segments, ordered from start to finish, that make up the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : IVectorView<GuidanceRoadSegment> RoadSegments { get; }public IReadOnlyList<GuidanceRoadSegment> RoadSegments { get; }Public ReadOnly Property RoadSegments As IReadOnlyList<GuidanceRoadSegment>// This API is not available in Javascript.
Value
IVectorView<GuidanceRoadSegment> IReadOnlyList<GuidanceRoadSegment> IReadOnlyList<GuidanceRoadSegment> IReadOnlyList<GuidanceRoadSegment>

A list of road segments, ordered from start to finish, that make up the route.

Methods

CanCreateFromMapRoute(MapRoute) CanCreateFromMapRoute(MapRoute) CanCreateFromMapRoute(MapRoute) CanCreateFromMapRoute(MapRoute)

Checks if the specified MapRoute object can be converted to a GuidanceRoute object.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : static PlatForm::Boolean CanCreateFromMapRoute(MapRoute mapRoute)public static bool CanCreateFromMapRoute(MapRoute mapRoute)Public Static Function CanCreateFromMapRoute(mapRoute As MapRoute) As bool// This API is not available in Javascript.
Parameters
mapRoute
MapRoute MapRoute MapRoute MapRoute

The potential route to be navigated.

Returns
PlatForm::Boolean bool bool bool

true if a GuidanceRoute object can be created; otherwise, false.

ConvertToMapRoute() ConvertToMapRoute() ConvertToMapRoute() ConvertToMapRoute()

Creates a MapRoute object that's based on the current GuidanceRoute.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : MapRoute ConvertToMapRoute()public MapRoute ConvertToMapRoute()Public Function ConvertToMapRoute() As MapRoute// This API is not available in Javascript.
Returns

A MapRoute object that's based on the current GuidanceRoute object.

TryCreateFromMapRoute(MapRoute) TryCreateFromMapRoute(MapRoute) TryCreateFromMapRoute(MapRoute) TryCreateFromMapRoute(MapRoute)

Creates a GuidanceRoute object that's based on the specified MapRoute.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public : static GuidanceRoute TryCreateFromMapRoute(MapRoute mapRoute)public static GuidanceRoute TryCreateFromMapRoute(MapRoute mapRoute)Public Static Function TryCreateFromMapRoute(mapRoute As MapRoute) As GuidanceRoute// This API is not available in Javascript.
Parameters
mapRoute
MapRoute MapRoute MapRoute MapRoute

The potential route to be navigated.

Returns

A GuidanceRoute object that's based on the specified MapRoute object; otherwise, if the mapRoute cannot be converted, null.