DirectionsFeatureSet 是 FeatureSet 的一个子类,其包含已求解路径的街道方向。
仅在使用 "complete"
、"complete-no-events"
、"instructions-only"
、"standard"
或 "summary-only"
的方向输出类型求解路径时,才会返回 DirectionsFeatureSet。"featuresets" 输出类型返回两个常规 FeatureSet,一个用于事件,另一个用于两个事件之间的路径。
// Get the drive time between Esri and the Redlands Bowl
const apiKey = "<ENTER YOUR API KEY HERE>";
const url = "https://route-api.geoscene.cn/geoscene/rest/services/World/Route/NAServer/Route_World";
const spatialReference = new SpatialReference({ wkid: 102100 });
const stops = new Collection([
new Stop({
name: "Esri",
geometry: new Point({ x: -13046165, y: 4036335, spatialReference })
}),
new Stop({
name: "Redland Bowl",
geometry: new Point({ x: -13045111, y: 4036114, spatialReference })
})
]);
const routeParameters = new RouteParameters({
apiKey,
stops,
outSpatialReference: spatialReference,
returnDirections: true,
directionsOutputType: "standard" // default value
});
const { routeResults } = await route.solve(url, routeParameters);
const { directions } = routeResults[0];
console.log(`The total drive time is: ${directions.totalTime}`);
属性概述
名称 | 类型 | 描述 | 类 |
---|---|---|---|
String | 类的名称。 更多详情 | Accessor | |
String | 图层的主显示字段的名称。 更多详情 | FeatureSet | |
Boolean | 通常,图层对查询操作返回的要素 (即记录) 数量有限制。 更多详情 | FeatureSet | |
Extent | 路径的范围。 更多详情 | DirectionsFeatureSet | |
Graphic[] | 方向要素的数组。 更多详情 | DirectionsFeatureSet | |
Field[] | 每个字段的信息。 更多详情 | FeatureSet | |
String | Directions FeatureSet 的几何类型。 更多详情 | DirectionsFeatureSet | |
Polyline | 表示路径的单条折线。 更多详情 | DirectionsFeatureSet | |
Geometry | 用于查询要素的几何。 更多详情 | FeatureSet | |
Number | 路径的 ID。 更多详情 | DirectionsFeatureSet | |
String | 路径的名称。 更多详情 | DirectionsFeatureSet | |
SpatialReference | 当 FeatureSet 用作地理处理器的输入时,空间参考默认设置为地图的空间参考。 更多详情 | FeatureSet | |
DirectionsString[] | 所有方向字符串的扁平化数组。 更多详情 | DirectionsFeatureSet | |
Number | 路径的总行驶时间。 更多详情 | DirectionsFeatureSet | |
Number | 路径的总长度。 更多详情 | DirectionsFeatureSet | |
Number | 路径的总时间,包括等待时间和服务时间。 更多详情 | DirectionsFeatureSet |
属性详细信息
-
类的名称。声明的类名称格式化为
geoscene.folder.className
。
-
图层的主显示字段的名称。此属性的值与其中一个要素字段的名称相匹配。这仅适用于从任务返回 FeatureSet 的情况。当 FeatureSet 用作地理处理任务的输入时,它会被忽略。
-
通常,图层对查询操作返回的要素 (即记录) 数量有限制。如果为图层配置了
maxRecordCount
,且查询匹配的要素数大于maxRecordCount
时,exceededTransferLimit
将为true
。否则,将为false
。GeoScene Server 1.1 及更高版本支持此功能。
-
extent Extent
-
路径的范围。
-
方向要素的数组。要素类型为 DirectionsFeature。
-
每个字段的信息。
-
geometryType String
-
Directions FeatureSet 的几何类型。
对于 DirectionsFeatureSet,geometryType 总是 "polyline"。
-
mergedGeometry Polyline
-
表示路径的单条折线。
-
用于查询要素的几何。获取由按距离查询要素生成的缓冲区几何或获取在查询的 outSpatialReference 中投影的查询几何时,这很有用。仅为客户端查询和 返回查询几何。查询的 returnQueryGeometry 必须设置为
true
,并且图层的 capabilities.query.supportsQueryGeometry 必须为true
,才能返回查询几何。
-
routeId Number
-
路径的 ID。
-
routeName String
-
路径的名称。
-
spatialReference SpatialReference inherited
-
当 FeatureSet 用作地理处理器的输入时,空间参考默认设置为地图的空间参考。该值可以更改。从任务返回 FeatureSet 时,其值为从服务器返回的结果。
-
strings DirectionsString[]
-
所有方向字符串的扁平化数组。
-
totalDriveTime Number
-
路径的总行驶时间。时间单位由路径求解请求中的 RouteParameters.directionsTimeAttribute 定义。
-
totalLength Number
-
路径的总长度。长度单位由路径求解请求中的 RouteParameters.directionsLengthUnits 定义。
-
totalTime Number
-
路径的总时间,包括等待时间和服务时间。时间单位由路径求解请求中的 RouteParameters.directionsTimeAttribute 定义。
方法概述
名称 | 返回值类值 | 描述 | 类 |
---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | Accessor | ||
* | 创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。 更多详情 | FeatureSet | |
Boolean | 如果存在指定的句柄组,则返回 true。 更多详情 | Accessor | |
移除对象拥有的句柄组。 更多详情 | Accessor | ||
Object | 将此类的实例转换为 GeoScene Portal JSON 表示。 更多详情 | FeatureSet |
方法详细说明
-
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() 进行删除。如果未提供键,则句柄将被添加到默认组。
-
fromJSON(json){*}static
-
创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入
json
参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例,请参阅指南中的使用 fromJSON() 主题。参数json ObjectGeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档。
返回类型 描述 * 返回该类的新实例。
-
起始版本: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");
-
将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。
返回类型 描述 Object 此类实例的 GeoScene Portal JSON 表示。