Waypoint Class
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.
In order to calculate a route between locations you need to first add all the locations as waypoints to the DirectionsManager. When creating an instance of the Waypoint class you must pass in an object containing WaypointOptions.
Constructor
Waypoint(options: WaypointOptions)
Methods
| Name | Type | Description |
|---|---|---|
dispose() |
Releases any resources associated with the waypoint. | |
getAddress() |
string | Returns the address associated with the waypoint. |
getLocation() |
Location | Returns the location of the waypoint. |
isViapoint() |
boolean | Returns a boolean value indicating whether the waypoint is a via point. A via point is a location that your route is guaranteed to pass through. There can be multiple via points between two stop points. |
| setOptions(options: WaypointOptions | Sets options for the waypoint. For these options to take effect, you must recalculate the route. |