你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
RouteURL class
RouteURL 表示Azure Maps路由操作的 URL。
- Extends
构造函数
| RouteURL(Pipeline, string) | 创建 RouteURL 的实例。 |
继承属性
| maps |
基 URL 字符串值。 |
方法
| calculate |
返回源和目标之间的路由，如果指定了路点，则通过路点传递。 该路线将考虑各种因素，例如当前交通状况以及一周中某天和一天中所需时间的典型道路速度。 返回的信息包括距离、估计行程时间和路线几何图形的表示形式。 还可以使用其他路由信息，例如优化路点顺序或轮次指示，具体取决于所选选项。 路线服务提供一组参数，用于对特定于车辆的消耗模型进行详细说明。 有关相关概念和参数的详细说明，检查消耗模型。 如果 否则，使用获取路线路线 API： https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
注意：此 API 目前为预览版，可能会发生中断性变更。 计算由出发地和目标位置定义的一组路由的路线摘要矩阵。 对于每个给定的源，此服务计算从该源到每个给定目标的路由成本。 可以将原点集和目标集视为表的列标题和行标题，表中的每个单元格都包含从源路由到该单元格的目标的成本。 对于每个路线，都会计算行程时间和距离。 可以使用计算成本来确定要使用路线方向 API 计算的路线。 如果请求中的 waitForResults 参数设置为 false (默认值) ，则此 API 在响应标头的“位置”字段中返回重定向 URL 的 202 响应代码。 应定期检查此 URL，直到响应数据或错误信息可用。 此 API 矩阵的最大大小为 700 (源数乘以) 的目标数。 考虑到这一约束，可能的矩阵维度的示例包括：50x10、10x10、28x25。 10x70 (它不需要是正方形) 。 计算路由矩阵被视为长时间运行的操作。 长时间运行的操作意味着在接受初始请求后 (HTTP 202) 将轮询最终结果，直到可用为止。 每个轮询请求都会重启中止程序超时（如果已指定）。 使用后路由矩阵 API： https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
根据指定的燃料、能源或时间预算，计算一组可从出发点到达的位置。 逆时针方向返回多边形边界 (或等时线) ，以及原点结果的精确多边形中心。 返回的多边形可用于进一步处理，例如搜索内部几何图形，以在提供的等时线内搜索 POI。 使用获取路由范围 API： https://docs.microsoft.com/rest/api/maps/route/getrouterange |
继承的方法
| new |
一种静态方法，用于创建提供凭据的新 Pipeline 对象。 |
构造函数详细信息
RouteURL(Pipeline, string)
创建 RouteURL 的实例。
new RouteURL(pipeline: Pipeline, mapsUrl?: string)参数
- pipeline
- Pipeline
调用 MapsURL.newPipeline () 以创建默认管道或提供自定义管道。
- mapsUrl
-
string
指向Azure Maps服务的 URL 字符串，默认值为 "https://atlas.microsoft.com"。
如果未指定协议，例如 "atlas.microsoft.com"， https 则将假定为 。
继承属性详细信息
mapsUrl
方法详细信息
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
返回源和目标之间的路由，如果指定了路点，则通过路点传递。 该路线将考虑各种因素，例如当前交通状况以及一周中某天和一天中所需时间的典型道路速度。 返回的信息包括距离、估计行程时间和路线几何图形的表示形式。 还可以使用其他路由信息，例如优化路点顺序或轮次指示，具体取决于所选选项。
路线服务提供一组参数，用于对特定于车辆的消耗模型进行详细说明。 有关相关概念和参数的详细说明，检查消耗模型。
如果 options.postBody 指定 了 ，则使用 Post Route Directions API： https://docs.microsoft.com/rest/api/maps/route/postroutedirections
否则，使用获取路线路线 API： https://docs.microsoft.com/rest/api/maps/route/getroutedirections
function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- coordinates
-
GeoJSON.Position[]
计算路线所通过的坐标数组。
每个坐标都是 的 [longitude, latitude]数组。 至少需要两个坐标。
第一个是源，最后一个是路由的目的地。
中间的可选坐标充当路由中的 WayPoint。 最多可传递 150 个 WayPoint。
- options
- CalculateRouteDirectionsOptions
返回
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
注意：此 API 目前为预览版，可能会发生中断性变更。 计算由出发地和目标位置定义的一组路由的路线摘要矩阵。 对于每个给定的源，此服务计算从该源到每个给定目标的路由成本。 可以将原点集和目标集视为表的列标题和行标题，表中的每个单元格都包含从源路由到该单元格的目标的成本。 对于每个路线，都会计算行程时间和距离。 可以使用计算成本来确定要使用路线方向 API 计算的路线。 如果请求中的 waitForResults 参数设置为 false (默认值) ，则此 API 在响应标头的“位置”字段中返回重定向 URL 的 202 响应代码。 应定期检查此 URL，直到响应数据或错误信息可用。 此 API 矩阵的最大大小为 700 (源数乘以) 的目标数。 考虑到这一约束，可能的矩阵维度的示例包括：50x10、10x10、28x25。 10x70 (它不需要是正方形) 。
计算路由矩阵被视为长时间运行的操作。 长时间运行的操作意味着在接受初始请求后 (HTTP 202) 将轮询最终结果，直到可用为止。 每个轮询请求都会重启中止程序超时（如果已指定）。
使用后路由矩阵 API： https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
起点坐标和目标坐标矩阵，用于根据输入参数计算矩阵中每个单元格的路线距离、行程时间和其他摘要。 支持的最小和最大单元格计数分别为 1 和 700。 例如，它可以是 35 个源和 20 个目标，也可以是 25 个源和 25 个目的地。
- options
- CalculateRouteMatrixOptions
返回
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
根据指定的燃料、能源或时间预算，计算一组可从出发点到达的位置。 逆时针方向返回多边形边界 (或等时线) ，以及原点结果的精确多边形中心。 返回的多边形可用于进一步处理，例如搜索内部几何图形，以在提供的等时线内搜索 POI。
使用获取路由范围 API： https://docs.microsoft.com/rest/api/maps/route/getrouterange
function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- center
- GeoJSON.Position
范围计算应从其开始的坐标。
- options
- CalculateRouteRangeOptions
返回
Promise<CalculateRouteRangeResponse>
继承的方法详细信息
newPipeline(Credential, INewPipelineOptions)
一种静态方法，用于创建提供凭据的新 Pipeline 对象。
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline参数
- credential
- Credential
例如 SubscriptionKeyCredential、TokenCredential 和 MapControlCredential。
- pipelineOptions
- INewPipelineOptions
返回
一个新的 Pipeline 对象。