MapsRoutingClient.GetRouteRange(RouteRangeOptions, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. The returned polygon can be used for further processing such as Search Inside Geometry to search for POIs within the provided Isochrone.
public virtual Azure.Response<Azure.Maps.Routing.Models.RouteRangeResult> GetRouteRange (Azure.Maps.Routing.RouteRangeOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetRouteRange : Azure.Maps.Routing.RouteRangeOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Maps.Routing.Models.RouteRangeResult>
override this.GetRouteRange : Azure.Maps.Routing.RouteRangeOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Maps.Routing.Models.RouteRangeResult>
Public Overridable Function GetRouteRange (options As RouteRangeOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RouteRangeResult)
Parameters
- options
- RouteRangeOptions
Route range options to use.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
options
is null.
Service returned a non-success status code.
Applies to
Azure SDK for .NET