DirectionsViewModel

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

属性概览

属性详情

apiKey String

起始版本：GeoScene API for JavaScript 4.19

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

默认情况下，将使用以下 URL（除非在应用程序中被覆盖，或者如果使用来自门户的不同默认值）：

Geocoding URL: https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer

Routing URL: https://route-api.geoscene.cn/arcgis/rest/services/World/Route/NAServer/Route_World

declaredClass Stringreadonly inherited

起始版本：GeoScene API for JavaScript 4.7

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

goToOverride GoToOverride

起始版本：GeoScene API 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()

maxStops Number

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

默认值:50

routeParameters RouteParameters

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

routeServiceUrl String

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

// Create DirectionsViewModel using a defined route service and an apiKey
const viewModel = new DirectionsViewModel({
  apiKey: "YOUR_API_KEY",
  routeServiceUrl: "https://route-api.geoscene.cn/arcgis/rest/services/World/Route/NAServer/Route_World"
});

routeSymbol SimpleLineSymbol

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

selectedTravelMode TravelMode

选择的出行方式。除非指定，否则 Directions 微件将使用第一个支持的出行模式。对于默认 routeServiceUrl，这是一个名为“Driving Time”的出行模式。更多信息可以在 GeoScene Online 文档中找到。

默认值:null

另请参阅：

• 默认出行模式

• networkService.fetchServiceDescription

serviceDescription Objectreadonly

Route REST Endpoint 返回的服务描述对象。 该对象包含三个属性：currentVersion, defaultTravelMode, and 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[]

定义沿途停靠点的 Stop 集合。

stopSymbols Object

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

属性：

first Symbol optional 第一个停止符号。

middle Symbol optional 中间停止符号。

last Symbol optional 最后一个停止符号。

unlocated Symbol optional 未定位的停止符号。

waypoint Symbol optional 航路点停止符号。

timeAttribute Objectreadonly

计算方向时用于行驶时间的网络属性名称。

属性：

name String 计算方向时用于行驶时间的网络属性名称。

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

travelModes TravelMode[]readonly

包含特定于 GeoScene 服务或组织的出行模式的属性的对象数组。更多信息可以在 GeoScene Online 文档中找到。

view MapView|SceneView

微件将从中操作的视图。

方法概览

方法详情

centerAt(stopOrManeuver)

在指定的机动或停止处将地图居中。

参数：

stopOrManeuver Graphic 地图应居中的停止或机动。

clearHighlights()

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

clearResults()

从路线列表中删除路线路线，保持输入不变。 路线和位置保留在地图上。

getCostAttribute(attributeName){Object}

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

参数：

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

返回：

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

getDirections(){Promise<RouteLayerSolveResult>}

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

返回：

类型	说明
Promise<RouteLayerSolveResult>	解决后，返回一个 RouteLayerSolveResult。

highlightSegment(maneuver)

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

参数：

maneuver Graphic 要突出显示的路段。

load(){Promise}

应该调用这个方法来加载视图模型的路由资源。

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

返回：

类型	说明
Promise	解析后，视图模型已加载路由所需的路由服务元数据。

reset()

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

zoomToRoute()

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