你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

RouteBeginPostRouteMatrixPreviewOptionalParams interface

包:

azure-maps-rest

可选参数。

Extends

RequestOptionsBase

属性

arriveAt	到达目标点的日期和时间。 必须将其指定为 dateTime。 如果未指定时区偏移量，则将它假定为目标点的时区偏移量。 arriveAt 值必须是将来的。 arriveAt 参数不能与 departAt、minDeviationDistance 或 minDeviationTime 结合使用。
avoid	指定在确定路由时路由计算应尝试避免的内容。 可以在一个请求中多次指定，例如，“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在 calculateReachableRange 请求中，不得使用已经UsedRoads 的值。 可能的值包括：“tollRoads”、“高速公路”、“渡轮”、“unpavedRoads”、“carpools”、“alreadyUsedRoads”、“borderCrossings”
computeTravelTimeFor	指定是否使用不同类型的交通信息返回其他行程时间， (无、历史、实时) 以及默认的最佳估计行程时间。 可能的值包括：“none”、“all”
departAt	从起点出发的日期和时间。 除现在以外的出发时间必须指定为 dateTime。 如果未指定时区偏移量，则将假定为原点的时区偏移量。 (1996-12-19T16：39：57-08：00) ，
hilliness	惊心动魄路线的丘陵程度。 此参数只能与 routeType=thrilling 结合使用。 可能的值包括：“low”、“normal”、“high”
routeType	请求的路由类型。 可能的值包括：“fastest”、“shortest”、“eco”、“thrilling”
sectionType	指定在路由响应中报告哪些节类型。 例如，如果 sectionType = 行人，则返回仅适用于行人的部分。 可以使用多个类型。 default sectionType 引用 travelMode 输入。 默认情况下，travelMode 设置为 car。 可能的值包括：“carTrain”、“country”、“ferry”、“motorway”、“pedestrian”、“tollRoad”、“tollVignette”、“traffic”、“travelMode”、“tunnel”
traffic	可能的值： true - 在路由期间考虑所有可用的流量信息 false - 在路由期间忽略当前流量数据。 请注意，尽管在路由过程中忽略了当前交通数据，但仍会纳入历史交通对有效道路速度的影响。
travelMode	所请求路线的出行模式。 请注意，请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节，该节响应的 travelMode 元素将是其他部分。 请注意，公交、摩托车、出租车和面包车的出行模式是 BETA 版功能。 并非所有区域都提供完全限制数据。 在 calculateReachableRange 请求中，不得使用“自行车”和“行人”值。 可能的值包括：“car”、“truck”、“taxi”、“bus”、“van”、“motorcycle”、“bicycle”、“pedestrian”
vehicleAxleWeight	车辆每轴的重量（以公斤为单位）。 值为 0 表示不考虑每个轴的重量限制。
vehicleHeight	车辆的高度（以米为单位）。 值为 0 表示不考虑高度限制。
vehicleLength	车辆长度（以米为单位）。 值为 0 表示不考虑长度限制。
vehicleLoadType	可归类为危险品并限制在一些道路的货物类型。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9，外加在其他国家/地区使用的通用分类。 以 USHazmat 开头的值用于美国路由，而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅考虑用于 travelMode=truck。 可能的值包括：“USHazmatClass1”， “USHazmatClass2”、“USHazmatClass3”、“USHazmatClass4”、“USHazmatClass5”、“USHazmatClass6”、“USHazmatClass7”、“USHazmatClass8”、“USHazmatClass9”、“otherHazmatExplosive”、“otherHazmatGeneral”、“otherHazmatHarmfulToWater”
vehicleMaxSpeed	车辆的最高速度（以公里/小时为单位）。 值为 0 表示将在路线规划期间确定并应用车辆的适当值。 在路线规划期间，可能会重写非零值。
vehicleWeight	车辆的重量（以公斤为单位）。
vehicleWidth	车辆宽度（以米为单位）。 值为 0 表示不考虑宽度限制。
waitForResults	指示是否同步执行请求的布尔值。 如果设置为 true，则如果请求在 120 秒内完成，用户将收到 200 响应。 否则，用户将立即获得 202 响应。 有关 202 响应的详细信息，请参阅 API 说明。
windingness	惊心动魄的路线的转弯水平。 此参数只能与 routeType=thrilling 一起使用。 可能的值包括：“low”、“normal”、“high”

继承属性

abortSignal	可用于中止请求的信号。
customHeaders	{object}[customHeaders]用户定义的自定义请求标头，将在发送请求之前应用。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
timeout	请求在自动终止之前可以花费的毫秒数。

属性详细信息

arriveAt

到达目标点的日期和时间。 必须将其指定为 dateTime。 如果未指定时区偏移量，则将它假定为目标点的时区偏移量。 arriveAt 值必须是将来的。 arriveAt 参数不能与 departAt、minDeviationDistance 或 minDeviationTime 结合使用。

arriveAt?: Date

属性值

Date

avoid

指定在确定路由时路由计算应尝试避免的内容。 可以在一个请求中多次指定，例如，“&avoid=高速公路&avoid=tollRoads&avoid=ferries”。 在 calculateReachableRange 请求中，不得使用已经UsedRoads 的值。 可能的值包括：“tollRoads”、“高速公路”、“渡轮”、“unpavedRoads”、“carpools”、“alreadyUsedRoads”、“borderCrossings”

avoid?: Avoid[]

属性值

Avoid[]

computeTravelTimeFor

指定是否使用不同类型的交通信息返回其他行程时间， (无、历史、实时) 以及默认的最佳估计行程时间。 可能的值包括：“none”、“all”

computeTravelTimeFor?: ComputeTravelTimeFor

属性值

ComputeTravelTimeFor

departAt

从起点出发的日期和时间。 除现在以外的出发时间必须指定为 dateTime。 如果未指定时区偏移量，则将假定为原点的时区偏移量。 (1996-12-19T16：39：57-08：00) ，

departAt?: Date

属性值

Date

hilliness

惊心动魄路线的丘陵程度。 此参数只能与 routeType=thrilling 结合使用。 可能的值包括：“low”、“normal”、“high”

hilliness?: Hilliness

属性值

Hilliness

routeType

请求的路由类型。 可能的值包括：“fastest”、“shortest”、“eco”、“thrilling”

routeType?: RouteType

属性值

RouteType

sectionType

指定在路由响应中报告哪些节类型。

例如，如果 sectionType = 行人，则返回仅适用于行人的部分。 可以使用多个类型。 default sectionType 引用 travelMode 输入。 默认情况下，travelMode 设置为 car。 可能的值包括：“carTrain”、“country”、“ferry”、“motorway”、“pedestrian”、“tollRoad”、“tollVignette”、“traffic”、“travelMode”、“tunnel”

sectionType?: SectionType

属性值

SectionType

traffic

可能的值：

• true - 在路由期间考虑所有可用的流量信息
• false - 在路由期间忽略当前流量数据。 请注意，尽管在路由过程中忽略了当前交通数据，但仍会纳入历史交通对有效道路速度的影响。

traffic?: boolean

属性值

boolean

travelMode

所请求路线的出行模式。 请注意，请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节，该节响应的 travelMode 元素将是其他部分。 请注意，公交、摩托车、出租车和面包车的出行模式是 BETA 版功能。 并非所有区域都提供完全限制数据。 在 calculateReachableRange 请求中，不得使用“自行车”和“行人”值。 可能的值包括：“car”、“truck”、“taxi”、“bus”、“van”、“motorcycle”、“bicycle”、“pedestrian”

travelMode?: TravelMode

属性值

TravelMode

vehicleAxleWeight

车辆每轴的重量（以公斤为单位）。 值为 0 表示不考虑每个轴的重量限制。

vehicleAxleWeight?: number

属性值

number

vehicleHeight

车辆的高度（以米为单位）。 值为 0 表示不考虑高度限制。

vehicleHeight?: number

属性值

number

vehicleLength

车辆长度（以米为单位）。 值为 0 表示不考虑长度限制。

vehicleLength?: number

属性值

number

vehicleLoadType

可归类为危险品并限制在一些道路的货物类型。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9，外加在其他国家/地区使用的通用分类。 以 USHazmat 开头的值用于美国路由，而 otherHazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数目前仅考虑用于 travelMode=truck。 可能的值包括：“USHazmatClass1”， “USHazmatClass2”、“USHazmatClass3”、“USHazmatClass4”、“USHazmatClass5”、“USHazmatClass6”、“USHazmatClass7”、“USHazmatClass8”、“USHazmatClass9”、“otherHazmatExplosive”、“otherHazmatGeneral”、“otherHazmatHarmfulToWater”

vehicleLoadType?: VehicleLoadType

属性值

VehicleLoadType

vehicleMaxSpeed

车辆的最高速度（以公里/小时为单位）。 值为 0 表示将在路线规划期间确定并应用车辆的适当值。 在路线规划期间，可能会重写非零值。

vehicleMaxSpeed?: number

属性值

number

vehicleWeight

车辆的重量（以公斤为单位）。

vehicleWeight?: number

属性值

number

vehicleWidth

车辆宽度（以米为单位）。 值为 0 表示不考虑宽度限制。

vehicleWidth?: number

属性值

number

waitForResults

指示是否同步执行请求的布尔值。 如果设置为 true，则如果请求在 120 秒内完成，用户将收到 200 响应。 否则，用户将立即获得 202 响应。 有关 202 响应的详细信息，请参阅 API 说明。

waitForResults?: boolean

属性值

boolean

windingness

惊心动魄的路线的转弯水平。 此参数只能与 routeType=thrilling 一起使用。 可能的值包括：“low”、“normal”、“high”

windingness?: Windingness

属性值

Windingness

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 RequestOptionsBase.abortSignal

customHeaders

{object}[customHeaders]用户定义的自定义请求标头，将在发送请求之前应用。

customHeaders?: [key: string]: string

属性值

[key: string]: string

继承自 RequestOptionsBase.customHeaders

onDownloadProgress

下载进度时触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 RequestOptionsBase.onDownloadProgress

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 RequestOptionsBase.onUploadProgress

timeout

请求在自动终止之前可以花费的毫秒数。

timeout?: number

属性值

number

继承自 RequestOptionsBase.timeout