你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
RouteGetRouteRangeQueryParamProperties interface
属性
acceleration |
指定当车辆加速 (即 KineticEnergyGained/ChemicalEnergyConsumed)时,将燃料中存储的化学能量转换为动能的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。 必须与 减速配对。 允许的值为 0.0 到 1/减速效率。 合理值:燃烧模型:0.33,电动模型:0.66 |
auxiliary |
指定用于维持辅助系统(千瓦)的电力量。 它可用于指定由于设备和系统(如 AC 系统、无线电、加热等)的消耗。 合理的值:1.7 |
auxiliary |
指定用于维持车辆辅助系统的燃料量(以升/小时为单位)。 它可用于指定由于设备和系统(如 AC 系统、无线电、加热等)的消耗。 合理的值:0.2 |
avoid | 指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路,&避免=tollRoads&avoid=ferries”。 在 calculateReachableRange 请求中,不能使用 alreadyUsedRoads 值。 |
constant |
指定消耗速度相关组件。 以无序的速度/消耗率对列表的形式提供。 该列表定义消耗曲线上的点。 在列表中找不到速度的消耗率,如下所示:
该列表必须包含 1 到 25 磅(含),并且不能包含相同速度的重复点。 如果它仅包含一个点,则使用该点的消耗率而不进行进一步处理。 为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。 这可确保推断不会导致负消耗率。 同样,为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。 消耗值的有效范围(以 kWh/100km 表示)介于 0.01 和 100000.0 之间。 合理的值: 50,8.2:130,21.3 用电模型需要此参数。 |
constant |
指定消耗速度相关组件。 以无序分隔的速度列表的形式提供,& 消耗率对。 该列表定义消耗曲线上的点。 在列表中找不到速度的消耗率,如下所示:
该列表必须包含 1 到 25 磅(含),并且不能包含相同速度的重复点。 如果它仅包含一个点,则使用该点的消耗率而不进行进一步处理。 为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。 这可确保推断不会导致负消耗率。 同样,为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。 消耗值的有效范围(以 l/100 公里表示)介于 0.01 和 100000.0 之间。 合理的值: 50,6.3:130,11.5 注意:燃烧消耗模型,此参数是必需的。 |
current |
以千瓦时为单位指定当前电力供应(千瓦时)。 此参数与 maxChargeInkWh 参数共存。 允许的值为 0.0 到 maxChargeInkWh。 合理的值:43 |
current |
指定当前以升为单位的燃料供应。 合理的值: 55 |
deceleration |
指定当车辆减速 (即 ChemicalEnergySaved/KineticEnergyLost)时,将动能转换为节约(未消耗)燃料的效率。ChemicalEnergySaved 是通过使用 燃料EnergyDensityInMJoulesPerLiter将节约的(未消耗)燃料转换为能量获得的。 必须与 accelerationEfficiency配对。 允许的值为 0.0 到 1/accelerationEfficiency。 合理的值:对于 燃烧模型: 0.83,对于 电动模型: 0.91 |
depart |
从原点出发的日期和时间。 除现在以外的出发时间必须指定为 dateTime。 如果未指定时区偏移量,则假定其为原点的偏移量。 departAt 值必须采用日期时间格式(1996-12-19T16:39:57-08:00)。 |
distance |
距离预算(以米为单位),用于确定可使用驾驶距离行驶的最大范围。 消耗模型只会在 routeType 为生态时影响范围。 |
downhill |
指定当车辆失去海拔 (即 ChemicalEnergySaved/PotentialEnergyLost)时将潜在能量转换为节约(未消耗)燃料的效率。ChemicalEnergySaved 是通过使用 燃料EnergyDensityInMJoulesPerLiter将节约的(未消耗)燃料转换为能量获得的。 必须与 上坡效率配对。 允许的值为 0.0 到 1/uphillEfficiency。 合理值:燃烧模型:0.51,电动模型:0.73 |
energy |
千瓦时(千瓦时)的电力能源预算,用于确定可以使用指定的用电模型行驶的最大范围。 |
fuel |
燃油预算以升为单位,用于确定可以使用指定的燃烧消耗模型行驶的最大范围。 |
fuel |
指定以兆焦(MJ)存储在一升燃料中的化学能量量。 它与 *效率 参数结合使用,用于节省或消耗的能量和燃料之间的转换。 例如,汽油的能源密度为 34.2 MJ/l,柴油为 35.8 MJ/l。 如果设置了任何 *效率 参数,则此参数是必需的。 合理的值:34.2 |
hilliness | 惊心动魄的路线的丘陵程度。 此参数只能与 |
max |
指定可存储在车辆电池中的千瓦时(千瓦时)的最大电力供应量。 此参数与 currentChargeInkWh 参数共存。 最小值必须大于或等于 currentChargeInkWh。 合理的值: 85 |
query | 范围计算应从其开始的坐标。 |
route |
请求的路由类型。 |
time |
时间预算(以秒为单位),确定可使用驾驶时间行驶的最大范围。 消耗模型只会在 routeType 为生态时影响范围。 |
traffic | 可能的值:
|
travel |
所请求路线的旅行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则响应的 travelMode 元素将为“其他”。 请注意,旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。 在 calculateReachableRange 请求中,不得使用自行车和行人的值。 |
uphill |
指定当车辆提升 (即 PotentialEnergyGained/ChemicalEnergyConsumed)时,将存储在燃料中的化学能量转换为潜在能量的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。 必须与 下坡效率配对。 允许的值为 0.0 到 1/downhillEfficiency。 合理值:燃烧模型:0.27,电动模型:0.74 |
vehicle |
车辆每轴重量(以公斤为单位)。 值为 0 表示不考虑每个轴的重量限制。 |
vehicle |
车辆是否用于商业目的。 商业车辆不得在一些公路上行驶。 |
vehicle |
车辆的引擎类型。 指定详细消耗模型时,它必须与 vehicleEngineType的值一致。 |
vehicle |
车辆的高度(以米为单位)。 值为 0 表示不考虑高度限制。 |
vehicle |
车辆长度(以米为单位)。 值为 0 表示不考虑长度限制。 |
vehicle |
可能归类为危险物质的货物类型,并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9,以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由,而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。 |
vehicle |
车辆的最大速度(以公里/小时为单位)。 车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上。
|
vehicle |
车辆重量(以公斤为单位)。
合理值:燃烧模型:1600,电动模型:1900 |
vehicle |
车辆宽度(以米为单位)。 值为 0 表示不考虑宽度限制。 |
windingness | 惊心动魄的路线的转弯水平。 此参数只能与 |
属性详细信息
accelerationEfficiency
指定当车辆加速 (即 KineticEnergyGained/ChemicalEnergyConsumed)时,将燃料中存储的化学能量转换为动能的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。
必须与 减速配对。
允许的值为 0.0 到 1/减速效率。
合理值:燃烧模型:0.33,电动模型:0.66
accelerationEfficiency?: number
属性值
number
auxiliaryPowerInkW
指定用于维持辅助系统(千瓦)的电力量。
它可用于指定由于设备和系统(如 AC 系统、无线电、加热等)的消耗。
合理的值:1.7
auxiliaryPowerInkW?: number
属性值
number
auxiliaryPowerInLitersPerHour
指定用于维持车辆辅助系统的燃料量(以升/小时为单位)。
它可用于指定由于设备和系统(如 AC 系统、无线电、加热等)的消耗。
合理的值:0.2
auxiliaryPowerInLitersPerHour?: number
属性值
number
avoid
指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路,&避免=tollRoads&avoid=ferries”。 在 calculateReachableRange 请求中,不能使用 alreadyUsedRoads 值。
avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]
属性值
("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]
constantSpeedConsumptionInkWhPerHundredkm
指定消耗速度相关组件。
以无序的速度/消耗率对列表的形式提供。 该列表定义消耗曲线上的点。 在列表中找不到速度的消耗率,如下所示:
通过线性内插,如果给定的速度位于列表中的两个速度之间
如果为线性推断,则假定由列表中最近的两个点确定的常量(列表中选择一个常量()(按线性推断)
该列表必须包含 1 到 25 磅(含),并且不能包含相同速度的重复点。 如果它仅包含一个点,则使用该点的消耗率而不进行进一步处理。
为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。 这可确保推断不会导致负消耗率。
同样,为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。
消耗值的有效范围(以 kWh/100km 表示)介于 0.01 和 100000.0 之间。
合理的值: 50,8.2:130,21.3
用电模型需要此参数。
constantSpeedConsumptionInkWhPerHundredkm?: string
属性值
string
constantSpeedConsumptionInLitersPerHundredkm
指定消耗速度相关组件。
以无序分隔的速度列表的形式提供,& 消耗率对。 该列表定义消耗曲线上的点。 在列表中找不到速度的消耗率,如下所示:
通过线性内插,如果给定的速度位于列表中的两个速度之间
如果为线性推断,则假定由列表中最近的两个点确定的常量(列表中选择一个常量()(按线性推断)
该列表必须包含 1 到 25 磅(含),并且不能包含相同速度的重复点。 如果它仅包含一个点,则使用该点的消耗率而不进行进一步处理。
为最大速度指定的消耗必须大于或等于倒数第二个最大速度的消耗量。 这可确保推断不会导致负消耗率。
同样,为列表中的两个最小速度指定的消耗值不能导致任何较小的速度的负消耗率。
消耗值的有效范围(以 l/100 公里表示)介于 0.01 和 100000.0 之间。
合理的值: 50,6.3:130,11.5
注意:燃烧消耗模型,此参数是必需的。
constantSpeedConsumptionInLitersPerHundredkm?: string
属性值
string
currentChargeInkWh
以千瓦时为单位指定当前电力供应(千瓦时)。
此参数与 maxChargeInkWh 参数共存。
允许的值为 0.0 到 maxChargeInkWh。
合理的值:43
currentChargeInkWh?: number
属性值
number
currentFuelInLiters
指定当前以升为单位的燃料供应。
合理的值: 55
currentFuelInLiters?: number
属性值
number
decelerationEfficiency
指定当车辆减速 (即 ChemicalEnergySaved/KineticEnergyLost)时,将动能转换为节约(未消耗)燃料的效率。ChemicalEnergySaved 是通过使用 燃料EnergyDensityInMJoulesPerLiter将节约的(未消耗)燃料转换为能量获得的。
必须与 accelerationEfficiency配对。
允许的值为 0.0 到 1/accelerationEfficiency。
合理的值:对于 燃烧模型: 0.83,对于 电动模型: 0.91
decelerationEfficiency?: number
属性值
number
departAt
从原点出发的日期和时间。 除现在以外的出发时间必须指定为 dateTime。 如果未指定时区偏移量,则假定其为原点的偏移量。 departAt 值必须采用日期时间格式(1996-12-19T16:39:57-08:00)。
departAt?: string | Date
属性值
string | Date
distanceBudgetInMeters
距离预算(以米为单位),用于确定可使用驾驶距离行驶的最大范围。 消耗模型只会在 routeType 为生态时影响范围。
必须使用一个预算(fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters)。
distanceBudgetInMeters?: number
属性值
number
downhillEfficiency
指定当车辆失去海拔 (即 ChemicalEnergySaved/PotentialEnergyLost)时将潜在能量转换为节约(未消耗)燃料的效率。ChemicalEnergySaved 是通过使用 燃料EnergyDensityInMJoulesPerLiter将节约的(未消耗)燃料转换为能量获得的。
必须与 上坡效率配对。
允许的值为 0.0 到 1/uphillEfficiency。
合理值:燃烧模型:0.51,电动模型:0.73
downhillEfficiency?: number
属性值
number
energyBudgetInkWh
千瓦时(千瓦时)的电力能源预算,用于确定可以使用指定的用电模型行驶的最大范围。
使用 energyBudgetInkWh 时,必须指定详细的用电量模型。
必须使用一个预算(fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters)。
energyBudgetInkWh?: number
属性值
number
fuelBudgetInLiters
燃油预算以升为单位,用于确定可以使用指定的燃烧消耗模型行驶的最大范围。
使用 fuelBudgetInLiters 时,必须指定详细的燃烧消耗模型。
必须使用一个预算(fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters)。
fuelBudgetInLiters?: number
属性值
number
fuelEnergyDensityInMJoulesPerLiter
指定以兆焦(MJ)存储在一升燃料中的化学能量量。 它与 *效率 参数结合使用,用于节省或消耗的能量和燃料之间的转换。 例如,汽油的能源密度为 34.2 MJ/l,柴油为 35.8 MJ/l。
如果设置了任何 *效率 参数,则此参数是必需的。
合理的值:34.2
fuelEnergyDensityInMJoulesPerLiter?: number
属性值
number
hilliness
惊心动魄的路线的丘陵程度。 此参数只能与 routeType
=thrilling 结合使用。
hilliness?: "low" | "normal" | "high"
属性值
"low" | "normal" | "high"
maxChargeInkWh
指定可存储在车辆电池中的千瓦时(千瓦时)的最大电力供应量。
此参数与 currentChargeInkWh 参数共存。
最小值必须大于或等于 currentChargeInkWh。
合理的值: 85
maxChargeInkWh?: number
属性值
number
query
范围计算应从其开始的坐标。
query: number[]
属性值
number[]
routeType
请求的路由类型。
routeType?: "fastest" | "shortest" | "eco" | "thrilling"
属性值
"fastest" | "shortest" | "eco" | "thrilling"
timeBudgetInSec
时间预算(以秒为单位),确定可使用驾驶时间行驶的最大范围。 消耗模型只会在 routeType 为生态时影响范围。
必须使用一个预算(fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters)。
timeBudgetInSec?: number
属性值
number
traffic
可能的值:
- true - 在路由期间考虑所有可用的流量信息
- false - 在路由期间忽略当前流量数据。 请注意,虽然当前交通数据在路由期间被忽略,但历史交通对有效道路速度的影响仍会合并。
traffic?: boolean
属性值
boolean
travelMode
所请求路线的旅行模式。 如果未定义,则默认值为“car”。 请注意,请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节,则响应的 travelMode 元素将为“其他”。 请注意,旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。 在 calculateReachableRange 请求中,不得使用自行车和行人的值。
travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"
属性值
"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"
uphillEfficiency
指定当车辆提升 (即 PotentialEnergyGained/ChemicalEnergyConsumed)时,将存储在燃料中的化学能量转换为潜在能量的效率。ChemicalEnergyConsumed 是通过使用 fuelEnergyDensityInMJoulesPerLiter将消耗的燃料转换为化学能量获得的。
必须与 下坡效率配对。
允许的值为 0.0 到 1/downhillEfficiency。
合理值:燃烧模型:0.27,电动模型:0.74
uphillEfficiency?: number
属性值
number
vehicleAxleWeight
车辆每轴重量(以公斤为单位)。 值为 0 表示不考虑每个轴的重量限制。
vehicleAxleWeight?: number
属性值
number
vehicleCommercial
车辆是否用于商业目的。 商业车辆不得在一些公路上行驶。
vehicleCommercial?: boolean
属性值
boolean
vehicleEngineType
车辆的引擎类型。 指定详细消耗模型时,它必须与 vehicleEngineType的值一致。
vehicleEngineType?: "combustion" | "electric"
属性值
"combustion" | "electric"
vehicleHeight
车辆的高度(以米为单位)。 值为 0 表示不考虑高度限制。
vehicleHeight?: number
属性值
number
vehicleLength
车辆长度(以米为单位)。 值为 0 表示不考虑长度限制。
vehicleLength?: number
属性值
number
vehicleLoadType
可能归类为危险物质的货物类型,并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9,以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由,而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"
属性值
"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"
vehicleMaxSpeed
车辆的最大速度(以公里/小时为单位)。 车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上。
值为 0 表示将在路线规划期间确定并应用车辆的相应值。
在路由规划期间,可能会重写非零值。 例如,当前流量流为 60 公里/小时。 如果车辆最大速度设置为 50 公里/小时,路由引擎将考虑 60 公里/小时,因为这是目前的情况。 如果车辆的最大速度为 80 公里/小时,但当前交通流量为 60 公里/小时,则路由引擎将再次使用 60 公里/小时。
vehicleMaxSpeed?: number
属性值
number
vehicleWeight
车辆重量(以公斤为单位)。
如果设置了任何 *效率参数,则是必需的。
在消耗模型上下文中使用时,它必须严格为正。 考虑权重限制。
如果未指定详细的 消耗模型,并且 车辆重量 的值为非零,则考虑重量限制。
在所有其他情况下,将忽略此参数。
合理值:燃烧模型:1600,电动模型:1900
vehicleWeight?: number
属性值
number
vehicleWidth
车辆宽度(以米为单位)。 值为 0 表示不考虑宽度限制。
vehicleWidth?: number
属性值
number
windingness
惊心动魄的路线的转弯水平。 此参数只能与 routeType
=thrilling 结合使用。
windingness?: "low" | "normal" | "high"
属性值
"low" | "normal" | "high"