DirectionsViewModel

const directions = new Directions({
  viewModel: { // autocasts as new DirectionsViewModel
    routeServiceUrl: "https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World"
  }
});

属性概述

属性详细信息

apiKey String

起始版本：GeoScene Maps SDK for JavaScript 4.19

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

默认情况下，将使用以下 URL (除非在应用程序中被覆盖，或者从门户使用不同的默认值)：

地理编码 URL： https://geocode-api.arcgis.com/geoscene/rest/services/World/GeocodeServer

路径服务 URL： https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

goToOverride GoToOverride

起始版本：GeoScene Maps SDK for JavaScript 4.8

此函数提供了覆盖 MapView goTo() 或 SceneView goTo() 方法的能力。

另请参阅

• MapView
• SceneView

示例

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options.duration = updatedDuration;
  return view.goTo(goToParams.target, goToParams.options);
};

impedanceAttribute Objectreadonly

在分析中用作阻抗属性的网络属性名称。该值是在 route 中使用的特定路径网络图层中定义的。

属性

name String 阻抗网络属性的名称。

units String 此网络属性的单位。

lastRoute RouteLayerSolveResultreadonly

最近的路径结果。返回一个 RouteLayerSolveResult 对象，其中包含障碍 (如果有)、停靠点和方向的属性。

属性

directionLines Collection<DirectionLine> 与转弯之间的线段相关联的方向折线的集合。

directionPoints Collection<DirectionPoint> 将方向项目集合表示为具有各种显示信息的点。

pointBarriers Collection<PointBarrier> 点障碍的集合。

polygonBarriers Collection<PolygonBarrier> 面障碍的集合。

polylineBarriers Collection<PolylineBarrier> 折线障碍的集合。

routeInfo RouteInfo 有关已求解路径的信息，包括路径几何以及总距离和时间。

stops Collection<Stop> 停靠点的集合。表示路线的起点、终点或中点。

默认值：null

另请参阅

• RouteLayer.solve()

layer RouteLayer

起始版本：GeoScene Maps SDK for JavaScript 4.24

与 DirectionsViewModel 相关联的 RouteLayer。路径图层包含停靠点和障碍物，将用于显示和求解路径。

maxStops Number

路径允许的最大停靠点数。

默认值：50

routeParameters RouteParameters

用于调用服务的路径参数对象。有关可用设置的列表，请参阅 RouteParameters 文档。

routeServiceUrl String

已弃用从 4.24 版开始。请改用图层中的 url。

Route 服务的 REST 端点的 URL。

默认情况下，DirectionsViewModel 将使用全局路径服务 (参阅 config.routeServiceUrl)。

如果连接到 Portal，您可使用门户帮助器服务上公布的路径服务，如下所示。

另请参阅

• config.routeServiceUrl
• Portal.helperServices

示例

// Create DirectionsViewModel using the route service advertised on the portal
const portal = Portal.getDefault();
const viewModel = new DirectionsViewModel({
  routeServiceUrl: portal.helperServices.route.url
});

routeSymbol SimpleLineSymbol

已弃用从 4.24 版开始。请改用图层中的 directionLines。

定义用于在地图上绘制路线的符号。

selectedTravelMode TravelMode

选择的出行方式。除非指定，否则 Directions 微件将使用第一个支持的出行模式。对于默认 routeServiceUrl，这是一个名为 “Driving Time” 的出行模式。

默认值：null

另请参阅

• 默认的出行模式

• networkService.fetchServiceDescription

serviceDescription Objectreadonly

Route REST Endpoint 返回的服务描述对象。该对象包含三个属性：currentVersion、defaultTravelMode 和 supportedTravelModes。

在实施对车辆或停靠点属性有限制或偏好的复杂物流场景时，此信息很有用，例如避开收费公路、处理危险材料、处理停靠点服务时间等。

属性

currentVersion Number 服务器版本。

defaultTravelMode String 默认出行方式 id

supportedTravelModes TravelMode[] 可用的出行方式

默认值：null

state Stringreadonly

视图模型的当前状态。

可能的值："disabled"|"ready"

默认值：disabled

stops Collection<Stop>autocast

Autocasts from Collection<Graphic>|Graphic[]|Stop[]|Object[]

已弃用从 4.24 版开始。请改用图层中的 stops。

定义沿路径停靠点位置的 Stop 集合。

stopSymbols RouteStopSymbols

已弃用从 4.24 版开始。请改用图层中的 RouteStopSymbols。

用于显示起点和最终目的地之间位置的默认停靠点符号。

属性

first SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol 第一个停靠点符号。

middle SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol 中间的停靠点符号。

last SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol 最后一个停靠点符号。

unlocated SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol 未定位的停靠点符号。

waypoint SimpleMarkerSymbol|PictureMarkerSymbol|PointSymbol3D|CIMSymbol 航路点停止符号。

timeAttribute Objectreadonly

计算路径时用于行驶时间的经度网络属性名称。

属性

name String 计算路径时用于行驶时间的经度网络属性名称。

units String 计算方向行驶时间时使用的单位。

travelModes TravelMode[]readonly

包含特定于 GeoScene 服务或组织出行模式的属性的对象数组。

view MapView|SceneView

微件将从中操作的视图。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

centerAt(stopOrManeuver)

将地图居中于指定行进或停止处。

参数

stopOrManeuver Graphic 地图应居中的停靠点或行进策略。

clearHighlights()

清除所有突出显示的路段。

clearResults()

从方向列表中移除路径方向，保持输入不变。路径和位置保留在地图上。

getCostAttribute(attributeName){Object}

返回与解析名称关联的成本属性。

参数

attributeName String 指定用作阻抗的成本属性的属性名称。

返回

类型	描述
Object	与传递的名称关联的成本属性。 属性 类型 描述 name string 阻抗网络属性的名称。 units string 此网络属性的单位。

getDirections(){Promise<RouteLayerSolveResult>}

计算路径和方向。如果成功，结果将分配给 lastRoute 并在解析 promise 中返回。如果分配了视图，它将缩放到路径的范围。

返回

类型	描述
Promise<RouteLayerSolveResult>	解析后，返回 RouteLayerSolveResult。

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

highlight(networkFeature){Promise}

起始版本：GeoScene Maps SDK for JavaScript 4.24

突出显示指定的网络要素。

参数

networkFeature DirectionLine|DirectionPoint|PointBarrier|PolygonBarrier|PolylineBarrier|RouteInfo|Stop 要突出显示的网络要素。

返回

类型	描述
Promise	突出显示完成时解析。

highlightSegment(maneuver)

已弃用从 4.24 版开始。请改为使用 highlight。

在地图上突出显示指定的路段。

参数

maneuver Graphic 要突出显示的路段。

load(){Promise}

应调用此方法来加载视图模型的路径资源。

此方法从分配的路径服务下载服务元数据。在访问视图模型上的属性之前或当 routeServiceUrl 更改时调用此方法。

返回

类型	描述
Promise	解析后，视图模型已加载路径分析所需的路径服务元数据。

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

reset()

重置 ViewModel 的状态，清除微件和地图中的所有输入停靠点和结果。

save(){Promise<PortalItem>}

起始版本：GeoScene Maps SDK for JavaScript 4.24

保存与视图模型相关联的 RouteLayer。此方法将更新与图层相关联的门户项目。

返回

类型	描述
Promise<PortalItem>	解析后，返回 PortalItem。

另请参阅

• RouteLayer.save()
• RouteLayer.saveAs()

saveAs(portalItem, options){Promise<PortalItem>}

起始版本：GeoScene Maps SDK for JavaScript 4.24

将与视图模型相关联的 RouteLayer 另存为新门户项目。

参数

portalItem Promise<PortalItem> 图层将保存到的新门户项目。

options Object optional 保存选项。目前，仅可设置一个属性，即 folder。 规范 folder PortalFolder optional 保存项目的文件夹。

返回

类型	描述
Promise<PortalItem>	保存的门户项目。

另请参阅

• RouteLayer.save()
• RouteLayer.saveAs()

zoomToRoute()

缩放以在当前地图范围内显示完整路径。