Share via

DirectionsRenderOptions 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.

You can set options for how to the route is rendered by passing an object containing direction render options to the setRenderOptions method of the DirectionsManager. The following is a list of properties that are available in the DirectionsRenderOptions object.

Name Type Description
autoUpdateMapView boolean A boolean indicating whether to automatically set the map view to the best map view of the calculated route. Default: true
displayDisclaimer boolean A boolean indicating whether to display the disclaimer about the accuracy of the directions. Default: true
displayManeuverIcons boolean A boolean indicating whether to display the icons for each direction maneuver. Default: true
displayPostItineraryItemHints boolean A boolean indicating whether to display direction hints that describe when a direction step was missed. Default: true
displayPreItineraryItemHints boolean A boolean indicating whether to display direction hints that describe what to look for before you come to the next direction step. The default value is true.
displayRouteSelector boolean A boolean indicating whether to display the route selector control. Default: true
displayStepWarnings boolean A boolean indicating whether to display direction warnings. Default: true
displayWalkingWarning boolean A boolean indicating whether to display a warning about walking directions. Default: true
drivingPolylineOptions PolylineOptions The polyline options that define how to draw the route line on the map, if the RouteMode is driving.
firstWaypointPushpinOptions PushpinOptions The pushpin options that define how the first waypoint should be rendered.
itineraryContainer DOMElement The DOM element inside which the directions itinerary will be rendered.
lastWaypointPushpinOptions PushpinOptions The pushpin options that define how the last waypoint should be rendered.
showInputPanel boolean A boolean indicating whether to show the input panel. Default: false
transitPolylineOptions PolylineOptions The options that define how to draw the route line on the map, if the RouteMode is transit.
walkingPolylineOptions PolylineOptions The options that define how to draw the route line on the map, if the RouteMode is walking.
waypointPushpinOptions PushpinOptions The options that define the pushpin to use for all route waypoints by default. The first and last waypoints in the route will be overridden by firstWaypointPushpinOptions and lastWaypointPushpinOptions if set.