GuidanceUpdatedEventArgs GuidanceUpdatedEventArgs GuidanceUpdatedEventArgs GuidanceUpdatedEventArgs Class

Definition

Provides data for the GuidanceUpdated event.

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 GuidanceUpdatedEventArgs : IGuidanceUpdatedEventArgspublic sealed class GuidanceUpdatedEventArgs : IGuidanceUpdatedEventArgsPublic NotInheritable Class GuidanceUpdatedEventArgs Implements IGuidanceUpdatedEventArgs// 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)

Remarks

During a guidance update, the geographic location returned by GuidanceUpdatedEventArgs corresponds to the nearest point on the route near the user's actual geographic location. This helps compensate for GPS inaccuracies. If the route is not nearby, a point on the nearest road will be used. For example, if the user misses a turn.

Properties

AfterNextManeuver AfterNextManeuver AfterNextManeuver AfterNextManeuver

Gets the maneuver that follows NextManeuver.

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 : GuidanceManeuver AfterNextManeuver { get; }public GuidanceManeuver AfterNextManeuver { get; }Public ReadOnly Property AfterNextManeuver As GuidanceManeuver// This API is not available in Javascript.

AfterNextManeuverDistance AfterNextManeuverDistance AfterNextManeuverDistance AfterNextManeuverDistance

Gets the distance along the route between the current location and AfterNextManeuver, 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 AfterNextManeuverDistance { get; }public int AfterNextManeuverDistance { get; }Public ReadOnly Property AfterNextManeuverDistance As int// This API is not available in Javascript.
Value
int int int int

The distance along the route between the current location and AfterNextManeuver, in meters.

CurrentLocation CurrentLocation CurrentLocation CurrentLocation

Gets the navigational conditions at the current location.

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 : GuidanceMapMatchedCoordinate CurrentLocation { get; }public GuidanceMapMatchedCoordinate CurrentLocation { get; }Public ReadOnly Property CurrentLocation As GuidanceMapMatchedCoordinate// This API is not available in Javascript.

Remarks

During a guidance update, the geographic location returned by GuidanceUpdatedEventArgs corresponds to the nearest point on the route near the user's actual geographic location. This helps compensate for GPS inaccuracies. If the route is not nearby, a point on the nearest road will be used. For example, if the user misses a turn.

DistanceToDestination DistanceToDestination DistanceToDestination DistanceToDestination

Gets the distance remaining along 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 DistanceToDestination { get; }public int DistanceToDestination { get; }Public ReadOnly Property DistanceToDestination As int// This API is not available in Javascript.
Value
int int int int

The distance remaining along the route, in meters.

ElapsedDistance ElapsedDistance ElapsedDistance ElapsedDistance

Gets the distance traveled along the route prior to the update, 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 ElapsedDistance { get; }public int ElapsedDistance { get; }Public ReadOnly Property ElapsedDistance As int// This API is not available in Javascript.
Value
int int int int

The distance traveled along the route prior to the update, in meters.

ElapsedTime ElapsedTime ElapsedTime ElapsedTime

Gets the time that has elapsed along the route prior to the update.

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 ElapsedTime { get; }public TimeSpan ElapsedTime { get; }Public ReadOnly Property ElapsedTime As TimeSpan// This API is not available in Javascript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The time that has elapsed along the route prior to the update.

IsNewManeuver IsNewManeuver IsNewManeuver IsNewManeuver

Gets a value that indicates if the update contains a new maneuver.

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 : PlatForm::Boolean IsNewManeuver { get; }public bool IsNewManeuver { get; }Public ReadOnly Property IsNewManeuver As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true if the update contains a new maneuver; otherwise, false.

LaneInfo LaneInfo LaneInfo LaneInfo

Gets a list of lanes near the current location, ordered from left to right.

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<GuidanceLaneInfo> LaneInfo { get; }public IReadOnlyList<GuidanceLaneInfo> LaneInfo { get; }Public ReadOnly Property LaneInfo As IReadOnlyList<GuidanceLaneInfo>// This API is not available in Javascript.
Value
IVectorView<GuidanceLaneInfo> IReadOnlyList<GuidanceLaneInfo> IReadOnlyList<GuidanceLaneInfo> IReadOnlyList<GuidanceLaneInfo>

The lanes near the current location, ordered from left to right.

Mode Mode Mode Mode

Gets the type of the navigational guidance.

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 : GuidanceMode Mode { get; }public GuidanceMode Mode { get; }Public ReadOnly Property Mode As GuidanceMode// This API is not available in Javascript.
Value
GuidanceMode GuidanceMode GuidanceMode GuidanceMode

The type of the navigational guidance.

NextManeuver NextManeuver NextManeuver NextManeuver

Gets the maneuver that follows the current maneuver.

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 : GuidanceManeuver NextManeuver { get; }public GuidanceManeuver NextManeuver { get; }Public ReadOnly Property NextManeuver As GuidanceManeuver// This API is not available in Javascript.
Value
GuidanceManeuver GuidanceManeuver GuidanceManeuver GuidanceManeuver

The maneuver that follows the current maneuver.

NextManeuverDistance NextManeuverDistance NextManeuverDistance NextManeuverDistance

Gets the distance along the route between the current location and NextManeuver, 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 NextManeuverDistance { get; }public int NextManeuverDistance { get; }Public ReadOnly Property NextManeuverDistance As int// This API is not available in Javascript.
Value
int int int int

The distance along the route between the current location and NextManeuver, in meters.

RoadName RoadName RoadName RoadName

Gets the full name of the current road segment.

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 : PlatForm::String RoadName { get; }public string RoadName { get; }Public ReadOnly Property RoadName As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The full name of the current road segment.

Route Route Route Route

Gets the updated 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 : GuidanceRoute Route { get; }public GuidanceRoute Route { get; }Public ReadOnly Property Route As GuidanceRoute// This API is not available in Javascript.

TimeToDestination TimeToDestination TimeToDestination TimeToDestination

Gets the estimated travel time to reach the destination.

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 TimeToDestination { get; }public TimeSpan TimeToDestination { get; }Public ReadOnly Property TimeToDestination As TimeSpan// This API is not available in Javascript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The estimated travel time to reach the destination.