RouteParameters

属性概述

属性详细信息

accumulateAttributes String[]

使用此属性可指定操作是否应累积为 impedanceAttribute 指定的值以外的值。例如，如果您的 impedanceAttribute 设置为 TravelTime，则该路径的总行驶时间将由操作计算。但是，如果您还想计算路径的总距离 (以英里为单位)，则可将 Miles 指定为 accumulateAttributes 属性的值。

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

apiKey String

用于访问资源或服务的授权字符串。API 秘钥可在 GeoScene Developer 仪表盘中生成和管理。API 密钥显式绑定到 GeoScene 帐户；它还用于监视服务的使用情况。在特定类上设置细粒度 API 秘钥将覆盖全局 API 秘钥。

另请参阅

• API 密钥

• 显示地图教程 - 获取 API 秘钥

示例

const stops = new FeatureSet({
  features: [
    new Graphic({
      geometry: new Point({
        x: -117.1949676,
        y: 34.0571844
      })
    }),
    new Graphic({
      geometry: new Point({
        x: -117.0619917,
        y: 34.0010284
      })
    })
  ]
});

const routeParameters = new RouteParameters({
  apiKey: "YOUR_API_KEY",
  stops
});

const routeURL = "https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World";

const routeContainer = await route.solve(routeURL, routeParameters);
const routeLayer = routeContainer.routeResults[0].route;

const { attributes, geometry } = routeLayer;
view.graphics.add(new Graphic({
  attributes,
  geometry,
  symbol: {
    type: "simple-line",
    color: "green",
    width: "8px"
  }
}));

attributeParameterValues AttributeParameterValue[]

使用此属性可指定属性或限制条件所需的其他值，例如指定限制条件是禁止、避免还是偏爱在受限道路上行驶。如果该限制要避免或首选道路，您可以使用此属性进一步指定要避免或首选的程度。例如，您可以选择从不使用收费公路，尽可能的避开它们，或首选它们。

declaredClass Stringreadonly inherited

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

directionsLanguage String

在生成行驶方向时将使用的语言。仅当 returnDirections 参数设置为 true 时，才应用此参数。该服务支持使用以下语言生成方向：ar、bg、bs、ca、cs、da、de、el、en、es、et、fi、fr、he、hr、hu、id、it、ja、ko、lt、lv、nb、nl、pl、pt-BR、pt-PT、ro、ru、sk、sl、sr、sv、th、tr、uk、vi、zh-CN、zh-HK 和 zh-TW。

directionsLengthUnits String

指定在行驶方向中显示行驶距离的单位。仅当 returnDirections 属性设置为 true 时，才应用此属性。

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

directionsOutputType String

定义行驶方向的内容和详细程度。仅当 returnDirections 属性设置为 true 时，才应用此属性。

可能值："complete"|"complete-no-events"|"featuresets"|"instructions-only"|"standard"|"summary-only"

directionsStyleName String

指定方向的格式化样式的名称。仅当 returnDirections 属性设置为 true 时，才应用此属性。

可能值："desktop"|"navigation"|"campus"

directionsTimeAttribute String

设置基于时间的阻抗属性可显示行进的持续时间，比如“在 Alvorado 街向西北行驶 5 分钟”。所有时间属性的单位均为分钟。

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

findBestSequence Boolean

使用此属性以指定操作是否应重新排序停靠点以查找优化的路线。如果属性值为 false，则操作将返回一条以您定义的顺序访问停靠点的路线。如果参数值为 true，则操作将查找访问停靠点的最佳顺序。操作将考虑各种变量，以使路径的总行驶距离或行驶时间最小化。您可以选择保留起点和目的地停靠点，同时通过设置 preserveFirstStop 和 preserveLastStop 属性以允许操作对中间停靠点进行重新排序。

geometryPrecision Number

起始版本：GeoScene Maps SDK for JavaScript 4.24

使用此属性可指定求解操作返回的响应几何中的小数位数。这仅适用于 x 和 y 值（不适用于 m 或 z 值）。

geometryPrecisionM Number

起始版本：GeoScene Maps SDK for JavaScript 4.24

使用此属性可指定求解操作返回的响应几何中的小数位数。这仅适用于 m 值（不适用于 x、y 值或 z 值）。

geometryPrecisionZ Number

起始版本：GeoScene Maps SDK for JavaScript 4.24

使用此属性可指定求解操作返回的响应几何中的小数位数。这仅适用于 z 值（不适用于 x、y 值或 m 值）。

ignoreInvalidLocations Boolean

指示在查找最佳解决方案时，是否应忽略无效输入位置。如果输入点不在任何可遍历街道的最大捕捉容差范围内，则该操作将其视为无效。为 true 时，将忽略无效点。为 false 时，则请求中的任何无效点都将导致操作返回失败。

impedanceAttribute String

指定阻抗。

阻抗是一个值，可量化沿交通网络的行程。行程距离是阻抗的一个示例；它量化了人行道和路段的长度。类似地，行驶时间 (沿路段行驶的典型时间) 也是阻抗的一个示例。如果设置了 travelMode，则必须忽略此属性。

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

outputGeometryPrecision Number

使用此属性可指定要对操作返回的路径几何进行简化的程度。简化将保留路径上定义路径基本形状所需的关键点（例如交点处的转弯）而移除其他点。当您传入 travelMode 时，无论您是依赖默认值还是显式设置值，此属性的值都会被覆盖。

单位由 outputGeometryPrecisionUnits 参数指定。

outputGeometryPrecisionUnits String

使用此属性为 outputGeometryPrecision 参数指定的值指定单位。当您传入 travelMode 时，无论您是依赖默认值还是显式设置值，此参数的值都会被覆盖。

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

outputLines String

使用此属性可指定操作输出的路径要素的类型。仅当 returnRoutes 参数设置为 true 时，此参数才适用。

可能值	描述
none	不返回任何路径形状。
straight	在停靠点之间返回一条直线。
true-shape	返回基于基础街道的生成路径的精确形状。
true-shape-with-measure	返回基于基础街道的生成路径的精确形状，并包括路线测量值，以跟踪路径相对于第一个停靠点的累计行驶时间或行驶距离。

可能值："none"|"straight"|"true-shape"|"true-shape-with-measure"

outSpatialReference SpatialReference

使用此属性可指定求解操作返回的几何的空间参考，例如线或点要素。

overrides Object

起始版本：GeoScene Maps SDK for JavaScript 4.24

指定其他设置，这些设置在求解网络分析问题时可能会影响求解程序的行为。

pointBarriers Collection<PointBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

使用此属性可指定一个或多个点，以作为临时限制或表示在基础街道上行驶可能需要的额外时间或距离。例如，点障碍可以用来表示沿街道倒下的树或在铁路交叉口花费的时间延迟。

polygonBarriers Collection<PolygonBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

使用此属性指定面，用于完全限制通行或按比例调整行驶在与面相交的街道上所需的行驶时间或距离。

polylineBarriers Collection<PolylineBarrier>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

使用此属性可指定一个或多个禁止沿线与街道相交的任何地方行驶的线。例如，可以使用线障碍来模拟阻塞多个街道段的交通的游行或抗议。

preserveFirstStop Boolean

使用此属性可指示重新排序停靠点时，操作是否应保持第一个固定停靠点。仅当 findBestSequence 参数值为 true 时，此属性才适用。

preserveLastStop Boolean

使用此属性可指示重新排序停靠点时，操作是否应保持最后一个固定停靠点。仅当 findBestSequence 参数值为 true 时，此属性才适用。

preserveObjectID Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

使用此属性指定当输入位置作为输出返回时，是否应保留为输入位置 (如停靠点或障碍点) 指定的对象 ID。

restrictionAttributes String[]

使用此属性可指定操作应遵循的限制。限制表示驾驶偏好或要求。如果指定了 travelMode，则忽略此值。

可能值："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"

restrictUTurns String

使用此属性以限制或允许在交汇点处掉头的路线。如果指定了 travelMode，则忽略此值。

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

returnBarriers Boolean

指定路径操作是否返回点障碍。

returnDirections Boolean

指定操作是否应为每条路径生成行驶方向。如果为 true，则方向是根据 directionsLanguage、directionsOutputType、directionsStyleName 和 directionsLengthUnits 属性的值配置的。

returnPolygonBarriers Boolean

指定路径操作是否返回面障碍。

returnPolylineBarriers Boolean

指定路径操作是否返回折线障碍。

returnRoutes Boolean

使用此属性可指定操作是否应返回路径。如果为 true，则路径的形状取决于 outputLines 属性的值。

returnStops Boolean

使用此属性可指定路径操作是否应返回停靠点。

returnTraversedEdges Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

指定操作是否返回遍历的边。

returnTraversedJunctions Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

指定操作是否返回遍历的交汇点。

returnTraversedTurns Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

指定操作是否返回遍历的转弯。

returnZ Boolean

如果基础网络支持，请为返回的几何包含 z 值。

startTime Date|String

指示出行应开始的时间。

对于 RouteParameters，startTime 总是 "now"。

startTimeIsUTC Boolean

指定 startTime 属性的一个或多个时区。

stops Collection<Stop>|DataLayer|FeatureSet|NetworkFeatureSet|NetworkUrl

指定一条或多条输出路径将访问的位置。

示例

// Define stops using a FeatureSet.
const routeParameters = new RouteParameters({
  stops: new FeatureSet({
      features: [
      new Graphic({
        attributes: { Name: "Redlands" },
        geometry: new Point({ x: -117.1825, y: 34.054722 })
      }),
      new Graphic({
        attributes: { Name: "Palm Springs" },
        geometry: new Point({ x: -116.545278, y: 33.830278 })
      })
    ]
  })
});

// Define stops using a collection of Stops.
const routeParameters = new RouteParameters({
  stops: new Collection([
    new Stop({ name: "Redlands", geometry: { x: -117.1825, y: 34.054722 }}),
    new Stop({ name: "Palm Springs", geometry: { x: -116.545278, y: 33.830278 }})
  ])
});

timeWindowsAreUTC Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

指定停靠点的 timeWindowStart 和 timeWindowEnd 属性值是以 UTC 还是以当地地理位置时间指定。

travelMode TravelMode

出行模式表示一种通行的方式，例如驾驶或步行。出行模式定义了车辆或行人的物理特征。

使用 networkService.fetchServiceDescription 可获取预定义的出行模式列表，在路径请求中未指定出行模式的情况下，使用默认出行模式。

示例

// Display the fastest walking time route between two existing graphics.
const apiKey = "<your-api-key>";
const url = "https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World";

// Obtain the routing service's description. The description contains all preset travel modes.
const serviceDescription = await networkService.fetchServiceDescription(url, apiKey);

// Find the named travel mode called "Walking Time".
const { supportedTravelModes } = serviceDescription;
const travelMode = supportedTravelModes.find((mode) => mode.name === "Walking Time");

// Construct the route parameter object.
const routeParameters = new RouteParameters({
  apiKey,
  stops: new FeatureSet({
    features: view.graphics.toArray()
  }),
  returnDirections: true,
  travelMode
});

// Solve the route and add the path representing the fastest walk path to the map.
const routeContainer = await route.solve(url, routeParameters);
for (const routeResult of routeContainer.routeResults) {
  const { routeLayer } = routeResult;
  routeLayer.symbol = {
    type: "simple-line",
    color: [5, 150, 255],
    width: 3
  };
  view.graphics.add(routeLayer);
}

useHierarchy Boolean

指定在查找最短路径时是否使用等级。如果指定了 travelMode，则忽略此值。

useTimeWindows Boolean

使用此属性可指示在查找最佳路径时，操作是否应考虑在停靠点处指定的时间窗。使用 timeWindowStart 和 timeWindowEnd 属性在停靠点处指定时间窗。

方法概述

方法详细说明

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

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

clone(){this}

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

返回

类型	描述
this	调用此方法的类实例的深度克隆。

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

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 表示。

类型定义

AttributeParameterValue

一个对象，用于描述 RouteParameters 的 attributeParameterValues 属性的参数值。

属性

attributeName String 限制的名称。

parameterName String 与限制相关的参数名称。限制可具有一个或多个 parameterName 属性。

value String|Number parameterName 的值。