Share via

DirectionsStep Object

  • Article

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

Represents one direction in a set of route directions.

Name Type Description
childItineraryItems DirectionsStep[] The child direction items for this directions step.
coordinate Location The location of the start of the direction.
distance string The total distance of the step in the unit specified in the distanceUnit property of the DirectionsRequestOptions.
durationInSeconds number The total time, in seconds, of the direction step.
formattedText string The HTML formatted route instruction associated with the step.
isImageRoadShield boolean A boolean indicating whether the maneuver image is a road shield image.
maneuver string The type of maneuver being performed
monetaryCost number The cost of the step.
postIntersectionHints string[] An array of strings, where each string is a hint to help determine when to move to the next direction step. Not all direction steps have hints.
preIntersectionHints string[] An array of strings, where each string is a hint to help determine when you have arrived at this direction step. Not all direction steps have hints.
startStopName string The name of the transit stop where this step originates.
transitLine TransitLine The transit line associated with this step.
transitStepIcon string The URL of the image to use for transit direction steps.
transitStopId string The ID of the transit stop.
transitTerminus string The name of the transit line end.
warnings DirectionsStepWarning[] An array of route warnings associated with this step.