TravelMode

AMD: require(["geoscene/rest/support/TravelMode"], (TravelMode) => { /* code goes here */ });
ESM: import TravelMode from "@geoscene/core/rest/support/TravelMode.js";
类: geoscene/rest/support/TravelMode
继承于:TravelMode Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.20

TravelMode 是一组特征,用于定义对象 (如车辆、自行车或行人) 如何沿街道网络移动。在查找方向以确定车辆或行人如何行驶以及他们可以去哪里时,会考虑这些特征。要获取支持的出行模式列表、查找默认出行模式以及查找和使用特定出行模式,您可使用 networkService.fetchServiceDescription() 方法:

// 1. Get the default and supported travel modes of a route service
 ;
const url = "https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World";
const serviceDescription = await fetchServiceDescription(url, apiKey);
const { defaultTravelMode, supportedTravelModes } = serviceDescription;
console.log(`The name of the default travel mode is: ${defaultTravelMode.name}.`);
console.log(`This service has ${supportedTravelModes.length} preset travel modes`);
// 2. Find and use the "Driving Time" travel mode
 ;
const url = "https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World";
const serviceDescription = await fetchServiceDescription(url, apiKey);
const { supportedTravelModes } = serviceDescription;
const driveTimeTravelMode = supportedTravelModes.find(({ name }) => name === "Driving Time");

// Solve a route using the "Driving Time" travel mode
const routeParameters = {
  stops: stopsFeatureSet, // route stops
  travelMode: driveTimeTravelMode
};
const result = await solve(url, routeParameters);

对于 GeoScene Enterprise 服务,当使用网络分析功能发布地图服务时,出行模式的默认值都基于图层设置。打开服务描述页面以查看参数的默认值。

另请参阅

构造函数

new TravelMode(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

所有属性都可以设置、获取和监听。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
Object[]

列出出行模式使用的参数化属性。

更多详情
TravelMode
String

类的名称。

更多详情
Accessor
String

出行模式的简短文本描述。

更多详情
TravelMode
String

指示用于报告方向和解决车辆配送问题的基于距离的成本属性。

更多详情
TravelMode
String

唯一标识符。

更多详情
TravelMode
String

用作阻抗的网络成本属性。

更多详情
TravelMode
String

出行模式的唯一名称。

更多详情
TravelMode
String[]

使用此出行模式解决网络分析问题时使用的限制属性列表。

更多详情
TravelMode
Number

指定出行模式是否对分析结果的几何进行概化以及概化程度。

更多详情
TravelMode
String

simplificationTolerance 相关的线性单位。

更多详情
TravelMode
String

指示报告方向的基于时间的成本属性。

更多详情
TravelMode
String

表示该出行模式所代表的出行或车辆类别。

更多详情
TravelMode
Boolean

指示出行模式在执行分析时是否使用等级属性。

更多详情
TravelMode
String

指示求解程序如何处理网络遍历期间可能发生的交叉路口处的 U 形转弯。

更多详情
TravelMode

属性详细信息

attributeParameterValues Object[]

列出出行模式使用的参数化属性。

属性
attributeName String

属性的名称。

parameterName String

参数名称。

value String

参数值。

declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className

description String

出行模式的简短文本描述。

distanceAttributeName String

指示用于报告方向和解决车辆配送问题的基于距离的成本属性。

可能值"kilometers"|"miles"|"meters"

唯一标识符。

impedanceAttributeName String

用作阻抗的网络成本属性。在解决网络分析问题时,此成本属性被最小化。

可能值"kilometers"|"miles"|"meters"|"minutes"|"travel-time"|"truck-minutes"|"truck-travel-time"|"walk-time"

name String

出行模式的唯一名称。

restrictionAttributeNames String[]

使用此出行模式解决网络分析问题时使用的限制属性列表。

可能值"any-hazmat-prohibited"|"avoid-carpool-roads"|"avoid-express-lanes"|"avoid-ferries"|"avoid-gates"|"avoid-limited-access-roads"|"avoid-private-roads"|"avoid-roads-unsuitable-for-pedestrians"|"avoid-stairways"|"avoid-toll-roads"|"avoid-toll-roads-for-trucks"|"avoid-truck-restricted-roads"|"avoid-unpaved-roads"|"axle-count-restriction"|"driving-a-bus"|"driving-a-taxi"|"driving-a-truck"|"driving-an-automobile"|"driving-an-emergency-vehicle"|"height-restriction"|"kingpin-to-rear-axle-length-restriction"|"length-restriction"|"preferred-for-pedestrians"|"riding-a-motorcycle"|"roads-under-construction-prohibited"|"semi-or-tractor-with-one-or-more-trailers-prohibited"|"single-axle-vehicles-prohibited"|"tandem-axle-vehicles-prohibited"|"through-traffic-prohibited"|"truck-with-trailers-restriction"|"use-preferred-hazmat-routes"|"use-preferred-truck-routes"|"walking"|"weight-restriction"|"string"

simplificationTolerance Number

指定出行模式是否对分析结果的几何进行概化以及概化程度。

simplificationToleranceUnits String

simplificationTolerance 相关的线性单位。

可能值"centimeters"|"decimal-degrees"|"decimeters"|"feet"|"inches"|"kilometers"|"meters"|"miles"|"millimeters"|"nautical-miles"|"points"|"unknown"|"yards"

timeAttributeName String

指示报告方向的基于时间的成本属性。

可能值"minutes"|"travel-time"|"truck-minutes"|"truck-travel-time"|"walk-time"

type String

表示该出行模式所代表的出行或车辆类别。

可能值"automobile"|"truck"|"walk"|"other"

useHierarchy Boolean

指示出行模式在执行分析时是否使用等级属性。

uturnAtJunctions String

指示求解程序如何处理网络遍历期间可能发生的交叉路口处的 U 形转弯。

可能值"allow-backtrack"|"at-dead-ends-only"|"no-backtrack"|"at-dead-ends-and-intersections"

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象生命周期相关联的句柄

更多详情
Accessor
this

创建此对象的深度克隆。

更多详情
TravelMode
*

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。

更多详情
TravelMode
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为其 GeoScene Portal JSON 表示。

更多详情
TravelMode

方法详细说明

addHandles(handleOrHandles, groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时,将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。

clone(){this}

创建此对象的深度克隆。任何通过引用存储值的属性都将被分配克隆实例上引用值的副本。

返回
类型 描述
this 调用此方法的类实例的深度克隆。
fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数
json Object

GeoScene 格式实例的 JSON 表示。

返回
类型 描述
* 返回该类的新实例。
hasHandles(groupKey){Boolean}inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组,则返回 true。

参数
groupKey *
optional

组键。

返回
类型 描述
Boolean 如果存在指定的句柄组,则返回 true
示例
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数
groupKey *
optional

要移除的组键或组键的数组或集合。

示例
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

将此类的实例转换为其 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。

返回
类型 描述
Object 此类实例的 GeoScene Portal JSON 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。